UserTagAPI

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

Method	HTTP request	Description
addMyUserTag_0	POST /users/me/tags	自分にタグを追加
addUserTag_0	POST /users/{userId}/tags	ユーザーにタグを追加
editMyUserTag	PATCH /users/me/tags/{tagId}	自分のタグを編集
editUserTag_0	PATCH /users/{userId}/tags/{tagId}	ユーザーのタグを編集
getMyUserTags_0	GET /users/me/tags	自分のタグリストを取得
getTag	GET /tags/{tagId}	タグ情報を取得
getUserTags_0	GET /users/{userId}/tags	ユーザーのタグリストを取得
removeMyUserTag	DELETE /users/me/tags/{tagId}	自分からタグを削除します
removeUserTag_0	DELETE /users/{userId}/tags/{tagId}	ユーザーからタグを削除します

addMyUserTag_0

    open class func addMyUserTag_0(postUserTagRequest: PostUserTagRequest? = nil, completion: @escaping (_ data: UserTag?, _ 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 postUserTagRequest = PostUserTagRequest(tag: "tag_example") // PostUserTagRequest |  (optional)

// 自分にタグを追加
UserTagAPI.addMyUserTag_0(postUserTagRequest: postUserTagRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
postUserTagRequest	PostUserTagRequest		[optional]

Return type

UserTag

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]

addUserTag_0

    open class func addUserTag_0(userId: UUID, postUserTagRequest: PostUserTagRequest? = nil, completion: @escaping (_ data: UserTag?, _ error: Error?) -> Void)

ユーザーにタグを追加

指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。

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 userId = 987 // UUID | ユーザーUUID
let postUserTagRequest = PostUserTagRequest(tag: "tag_example") // PostUserTagRequest |  (optional)

// ユーザーにタグを追加
UserTagAPI.addUserTag_0(userId: userId, postUserTagRequest: postUserTagRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
userId	UUID	ユーザーUUID
postUserTagRequest	PostUserTagRequest		[optional]

Return type

UserTag

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]

editMyUserTag

    open class func editMyUserTag(tagId: UUID, patchUserTagRequest: PatchUserTagRequest? = 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 tagId = 987 // UUID | タグUUID
let patchUserTagRequest = PatchUserTagRequest(isLocked: false) // PatchUserTagRequest |  (optional)

// 自分のタグを編集
UserTagAPI.editMyUserTag(tagId: tagId, patchUserTagRequest: patchUserTagRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tagId	UUID	タグUUID
patchUserTagRequest	PatchUserTagRequest		[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]

editUserTag_0

    open class func editUserTag_0(userId: UUID, tagId: UUID, patchUserTagRequest: PatchUserTagRequest? = 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 userId = 987 // UUID | ユーザーUUID
let tagId = 987 // UUID | タグUUID
let patchUserTagRequest = PatchUserTagRequest(isLocked: false) // PatchUserTagRequest |  (optional)

// ユーザーのタグを編集
UserTagAPI.editUserTag_0(userId: userId, tagId: tagId, patchUserTagRequest: patchUserTagRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
userId	UUID	ユーザーUUID
tagId	UUID	タグUUID
patchUserTagRequest	PatchUserTagRequest		[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]

getMyUserTags_0

    open class func getMyUserTags_0(completion: @escaping (_ data: [UserTag]?, _ 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


// 自分のタグリストを取得
UserTagAPI.getMyUserTags_0() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[UserTag]

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]

getTag

    open class func getTag(tagId: UUID, completion: @escaping (_ data: Tag?, _ 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 tagId = 987 // UUID | タグUUID

// タグ情報を取得
UserTagAPI.getTag(tagId: tagId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tagId	UUID	タグUUID

Return type

Tag

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]

getUserTags_0

    open class func getUserTags_0(userId: UUID, completion: @escaping (_ data: [UserTag]?, _ 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 userId = 987 // UUID | ユーザーUUID

// ユーザーのタグリストを取得
UserTagAPI.getUserTags_0(userId: userId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
userId	UUID	ユーザーUUID

Return type

[UserTag]

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]

removeMyUserTag

    open class func removeMyUserTag(tagId: 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 tagId = 987 // UUID | タグUUID

// 自分からタグを削除します
UserTagAPI.removeMyUserTag(tagId: tagId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tagId	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]

removeUserTag_0

    open class func removeUserTag_0(userId: UUID, tagId: 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 userId = 987 // UUID | ユーザーUUID
let tagId = 987 // UUID | タグUUID

// ユーザーからタグを削除します
UserTagAPI.removeUserTag_0(userId: userId, tagId: tagId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
userId	UUID	ユーザーUUID
tagId	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

UserTagAPI.md

Latest commit

History

UserTagAPI.md

File metadata and controls

UserTagAPI

addMyUserTag_0

Example

Parameters

Return type

Authorization

HTTP request headers

addUserTag_0

Example

Parameters

Return type

Authorization

HTTP request headers

editMyUserTag

Example

Parameters

Return type

Authorization

HTTP request headers

editUserTag_0

Example

Parameters

Return type

Authorization

HTTP request headers

getMyUserTags_0

Example

Parameters

Return type

Authorization

HTTP request headers

getTag

Example

Parameters

Return type

Authorization

HTTP request headers

getUserTags_0

Example

Parameters

Return type

Authorization

HTTP request headers

removeMyUserTag

Example

Parameters

Return type

Authorization

HTTP request headers

removeUserTag_0

Example

Parameters

Return type

Authorization

HTTP request headers