@unified-api/typescript-sdk 2.79.0 → 2.80.1

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 (165) hide show
  1. package/examples/package-lock.json +1 -1
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +3 -3
  4. package/lib/config.js +3 -3
  5. package/package.json +1 -1
  6. package/sdk/models/shared/calendareventrecurrence.d.ts +2 -5
  7. package/sdk/models/shared/calendareventrecurrence.d.ts.map +1 -1
  8. package/sdk/models/shared/calendareventrecurrence.js +2 -2
  9. package/sdk/models/shared/calendareventrecurrence.js.map +1 -1
  10. package/sdk/models/shared/index.d.ts +5 -0
  11. package/sdk/models/shared/index.d.ts.map +1 -1
  12. package/sdk/models/shared/index.js +5 -0
  13. package/sdk/models/shared/index.js.map +1 -1
  14. package/sdk/models/shared/integration.d.ts +3 -2
  15. package/sdk/models/shared/integration.d.ts.map +1 -1
  16. package/sdk/models/shared/integration.js +3 -2
  17. package/sdk/models/shared/integration.js.map +1 -1
  18. package/sdk/models/shared/integrationsupport.d.ts +2410 -0
  19. package/sdk/models/shared/integrationsupport.d.ts.map +1 -0
  20. package/sdk/models/shared/integrationsupport.js +3440 -0
  21. package/sdk/models/shared/integrationsupport.js.map +1 -0
  22. package/sdk/models/shared/kmspage.d.ts +2 -0
  23. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  24. package/sdk/models/shared/kmspage.js +4 -0
  25. package/sdk/models/shared/kmspage.js.map +1 -1
  26. package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts +36 -0
  27. package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts.map +1 -0
  28. package/sdk/models/shared/propertyintegrationsupportwebhookevents.js +79 -0
  29. package/sdk/models/shared/propertyintegrationsupportwebhookevents.js.map +1 -0
  30. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts +22 -0
  31. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts.map +1 -0
  32. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js +68 -0
  33. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js.map +1 -0
  34. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts +22 -0
  35. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts.map +1 -0
  36. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js +68 -0
  37. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js.map +1 -0
  38. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts +22 -0
  39. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts.map +1 -0
  40. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js +68 -0
  41. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js.map +1 -0
  42. package/sdk/models/shared/webhook.d.ts +2 -2
  43. package/sdk/models/shared/webhook.d.ts.map +1 -1
  44. package/sdk/models/shared/webhook.js +2 -2
  45. package/sdk/models/shared/webhook.js.map +1 -1
  46. package/src/lib/config.ts +3 -3
  47. package/src/sdk/models/shared/calendareventrecurrence.ts +4 -7
  48. package/src/sdk/models/shared/index.ts +5 -0
  49. package/src/sdk/models/shared/integration.ts +10 -4
  50. package/src/sdk/models/shared/integrationsupport.ts +4969 -0
  51. package/src/sdk/models/shared/kmspage.ts +6 -0
  52. package/src/sdk/models/shared/propertyintegrationsupportwebhookevents.ts +109 -0
  53. package/src/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.ts +54 -0
  54. package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.ts +54 -0
  55. package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.ts +54 -0
  56. package/src/sdk/models/shared/webhook.ts +4 -4
  57. package/docs/sdks/account/README.md +0 -489
  58. package/docs/sdks/accounting/README.md +0 -7221
  59. package/docs/sdks/activity/README.md +0 -489
  60. package/docs/sdks/apicall/README.md +0 -159
  61. package/docs/sdks/application/README.md +0 -489
  62. package/docs/sdks/applicationstatus/README.md +0 -85
  63. package/docs/sdks/ats/README.md +0 -3953
  64. package/docs/sdks/auth/README.md +0 -167
  65. package/docs/sdks/balancesheet/README.md +0 -165
  66. package/docs/sdks/bill/README.md +0 -489
  67. package/docs/sdks/branch/README.md +0 -507
  68. package/docs/sdks/busy/README.md +0 -85
  69. package/docs/sdks/calendar/README.md +0 -1713
  70. package/docs/sdks/call/README.md +0 -85
  71. package/docs/sdks/candidate/README.md +0 -489
  72. package/docs/sdks/cashflow/README.md +0 -165
  73. package/docs/sdks/category/README.md +0 -971
  74. package/docs/sdks/change/README.md +0 -165
  75. package/docs/sdks/channel/README.md +0 -165
  76. package/docs/sdks/class/README.md +0 -507
  77. package/docs/sdks/collection/README.md +0 -501
  78. package/docs/sdks/comment/README.md +0 -1495
  79. package/docs/sdks/commerce/README.md +0 -2465
  80. package/docs/sdks/commit/README.md +0 -501
  81. package/docs/sdks/company/README.md +0 -1543
  82. package/docs/sdks/connection/README.md +0 -513
  83. package/docs/sdks/contact/README.md +0 -1453
  84. package/docs/sdks/course/README.md +0 -501
  85. package/docs/sdks/creditmemo/README.md +0 -489
  86. package/docs/sdks/crm/README.md +0 -2899
  87. package/docs/sdks/customer/README.md +0 -489
  88. package/docs/sdks/deal/README.md +0 -489
  89. package/docs/sdks/device/README.md +0 -501
  90. package/docs/sdks/document/README.md +0 -489
  91. package/docs/sdks/embedding/README.md +0 -87
  92. package/docs/sdks/employee/README.md +0 -489
  93. package/docs/sdks/enrich/README.md +0 -163
  94. package/docs/sdks/event/README.md +0 -971
  95. package/docs/sdks/expense/README.md +0 -489
  96. package/docs/sdks/file/README.md +0 -489
  97. package/docs/sdks/genai/README.md +0 -325
  98. package/docs/sdks/group/README.md +0 -983
  99. package/docs/sdks/hris/README.md +0 -3251
  100. package/docs/sdks/instructor/README.md +0 -489
  101. package/docs/sdks/integration/README.md +0 -239
  102. package/docs/sdks/interview/README.md +0 -489
  103. package/docs/sdks/inventory/README.md +0 -501
  104. package/docs/sdks/invoice/README.md +0 -489
  105. package/docs/sdks/issue/README.md +0 -159
  106. package/docs/sdks/item/README.md +0 -489
  107. package/docs/sdks/job/README.md +0 -489
  108. package/docs/sdks/journal/README.md +0 -489
  109. package/docs/sdks/kms/README.md +0 -1495
  110. package/docs/sdks/lead/README.md +0 -489
  111. package/docs/sdks/link/README.md +0 -983
  112. package/docs/sdks/list/README.md +0 -489
  113. package/docs/sdks/lms/README.md +0 -1965
  114. package/docs/sdks/location/README.md +0 -983
  115. package/docs/sdks/login/README.md +0 -87
  116. package/docs/sdks/martech/README.md +0 -971
  117. package/docs/sdks/member/README.md +0 -489
  118. package/docs/sdks/message/README.md +0 -489
  119. package/docs/sdks/messaging/README.md +0 -647
  120. package/docs/sdks/metadata/README.md +0 -507
  121. package/docs/sdks/model/README.md +0 -165
  122. package/docs/sdks/note/README.md +0 -489
  123. package/docs/sdks/order/README.md +0 -489
  124. package/docs/sdks/organization/README.md +0 -647
  125. package/docs/sdks/package/README.md +0 -165
  126. package/docs/sdks/page/README.md +0 -507
  127. package/docs/sdks/passthrough/README.md +0 -647
  128. package/docs/sdks/payment/README.md +0 -1769
  129. package/docs/sdks/payout/README.md +0 -165
  130. package/docs/sdks/payslip/README.md +0 -165
  131. package/docs/sdks/person/README.md +0 -85
  132. package/docs/sdks/pipeline/README.md +0 -489
  133. package/docs/sdks/profitloss/README.md +0 -165
  134. package/docs/sdks/project/README.md +0 -489
  135. package/docs/sdks/prompt/README.md +0 -87
  136. package/docs/sdks/pullrequest/README.md +0 -489
  137. package/docs/sdks/purchaseorder/README.md +0 -489
  138. package/docs/sdks/recording/README.md +0 -647
  139. package/docs/sdks/refund/README.md +0 -165
  140. package/docs/sdks/repo/README.md +0 -2459
  141. package/docs/sdks/report/README.md +0 -165
  142. package/docs/sdks/repository/README.md +0 -501
  143. package/docs/sdks/request/README.md +0 -489
  144. package/docs/sdks/review/README.md +0 -501
  145. package/docs/sdks/salesorder/README.md +0 -489
  146. package/docs/sdks/scim/README.md +0 -983
  147. package/docs/sdks/scorecard/README.md +0 -489
  148. package/docs/sdks/space/README.md +0 -501
  149. package/docs/sdks/storage/README.md +0 -489
  150. package/docs/sdks/student/README.md +0 -489
  151. package/docs/sdks/subscription/README.md +0 -489
  152. package/docs/sdks/task/README.md +0 -1629
  153. package/docs/sdks/taxrate/README.md +0 -489
  154. package/docs/sdks/ticket/README.md +0 -489
  155. package/docs/sdks/ticketing/README.md +0 -1935
  156. package/docs/sdks/timeoff/README.md +0 -165
  157. package/docs/sdks/timeshift/README.md +0 -513
  158. package/docs/sdks/transaction/README.md +0 -489
  159. package/docs/sdks/trialbalance/README.md +0 -165
  160. package/docs/sdks/uc/README.md +0 -1543
  161. package/docs/sdks/unified/README.md +0 -1697
  162. package/docs/sdks/user/README.md +0 -489
  163. package/docs/sdks/verification/README.md +0 -647
  164. package/docs/sdks/webhook/README.md +0 -655
  165. package/examples/README.md +0 -31
@@ -1,1495 +0,0 @@
1
- # Kms
2
- (*kms*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createKmsComment](#createkmscomment) - Create a comment
9
- * [createKmsPage](#createkmspage) - Create a page
10
- * [createKmsSpace](#createkmsspace) - Create a space
11
- * [getKmsComment](#getkmscomment) - Retrieve a comment
12
- * [getKmsPage](#getkmspage) - Retrieve a page
13
- * [getKmsSpace](#getkmsspace) - Retrieve a space
14
- * [listKmsComments](#listkmscomments) - List all comments
15
- * [listKmsPages](#listkmspages) - List all pages
16
- * [listKmsSpaces](#listkmsspaces) - List all spaces
17
- * [patchKmsComment](#patchkmscomment) - Update a comment
18
- * [patchKmsPage](#patchkmspage) - Update a page
19
- * [patchKmsSpace](#patchkmsspace) - Update a space
20
- * [removeKmsComment](#removekmscomment) - Remove a comment
21
- * [removeKmsPage](#removekmspage) - Remove a page
22
- * [removeKmsSpace](#removekmsspace) - Remove a space
23
- * [updateKmsComment](#updatekmscomment) - Update a comment
24
- * [updateKmsPage](#updatekmspage) - Update a page
25
- * [updateKmsSpace](#updatekmsspace) - Update a space
26
-
27
- ## createKmsComment
28
-
29
- Create a comment
30
-
31
- ### Example Usage
32
-
33
- <!-- UsageSnippet language="typescript" operationID="createKmsComment" method="post" path="/kms/{connection_id}/comment" -->
34
- ```typescript
35
- import { UnifiedTo } from "@unified-api/typescript-sdk";
36
-
37
- const unifiedTo = new UnifiedTo({
38
- security: {
39
- jwt: "<YOUR_API_KEY_HERE>",
40
- },
41
- });
42
-
43
- async function run() {
44
- const result = await unifiedTo.kms.createKmsComment({
45
- kmsComment: {
46
- content: "<value>",
47
- },
48
- connectionId: "<id>",
49
- });
50
-
51
- console.log(result);
52
- }
53
-
54
- run();
55
- ```
56
-
57
- ### Standalone function
58
-
59
- The standalone function version of this method:
60
-
61
- ```typescript
62
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
63
- import { kmsCreateKmsComment } from "@unified-api/typescript-sdk/funcs/kmsCreateKmsComment.js";
64
-
65
- // Use `UnifiedToCore` for best tree-shaking performance.
66
- // You can create one instance of it to use across an application.
67
- const unifiedTo = new UnifiedToCore({
68
- security: {
69
- jwt: "<YOUR_API_KEY_HERE>",
70
- },
71
- });
72
-
73
- async function run() {
74
- const res = await kmsCreateKmsComment(unifiedTo, {
75
- kmsComment: {
76
- content: "<value>",
77
- },
78
- connectionId: "<id>",
79
- });
80
- if (res.ok) {
81
- const { value: result } = res;
82
- console.log(result);
83
- } else {
84
- console.log("kmsCreateKmsComment failed:", res.error);
85
- }
86
- }
87
-
88
- run();
89
- ```
90
-
91
- ### Parameters
92
-
93
- | Parameter | Type | Required | Description |
94
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
95
- | `request` | [operations.CreateKmsCommentRequest](../../sdk/models/operations/createkmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
96
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
97
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
98
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
99
-
100
- ### Response
101
-
102
- **Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
103
-
104
- ### Errors
105
-
106
- | Error Type | Status Code | Content Type |
107
- | --------------- | --------------- | --------------- |
108
- | errors.SDKError | 4XX, 5XX | \*/\* |
109
-
110
- ## createKmsPage
111
-
112
- Create a page
113
-
114
- ### Example Usage
115
-
116
- <!-- UsageSnippet language="typescript" operationID="createKmsPage" method="post" path="/kms/{connection_id}/page" -->
117
- ```typescript
118
- import { UnifiedTo } from "@unified-api/typescript-sdk";
119
-
120
- const unifiedTo = new UnifiedTo({
121
- security: {
122
- jwt: "<YOUR_API_KEY_HERE>",
123
- },
124
- });
125
-
126
- async function run() {
127
- const result = await unifiedTo.kms.createKmsPage({
128
- kmsPage: {
129
- title: "<value>",
130
- type: "TEXT",
131
- },
132
- connectionId: "<id>",
133
- });
134
-
135
- console.log(result);
136
- }
137
-
138
- run();
139
- ```
140
-
141
- ### Standalone function
142
-
143
- The standalone function version of this method:
144
-
145
- ```typescript
146
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
147
- import { kmsCreateKmsPage } from "@unified-api/typescript-sdk/funcs/kmsCreateKmsPage.js";
148
-
149
- // Use `UnifiedToCore` for best tree-shaking performance.
150
- // You can create one instance of it to use across an application.
151
- const unifiedTo = new UnifiedToCore({
152
- security: {
153
- jwt: "<YOUR_API_KEY_HERE>",
154
- },
155
- });
156
-
157
- async function run() {
158
- const res = await kmsCreateKmsPage(unifiedTo, {
159
- kmsPage: {
160
- title: "<value>",
161
- type: "TEXT",
162
- },
163
- connectionId: "<id>",
164
- });
165
- if (res.ok) {
166
- const { value: result } = res;
167
- console.log(result);
168
- } else {
169
- console.log("kmsCreateKmsPage failed:", res.error);
170
- }
171
- }
172
-
173
- run();
174
- ```
175
-
176
- ### Parameters
177
-
178
- | Parameter | Type | Required | Description |
179
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
180
- | `request` | [operations.CreateKmsPageRequest](../../sdk/models/operations/createkmspagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
181
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
182
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
183
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
184
-
185
- ### Response
186
-
187
- **Promise\<[shared.KmsPage](../../sdk/models/shared/kmspage.md)\>**
188
-
189
- ### Errors
190
-
191
- | Error Type | Status Code | Content Type |
192
- | --------------- | --------------- | --------------- |
193
- | errors.SDKError | 4XX, 5XX | \*/\* |
194
-
195
- ## createKmsSpace
196
-
197
- Create a space
198
-
199
- ### Example Usage
200
-
201
- <!-- UsageSnippet language="typescript" operationID="createKmsSpace" method="post" path="/kms/{connection_id}/space" -->
202
- ```typescript
203
- import { UnifiedTo } from "@unified-api/typescript-sdk";
204
-
205
- const unifiedTo = new UnifiedTo({
206
- security: {
207
- jwt: "<YOUR_API_KEY_HERE>",
208
- },
209
- });
210
-
211
- async function run() {
212
- const result = await unifiedTo.kms.createKmsSpace({
213
- kmsSpace: {
214
- name: "<value>",
215
- },
216
- connectionId: "<id>",
217
- });
218
-
219
- console.log(result);
220
- }
221
-
222
- run();
223
- ```
224
-
225
- ### Standalone function
226
-
227
- The standalone function version of this method:
228
-
229
- ```typescript
230
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
231
- import { kmsCreateKmsSpace } from "@unified-api/typescript-sdk/funcs/kmsCreateKmsSpace.js";
232
-
233
- // Use `UnifiedToCore` for best tree-shaking performance.
234
- // You can create one instance of it to use across an application.
235
- const unifiedTo = new UnifiedToCore({
236
- security: {
237
- jwt: "<YOUR_API_KEY_HERE>",
238
- },
239
- });
240
-
241
- async function run() {
242
- const res = await kmsCreateKmsSpace(unifiedTo, {
243
- kmsSpace: {
244
- name: "<value>",
245
- },
246
- connectionId: "<id>",
247
- });
248
- if (res.ok) {
249
- const { value: result } = res;
250
- console.log(result);
251
- } else {
252
- console.log("kmsCreateKmsSpace failed:", res.error);
253
- }
254
- }
255
-
256
- run();
257
- ```
258
-
259
- ### Parameters
260
-
261
- | Parameter | Type | Required | Description |
262
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
263
- | `request` | [operations.CreateKmsSpaceRequest](../../sdk/models/operations/createkmsspacerequest.md) | :heavy_check_mark: | The request object to use for the request. |
264
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
265
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
266
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
267
-
268
- ### Response
269
-
270
- **Promise\<[shared.KmsSpace](../../sdk/models/shared/kmsspace.md)\>**
271
-
272
- ### Errors
273
-
274
- | Error Type | Status Code | Content Type |
275
- | --------------- | --------------- | --------------- |
276
- | errors.SDKError | 4XX, 5XX | \*/\* |
277
-
278
- ## getKmsComment
279
-
280
- Retrieve a comment
281
-
282
- ### Example Usage
283
-
284
- <!-- UsageSnippet language="typescript" operationID="getKmsComment" method="get" path="/kms/{connection_id}/comment/{id}" -->
285
- ```typescript
286
- import { UnifiedTo } from "@unified-api/typescript-sdk";
287
-
288
- const unifiedTo = new UnifiedTo({
289
- security: {
290
- jwt: "<YOUR_API_KEY_HERE>",
291
- },
292
- });
293
-
294
- async function run() {
295
- const result = await unifiedTo.kms.getKmsComment({
296
- connectionId: "<id>",
297
- id: "<id>",
298
- });
299
-
300
- console.log(result);
301
- }
302
-
303
- run();
304
- ```
305
-
306
- ### Standalone function
307
-
308
- The standalone function version of this method:
309
-
310
- ```typescript
311
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
312
- import { kmsGetKmsComment } from "@unified-api/typescript-sdk/funcs/kmsGetKmsComment.js";
313
-
314
- // Use `UnifiedToCore` for best tree-shaking performance.
315
- // You can create one instance of it to use across an application.
316
- const unifiedTo = new UnifiedToCore({
317
- security: {
318
- jwt: "<YOUR_API_KEY_HERE>",
319
- },
320
- });
321
-
322
- async function run() {
323
- const res = await kmsGetKmsComment(unifiedTo, {
324
- connectionId: "<id>",
325
- id: "<id>",
326
- });
327
- if (res.ok) {
328
- const { value: result } = res;
329
- console.log(result);
330
- } else {
331
- console.log("kmsGetKmsComment failed:", res.error);
332
- }
333
- }
334
-
335
- run();
336
- ```
337
-
338
- ### Parameters
339
-
340
- | Parameter | Type | Required | Description |
341
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
342
- | `request` | [operations.GetKmsCommentRequest](../../sdk/models/operations/getkmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
343
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
344
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
345
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
346
-
347
- ### Response
348
-
349
- **Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
350
-
351
- ### Errors
352
-
353
- | Error Type | Status Code | Content Type |
354
- | --------------- | --------------- | --------------- |
355
- | errors.SDKError | 4XX, 5XX | \*/\* |
356
-
357
- ## getKmsPage
358
-
359
- Retrieve a page
360
-
361
- ### Example Usage
362
-
363
- <!-- UsageSnippet language="typescript" operationID="getKmsPage" method="get" path="/kms/{connection_id}/page/{id}" -->
364
- ```typescript
365
- import { UnifiedTo } from "@unified-api/typescript-sdk";
366
-
367
- const unifiedTo = new UnifiedTo({
368
- security: {
369
- jwt: "<YOUR_API_KEY_HERE>",
370
- },
371
- });
372
-
373
- async function run() {
374
- const result = await unifiedTo.kms.getKmsPage({
375
- connectionId: "<id>",
376
- id: "<id>",
377
- });
378
-
379
- console.log(result);
380
- }
381
-
382
- run();
383
- ```
384
-
385
- ### Standalone function
386
-
387
- The standalone function version of this method:
388
-
389
- ```typescript
390
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
391
- import { kmsGetKmsPage } from "@unified-api/typescript-sdk/funcs/kmsGetKmsPage.js";
392
-
393
- // Use `UnifiedToCore` for best tree-shaking performance.
394
- // You can create one instance of it to use across an application.
395
- const unifiedTo = new UnifiedToCore({
396
- security: {
397
- jwt: "<YOUR_API_KEY_HERE>",
398
- },
399
- });
400
-
401
- async function run() {
402
- const res = await kmsGetKmsPage(unifiedTo, {
403
- connectionId: "<id>",
404
- id: "<id>",
405
- });
406
- if (res.ok) {
407
- const { value: result } = res;
408
- console.log(result);
409
- } else {
410
- console.log("kmsGetKmsPage failed:", res.error);
411
- }
412
- }
413
-
414
- run();
415
- ```
416
-
417
- ### Parameters
418
-
419
- | Parameter | Type | Required | Description |
420
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
421
- | `request` | [operations.GetKmsPageRequest](../../sdk/models/operations/getkmspagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
422
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
423
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
424
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
425
-
426
- ### Response
427
-
428
- **Promise\<[shared.KmsPage](../../sdk/models/shared/kmspage.md)\>**
429
-
430
- ### Errors
431
-
432
- | Error Type | Status Code | Content Type |
433
- | --------------- | --------------- | --------------- |
434
- | errors.SDKError | 4XX, 5XX | \*/\* |
435
-
436
- ## getKmsSpace
437
-
438
- Retrieve a space
439
-
440
- ### Example Usage
441
-
442
- <!-- UsageSnippet language="typescript" operationID="getKmsSpace" method="get" path="/kms/{connection_id}/space/{id}" -->
443
- ```typescript
444
- import { UnifiedTo } from "@unified-api/typescript-sdk";
445
-
446
- const unifiedTo = new UnifiedTo({
447
- security: {
448
- jwt: "<YOUR_API_KEY_HERE>",
449
- },
450
- });
451
-
452
- async function run() {
453
- const result = await unifiedTo.kms.getKmsSpace({
454
- connectionId: "<id>",
455
- id: "<id>",
456
- });
457
-
458
- console.log(result);
459
- }
460
-
461
- run();
462
- ```
463
-
464
- ### Standalone function
465
-
466
- The standalone function version of this method:
467
-
468
- ```typescript
469
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
470
- import { kmsGetKmsSpace } from "@unified-api/typescript-sdk/funcs/kmsGetKmsSpace.js";
471
-
472
- // Use `UnifiedToCore` for best tree-shaking performance.
473
- // You can create one instance of it to use across an application.
474
- const unifiedTo = new UnifiedToCore({
475
- security: {
476
- jwt: "<YOUR_API_KEY_HERE>",
477
- },
478
- });
479
-
480
- async function run() {
481
- const res = await kmsGetKmsSpace(unifiedTo, {
482
- connectionId: "<id>",
483
- id: "<id>",
484
- });
485
- if (res.ok) {
486
- const { value: result } = res;
487
- console.log(result);
488
- } else {
489
- console.log("kmsGetKmsSpace failed:", res.error);
490
- }
491
- }
492
-
493
- run();
494
- ```
495
-
496
- ### Parameters
497
-
498
- | Parameter | Type | Required | Description |
499
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
500
- | `request` | [operations.GetKmsSpaceRequest](../../sdk/models/operations/getkmsspacerequest.md) | :heavy_check_mark: | The request object to use for the request. |
501
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
502
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
503
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
504
-
505
- ### Response
506
-
507
- **Promise\<[shared.KmsSpace](../../sdk/models/shared/kmsspace.md)\>**
508
-
509
- ### Errors
510
-
511
- | Error Type | Status Code | Content Type |
512
- | --------------- | --------------- | --------------- |
513
- | errors.SDKError | 4XX, 5XX | \*/\* |
514
-
515
- ## listKmsComments
516
-
517
- List all comments
518
-
519
- ### Example Usage
520
-
521
- <!-- UsageSnippet language="typescript" operationID="listKmsComments" method="get" path="/kms/{connection_id}/comment" -->
522
- ```typescript
523
- import { UnifiedTo } from "@unified-api/typescript-sdk";
524
-
525
- const unifiedTo = new UnifiedTo({
526
- security: {
527
- jwt: "<YOUR_API_KEY_HERE>",
528
- },
529
- });
530
-
531
- async function run() {
532
- const result = await unifiedTo.kms.listKmsComments({
533
- connectionId: "<id>",
534
- });
535
-
536
- console.log(result);
537
- }
538
-
539
- run();
540
- ```
541
-
542
- ### Standalone function
543
-
544
- The standalone function version of this method:
545
-
546
- ```typescript
547
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
548
- import { kmsListKmsComments } from "@unified-api/typescript-sdk/funcs/kmsListKmsComments.js";
549
-
550
- // Use `UnifiedToCore` for best tree-shaking performance.
551
- // You can create one instance of it to use across an application.
552
- const unifiedTo = new UnifiedToCore({
553
- security: {
554
- jwt: "<YOUR_API_KEY_HERE>",
555
- },
556
- });
557
-
558
- async function run() {
559
- const res = await kmsListKmsComments(unifiedTo, {
560
- connectionId: "<id>",
561
- });
562
- if (res.ok) {
563
- const { value: result } = res;
564
- console.log(result);
565
- } else {
566
- console.log("kmsListKmsComments failed:", res.error);
567
- }
568
- }
569
-
570
- run();
571
- ```
572
-
573
- ### Parameters
574
-
575
- | Parameter | Type | Required | Description |
576
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
577
- | `request` | [operations.ListKmsCommentsRequest](../../sdk/models/operations/listkmscommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
578
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
579
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
580
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
581
-
582
- ### Response
583
-
584
- **Promise\<[shared.KmsComment[]](../../models/.md)\>**
585
-
586
- ### Errors
587
-
588
- | Error Type | Status Code | Content Type |
589
- | --------------- | --------------- | --------------- |
590
- | errors.SDKError | 4XX, 5XX | \*/\* |
591
-
592
- ## listKmsPages
593
-
594
- List all pages
595
-
596
- ### Example Usage
597
-
598
- <!-- UsageSnippet language="typescript" operationID="listKmsPages" method="get" path="/kms/{connection_id}/page" -->
599
- ```typescript
600
- import { UnifiedTo } from "@unified-api/typescript-sdk";
601
-
602
- const unifiedTo = new UnifiedTo({
603
- security: {
604
- jwt: "<YOUR_API_KEY_HERE>",
605
- },
606
- });
607
-
608
- async function run() {
609
- const result = await unifiedTo.kms.listKmsPages({
610
- connectionId: "<id>",
611
- });
612
-
613
- console.log(result);
614
- }
615
-
616
- run();
617
- ```
618
-
619
- ### Standalone function
620
-
621
- The standalone function version of this method:
622
-
623
- ```typescript
624
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
625
- import { kmsListKmsPages } from "@unified-api/typescript-sdk/funcs/kmsListKmsPages.js";
626
-
627
- // Use `UnifiedToCore` for best tree-shaking performance.
628
- // You can create one instance of it to use across an application.
629
- const unifiedTo = new UnifiedToCore({
630
- security: {
631
- jwt: "<YOUR_API_KEY_HERE>",
632
- },
633
- });
634
-
635
- async function run() {
636
- const res = await kmsListKmsPages(unifiedTo, {
637
- connectionId: "<id>",
638
- });
639
- if (res.ok) {
640
- const { value: result } = res;
641
- console.log(result);
642
- } else {
643
- console.log("kmsListKmsPages failed:", res.error);
644
- }
645
- }
646
-
647
- run();
648
- ```
649
-
650
- ### Parameters
651
-
652
- | Parameter | Type | Required | Description |
653
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
654
- | `request` | [operations.ListKmsPagesRequest](../../sdk/models/operations/listkmspagesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
655
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
656
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
657
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
658
-
659
- ### Response
660
-
661
- **Promise\<[shared.KmsPage[]](../../models/.md)\>**
662
-
663
- ### Errors
664
-
665
- | Error Type | Status Code | Content Type |
666
- | --------------- | --------------- | --------------- |
667
- | errors.SDKError | 4XX, 5XX | \*/\* |
668
-
669
- ## listKmsSpaces
670
-
671
- List all spaces
672
-
673
- ### Example Usage
674
-
675
- <!-- UsageSnippet language="typescript" operationID="listKmsSpaces" method="get" path="/kms/{connection_id}/space" -->
676
- ```typescript
677
- import { UnifiedTo } from "@unified-api/typescript-sdk";
678
-
679
- const unifiedTo = new UnifiedTo({
680
- security: {
681
- jwt: "<YOUR_API_KEY_HERE>",
682
- },
683
- });
684
-
685
- async function run() {
686
- const result = await unifiedTo.kms.listKmsSpaces({
687
- connectionId: "<id>",
688
- });
689
-
690
- console.log(result);
691
- }
692
-
693
- run();
694
- ```
695
-
696
- ### Standalone function
697
-
698
- The standalone function version of this method:
699
-
700
- ```typescript
701
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
702
- import { kmsListKmsSpaces } from "@unified-api/typescript-sdk/funcs/kmsListKmsSpaces.js";
703
-
704
- // Use `UnifiedToCore` for best tree-shaking performance.
705
- // You can create one instance of it to use across an application.
706
- const unifiedTo = new UnifiedToCore({
707
- security: {
708
- jwt: "<YOUR_API_KEY_HERE>",
709
- },
710
- });
711
-
712
- async function run() {
713
- const res = await kmsListKmsSpaces(unifiedTo, {
714
- connectionId: "<id>",
715
- });
716
- if (res.ok) {
717
- const { value: result } = res;
718
- console.log(result);
719
- } else {
720
- console.log("kmsListKmsSpaces failed:", res.error);
721
- }
722
- }
723
-
724
- run();
725
- ```
726
-
727
- ### Parameters
728
-
729
- | Parameter | Type | Required | Description |
730
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
731
- | `request` | [operations.ListKmsSpacesRequest](../../sdk/models/operations/listkmsspacesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
732
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
733
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
734
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
735
-
736
- ### Response
737
-
738
- **Promise\<[shared.KmsSpace[]](../../models/.md)\>**
739
-
740
- ### Errors
741
-
742
- | Error Type | Status Code | Content Type |
743
- | --------------- | --------------- | --------------- |
744
- | errors.SDKError | 4XX, 5XX | \*/\* |
745
-
746
- ## patchKmsComment
747
-
748
- Update a comment
749
-
750
- ### Example Usage
751
-
752
- <!-- UsageSnippet language="typescript" operationID="patchKmsComment" method="patch" path="/kms/{connection_id}/comment/{id}" -->
753
- ```typescript
754
- import { UnifiedTo } from "@unified-api/typescript-sdk";
755
-
756
- const unifiedTo = new UnifiedTo({
757
- security: {
758
- jwt: "<YOUR_API_KEY_HERE>",
759
- },
760
- });
761
-
762
- async function run() {
763
- const result = await unifiedTo.kms.patchKmsComment({
764
- kmsComment: {
765
- content: "<value>",
766
- },
767
- connectionId: "<id>",
768
- id: "<id>",
769
- });
770
-
771
- console.log(result);
772
- }
773
-
774
- run();
775
- ```
776
-
777
- ### Standalone function
778
-
779
- The standalone function version of this method:
780
-
781
- ```typescript
782
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
783
- import { kmsPatchKmsComment } from "@unified-api/typescript-sdk/funcs/kmsPatchKmsComment.js";
784
-
785
- // Use `UnifiedToCore` for best tree-shaking performance.
786
- // You can create one instance of it to use across an application.
787
- const unifiedTo = new UnifiedToCore({
788
- security: {
789
- jwt: "<YOUR_API_KEY_HERE>",
790
- },
791
- });
792
-
793
- async function run() {
794
- const res = await kmsPatchKmsComment(unifiedTo, {
795
- kmsComment: {
796
- content: "<value>",
797
- },
798
- connectionId: "<id>",
799
- id: "<id>",
800
- });
801
- if (res.ok) {
802
- const { value: result } = res;
803
- console.log(result);
804
- } else {
805
- console.log("kmsPatchKmsComment failed:", res.error);
806
- }
807
- }
808
-
809
- run();
810
- ```
811
-
812
- ### Parameters
813
-
814
- | Parameter | Type | Required | Description |
815
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
816
- | `request` | [operations.PatchKmsCommentRequest](../../sdk/models/operations/patchkmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
817
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
818
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
819
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
820
-
821
- ### Response
822
-
823
- **Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
824
-
825
- ### Errors
826
-
827
- | Error Type | Status Code | Content Type |
828
- | --------------- | --------------- | --------------- |
829
- | errors.SDKError | 4XX, 5XX | \*/\* |
830
-
831
- ## patchKmsPage
832
-
833
- Update a page
834
-
835
- ### Example Usage
836
-
837
- <!-- UsageSnippet language="typescript" operationID="patchKmsPage" method="patch" path="/kms/{connection_id}/page/{id}" -->
838
- ```typescript
839
- import { UnifiedTo } from "@unified-api/typescript-sdk";
840
-
841
- const unifiedTo = new UnifiedTo({
842
- security: {
843
- jwt: "<YOUR_API_KEY_HERE>",
844
- },
845
- });
846
-
847
- async function run() {
848
- const result = await unifiedTo.kms.patchKmsPage({
849
- kmsPage: {
850
- title: "<value>",
851
- type: "OTHER",
852
- },
853
- connectionId: "<id>",
854
- id: "<id>",
855
- });
856
-
857
- console.log(result);
858
- }
859
-
860
- run();
861
- ```
862
-
863
- ### Standalone function
864
-
865
- The standalone function version of this method:
866
-
867
- ```typescript
868
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
869
- import { kmsPatchKmsPage } from "@unified-api/typescript-sdk/funcs/kmsPatchKmsPage.js";
870
-
871
- // Use `UnifiedToCore` for best tree-shaking performance.
872
- // You can create one instance of it to use across an application.
873
- const unifiedTo = new UnifiedToCore({
874
- security: {
875
- jwt: "<YOUR_API_KEY_HERE>",
876
- },
877
- });
878
-
879
- async function run() {
880
- const res = await kmsPatchKmsPage(unifiedTo, {
881
- kmsPage: {
882
- title: "<value>",
883
- type: "OTHER",
884
- },
885
- connectionId: "<id>",
886
- id: "<id>",
887
- });
888
- if (res.ok) {
889
- const { value: result } = res;
890
- console.log(result);
891
- } else {
892
- console.log("kmsPatchKmsPage failed:", res.error);
893
- }
894
- }
895
-
896
- run();
897
- ```
898
-
899
- ### Parameters
900
-
901
- | Parameter | Type | Required | Description |
902
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
903
- | `request` | [operations.PatchKmsPageRequest](../../sdk/models/operations/patchkmspagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
904
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
905
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
906
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
907
-
908
- ### Response
909
-
910
- **Promise\<[shared.KmsPage](../../sdk/models/shared/kmspage.md)\>**
911
-
912
- ### Errors
913
-
914
- | Error Type | Status Code | Content Type |
915
- | --------------- | --------------- | --------------- |
916
- | errors.SDKError | 4XX, 5XX | \*/\* |
917
-
918
- ## patchKmsSpace
919
-
920
- Update a space
921
-
922
- ### Example Usage
923
-
924
- <!-- UsageSnippet language="typescript" operationID="patchKmsSpace" method="patch" path="/kms/{connection_id}/space/{id}" -->
925
- ```typescript
926
- import { UnifiedTo } from "@unified-api/typescript-sdk";
927
-
928
- const unifiedTo = new UnifiedTo({
929
- security: {
930
- jwt: "<YOUR_API_KEY_HERE>",
931
- },
932
- });
933
-
934
- async function run() {
935
- const result = await unifiedTo.kms.patchKmsSpace({
936
- kmsSpace: {
937
- name: "<value>",
938
- },
939
- connectionId: "<id>",
940
- id: "<id>",
941
- });
942
-
943
- console.log(result);
944
- }
945
-
946
- run();
947
- ```
948
-
949
- ### Standalone function
950
-
951
- The standalone function version of this method:
952
-
953
- ```typescript
954
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
955
- import { kmsPatchKmsSpace } from "@unified-api/typescript-sdk/funcs/kmsPatchKmsSpace.js";
956
-
957
- // Use `UnifiedToCore` for best tree-shaking performance.
958
- // You can create one instance of it to use across an application.
959
- const unifiedTo = new UnifiedToCore({
960
- security: {
961
- jwt: "<YOUR_API_KEY_HERE>",
962
- },
963
- });
964
-
965
- async function run() {
966
- const res = await kmsPatchKmsSpace(unifiedTo, {
967
- kmsSpace: {
968
- name: "<value>",
969
- },
970
- connectionId: "<id>",
971
- id: "<id>",
972
- });
973
- if (res.ok) {
974
- const { value: result } = res;
975
- console.log(result);
976
- } else {
977
- console.log("kmsPatchKmsSpace failed:", res.error);
978
- }
979
- }
980
-
981
- run();
982
- ```
983
-
984
- ### Parameters
985
-
986
- | Parameter | Type | Required | Description |
987
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
988
- | `request` | [operations.PatchKmsSpaceRequest](../../sdk/models/operations/patchkmsspacerequest.md) | :heavy_check_mark: | The request object to use for the request. |
989
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
990
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
991
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
992
-
993
- ### Response
994
-
995
- **Promise\<[shared.KmsSpace](../../sdk/models/shared/kmsspace.md)\>**
996
-
997
- ### Errors
998
-
999
- | Error Type | Status Code | Content Type |
1000
- | --------------- | --------------- | --------------- |
1001
- | errors.SDKError | 4XX, 5XX | \*/\* |
1002
-
1003
- ## removeKmsComment
1004
-
1005
- Remove a comment
1006
-
1007
- ### Example Usage
1008
-
1009
- <!-- UsageSnippet language="typescript" operationID="removeKmsComment" method="delete" path="/kms/{connection_id}/comment/{id}" -->
1010
- ```typescript
1011
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1012
-
1013
- const unifiedTo = new UnifiedTo({
1014
- security: {
1015
- jwt: "<YOUR_API_KEY_HERE>",
1016
- },
1017
- });
1018
-
1019
- async function run() {
1020
- const result = await unifiedTo.kms.removeKmsComment({
1021
- connectionId: "<id>",
1022
- id: "<id>",
1023
- });
1024
-
1025
- console.log(result);
1026
- }
1027
-
1028
- run();
1029
- ```
1030
-
1031
- ### Standalone function
1032
-
1033
- The standalone function version of this method:
1034
-
1035
- ```typescript
1036
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1037
- import { kmsRemoveKmsComment } from "@unified-api/typescript-sdk/funcs/kmsRemoveKmsComment.js";
1038
-
1039
- // Use `UnifiedToCore` for best tree-shaking performance.
1040
- // You can create one instance of it to use across an application.
1041
- const unifiedTo = new UnifiedToCore({
1042
- security: {
1043
- jwt: "<YOUR_API_KEY_HERE>",
1044
- },
1045
- });
1046
-
1047
- async function run() {
1048
- const res = await kmsRemoveKmsComment(unifiedTo, {
1049
- connectionId: "<id>",
1050
- id: "<id>",
1051
- });
1052
- if (res.ok) {
1053
- const { value: result } = res;
1054
- console.log(result);
1055
- } else {
1056
- console.log("kmsRemoveKmsComment failed:", res.error);
1057
- }
1058
- }
1059
-
1060
- run();
1061
- ```
1062
-
1063
- ### Parameters
1064
-
1065
- | Parameter | Type | Required | Description |
1066
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1067
- | `request` | [operations.RemoveKmsCommentRequest](../../sdk/models/operations/removekmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1068
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1069
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1070
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1071
-
1072
- ### Response
1073
-
1074
- **Promise\<[operations.RemoveKmsCommentResponse](../../sdk/models/operations/removekmscommentresponse.md)\>**
1075
-
1076
- ### Errors
1077
-
1078
- | Error Type | Status Code | Content Type |
1079
- | --------------- | --------------- | --------------- |
1080
- | errors.SDKError | 4XX, 5XX | \*/\* |
1081
-
1082
- ## removeKmsPage
1083
-
1084
- Remove a page
1085
-
1086
- ### Example Usage
1087
-
1088
- <!-- UsageSnippet language="typescript" operationID="removeKmsPage" method="delete" path="/kms/{connection_id}/page/{id}" -->
1089
- ```typescript
1090
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1091
-
1092
- const unifiedTo = new UnifiedTo({
1093
- security: {
1094
- jwt: "<YOUR_API_KEY_HERE>",
1095
- },
1096
- });
1097
-
1098
- async function run() {
1099
- const result = await unifiedTo.kms.removeKmsPage({
1100
- connectionId: "<id>",
1101
- id: "<id>",
1102
- });
1103
-
1104
- console.log(result);
1105
- }
1106
-
1107
- run();
1108
- ```
1109
-
1110
- ### Standalone function
1111
-
1112
- The standalone function version of this method:
1113
-
1114
- ```typescript
1115
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1116
- import { kmsRemoveKmsPage } from "@unified-api/typescript-sdk/funcs/kmsRemoveKmsPage.js";
1117
-
1118
- // Use `UnifiedToCore` for best tree-shaking performance.
1119
- // You can create one instance of it to use across an application.
1120
- const unifiedTo = new UnifiedToCore({
1121
- security: {
1122
- jwt: "<YOUR_API_KEY_HERE>",
1123
- },
1124
- });
1125
-
1126
- async function run() {
1127
- const res = await kmsRemoveKmsPage(unifiedTo, {
1128
- connectionId: "<id>",
1129
- id: "<id>",
1130
- });
1131
- if (res.ok) {
1132
- const { value: result } = res;
1133
- console.log(result);
1134
- } else {
1135
- console.log("kmsRemoveKmsPage failed:", res.error);
1136
- }
1137
- }
1138
-
1139
- run();
1140
- ```
1141
-
1142
- ### Parameters
1143
-
1144
- | Parameter | Type | Required | Description |
1145
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1146
- | `request` | [operations.RemoveKmsPageRequest](../../sdk/models/operations/removekmspagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1147
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1148
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1149
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1150
-
1151
- ### Response
1152
-
1153
- **Promise\<[operations.RemoveKmsPageResponse](../../sdk/models/operations/removekmspageresponse.md)\>**
1154
-
1155
- ### Errors
1156
-
1157
- | Error Type | Status Code | Content Type |
1158
- | --------------- | --------------- | --------------- |
1159
- | errors.SDKError | 4XX, 5XX | \*/\* |
1160
-
1161
- ## removeKmsSpace
1162
-
1163
- Remove a space
1164
-
1165
- ### Example Usage
1166
-
1167
- <!-- UsageSnippet language="typescript" operationID="removeKmsSpace" method="delete" path="/kms/{connection_id}/space/{id}" -->
1168
- ```typescript
1169
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1170
-
1171
- const unifiedTo = new UnifiedTo({
1172
- security: {
1173
- jwt: "<YOUR_API_KEY_HERE>",
1174
- },
1175
- });
1176
-
1177
- async function run() {
1178
- const result = await unifiedTo.kms.removeKmsSpace({
1179
- connectionId: "<id>",
1180
- id: "<id>",
1181
- });
1182
-
1183
- console.log(result);
1184
- }
1185
-
1186
- run();
1187
- ```
1188
-
1189
- ### Standalone function
1190
-
1191
- The standalone function version of this method:
1192
-
1193
- ```typescript
1194
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1195
- import { kmsRemoveKmsSpace } from "@unified-api/typescript-sdk/funcs/kmsRemoveKmsSpace.js";
1196
-
1197
- // Use `UnifiedToCore` for best tree-shaking performance.
1198
- // You can create one instance of it to use across an application.
1199
- const unifiedTo = new UnifiedToCore({
1200
- security: {
1201
- jwt: "<YOUR_API_KEY_HERE>",
1202
- },
1203
- });
1204
-
1205
- async function run() {
1206
- const res = await kmsRemoveKmsSpace(unifiedTo, {
1207
- connectionId: "<id>",
1208
- id: "<id>",
1209
- });
1210
- if (res.ok) {
1211
- const { value: result } = res;
1212
- console.log(result);
1213
- } else {
1214
- console.log("kmsRemoveKmsSpace failed:", res.error);
1215
- }
1216
- }
1217
-
1218
- run();
1219
- ```
1220
-
1221
- ### Parameters
1222
-
1223
- | Parameter | Type | Required | Description |
1224
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1225
- | `request` | [operations.RemoveKmsSpaceRequest](../../sdk/models/operations/removekmsspacerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1226
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1227
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1228
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1229
-
1230
- ### Response
1231
-
1232
- **Promise\<[operations.RemoveKmsSpaceResponse](../../sdk/models/operations/removekmsspaceresponse.md)\>**
1233
-
1234
- ### Errors
1235
-
1236
- | Error Type | Status Code | Content Type |
1237
- | --------------- | --------------- | --------------- |
1238
- | errors.SDKError | 4XX, 5XX | \*/\* |
1239
-
1240
- ## updateKmsComment
1241
-
1242
- Update a comment
1243
-
1244
- ### Example Usage
1245
-
1246
- <!-- UsageSnippet language="typescript" operationID="updateKmsComment" method="put" path="/kms/{connection_id}/comment/{id}" -->
1247
- ```typescript
1248
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1249
-
1250
- const unifiedTo = new UnifiedTo({
1251
- security: {
1252
- jwt: "<YOUR_API_KEY_HERE>",
1253
- },
1254
- });
1255
-
1256
- async function run() {
1257
- const result = await unifiedTo.kms.updateKmsComment({
1258
- kmsComment: {
1259
- content: "<value>",
1260
- },
1261
- connectionId: "<id>",
1262
- id: "<id>",
1263
- });
1264
-
1265
- console.log(result);
1266
- }
1267
-
1268
- run();
1269
- ```
1270
-
1271
- ### Standalone function
1272
-
1273
- The standalone function version of this method:
1274
-
1275
- ```typescript
1276
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1277
- import { kmsUpdateKmsComment } from "@unified-api/typescript-sdk/funcs/kmsUpdateKmsComment.js";
1278
-
1279
- // Use `UnifiedToCore` for best tree-shaking performance.
1280
- // You can create one instance of it to use across an application.
1281
- const unifiedTo = new UnifiedToCore({
1282
- security: {
1283
- jwt: "<YOUR_API_KEY_HERE>",
1284
- },
1285
- });
1286
-
1287
- async function run() {
1288
- const res = await kmsUpdateKmsComment(unifiedTo, {
1289
- kmsComment: {
1290
- content: "<value>",
1291
- },
1292
- connectionId: "<id>",
1293
- id: "<id>",
1294
- });
1295
- if (res.ok) {
1296
- const { value: result } = res;
1297
- console.log(result);
1298
- } else {
1299
- console.log("kmsUpdateKmsComment failed:", res.error);
1300
- }
1301
- }
1302
-
1303
- run();
1304
- ```
1305
-
1306
- ### Parameters
1307
-
1308
- | Parameter | Type | Required | Description |
1309
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1310
- | `request` | [operations.UpdateKmsCommentRequest](../../sdk/models/operations/updatekmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1311
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1312
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1313
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1314
-
1315
- ### Response
1316
-
1317
- **Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
1318
-
1319
- ### Errors
1320
-
1321
- | Error Type | Status Code | Content Type |
1322
- | --------------- | --------------- | --------------- |
1323
- | errors.SDKError | 4XX, 5XX | \*/\* |
1324
-
1325
- ## updateKmsPage
1326
-
1327
- Update a page
1328
-
1329
- ### Example Usage
1330
-
1331
- <!-- UsageSnippet language="typescript" operationID="updateKmsPage" method="put" path="/kms/{connection_id}/page/{id}" -->
1332
- ```typescript
1333
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1334
-
1335
- const unifiedTo = new UnifiedTo({
1336
- security: {
1337
- jwt: "<YOUR_API_KEY_HERE>",
1338
- },
1339
- });
1340
-
1341
- async function run() {
1342
- const result = await unifiedTo.kms.updateKmsPage({
1343
- kmsPage: {
1344
- title: "<value>",
1345
- type: "OTHER",
1346
- },
1347
- connectionId: "<id>",
1348
- id: "<id>",
1349
- });
1350
-
1351
- console.log(result);
1352
- }
1353
-
1354
- run();
1355
- ```
1356
-
1357
- ### Standalone function
1358
-
1359
- The standalone function version of this method:
1360
-
1361
- ```typescript
1362
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1363
- import { kmsUpdateKmsPage } from "@unified-api/typescript-sdk/funcs/kmsUpdateKmsPage.js";
1364
-
1365
- // Use `UnifiedToCore` for best tree-shaking performance.
1366
- // You can create one instance of it to use across an application.
1367
- const unifiedTo = new UnifiedToCore({
1368
- security: {
1369
- jwt: "<YOUR_API_KEY_HERE>",
1370
- },
1371
- });
1372
-
1373
- async function run() {
1374
- const res = await kmsUpdateKmsPage(unifiedTo, {
1375
- kmsPage: {
1376
- title: "<value>",
1377
- type: "OTHER",
1378
- },
1379
- connectionId: "<id>",
1380
- id: "<id>",
1381
- });
1382
- if (res.ok) {
1383
- const { value: result } = res;
1384
- console.log(result);
1385
- } else {
1386
- console.log("kmsUpdateKmsPage failed:", res.error);
1387
- }
1388
- }
1389
-
1390
- run();
1391
- ```
1392
-
1393
- ### Parameters
1394
-
1395
- | Parameter | Type | Required | Description |
1396
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1397
- | `request` | [operations.UpdateKmsPageRequest](../../sdk/models/operations/updatekmspagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1398
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1399
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1400
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1401
-
1402
- ### Response
1403
-
1404
- **Promise\<[shared.KmsPage](../../sdk/models/shared/kmspage.md)\>**
1405
-
1406
- ### Errors
1407
-
1408
- | Error Type | Status Code | Content Type |
1409
- | --------------- | --------------- | --------------- |
1410
- | errors.SDKError | 4XX, 5XX | \*/\* |
1411
-
1412
- ## updateKmsSpace
1413
-
1414
- Update a space
1415
-
1416
- ### Example Usage
1417
-
1418
- <!-- UsageSnippet language="typescript" operationID="updateKmsSpace" method="put" path="/kms/{connection_id}/space/{id}" -->
1419
- ```typescript
1420
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1421
-
1422
- const unifiedTo = new UnifiedTo({
1423
- security: {
1424
- jwt: "<YOUR_API_KEY_HERE>",
1425
- },
1426
- });
1427
-
1428
- async function run() {
1429
- const result = await unifiedTo.kms.updateKmsSpace({
1430
- kmsSpace: {
1431
- name: "<value>",
1432
- },
1433
- connectionId: "<id>",
1434
- id: "<id>",
1435
- });
1436
-
1437
- console.log(result);
1438
- }
1439
-
1440
- run();
1441
- ```
1442
-
1443
- ### Standalone function
1444
-
1445
- The standalone function version of this method:
1446
-
1447
- ```typescript
1448
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1449
- import { kmsUpdateKmsSpace } from "@unified-api/typescript-sdk/funcs/kmsUpdateKmsSpace.js";
1450
-
1451
- // Use `UnifiedToCore` for best tree-shaking performance.
1452
- // You can create one instance of it to use across an application.
1453
- const unifiedTo = new UnifiedToCore({
1454
- security: {
1455
- jwt: "<YOUR_API_KEY_HERE>",
1456
- },
1457
- });
1458
-
1459
- async function run() {
1460
- const res = await kmsUpdateKmsSpace(unifiedTo, {
1461
- kmsSpace: {
1462
- name: "<value>",
1463
- },
1464
- connectionId: "<id>",
1465
- id: "<id>",
1466
- });
1467
- if (res.ok) {
1468
- const { value: result } = res;
1469
- console.log(result);
1470
- } else {
1471
- console.log("kmsUpdateKmsSpace failed:", res.error);
1472
- }
1473
- }
1474
-
1475
- run();
1476
- ```
1477
-
1478
- ### Parameters
1479
-
1480
- | Parameter | Type | Required | Description |
1481
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1482
- | `request` | [operations.UpdateKmsSpaceRequest](../../sdk/models/operations/updatekmsspacerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1483
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1484
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1485
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1486
-
1487
- ### Response
1488
-
1489
- **Promise\<[shared.KmsSpace](../../sdk/models/shared/kmsspace.md)\>**
1490
-
1491
- ### Errors
1492
-
1493
- | Error Type | Status Code | Content Type |
1494
- | --------------- | --------------- | --------------- |
1495
- | errors.SDKError | 4XX, 5XX | \*/\* |