Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BaseAPI
    • TagsApi

Index

Constructors

constructor

  • new TagsApi(configuration?: Configuration): TagsApi
  • Parameters

    • configuration: Configuration = ...

    Returns TagsApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

createTag

createTagRaw

deleteTag

deleteTagRaw

  • deleteTagRaw(requestParameters: DeleteTagRequest): Promise<ApiResponse<string>>

getTag

getTagRaw

  • getTagRaw(requestParameters: GetTagRequest): Promise<ApiResponse<TagResponse>>

listTags

  • Return all of the tags for an organization. List all tags

    Parameters

    Returns Promise<ListTagsResponse>

listTagsRaw

  • listTagsRaw(requestParameters: ListTagsRequest): Promise<ApiResponse<ListTagsResponse>>
  • Return all of the tags for an organization. List all tags

    Parameters

    Returns Promise<ApiResponse<ListTagsResponse>>

patchTag

  • Update an existing tag. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array. Update a tag

    Parameters

    Returns Promise<TagResponse>

patchTagRaw

  • Update an existing tag. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array. Update a tag

    Parameters

    Returns Promise<ApiResponse<TagResponse>>

replaceTag

  • Update a tag with a new name and new members. This API call would replace all old members of a tag with new members specified in the request body. Update a tag

    Parameters

    Returns Promise<TagResponse>

replaceTagRaw

  • Update a tag with a new name and new members. This API call would replace all old members of a tag with new members specified in the request body. Update a tag

    Parameters

    Returns Promise<ApiResponse<TagResponse>>

Protected request

  • request(context: RequestOpts): Promise<Response>
  • Parameters

    • context: RequestOpts

    Returns Promise<Response>

withMiddleware

  • withMiddleware<T>(...middlewares: Middleware[]): T
  • Type parameters

    • T: BaseAPI<T>

    Parameters

    • Rest ...middlewares: Middleware[]

    Returns T

withPostMiddleware

  • withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
  • Type parameters

    • T: BaseAPI<T>

    Parameters

    • Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
  • Type parameters

    • T: BaseAPI<T>

    Parameters

    • Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]

    Returns T

Generated using TypeDoc