import type { EmptyResponse } from '../models/EmptyResponse'; import type { TagCompact } from '../models/TagCompact'; import type { TagRequest } from '../models/TagRequest'; import type { TagResponse } from '../models/TagResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; import type { BaseHttpRequest } from '../core/BaseHttpRequest'; export declare class TagsService { readonly httpRequest: BaseHttpRequest; constructor(httpRequest: BaseHttpRequest); /** * Get multiple tags * Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned. * @returns any Successfully retrieved the specified set of tags. * @throws ApiError */ getTags({ optPretty, optFields, limit, offset, workspace, }: { /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; /** * The workspace to filter tags on. */ workspace?: string; }): CancelablePromise<{ data?: Array; }>; /** * Create a tag * Creates a new tag in a workspace or organization. * * Every tag is required to be created in a specific workspace or * organization, and this cannot be changed once set. Note that you can use * the workspace parameter regardless of whether or not it is an * organization. * * Returns the full record of the newly created tag. * @returns any Successfully created the newly specified tag. * @throws ApiError */ createTag({ requestBody, optPretty, optFields, }: { /** * The tag to create. */ requestBody: { data?: TagRequest; }; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; }): CancelablePromise<{ data?: TagResponse; }>; /** * Get a tag * Returns the complete tag record for a single tag. * @returns any Successfully retrieved the specified tag. * @throws ApiError */ getTag({ tagGid, optPretty, optFields, limit, offset, }: { /** * Globally unique identifier for the tag. */ tagGid: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; }): CancelablePromise<{ data?: TagResponse; }>; /** * Update a tag * Updates the properties of a tag. Only the fields provided in the `data` * block will be updated; any unspecified fields will remain unchanged. * * When using this method, it is best to specify only those fields you wish * to change, or else you may overwrite changes made by another user since * you last retrieved the tag. * * Returns the complete updated tag record. * @returns any Successfully updated the specified tag. * @throws ApiError */ updateTag({ tagGid, optPretty, optFields, limit, offset, }: { /** * Globally unique identifier for the tag. */ tagGid: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; }): CancelablePromise<{ data?: TagResponse; }>; /** * Delete a tag * A specific, existing tag can be deleted by making a DELETE request on * the URL for that tag. * * Returns an empty data record. * @returns any Successfully deleted the specified tag. * @throws ApiError */ deleteTag({ tagGid, optPretty, optFields, limit, offset, }: { /** * Globally unique identifier for the tag. */ tagGid: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; }): CancelablePromise<{ data?: EmptyResponse; }>; /** * Get a task's tags * Get a compact representation of all of the tags the task has. * @returns any Successfully retrieved the tags for the given task. * @throws ApiError */ getTagsForTask({ taskGid, optPretty, optFields, limit, offset, }: { /** * The task to operate on. */ taskGid: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; }): CancelablePromise<{ data?: Array; }>; /** * Get tags in a workspace * Returns the compact tag records for some filtered set of tags. Use one or more of the parameters provided to filter the tags returned. * @returns any Successfully retrieved the specified set of tags. * @throws ApiError */ getTagsForWorkspace({ workspaceGid, optPretty, optFields, limit, offset, }: { /** * Globally unique identifier for the workspace or organization. */ workspaceGid: string; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; /** * Results per page. * The number of objects to return per page. The value must be between 1 and 100. */ limit?: number; /** * Offset token. * An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. * 'Note: You can only pass in an offset that was returned to you via a previously paginated request.' */ offset?: string; }): CancelablePromise<{ data?: Array; }>; /** * Create a tag in a workspace * Creates a new tag in a workspace or organization. * * Every tag is required to be created in a specific workspace or * organization, and this cannot be changed once set. Note that you can use * the workspace parameter regardless of whether or not it is an * organization. * * Returns the full record of the newly created tag. * @returns any Successfully created the newly specified tag. * @throws ApiError */ createTagForWorkspace({ workspaceGid, requestBody, optPretty, optFields, }: { /** * Globally unique identifier for the workspace or organization. */ workspaceGid: string; /** * The tag to create. */ requestBody: { data?: TagResponse; }; /** * Provides “pretty” output. * Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging. */ optPretty?: boolean; /** * Defines fields to return. * Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. * The id of included objects will always be returned, regardless of the field options. */ optFields?: Array; }): CancelablePromise<{ data?: TagResponse; }>; }