confluence.js 2.0.0-dev20250512202536 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +52 -2
- package/README.md +145 -183
- package/dist/cjs/api/analytics.cjs.map +1 -1
- package/dist/cjs/api/audit.cjs.map +1 -1
- package/dist/cjs/api/content.cjs +0 -5
- package/dist/cjs/api/content.cjs.map +1 -1
- package/dist/cjs/api/contentAttachments.cjs +1 -0
- package/dist/cjs/api/contentAttachments.cjs.map +1 -1
- package/dist/cjs/api/contentBody.cjs +18 -0
- package/dist/cjs/api/contentBody.cjs.map +1 -1
- package/dist/cjs/api/contentChildrenAndDescendants.cjs +2 -0
- package/dist/cjs/api/contentChildrenAndDescendants.cjs.map +1 -1
- package/dist/cjs/api/contentComments.cjs +1 -0
- package/dist/cjs/api/contentComments.cjs.map +1 -1
- package/dist/cjs/api/contentLabels.cjs.map +1 -1
- package/dist/cjs/api/contentMacroBody.cjs.map +1 -1
- package/dist/cjs/api/contentPermissions.cjs.map +1 -1
- package/dist/cjs/api/contentProperties.cjs +1 -0
- package/dist/cjs/api/contentProperties.cjs.map +1 -1
- package/dist/cjs/api/contentRestrictions.cjs.map +1 -1
- package/dist/cjs/api/contentStates.cjs +13 -0
- package/dist/cjs/api/contentStates.cjs.map +1 -1
- package/dist/cjs/api/contentVersions.cjs.map +1 -1
- package/dist/cjs/api/contentWatches.cjs.map +1 -1
- package/dist/cjs/api/dynamicModules.cjs.map +1 -1
- package/dist/cjs/api/experimental.cjs.map +1 -1
- package/dist/cjs/api/group.cjs +18 -17
- package/dist/cjs/api/group.cjs.map +1 -1
- package/dist/cjs/api/index.cjs +2 -0
- package/dist/cjs/api/index.cjs.map +1 -1
- package/dist/cjs/api/inlineTasks.cjs +1 -0
- package/dist/cjs/api/inlineTasks.cjs.map +1 -1
- package/dist/cjs/api/labelInfo.cjs.map +1 -1
- package/dist/cjs/api/longRunningTask.cjs +1 -0
- package/dist/cjs/api/longRunningTask.cjs.map +1 -1
- package/dist/cjs/api/models/labeledContentType.cjs.map +1 -1
- package/dist/cjs/api/relation.cjs.map +1 -1
- package/dist/cjs/api/search.cjs +1 -0
- package/dist/cjs/api/search.cjs.map +1 -1
- package/dist/cjs/api/settings.cjs.map +1 -1
- package/dist/cjs/api/space.cjs +4 -2
- package/dist/cjs/api/space.cjs.map +1 -1
- package/dist/cjs/api/spacePermissions.cjs.map +1 -1
- package/dist/cjs/api/spaceProperties.cjs +1 -0
- package/dist/cjs/api/spaceProperties.cjs.map +1 -1
- package/dist/cjs/api/spaceSettings.cjs.map +1 -1
- package/dist/cjs/api/template.cjs.map +1 -1
- package/dist/cjs/api/themes.cjs.map +1 -1
- package/dist/cjs/api/userProperties.cjs +56 -0
- package/dist/cjs/api/userProperties.cjs.map +1 -0
- package/dist/cjs/api/users.cjs.map +1 -1
- package/dist/cjs/clients/baseClient.cjs.map +1 -1
- package/dist/cjs/clients/confluenceClient.cjs +6 -0
- package/dist/cjs/clients/confluenceClient.cjs.map +1 -1
- package/dist/cjs/config.cjs +3 -1
- package/dist/cjs/config.cjs.map +1 -1
- package/dist/cjs/paramSerializer.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/authenticationService.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/authentications/createBasicAuthenticationToken.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/authentications/createJWTAuthentication.cjs +1 -1
- package/dist/cjs/services/authenticationService/authentications/createJWTAuthentication.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/base64Encoder.cjs.map +1 -1
- package/dist/esm/api/analytics.mjs.map +1 -1
- package/dist/esm/api/audit.mjs.map +1 -1
- package/dist/esm/api/content.mjs +0 -5
- package/dist/esm/api/content.mjs.map +1 -1
- package/dist/esm/api/contentAttachments.mjs +1 -0
- package/dist/esm/api/contentAttachments.mjs.map +1 -1
- package/dist/esm/api/contentBody.mjs +18 -0
- package/dist/esm/api/contentBody.mjs.map +1 -1
- package/dist/esm/api/contentChildrenAndDescendants.mjs +2 -0
- package/dist/esm/api/contentChildrenAndDescendants.mjs.map +1 -1
- package/dist/esm/api/contentComments.mjs +1 -0
- package/dist/esm/api/contentComments.mjs.map +1 -1
- package/dist/esm/api/contentLabels.mjs.map +1 -1
- package/dist/esm/api/contentMacroBody.mjs.map +1 -1
- package/dist/esm/api/contentPermissions.mjs.map +1 -1
- package/dist/esm/api/contentProperties.mjs +1 -0
- package/dist/esm/api/contentProperties.mjs.map +1 -1
- package/dist/esm/api/contentRestrictions.mjs.map +1 -1
- package/dist/esm/api/contentStates.mjs +13 -0
- package/dist/esm/api/contentStates.mjs.map +1 -1
- package/dist/esm/api/contentVersions.mjs.map +1 -1
- package/dist/esm/api/contentWatches.mjs.map +1 -1
- package/dist/esm/api/dynamicModules.mjs.map +1 -1
- package/dist/esm/api/experimental.mjs.map +1 -1
- package/dist/esm/api/group.mjs +18 -17
- package/dist/esm/api/group.mjs.map +1 -1
- package/dist/esm/api/index.mjs +1 -0
- package/dist/esm/api/index.mjs.map +1 -1
- package/dist/esm/api/inlineTasks.mjs +1 -0
- package/dist/esm/api/inlineTasks.mjs.map +1 -1
- package/dist/esm/api/labelInfo.mjs.map +1 -1
- package/dist/esm/api/longRunningTask.mjs +1 -0
- package/dist/esm/api/longRunningTask.mjs.map +1 -1
- package/dist/esm/api/models/labeledContentType.mjs.map +1 -1
- package/dist/esm/api/relation.mjs.map +1 -1
- package/dist/esm/api/search.mjs +1 -0
- package/dist/esm/api/search.mjs.map +1 -1
- package/dist/esm/api/settings.mjs.map +1 -1
- package/dist/esm/api/space.mjs +4 -2
- package/dist/esm/api/space.mjs.map +1 -1
- package/dist/esm/api/spacePermissions.mjs.map +1 -1
- package/dist/esm/api/spaceProperties.mjs +1 -0
- package/dist/esm/api/spaceProperties.mjs.map +1 -1
- package/dist/esm/api/spaceSettings.mjs.map +1 -1
- package/dist/esm/api/template.mjs.map +1 -1
- package/dist/esm/api/themes.mjs.map +1 -1
- package/dist/esm/api/userProperties.mjs +54 -0
- package/dist/esm/api/userProperties.mjs.map +1 -0
- package/dist/esm/api/users.mjs.map +1 -1
- package/dist/esm/clients/baseClient.mjs.map +1 -1
- package/dist/esm/clients/confluenceClient.mjs +6 -0
- package/dist/esm/clients/confluenceClient.mjs.map +1 -1
- package/dist/esm/config.mjs +3 -1
- package/dist/esm/config.mjs.map +1 -1
- package/dist/esm/paramSerializer.mjs.map +1 -1
- package/dist/esm/services/authenticationService/authenticationService.mjs.map +1 -1
- package/dist/esm/services/authenticationService/authentications/createBasicAuthenticationToken.mjs.map +1 -1
- package/dist/esm/services/authenticationService/authentications/createJWTAuthentication.mjs +1 -1
- package/dist/esm/services/authenticationService/authentications/createJWTAuthentication.mjs.map +1 -1
- package/dist/esm/services/authenticationService/base64Encoder.mjs.map +1 -1
- package/dist/esm/types/api/analytics.d.ts +1 -1
- package/dist/esm/types/api/audit.d.ts +3 -3
- package/dist/esm/types/api/content.d.ts +33 -7
- package/dist/esm/types/api/contentAttachments.d.ts +5 -1
- package/dist/esm/types/api/contentBody.d.ts +73 -7
- package/dist/esm/types/api/contentChildrenAndDescendants.d.ts +37 -5
- package/dist/esm/types/api/contentComments.d.ts +5 -0
- package/dist/esm/types/api/contentLabels.d.ts +17 -9
- package/dist/esm/types/api/contentMacroBody.d.ts +79 -1
- package/dist/esm/types/api/contentPermissions.d.ts +1 -1
- package/dist/esm/types/api/contentProperties.d.ts +25 -0
- package/dist/esm/types/api/contentRestrictions.d.ts +19 -7
- package/dist/esm/types/api/contentStates.d.ts +23 -5
- package/dist/esm/types/api/contentVersions.d.ts +9 -1
- package/dist/esm/types/api/contentWatches.d.ts +1 -1
- package/dist/esm/types/api/dynamicModules.d.ts +1 -1
- package/dist/esm/types/api/experimental.d.ts +21 -1
- package/dist/esm/types/api/group.d.ts +47 -27
- package/dist/esm/types/api/index.d.ts +1 -0
- package/dist/esm/types/api/inlineTasks.d.ts +13 -0
- package/dist/esm/types/api/labelInfo.d.ts +1 -1
- package/dist/esm/types/api/longRunningTask.d.ts +1 -1
- package/dist/esm/types/api/models/spaceCreate.d.ts +11 -2
- package/dist/esm/types/api/models/spacePrivateCreate.d.ts +11 -2
- package/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyRequest.d.ts +58 -0
- package/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyResponse.d.ts +4 -0
- package/dist/esm/types/api/parameters/deleteGroupById.d.ts +4 -0
- package/dist/esm/types/api/parameters/downloadAttachment.d.ts +6 -0
- package/dist/esm/types/api/parameters/getContentChildren.d.ts +6 -1
- package/dist/esm/types/api/parameters/getContentsWithState.d.ts +17 -0
- package/dist/esm/types/api/parameters/getGroupMembersByGroupId.d.ts +7 -0
- package/dist/esm/types/api/parameters/getGroupMembershipsForUser.d.ts +4 -0
- package/dist/esm/types/api/parameters/getTasks.d.ts +2 -0
- package/dist/esm/types/api/parameters/getUser.d.ts +4 -0
- package/dist/esm/types/api/parameters/index.d.ts +4 -0
- package/dist/esm/types/api/parameters/searchUser.d.ts +7 -0
- package/dist/esm/types/api/relation.d.ts +13 -15
- package/dist/esm/types/api/search.d.ts +7 -1
- package/dist/esm/types/api/settings.d.ts +5 -1
- package/dist/esm/types/api/space.d.ts +23 -7
- package/dist/esm/types/api/spacePermissions.d.ts +1 -1
- package/dist/esm/types/api/spaceProperties.d.ts +25 -0
- package/dist/esm/types/api/spaceSettings.d.ts +1 -1
- package/dist/esm/types/api/template.d.ts +1 -1
- package/dist/esm/types/api/themes.d.ts +1 -1
- package/dist/esm/types/api/userProperties.d.ts +102 -0
- package/dist/esm/types/api/users.d.ts +21 -9
- package/dist/esm/types/clients/confluenceClient.d.ts +6 -1
- package/eslint.config.ts +11 -16
- package/package.json +29 -28
- package/src/api/analytics.ts +1 -1
- package/src/api/audit.ts +3 -3
- package/src/api/content.ts +33 -12
- package/src/api/contentAttachments.ts +6 -1
- package/src/api/contentBody.ts +113 -7
- package/src/api/contentChildrenAndDescendants.ts +39 -5
- package/src/api/contentComments.ts +5 -0
- package/src/api/contentLabels.ts +17 -9
- package/src/api/contentMacroBody.ts +79 -1
- package/src/api/contentPermissions.ts +1 -1
- package/src/api/contentProperties.ts +25 -0
- package/src/api/contentRestrictions.ts +19 -7
- package/src/api/contentStates.ts +47 -5
- package/src/api/contentVersions.ts +9 -1
- package/src/api/contentWatches.ts +1 -1
- package/src/api/dynamicModules.ts +1 -1
- package/src/api/experimental.ts +21 -1
- package/src/api/group.ts +96 -75
- package/src/api/index.ts +1 -0
- package/src/api/inlineTasks.ts +13 -0
- package/src/api/labelInfo.ts +1 -1
- package/src/api/longRunningTask.ts +2 -1
- package/src/api/models/spaceCreate.ts +11 -2
- package/src/api/models/spacePrivateCreate.ts +11 -2
- package/src/api/parameters/bulkAsyncConvertContentBodyRequest.ts +88 -0
- package/src/api/parameters/bulkAsyncConvertContentBodyResponse.ts +4 -0
- package/src/api/parameters/deleteGroupById.ts +4 -0
- package/src/api/parameters/downloadAttachment.ts +6 -0
- package/src/api/parameters/getContentChildren.ts +7 -1
- package/src/api/parameters/getContentsWithState.ts +17 -0
- package/src/api/parameters/getGroupMembersByGroupId.ts +7 -0
- package/src/api/parameters/getGroupMembershipsForUser.ts +4 -0
- package/src/api/parameters/getTasks.ts +2 -0
- package/src/api/parameters/getUser.ts +4 -0
- package/src/api/parameters/index.ts +4 -0
- package/src/api/parameters/searchUser.ts +7 -0
- package/src/api/relation.ts +13 -15
- package/src/api/search.ts +8 -1
- package/src/api/settings.ts +5 -1
- package/src/api/space.ts +27 -9
- package/src/api/spacePermissions.ts +1 -1
- package/src/api/spaceProperties.ts +25 -0
- package/src/api/spaceSettings.ts +1 -1
- package/src/api/template.ts +1 -1
- package/src/api/themes.ts +1 -1
- package/src/api/userProperties.ts +185 -0
- package/src/api/users.ts +21 -9
- package/src/clients/baseClient.ts +1 -5
- package/src/clients/confluenceClient.ts +6 -0
- package/src/config.ts +4 -1
- package/src/services/authenticationService/authentications/createJWTAuthentication.ts +1 -1
- package/favicon.svg +0 -7
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"experimental.cjs","sources":["../../../../src/api/experimental.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Callback } from '../callback';\nimport type { Client } from '../clients';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Experimental {\n constructor(private client: Client) {}\n\n /**\n * Moves a pagetree rooted at a page to the space's trash:\n *\n * - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.\n * - For every other combination of content type and status, this API is not supported.\n *\n * This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.\n *\n * Use the `/longtask/<taskId>` REST API to get the copy task status.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the\n * content is in.\n */\n async deletePageTree<T = Models.LongTask>(\n parameters: Parameters.DeletePageTree,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Moves a pagetree rooted at a page to the space's trash:\n *\n * - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.\n * - For every other combination of content type and status, this API is not supported.\n *\n * This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.\n *\n * Use the `/longtask/<taskId>` REST API to get the copy task status.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the\n * content is in.\n */\n async deletePageTree<T = Models.LongTask>(parameters: Parameters.DeletePageTree, callback?: never): Promise<T>;\n async deletePageTree<T = Models.LongTask>(\n parameters: Parameters.DeletePageTree,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/content/${parameters.id}/pageTree`,\n method: 'DELETE',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different\n * types of labels.\n */\n async getLabelsForSpace<T = Models.LabelArray>(\n parameters: Parameters.GetLabelsForSpace,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different\n * types of labels.\n */\n async getLabelsForSpace<T = Models.LabelArray>(\n parameters: Parameters.GetLabelsForSpace,\n callback?: never,\n ): Promise<T>;\n async getLabelsForSpace<T = Models.LabelArray>(\n parameters: Parameters.GetLabelsForSpace,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/space/${parameters.spaceKey}/label`,\n method: 'GET',\n params: {\n prefix: parameters.prefix,\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Adds labels to a piece of content. Does not modify the existing labels.\n *\n * Notes:\n *\n * - Labels can also be added when creating content ([Create content](#api-content-post)).\n * - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing\n * labels and replace them with the labels in the request.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.\n */\n async addLabelsToSpace<T = Models.LabelArray>(\n parameters: Parameters.AddLabelsToSpace,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Adds labels to a piece of content. Does not modify the existing labels.\n *\n * Notes:\n *\n * - Labels can also be added when creating content ([Create content](#api-content-post)).\n * - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing\n * labels and replace them with the labels in the request.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.\n */\n async addLabelsToSpace<T = Models.LabelArray>(parameters: Parameters.AddLabelsToSpace, callback?: never): Promise<T>;\n async addLabelsToSpace<T = Models.LabelArray>(\n parameters: Parameters.AddLabelsToSpace,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/space/${parameters.spaceKey}/label`,\n method: 'POST',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n async deleteLabelFromSpace<T = void>(\n parameters: Parameters.DeleteLabelFromSpace,\n callback: Callback<T>,\n ): Promise<void>;\n async deleteLabelFromSpace<T = void>(parameters: Parameters.DeleteLabelFromSpace, callback?: never): Promise<T>;\n async deleteLabelFromSpace<T = void>(\n parameters: Parameters.DeleteLabelFromSpace,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/space/${parameters.spaceKey}/label`,\n method: 'DELETE',\n params: {\n name: parameters.name,\n prefix: parameters.prefix,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the properties for a user as list of property keys. For more information about user properties, see\n * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n * `Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getUserProperties<T = Models.UserPropertyKeyArray>(\n parameters: Parameters.GetUserProperties,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the properties for a user as list of property keys. For more information about user properties, see\n * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n * `Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getUserProperties<T = Models.UserPropertyKeyArray>(\n parameters: Parameters.GetUserProperties,\n callback?: never,\n ): Promise<T>;\n async getUserProperties<T = Models.UserPropertyKeyArray>(\n parameters: Parameters.GetUserProperties,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property`,\n method: 'GET',\n params: {\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence\n * entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getUserProperty<T = Models.UserProperty>(\n parameters: Parameters.GetUserProperty,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence\n * entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;\n async getUserProperty<T = Models.UserProperty>(\n parameters: Parameters.GetUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Creates a property for a user. For more information about user properties, see [Confluence entity properties]\n * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored\n * against a user are on a Confluence site level and not space/content level.\n *\n * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by\n * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access\n * the Confluence site ('Can use' global permission).\n */\n async createUserProperty<T = unknown>(\n parameters: Parameters.CreateUserProperty,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Creates a property for a user. For more information about user properties, see [Confluence entity properties]\n * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored\n * against a user are on a Confluence site level and not space/content level.\n *\n * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by\n * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access\n * the Confluence site ('Can use' global permission).\n */\n async createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;\n async createUserProperty<T = unknown>(\n parameters: Parameters.CreateUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'POST',\n data: {\n value: parameters.value,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more\n * information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;\n /**\n * Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more\n * information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;\n async updateUserProperty<T = void>(\n parameters: Parameters.UpdateUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'PUT',\n data: {\n value: parameters.value,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Deletes a property for the given user. For more information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;\n /**\n * Deletes a property for the given user. For more information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;\n async deleteUserProperty<T = void>(\n parameters: Parameters.DeleteUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'DELETE',\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,YAAY,CAAA;AACH,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAM,CAAA,MAAA,GAAN,MAAM;;AAiC1B,IAAA,MAAM,cAAc,CAClB,UAAqC,EACrC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,aAAA,EAAgB,UAAU,CAAC,EAAE,CAAW,SAAA,CAAA;AAC7C,YAAA,MAAM,EAAE,QAAQ;SACjB;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAmBlD,IAAA,MAAM,iBAAiB,CACrB,UAAwC,EACxC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,QAAQ,CAAQ,MAAA,CAAA;AAC9C,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AA8BlD,IAAA,MAAM,gBAAgB,CACpB,UAAuC,EACvC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,QAAQ,CAAQ,MAAA,CAAA;AAC9C,YAAA,MAAM,EAAE,MAAM;SACf;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAQlD,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,QAAQ,CAAQ,MAAA,CAAA;AAC9C,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,MAAM,EAAE,UAAU,CAAC,MAAM;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AA2BlD,IAAA,MAAM,iBAAiB,CACrB,UAAwC,EACxC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,UAAA,EAAa,UAAU,CAAC,MAAM,CAAW,SAAA,CAAA;AAC9C,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAwBlD,IAAA,MAAM,eAAe,CACnB,UAAsC,EACtC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAa,UAAA,EAAA,UAAU,CAAC,GAAG,CAAE,CAAA;AAChE,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AA0BlD,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAa,UAAA,EAAA,UAAU,CAAC,GAAG,CAAE,CAAA;AAChE,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,IAAI,EAAE;gBACJ,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAuBlD,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAa,UAAA,EAAA,UAAU,CAAC,GAAG,CAAE,CAAA;AAChE,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,IAAI,EAAE;gBACJ,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAqBlD,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAa,UAAA,EAAA,UAAU,CAAC,GAAG,CAAE,CAAA;AAChE,YAAA,MAAM,EAAE,QAAQ;SACjB;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAEnD;;;;"}
|
|
1
|
+
{"version":3,"file":"experimental.cjs","sources":["../../../../src/api/experimental.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Client } from '../clients';\nimport type { Callback } from '../callback';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Experimental {\n constructor(private client: Client) {}\n\n /**\n * Moves a pagetree rooted at a page to the space's trash:\n *\n * - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.\n * - For every other combination of content type and status, this API is not supported.\n *\n * This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.\n *\n * Use the `/longtask/<taskId>` REST API to get the copy task status.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the\n * content is in.\n */\n async deletePageTree<T = Models.LongTask>(\n parameters: Parameters.DeletePageTree,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Moves a pagetree rooted at a page to the space's trash:\n *\n * - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.\n * - For every other combination of content type and status, this API is not supported.\n *\n * This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.\n *\n * Use the `/longtask/<taskId>` REST API to get the copy task status.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the\n * content is in.\n */\n async deletePageTree<T = Models.LongTask>(parameters: Parameters.DeletePageTree, callback?: never): Promise<T>;\n async deletePageTree<T = Models.LongTask>(\n parameters: Parameters.DeletePageTree,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/content/${parameters.id}/pageTree`,\n method: 'DELETE',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different\n * types of labels.\n */\n async getLabelsForSpace<T = Models.LabelArray>(\n parameters: Parameters.GetLabelsForSpace,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different\n * types of labels.\n */\n async getLabelsForSpace<T = Models.LabelArray>(\n parameters: Parameters.GetLabelsForSpace,\n callback?: never,\n ): Promise<T>;\n async getLabelsForSpace<T = Models.LabelArray>(\n parameters: Parameters.GetLabelsForSpace,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/space/${parameters.spaceKey}/label`,\n method: 'GET',\n params: {\n prefix: parameters.prefix,\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Adds labels to a piece of content. Does not modify the existing labels.\n *\n * Notes:\n *\n * - Labels can also be added when creating content ([Create content](#api-content-post)).\n * - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing\n * labels and replace them with the labels in the request.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.\n */\n async addLabelsToSpace<T = Models.LabelArray>(\n parameters: Parameters.AddLabelsToSpace,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Adds labels to a piece of content. Does not modify the existing labels.\n *\n * Notes:\n *\n * - Labels can also be added when creating content ([Create content](#api-content-post)).\n * - Labels can be updated when updating content ([Update content](#api-content-id-put)). This will delete the existing\n * labels and replace them with the labels in the request.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.\n */\n async addLabelsToSpace<T = Models.LabelArray>(parameters: Parameters.AddLabelsToSpace, callback?: never): Promise<T>;\n async addLabelsToSpace<T = Models.LabelArray>(\n parameters: Parameters.AddLabelsToSpace,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/space/${parameters.spaceKey}/label`,\n method: 'POST',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n async deleteLabelFromSpace<T = void>(\n parameters: Parameters.DeleteLabelFromSpace,\n callback: Callback<T>,\n ): Promise<void>;\n async deleteLabelFromSpace<T = void>(parameters: Parameters.DeleteLabelFromSpace, callback?: never): Promise<T>;\n async deleteLabelFromSpace<T = void>(\n parameters: Parameters.DeleteLabelFromSpace,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/space/${parameters.spaceKey}/label`,\n method: 'DELETE',\n params: {\n name: parameters.name,\n prefix: parameters.prefix,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the properties for a user as list of property keys. For more information about user properties, see\n * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n * `Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.getUserProperties` instead.\n */\n async getUserProperties<T = Models.UserPropertyKeyArray>(\n parameters: Parameters.GetUserProperties,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the properties for a user as list of property keys. For more information about user properties, see\n * [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).\n * `Note`, these properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.getUserProperties` instead.\n */\n async getUserProperties<T = Models.UserPropertyKeyArray>(\n parameters: Parameters.GetUserProperties,\n callback?: never,\n ): Promise<T>;\n async getUserProperties<T = Models.UserPropertyKeyArray>(\n parameters: Parameters.GetUserProperties,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property`,\n method: 'GET',\n params: {\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence\n * entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.getUserProperty` instead.\n */\n async getUserProperty<T = Models.UserProperty>(\n parameters: Parameters.GetUserProperty,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence\n * entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.getUserProperty` instead.\n */\n async getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;\n async getUserProperty<T = Models.UserProperty>(\n parameters: Parameters.GetUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Creates a property for a user. For more information about user properties, see [Confluence entity properties]\n * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored\n * against a user are on a Confluence site level and not space/content level.\n *\n * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by\n * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access\n * the Confluence site ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.createUserProperty` instead.\n */\n async createUserProperty<T = unknown>(\n parameters: Parameters.CreateUserProperty,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Creates a property for a user. For more information about user properties, see [Confluence entity properties]\n * (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored\n * against a user are on a Confluence site level and not space/content level.\n *\n * `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by\n * fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access\n * the Confluence site ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.createUserProperty` instead.\n */\n async createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;\n async createUserProperty<T = unknown>(\n parameters: Parameters.CreateUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'POST',\n data: {\n value: parameters.value,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more\n * information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.updateUserProperty` instead.\n */\n async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;\n /**\n * Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more\n * information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.updateUserProperty` instead.\n */\n async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;\n async updateUserProperty<T = void>(\n parameters: Parameters.UpdateUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'PUT',\n data: {\n value: parameters.value,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Deletes a property for the given user. For more information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.deleteUserProperty` instead.\n */\n async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;\n /**\n * Deletes a property for the given user. For more information about user properties, see [Confluence entity\n * properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these\n * properties stored against a user are on a Confluence site level and not space/content level.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `userProperties.deleteUserProperty` instead.\n */\n async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;\n async deleteUserProperty<T = void>(\n parameters: Parameters.DeleteUserProperty,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/user/${parameters.userId}/property/${parameters.key}`,\n method: 'DELETE',\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,YAAY,CAAA;AACH,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AAiCrC,IAAA,MAAM,cAAc,CAClB,UAAqC,EACrC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,aAAA,EAAgB,UAAU,CAAC,EAAE,CAAA,SAAA,CAAW;AAC7C,YAAA,MAAM,EAAE,QAAQ;SACjB;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAkBA,IAAA,MAAM,iBAAiB,CACrB,UAAwC,EACxC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,QAAQ,CAAA,MAAA,CAAQ;AAC9C,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA6BA,IAAA,MAAM,gBAAgB,CACpB,UAAuC,EACvC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,QAAQ,CAAA,MAAA,CAAQ;AAC9C,YAAA,MAAM,EAAE,MAAM;SACf;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAOA,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,QAAQ,CAAA,MAAA,CAAQ;AAC9C,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,MAAM,EAAE,UAAU,CAAC,MAAM;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA8BA,IAAA,MAAM,iBAAiB,CACrB,UAAwC,EACxC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,UAAA,EAAa,UAAU,CAAC,MAAM,CAAA,SAAA,CAAW;AAC9C,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA2BA,IAAA,MAAM,eAAe,CACnB,UAAsC,EACtC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAA,UAAA,EAAa,UAAU,CAAC,GAAG,CAAA,CAAE;AAChE,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA6BA,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAA,UAAA,EAAa,UAAU,CAAC,GAAG,CAAA,CAAE;AAChE,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,IAAI,EAAE;gBACJ,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA0BA,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAA,UAAA,EAAa,UAAU,CAAC,GAAG,CAAA,CAAE;AAChE,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,IAAI,EAAE;gBACJ,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAwBA,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,aAAa,UAAU,CAAC,MAAM,CAAA,UAAA,EAAa,UAAU,CAAC,GAAG,CAAA,CAAE;AAChE,YAAA,MAAM,EAAE,QAAQ;SACjB;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
package/dist/cjs/api/group.cjs
CHANGED
|
@@ -87,26 +87,28 @@ class Group {
|
|
|
87
87
|
};
|
|
88
88
|
return this.client.sendRequest(config, callback);
|
|
89
89
|
}
|
|
90
|
-
async
|
|
90
|
+
async searchGroups(parameters, callback) {
|
|
91
91
|
const config = {
|
|
92
|
-
url:
|
|
92
|
+
url: '/api/group/picker',
|
|
93
93
|
method: 'GET',
|
|
94
94
|
params: {
|
|
95
|
+
query: parameters.query,
|
|
95
96
|
start: parameters.start,
|
|
96
97
|
limit: parameters.limit,
|
|
98
|
+
shouldReturnTotalSize: parameters.shouldReturnTotalSize,
|
|
97
99
|
},
|
|
98
100
|
};
|
|
99
101
|
return this.client.sendRequest(config, callback);
|
|
100
102
|
}
|
|
101
|
-
async
|
|
103
|
+
async getGroupMembersByGroupId(parameters, callback) {
|
|
102
104
|
const config = {
|
|
103
|
-
url:
|
|
105
|
+
url: `/api/group/${parameters.groupId}/membersByGroupId`,
|
|
104
106
|
method: 'GET',
|
|
105
107
|
params: {
|
|
106
|
-
query: parameters.query,
|
|
107
108
|
start: parameters.start,
|
|
108
109
|
limit: parameters.limit,
|
|
109
110
|
shouldReturnTotalSize: parameters.shouldReturnTotalSize,
|
|
111
|
+
expand: parameters.expand,
|
|
110
112
|
},
|
|
111
113
|
};
|
|
112
114
|
return this.client.sendRequest(config, callback);
|
|
@@ -135,18 +137,6 @@ class Group {
|
|
|
135
137
|
};
|
|
136
138
|
return this.client.sendRequest(config, callback);
|
|
137
139
|
}
|
|
138
|
-
async getGroupMembersByGroupId(parameters, callback) {
|
|
139
|
-
const config = {
|
|
140
|
-
url: `/api/group/${parameters.groupId}/membersByGroupId`,
|
|
141
|
-
method: 'GET',
|
|
142
|
-
params: {
|
|
143
|
-
start: parameters.start,
|
|
144
|
-
limit: parameters.limit,
|
|
145
|
-
shouldReturnTotalSize: parameters.shouldReturnTotalSize,
|
|
146
|
-
},
|
|
147
|
-
};
|
|
148
|
-
return this.client.sendRequest(config, callback);
|
|
149
|
-
}
|
|
150
140
|
async addUserToGroup(parameters, callback) {
|
|
151
141
|
const config = {
|
|
152
142
|
url: '/api/group/user',
|
|
@@ -171,6 +161,17 @@ class Group {
|
|
|
171
161
|
};
|
|
172
162
|
return this.client.sendRequest(config, callback);
|
|
173
163
|
}
|
|
164
|
+
async getGroupMembers(parameters, callback) {
|
|
165
|
+
const config = {
|
|
166
|
+
url: `/api/group/${parameters.groupName}/member`,
|
|
167
|
+
method: 'GET',
|
|
168
|
+
params: {
|
|
169
|
+
start: parameters.start,
|
|
170
|
+
limit: parameters.limit,
|
|
171
|
+
},
|
|
172
|
+
};
|
|
173
|
+
return this.client.sendRequest(config, callback);
|
|
174
|
+
}
|
|
174
175
|
}
|
|
175
176
|
|
|
176
177
|
exports.Group = Group;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"group.cjs","sources":["../../../../src/api/group.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Callback } from '../callback';\nimport type { Client } from '../clients';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Group {\n constructor(private client: Client) {}\n\n /**\n * Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroups<T = Models.GroupArrayWithLinks>(\n parameters: Parameters.GetGroups | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroups<T = Models.GroupArrayWithLinks>(parameters?: Parameters.GetGroups, callback?: never): Promise<T>;\n async getGroups<T = Models.GroupArrayWithLinks>(\n parameters?: Parameters.GetGroups,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group',\n method: 'GET',\n params: {\n start: parameters?.start,\n limit: parameters?.limit,\n accessType: parameters?.accessType,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Creates a new user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async createGroup<T = Models.Group>(\n parameters: Parameters.CreateGroup | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Creates a new user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async createGroup<T = Models.Group>(parameters?: Parameters.CreateGroup, callback?: never): Promise<T>;\n async createGroup<T = Models.Group>(parameters?: Parameters.CreateGroup, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group',\n method: 'POST',\n data: {\n name: parameters?.name,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback: Callback<T>): Promise<void>;\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: never): Promise<T>;\n async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group',\n method: 'DELETE',\n params: {\n name: parameters.name,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a user group for a given group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByQueryParam<T = Models.Group>(\n parameters: Parameters.GetGroupByQueryParam,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns a user group for a given group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByQueryParam<T = Models.Group>(\n parameters: Parameters.GetGroupByQueryParam,\n callback?: never,\n ): Promise<T>;\n async getGroupByQueryParam<T = Models.Group>(\n parameters: Parameters.GetGroupByQueryParam,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/by-name',\n method: 'GET',\n params: {\n name: parameters.name,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a user group for a given group id.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByGroupId<T = Models.Group>(\n parameters: Parameters.GetGroupByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns a user group for a given group id.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByGroupId<T = Models.Group>(parameters: Parameters.GetGroupByGroupId, callback?: never): Promise<T>;\n async getGroupByGroupId<T = Models.Group>(\n parameters: Parameters.GetGroupByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/by-id',\n method: 'GET',\n params: {\n id: parameters.id,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback: Callback<T>): Promise<void>;\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: never): Promise<T>;\n async removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/by-id',\n method: 'DELETE',\n params: {\n id: parameters.id,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a user group for a given group name.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback: Callback<T>): Promise<void>;\n /**\n * Returns a user group for a given group name.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback?: never): Promise<T>;\n async getGroupByName<T = Models.Group>(\n parameters: Parameters.GetGroupByName,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/group/${parameters.groupName}`,\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the users that are members of a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getMembersByQueryParam<T = Models.UserArray>(\n parameters: Parameters.GetMembersByQueryParam,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the users that are members of a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getMembersByQueryParam<T = Models.UserArray>(\n parameters: Parameters.GetMembersByQueryParam,\n callback?: never,\n ): Promise<T>;\n async getMembersByQueryParam<T = Models.UserArray>(\n parameters: Parameters.GetMembersByQueryParam,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/member',\n method: 'GET',\n params: {\n name: parameters.name,\n start: parameters.start,\n limit: parameters.limit,\n shouldReturnTotalSize: parameters.shouldReturnTotalSize,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupMembers<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembers,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;\n async getGroupMembers<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembers,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/group/${parameters.groupName}/member`,\n method: 'GET',\n params: {\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /** Get search results of groups by partial query provided. */\n async searchGroups<T = Models.GroupArrayWithLinks>(\n parameters: Parameters.SearchGroups,\n callback: Callback<T>,\n ): Promise<void>;\n /** Get search results of groups by partial query provided. */\n async searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;\n async searchGroups<T = Models.GroupArrayWithLinks>(\n parameters: Parameters.SearchGroups,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/picker',\n method: 'GET',\n params: {\n query: parameters.query,\n start: parameters.start,\n limit: parameters.limit,\n shouldReturnTotalSize: parameters.shouldReturnTotalSize,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Adds a user as a member in a group represented by its groupId\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroupByGroupId<T = unknown>(\n parameters: Parameters.AddUserToGroupByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Adds a user as a member in a group represented by its groupId\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroupByGroupId<T = unknown>(\n parameters: Parameters.AddUserToGroupByGroupId,\n callback?: never,\n ): Promise<T>;\n async addUserToGroupByGroupId<T = unknown>(\n parameters: Parameters.AddUserToGroupByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/userByGroupId',\n method: 'POST',\n params: {\n groupId: parameters.groupId,\n },\n data: {\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroupByGroupId<T = void>(\n parameters: Parameters.RemoveMemberFromGroupByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroupByGroupId<T = void>(\n parameters: Parameters.RemoveMemberFromGroupByGroupId,\n callback?: never,\n ): Promise<T>;\n async removeMemberFromGroupByGroupId<T = void>(\n parameters: Parameters.RemoveMemberFromGroupByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/userByGroupId',\n method: 'DELETE',\n params: {\n groupId: parameters.groupId,\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupMembersByGroupId<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembersByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupMembersByGroupId<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembersByGroupId,\n callback?: never,\n ): Promise<T>;\n async getGroupMembersByGroupId<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembersByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/group/${parameters.groupId}/membersByGroupId`,\n method: 'GET',\n params: {\n start: parameters.start,\n limit: parameters.limit,\n shouldReturnTotalSize: parameters.shouldReturnTotalSize,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Adds a user as a member in a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroup<T = unknown>(parameters: Parameters.AddUserToGroup, callback: Callback<T>): Promise<void>;\n /**\n * Adds a user as a member in a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroup<T = unknown>(parameters: Parameters.AddUserToGroup, callback?: never): Promise<T>;\n async addUserToGroup<T = unknown>(parameters: Parameters.AddUserToGroup, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/user',\n method: 'POST',\n params: {\n name: parameters.name,\n },\n data: {\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroup<T = void>(\n parameters: Parameters.RemoveMemberFromGroup,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroup<T = void>(parameters: Parameters.RemoveMemberFromGroup, callback?: never): Promise<T>;\n async removeMemberFromGroup<T = void>(\n parameters: Parameters.RemoveMemberFromGroup,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/user',\n method: 'DELETE',\n params: {\n name: parameters.name,\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,KAAK,CAAA;AACI,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAM,CAAA,MAAA,GAAN,MAAM;;AAmB1B,IAAA,MAAM,SAAS,CACb,UAAiC,EACjC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,YAAY;AACjB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,UAAU,EAAE,UAAU,EAAE,UAAU;AACnC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAkBlD,IAAA,MAAM,WAAW,CAAmB,UAAmC,EAAE,QAAsB,EAAA;AAC7F,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,YAAY;AACjB,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,IAAI,EAAE;gBACJ,IAAI,EAAE,UAAU,EAAE,IAAI;AACvB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAelD,IAAA,MAAM,WAAW,CAAW,UAAkC,EAAE,QAAsB,EAAA;AACpF,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,YAAY;AACjB,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;AACtB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAuBlD,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,oBAAoB;AACzB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;AACtB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAoBlD,IAAA,MAAM,iBAAiB,CACrB,UAAwC,EACxC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kBAAkB;AACvB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,EAAE,EAAE,UAAU,CAAC,EAAE;AAClB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAelD,IAAA,MAAM,eAAe,CAAW,UAAsC,EAAE,QAAsB,EAAA;AAC5F,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kBAAkB;AACvB,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,EAAE,EAAE,UAAU,CAAC,EAAE;AAClB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAqBlD,IAAA,MAAM,cAAc,CAClB,UAAqC,EACrC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,SAAS,CAAE,CAAA;AACzC,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAuBlD,IAAA,MAAM,sBAAsB,CAC1B,UAA6C,EAC7C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,mBAAmB;AACxB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;AACxD,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAwBlD,IAAA,MAAM,eAAe,CACnB,UAAsC,EACtC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,SAAS,CAAS,OAAA,CAAA;AAChD,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAUlD,IAAA,MAAM,YAAY,CAChB,UAAmC,EACnC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,mBAAmB;AACxB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;AACxD,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAqBlD,IAAA,MAAM,uBAAuB,CAC3B,UAA8C,EAC9C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,0BAA0B;AAC/B,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,MAAM,EAAE;gBACN,OAAO,EAAE,UAAU,CAAC,OAAO;AAC5B,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAqBlD,IAAA,MAAM,8BAA8B,CAClC,UAAqD,EACrD,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,0BAA0B;AAC/B,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AA2BlD,IAAA,MAAM,wBAAwB,CAC5B,UAA+C,EAC/C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,OAAO,CAAmB,iBAAA,CAAA;AACxD,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;AACxD,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAelD,IAAA,MAAM,cAAc,CAAc,UAAqC,EAAE,QAAsB,EAAA;AAC7F,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,iBAAiB;AACtB,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;AACtB,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAkBlD,IAAA,MAAM,qBAAqB,CACzB,UAA4C,EAC5C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,iBAAiB;AACtB,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAEnD;;;;"}
|
|
1
|
+
{"version":3,"file":"group.cjs","sources":["../../../../src/api/group.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Client } from '../clients';\nimport type { Callback } from '../callback';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Group {\n constructor(private client: Client) {}\n\n /**\n * Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroups<T = Models.GroupArrayWithLinks>(\n parameters: Parameters.GetGroups | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroups<T = Models.GroupArrayWithLinks>(parameters?: Parameters.GetGroups, callback?: never): Promise<T>;\n async getGroups<T = Models.GroupArrayWithLinks>(\n parameters?: Parameters.GetGroups,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group',\n method: 'GET',\n params: {\n start: parameters?.start,\n limit: parameters?.limit,\n accessType: parameters?.accessType,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Creates a new user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async createGroup<T = Models.Group>(\n parameters: Parameters.CreateGroup | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Creates a new user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async createGroup<T = Models.Group>(parameters?: Parameters.CreateGroup, callback?: never): Promise<T>;\n async createGroup<T = Models.Group>(parameters?: Parameters.CreateGroup, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group',\n method: 'POST',\n data: {\n name: parameters?.name,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n *\n * @deprecated Will be removed in next major version.\n */\n async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback: Callback<T>): Promise<void>;\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n *\n * @deprecated Will be removed in next major version.\n */\n async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: never): Promise<T>;\n async removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group',\n method: 'DELETE',\n params: {\n name: parameters.name,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a user group for a given group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version.\n */\n async getGroupByQueryParam<T = Models.Group>(\n parameters: Parameters.GetGroupByQueryParam,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns a user group for a given group name.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version.\n */\n async getGroupByQueryParam<T = Models.Group>(\n parameters: Parameters.GetGroupByQueryParam,\n callback?: never,\n ): Promise<T>;\n async getGroupByQueryParam<T = Models.Group>(\n parameters: Parameters.GetGroupByQueryParam,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/by-name',\n method: 'GET',\n params: {\n name: parameters.name,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a user group for a given group id.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByGroupId<T = Models.Group>(\n parameters: Parameters.GetGroupByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns a user group for a given group id.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupByGroupId<T = Models.Group>(parameters: Parameters.GetGroupByGroupId, callback?: never): Promise<T>;\n async getGroupByGroupId<T = Models.Group>(\n parameters: Parameters.GetGroupByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/by-id',\n method: 'GET',\n params: {\n id: parameters.id,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback: Callback<T>): Promise<void>;\n /**\n * Delete user group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback?: never): Promise<T>;\n async removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/by-id',\n method: 'DELETE',\n params: {\n id: parameters.id,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns a user group for a given group name.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version.\n */\n async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback: Callback<T>): Promise<void>;\n /**\n * Returns a user group for a given group name.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version.\n */\n async getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback?: never): Promise<T>;\n async getGroupByName<T = Models.Group>(\n parameters: Parameters.GetGroupByName,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/group/${parameters.groupName}`,\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the users that are members of a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version.\n */\n async getMembersByQueryParam<T = Models.UserArray>(\n parameters: Parameters.GetMembersByQueryParam,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the users that are members of a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version.\n */\n async getMembersByQueryParam<T = Models.UserArray>(\n parameters: Parameters.GetMembersByQueryParam,\n callback?: never,\n ): Promise<T>;\n async getMembersByQueryParam<T = Models.UserArray>(\n parameters: Parameters.GetMembersByQueryParam,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/member',\n method: 'GET',\n params: {\n name: parameters.name,\n start: parameters.start,\n limit: parameters.limit,\n shouldReturnTotalSize: parameters.shouldReturnTotalSize,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /** Get search results of groups by partial query provided. */\n async searchGroups<T = Models.GroupArrayWithLinks>(\n parameters: Parameters.SearchGroups,\n callback: Callback<T>,\n ): Promise<void>;\n /** Get search results of groups by partial query provided. */\n async searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;\n async searchGroups<T = Models.GroupArrayWithLinks>(\n parameters: Parameters.SearchGroups,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/picker',\n method: 'GET',\n params: {\n query: parameters.query,\n start: parameters.start,\n limit: parameters.limit,\n shouldReturnTotalSize: parameters.shouldReturnTotalSize,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupMembersByGroupId<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembersByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getGroupMembersByGroupId<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembersByGroupId,\n callback?: never,\n ): Promise<T>;\n async getGroupMembersByGroupId<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembersByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/group/${parameters.groupId}/membersByGroupId`,\n method: 'GET',\n params: {\n start: parameters.start,\n limit: parameters.limit,\n shouldReturnTotalSize: parameters.shouldReturnTotalSize,\n expand: parameters.expand,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Adds a user as a member in a group represented by its groupId\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroupByGroupId<T = unknown>(\n parameters: Parameters.AddUserToGroupByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Adds a user as a member in a group represented by its groupId\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroupByGroupId<T = unknown>(\n parameters: Parameters.AddUserToGroupByGroupId,\n callback?: never,\n ): Promise<T>;\n async addUserToGroupByGroupId<T = unknown>(\n parameters: Parameters.AddUserToGroupByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/userByGroupId',\n method: 'POST',\n params: {\n groupId: parameters.groupId,\n },\n data: {\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroupByGroupId<T = void>(\n parameters: Parameters.RemoveMemberFromGroupByGroupId,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroupByGroupId<T = void>(\n parameters: Parameters.RemoveMemberFromGroupByGroupId,\n callback?: never,\n ): Promise<T>;\n async removeMemberFromGroupByGroupId<T = void>(\n parameters: Parameters.RemoveMemberFromGroupByGroupId,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/userByGroupId',\n method: 'DELETE',\n params: {\n groupId: parameters.groupId,\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Adds a user as a member in a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroup<T = unknown>(parameters: Parameters.AddUserToGroup, callback: Callback<T>): Promise<void>;\n /**\n * Adds a user as a member in a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async addUserToGroup<T = unknown>(parameters: Parameters.AddUserToGroup, callback?: never): Promise<T>;\n async addUserToGroup<T = unknown>(parameters: Parameters.AddUserToGroup, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/user',\n method: 'POST',\n params: {\n name: parameters.name,\n },\n data: {\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroup<T = void>(\n parameters: Parameters.RemoveMemberFromGroup,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Remove user as a member from a group.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.\n */\n async removeMemberFromGroup<T = void>(parameters: Parameters.RemoveMemberFromGroup, callback?: never): Promise<T>;\n async removeMemberFromGroup<T = void>(\n parameters: Parameters.RemoveMemberFromGroup,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/group/user',\n method: 'DELETE',\n params: {\n name: parameters.name,\n accountId: parameters.accountId,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `group.getGroupMembersByGroupId`\n */\n async getGroupMembers<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembers,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the users that are members of a group.\n *\n * Use updated Get group API\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n *\n * @deprecated Will be removed in next major version. Use `group.getGroupMembersByGroupId`\n */\n async getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;\n async getGroupMembers<T = Models.UserArray>(\n parameters: Parameters.GetGroupMembers,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/group/${parameters.groupName}/member`,\n method: 'GET',\n params: {\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,KAAK,CAAA;AACI,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AAmBrC,IAAA,MAAM,SAAS,CACb,UAAiC,EACjC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,YAAY;AACjB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,UAAU,EAAE,UAAU,EAAE,UAAU;AACnC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAiBA,IAAA,MAAM,WAAW,CAAmB,UAAmC,EAAE,QAAsB,EAAA;AAC7F,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,YAAY;AACjB,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,IAAI,EAAE;gBACJ,IAAI,EAAE,UAAU,EAAE,IAAI;AACvB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAkBA,IAAA,MAAM,WAAW,CAAW,UAAkC,EAAE,QAAsB,EAAA;AACpF,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,YAAY;AACjB,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;AACtB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA0BA,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,oBAAoB;AACzB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;AACtB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAmBA,IAAA,MAAM,iBAAiB,CACrB,UAAwC,EACxC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kBAAkB;AACvB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,EAAE,EAAE,UAAU,CAAC,EAAE;AAClB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAcA,IAAA,MAAM,eAAe,CAAW,UAAsC,EAAE,QAAsB,EAAA;AAC5F,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kBAAkB;AACvB,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,EAAE,EAAE,UAAU,CAAC,EAAE;AAClB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAwBA,IAAA,MAAM,cAAc,CAClB,UAAqC,EACrC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,SAAS,CAAA,CAAE;AACzC,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA0BA,IAAA,MAAM,sBAAsB,CAC1B,UAA6C,EAC7C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,mBAAmB;AACxB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;AACxD,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AASA,IAAA,MAAM,YAAY,CAChB,UAAmC,EACnC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,mBAAmB;AACxB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;AACxD,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA0BA,IAAA,MAAM,wBAAwB,CAC5B,UAA+C,EAC/C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,OAAO,CAAA,iBAAA,CAAmB;AACxD,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;gBACvD,MAAM,EAAE,UAAU,CAAC,MAAM;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAoBA,IAAA,MAAM,uBAAuB,CAC3B,UAA8C,EAC9C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,0BAA0B;AAC/B,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,MAAM,EAAE;gBACN,OAAO,EAAE,UAAU,CAAC,OAAO;AAC5B,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAoBA,IAAA,MAAM,8BAA8B,CAClC,UAAqD,EACrD,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,0BAA0B;AAC/B,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAcA,IAAA,MAAM,cAAc,CAAc,UAAqC,EAAE,QAAsB,EAAA;AAC7F,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,iBAAiB;AACtB,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;AACtB,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAiBA,IAAA,MAAM,qBAAqB,CACzB,UAA4C,EAC5C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,iBAAiB;AACtB,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,SAAS,EAAE,UAAU,CAAC,SAAS;AAChC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA2BA,IAAA,MAAM,eAAe,CACnB,UAAsC,EACtC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,WAAA,EAAc,UAAU,CAAC,SAAS,CAAA,OAAA,CAAS;AAChD,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
package/dist/cjs/api/index.cjs
CHANGED
|
@@ -31,6 +31,7 @@ var spaceSettings = require('./spaceSettings.cjs');
|
|
|
31
31
|
var template = require('./template.cjs');
|
|
32
32
|
var themes = require('./themes.cjs');
|
|
33
33
|
var users = require('./users.cjs');
|
|
34
|
+
var userProperties = require('./userProperties.cjs');
|
|
34
35
|
|
|
35
36
|
|
|
36
37
|
|
|
@@ -65,4 +66,5 @@ exports.SpaceSettings = spaceSettings.SpaceSettings;
|
|
|
65
66
|
exports.Template = template.Template;
|
|
66
67
|
exports.Themes = themes.Themes;
|
|
67
68
|
exports.Users = users.Users;
|
|
69
|
+
exports.UserProperties = userProperties.UserProperties;
|
|
68
70
|
//# sourceMappingURL=index.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inlineTasks.cjs","sources":["../../../../src/api/inlineTasks.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Callback } from '../callback';\nimport type { Client } from '../clients';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class InlineTasks {\n constructor(private client: Client) {}\n\n /**\n * Returns inline tasks based on the search query.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.\n */\n async searchTasks<T = Models.TaskPageResponse>(\n parameters: Parameters.SearchTasks | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns inline tasks based on the search query.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.\n */\n async searchTasks<T = Models.TaskPageResponse>(parameters?: Parameters.SearchTasks, callback?: never): Promise<T>;\n async searchTasks<T = Models.TaskPageResponse>(\n parameters?: Parameters.SearchTasks,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/inlinetasks/search',\n method: 'GET',\n params: {\n start: parameters?.start,\n limit: parameters?.limit,\n spaceKey: parameters?.spaceKey,\n pageId: parameters?.pageId,\n assignee: parameters?.assignee,\n creator: parameters?.creator,\n completedUser: parameters?.completedUser,\n duedateFrom: parameters?.duedateFrom,\n duedateTo: parameters?.duedateTo,\n createdateFrom: parameters?.createdateFrom,\n createdateTo: parameters?.createdateTo,\n completedateFrom: parameters?.completedateFrom,\n completedateTo: parameters?.completedateTo,\n status: parameters?.status,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns inline task based on the global ID.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated\n * with the task.\n */\n async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback: Callback<T>): Promise<void>;\n /**\n * Returns inline task based on the global ID.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated\n * with the task.\n */\n async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;\n async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/inlinetasks/${parameters.inlineTaskId}`,\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Updates an inline tasks status given its global ID\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated\n * with the task.\n */\n async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback: Callback<T>): Promise<void>;\n /**\n * Updates an inline tasks status given its global ID\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated\n * with the task.\n */\n async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;\n async updateTaskById<T = Models.Task>(\n parameters: Parameters.UpdateTaskById,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/inlinetasks/${parameters.inlineTaskId}`,\n method: 'PUT',\n data: {\n status: parameters.status,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"inlineTasks.cjs","sources":["../../../../src/api/inlineTasks.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Callback } from '../callback';\nimport type { Client } from '../clients';\nimport type { RequestConfig } from '../requestConfig';\n\n/** @deprecated Will be removed in next major version. */\nexport class InlineTasks {\n constructor(private client: Client) {}\n\n /**\n * Returns inline tasks based on the search query.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.\n *\n * @deprecated Will be removed in next major version.\n */\n async searchTasks<T = Models.TaskPageResponse>(\n parameters: Parameters.SearchTasks | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns inline tasks based on the search query.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.\n *\n * @deprecated Will be removed in next major version.\n */\n async searchTasks<T = Models.TaskPageResponse>(parameters?: Parameters.SearchTasks, callback?: never): Promise<T>;\n async searchTasks<T = Models.TaskPageResponse>(\n parameters?: Parameters.SearchTasks,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/inlinetasks/search',\n method: 'GET',\n params: {\n start: parameters?.start,\n limit: parameters?.limit,\n spaceKey: parameters?.spaceKey,\n pageId: parameters?.pageId,\n assignee: parameters?.assignee,\n creator: parameters?.creator,\n completedUser: parameters?.completedUser,\n duedateFrom: parameters?.duedateFrom,\n duedateTo: parameters?.duedateTo,\n createdateFrom: parameters?.createdateFrom,\n createdateTo: parameters?.createdateTo,\n completedateFrom: parameters?.completedateFrom,\n completedateTo: parameters?.completedateTo,\n status: parameters?.status,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns inline task based on the global ID.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated\n * with the task.\n *\n * @deprecated Will be removed in next major version.\n */\n async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback: Callback<T>): Promise<void>;\n /**\n * Returns inline task based on the global ID.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated\n * with the task.\n *\n * @deprecated Will be removed in next major version.\n */\n async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;\n async getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/inlinetasks/${parameters.inlineTaskId}`,\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Updates an inline tasks status given its global ID\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated\n * with the task.\n *\n * @deprecated Will be removed in next major version.\n */\n async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback: Callback<T>): Promise<void>;\n /**\n * Updates an inline tasks status given its global ID\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated\n * with the task.\n *\n * @deprecated Will be removed in next major version.\n */\n async updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;\n async updateTaskById<T = Models.Task>(\n parameters: Parameters.UpdateTaskById,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/inlinetasks/${parameters.inlineTaskId}`,\n method: 'PUT',\n data: {\n status: parameters.status,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;AAMA;MACa,WAAW,CAAA;AACF,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AAuBrC,IAAA,MAAM,WAAW,CACf,UAAmC,EACnC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,yBAAyB;AAC9B,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,QAAQ,EAAE,UAAU,EAAE,QAAQ;gBAC9B,MAAM,EAAE,UAAU,EAAE,MAAM;gBAC1B,QAAQ,EAAE,UAAU,EAAE,QAAQ;gBAC9B,OAAO,EAAE,UAAU,EAAE,OAAO;gBAC5B,aAAa,EAAE,UAAU,EAAE,aAAa;gBACxC,WAAW,EAAE,UAAU,EAAE,WAAW;gBACpC,SAAS,EAAE,UAAU,EAAE,SAAS;gBAChC,cAAc,EAAE,UAAU,EAAE,cAAc;gBAC1C,YAAY,EAAE,UAAU,EAAE,YAAY;gBACtC,gBAAgB,EAAE,UAAU,EAAE,gBAAgB;gBAC9C,cAAc,EAAE,UAAU,EAAE,cAAc;gBAC1C,MAAM,EAAE,UAAU,EAAE,MAAM;AAC3B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAoBA,IAAA,MAAM,WAAW,CAAkB,UAAkC,EAAE,QAAsB,EAAA;AAC3F,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,iBAAA,EAAoB,UAAU,CAAC,YAAY,CAAA,CAAE;AAClD,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAoBA,IAAA,MAAM,cAAc,CAClB,UAAqC,EACrC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,iBAAA,EAAoB,UAAU,CAAC,YAAY,CAAA,CAAE;AAClD,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,IAAI,EAAE;gBACJ,MAAM,EAAE,UAAU,CAAC,MAAM;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"labelInfo.cjs","sources":["../../../../src/api/labelInfo.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type {
|
|
1
|
+
{"version":3,"file":"labelInfo.cjs","sources":["../../../../src/api/labelInfo.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Client } from '../clients';\nimport type { Callback } from '../callback';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class LabelInfo {\n constructor(private client: Client) {}\n\n /**\n * Returns label information and a list of contents associated with the label.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). Only contents that the user is permitted to view is returned.\n */\n async getAllLabelContent<T = Models.LabelDetails>(\n parameters: Parameters.GetAllLabelContent,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns label information and a list of contents associated with the label.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). Only contents that the user is permitted to view is returned.\n */\n async getAllLabelContent<T = Models.LabelDetails>(\n parameters: Parameters.GetAllLabelContent,\n callback?: never,\n ): Promise<T>;\n async getAllLabelContent<T = Models.LabelDetails>(\n parameters: Parameters.GetAllLabelContent,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/label',\n method: 'GET',\n params: {\n name: parameters.name,\n type: parameters.type,\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,SAAS,CAAA;AACA,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AAsBrC,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,YAAY;AACjB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"longRunningTask.cjs","sources":["../../../../src/api/longRunningTask.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type {
|
|
1
|
+
{"version":3,"file":"longRunningTask.cjs","sources":["../../../../src/api/longRunningTask.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Client } from '../clients';\nimport type { Callback } from '../callback';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class LongRunningTask {\n constructor(private client: Client) {}\n\n /**\n * Returns information about all active long-running tasks (e.g. space export), such as how long each task has been\n * running and the percentage of each task that has completed.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getTasks<T = Models.LongTaskStatusArray>(\n parameters: Parameters.GetTasks | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns information about all active long-running tasks (e.g. space export), such as how long each task has been\n * running and the percentage of each task that has completed.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getTasks<T = Models.LongTaskStatusArray>(parameters?: Parameters.GetTasks, callback?: never): Promise<T>;\n async getTasks<T = Models.LongTaskStatusArray>(\n parameters?: Parameters.GetTasks,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/longtask',\n method: 'GET',\n params: {\n key: parameters?.key,\n start: parameters?.start,\n limit: parameters?.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns information about an active long-running task (e.g. space export), such as how long it has been running and\n * the percentage of the task that has completed.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getTask<T = Models.LongTaskStatusWithLinks>(\n parameters: Parameters.GetTask,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns information about an active long-running task (e.g. space export), such as how long it has been running and\n * the percentage of the task that has completed.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getTask<T = Models.LongTaskStatusWithLinks>(parameters: Parameters.GetTask, callback?: never): Promise<T>;\n async getTask<T = Models.LongTaskStatusWithLinks>(\n parameters: Parameters.GetTask,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/longtask/${parameters.id}`,\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,eAAe,CAAA;AACN,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AAqBrC,IAAA,MAAM,QAAQ,CACZ,UAAgC,EAChC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,eAAe;AACpB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,GAAG,EAAE,UAAU,EAAE,GAAG;gBACpB,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,KAAK,EAAE,UAAU,EAAE,KAAK;AACzB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAqBA,IAAA,MAAM,OAAO,CACX,UAA8B,EAC9B,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,cAAA,EAAiB,UAAU,CAAC,EAAE,CAAA,CAAE;AACrC,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"labeledContentType.cjs","sources":["../../../../../src/api/models/labeledContentType.ts"],"sourcesContent":["export enum LabeledContentType {\n Page = 'page',\n Blogpost = 'blogpost',\n Attachment = 'attachment',\n PageTemplate = 'page_template',\n}\n"],"names":["LabeledContentType"],"mappings":";;AAAYA;AAAZ,CAAA,UAAY,kBAAkB,EAAA;AAC5B,IAAA,kBAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACb,IAAA,kBAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACrB,IAAA,kBAAA,CAAA,YAAA,CAAA,GAAA,YAAyB;AACzB,IAAA,kBAAA,CAAA,cAAA,CAAA,GAAA,eAA8B;AAChC,CAAC,EALWA,0BAAkB,KAAlBA,0BAAkB,
|
|
1
|
+
{"version":3,"file":"labeledContentType.cjs","sources":["../../../../../src/api/models/labeledContentType.ts"],"sourcesContent":["export enum LabeledContentType {\n Page = 'page',\n Blogpost = 'blogpost',\n Attachment = 'attachment',\n PageTemplate = 'page_template',\n}\n"],"names":["LabeledContentType"],"mappings":";;AAAYA;AAAZ,CAAA,UAAY,kBAAkB,EAAA;AAC5B,IAAA,kBAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACb,IAAA,kBAAA,CAAA,UAAA,CAAA,GAAA,UAAqB;AACrB,IAAA,kBAAA,CAAA,YAAA,CAAA,GAAA,YAAyB;AACzB,IAAA,kBAAA,CAAA,cAAA,CAAA,GAAA,eAA8B;AAChC,CAAC,EALWA,0BAAkB,KAAlBA,0BAAkB,GAAA,EAAA,CAAA,CAAA;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"relation.cjs","sources":["../../../../src/api/relation.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Callback } from '../callback';\nimport type { Client } from '../clients';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Relation {\n constructor(private client: Client) {}\n\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an\n * example custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findTargetFromSource<T = Models.RelationArray>(\n parameters: Parameters.FindTargetFromSource,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an\n * example custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findTargetFromSource<T = Models.RelationArray>(\n parameters: Parameters.FindTargetFromSource,\n callback?: never,\n ): Promise<T>;\n async findTargetFromSource<T = Models.RelationArray>(\n parameters: Parameters.FindTargetFromSource,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}`,\n method: 'GET',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n expand: parameters.expand,\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships\n * are one way.\n *\n * For example, you can use this method to find whether the current user has selected a particular page as a favorite\n * (i.e. 'save for later'): `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/favourite/from/user/current/to/content/123`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async getRelationship<T = Models.Relation>(\n parameters: Parameters.GetRelationship,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships\n * are one way.\n *\n * For example, you can use this method to find whether the current user has selected a particular page as a favorite\n * (i.e. 'save for later'): `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/favourite/from/user/current/to/content/123`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async getRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;\n async getRelationship<T = Models.Relation>(\n parameters: Parameters.GetRelationship,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,\n method: 'GET',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n expand: parameters.expand,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by\n * default, but you can use this method to create any type of relationship between two entities.\n *\n * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async createRelationship<T = Models.Relation>(\n parameters: Parameters.CreateRelationship,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by\n * default, but you can use this method to create any type of relationship between two entities.\n *\n * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async createRelationship<T = Models.Relation>(\n parameters: Parameters.CreateRelationship,\n callback?: never,\n ): Promise<T>;\n async createRelationship<T = Models.Relation>(\n parameters: Parameters.CreateRelationship,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,\n method: 'PUT',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Deletes a relationship between two entities (user, space, content).\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite\n * relationships. A space administrator can delete favourite relationships for any user.\n */\n async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback: Callback<T>): Promise<void>;\n /**\n * Deletes a relationship between two entities (user, space, content).\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite\n * relationships. A space administrator can delete favourite relationships for any user.\n */\n async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback?: never): Promise<T>;\n async deleteRelationship<T = void>(\n parameters: Parameters.DeleteRelationship,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,\n method: 'DELETE',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content\n * with an ID of '1234': `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user` Note,\n * 'collaborator' is an example custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findSourcesForTarget<T = Models.RelationArray>(\n parameters: Parameters.FindSourcesForTarget,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content\n * with an ID of '1234': `GET\n * https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user` Note,\n * 'collaborator' is an example custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findSourcesForTarget<T = Models.RelationArray>(\n parameters: Parameters.FindSourcesForTarget,\n callback?: never,\n ): Promise<T>;\n async findSourcesForTarget<T = Models.RelationArray>(\n parameters: Parameters.FindSourcesForTarget,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/to/${parameters.targetType}/${parameters.targetKey}/from/${parameters.sourceType}`,\n method: 'GET',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n expand: parameters.expand,\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,QAAQ,CAAA;AACC,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAM,CAAA,MAAA,GAAN,MAAM;;AAgC1B,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAiB,cAAA,EAAA,UAAU,CAAC,YAAY,SAAS,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAE,CAAA;AACjI,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AA8BlD,IAAA,MAAM,eAAe,CACnB,UAAsC,EACtC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,iBAAiB,UAAU,CAAC,YAAY,CAAS,MAAA,EAAA,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAI,CAAA,EAAA,UAAU,CAAC,SAAS,CAAE,CAAA;AACzJ,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,MAAM,EAAE,UAAU,CAAC,MAAM;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AA+BlD,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,iBAAiB,UAAU,CAAC,YAAY,CAAS,MAAA,EAAA,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAI,CAAA,EAAA,UAAU,CAAC,SAAS,CAAE,CAAA;AACzJ,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;AACxC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAmBlD,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,iBAAiB,UAAU,CAAC,YAAY,CAAS,MAAA,EAAA,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAI,CAAA,EAAA,UAAU,CAAC,SAAS,CAAE,CAAA;AACzJ,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;AACxC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAmClD,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAiB,cAAA,EAAA,UAAU,CAAC,YAAY,OAAO,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,SAAS,UAAU,CAAC,UAAU,CAAE,CAAA;AACjI,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAEnD;;;;"}
|
|
1
|
+
{"version":3,"file":"relation.cjs","sources":["../../../../src/api/relation.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Client } from '../clients';\nimport type { Callback } from '../callback';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Relation {\n constructor(private client: Client) {}\n\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET\n * https://your-domain.atlassian.net/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an example\n * custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findTargetFromSource<T = Models.RelationArray>(\n parameters: Parameters.FindTargetFromSource,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all content that the current user has an 'ignore' relationship with: `GET\n * https://your-domain.atlassian.net/api/relation/ignore/from/user/current/to/content` Note, 'ignore' is an example\n * custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findTargetFromSource<T = Models.RelationArray>(\n parameters: Parameters.FindTargetFromSource,\n callback?: never,\n ): Promise<T>;\n async findTargetFromSource<T = Models.RelationArray>(\n parameters: Parameters.FindTargetFromSource,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}`,\n method: 'GET',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n expand: parameters.expand,\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships\n * are one way.\n *\n * For example, you can use this method to find whether the current user has selected a particular page as a favorite\n * (i.e. 'save for later'): `GET\n * https://your-domain.atlassian.net/api/relation/favourite/from/user/current/to/content/123`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async getRelationship<T = Models.Relation>(\n parameters: Parameters.GetRelationship,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships\n * are one way.\n *\n * For example, you can use this method to find whether the current user has selected a particular page as a favorite\n * (i.e. 'save for later'): `GET\n * https://your-domain.atlassian.net/api/relation/favourite/from/user/current/to/content/123`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async getRelationship<T = Models.Relation>(parameters: Parameters.GetRelationship, callback?: never): Promise<T>;\n async getRelationship<T = Models.Relation>(\n parameters: Parameters.GetRelationship,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,\n method: 'GET',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n expand: parameters.expand,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by\n * default, but you can use this method to create any type of relationship between two entities.\n *\n * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET\n * https://your-domain.atlassian.net/api/relation/sibling/from/content/123/to/content/456`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async createRelationship<T = Models.Relation>(\n parameters: Parameters.CreateRelationship,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Creates a relationship between two entities (user, space, content). The 'favourite' relationship is supported by\n * default, but you can use this method to create any type of relationship between two entities.\n *\n * For example, the following method creates a 'sibling' relationship between two pieces of content: `GET\n * https://your-domain.atlassian.net/api/relation/sibling/from/content/123/to/content/456`\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async createRelationship<T = Models.Relation>(\n parameters: Parameters.CreateRelationship,\n callback?: never,\n ): Promise<T>;\n async createRelationship<T = Models.Relation>(\n parameters: Parameters.CreateRelationship,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,\n method: 'PUT',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Deletes a relationship between two entities (user, space, content).\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite\n * relationships. A space administrator can delete favourite relationships for any user.\n */\n async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback: Callback<T>): Promise<void>;\n /**\n * Deletes a relationship between two entities (user, space, content).\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission). For favourite relationships, the current user can only delete their own favourite\n * relationships. A space administrator can delete favourite relationships for any user.\n */\n async deleteRelationship<T = void>(parameters: Parameters.DeleteRelationship, callback?: never): Promise<T>;\n async deleteRelationship<T = void>(\n parameters: Parameters.DeleteRelationship,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/from/${parameters.sourceType}/${parameters.sourceKey}/to/${parameters.targetType}/${parameters.targetKey}`,\n method: 'DELETE',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content\n * with an ID of '1234': `GET https://your-domain.atlassian.net/api/relation/collaborator/to/content/1234/from/user`\n * Note, 'collaborator' is an example custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findSourcesForTarget<T = Models.RelationArray>(\n parameters: Parameters.FindSourcesForTarget,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns all target entities that have a particular relationship to the source entity. Note, relationships are one\n * way.\n *\n * For example, the following method finds all users that have a 'collaborator' relationship to a piece of content\n * with an ID of '1234': `GET https://your-domain.atlassian.net/api/relation/collaborator/to/content/1234/from/user`\n * Note, 'collaborator' is an example custom relationship type.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view both the target entity\n * and source entity.\n */\n async findSourcesForTarget<T = Models.RelationArray>(\n parameters: Parameters.FindSourcesForTarget,\n callback?: never,\n ): Promise<T>;\n async findSourcesForTarget<T = Models.RelationArray>(\n parameters: Parameters.FindSourcesForTarget,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: `/api/relation/${parameters.relationName}/to/${parameters.targetType}/${parameters.targetKey}/from/${parameters.sourceType}`,\n method: 'GET',\n params: {\n sourceStatus: parameters.sourceStatus,\n targetStatus: parameters.targetStatus,\n sourceVersion: parameters.sourceVersion,\n targetVersion: parameters.targetVersion,\n expand: parameters.expand,\n start: parameters.start,\n limit: parameters.limit,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,QAAQ,CAAA;AACC,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AAgCrC,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,cAAA,EAAiB,UAAU,CAAC,YAAY,SAAS,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAA,CAAE;AACjI,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA6BA,IAAA,MAAM,eAAe,CACnB,UAAsC,EACtC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,iBAAiB,UAAU,CAAC,YAAY,CAAA,MAAA,EAAS,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,CAAA,CAAE;AACzJ,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,MAAM,EAAE,UAAU,CAAC,MAAM;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA8BA,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,iBAAiB,UAAU,CAAC,YAAY,CAAA,MAAA,EAAS,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,CAAA,CAAE;AACzJ,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;AACxC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAkBA,IAAA,MAAM,kBAAkB,CACtB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,iBAAiB,UAAU,CAAC,YAAY,CAAA,MAAA,EAAS,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,OAAO,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,CAAA,CAAE;AACzJ,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;AACxC,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAgCA,IAAA,MAAM,oBAAoB,CACxB,UAA2C,EAC3C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,CAAA,cAAA,EAAiB,UAAU,CAAC,YAAY,OAAO,UAAU,CAAC,UAAU,CAAA,CAAA,EAAI,UAAU,CAAC,SAAS,SAAS,UAAU,CAAC,UAAU,CAAA,CAAE;AACjI,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,YAAY,EAAE,UAAU,CAAC,YAAY;gBACrC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,aAAa,EAAE,UAAU,CAAC,aAAa;gBACvC,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;AACxB,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
package/dist/cjs/api/search.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.cjs","sources":["../../../../src/api/search.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type {
|
|
1
|
+
{"version":3,"file":"search.cjs","sources":["../../../../src/api/search.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Client } from '../clients';\nimport type { Callback } from '../callback';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Search {\n constructor(private client: Client) {}\n\n /**\n * Searches for content using the [Confluence Query Language\n * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)\n *\n * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The\n * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of\n * results returned in each call.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only\n * entities that the user has permission to view will be returned.\n */\n async searchByCQL<T = Models.SearchPageResponseSearchResult>(\n parameters: Parameters.SearchByCQL,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Searches for content using the [Confluence Query Language\n * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)\n *\n * When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The\n * URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of\n * results returned in each call.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only\n * entities that the user has permission to view will be returned.\n */\n async searchByCQL<T = Models.SearchPageResponseSearchResult>(\n parameters: Parameters.SearchByCQL,\n callback?: never,\n ): Promise<T>;\n async searchByCQL<T = Models.SearchPageResponseSearchResult>(\n parameters: Parameters.SearchByCQL,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/search',\n method: 'GET',\n params: {\n cql: parameters.cql,\n cqlcontext: parameters.cqlcontext,\n cursor: parameters.cursor,\n next: parameters.next,\n prev: parameters.prev,\n limit: parameters.limit,\n start: parameters.start,\n includeArchivedSpaces: parameters.includeArchivedSpaces,\n excludeCurrentSpaces: parameters.excludeCurrentSpaces,\n excerpt: parameters.excerpt,\n sitePermissionTypeFilter: parameters.sitePermissionTypeFilter,\n expand: parameters.expand,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Searches for users using user-specific queries from the [Confluence Query Language\n * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).\n *\n * Note that CQL input queries submitted through the `/api/search/user` endpoint only support user-specific fields\n * like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.\n *\n * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,\n * profilePicture, displayName, and timeZone.\n */\n async searchUser<T = Models.SearchPageResponseSearchResult>(\n parameters: Parameters.SearchUser,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Searches for users using user-specific queries from the [Confluence Query Language\n * (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).\n *\n * Note that CQL input queries submitted through the `/api/search/user` endpoint only support user-specific fields\n * like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.\n *\n * Note that some user fields may be set to null depending on the user's privacy settings. These are: email,\n * profilePicture, displayName, and timeZone.\n */\n async searchUser<T = Models.SearchPageResponseSearchResult>(\n parameters: Parameters.SearchUser,\n callback?: never,\n ): Promise<T>;\n async searchUser<T = Models.SearchPageResponseSearchResult>(\n parameters: Parameters.SearchUser,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/search/user',\n method: 'GET',\n params: {\n cql: parameters.cql,\n start: parameters.start,\n limit: parameters.limit,\n expand: parameters.expand,\n sitePermissionTypeFilter: parameters.sitePermissionTypeFilter,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,MAAM,CAAA;AACG,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AAgCrC,IAAA,MAAM,WAAW,CACf,UAAkC,EAClC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,aAAa;AAClB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,UAAU,EAAE,UAAU,CAAC,UAAU;gBACjC,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;gBACvD,oBAAoB,EAAE,UAAU,CAAC,oBAAoB;gBACrD,OAAO,EAAE,UAAU,CAAC,OAAO;gBAC3B,wBAAwB,EAAE,UAAU,CAAC,wBAAwB;gBAC7D,MAAM,EAAE,UAAU,CAAC,MAAM;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA8BA,IAAA,MAAM,UAAU,CACd,UAAiC,EACjC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kBAAkB;AACvB,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,GAAG,EAAE,UAAU,CAAC,GAAG;gBACnB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,wBAAwB,EAAE,UAAU,CAAC,wBAAwB;AAC9D,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"settings.cjs","sources":["../../../../src/api/settings.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Callback } from '../callback';\nimport type { Client } from '../clients';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Settings {\n constructor(private client: Client) {}\n\n /**\n * Returns the look and feel settings for the site or a single space. This includes attributes such as the color\n * scheme, padding, and border radius.\n *\n * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a\n * theme.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None\n */\n async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(\n parameters: Parameters.GetLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the look and feel settings for the site or a single space. This includes attributes such as the color\n * scheme, padding, and border radius.\n *\n * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a\n * theme.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None\n */\n async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(\n parameters?: Parameters.GetLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(\n parameters?: Parameters.GetLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel',\n method: 'GET',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's\n * settings for a space. The custom and theme settings can only be selected if there is already a theme set for a\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeel<T = Models.LookAndFeelSelection>(\n parameters: Parameters.UpdateLookAndFeel | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's\n * settings for a space. The custom and theme settings can only be selected if there is already a theme set for a\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeel<T = Models.LookAndFeelSelection>(\n parameters?: Parameters.UpdateLookAndFeel,\n callback?: never,\n ): Promise<T>;\n async updateLookAndFeel<T = Models.LookAndFeelSelection>(\n parameters?: Parameters.UpdateLookAndFeel,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel',\n method: 'PUT',\n data: {\n spaceKey: parameters?.spaceKey,\n lookAndFeelType: parameters?.lookAndFeelType,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated.\n * If no custom settings exist, then a set of custom settings is created.\n *\n * Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be\n * overridden.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeelSettings<T = Models.LookAndFeel>(\n parameters: Parameters.UpdateLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated.\n * If no custom settings exist, then a set of custom settings is created.\n *\n * Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be\n * overridden.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeelSettings<T = Models.LookAndFeel>(\n parameters?: Parameters.UpdateLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async updateLookAndFeelSettings<T = Models.LookAndFeel>(\n parameters?: Parameters.UpdateLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel/custom',\n method: 'POST',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n data: {\n headings: parameters?.headings,\n links: parameters?.links,\n menus: parameters?.menus,\n header: parameters?.header,\n horizontalHeader: parameters?.horizontalHeader,\n content: parameters?.content,\n bordersAndDividers: parameters?.bordersAndDividers,\n spaceReference: parameters?.spaceReference,\n _links: parameters?.links,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Resets the custom look and feel settings for the site or a single space. This changes the values of the custom\n * settings to be the same as the default settings. It does not change which settings (default or custom) are\n * selected. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async resetLookAndFeelSettings<T = void>(\n parameters: Parameters.ResetLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Resets the custom look and feel settings for the site or a single space. This changes the values of the custom\n * settings to be the same as the default settings. It does not change which settings (default or custom) are\n * selected. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async resetLookAndFeelSettings<T = void>(\n parameters?: Parameters.ResetLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async resetLookAndFeelSettings<T = void>(\n parameters?: Parameters.ResetLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel/custom',\n method: 'DELETE',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Sets the look and feel settings to either the default settings or the custom settings, for the site or a single\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async setLookAndFeelSettings<T = unknown>(\n parameters: Parameters.SetLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Sets the look and feel settings to either the default settings or the custom settings, for the site or a single\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async setLookAndFeelSettings<T = unknown>(\n parameters?: Parameters.SetLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async setLookAndFeelSettings<T = unknown>(\n parameters?: Parameters.SetLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel/selected',\n method: 'PUT',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getSystemInfo<T = Models.SystemInfoEntity>(callback: Callback<T>): Promise<void>;\n /**\n * Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getSystemInfo<T = Models.SystemInfoEntity>(callback?: never): Promise<T>;\n async getSystemInfo<T = Models.SystemInfoEntity>(callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/systemInfo',\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,QAAQ,CAAA;AACC,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAM,CAAA,MAAA,GAAN,MAAM;;AA4B1B,IAAA,MAAM,sBAAsB,CAC1B,UAA8C,EAC9C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,2BAA2B;AAChC,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAyBlD,IAAA,MAAM,iBAAiB,CACrB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,2BAA2B;AAChC,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU,EAAE,QAAQ;gBAC9B,eAAe,EAAE,UAAU,EAAE,eAAe;AAC7C,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AA6BlD,IAAA,MAAM,yBAAyB,CAC7B,UAAiD,EACjD,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kCAAkC;AACvC,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU,EAAE,QAAQ;gBAC9B,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,MAAM,EAAE,UAAU,EAAE,MAAM;gBAC1B,gBAAgB,EAAE,UAAU,EAAE,gBAAgB;gBAC9C,OAAO,EAAE,UAAU,EAAE,OAAO;gBAC5B,kBAAkB,EAAE,UAAU,EAAE,kBAAkB;gBAClD,cAAc,EAAE,UAAU,EAAE,cAAc;gBAC1C,MAAM,EAAE,UAAU,EAAE,KAAK;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAyBlD,IAAA,MAAM,wBAAwB,CAC5B,UAAgD,EAChD,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kCAAkC;AACvC,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAuBlD,IAAA,MAAM,sBAAsB,CAC1B,UAA8C,EAC9C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,oCAAoC;AACzC,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;IAiBlD,MAAM,aAAa,CAA8B,QAAsB,EAAA;AACrE,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,0BAA0B;AAC/B,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;;AAEnD;;;;"}
|
|
1
|
+
{"version":3,"file":"settings.cjs","sources":["../../../../src/api/settings.ts"],"sourcesContent":["import type * as Models from './models';\nimport type * as Parameters from './parameters';\nimport type { Client } from '../clients';\nimport type { Callback } from '../callback';\nimport type { RequestConfig } from '../requestConfig';\n\nexport class Settings {\n constructor(private client: Client) {}\n\n /**\n * Returns the look and feel settings for the site or a single space. This includes attributes such as the color\n * scheme, padding, and border radius.\n *\n * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a\n * theme.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None\n */\n async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(\n parameters: Parameters.GetLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Returns the look and feel settings for the site or a single space. This includes attributes such as the color\n * scheme, padding, and border radius.\n *\n * The look and feel settings for a space can be inherited from the global look and feel settings or provided by a\n * theme.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None\n */\n async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(\n parameters?: Parameters.GetLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async getLookAndFeelSettings<T = Models.LookAndFeelSettings>(\n parameters?: Parameters.GetLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel',\n method: 'GET',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's\n * settings for a space. The custom and theme settings can only be selected if there is already a theme set for a\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeel<T = Models.LookAndFeelSelection>(\n parameters: Parameters.UpdateLookAndFeel | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's\n * settings for a space. The custom and theme settings can only be selected if there is already a theme set for a\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeel<T = Models.LookAndFeelSelection>(\n parameters?: Parameters.UpdateLookAndFeel,\n callback?: never,\n ): Promise<T>;\n async updateLookAndFeel<T = Models.LookAndFeelSelection>(\n parameters?: Parameters.UpdateLookAndFeel,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel',\n method: 'PUT',\n data: {\n spaceKey: parameters?.spaceKey,\n lookAndFeelType: parameters?.lookAndFeelType,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated.\n * If no custom settings exist, then a set of custom settings is created.\n *\n * Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be\n * overridden.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeelSettings<T = Models.LookAndFeel>(\n parameters: Parameters.UpdateLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated.\n * If no custom settings exist, then a set of custom settings is created.\n *\n * Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be\n * overridden.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async updateLookAndFeelSettings<T = Models.LookAndFeel>(\n parameters?: Parameters.UpdateLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async updateLookAndFeelSettings<T = Models.LookAndFeel>(\n parameters?: Parameters.UpdateLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel/custom',\n method: 'POST',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n data: {\n headings: parameters?.headings,\n links: parameters?.links,\n menus: parameters?.menus,\n header: parameters?.header,\n horizontalHeader: parameters?.horizontalHeader,\n content: parameters?.content,\n bordersAndDividers: parameters?.bordersAndDividers,\n spaceReference: parameters?.spaceReference,\n _links: parameters?.links,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Resets the custom look and feel settings for the site or a single space. This changes the values of the custom\n * settings to be the same as the default settings. It does not change which settings (default or custom) are\n * selected. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async resetLookAndFeelSettings<T = void>(\n parameters: Parameters.ResetLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Resets the custom look and feel settings for the site or a single space. This changes the values of the custom\n * settings to be the same as the default settings. It does not change which settings (default or custom) are\n * selected. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n */\n async resetLookAndFeelSettings<T = void>(\n parameters?: Parameters.ResetLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async resetLookAndFeelSettings<T = void>(\n parameters?: Parameters.ResetLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel/custom',\n method: 'DELETE',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Sets the look and feel settings to either the default settings or the custom settings, for the site or a single\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n *\n * @deprecated Will be removed in next major version.\n */\n async setLookAndFeelSettings<T = unknown>(\n parameters: Parameters.SetLookAndFeelSettings | undefined,\n callback: Callback<T>,\n ): Promise<void>;\n /**\n * Sets the look and feel settings to either the default settings or the custom settings, for the site or a single\n * space. Note, the default space settings are inherited from the current global settings.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.\n *\n * @deprecated Will be removed in next major version.\n */\n async setLookAndFeelSettings<T = unknown>(\n parameters?: Parameters.SetLookAndFeelSettings,\n callback?: never,\n ): Promise<T>;\n async setLookAndFeelSettings<T = unknown>(\n parameters?: Parameters.SetLookAndFeelSettings,\n callback?: Callback<T>,\n ): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/lookandfeel/selected',\n method: 'PUT',\n params: {\n spaceKey: parameters?.spaceKey,\n },\n };\n\n return this.client.sendRequest(config, callback);\n }\n\n /**\n * Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getSystemInfo<T = Models.SystemInfoEntity>(callback: Callback<T>): Promise<void>;\n /**\n * Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.\n *\n * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site\n * ('Can use' global permission).\n */\n async getSystemInfo<T = Models.SystemInfoEntity>(callback?: never): Promise<T>;\n async getSystemInfo<T = Models.SystemInfoEntity>(callback?: Callback<T>): Promise<void | T> {\n const config: RequestConfig = {\n url: '/api/settings/systemInfo',\n method: 'GET',\n };\n\n return this.client.sendRequest(config, callback);\n }\n}\n"],"names":[],"mappings":";;MAMa,QAAQ,CAAA;AACC,IAAA,MAAA;AAApB,IAAA,WAAA,CAAoB,MAAc,EAAA;QAAd,IAAA,CAAA,MAAM,GAAN,MAAM;IAAW;AA4BrC,IAAA,MAAM,sBAAsB,CAC1B,UAA8C,EAC9C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,2BAA2B;AAChC,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAwBA,IAAA,MAAM,iBAAiB,CACrB,UAAyC,EACzC,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,2BAA2B;AAChC,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU,EAAE,QAAQ;gBAC9B,eAAe,EAAE,UAAU,EAAE,eAAe;AAC7C,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA4BA,IAAA,MAAM,yBAAyB,CAC7B,UAAiD,EACjD,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kCAAkC;AACvC,YAAA,MAAM,EAAE,MAAM;AACd,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU,EAAE,QAAQ;gBAC9B,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,KAAK,EAAE,UAAU,EAAE,KAAK;gBACxB,MAAM,EAAE,UAAU,EAAE,MAAM;gBAC1B,gBAAgB,EAAE,UAAU,EAAE,gBAAgB;gBAC9C,OAAO,EAAE,UAAU,EAAE,OAAO;gBAC5B,kBAAkB,EAAE,UAAU,EAAE,kBAAkB;gBAClD,cAAc,EAAE,UAAU,EAAE,cAAc;gBAC1C,MAAM,EAAE,UAAU,EAAE,KAAK;AAC1B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AAwBA,IAAA,MAAM,wBAAwB,CAC5B,UAAgD,EAChD,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,kCAAkC;AACvC,YAAA,MAAM,EAAE,QAAQ;AAChB,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AA0BA,IAAA,MAAM,sBAAsB,CAC1B,UAA8C,EAC9C,QAAsB,EAAA;AAEtB,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,oCAAoC;AACzC,YAAA,MAAM,EAAE,KAAK;AACb,YAAA,MAAM,EAAE;gBACN,QAAQ,EAAE,UAAU,EAAE,QAAQ;AAC/B,aAAA;SACF;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;IAgBA,MAAM,aAAa,CAA8B,QAAsB,EAAA;AACrE,QAAA,MAAM,MAAM,GAAkB;AAC5B,YAAA,GAAG,EAAE,0BAA0B;AAC/B,YAAA,MAAM,EAAE,KAAK;SACd;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC;IAClD;AACD;;;;"}
|
package/dist/cjs/api/space.cjs
CHANGED
|
@@ -31,8 +31,9 @@ class Space {
|
|
|
31
31
|
url: '/api/space',
|
|
32
32
|
method: 'POST',
|
|
33
33
|
data: {
|
|
34
|
-
key: parameters?.key,
|
|
35
34
|
name: parameters?.name,
|
|
35
|
+
key: parameters?.key,
|
|
36
|
+
alias: parameters?.alias,
|
|
36
37
|
description: parameters?.description,
|
|
37
38
|
permissions: parameters?.permissions,
|
|
38
39
|
},
|
|
@@ -44,8 +45,9 @@ class Space {
|
|
|
44
45
|
url: '/api/space/_private',
|
|
45
46
|
method: 'POST',
|
|
46
47
|
data: {
|
|
47
|
-
key: parameters?.key,
|
|
48
48
|
name: parameters?.name,
|
|
49
|
+
key: parameters?.key,
|
|
50
|
+
alias: parameters?.alias,
|
|
49
51
|
description: parameters?.description,
|
|
50
52
|
permissions: parameters?.permissions,
|
|
51
53
|
},
|