@resolution/confluence-api-client 0.13.4 → 0.14.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.
Files changed (128) hide show
  1. package/lib/openapi/core/CommonHttpClient.d.ts +1 -1
  2. package/lib/openapi/core/CommonHttpClient.js +1 -1
  3. package/lib/openapi/core/CommonHttpClient.js.map +1 -1
  4. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +6 -37
  5. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +3 -71
  6. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
  7. package/lib/openapi/v1/models/audit.js +2 -2
  8. package/lib/openapi/v1/models/audit.js.map +1 -1
  9. package/lib/openapi/v1/models/common.d.ts +1 -1
  10. package/lib/openapi/v1/models/common.js +3 -3
  11. package/lib/openapi/v1/models/common.js.map +1 -1
  12. package/lib/openapi/v1/models/content.d.ts +0 -543
  13. package/lib/openapi/v1/models/content.js +2 -309
  14. package/lib/openapi/v1/models/content.js.map +1 -1
  15. package/lib/openapi/v1/models/contentChildrenAndDescendants.d.ts +7 -3
  16. package/lib/openapi/v1/models/contentChildrenAndDescendants.js +1 -1
  17. package/lib/openapi/v1/models/contentChildrenAndDescendants.js.map +1 -1
  18. package/lib/openapi/v1/models/contentRestrictions.js +1 -1
  19. package/lib/openapi/v1/models/contentRestrictions.js.map +1 -1
  20. package/lib/openapi/v1/models/contentStates.d.ts +322 -0
  21. package/lib/openapi/v1/models/contentStates.js +219 -0
  22. package/lib/openapi/v1/models/contentStates.js.map +1 -1
  23. package/lib/openapi/v1/models/contentVersions.d.ts +0 -9
  24. package/lib/openapi/v1/models/contentVersions.js +1 -10
  25. package/lib/openapi/v1/models/contentVersions.js.map +1 -1
  26. package/lib/openapi/v1/models/dynamicModules.d.ts +3 -3
  27. package/lib/openapi/v1/models/space.d.ts +1 -9
  28. package/lib/openapi/v1/models/space.js +1 -8
  29. package/lib/openapi/v1/models/space.js.map +1 -1
  30. package/lib/openapi/v1/models/template.js +1 -1
  31. package/lib/openapi/v1/models/template.js.map +1 -1
  32. package/lib/openapi/v1/services/AnalyticsService.d.ts +4 -0
  33. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  34. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +0 -130
  35. package/lib/openapi/v1/services/ContentAttachmentsService.js +0 -52
  36. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  37. package/lib/openapi/v1/services/ContentBodyService.d.ts +1 -102
  38. package/lib/openapi/v1/services/ContentBodyService.js +1 -65
  39. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  40. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +5 -220
  41. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +4 -144
  42. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  43. package/lib/openapi/v1/services/ContentLabelsService.d.ts +1 -44
  44. package/lib/openapi/v1/services/ContentLabelsService.js +0 -41
  45. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  46. package/lib/openapi/v1/services/ContentService.d.ts +2 -560
  47. package/lib/openapi/v1/services/ContentService.js +1 -300
  48. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  49. package/lib/openapi/v1/services/ContentVersionsService.d.ts +1 -72
  50. package/lib/openapi/v1/services/ContentVersionsService.js +1 -97
  51. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  52. package/lib/openapi/v1/services/GroupService.d.ts +1 -1
  53. package/lib/openapi/v1/services/GroupService.js +1 -1
  54. package/lib/openapi/v1/services/SettingsService.d.ts +0 -26
  55. package/lib/openapi/v1/services/SettingsService.js +0 -38
  56. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  57. package/lib/openapi/v1/services/SpaceService.d.ts +2 -406
  58. package/lib/openapi/v1/services/SpaceService.js +1 -215
  59. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  60. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +22 -3
  61. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +25 -1
  62. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
  63. package/lib/openapi/v2/models/adminKey.d.ts +13 -0
  64. package/lib/openapi/v2/models/adminKey.js +12 -0
  65. package/lib/openapi/v2/models/adminKey.js.map +1 -0
  66. package/lib/openapi/v2/models/children.d.ts +21 -6
  67. package/lib/openapi/v2/models/children.js +10 -1
  68. package/lib/openapi/v2/models/children.js.map +1 -1
  69. package/lib/openapi/v2/models/common.d.ts +6 -0
  70. package/lib/openapi/v2/models/common.js +1 -0
  71. package/lib/openapi/v2/models/common.js.map +1 -1
  72. package/lib/openapi/v2/models/descendants.d.ts +29 -0
  73. package/lib/openapi/v2/models/descendants.js +19 -0
  74. package/lib/openapi/v2/models/descendants.js.map +1 -0
  75. package/lib/openapi/v2/services/AdminKeyService.d.ts +71 -0
  76. package/lib/openapi/v2/services/AdminKeyService.js +111 -0
  77. package/lib/openapi/v2/services/AdminKeyService.js.map +1 -0
  78. package/lib/openapi/v2/services/AttachmentService.d.ts +6 -5
  79. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  80. package/lib/openapi/v2/services/BlogPostService.d.ts +5 -4
  81. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  82. package/lib/openapi/v2/services/ChildrenService.d.ts +307 -1
  83. package/lib/openapi/v2/services/ChildrenService.js +321 -0
  84. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  85. package/lib/openapi/v2/services/CommentService.d.ts +10 -8
  86. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  87. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +1 -1
  88. package/lib/openapi/v2/services/CustomContentService.d.ts +18 -1
  89. package/lib/openapi/v2/services/CustomContentService.js +5 -0
  90. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  91. package/lib/openapi/v2/services/DatabaseService.d.ts +4 -6
  92. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  93. package/lib/openapi/v2/services/DescendantsService.d.ts +346 -0
  94. package/lib/openapi/v2/services/DescendantsService.js +362 -0
  95. package/lib/openapi/v2/services/DescendantsService.js.map +1 -0
  96. package/lib/openapi/v2/services/FolderService.d.ts +4 -6
  97. package/lib/openapi/v2/services/FolderService.js.map +1 -1
  98. package/lib/openapi/v2/services/PageService.d.ts +49 -6
  99. package/lib/openapi/v2/services/PageService.js +42 -2
  100. package/lib/openapi/v2/services/PageService.js.map +1 -1
  101. package/lib/openapi/v2/services/SmartLinkService.d.ts +4 -6
  102. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  103. package/lib/openapi/v2/services/SpaceService.d.ts +2 -1
  104. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  105. package/lib/openapi/v2/services/WhiteboardService.d.ts +6 -8
  106. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  107. package/package.json +3 -3
  108. package/lib/openapi/v1/models/contentProperties.d.ts +0 -78
  109. package/lib/openapi/v1/models/contentProperties.js +0 -48
  110. package/lib/openapi/v1/models/contentProperties.js.map +0 -1
  111. package/lib/openapi/v1/models/inlineTasks.d.ts +0 -33
  112. package/lib/openapi/v1/models/inlineTasks.js +0 -36
  113. package/lib/openapi/v1/models/inlineTasks.js.map +0 -1
  114. package/lib/openapi/v1/models/spaceProperties.d.ts +0 -103
  115. package/lib/openapi/v1/models/spaceProperties.js +0 -48
  116. package/lib/openapi/v1/models/spaceProperties.js.map +0 -1
  117. package/lib/openapi/v1/services/ContentCommentsService.d.ts +0 -153
  118. package/lib/openapi/v1/services/ContentCommentsService.js +0 -81
  119. package/lib/openapi/v1/services/ContentCommentsService.js.map +0 -1
  120. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +0 -203
  121. package/lib/openapi/v1/services/ContentPropertiesService.js +0 -279
  122. package/lib/openapi/v1/services/ContentPropertiesService.js.map +0 -1
  123. package/lib/openapi/v1/services/InlineTasksService.d.ts +0 -101
  124. package/lib/openapi/v1/services/InlineTasksService.js +0 -145
  125. package/lib/openapi/v1/services/InlineTasksService.js.map +0 -1
  126. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +0 -177
  127. package/lib/openapi/v1/services/SpacePropertiesService.js +0 -269
  128. package/lib/openapi/v1/services/SpacePropertiesService.js.map +0 -1
@@ -1,177 +0,0 @@
1
- import { CommonHttpService } from "../../core/CommonHttpService";
2
- import { type SpacePropertyArray, type SpacePropertyCreate, type SpacePropertyV1, type SpacePropertyUpdate, type SpacePropertyCreateNoKey } from "../models/spaceProperties";
3
- /**
4
- * @deprecated
5
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties
6
- * @category Services
7
- */
8
- export declare class SpacePropertiesService extends CommonHttpService {
9
- /**
10
- * Deprecated, use [Confluence's v2
11
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
12
- *
13
- * Creates a new space property.
14
- *
15
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
16
- * ‘Admin’ permission for the space.
17
- *
18
- * @deprecated
19
- * @returns Returned if the space property is created.
20
- * @path POST `/wiki/rest/api/space/{spaceKey}/property`
21
- * @scopes-current write:confluence-props
22
- * @scopes-beta read:space.property:confluence, write:space.property:confluence
23
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-post
24
- * @param params
25
- */
26
- createSpaceProperty: ({ spaceKey, spacePropertyCreate }: {
27
- /** The key of the space that the property will be created in. */
28
- spaceKey: string;
29
- /** The space property to be created. */
30
- spacePropertyCreate: SpacePropertyCreate;
31
- }) => Promise<SpacePropertyV1>;
32
- /**
33
- * Deprecated, use [Confluence's v2
34
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
35
- *
36
- * Creates a new space property. This is the same as `POST
37
- * /wiki/rest/api/space/{spaceKey}/property` but the key for the property is
38
- * passed as a
39
- * path parameter, rather than in the request body.
40
- *
41
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
42
- * ‘Admin’ permission for the space.
43
- *
44
- * @deprecated
45
- * @returns Returned if the space property is created.
46
- * @path POST `/wiki/rest/api/space/{spaceKey}/property/{key}`
47
- * @scopes-current write:confluence-props
48
- * @scopes-beta read:space.property:confluence, write:space.property:confluence
49
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-post
50
- * @param params
51
- */
52
- createSpacePropertyForKey: ({ spaceKey, key, spacePropertyCreateNoKey }: {
53
- /** The key of the space that the property will be created in. */
54
- spaceKey: string;
55
- /** The key of the property to be created. */
56
- key: string;
57
- /** The space property to be created. */
58
- spacePropertyCreateNoKey: SpacePropertyCreateNoKey;
59
- }) => Promise<SpacePropertyV1>;
60
- /**
61
- * Deprecated, use [Confluence's v2
62
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
63
- *
64
- * Deletes a space property.
65
- *
66
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
67
- * ‘Admin’ permission for the space.
68
- *
69
- * @deprecated
70
- * @path DELETE `/wiki/rest/api/space/{spaceKey}/property/{key}`
71
- * @scopes-current write:confluence-props
72
- * @scopes-beta write:space.property:confluence
73
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-delete
74
- * @param params
75
- */
76
- deleteSpaceProperty: ({ spaceKey, key }: {
77
- /** The key of the space that the property is in. */
78
- spaceKey: string;
79
- /** The key of the property to be deleted. */
80
- key: string;
81
- }) => Promise<void>;
82
- /**
83
- * Deprecated, use [Confluence's v2
84
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
85
- *
86
- * Returns all properties for the given space. Space properties are a key-value
87
- * storage associated with a space.
88
- *
89
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
90
- * permission for the space.
91
- *
92
- * @deprecated
93
- * @returns Returned if the requested space properties are returned.
94
- * @path GET `/wiki/rest/api/space/{spaceKey}/property`
95
- * @scopes-current read:confluence-props
96
- * @scopes-beta read:content-details:confluence
97
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-get
98
- * @param params
99
- */
100
- getSpaceProperties: ({ spaceKey, expand, start, limit }: {
101
- /** The key of the space to be queried for its properties. */
102
- spaceKey: string;
103
- /**
104
- * A multi-value parameter indicating which properties of the space
105
- * property to expand. By default, the `version` object is expanded.
106
- *
107
- * - `version` returns information about the version of the content.
108
- * - `space` returns the space that the properties are in.
109
- */
110
- expand?: ("version" | "space")[] | undefined;
111
- /** The starting index of the returned objects. */
112
- start?: number | undefined;
113
- /**
114
- * The maximum number of properties to return per page. Note, this may be
115
- * restricted by fixed system limits.
116
- */
117
- limit?: number | undefined;
118
- }) => Promise<SpacePropertyArray>;
119
- /**
120
- * Deprecated, use [Confluence's v2
121
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
122
- *
123
- * Returns a space property.
124
- *
125
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
126
- * permission for the space.
127
- *
128
- * @deprecated
129
- * @returns Returned if the requested space property is returned.
130
- * @path GET `/wiki/rest/api/space/{spaceKey}/property/{key}`
131
- * @scopes-current read:confluence-props
132
- * @scopes-beta read:content-details:confluence
133
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-get
134
- * @param params
135
- */
136
- getSpaceProperty: ({ spaceKey, key, expand }: {
137
- /** The key of the space that the property is in. */
138
- spaceKey: string;
139
- /** The key of the space property. */
140
- key: string;
141
- /**
142
- * A multi-value parameter indicating which properties of the space
143
- * property to expand. By default, the `version` object is expanded.
144
- *
145
- * - `version` returns information about the version of the content.
146
- * - `space` returns the space that the properties are in.
147
- */
148
- expand?: ("version" | "space")[] | undefined;
149
- }) => Promise<SpacePropertyV1>;
150
- /**
151
- * Deprecated, use [Confluence's v2
152
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
153
- *
154
- * Updates a space property. Note, you cannot update the key of a space
155
- * property, only the value.
156
- *
157
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
158
- * ‘Admin’ permission for the space.
159
- *
160
- * @deprecated
161
- * @returns Returned if the space property is updated.
162
- * @path PUT `/wiki/rest/api/space/{spaceKey}/property/{key}`
163
- * @scopes-current write:confluence-props
164
- * @scopes-beta read:space.property:confluence, write:space.property:confluence
165
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-put
166
- * @param params
167
- */
168
- updateSpaceProperty: ({ spaceKey, key, spacePropertyUpdate }: {
169
- /** The key of the space that the property is in. */
170
- spaceKey: string;
171
- /** The key of the property to be updated. */
172
- key: string;
173
- /** The space property being updated. */
174
- spacePropertyUpdate: SpacePropertyUpdate;
175
- }) => Promise<SpacePropertyV1>;
176
- protected static initialize(): void;
177
- }
@@ -1,269 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SpacePropertiesService = void 0;
4
- // DO NOT EDIT!
5
- // This file is generated by "api-typescript-generator".
6
- // To update this file run "yarn build:openapi".
7
- const commonHttpClient = require("../../core/CommonHttpClient");
8
- const CommonHttpService_1 = require("../../core/CommonHttpService");
9
- const spaceProperties_1 = require("../models/spaceProperties");
10
- const validationSchemaStorage_1 = require("../validationSchemaStorage");
11
- const zod_1 = require("zod");
12
- /**
13
- * @deprecated
14
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties
15
- * @category Services
16
- */
17
- class SpacePropertiesService extends CommonHttpService_1.CommonHttpService {
18
- constructor() {
19
- super(...arguments);
20
- /**
21
- * Deprecated, use [Confluence's v2
22
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
23
- *
24
- * Creates a new space property.
25
- *
26
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
27
- * ‘Admin’ permission for the space.
28
- *
29
- * @deprecated
30
- * @returns Returned if the space property is created.
31
- * @path POST `/wiki/rest/api/space/{spaceKey}/property`
32
- * @scopes-current write:confluence-props
33
- * @scopes-beta read:space.property:confluence, write:space.property:confluence
34
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-post
35
- * @param params
36
- */
37
- this.createSpaceProperty = ({ spaceKey, spacePropertyCreate }) => {
38
- return this.getClientInstance().request({
39
- path: "/wiki/rest/api/space/{spaceKey}/property",
40
- method: "POST",
41
- pathParams: {
42
- spaceKey
43
- },
44
- headers: {
45
- "Content-Type": "application/json"
46
- },
47
- body: spacePropertyCreate
48
- }).then(this.getClientInstance().responseHandler({
49
- 200: {
50
- "application/json": "json"
51
- }
52
- })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpaceProperty.response"))).then(commonHttpClient.getBody);
53
- };
54
- /**
55
- * Deprecated, use [Confluence's v2
56
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
57
- *
58
- * Creates a new space property. This is the same as `POST
59
- * /wiki/rest/api/space/{spaceKey}/property` but the key for the property is
60
- * passed as a
61
- * path parameter, rather than in the request body.
62
- *
63
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
64
- * ‘Admin’ permission for the space.
65
- *
66
- * @deprecated
67
- * @returns Returned if the space property is created.
68
- * @path POST `/wiki/rest/api/space/{spaceKey}/property/{key}`
69
- * @scopes-current write:confluence-props
70
- * @scopes-beta read:space.property:confluence, write:space.property:confluence
71
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-post
72
- * @param params
73
- */
74
- this.createSpacePropertyForKey = ({ spaceKey, key, spacePropertyCreateNoKey }) => {
75
- return this.getClientInstance().request({
76
- path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
77
- method: "POST",
78
- pathParams: {
79
- spaceKey,
80
- key
81
- },
82
- headers: {
83
- "Content-Type": "application/json"
84
- },
85
- body: spacePropertyCreateNoKey
86
- }).then(this.getClientInstance().responseHandler({
87
- 200: {
88
- "application/json": "json"
89
- }
90
- })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpacePropertyForKey.response"))).then(commonHttpClient.getBody);
91
- };
92
- /**
93
- * Deprecated, use [Confluence's v2
94
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
95
- *
96
- * Deletes a space property.
97
- *
98
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
99
- * ‘Admin’ permission for the space.
100
- *
101
- * @deprecated
102
- * @path DELETE `/wiki/rest/api/space/{spaceKey}/property/{key}`
103
- * @scopes-current write:confluence-props
104
- * @scopes-beta write:space.property:confluence
105
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-delete
106
- * @param params
107
- */
108
- this.deleteSpaceProperty = ({ spaceKey, key }) => {
109
- return this.getClientInstance().request({
110
- path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
111
- method: "DELETE",
112
- pathParams: {
113
- spaceKey,
114
- key
115
- }
116
- }).then(commonHttpClient.discardResult);
117
- };
118
- /**
119
- * Deprecated, use [Confluence's v2
120
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
121
- *
122
- * Returns all properties for the given space. Space properties are a key-value
123
- * storage associated with a space.
124
- *
125
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
126
- * permission for the space.
127
- *
128
- * @deprecated
129
- * @returns Returned if the requested space properties are returned.
130
- * @path GET `/wiki/rest/api/space/{spaceKey}/property`
131
- * @scopes-current read:confluence-props
132
- * @scopes-beta read:content-details:confluence
133
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-get
134
- * @param params
135
- */
136
- this.getSpaceProperties = ({ spaceKey, expand, start, limit }) => {
137
- return this.getClientInstance().request({
138
- path: "/wiki/rest/api/space/{spaceKey}/property",
139
- method: "GET",
140
- pathParams: {
141
- spaceKey
142
- },
143
- query: {
144
- expand,
145
- start,
146
- limit
147
- },
148
- parameters: {
149
- query: {
150
- expand: {
151
- explode: false
152
- }
153
- }
154
- }
155
- }).then(this.getClientInstance().responseHandler({
156
- 200: {
157
- "application/json": "json"
158
- }
159
- })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperties.response"))).then(commonHttpClient.getBody);
160
- };
161
- /**
162
- * Deprecated, use [Confluence's v2
163
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
164
- *
165
- * Returns a space property.
166
- *
167
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
168
- * permission for the space.
169
- *
170
- * @deprecated
171
- * @returns Returned if the requested space property is returned.
172
- * @path GET `/wiki/rest/api/space/{spaceKey}/property/{key}`
173
- * @scopes-current read:confluence-props
174
- * @scopes-beta read:content-details:confluence
175
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-get
176
- * @param params
177
- */
178
- this.getSpaceProperty = ({ spaceKey, key, expand }) => {
179
- return this.getClientInstance().request({
180
- path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
181
- method: "GET",
182
- pathParams: {
183
- spaceKey,
184
- key
185
- },
186
- query: {
187
- expand
188
- },
189
- parameters: {
190
- query: {
191
- expand: {
192
- explode: false
193
- }
194
- }
195
- }
196
- }).then(this.getClientInstance().responseHandler({
197
- 200: {
198
- "application/json": "json"
199
- }
200
- })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperty.response"))).then(commonHttpClient.getBody);
201
- };
202
- /**
203
- * Deprecated, use [Confluence's v2
204
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
205
- *
206
- * Updates a space property. Note, you cannot update the key of a space
207
- * property, only the value.
208
- *
209
- * **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**:
210
- * ‘Admin’ permission for the space.
211
- *
212
- * @deprecated
213
- * @returns Returned if the space property is updated.
214
- * @path PUT `/wiki/rest/api/space/{spaceKey}/property/{key}`
215
- * @scopes-current write:confluence-props
216
- * @scopes-beta read:space.property:confluence, write:space.property:confluence
217
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties#api-wiki-rest-api-space-spacekey-property-key-put
218
- * @param params
219
- */
220
- this.updateSpaceProperty = ({ spaceKey, key, spacePropertyUpdate }) => {
221
- return this.getClientInstance().request({
222
- path: "/wiki/rest/api/space/{spaceKey}/property/{key}",
223
- method: "PUT",
224
- pathParams: {
225
- spaceKey,
226
- key
227
- },
228
- headers: {
229
- "Content-Type": "application/json"
230
- },
231
- body: spacePropertyUpdate
232
- }).then(this.getClientInstance().responseHandler({
233
- 200: {
234
- "application/json": "json"
235
- }
236
- })).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.updateSpaceProperty.response"))).then(commonHttpClient.getBody);
237
- };
238
- }
239
- static initialize() {
240
- validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpaceProperties.response", zod_1.z.object({
241
- status: zod_1.z.literal(200),
242
- mediaType: zod_1.z.literal("application/json"),
243
- body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyArray")
244
- }).describe("SpacePropertiesService.getSpaceProperties.response"));
245
- validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.createSpaceProperty.response", zod_1.z.object({
246
- status: zod_1.z.literal(200),
247
- mediaType: zod_1.z.literal("application/json"),
248
- body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1")
249
- }).describe("SpacePropertiesService.createSpaceProperty.response"));
250
- validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpaceProperty.response", zod_1.z.object({
251
- status: zod_1.z.literal(200),
252
- mediaType: zod_1.z.literal("application/json"),
253
- body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1")
254
- }).describe("SpacePropertiesService.getSpaceProperty.response"));
255
- validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.updateSpaceProperty.response", zod_1.z.object({
256
- status: zod_1.z.literal(200),
257
- mediaType: zod_1.z.literal("application/json"),
258
- body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1")
259
- }).describe("SpacePropertiesService.updateSpaceProperty.response"));
260
- validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.createSpacePropertyForKey.response", zod_1.z.object({
261
- status: zod_1.z.literal(200),
262
- mediaType: zod_1.z.literal("application/json"),
263
- body: validationSchemaStorage_1.validationSchemaStorage.lazy("SpacePropertyV1")
264
- }).describe("SpacePropertiesService.createSpacePropertyForKey.response"));
265
- validationSchemaStorage_1.validationSchemaStorage.registerOnce([spaceProperties_1.registerSpacePropertiesValidationSchemas]);
266
- }
267
- }
268
- exports.SpacePropertiesService = SpacePropertiesService;
269
- //# sourceMappingURL=SpacePropertiesService.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"SpacePropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SpacePropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,+DAAuN;AACvN,wEAAqE;AACrE,6BAAwB;AACxB;;;;GAIG;AACH,MAAa,sBAAuB,SAAQ,qCAAiB;IAA7D;;QACE;;;;;;;;;;;;;;;;WAgBG;QACH,wBAAmB,GAAG,CAAC,EACrB,QAAQ,EACR,mBAAmB,EAMpB,EAA4B,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,0CAA0C;gBAChD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,mBAAmB;aAC1B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,qDAAqD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3K,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;WAmBG;QACH,8BAAyB,GAAG,CAAC,EAC3B,QAAQ,EACR,GAAG,EACH,wBAAwB,EAQzB,EAA4B,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,QAAQ;oBACR,GAAG;iBACJ;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,wBAAwB;aAC/B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,2DAA2D,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACjL,CAAC,CAAC;QACF;;;;;;;;;;;;;;;WAeG;QACH,wBAAmB,GAAG,CAAC,EACrB,QAAQ,EACR,GAAG,EAMJ,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,QAAQ;oBACR,GAAG;iBACJ;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,uBAAkB,GAAG,CAAC,EACpB,QAAQ,EACR,MAAM,EACN,KAAK,EACL,KAAK,EAmBN,EAA+B,EAAE;YAChC,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,0CAA0C;gBAChD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,QAAQ;iBACT;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;oBACL,KAAK;iBACN;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,oDAAoD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1K,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,qBAAgB,GAAG,CAAC,EAClB,QAAQ,EACR,GAAG,EACH,MAAM,EAcP,EAA4B,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,QAAQ;oBACR,GAAG;iBACJ;gBACD,KAAK,EAAE;oBACL,MAAM;iBACP;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,kDAAkD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACxK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,wBAAmB,GAAG,CAAC,EACrB,QAAQ,EACR,GAAG,EACH,mBAAmB,EAQpB,EAA4B,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,QAAQ;oBACR,GAAG;iBACJ;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,mBAAmB;aAC1B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,qDAAqD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3K,CAAC,CAAC;IA6BJ,CAAC;IA5BW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,oDAAoD,EAAE,OAAC,CAAC,MAAM,CAAC;YACxG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,oBAAoB,CAAC;SACzD,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC,CAAC,CAAC;QACnE,iDAAuB,CAAC,kBAAkB,CAAC,qDAAqD,EAAE,OAAC,CAAC,MAAM,CAAC;YACzG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC,CAAC,QAAQ,CAAC,qDAAqD,CAAC,CAAC,CAAC;QACpE,iDAAuB,CAAC,kBAAkB,CAAC,kDAAkD,EAAE,OAAC,CAAC,MAAM,CAAC;YACtG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC,CAAC,QAAQ,CAAC,kDAAkD,CAAC,CAAC,CAAC;QACjE,iDAAuB,CAAC,kBAAkB,CAAC,qDAAqD,EAAE,OAAC,CAAC,MAAM,CAAC;YACzG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC,CAAC,QAAQ,CAAC,qDAAqD,CAAC,CAAC,CAAC;QACpE,iDAAuB,CAAC,kBAAkB,CAAC,2DAA2D,EAAE,OAAC,CAAC,MAAM,CAAC;YAC/G,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC,CAAC,QAAQ,CAAC,2DAA2D,CAAC,CAAC,CAAC;QAC1E,iDAAuB,CAAC,YAAY,CAAC,CAAC,0DAAwC,CAAC,CAAC,CAAC;IACnF,CAAC;CACF;AAzVD,wDAyVC"}