@unified-api/typescript-sdk 2.9.21 → 2.9.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +1 -1
- package/README.md +20 -8
- package/docs/sdks/account/README.md +12 -12
- package/docs/sdks/accounting/README.md +76 -76
- package/docs/sdks/activity/README.md +12 -12
- package/docs/sdks/application/README.md +12 -12
- package/docs/sdks/applicationstatus/README.md +2 -2
- package/docs/sdks/ats/README.md +90 -90
- package/docs/sdks/auth/README.md +4 -4
- package/docs/sdks/call/README.md +2 -2
- package/docs/sdks/candidate/README.md +12 -12
- package/docs/sdks/channel/README.md +4 -4
- package/docs/sdks/collection/README.md +12 -12
- package/docs/sdks/comment/README.md +494 -0
- package/docs/sdks/commerce/README.md +48 -48
- package/docs/sdks/company/README.md +30 -30
- package/docs/sdks/contact/README.md +36 -36
- package/docs/sdks/crm/README.md +72 -72
- package/docs/sdks/customer/README.md +12 -12
- package/docs/sdks/deal/README.md +12 -12
- package/docs/sdks/document/README.md +12 -12
- package/docs/sdks/employee/README.md +12 -12
- package/docs/sdks/enrich/README.md +4 -4
- package/docs/sdks/event/README.md +12 -12
- package/docs/sdks/file/README.md +12 -12
- package/docs/sdks/genai/README.md +4 -4
- package/docs/sdks/group/README.md +12 -12
- package/docs/sdks/hris/README.md +56 -56
- package/docs/sdks/integration/README.md +4 -4
- package/docs/sdks/interview/README.md +12 -12
- package/docs/sdks/inventory/README.md +12 -12
- package/docs/sdks/invoice/README.md +12 -12
- package/docs/sdks/item/README.md +12 -12
- package/docs/sdks/job/README.md +12 -12
- package/docs/sdks/journal/README.md +12 -12
- package/docs/sdks/kms/README.md +518 -24
- package/docs/sdks/lead/README.md +12 -12
- package/docs/sdks/link/README.md +12 -12
- package/docs/sdks/list/README.md +12 -12
- package/docs/sdks/location/README.md +24 -24
- package/docs/sdks/login/README.md +2 -2
- package/docs/sdks/martech/README.md +24 -24
- package/docs/sdks/member/README.md +12 -12
- package/docs/sdks/message/README.md +12 -12
- package/docs/sdks/messaging/README.md +16 -16
- package/docs/sdks/model/README.md +2 -2
- package/docs/sdks/note/README.md +12 -12
- package/docs/sdks/organization/README.md +4 -4
- package/docs/sdks/page/README.md +12 -12
- package/docs/sdks/passthrough/README.md +28 -28
- package/docs/sdks/payment/README.md +32 -32
- package/docs/sdks/payout/README.md +4 -4
- package/docs/sdks/payslip/README.md +4 -4
- package/docs/sdks/person/README.md +2 -2
- package/docs/sdks/pipeline/README.md +12 -12
- package/docs/sdks/project/README.md +12 -12
- package/docs/sdks/prompt/README.md +2 -2
- package/docs/sdks/refund/README.md +4 -4
- package/docs/sdks/scorecard/README.md +12 -12
- package/docs/sdks/space/README.md +12 -12
- package/docs/sdks/storage/README.md +12 -12
- package/docs/sdks/task/README.md +24 -24
- package/docs/sdks/taxrate/README.md +12 -12
- package/docs/sdks/ticket/README.md +12 -12
- package/docs/sdks/ticketing/README.md +36 -36
- package/docs/sdks/timeoff/README.md +4 -4
- package/docs/sdks/transaction/README.md +12 -12
- package/docs/sdks/uc/README.md +14 -14
- package/docs/sdks/unified/README.md +4 -4
- package/funcs/commentCreateKmsComment.d.ts +13 -0
- package/funcs/commentCreateKmsComment.d.ts.map +1 -0
- package/funcs/commentCreateKmsComment.js +104 -0
- package/funcs/commentCreateKmsComment.js.map +1 -0
- package/funcs/commentGetKmsComment.d.ts +13 -0
- package/funcs/commentGetKmsComment.d.ts.map +1 -0
- package/funcs/commentGetKmsComment.js +107 -0
- package/funcs/commentGetKmsComment.js.map +1 -0
- package/funcs/commentListKmsComments.d.ts +13 -0
- package/funcs/commentListKmsComments.d.ts.map +1 -0
- package/funcs/commentListKmsComments.js +113 -0
- package/funcs/commentListKmsComments.js.map +1 -0
- package/funcs/commentPatchKmsComment.d.ts +13 -0
- package/funcs/commentPatchKmsComment.d.ts.map +1 -0
- package/funcs/commentPatchKmsComment.js +108 -0
- package/funcs/commentPatchKmsComment.js.map +1 -0
- package/funcs/commentRemoveKmsComment.d.ts +12 -0
- package/funcs/commentRemoveKmsComment.d.ts.map +1 -0
- package/funcs/commentRemoveKmsComment.js +105 -0
- package/funcs/commentRemoveKmsComment.js.map +1 -0
- package/funcs/commentUpdateKmsComment.d.ts +13 -0
- package/funcs/commentUpdateKmsComment.d.ts.map +1 -0
- package/funcs/commentUpdateKmsComment.js +108 -0
- package/funcs/commentUpdateKmsComment.js.map +1 -0
- package/funcs/kmsCreateKmsComment.d.ts +13 -0
- package/funcs/kmsCreateKmsComment.d.ts.map +1 -0
- package/funcs/kmsCreateKmsComment.js +104 -0
- package/funcs/kmsCreateKmsComment.js.map +1 -0
- package/funcs/kmsGetKmsComment.d.ts +13 -0
- package/funcs/kmsGetKmsComment.d.ts.map +1 -0
- package/funcs/kmsGetKmsComment.js +107 -0
- package/funcs/kmsGetKmsComment.js.map +1 -0
- package/funcs/kmsListKmsComments.d.ts +13 -0
- package/funcs/kmsListKmsComments.d.ts.map +1 -0
- package/funcs/kmsListKmsComments.js +113 -0
- package/funcs/kmsListKmsComments.js.map +1 -0
- package/funcs/kmsPatchKmsComment.d.ts +13 -0
- package/funcs/kmsPatchKmsComment.d.ts.map +1 -0
- package/funcs/kmsPatchKmsComment.js +108 -0
- package/funcs/kmsPatchKmsComment.js.map +1 -0
- package/funcs/kmsRemoveKmsComment.d.ts +12 -0
- package/funcs/kmsRemoveKmsComment.d.ts.map +1 -0
- package/funcs/kmsRemoveKmsComment.js +105 -0
- package/funcs/kmsRemoveKmsComment.js.map +1 -0
- package/funcs/kmsUpdateKmsComment.d.ts +13 -0
- package/funcs/kmsUpdateKmsComment.d.ts.map +1 -0
- package/funcs/kmsUpdateKmsComment.js +108 -0
- package/funcs/kmsUpdateKmsComment.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/schemas.d.ts +1 -1
- package/lib/schemas.d.ts.map +1 -1
- package/lib/schemas.js +4 -1
- package/lib/schemas.js.map +1 -1
- package/package.json +1 -1
- package/sdk/comment.d.ts +24 -0
- package/sdk/comment.d.ts.map +1 -1
- package/sdk/comment.js +42 -0
- package/sdk/comment.js.map +1 -1
- package/sdk/kms.d.ts +24 -0
- package/sdk/kms.d.ts.map +1 -1
- package/sdk/kms.js +42 -0
- package/sdk/kms.js.map +1 -1
- package/sdk/models/operations/createkmscomment.d.ts +40 -0
- package/sdk/models/operations/createkmscomment.d.ts.map +1 -0
- package/sdk/models/operations/createkmscomment.js +75 -0
- package/sdk/models/operations/createkmscomment.js.map +1 -0
- package/sdk/models/operations/getkmscomment.d.ts +42 -0
- package/sdk/models/operations/getkmscomment.d.ts.map +1 -0
- package/sdk/models/operations/getkmscomment.js +72 -0
- package/sdk/models/operations/getkmscomment.js.map +1 -0
- package/sdk/models/operations/index.d.ts +6 -0
- package/sdk/models/operations/index.d.ts.map +1 -1
- package/sdk/models/operations/index.js +6 -0
- package/sdk/models/operations/index.js.map +1 -1
- package/sdk/models/operations/listkmscomments.d.ts +61 -0
- package/sdk/models/operations/listkmscomments.d.ts.map +1 -0
- package/sdk/models/operations/listkmscomments.js +95 -0
- package/sdk/models/operations/listkmscomments.js.map +1 -0
- package/sdk/models/operations/patchkmscomment.d.ts +45 -0
- package/sdk/models/operations/patchkmscomment.d.ts.map +1 -0
- package/sdk/models/operations/patchkmscomment.js +77 -0
- package/sdk/models/operations/patchkmscomment.js.map +1 -0
- package/sdk/models/operations/removekmscomment.d.ts +66 -0
- package/sdk/models/operations/removekmscomment.d.ts.map +1 -0
- package/sdk/models/operations/removekmscomment.js +105 -0
- package/sdk/models/operations/removekmscomment.js.map +1 -0
- package/sdk/models/operations/updatekmscomment.d.ts +45 -0
- package/sdk/models/operations/updatekmscomment.d.ts.map +1 -0
- package/sdk/models/operations/updatekmscomment.js +77 -0
- package/sdk/models/operations/updatekmscomment.js.map +1 -0
- package/sdk/models/shared/index.d.ts +1 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +1 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/integrationsupport.d.ts +32 -0
- package/sdk/models/shared/integrationsupport.d.ts.map +1 -1
- package/sdk/models/shared/integrationsupport.js +34 -5
- package/sdk/models/shared/integrationsupport.js.map +1 -1
- package/sdk/models/shared/kmscomment.d.ts +105 -0
- package/sdk/models/shared/kmscomment.d.ts.map +1 -0
- package/sdk/models/shared/kmscomment.js +138 -0
- package/sdk/models/shared/kmscomment.js.map +1 -0
- package/sdk/models/shared/kmspagemetadata.d.ts +2 -6
- package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -1
- package/sdk/models/shared/kmspagemetadata.js +2 -2
- package/sdk/models/shared/kmspagemetadata.js.map +1 -1
- package/sdk/models/shared/repoorganization.d.ts +5 -0
- package/sdk/models/shared/repoorganization.d.ts.map +1 -1
- package/sdk/models/shared/repoorganization.js +4 -0
- package/sdk/models/shared/repoorganization.js.map +1 -1
- package/sdk/models/shared/webhook.d.ts +3 -0
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +1 -0
- package/sdk/models/shared/webhook.js.map +1 -1
- package/sdk/sdk.d.ts +2 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +3 -3
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/commentCreateKmsComment.ts +135 -0
- package/src/funcs/commentGetKmsComment.ts +138 -0
- package/src/funcs/commentListKmsComments.ts +144 -0
- package/src/funcs/commentPatchKmsComment.ts +139 -0
- package/src/funcs/commentRemoveKmsComment.ts +141 -0
- package/src/funcs/commentUpdateKmsComment.ts +139 -0
- package/src/funcs/kmsCreateKmsComment.ts +135 -0
- package/src/funcs/kmsGetKmsComment.ts +138 -0
- package/src/funcs/kmsListKmsComments.ts +144 -0
- package/src/funcs/kmsPatchKmsComment.ts +139 -0
- package/src/funcs/kmsRemoveKmsComment.ts +141 -0
- package/src/funcs/kmsUpdateKmsComment.ts +139 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/schemas.ts +5 -0
- package/src/sdk/comment.ts +90 -0
- package/src/sdk/kms.ts +90 -0
- package/src/sdk/models/operations/createkmscomment.ts +92 -0
- package/src/sdk/models/operations/getkmscomment.ts +92 -0
- package/src/sdk/models/operations/index.ts +6 -0
- package/src/sdk/models/operations/listkmscomments.ts +134 -0
- package/src/sdk/models/operations/patchkmscomment.ts +99 -0
- package/src/sdk/models/operations/removekmscomment.ts +151 -0
- package/src/sdk/models/operations/updatekmscomment.ts +99 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/models/shared/integrationsupport.ts +38 -0
- package/src/sdk/models/shared/kmscomment.ts +173 -0
- package/src/sdk/models/shared/kmspagemetadata.ts +4 -4
- package/src/sdk/models/shared/repoorganization.ts +9 -0
- package/src/sdk/models/shared/webhook.ts +1 -0
- package/src/sdk/sdk.ts +5 -5
package/docs/sdks/kms/README.md
CHANGED
|
@@ -5,19 +5,105 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [createKmsComment](#createkmscomment) - Create a comment
|
|
8
9
|
* [createKmsPage](#createkmspage) - Create a page
|
|
9
10
|
* [createKmsSpace](#createkmsspace) - Create a space
|
|
11
|
+
* [getKmsComment](#getkmscomment) - Retrieve a comment
|
|
10
12
|
* [getKmsPage](#getkmspage) - Retrieve a page
|
|
11
13
|
* [getKmsSpace](#getkmsspace) - Retrieve a space
|
|
14
|
+
* [listKmsComments](#listkmscomments) - List all comments
|
|
12
15
|
* [listKmsPages](#listkmspages) - List all pages
|
|
13
16
|
* [listKmsSpaces](#listkmsspaces) - List all spaces
|
|
17
|
+
* [patchKmsComment](#patchkmscomment) - Update a comment
|
|
14
18
|
* [patchKmsPage](#patchkmspage) - Update a page
|
|
15
19
|
* [patchKmsSpace](#patchkmsspace) - Update a space
|
|
20
|
+
* [removeKmsComment](#removekmscomment) - Remove a comment
|
|
16
21
|
* [removeKmsPage](#removekmspage) - Remove a page
|
|
17
22
|
* [removeKmsSpace](#removekmsspace) - Remove a space
|
|
23
|
+
* [updateKmsComment](#updatekmscomment) - Update a comment
|
|
18
24
|
* [updateKmsPage](#updatekmspage) - Update a page
|
|
19
25
|
* [updateKmsSpace](#updatekmsspace) - Update a space
|
|
20
26
|
|
|
27
|
+
## createKmsComment
|
|
28
|
+
|
|
29
|
+
Create a comment
|
|
30
|
+
|
|
31
|
+
### Example Usage
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
35
|
+
|
|
36
|
+
const unifiedTo = new UnifiedTo({
|
|
37
|
+
security: {
|
|
38
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
39
|
+
},
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
async function run() {
|
|
43
|
+
const result = await unifiedTo.kms.createKmsComment({
|
|
44
|
+
connectionId: "<id>",
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
// Handle the result
|
|
48
|
+
console.log(result);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
run();
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Standalone function
|
|
55
|
+
|
|
56
|
+
The standalone function version of this method:
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
60
|
+
import { kmsCreateKmsComment } from "@unified-api/typescript-sdk/funcs/kmsCreateKmsComment.js";
|
|
61
|
+
|
|
62
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
63
|
+
// You can create one instance of it to use across an application.
|
|
64
|
+
const unifiedTo = new UnifiedToCore({
|
|
65
|
+
security: {
|
|
66
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
67
|
+
},
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
async function run() {
|
|
71
|
+
const res = await kmsCreateKmsComment(unifiedTo, {
|
|
72
|
+
connectionId: "<id>",
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
if (!res.ok) {
|
|
76
|
+
throw res.error;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
const { value: result } = res;
|
|
80
|
+
|
|
81
|
+
// Handle the result
|
|
82
|
+
console.log(result);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
run();
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
| Parameter | Type | Required | Description |
|
|
91
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
92
|
+
| `request` | [operations.CreateKmsCommentRequest](../../sdk/models/operations/createkmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
93
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
94
|
+
| `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. |
|
|
95
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
96
|
+
|
|
97
|
+
### Response
|
|
98
|
+
|
|
99
|
+
**Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
|
|
100
|
+
|
|
101
|
+
### Errors
|
|
102
|
+
|
|
103
|
+
| Error Type | Status Code | Content Type |
|
|
104
|
+
| --------------- | --------------- | --------------- |
|
|
105
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
106
|
+
|
|
21
107
|
## createKmsPage
|
|
22
108
|
|
|
23
109
|
Create a page
|
|
@@ -35,7 +121,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
35
121
|
|
|
36
122
|
async function run() {
|
|
37
123
|
const result = await unifiedTo.kms.createKmsPage({
|
|
38
|
-
connectionId: "<
|
|
124
|
+
connectionId: "<id>",
|
|
39
125
|
});
|
|
40
126
|
|
|
41
127
|
// Handle the result
|
|
@@ -63,7 +149,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
63
149
|
|
|
64
150
|
async function run() {
|
|
65
151
|
const res = await kmsCreateKmsPage(unifiedTo, {
|
|
66
|
-
connectionId: "<
|
|
152
|
+
connectionId: "<id>",
|
|
67
153
|
});
|
|
68
154
|
|
|
69
155
|
if (!res.ok) {
|
|
@@ -115,7 +201,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
115
201
|
|
|
116
202
|
async function run() {
|
|
117
203
|
const result = await unifiedTo.kms.createKmsSpace({
|
|
118
|
-
connectionId: "<
|
|
204
|
+
connectionId: "<id>",
|
|
119
205
|
});
|
|
120
206
|
|
|
121
207
|
// Handle the result
|
|
@@ -143,7 +229,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
143
229
|
|
|
144
230
|
async function run() {
|
|
145
231
|
const res = await kmsCreateKmsSpace(unifiedTo, {
|
|
146
|
-
connectionId: "<
|
|
232
|
+
connectionId: "<id>",
|
|
147
233
|
});
|
|
148
234
|
|
|
149
235
|
if (!res.ok) {
|
|
@@ -178,6 +264,88 @@ run();
|
|
|
178
264
|
| --------------- | --------------- | --------------- |
|
|
179
265
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
180
266
|
|
|
267
|
+
## getKmsComment
|
|
268
|
+
|
|
269
|
+
Retrieve a comment
|
|
270
|
+
|
|
271
|
+
### Example Usage
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
275
|
+
|
|
276
|
+
const unifiedTo = new UnifiedTo({
|
|
277
|
+
security: {
|
|
278
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
279
|
+
},
|
|
280
|
+
});
|
|
281
|
+
|
|
282
|
+
async function run() {
|
|
283
|
+
const result = await unifiedTo.kms.getKmsComment({
|
|
284
|
+
connectionId: "<id>",
|
|
285
|
+
id: "<id>",
|
|
286
|
+
});
|
|
287
|
+
|
|
288
|
+
// Handle the result
|
|
289
|
+
console.log(result);
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
run();
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Standalone function
|
|
296
|
+
|
|
297
|
+
The standalone function version of this method:
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
301
|
+
import { kmsGetKmsComment } from "@unified-api/typescript-sdk/funcs/kmsGetKmsComment.js";
|
|
302
|
+
|
|
303
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
304
|
+
// You can create one instance of it to use across an application.
|
|
305
|
+
const unifiedTo = new UnifiedToCore({
|
|
306
|
+
security: {
|
|
307
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
308
|
+
},
|
|
309
|
+
});
|
|
310
|
+
|
|
311
|
+
async function run() {
|
|
312
|
+
const res = await kmsGetKmsComment(unifiedTo, {
|
|
313
|
+
connectionId: "<id>",
|
|
314
|
+
id: "<id>",
|
|
315
|
+
});
|
|
316
|
+
|
|
317
|
+
if (!res.ok) {
|
|
318
|
+
throw res.error;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
const { value: result } = res;
|
|
322
|
+
|
|
323
|
+
// Handle the result
|
|
324
|
+
console.log(result);
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
run();
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Parameters
|
|
331
|
+
|
|
332
|
+
| Parameter | Type | Required | Description |
|
|
333
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
334
|
+
| `request` | [operations.GetKmsCommentRequest](../../sdk/models/operations/getkmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
335
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
336
|
+
| `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. |
|
|
337
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
338
|
+
|
|
339
|
+
### Response
|
|
340
|
+
|
|
341
|
+
**Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
|
|
342
|
+
|
|
343
|
+
### Errors
|
|
344
|
+
|
|
345
|
+
| Error Type | Status Code | Content Type |
|
|
346
|
+
| --------------- | --------------- | --------------- |
|
|
347
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
348
|
+
|
|
181
349
|
## getKmsPage
|
|
182
350
|
|
|
183
351
|
Retrieve a page
|
|
@@ -195,7 +363,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
195
363
|
|
|
196
364
|
async function run() {
|
|
197
365
|
const result = await unifiedTo.kms.getKmsPage({
|
|
198
|
-
connectionId: "<
|
|
366
|
+
connectionId: "<id>",
|
|
199
367
|
id: "<id>",
|
|
200
368
|
});
|
|
201
369
|
|
|
@@ -224,7 +392,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
224
392
|
|
|
225
393
|
async function run() {
|
|
226
394
|
const res = await kmsGetKmsPage(unifiedTo, {
|
|
227
|
-
connectionId: "<
|
|
395
|
+
connectionId: "<id>",
|
|
228
396
|
id: "<id>",
|
|
229
397
|
});
|
|
230
398
|
|
|
@@ -277,7 +445,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
277
445
|
|
|
278
446
|
async function run() {
|
|
279
447
|
const result = await unifiedTo.kms.getKmsSpace({
|
|
280
|
-
connectionId: "<
|
|
448
|
+
connectionId: "<id>",
|
|
281
449
|
id: "<id>",
|
|
282
450
|
});
|
|
283
451
|
|
|
@@ -306,7 +474,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
306
474
|
|
|
307
475
|
async function run() {
|
|
308
476
|
const res = await kmsGetKmsSpace(unifiedTo, {
|
|
309
|
-
connectionId: "<
|
|
477
|
+
connectionId: "<id>",
|
|
310
478
|
id: "<id>",
|
|
311
479
|
});
|
|
312
480
|
|
|
@@ -342,6 +510,86 @@ run();
|
|
|
342
510
|
| --------------- | --------------- | --------------- |
|
|
343
511
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
344
512
|
|
|
513
|
+
## listKmsComments
|
|
514
|
+
|
|
515
|
+
List all comments
|
|
516
|
+
|
|
517
|
+
### Example Usage
|
|
518
|
+
|
|
519
|
+
```typescript
|
|
520
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
521
|
+
|
|
522
|
+
const unifiedTo = new UnifiedTo({
|
|
523
|
+
security: {
|
|
524
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
525
|
+
},
|
|
526
|
+
});
|
|
527
|
+
|
|
528
|
+
async function run() {
|
|
529
|
+
const result = await unifiedTo.kms.listKmsComments({
|
|
530
|
+
connectionId: "<id>",
|
|
531
|
+
});
|
|
532
|
+
|
|
533
|
+
// Handle the result
|
|
534
|
+
console.log(result);
|
|
535
|
+
}
|
|
536
|
+
|
|
537
|
+
run();
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
### Standalone function
|
|
541
|
+
|
|
542
|
+
The standalone function version of this method:
|
|
543
|
+
|
|
544
|
+
```typescript
|
|
545
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
546
|
+
import { kmsListKmsComments } from "@unified-api/typescript-sdk/funcs/kmsListKmsComments.js";
|
|
547
|
+
|
|
548
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
549
|
+
// You can create one instance of it to use across an application.
|
|
550
|
+
const unifiedTo = new UnifiedToCore({
|
|
551
|
+
security: {
|
|
552
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
553
|
+
},
|
|
554
|
+
});
|
|
555
|
+
|
|
556
|
+
async function run() {
|
|
557
|
+
const res = await kmsListKmsComments(unifiedTo, {
|
|
558
|
+
connectionId: "<id>",
|
|
559
|
+
});
|
|
560
|
+
|
|
561
|
+
if (!res.ok) {
|
|
562
|
+
throw res.error;
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
const { value: result } = res;
|
|
566
|
+
|
|
567
|
+
// Handle the result
|
|
568
|
+
console.log(result);
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
run();
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
### Parameters
|
|
575
|
+
|
|
576
|
+
| Parameter | Type | Required | Description |
|
|
577
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
578
|
+
| `request` | [operations.ListKmsCommentsRequest](../../sdk/models/operations/listkmscommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
579
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
580
|
+
| `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. |
|
|
581
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
582
|
+
|
|
583
|
+
### Response
|
|
584
|
+
|
|
585
|
+
**Promise\<[shared.KmsComment[]](../../models/.md)\>**
|
|
586
|
+
|
|
587
|
+
### Errors
|
|
588
|
+
|
|
589
|
+
| Error Type | Status Code | Content Type |
|
|
590
|
+
| --------------- | --------------- | --------------- |
|
|
591
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
592
|
+
|
|
345
593
|
## listKmsPages
|
|
346
594
|
|
|
347
595
|
List all pages
|
|
@@ -359,7 +607,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
359
607
|
|
|
360
608
|
async function run() {
|
|
361
609
|
const result = await unifiedTo.kms.listKmsPages({
|
|
362
|
-
connectionId: "<
|
|
610
|
+
connectionId: "<id>",
|
|
363
611
|
});
|
|
364
612
|
|
|
365
613
|
// Handle the result
|
|
@@ -387,7 +635,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
387
635
|
|
|
388
636
|
async function run() {
|
|
389
637
|
const res = await kmsListKmsPages(unifiedTo, {
|
|
390
|
-
connectionId: "<
|
|
638
|
+
connectionId: "<id>",
|
|
391
639
|
});
|
|
392
640
|
|
|
393
641
|
if (!res.ok) {
|
|
@@ -439,7 +687,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
439
687
|
|
|
440
688
|
async function run() {
|
|
441
689
|
const result = await unifiedTo.kms.listKmsSpaces({
|
|
442
|
-
connectionId: "<
|
|
690
|
+
connectionId: "<id>",
|
|
443
691
|
});
|
|
444
692
|
|
|
445
693
|
// Handle the result
|
|
@@ -467,7 +715,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
467
715
|
|
|
468
716
|
async function run() {
|
|
469
717
|
const res = await kmsListKmsSpaces(unifiedTo, {
|
|
470
|
-
connectionId: "<
|
|
718
|
+
connectionId: "<id>",
|
|
471
719
|
});
|
|
472
720
|
|
|
473
721
|
if (!res.ok) {
|
|
@@ -502,6 +750,88 @@ run();
|
|
|
502
750
|
| --------------- | --------------- | --------------- |
|
|
503
751
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
504
752
|
|
|
753
|
+
## patchKmsComment
|
|
754
|
+
|
|
755
|
+
Update a comment
|
|
756
|
+
|
|
757
|
+
### Example Usage
|
|
758
|
+
|
|
759
|
+
```typescript
|
|
760
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
761
|
+
|
|
762
|
+
const unifiedTo = new UnifiedTo({
|
|
763
|
+
security: {
|
|
764
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
765
|
+
},
|
|
766
|
+
});
|
|
767
|
+
|
|
768
|
+
async function run() {
|
|
769
|
+
const result = await unifiedTo.kms.patchKmsComment({
|
|
770
|
+
connectionId: "<id>",
|
|
771
|
+
id: "<id>",
|
|
772
|
+
});
|
|
773
|
+
|
|
774
|
+
// Handle the result
|
|
775
|
+
console.log(result);
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
run();
|
|
779
|
+
```
|
|
780
|
+
|
|
781
|
+
### Standalone function
|
|
782
|
+
|
|
783
|
+
The standalone function version of this method:
|
|
784
|
+
|
|
785
|
+
```typescript
|
|
786
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
787
|
+
import { kmsPatchKmsComment } from "@unified-api/typescript-sdk/funcs/kmsPatchKmsComment.js";
|
|
788
|
+
|
|
789
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
790
|
+
// You can create one instance of it to use across an application.
|
|
791
|
+
const unifiedTo = new UnifiedToCore({
|
|
792
|
+
security: {
|
|
793
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
794
|
+
},
|
|
795
|
+
});
|
|
796
|
+
|
|
797
|
+
async function run() {
|
|
798
|
+
const res = await kmsPatchKmsComment(unifiedTo, {
|
|
799
|
+
connectionId: "<id>",
|
|
800
|
+
id: "<id>",
|
|
801
|
+
});
|
|
802
|
+
|
|
803
|
+
if (!res.ok) {
|
|
804
|
+
throw res.error;
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
const { value: result } = res;
|
|
808
|
+
|
|
809
|
+
// Handle the result
|
|
810
|
+
console.log(result);
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
run();
|
|
814
|
+
```
|
|
815
|
+
|
|
816
|
+
### Parameters
|
|
817
|
+
|
|
818
|
+
| Parameter | Type | Required | Description |
|
|
819
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
820
|
+
| `request` | [operations.PatchKmsCommentRequest](../../sdk/models/operations/patchkmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
821
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
822
|
+
| `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. |
|
|
823
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
824
|
+
|
|
825
|
+
### Response
|
|
826
|
+
|
|
827
|
+
**Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
|
|
828
|
+
|
|
829
|
+
### Errors
|
|
830
|
+
|
|
831
|
+
| Error Type | Status Code | Content Type |
|
|
832
|
+
| --------------- | --------------- | --------------- |
|
|
833
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
834
|
+
|
|
505
835
|
## patchKmsPage
|
|
506
836
|
|
|
507
837
|
Update a page
|
|
@@ -519,7 +849,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
519
849
|
|
|
520
850
|
async function run() {
|
|
521
851
|
const result = await unifiedTo.kms.patchKmsPage({
|
|
522
|
-
connectionId: "<
|
|
852
|
+
connectionId: "<id>",
|
|
523
853
|
id: "<id>",
|
|
524
854
|
});
|
|
525
855
|
|
|
@@ -548,7 +878,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
548
878
|
|
|
549
879
|
async function run() {
|
|
550
880
|
const res = await kmsPatchKmsPage(unifiedTo, {
|
|
551
|
-
connectionId: "<
|
|
881
|
+
connectionId: "<id>",
|
|
552
882
|
id: "<id>",
|
|
553
883
|
});
|
|
554
884
|
|
|
@@ -601,7 +931,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
601
931
|
|
|
602
932
|
async function run() {
|
|
603
933
|
const result = await unifiedTo.kms.patchKmsSpace({
|
|
604
|
-
connectionId: "<
|
|
934
|
+
connectionId: "<id>",
|
|
605
935
|
id: "<id>",
|
|
606
936
|
});
|
|
607
937
|
|
|
@@ -630,7 +960,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
630
960
|
|
|
631
961
|
async function run() {
|
|
632
962
|
const res = await kmsPatchKmsSpace(unifiedTo, {
|
|
633
|
-
connectionId: "<
|
|
963
|
+
connectionId: "<id>",
|
|
634
964
|
id: "<id>",
|
|
635
965
|
});
|
|
636
966
|
|
|
@@ -666,6 +996,88 @@ run();
|
|
|
666
996
|
| --------------- | --------------- | --------------- |
|
|
667
997
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
668
998
|
|
|
999
|
+
## removeKmsComment
|
|
1000
|
+
|
|
1001
|
+
Remove a comment
|
|
1002
|
+
|
|
1003
|
+
### Example Usage
|
|
1004
|
+
|
|
1005
|
+
```typescript
|
|
1006
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1007
|
+
|
|
1008
|
+
const unifiedTo = new UnifiedTo({
|
|
1009
|
+
security: {
|
|
1010
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1011
|
+
},
|
|
1012
|
+
});
|
|
1013
|
+
|
|
1014
|
+
async function run() {
|
|
1015
|
+
const result = await unifiedTo.kms.removeKmsComment({
|
|
1016
|
+
connectionId: "<id>",
|
|
1017
|
+
id: "<id>",
|
|
1018
|
+
});
|
|
1019
|
+
|
|
1020
|
+
// Handle the result
|
|
1021
|
+
console.log(result);
|
|
1022
|
+
}
|
|
1023
|
+
|
|
1024
|
+
run();
|
|
1025
|
+
```
|
|
1026
|
+
|
|
1027
|
+
### Standalone function
|
|
1028
|
+
|
|
1029
|
+
The standalone function version of this method:
|
|
1030
|
+
|
|
1031
|
+
```typescript
|
|
1032
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1033
|
+
import { kmsRemoveKmsComment } from "@unified-api/typescript-sdk/funcs/kmsRemoveKmsComment.js";
|
|
1034
|
+
|
|
1035
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1036
|
+
// You can create one instance of it to use across an application.
|
|
1037
|
+
const unifiedTo = new UnifiedToCore({
|
|
1038
|
+
security: {
|
|
1039
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1040
|
+
},
|
|
1041
|
+
});
|
|
1042
|
+
|
|
1043
|
+
async function run() {
|
|
1044
|
+
const res = await kmsRemoveKmsComment(unifiedTo, {
|
|
1045
|
+
connectionId: "<id>",
|
|
1046
|
+
id: "<id>",
|
|
1047
|
+
});
|
|
1048
|
+
|
|
1049
|
+
if (!res.ok) {
|
|
1050
|
+
throw res.error;
|
|
1051
|
+
}
|
|
1052
|
+
|
|
1053
|
+
const { value: result } = res;
|
|
1054
|
+
|
|
1055
|
+
// Handle the result
|
|
1056
|
+
console.log(result);
|
|
1057
|
+
}
|
|
1058
|
+
|
|
1059
|
+
run();
|
|
1060
|
+
```
|
|
1061
|
+
|
|
1062
|
+
### Parameters
|
|
1063
|
+
|
|
1064
|
+
| Parameter | Type | Required | Description |
|
|
1065
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1066
|
+
| `request` | [operations.RemoveKmsCommentRequest](../../sdk/models/operations/removekmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1067
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1068
|
+
| `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. |
|
|
1069
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1070
|
+
|
|
1071
|
+
### Response
|
|
1072
|
+
|
|
1073
|
+
**Promise\<[operations.RemoveKmsCommentResponse](../../sdk/models/operations/removekmscommentresponse.md)\>**
|
|
1074
|
+
|
|
1075
|
+
### Errors
|
|
1076
|
+
|
|
1077
|
+
| Error Type | Status Code | Content Type |
|
|
1078
|
+
| --------------- | --------------- | --------------- |
|
|
1079
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1080
|
+
|
|
669
1081
|
## removeKmsPage
|
|
670
1082
|
|
|
671
1083
|
Remove a page
|
|
@@ -683,7 +1095,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
683
1095
|
|
|
684
1096
|
async function run() {
|
|
685
1097
|
const result = await unifiedTo.kms.removeKmsPage({
|
|
686
|
-
connectionId: "<
|
|
1098
|
+
connectionId: "<id>",
|
|
687
1099
|
id: "<id>",
|
|
688
1100
|
});
|
|
689
1101
|
|
|
@@ -712,7 +1124,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
712
1124
|
|
|
713
1125
|
async function run() {
|
|
714
1126
|
const res = await kmsRemoveKmsPage(unifiedTo, {
|
|
715
|
-
connectionId: "<
|
|
1127
|
+
connectionId: "<id>",
|
|
716
1128
|
id: "<id>",
|
|
717
1129
|
});
|
|
718
1130
|
|
|
@@ -765,7 +1177,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
765
1177
|
|
|
766
1178
|
async function run() {
|
|
767
1179
|
const result = await unifiedTo.kms.removeKmsSpace({
|
|
768
|
-
connectionId: "<
|
|
1180
|
+
connectionId: "<id>",
|
|
769
1181
|
id: "<id>",
|
|
770
1182
|
});
|
|
771
1183
|
|
|
@@ -794,7 +1206,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
794
1206
|
|
|
795
1207
|
async function run() {
|
|
796
1208
|
const res = await kmsRemoveKmsSpace(unifiedTo, {
|
|
797
|
-
connectionId: "<
|
|
1209
|
+
connectionId: "<id>",
|
|
798
1210
|
id: "<id>",
|
|
799
1211
|
});
|
|
800
1212
|
|
|
@@ -830,6 +1242,88 @@ run();
|
|
|
830
1242
|
| --------------- | --------------- | --------------- |
|
|
831
1243
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
832
1244
|
|
|
1245
|
+
## updateKmsComment
|
|
1246
|
+
|
|
1247
|
+
Update a comment
|
|
1248
|
+
|
|
1249
|
+
### Example Usage
|
|
1250
|
+
|
|
1251
|
+
```typescript
|
|
1252
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1253
|
+
|
|
1254
|
+
const unifiedTo = new UnifiedTo({
|
|
1255
|
+
security: {
|
|
1256
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1257
|
+
},
|
|
1258
|
+
});
|
|
1259
|
+
|
|
1260
|
+
async function run() {
|
|
1261
|
+
const result = await unifiedTo.kms.updateKmsComment({
|
|
1262
|
+
connectionId: "<id>",
|
|
1263
|
+
id: "<id>",
|
|
1264
|
+
});
|
|
1265
|
+
|
|
1266
|
+
// Handle the result
|
|
1267
|
+
console.log(result);
|
|
1268
|
+
}
|
|
1269
|
+
|
|
1270
|
+
run();
|
|
1271
|
+
```
|
|
1272
|
+
|
|
1273
|
+
### Standalone function
|
|
1274
|
+
|
|
1275
|
+
The standalone function version of this method:
|
|
1276
|
+
|
|
1277
|
+
```typescript
|
|
1278
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1279
|
+
import { kmsUpdateKmsComment } from "@unified-api/typescript-sdk/funcs/kmsUpdateKmsComment.js";
|
|
1280
|
+
|
|
1281
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1282
|
+
// You can create one instance of it to use across an application.
|
|
1283
|
+
const unifiedTo = new UnifiedToCore({
|
|
1284
|
+
security: {
|
|
1285
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1286
|
+
},
|
|
1287
|
+
});
|
|
1288
|
+
|
|
1289
|
+
async function run() {
|
|
1290
|
+
const res = await kmsUpdateKmsComment(unifiedTo, {
|
|
1291
|
+
connectionId: "<id>",
|
|
1292
|
+
id: "<id>",
|
|
1293
|
+
});
|
|
1294
|
+
|
|
1295
|
+
if (!res.ok) {
|
|
1296
|
+
throw res.error;
|
|
1297
|
+
}
|
|
1298
|
+
|
|
1299
|
+
const { value: result } = res;
|
|
1300
|
+
|
|
1301
|
+
// Handle the result
|
|
1302
|
+
console.log(result);
|
|
1303
|
+
}
|
|
1304
|
+
|
|
1305
|
+
run();
|
|
1306
|
+
```
|
|
1307
|
+
|
|
1308
|
+
### Parameters
|
|
1309
|
+
|
|
1310
|
+
| Parameter | Type | Required | Description |
|
|
1311
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1312
|
+
| `request` | [operations.UpdateKmsCommentRequest](../../sdk/models/operations/updatekmscommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1313
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1314
|
+
| `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. |
|
|
1315
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1316
|
+
|
|
1317
|
+
### Response
|
|
1318
|
+
|
|
1319
|
+
**Promise\<[shared.KmsComment](../../sdk/models/shared/kmscomment.md)\>**
|
|
1320
|
+
|
|
1321
|
+
### Errors
|
|
1322
|
+
|
|
1323
|
+
| Error Type | Status Code | Content Type |
|
|
1324
|
+
| --------------- | --------------- | --------------- |
|
|
1325
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1326
|
+
|
|
833
1327
|
## updateKmsPage
|
|
834
1328
|
|
|
835
1329
|
Update a page
|
|
@@ -847,7 +1341,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
847
1341
|
|
|
848
1342
|
async function run() {
|
|
849
1343
|
const result = await unifiedTo.kms.updateKmsPage({
|
|
850
|
-
connectionId: "<
|
|
1344
|
+
connectionId: "<id>",
|
|
851
1345
|
id: "<id>",
|
|
852
1346
|
});
|
|
853
1347
|
|
|
@@ -876,7 +1370,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
876
1370
|
|
|
877
1371
|
async function run() {
|
|
878
1372
|
const res = await kmsUpdateKmsPage(unifiedTo, {
|
|
879
|
-
connectionId: "<
|
|
1373
|
+
connectionId: "<id>",
|
|
880
1374
|
id: "<id>",
|
|
881
1375
|
});
|
|
882
1376
|
|
|
@@ -929,7 +1423,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
929
1423
|
|
|
930
1424
|
async function run() {
|
|
931
1425
|
const result = await unifiedTo.kms.updateKmsSpace({
|
|
932
|
-
connectionId: "<
|
|
1426
|
+
connectionId: "<id>",
|
|
933
1427
|
id: "<id>",
|
|
934
1428
|
});
|
|
935
1429
|
|
|
@@ -958,7 +1452,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
958
1452
|
|
|
959
1453
|
async function run() {
|
|
960
1454
|
const res = await kmsUpdateKmsSpace(unifiedTo, {
|
|
961
|
-
connectionId: "<
|
|
1455
|
+
connectionId: "<id>",
|
|
962
1456
|
id: "<id>",
|
|
963
1457
|
});
|
|
964
1458
|
|