GroupAPI

All URIs are relative to https://q.trap.jp/api/v3

Method	HTTP request	Description
addUserGroupAdmin	POST /groups/{groupId}/admins	グループ管理者を追加
addUserGroupMember	POST /groups/{groupId}/members	グループメンバーを追加
changeUserGroupIcon	PUT /groups/{groupId}/icon	ユーザーグループのアイコンを変更
createUserGroup	POST /groups	ユーザーグループを作成
deleteUserGroup	DELETE /groups/{groupId}	ユーザーグループを削除
editUserGroup	PATCH /groups/{groupId}	ユーザーグループを編集
editUserGroupMember	PATCH /groups/{groupId}/members/{userId}	グループメンバーを編集
getUserGroup	GET /groups/{groupId}	ユーザーグループを取得
getUserGroupAdmins	GET /groups/{groupId}/admins	グループ管理者を取得
getUserGroupMembers	GET /groups/{groupId}/members	グループメンバーを取得
getUserGroups	GET /groups	ユーザーグループのリストを取得
removeUserGroupAdmin	DELETE /groups/{groupId}/admins/{userId}	グループ管理者を削除
removeUserGroupMember	DELETE /groups/{groupId}/members/{userId}	グループメンバーを削除
removeUserGroupMembers	DELETE /groups/{groupId}/members	グループメンバーを一括削除

addUserGroupAdmin

    open class func addUserGroupAdmin(groupId: UUID, postUserGroupAdminRequest: PostUserGroupAdminRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

グループ管理者を追加

指定したグループに管理者を追加します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID
let postUserGroupAdminRequest = PostUserGroupAdminRequest(id: 123) // PostUserGroupAdminRequest |  (optional)

// グループ管理者を追加
GroupAPI.addUserGroupAdmin(groupId: groupId, postUserGroupAdminRequest: postUserGroupAdminRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID
postUserGroupAdminRequest	PostUserGroupAdminRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addUserGroupMember

    open class func addUserGroupMember(groupId: UUID, addUserGroupMemberRequest: AddUserGroupMemberRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

グループメンバーを追加

指定したグループにメンバーを追加します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID
let addUserGroupMemberRequest = addUserGroupMember_request(id: 123, role: "role_example") // AddUserGroupMemberRequest |  (optional)

// グループメンバーを追加
GroupAPI.addUserGroupMember(groupId: groupId, addUserGroupMemberRequest: addUserGroupMemberRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID
addUserGroupMemberRequest	AddUserGroupMemberRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

changeUserGroupIcon

    open class func changeUserGroupIcon(groupId: UUID, file: URL, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

ユーザーグループのアイコンを変更

ユーザーグループのアイコンを変更します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID
let file = URL(string: "https://example.com")! // URL | アイコン画像(2MBまでのpng, jpeg, gif)

// ユーザーグループのアイコンを変更
GroupAPI.changeUserGroupIcon(groupId: groupId, file: file) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID
file	URL	アイコン画像(2MBまでのpng, jpeg, gif)

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createUserGroup

    open class func createUserGroup(postUserGroupRequest: PostUserGroupRequest? = nil, completion: @escaping (_ data: UserGroup?, _ error: Error?) -> Void)

ユーザーグループを作成

ユーザーグループを作成します。作成者は自動的にグループ管理者になります。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let postUserGroupRequest = PostUserGroupRequest(name: "name_example", description: "description_example", type: "type_example") // PostUserGroupRequest |  (optional)

// ユーザーグループを作成
GroupAPI.createUserGroup(postUserGroupRequest: postUserGroupRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
postUserGroupRequest	PostUserGroupRequest		[optional]

Return type

UserGroup

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteUserGroup

    open class func deleteUserGroup(groupId: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

ユーザーグループを削除

指定したユーザーグループを削除します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID

// ユーザーグループを削除
GroupAPI.deleteUserGroup(groupId: groupId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editUserGroup

    open class func editUserGroup(groupId: UUID, patchUserGroupRequest: PatchUserGroupRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

ユーザーグループを編集

指定したユーザーグループの情報を編集します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID
let patchUserGroupRequest = PatchUserGroupRequest(name: "name_example", description: "description_example", type: "type_example") // PatchUserGroupRequest |  (optional)

// ユーザーグループを編集
GroupAPI.editUserGroup(groupId: groupId, patchUserGroupRequest: patchUserGroupRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID
patchUserGroupRequest	PatchUserGroupRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

editUserGroupMember

    open class func editUserGroupMember(groupId: UUID, userId: UUID, patchGroupMemberRequest: PatchGroupMemberRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

グループメンバーを編集

指定したユーザーグループ内の指定したユーザーの属性を編集します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID
let userId = 987 // UUID | ユーザーUUID
let patchGroupMemberRequest = PatchGroupMemberRequest(role: "role_example") // PatchGroupMemberRequest |  (optional)

// グループメンバーを編集
GroupAPI.editUserGroupMember(groupId: groupId, userId: userId, patchGroupMemberRequest: patchGroupMemberRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID
userId	UUID	ユーザーUUID
patchGroupMemberRequest	PatchGroupMemberRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserGroup

    open class func getUserGroup(groupId: UUID, completion: @escaping (_ data: UserGroup?, _ error: Error?) -> Void)

ユーザーグループを取得

指定したユーザーグループの情報を取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID

// ユーザーグループを取得
GroupAPI.getUserGroup(groupId: groupId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID

Return type

UserGroup

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserGroupAdmins

    open class func getUserGroupAdmins(groupId: UUID, completion: @escaping (_ data: [UUID]?, _ error: Error?) -> Void)

グループ管理者を取得

指定したグループの管理者のリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID

// グループ管理者を取得
GroupAPI.getUserGroupAdmins(groupId: groupId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID

Return type

[UUID]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserGroupMembers

    open class func getUserGroupMembers(groupId: UUID, completion: @escaping (_ data: [UserGroupMember]?, _ error: Error?) -> Void)

グループメンバーを取得

指定したグループのメンバーのリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID

// グループメンバーを取得
GroupAPI.getUserGroupMembers(groupId: groupId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID

Return type

[UserGroupMember]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUserGroups

    open class func getUserGroups(completion: @escaping (_ data: [UserGroup]?, _ error: Error?) -> Void)

ユーザーグループのリストを取得

ユーザーグループのリストを取得します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq


// ユーザーグループのリストを取得
GroupAPI.getUserGroups() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[UserGroup]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeUserGroupAdmin

    open class func removeUserGroupAdmin(groupId: UUID, userId: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

グループ管理者を削除

指定したユーザーグループから指定した管理者を削除します。対象のユーザーグループの管理者権限が必要です。グループから管理者が存在しなくなる場合は400エラーを返します。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID
let userId = 987 // UUID | ユーザーUUID

// グループ管理者を削除
GroupAPI.removeUserGroupAdmin(groupId: groupId, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID
userId	UUID	ユーザーUUID

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeUserGroupMember

    open class func removeUserGroupMember(groupId: UUID, userId: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

グループメンバーを削除

指定したユーザーグループから指定したユーザーを削除します。既にグループから削除されているメンバーを指定した場合は204を返します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID
let userId = 987 // UUID | ユーザーUUID

// グループメンバーを削除
GroupAPI.removeUserGroupMember(groupId: groupId, userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID
userId	UUID	ユーザーUUID

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeUserGroupMembers

    open class func removeUserGroupMembers(groupId: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

グループメンバーを一括削除

指定したグループから全てのメンバーを削除します。対象のユーザーグループの管理者権限が必要です。

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import Traq

let groupId = 987 // UUID | ユーザーグループUUID

// グループメンバーを一括削除
GroupAPI.removeUserGroupMembers(groupId: groupId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
groupId	UUID	ユーザーグループUUID

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

GroupAPI.md

Latest commit

History

GroupAPI.md

File metadata and controls

GroupAPI

addUserGroupAdmin

Example

Parameters

Return type

Authorization

HTTP request headers

addUserGroupMember

Example

Parameters

Return type

Authorization

HTTP request headers

changeUserGroupIcon

Example

Parameters

Return type

Authorization

HTTP request headers

createUserGroup

Example

Parameters

Return type

Authorization

HTTP request headers

deleteUserGroup

Example

Parameters

Return type

Authorization

HTTP request headers

editUserGroup

Example

Parameters

Return type

Authorization

HTTP request headers

editUserGroupMember

Example

Parameters

Return type

Authorization

HTTP request headers

getUserGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getUserGroupAdmins

Example

Parameters

Return type

Authorization

HTTP request headers

getUserGroupMembers

Example

Parameters

Return type

Authorization

HTTP request headers

getUserGroups

Example

Parameters

Return type

Authorization

HTTP request headers

removeUserGroupAdmin

Example

Parameters

Return type

Authorization

HTTP request headers

removeUserGroupMember