@unified-api/typescript-sdk 2.56.0 → 2.58.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/docs/sdks/comment/README.md +512 -0
- package/docs/sdks/connection/README.md +4 -4
- package/docs/sdks/recording/README.md +500 -0
- package/docs/sdks/uc/README.md +1054 -42
- package/docs/sdks/unified/README.md +10 -10
- package/docs/sdks/webhook/README.md +6 -6
- package/funcs/commentCreateUcComment.d.ts +14 -0
- package/funcs/commentCreateUcComment.d.ts.map +1 -0
- package/funcs/commentCreateUcComment.js +109 -0
- package/funcs/commentCreateUcComment.js.map +1 -0
- package/funcs/commentGetUcComment.d.ts +14 -0
- package/funcs/commentGetUcComment.d.ts.map +1 -0
- package/funcs/commentGetUcComment.js +112 -0
- package/funcs/commentGetUcComment.js.map +1 -0
- package/funcs/commentListUcComments.d.ts +14 -0
- package/funcs/commentListUcComments.d.ts.map +1 -0
- package/funcs/commentListUcComments.js +117 -0
- package/funcs/commentListUcComments.js.map +1 -0
- package/funcs/commentPatchUcComment.d.ts +14 -0
- package/funcs/commentPatchUcComment.d.ts.map +1 -0
- package/funcs/commentPatchUcComment.js +113 -0
- package/funcs/commentPatchUcComment.js.map +1 -0
- package/funcs/commentRemoveUcComment.d.ts +13 -0
- package/funcs/commentRemoveUcComment.d.ts.map +1 -0
- package/funcs/commentRemoveUcComment.js +110 -0
- package/funcs/commentRemoveUcComment.js.map +1 -0
- package/funcs/commentUpdateUcComment.d.ts +14 -0
- package/funcs/commentUpdateUcComment.d.ts.map +1 -0
- package/funcs/commentUpdateUcComment.js +113 -0
- package/funcs/commentUpdateUcComment.js.map +1 -0
- package/funcs/passthroughCreatePassthroughJson.js +4 -0
- package/funcs/passthroughCreatePassthroughJson.js.map +1 -1
- package/funcs/passthroughCreatePassthroughRaw.js +4 -0
- package/funcs/passthroughCreatePassthroughRaw.js.map +1 -1
- package/funcs/passthroughListPassthroughs.js +4 -0
- package/funcs/passthroughListPassthroughs.js.map +1 -1
- package/funcs/passthroughPatchPassthroughJson.js +4 -0
- package/funcs/passthroughPatchPassthroughJson.js.map +1 -1
- package/funcs/passthroughPatchPassthroughRaw.js +4 -0
- package/funcs/passthroughPatchPassthroughRaw.js.map +1 -1
- package/funcs/passthroughRemovePassthrough.js +4 -0
- package/funcs/passthroughRemovePassthrough.js.map +1 -1
- package/funcs/passthroughUpdatePassthroughJson.js +4 -0
- package/funcs/passthroughUpdatePassthroughJson.js.map +1 -1
- package/funcs/passthroughUpdatePassthroughRaw.js +4 -0
- package/funcs/passthroughUpdatePassthroughRaw.js.map +1 -1
- package/funcs/recordingCreateUcRecording.d.ts +14 -0
- package/funcs/recordingCreateUcRecording.d.ts.map +1 -0
- package/funcs/recordingCreateUcRecording.js +109 -0
- package/funcs/recordingCreateUcRecording.js.map +1 -0
- package/funcs/recordingGetUcRecording.d.ts +14 -0
- package/funcs/recordingGetUcRecording.d.ts.map +1 -0
- package/funcs/recordingGetUcRecording.js +112 -0
- package/funcs/recordingGetUcRecording.js.map +1 -0
- package/funcs/recordingListUcRecordings.d.ts +14 -0
- package/funcs/recordingListUcRecordings.d.ts.map +1 -0
- package/funcs/recordingListUcRecordings.js +119 -0
- package/funcs/recordingListUcRecordings.js.map +1 -0
- package/funcs/recordingPatchUcRecording.d.ts +14 -0
- package/funcs/recordingPatchUcRecording.d.ts.map +1 -0
- package/funcs/recordingPatchUcRecording.js +113 -0
- package/funcs/recordingPatchUcRecording.js.map +1 -0
- package/funcs/recordingRemoveUcRecording.d.ts +13 -0
- package/funcs/recordingRemoveUcRecording.d.ts.map +1 -0
- package/funcs/recordingRemoveUcRecording.js +110 -0
- package/funcs/recordingRemoveUcRecording.js.map +1 -0
- package/funcs/recordingUpdateUcRecording.d.ts +14 -0
- package/funcs/recordingUpdateUcRecording.d.ts.map +1 -0
- package/funcs/recordingUpdateUcRecording.js +113 -0
- package/funcs/recordingUpdateUcRecording.js.map +1 -0
- package/funcs/ucCreateUcComment.d.ts +14 -0
- package/funcs/ucCreateUcComment.d.ts.map +1 -0
- package/funcs/ucCreateUcComment.js +109 -0
- package/funcs/ucCreateUcComment.js.map +1 -0
- package/funcs/ucCreateUcRecording.d.ts +14 -0
- package/funcs/ucCreateUcRecording.d.ts.map +1 -0
- package/funcs/ucCreateUcRecording.js +109 -0
- package/funcs/ucCreateUcRecording.js.map +1 -0
- package/funcs/ucGetUcComment.d.ts +14 -0
- package/funcs/ucGetUcComment.d.ts.map +1 -0
- package/funcs/ucGetUcComment.js +112 -0
- package/funcs/ucGetUcComment.js.map +1 -0
- package/funcs/ucGetUcRecording.d.ts +14 -0
- package/funcs/ucGetUcRecording.d.ts.map +1 -0
- package/funcs/ucGetUcRecording.js +112 -0
- package/funcs/ucGetUcRecording.js.map +1 -0
- package/funcs/ucListUcComments.d.ts +14 -0
- package/funcs/ucListUcComments.d.ts.map +1 -0
- package/funcs/ucListUcComments.js +117 -0
- package/funcs/ucListUcComments.js.map +1 -0
- package/funcs/ucListUcRecordings.d.ts +14 -0
- package/funcs/ucListUcRecordings.d.ts.map +1 -0
- package/funcs/ucListUcRecordings.js +119 -0
- package/funcs/ucListUcRecordings.js.map +1 -0
- package/funcs/ucPatchUcComment.d.ts +14 -0
- package/funcs/ucPatchUcComment.d.ts.map +1 -0
- package/funcs/ucPatchUcComment.js +113 -0
- package/funcs/ucPatchUcComment.js.map +1 -0
- package/funcs/ucPatchUcRecording.d.ts +14 -0
- package/funcs/ucPatchUcRecording.d.ts.map +1 -0
- package/funcs/ucPatchUcRecording.js +113 -0
- package/funcs/ucPatchUcRecording.js.map +1 -0
- package/funcs/ucRemoveUcComment.d.ts +13 -0
- package/funcs/ucRemoveUcComment.d.ts.map +1 -0
- package/funcs/ucRemoveUcComment.js +110 -0
- package/funcs/ucRemoveUcComment.js.map +1 -0
- package/funcs/ucRemoveUcRecording.d.ts +13 -0
- package/funcs/ucRemoveUcRecording.d.ts.map +1 -0
- package/funcs/ucRemoveUcRecording.js +110 -0
- package/funcs/ucRemoveUcRecording.js.map +1 -0
- package/funcs/ucUpdateUcComment.d.ts +14 -0
- package/funcs/ucUpdateUcComment.d.ts.map +1 -0
- package/funcs/ucUpdateUcComment.js +113 -0
- package/funcs/ucUpdateUcComment.js.map +1 -0
- package/funcs/ucUpdateUcRecording.d.ts +14 -0
- package/funcs/ucUpdateUcRecording.d.ts.map +1 -0
- package/funcs/ucUpdateUcRecording.js +113 -0
- package/funcs/ucUpdateUcRecording.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- 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/models/operations/createpassthroughjson.d.ts +6 -0
- package/sdk/models/operations/createpassthroughjson.d.ts.map +1 -1
- package/sdk/models/operations/createpassthroughjson.js +2 -0
- package/sdk/models/operations/createpassthroughjson.js.map +1 -1
- package/sdk/models/operations/createpassthroughraw.d.ts +6 -0
- package/sdk/models/operations/createpassthroughraw.d.ts.map +1 -1
- package/sdk/models/operations/createpassthroughraw.js +2 -0
- package/sdk/models/operations/createpassthroughraw.js.map +1 -1
- package/sdk/models/operations/createuccomment.d.ts +40 -0
- package/sdk/models/operations/createuccomment.d.ts.map +1 -0
- package/sdk/models/operations/createuccomment.js +75 -0
- package/sdk/models/operations/createuccomment.js.map +1 -0
- package/sdk/models/operations/createucrecording.d.ts +40 -0
- package/sdk/models/operations/createucrecording.d.ts.map +1 -0
- package/sdk/models/operations/createucrecording.js +75 -0
- package/sdk/models/operations/createucrecording.js.map +1 -0
- package/sdk/models/operations/getuccomment.d.ts +42 -0
- package/sdk/models/operations/getuccomment.d.ts.map +1 -0
- package/sdk/models/operations/getuccomment.js +72 -0
- package/sdk/models/operations/getuccomment.js.map +1 -0
- package/sdk/models/operations/getucrecording.d.ts +42 -0
- package/sdk/models/operations/getucrecording.d.ts.map +1 -0
- package/sdk/models/operations/getucrecording.js +72 -0
- package/sdk/models/operations/getucrecording.js.map +1 -0
- package/sdk/models/operations/index.d.ts +12 -0
- package/sdk/models/operations/index.d.ts.map +1 -1
- package/sdk/models/operations/index.js +12 -0
- package/sdk/models/operations/index.js.map +1 -1
- package/sdk/models/operations/listpassthroughs.d.ts +6 -0
- package/sdk/models/operations/listpassthroughs.d.ts.map +1 -1
- package/sdk/models/operations/listpassthroughs.js +2 -0
- package/sdk/models/operations/listpassthroughs.js.map +1 -1
- package/sdk/models/operations/listuccomments.d.ts +59 -0
- package/sdk/models/operations/listuccomments.d.ts.map +1 -0
- package/sdk/models/operations/listuccomments.js +93 -0
- package/sdk/models/operations/listuccomments.js.map +1 -0
- package/sdk/models/operations/listucrecordings.d.ts +63 -0
- package/sdk/models/operations/listucrecordings.d.ts.map +1 -0
- package/sdk/models/operations/listucrecordings.js +101 -0
- package/sdk/models/operations/listucrecordings.js.map +1 -0
- package/sdk/models/operations/patchpassthroughjson.d.ts +6 -0
- package/sdk/models/operations/patchpassthroughjson.d.ts.map +1 -1
- package/sdk/models/operations/patchpassthroughjson.js +2 -0
- package/sdk/models/operations/patchpassthroughjson.js.map +1 -1
- package/sdk/models/operations/patchpassthroughraw.d.ts +6 -0
- package/sdk/models/operations/patchpassthroughraw.d.ts.map +1 -1
- package/sdk/models/operations/patchpassthroughraw.js +2 -0
- package/sdk/models/operations/patchpassthroughraw.js.map +1 -1
- package/sdk/models/operations/patchuccomment.d.ts +45 -0
- package/sdk/models/operations/patchuccomment.d.ts.map +1 -0
- package/sdk/models/operations/patchuccomment.js +77 -0
- package/sdk/models/operations/patchuccomment.js.map +1 -0
- package/sdk/models/operations/patchucrecording.d.ts +45 -0
- package/sdk/models/operations/patchucrecording.d.ts.map +1 -0
- package/sdk/models/operations/patchucrecording.js +77 -0
- package/sdk/models/operations/patchucrecording.js.map +1 -0
- package/sdk/models/operations/removepassthrough.d.ts +6 -0
- package/sdk/models/operations/removepassthrough.d.ts.map +1 -1
- package/sdk/models/operations/removepassthrough.js +2 -0
- package/sdk/models/operations/removepassthrough.js.map +1 -1
- package/sdk/models/operations/removeuccomment.d.ts +66 -0
- package/sdk/models/operations/removeuccomment.d.ts.map +1 -0
- package/sdk/models/operations/removeuccomment.js +105 -0
- package/sdk/models/operations/removeuccomment.js.map +1 -0
- package/sdk/models/operations/removeucrecording.d.ts +66 -0
- package/sdk/models/operations/removeucrecording.d.ts.map +1 -0
- package/sdk/models/operations/removeucrecording.js +105 -0
- package/sdk/models/operations/removeucrecording.js.map +1 -0
- package/sdk/models/operations/updatepassthroughjson.d.ts +6 -0
- package/sdk/models/operations/updatepassthroughjson.d.ts.map +1 -1
- package/sdk/models/operations/updatepassthroughjson.js +2 -0
- package/sdk/models/operations/updatepassthroughjson.js.map +1 -1
- package/sdk/models/operations/updatepassthroughraw.d.ts +6 -0
- package/sdk/models/operations/updatepassthroughraw.d.ts.map +1 -1
- package/sdk/models/operations/updatepassthroughraw.js +2 -0
- package/sdk/models/operations/updatepassthroughraw.js.map +1 -1
- package/sdk/models/operations/updateuccomment.d.ts +45 -0
- package/sdk/models/operations/updateuccomment.d.ts.map +1 -0
- package/sdk/models/operations/updateuccomment.js +77 -0
- package/sdk/models/operations/updateuccomment.js.map +1 -0
- package/sdk/models/operations/updateucrecording.d.ts +45 -0
- package/sdk/models/operations/updateucrecording.d.ts.map +1 -0
- package/sdk/models/operations/updateucrecording.js +77 -0
- package/sdk/models/operations/updateucrecording.js.map +1 -0
- package/sdk/models/shared/accountingattachment.d.ts +6 -6
- package/sdk/models/shared/accountingattachment.d.ts.map +1 -1
- package/sdk/models/shared/accountingattachment.js +6 -6
- package/sdk/models/shared/accountingattachment.js.map +1 -1
- package/sdk/models/shared/index.d.ts +4 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +4 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/integrationsupport.d.ts +30 -0
- package/sdk/models/shared/integrationsupport.d.ts.map +1 -1
- package/sdk/models/shared/integrationsupport.js +31 -6
- package/sdk/models/shared/integrationsupport.js.map +1 -1
- package/sdk/models/shared/propertyconnectionpermissions.d.ts +9 -0
- package/sdk/models/shared/propertyconnectionpermissions.d.ts.map +1 -1
- package/sdk/models/shared/propertyconnectionpermissions.js +3 -0
- package/sdk/models/shared/propertyconnectionpermissions.js.map +1 -1
- package/sdk/models/shared/uccall.d.ts +0 -3
- package/sdk/models/shared/uccall.d.ts.map +1 -1
- package/sdk/models/shared/uccall.js.map +1 -1
- package/sdk/models/shared/uccomment.d.ts +43 -0
- package/sdk/models/shared/uccomment.d.ts.map +1 -0
- package/sdk/models/shared/uccomment.js +82 -0
- package/sdk/models/shared/uccomment.js.map +1 -0
- package/sdk/models/shared/uccontact.d.ts +0 -3
- package/sdk/models/shared/uccontact.d.ts.map +1 -1
- package/sdk/models/shared/uccontact.js.map +1 -1
- package/sdk/models/shared/ucrecording.d.ts +60 -0
- package/sdk/models/shared/ucrecording.d.ts.map +1 -0
- package/sdk/models/shared/ucrecording.js +120 -0
- package/sdk/models/shared/ucrecording.js.map +1 -0
- package/sdk/models/shared/ucrecordingmedia.d.ts +40 -0
- package/sdk/models/shared/ucrecordingmedia.d.ts.map +1 -0
- package/sdk/models/shared/ucrecordingmedia.js +87 -0
- package/sdk/models/shared/ucrecordingmedia.js.map +1 -0
- package/sdk/models/shared/ucrecordingtranscript.d.ts +37 -0
- package/sdk/models/shared/ucrecordingtranscript.d.ts.map +1 -0
- package/sdk/models/shared/ucrecordingtranscript.js +84 -0
- package/sdk/models/shared/ucrecordingtranscript.js.map +1 -0
- package/sdk/models/shared/webhook.d.ts +6 -0
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +2 -0
- package/sdk/models/shared/webhook.js.map +1 -1
- package/sdk/recording.d.ts +24 -0
- package/sdk/recording.d.ts.map +1 -1
- package/sdk/recording.js +42 -0
- package/sdk/recording.js.map +1 -1
- package/sdk/uc.d.ts +48 -0
- package/sdk/uc.d.ts.map +1 -1
- package/sdk/uc.js +84 -0
- package/sdk/uc.js.map +1 -1
- package/src/funcs/commentCreateUcComment.ts +163 -0
- package/src/funcs/commentGetUcComment.ts +166 -0
- package/src/funcs/commentListUcComments.ts +171 -0
- package/src/funcs/commentPatchUcComment.ts +167 -0
- package/src/funcs/commentRemoveUcComment.ts +169 -0
- package/src/funcs/commentUpdateUcComment.ts +167 -0
- package/src/funcs/passthroughCreatePassthroughJson.ts +6 -1
- package/src/funcs/passthroughCreatePassthroughRaw.ts +6 -1
- package/src/funcs/passthroughListPassthroughs.ts +6 -1
- package/src/funcs/passthroughPatchPassthroughJson.ts +6 -1
- package/src/funcs/passthroughPatchPassthroughRaw.ts +6 -1
- package/src/funcs/passthroughRemovePassthrough.ts +6 -1
- package/src/funcs/passthroughUpdatePassthroughJson.ts +6 -1
- package/src/funcs/passthroughUpdatePassthroughRaw.ts +6 -1
- package/src/funcs/recordingCreateUcRecording.ts +163 -0
- package/src/funcs/recordingGetUcRecording.ts +166 -0
- package/src/funcs/recordingListUcRecordings.ts +173 -0
- package/src/funcs/recordingPatchUcRecording.ts +167 -0
- package/src/funcs/recordingRemoveUcRecording.ts +169 -0
- package/src/funcs/recordingUpdateUcRecording.ts +167 -0
- package/src/funcs/ucCreateUcComment.ts +163 -0
- package/src/funcs/ucCreateUcRecording.ts +163 -0
- package/src/funcs/ucGetUcComment.ts +166 -0
- package/src/funcs/ucGetUcRecording.ts +166 -0
- package/src/funcs/ucListUcComments.ts +171 -0
- package/src/funcs/ucListUcRecordings.ts +173 -0
- package/src/funcs/ucPatchUcComment.ts +167 -0
- package/src/funcs/ucPatchUcRecording.ts +167 -0
- package/src/funcs/ucRemoveUcComment.ts +169 -0
- package/src/funcs/ucRemoveUcRecording.ts +169 -0
- package/src/funcs/ucUpdateUcComment.ts +167 -0
- package/src/funcs/ucUpdateUcRecording.ts +167 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/comment.ts +90 -0
- package/src/sdk/models/operations/createpassthroughjson.ts +4 -0
- package/src/sdk/models/operations/createpassthroughraw.ts +4 -0
- package/src/sdk/models/operations/createuccomment.ts +92 -0
- package/src/sdk/models/operations/createucrecording.ts +92 -0
- package/src/sdk/models/operations/getuccomment.ts +92 -0
- package/src/sdk/models/operations/getucrecording.ts +92 -0
- package/src/sdk/models/operations/index.ts +12 -0
- package/src/sdk/models/operations/listpassthroughs.ts +4 -0
- package/src/sdk/models/operations/listuccomments.ts +130 -0
- package/src/sdk/models/operations/listucrecordings.ts +142 -0
- package/src/sdk/models/operations/patchpassthroughjson.ts +4 -0
- package/src/sdk/models/operations/patchpassthroughraw.ts +4 -0
- package/src/sdk/models/operations/patchuccomment.ts +99 -0
- package/src/sdk/models/operations/patchucrecording.ts +99 -0
- package/src/sdk/models/operations/removepassthrough.ts +4 -0
- package/src/sdk/models/operations/removeuccomment.ts +151 -0
- package/src/sdk/models/operations/removeucrecording.ts +151 -0
- package/src/sdk/models/operations/updatepassthroughjson.ts +4 -0
- package/src/sdk/models/operations/updatepassthroughraw.ts +4 -0
- package/src/sdk/models/operations/updateuccomment.ts +99 -0
- package/src/sdk/models/operations/updateucrecording.ts +99 -0
- package/src/sdk/models/shared/accountingattachment.ts +12 -12
- package/src/sdk/models/shared/index.ts +4 -0
- package/src/sdk/models/shared/integrationsupport.ts +32 -0
- package/src/sdk/models/shared/propertyconnectionpermissions.ts +3 -0
- package/src/sdk/models/shared/uccall.ts +0 -3
- package/src/sdk/models/shared/uccomment.ts +95 -0
- package/src/sdk/models/shared/uccontact.ts +0 -3
- package/src/sdk/models/shared/ucrecording.ts +154 -0
- package/src/sdk/models/shared/ucrecordingmedia.ts +109 -0
- package/src/sdk/models/shared/ucrecordingtranscript.ts +99 -0
- package/src/sdk/models/shared/webhook.ts +2 -0
- package/src/sdk/recording.ts +90 -0
- package/src/sdk/uc.ts +180 -0
package/docs/sdks/uc/README.md
CHANGED
|
@@ -5,17 +5,845 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [createUcComment](#createuccomment) - Create a comment
|
|
8
9
|
* [createUcContact](#createuccontact) - Create a contact
|
|
10
|
+
* [createUcRecording](#createucrecording) - Create a recording
|
|
11
|
+
* [getUcComment](#getuccomment) - Retrieve a comment
|
|
9
12
|
* [getUcContact](#getuccontact) - Retrieve a contact
|
|
13
|
+
* [getUcRecording](#getucrecording) - Retrieve a recording
|
|
10
14
|
* [listUcCalls](#listuccalls) - List all calls
|
|
15
|
+
* [listUcComments](#listuccomments) - List all comments
|
|
11
16
|
* [listUcContacts](#listuccontacts) - List all contacts
|
|
17
|
+
* [listUcRecordings](#listucrecordings) - List all recordings
|
|
18
|
+
* [patchUcComment](#patchuccomment) - Update a comment
|
|
12
19
|
* [patchUcContact](#patchuccontact) - Update a contact
|
|
20
|
+
* [patchUcRecording](#patchucrecording) - Update a recording
|
|
21
|
+
* [removeUcComment](#removeuccomment) - Remove a comment
|
|
13
22
|
* [removeUcContact](#removeuccontact) - Remove a contact
|
|
23
|
+
* [removeUcRecording](#removeucrecording) - Remove a recording
|
|
24
|
+
* [updateUcComment](#updateuccomment) - Update a comment
|
|
14
25
|
* [updateUcContact](#updateuccontact) - Update a contact
|
|
26
|
+
* [updateUcRecording](#updateucrecording) - Update a recording
|
|
27
|
+
|
|
28
|
+
## createUcComment
|
|
29
|
+
|
|
30
|
+
Create a comment
|
|
31
|
+
|
|
32
|
+
### Example Usage
|
|
33
|
+
|
|
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.uc.createUcComment({
|
|
45
|
+
ucComment: {
|
|
46
|
+
content: "<value>",
|
|
47
|
+
},
|
|
48
|
+
connectionId: "<id>",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
// Handle the result
|
|
52
|
+
console.log(result);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
run();
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Standalone function
|
|
59
|
+
|
|
60
|
+
The standalone function version of this method:
|
|
61
|
+
|
|
62
|
+
```typescript
|
|
63
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
64
|
+
import { ucCreateUcComment } from "@unified-api/typescript-sdk/funcs/ucCreateUcComment.js";
|
|
65
|
+
|
|
66
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
67
|
+
// You can create one instance of it to use across an application.
|
|
68
|
+
const unifiedTo = new UnifiedToCore({
|
|
69
|
+
security: {
|
|
70
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
71
|
+
},
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
async function run() {
|
|
75
|
+
const res = await ucCreateUcComment(unifiedTo, {
|
|
76
|
+
ucComment: {
|
|
77
|
+
content: "<value>",
|
|
78
|
+
},
|
|
79
|
+
connectionId: "<id>",
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
if (!res.ok) {
|
|
83
|
+
throw res.error;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
const { value: result } = res;
|
|
87
|
+
|
|
88
|
+
// Handle the result
|
|
89
|
+
console.log(result);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
run();
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Parameters
|
|
96
|
+
|
|
97
|
+
| Parameter | Type | Required | Description |
|
|
98
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
99
|
+
| `request` | [operations.CreateUcCommentRequest](../../sdk/models/operations/createuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
100
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
101
|
+
| `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. |
|
|
102
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
103
|
+
|
|
104
|
+
### Response
|
|
105
|
+
|
|
106
|
+
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
107
|
+
|
|
108
|
+
### Errors
|
|
109
|
+
|
|
110
|
+
| Error Type | Status Code | Content Type |
|
|
111
|
+
| --------------- | --------------- | --------------- |
|
|
112
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
15
113
|
|
|
16
114
|
## createUcContact
|
|
17
115
|
|
|
18
|
-
Create a contact
|
|
116
|
+
Create a contact
|
|
117
|
+
|
|
118
|
+
### Example Usage
|
|
119
|
+
|
|
120
|
+
```typescript
|
|
121
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
122
|
+
|
|
123
|
+
const unifiedTo = new UnifiedTo({
|
|
124
|
+
security: {
|
|
125
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
126
|
+
},
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
async function run() {
|
|
130
|
+
const result = await unifiedTo.uc.createUcContact({
|
|
131
|
+
ucContact: {},
|
|
132
|
+
connectionId: "<id>",
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
// Handle the result
|
|
136
|
+
console.log(result);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
run();
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Standalone function
|
|
143
|
+
|
|
144
|
+
The standalone function version of this method:
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
148
|
+
import { ucCreateUcContact } from "@unified-api/typescript-sdk/funcs/ucCreateUcContact.js";
|
|
149
|
+
|
|
150
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
151
|
+
// You can create one instance of it to use across an application.
|
|
152
|
+
const unifiedTo = new UnifiedToCore({
|
|
153
|
+
security: {
|
|
154
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
155
|
+
},
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
async function run() {
|
|
159
|
+
const res = await ucCreateUcContact(unifiedTo, {
|
|
160
|
+
ucContact: {},
|
|
161
|
+
connectionId: "<id>",
|
|
162
|
+
});
|
|
163
|
+
|
|
164
|
+
if (!res.ok) {
|
|
165
|
+
throw res.error;
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
const { value: result } = res;
|
|
169
|
+
|
|
170
|
+
// Handle the result
|
|
171
|
+
console.log(result);
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
run();
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
| Parameter | Type | Required | Description |
|
|
180
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
181
|
+
| `request` | [operations.CreateUcContactRequest](../../sdk/models/operations/createuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
182
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
183
|
+
| `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. |
|
|
184
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
185
|
+
|
|
186
|
+
### Response
|
|
187
|
+
|
|
188
|
+
**Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
|
|
189
|
+
|
|
190
|
+
### Errors
|
|
191
|
+
|
|
192
|
+
| Error Type | Status Code | Content Type |
|
|
193
|
+
| --------------- | --------------- | --------------- |
|
|
194
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
195
|
+
|
|
196
|
+
## createUcRecording
|
|
197
|
+
|
|
198
|
+
Create a recording
|
|
199
|
+
|
|
200
|
+
### Example Usage
|
|
201
|
+
|
|
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.uc.createUcRecording({
|
|
213
|
+
ucRecording: {},
|
|
214
|
+
connectionId: "<id>",
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
// Handle the result
|
|
218
|
+
console.log(result);
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
run();
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Standalone function
|
|
225
|
+
|
|
226
|
+
The standalone function version of this method:
|
|
227
|
+
|
|
228
|
+
```typescript
|
|
229
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
230
|
+
import { ucCreateUcRecording } from "@unified-api/typescript-sdk/funcs/ucCreateUcRecording.js";
|
|
231
|
+
|
|
232
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
233
|
+
// You can create one instance of it to use across an application.
|
|
234
|
+
const unifiedTo = new UnifiedToCore({
|
|
235
|
+
security: {
|
|
236
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
237
|
+
},
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
async function run() {
|
|
241
|
+
const res = await ucCreateUcRecording(unifiedTo, {
|
|
242
|
+
ucRecording: {},
|
|
243
|
+
connectionId: "<id>",
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
if (!res.ok) {
|
|
247
|
+
throw res.error;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
const { value: result } = res;
|
|
251
|
+
|
|
252
|
+
// Handle the result
|
|
253
|
+
console.log(result);
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
run();
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### Parameters
|
|
260
|
+
|
|
261
|
+
| Parameter | Type | Required | Description |
|
|
262
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
263
|
+
| `request` | [operations.CreateUcRecordingRequest](../../sdk/models/operations/createucrecordingrequest.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.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
271
|
+
|
|
272
|
+
### Errors
|
|
273
|
+
|
|
274
|
+
| Error Type | Status Code | Content Type |
|
|
275
|
+
| --------------- | --------------- | --------------- |
|
|
276
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
277
|
+
|
|
278
|
+
## getUcComment
|
|
279
|
+
|
|
280
|
+
Retrieve a comment
|
|
281
|
+
|
|
282
|
+
### Example Usage
|
|
283
|
+
|
|
284
|
+
```typescript
|
|
285
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
286
|
+
|
|
287
|
+
const unifiedTo = new UnifiedTo({
|
|
288
|
+
security: {
|
|
289
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
290
|
+
},
|
|
291
|
+
});
|
|
292
|
+
|
|
293
|
+
async function run() {
|
|
294
|
+
const result = await unifiedTo.uc.getUcComment({
|
|
295
|
+
connectionId: "<id>",
|
|
296
|
+
id: "<id>",
|
|
297
|
+
});
|
|
298
|
+
|
|
299
|
+
// Handle the result
|
|
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 { ucGetUcComment } from "@unified-api/typescript-sdk/funcs/ucGetUcComment.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 ucGetUcComment(unifiedTo, {
|
|
324
|
+
connectionId: "<id>",
|
|
325
|
+
id: "<id>",
|
|
326
|
+
});
|
|
327
|
+
|
|
328
|
+
if (!res.ok) {
|
|
329
|
+
throw res.error;
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
const { value: result } = res;
|
|
333
|
+
|
|
334
|
+
// Handle the result
|
|
335
|
+
console.log(result);
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
run();
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
| Parameter | Type | Required | Description |
|
|
344
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
345
|
+
| `request` | [operations.GetUcCommentRequest](../../sdk/models/operations/getuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
346
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
347
|
+
| `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. |
|
|
348
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
349
|
+
|
|
350
|
+
### Response
|
|
351
|
+
|
|
352
|
+
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
353
|
+
|
|
354
|
+
### Errors
|
|
355
|
+
|
|
356
|
+
| Error Type | Status Code | Content Type |
|
|
357
|
+
| --------------- | --------------- | --------------- |
|
|
358
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
359
|
+
|
|
360
|
+
## getUcContact
|
|
361
|
+
|
|
362
|
+
Retrieve a contact
|
|
363
|
+
|
|
364
|
+
### Example Usage
|
|
365
|
+
|
|
366
|
+
```typescript
|
|
367
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
368
|
+
|
|
369
|
+
const unifiedTo = new UnifiedTo({
|
|
370
|
+
security: {
|
|
371
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
372
|
+
},
|
|
373
|
+
});
|
|
374
|
+
|
|
375
|
+
async function run() {
|
|
376
|
+
const result = await unifiedTo.uc.getUcContact({
|
|
377
|
+
connectionId: "<id>",
|
|
378
|
+
id: "<id>",
|
|
379
|
+
});
|
|
380
|
+
|
|
381
|
+
// Handle the result
|
|
382
|
+
console.log(result);
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
run();
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
### Standalone function
|
|
389
|
+
|
|
390
|
+
The standalone function version of this method:
|
|
391
|
+
|
|
392
|
+
```typescript
|
|
393
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
394
|
+
import { ucGetUcContact } from "@unified-api/typescript-sdk/funcs/ucGetUcContact.js";
|
|
395
|
+
|
|
396
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
397
|
+
// You can create one instance of it to use across an application.
|
|
398
|
+
const unifiedTo = new UnifiedToCore({
|
|
399
|
+
security: {
|
|
400
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
401
|
+
},
|
|
402
|
+
});
|
|
403
|
+
|
|
404
|
+
async function run() {
|
|
405
|
+
const res = await ucGetUcContact(unifiedTo, {
|
|
406
|
+
connectionId: "<id>",
|
|
407
|
+
id: "<id>",
|
|
408
|
+
});
|
|
409
|
+
|
|
410
|
+
if (!res.ok) {
|
|
411
|
+
throw res.error;
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
const { value: result } = res;
|
|
415
|
+
|
|
416
|
+
// Handle the result
|
|
417
|
+
console.log(result);
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
run();
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
### Parameters
|
|
424
|
+
|
|
425
|
+
| Parameter | Type | Required | Description |
|
|
426
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
427
|
+
| `request` | [operations.GetUcContactRequest](../../sdk/models/operations/getuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
428
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
429
|
+
| `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. |
|
|
430
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
431
|
+
|
|
432
|
+
### Response
|
|
433
|
+
|
|
434
|
+
**Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
|
|
435
|
+
|
|
436
|
+
### Errors
|
|
437
|
+
|
|
438
|
+
| Error Type | Status Code | Content Type |
|
|
439
|
+
| --------------- | --------------- | --------------- |
|
|
440
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
441
|
+
|
|
442
|
+
## getUcRecording
|
|
443
|
+
|
|
444
|
+
Retrieve a recording
|
|
445
|
+
|
|
446
|
+
### Example Usage
|
|
447
|
+
|
|
448
|
+
```typescript
|
|
449
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
450
|
+
|
|
451
|
+
const unifiedTo = new UnifiedTo({
|
|
452
|
+
security: {
|
|
453
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
454
|
+
},
|
|
455
|
+
});
|
|
456
|
+
|
|
457
|
+
async function run() {
|
|
458
|
+
const result = await unifiedTo.uc.getUcRecording({
|
|
459
|
+
connectionId: "<id>",
|
|
460
|
+
id: "<id>",
|
|
461
|
+
});
|
|
462
|
+
|
|
463
|
+
// Handle the result
|
|
464
|
+
console.log(result);
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
run();
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
### Standalone function
|
|
471
|
+
|
|
472
|
+
The standalone function version of this method:
|
|
473
|
+
|
|
474
|
+
```typescript
|
|
475
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
476
|
+
import { ucGetUcRecording } from "@unified-api/typescript-sdk/funcs/ucGetUcRecording.js";
|
|
477
|
+
|
|
478
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
479
|
+
// You can create one instance of it to use across an application.
|
|
480
|
+
const unifiedTo = new UnifiedToCore({
|
|
481
|
+
security: {
|
|
482
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
483
|
+
},
|
|
484
|
+
});
|
|
485
|
+
|
|
486
|
+
async function run() {
|
|
487
|
+
const res = await ucGetUcRecording(unifiedTo, {
|
|
488
|
+
connectionId: "<id>",
|
|
489
|
+
id: "<id>",
|
|
490
|
+
});
|
|
491
|
+
|
|
492
|
+
if (!res.ok) {
|
|
493
|
+
throw res.error;
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
const { value: result } = res;
|
|
497
|
+
|
|
498
|
+
// Handle the result
|
|
499
|
+
console.log(result);
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
run();
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
### Parameters
|
|
506
|
+
|
|
507
|
+
| Parameter | Type | Required | Description |
|
|
508
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
509
|
+
| `request` | [operations.GetUcRecordingRequest](../../sdk/models/operations/getucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
510
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
511
|
+
| `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. |
|
|
512
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
513
|
+
|
|
514
|
+
### Response
|
|
515
|
+
|
|
516
|
+
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
517
|
+
|
|
518
|
+
### Errors
|
|
519
|
+
|
|
520
|
+
| Error Type | Status Code | Content Type |
|
|
521
|
+
| --------------- | --------------- | --------------- |
|
|
522
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
523
|
+
|
|
524
|
+
## listUcCalls
|
|
525
|
+
|
|
526
|
+
List all calls
|
|
527
|
+
|
|
528
|
+
### Example Usage
|
|
529
|
+
|
|
530
|
+
```typescript
|
|
531
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
532
|
+
|
|
533
|
+
const unifiedTo = new UnifiedTo({
|
|
534
|
+
security: {
|
|
535
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
536
|
+
},
|
|
537
|
+
});
|
|
538
|
+
|
|
539
|
+
async function run() {
|
|
540
|
+
const result = await unifiedTo.uc.listUcCalls({
|
|
541
|
+
connectionId: "<id>",
|
|
542
|
+
});
|
|
543
|
+
|
|
544
|
+
// Handle the result
|
|
545
|
+
console.log(result);
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
run();
|
|
549
|
+
```
|
|
550
|
+
|
|
551
|
+
### Standalone function
|
|
552
|
+
|
|
553
|
+
The standalone function version of this method:
|
|
554
|
+
|
|
555
|
+
```typescript
|
|
556
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
557
|
+
import { ucListUcCalls } from "@unified-api/typescript-sdk/funcs/ucListUcCalls.js";
|
|
558
|
+
|
|
559
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
560
|
+
// You can create one instance of it to use across an application.
|
|
561
|
+
const unifiedTo = new UnifiedToCore({
|
|
562
|
+
security: {
|
|
563
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
564
|
+
},
|
|
565
|
+
});
|
|
566
|
+
|
|
567
|
+
async function run() {
|
|
568
|
+
const res = await ucListUcCalls(unifiedTo, {
|
|
569
|
+
connectionId: "<id>",
|
|
570
|
+
});
|
|
571
|
+
|
|
572
|
+
if (!res.ok) {
|
|
573
|
+
throw res.error;
|
|
574
|
+
}
|
|
575
|
+
|
|
576
|
+
const { value: result } = res;
|
|
577
|
+
|
|
578
|
+
// Handle the result
|
|
579
|
+
console.log(result);
|
|
580
|
+
}
|
|
581
|
+
|
|
582
|
+
run();
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
### Parameters
|
|
586
|
+
|
|
587
|
+
| Parameter | Type | Required | Description |
|
|
588
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
589
|
+
| `request` | [operations.ListUcCallsRequest](../../sdk/models/operations/listuccallsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
590
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
591
|
+
| `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. |
|
|
592
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
593
|
+
|
|
594
|
+
### Response
|
|
595
|
+
|
|
596
|
+
**Promise\<[shared.UcCall[]](../../models/.md)\>**
|
|
597
|
+
|
|
598
|
+
### Errors
|
|
599
|
+
|
|
600
|
+
| Error Type | Status Code | Content Type |
|
|
601
|
+
| --------------- | --------------- | --------------- |
|
|
602
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
603
|
+
|
|
604
|
+
## listUcComments
|
|
605
|
+
|
|
606
|
+
List all comments
|
|
607
|
+
|
|
608
|
+
### Example Usage
|
|
609
|
+
|
|
610
|
+
```typescript
|
|
611
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
612
|
+
|
|
613
|
+
const unifiedTo = new UnifiedTo({
|
|
614
|
+
security: {
|
|
615
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
616
|
+
},
|
|
617
|
+
});
|
|
618
|
+
|
|
619
|
+
async function run() {
|
|
620
|
+
const result = await unifiedTo.uc.listUcComments({
|
|
621
|
+
connectionId: "<id>",
|
|
622
|
+
});
|
|
623
|
+
|
|
624
|
+
// Handle the result
|
|
625
|
+
console.log(result);
|
|
626
|
+
}
|
|
627
|
+
|
|
628
|
+
run();
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
### Standalone function
|
|
632
|
+
|
|
633
|
+
The standalone function version of this method:
|
|
634
|
+
|
|
635
|
+
```typescript
|
|
636
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
637
|
+
import { ucListUcComments } from "@unified-api/typescript-sdk/funcs/ucListUcComments.js";
|
|
638
|
+
|
|
639
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
640
|
+
// You can create one instance of it to use across an application.
|
|
641
|
+
const unifiedTo = new UnifiedToCore({
|
|
642
|
+
security: {
|
|
643
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
644
|
+
},
|
|
645
|
+
});
|
|
646
|
+
|
|
647
|
+
async function run() {
|
|
648
|
+
const res = await ucListUcComments(unifiedTo, {
|
|
649
|
+
connectionId: "<id>",
|
|
650
|
+
});
|
|
651
|
+
|
|
652
|
+
if (!res.ok) {
|
|
653
|
+
throw res.error;
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
const { value: result } = res;
|
|
657
|
+
|
|
658
|
+
// Handle the result
|
|
659
|
+
console.log(result);
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
run();
|
|
663
|
+
```
|
|
664
|
+
|
|
665
|
+
### Parameters
|
|
666
|
+
|
|
667
|
+
| Parameter | Type | Required | Description |
|
|
668
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
669
|
+
| `request` | [operations.ListUcCommentsRequest](../../sdk/models/operations/listuccommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
670
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
671
|
+
| `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. |
|
|
672
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
673
|
+
|
|
674
|
+
### Response
|
|
675
|
+
|
|
676
|
+
**Promise\<[shared.UcComment[]](../../models/.md)\>**
|
|
677
|
+
|
|
678
|
+
### Errors
|
|
679
|
+
|
|
680
|
+
| Error Type | Status Code | Content Type |
|
|
681
|
+
| --------------- | --------------- | --------------- |
|
|
682
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
683
|
+
|
|
684
|
+
## listUcContacts
|
|
685
|
+
|
|
686
|
+
List all contacts
|
|
687
|
+
|
|
688
|
+
### Example Usage
|
|
689
|
+
|
|
690
|
+
```typescript
|
|
691
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
692
|
+
|
|
693
|
+
const unifiedTo = new UnifiedTo({
|
|
694
|
+
security: {
|
|
695
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
696
|
+
},
|
|
697
|
+
});
|
|
698
|
+
|
|
699
|
+
async function run() {
|
|
700
|
+
const result = await unifiedTo.uc.listUcContacts({
|
|
701
|
+
connectionId: "<id>",
|
|
702
|
+
});
|
|
703
|
+
|
|
704
|
+
// Handle the result
|
|
705
|
+
console.log(result);
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
run();
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
### Standalone function
|
|
712
|
+
|
|
713
|
+
The standalone function version of this method:
|
|
714
|
+
|
|
715
|
+
```typescript
|
|
716
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
717
|
+
import { ucListUcContacts } from "@unified-api/typescript-sdk/funcs/ucListUcContacts.js";
|
|
718
|
+
|
|
719
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
720
|
+
// You can create one instance of it to use across an application.
|
|
721
|
+
const unifiedTo = new UnifiedToCore({
|
|
722
|
+
security: {
|
|
723
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
724
|
+
},
|
|
725
|
+
});
|
|
726
|
+
|
|
727
|
+
async function run() {
|
|
728
|
+
const res = await ucListUcContacts(unifiedTo, {
|
|
729
|
+
connectionId: "<id>",
|
|
730
|
+
});
|
|
731
|
+
|
|
732
|
+
if (!res.ok) {
|
|
733
|
+
throw res.error;
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
const { value: result } = res;
|
|
737
|
+
|
|
738
|
+
// Handle the result
|
|
739
|
+
console.log(result);
|
|
740
|
+
}
|
|
741
|
+
|
|
742
|
+
run();
|
|
743
|
+
```
|
|
744
|
+
|
|
745
|
+
### Parameters
|
|
746
|
+
|
|
747
|
+
| Parameter | Type | Required | Description |
|
|
748
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
749
|
+
| `request` | [operations.ListUcContactsRequest](../../sdk/models/operations/listuccontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
750
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
751
|
+
| `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. |
|
|
752
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
753
|
+
|
|
754
|
+
### Response
|
|
755
|
+
|
|
756
|
+
**Promise\<[shared.UcContact[]](../../models/.md)\>**
|
|
757
|
+
|
|
758
|
+
### Errors
|
|
759
|
+
|
|
760
|
+
| Error Type | Status Code | Content Type |
|
|
761
|
+
| --------------- | --------------- | --------------- |
|
|
762
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
763
|
+
|
|
764
|
+
## listUcRecordings
|
|
765
|
+
|
|
766
|
+
List all recordings
|
|
767
|
+
|
|
768
|
+
### Example Usage
|
|
769
|
+
|
|
770
|
+
```typescript
|
|
771
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
772
|
+
|
|
773
|
+
const unifiedTo = new UnifiedTo({
|
|
774
|
+
security: {
|
|
775
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
776
|
+
},
|
|
777
|
+
});
|
|
778
|
+
|
|
779
|
+
async function run() {
|
|
780
|
+
const result = await unifiedTo.uc.listUcRecordings({
|
|
781
|
+
connectionId: "<id>",
|
|
782
|
+
});
|
|
783
|
+
|
|
784
|
+
// Handle the result
|
|
785
|
+
console.log(result);
|
|
786
|
+
}
|
|
787
|
+
|
|
788
|
+
run();
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
### Standalone function
|
|
792
|
+
|
|
793
|
+
The standalone function version of this method:
|
|
794
|
+
|
|
795
|
+
```typescript
|
|
796
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
797
|
+
import { ucListUcRecordings } from "@unified-api/typescript-sdk/funcs/ucListUcRecordings.js";
|
|
798
|
+
|
|
799
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
800
|
+
// You can create one instance of it to use across an application.
|
|
801
|
+
const unifiedTo = new UnifiedToCore({
|
|
802
|
+
security: {
|
|
803
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
804
|
+
},
|
|
805
|
+
});
|
|
806
|
+
|
|
807
|
+
async function run() {
|
|
808
|
+
const res = await ucListUcRecordings(unifiedTo, {
|
|
809
|
+
connectionId: "<id>",
|
|
810
|
+
});
|
|
811
|
+
|
|
812
|
+
if (!res.ok) {
|
|
813
|
+
throw res.error;
|
|
814
|
+
}
|
|
815
|
+
|
|
816
|
+
const { value: result } = res;
|
|
817
|
+
|
|
818
|
+
// Handle the result
|
|
819
|
+
console.log(result);
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
run();
|
|
823
|
+
```
|
|
824
|
+
|
|
825
|
+
### Parameters
|
|
826
|
+
|
|
827
|
+
| Parameter | Type | Required | Description |
|
|
828
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
829
|
+
| `request` | [operations.ListUcRecordingsRequest](../../sdk/models/operations/listucrecordingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
830
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
831
|
+
| `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. |
|
|
832
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
833
|
+
|
|
834
|
+
### Response
|
|
835
|
+
|
|
836
|
+
**Promise\<[shared.UcRecording[]](../../models/.md)\>**
|
|
837
|
+
|
|
838
|
+
### Errors
|
|
839
|
+
|
|
840
|
+
| Error Type | Status Code | Content Type |
|
|
841
|
+
| --------------- | --------------- | --------------- |
|
|
842
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
843
|
+
|
|
844
|
+
## patchUcComment
|
|
845
|
+
|
|
846
|
+
Update a comment
|
|
19
847
|
|
|
20
848
|
### Example Usage
|
|
21
849
|
|
|
@@ -29,9 +857,98 @@ const unifiedTo = new UnifiedTo({
|
|
|
29
857
|
});
|
|
30
858
|
|
|
31
859
|
async function run() {
|
|
32
|
-
const result = await unifiedTo.uc.
|
|
860
|
+
const result = await unifiedTo.uc.patchUcComment({
|
|
861
|
+
ucComment: {
|
|
862
|
+
content: "<value>",
|
|
863
|
+
},
|
|
864
|
+
connectionId: "<id>",
|
|
865
|
+
id: "<id>",
|
|
866
|
+
});
|
|
867
|
+
|
|
868
|
+
// Handle the result
|
|
869
|
+
console.log(result);
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
run();
|
|
873
|
+
```
|
|
874
|
+
|
|
875
|
+
### Standalone function
|
|
876
|
+
|
|
877
|
+
The standalone function version of this method:
|
|
878
|
+
|
|
879
|
+
```typescript
|
|
880
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
881
|
+
import { ucPatchUcComment } from "@unified-api/typescript-sdk/funcs/ucPatchUcComment.js";
|
|
882
|
+
|
|
883
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
884
|
+
// You can create one instance of it to use across an application.
|
|
885
|
+
const unifiedTo = new UnifiedToCore({
|
|
886
|
+
security: {
|
|
887
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
888
|
+
},
|
|
889
|
+
});
|
|
890
|
+
|
|
891
|
+
async function run() {
|
|
892
|
+
const res = await ucPatchUcComment(unifiedTo, {
|
|
893
|
+
ucComment: {
|
|
894
|
+
content: "<value>",
|
|
895
|
+
},
|
|
896
|
+
connectionId: "<id>",
|
|
897
|
+
id: "<id>",
|
|
898
|
+
});
|
|
899
|
+
|
|
900
|
+
if (!res.ok) {
|
|
901
|
+
throw res.error;
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
const { value: result } = res;
|
|
905
|
+
|
|
906
|
+
// Handle the result
|
|
907
|
+
console.log(result);
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
run();
|
|
911
|
+
```
|
|
912
|
+
|
|
913
|
+
### Parameters
|
|
914
|
+
|
|
915
|
+
| Parameter | Type | Required | Description |
|
|
916
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
917
|
+
| `request` | [operations.PatchUcCommentRequest](../../sdk/models/operations/patchuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
918
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
919
|
+
| `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. |
|
|
920
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
921
|
+
|
|
922
|
+
### Response
|
|
923
|
+
|
|
924
|
+
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
925
|
+
|
|
926
|
+
### Errors
|
|
927
|
+
|
|
928
|
+
| Error Type | Status Code | Content Type |
|
|
929
|
+
| --------------- | --------------- | --------------- |
|
|
930
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
931
|
+
|
|
932
|
+
## patchUcContact
|
|
933
|
+
|
|
934
|
+
Update a contact
|
|
935
|
+
|
|
936
|
+
### Example Usage
|
|
937
|
+
|
|
938
|
+
```typescript
|
|
939
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
940
|
+
|
|
941
|
+
const unifiedTo = new UnifiedTo({
|
|
942
|
+
security: {
|
|
943
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
944
|
+
},
|
|
945
|
+
});
|
|
946
|
+
|
|
947
|
+
async function run() {
|
|
948
|
+
const result = await unifiedTo.uc.patchUcContact({
|
|
33
949
|
ucContact: {},
|
|
34
950
|
connectionId: "<id>",
|
|
951
|
+
id: "<id>",
|
|
35
952
|
});
|
|
36
953
|
|
|
37
954
|
// Handle the result
|
|
@@ -47,7 +964,7 @@ The standalone function version of this method:
|
|
|
47
964
|
|
|
48
965
|
```typescript
|
|
49
966
|
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
50
|
-
import {
|
|
967
|
+
import { ucPatchUcContact } from "@unified-api/typescript-sdk/funcs/ucPatchUcContact.js";
|
|
51
968
|
|
|
52
969
|
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
53
970
|
// You can create one instance of it to use across an application.
|
|
@@ -58,9 +975,10 @@ const unifiedTo = new UnifiedToCore({
|
|
|
58
975
|
});
|
|
59
976
|
|
|
60
977
|
async function run() {
|
|
61
|
-
const res = await
|
|
978
|
+
const res = await ucPatchUcContact(unifiedTo, {
|
|
62
979
|
ucContact: {},
|
|
63
980
|
connectionId: "<id>",
|
|
981
|
+
id: "<id>",
|
|
64
982
|
});
|
|
65
983
|
|
|
66
984
|
if (!res.ok) {
|
|
@@ -80,7 +998,7 @@ run();
|
|
|
80
998
|
|
|
81
999
|
| Parameter | Type | Required | Description |
|
|
82
1000
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
83
|
-
| `request` | [operations.
|
|
1001
|
+
| `request` | [operations.PatchUcContactRequest](../../sdk/models/operations/patchuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
84
1002
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
85
1003
|
| `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. |
|
|
86
1004
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -95,9 +1013,9 @@ run();
|
|
|
95
1013
|
| --------------- | --------------- | --------------- |
|
|
96
1014
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
97
1015
|
|
|
98
|
-
##
|
|
1016
|
+
## patchUcRecording
|
|
99
1017
|
|
|
100
|
-
|
|
1018
|
+
Update a recording
|
|
101
1019
|
|
|
102
1020
|
### Example Usage
|
|
103
1021
|
|
|
@@ -111,7 +1029,8 @@ const unifiedTo = new UnifiedTo({
|
|
|
111
1029
|
});
|
|
112
1030
|
|
|
113
1031
|
async function run() {
|
|
114
|
-
const result = await unifiedTo.uc.
|
|
1032
|
+
const result = await unifiedTo.uc.patchUcRecording({
|
|
1033
|
+
ucRecording: {},
|
|
115
1034
|
connectionId: "<id>",
|
|
116
1035
|
id: "<id>",
|
|
117
1036
|
});
|
|
@@ -129,7 +1048,7 @@ The standalone function version of this method:
|
|
|
129
1048
|
|
|
130
1049
|
```typescript
|
|
131
1050
|
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
132
|
-
import {
|
|
1051
|
+
import { ucPatchUcRecording } from "@unified-api/typescript-sdk/funcs/ucPatchUcRecording.js";
|
|
133
1052
|
|
|
134
1053
|
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
135
1054
|
// You can create one instance of it to use across an application.
|
|
@@ -140,7 +1059,8 @@ const unifiedTo = new UnifiedToCore({
|
|
|
140
1059
|
});
|
|
141
1060
|
|
|
142
1061
|
async function run() {
|
|
143
|
-
const res = await
|
|
1062
|
+
const res = await ucPatchUcRecording(unifiedTo, {
|
|
1063
|
+
ucRecording: {},
|
|
144
1064
|
connectionId: "<id>",
|
|
145
1065
|
id: "<id>",
|
|
146
1066
|
});
|
|
@@ -162,14 +1082,14 @@ run();
|
|
|
162
1082
|
|
|
163
1083
|
| Parameter | Type | Required | Description |
|
|
164
1084
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
165
|
-
| `request` | [operations.
|
|
1085
|
+
| `request` | [operations.PatchUcRecordingRequest](../../sdk/models/operations/patchucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
166
1086
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
167
1087
|
| `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. |
|
|
168
1088
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
169
1089
|
|
|
170
1090
|
### Response
|
|
171
1091
|
|
|
172
|
-
**Promise\<[shared.
|
|
1092
|
+
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
173
1093
|
|
|
174
1094
|
### Errors
|
|
175
1095
|
|
|
@@ -177,9 +1097,9 @@ run();
|
|
|
177
1097
|
| --------------- | --------------- | --------------- |
|
|
178
1098
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
179
1099
|
|
|
180
|
-
##
|
|
1100
|
+
## removeUcComment
|
|
181
1101
|
|
|
182
|
-
|
|
1102
|
+
Remove a comment
|
|
183
1103
|
|
|
184
1104
|
### Example Usage
|
|
185
1105
|
|
|
@@ -193,8 +1113,9 @@ const unifiedTo = new UnifiedTo({
|
|
|
193
1113
|
});
|
|
194
1114
|
|
|
195
1115
|
async function run() {
|
|
196
|
-
const result = await unifiedTo.uc.
|
|
1116
|
+
const result = await unifiedTo.uc.removeUcComment({
|
|
197
1117
|
connectionId: "<id>",
|
|
1118
|
+
id: "<id>",
|
|
198
1119
|
});
|
|
199
1120
|
|
|
200
1121
|
// Handle the result
|
|
@@ -210,7 +1131,7 @@ The standalone function version of this method:
|
|
|
210
1131
|
|
|
211
1132
|
```typescript
|
|
212
1133
|
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
213
|
-
import {
|
|
1134
|
+
import { ucRemoveUcComment } from "@unified-api/typescript-sdk/funcs/ucRemoveUcComment.js";
|
|
214
1135
|
|
|
215
1136
|
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
216
1137
|
// You can create one instance of it to use across an application.
|
|
@@ -221,8 +1142,9 @@ const unifiedTo = new UnifiedToCore({
|
|
|
221
1142
|
});
|
|
222
1143
|
|
|
223
1144
|
async function run() {
|
|
224
|
-
const res = await
|
|
1145
|
+
const res = await ucRemoveUcComment(unifiedTo, {
|
|
225
1146
|
connectionId: "<id>",
|
|
1147
|
+
id: "<id>",
|
|
226
1148
|
});
|
|
227
1149
|
|
|
228
1150
|
if (!res.ok) {
|
|
@@ -242,14 +1164,14 @@ run();
|
|
|
242
1164
|
|
|
243
1165
|
| Parameter | Type | Required | Description |
|
|
244
1166
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
245
|
-
| `request` | [operations.
|
|
1167
|
+
| `request` | [operations.RemoveUcCommentRequest](../../sdk/models/operations/removeuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
246
1168
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
247
1169
|
| `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. |
|
|
248
1170
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
249
1171
|
|
|
250
1172
|
### Response
|
|
251
1173
|
|
|
252
|
-
**Promise\<[
|
|
1174
|
+
**Promise\<[operations.RemoveUcCommentResponse](../../sdk/models/operations/removeuccommentresponse.md)\>**
|
|
253
1175
|
|
|
254
1176
|
### Errors
|
|
255
1177
|
|
|
@@ -257,9 +1179,9 @@ run();
|
|
|
257
1179
|
| --------------- | --------------- | --------------- |
|
|
258
1180
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
259
1181
|
|
|
260
|
-
##
|
|
1182
|
+
## removeUcContact
|
|
261
1183
|
|
|
262
|
-
|
|
1184
|
+
Remove a contact
|
|
263
1185
|
|
|
264
1186
|
### Example Usage
|
|
265
1187
|
|
|
@@ -273,8 +1195,9 @@ const unifiedTo = new UnifiedTo({
|
|
|
273
1195
|
});
|
|
274
1196
|
|
|
275
1197
|
async function run() {
|
|
276
|
-
const result = await unifiedTo.uc.
|
|
1198
|
+
const result = await unifiedTo.uc.removeUcContact({
|
|
277
1199
|
connectionId: "<id>",
|
|
1200
|
+
id: "<id>",
|
|
278
1201
|
});
|
|
279
1202
|
|
|
280
1203
|
// Handle the result
|
|
@@ -290,7 +1213,7 @@ The standalone function version of this method:
|
|
|
290
1213
|
|
|
291
1214
|
```typescript
|
|
292
1215
|
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
293
|
-
import {
|
|
1216
|
+
import { ucRemoveUcContact } from "@unified-api/typescript-sdk/funcs/ucRemoveUcContact.js";
|
|
294
1217
|
|
|
295
1218
|
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
296
1219
|
// You can create one instance of it to use across an application.
|
|
@@ -301,8 +1224,9 @@ const unifiedTo = new UnifiedToCore({
|
|
|
301
1224
|
});
|
|
302
1225
|
|
|
303
1226
|
async function run() {
|
|
304
|
-
const res = await
|
|
1227
|
+
const res = await ucRemoveUcContact(unifiedTo, {
|
|
305
1228
|
connectionId: "<id>",
|
|
1229
|
+
id: "<id>",
|
|
306
1230
|
});
|
|
307
1231
|
|
|
308
1232
|
if (!res.ok) {
|
|
@@ -322,14 +1246,14 @@ run();
|
|
|
322
1246
|
|
|
323
1247
|
| Parameter | Type | Required | Description |
|
|
324
1248
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
325
|
-
| `request` | [operations.
|
|
1249
|
+
| `request` | [operations.RemoveUcContactRequest](../../sdk/models/operations/removeuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
326
1250
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
327
1251
|
| `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. |
|
|
328
1252
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
329
1253
|
|
|
330
1254
|
### Response
|
|
331
1255
|
|
|
332
|
-
**Promise\<[
|
|
1256
|
+
**Promise\<[operations.RemoveUcContactResponse](../../sdk/models/operations/removeuccontactresponse.md)\>**
|
|
333
1257
|
|
|
334
1258
|
### Errors
|
|
335
1259
|
|
|
@@ -337,9 +1261,9 @@ run();
|
|
|
337
1261
|
| --------------- | --------------- | --------------- |
|
|
338
1262
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
339
1263
|
|
|
340
|
-
##
|
|
1264
|
+
## removeUcRecording
|
|
341
1265
|
|
|
342
|
-
|
|
1266
|
+
Remove a recording
|
|
343
1267
|
|
|
344
1268
|
### Example Usage
|
|
345
1269
|
|
|
@@ -353,8 +1277,7 @@ const unifiedTo = new UnifiedTo({
|
|
|
353
1277
|
});
|
|
354
1278
|
|
|
355
1279
|
async function run() {
|
|
356
|
-
const result = await unifiedTo.uc.
|
|
357
|
-
ucContact: {},
|
|
1280
|
+
const result = await unifiedTo.uc.removeUcRecording({
|
|
358
1281
|
connectionId: "<id>",
|
|
359
1282
|
id: "<id>",
|
|
360
1283
|
});
|
|
@@ -372,7 +1295,7 @@ The standalone function version of this method:
|
|
|
372
1295
|
|
|
373
1296
|
```typescript
|
|
374
1297
|
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
375
|
-
import {
|
|
1298
|
+
import { ucRemoveUcRecording } from "@unified-api/typescript-sdk/funcs/ucRemoveUcRecording.js";
|
|
376
1299
|
|
|
377
1300
|
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
378
1301
|
// You can create one instance of it to use across an application.
|
|
@@ -383,8 +1306,7 @@ const unifiedTo = new UnifiedToCore({
|
|
|
383
1306
|
});
|
|
384
1307
|
|
|
385
1308
|
async function run() {
|
|
386
|
-
const res = await
|
|
387
|
-
ucContact: {},
|
|
1309
|
+
const res = await ucRemoveUcRecording(unifiedTo, {
|
|
388
1310
|
connectionId: "<id>",
|
|
389
1311
|
id: "<id>",
|
|
390
1312
|
});
|
|
@@ -406,14 +1328,14 @@ run();
|
|
|
406
1328
|
|
|
407
1329
|
| Parameter | Type | Required | Description |
|
|
408
1330
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
409
|
-
| `request` | [operations.
|
|
1331
|
+
| `request` | [operations.RemoveUcRecordingRequest](../../sdk/models/operations/removeucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
410
1332
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
411
1333
|
| `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. |
|
|
412
1334
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
413
1335
|
|
|
414
1336
|
### Response
|
|
415
1337
|
|
|
416
|
-
**Promise\<[
|
|
1338
|
+
**Promise\<[operations.RemoveUcRecordingResponse](../../sdk/models/operations/removeucrecordingresponse.md)\>**
|
|
417
1339
|
|
|
418
1340
|
### Errors
|
|
419
1341
|
|
|
@@ -421,9 +1343,9 @@ run();
|
|
|
421
1343
|
| --------------- | --------------- | --------------- |
|
|
422
1344
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
423
1345
|
|
|
424
|
-
##
|
|
1346
|
+
## updateUcComment
|
|
425
1347
|
|
|
426
|
-
|
|
1348
|
+
Update a comment
|
|
427
1349
|
|
|
428
1350
|
### Example Usage
|
|
429
1351
|
|
|
@@ -437,7 +1359,10 @@ const unifiedTo = new UnifiedTo({
|
|
|
437
1359
|
});
|
|
438
1360
|
|
|
439
1361
|
async function run() {
|
|
440
|
-
const result = await unifiedTo.uc.
|
|
1362
|
+
const result = await unifiedTo.uc.updateUcComment({
|
|
1363
|
+
ucComment: {
|
|
1364
|
+
content: "<value>",
|
|
1365
|
+
},
|
|
441
1366
|
connectionId: "<id>",
|
|
442
1367
|
id: "<id>",
|
|
443
1368
|
});
|
|
@@ -455,7 +1380,7 @@ The standalone function version of this method:
|
|
|
455
1380
|
|
|
456
1381
|
```typescript
|
|
457
1382
|
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
458
|
-
import {
|
|
1383
|
+
import { ucUpdateUcComment } from "@unified-api/typescript-sdk/funcs/ucUpdateUcComment.js";
|
|
459
1384
|
|
|
460
1385
|
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
461
1386
|
// You can create one instance of it to use across an application.
|
|
@@ -466,7 +1391,10 @@ const unifiedTo = new UnifiedToCore({
|
|
|
466
1391
|
});
|
|
467
1392
|
|
|
468
1393
|
async function run() {
|
|
469
|
-
const res = await
|
|
1394
|
+
const res = await ucUpdateUcComment(unifiedTo, {
|
|
1395
|
+
ucComment: {
|
|
1396
|
+
content: "<value>",
|
|
1397
|
+
},
|
|
470
1398
|
connectionId: "<id>",
|
|
471
1399
|
id: "<id>",
|
|
472
1400
|
});
|
|
@@ -488,14 +1416,14 @@ run();
|
|
|
488
1416
|
|
|
489
1417
|
| Parameter | Type | Required | Description |
|
|
490
1418
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
491
|
-
| `request` | [operations.
|
|
1419
|
+
| `request` | [operations.UpdateUcCommentRequest](../../sdk/models/operations/updateuccommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
492
1420
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
493
1421
|
| `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. |
|
|
494
1422
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
495
1423
|
|
|
496
1424
|
### Response
|
|
497
1425
|
|
|
498
|
-
**Promise\<[
|
|
1426
|
+
**Promise\<[shared.UcComment](../../sdk/models/shared/uccomment.md)\>**
|
|
499
1427
|
|
|
500
1428
|
### Errors
|
|
501
1429
|
|
|
@@ -583,6 +1511,90 @@ run();
|
|
|
583
1511
|
|
|
584
1512
|
### Errors
|
|
585
1513
|
|
|
1514
|
+
| Error Type | Status Code | Content Type |
|
|
1515
|
+
| --------------- | --------------- | --------------- |
|
|
1516
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1517
|
+
|
|
1518
|
+
## updateUcRecording
|
|
1519
|
+
|
|
1520
|
+
Update a recording
|
|
1521
|
+
|
|
1522
|
+
### Example Usage
|
|
1523
|
+
|
|
1524
|
+
```typescript
|
|
1525
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1526
|
+
|
|
1527
|
+
const unifiedTo = new UnifiedTo({
|
|
1528
|
+
security: {
|
|
1529
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1530
|
+
},
|
|
1531
|
+
});
|
|
1532
|
+
|
|
1533
|
+
async function run() {
|
|
1534
|
+
const result = await unifiedTo.uc.updateUcRecording({
|
|
1535
|
+
ucRecording: {},
|
|
1536
|
+
connectionId: "<id>",
|
|
1537
|
+
id: "<id>",
|
|
1538
|
+
});
|
|
1539
|
+
|
|
1540
|
+
// Handle the result
|
|
1541
|
+
console.log(result);
|
|
1542
|
+
}
|
|
1543
|
+
|
|
1544
|
+
run();
|
|
1545
|
+
```
|
|
1546
|
+
|
|
1547
|
+
### Standalone function
|
|
1548
|
+
|
|
1549
|
+
The standalone function version of this method:
|
|
1550
|
+
|
|
1551
|
+
```typescript
|
|
1552
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1553
|
+
import { ucUpdateUcRecording } from "@unified-api/typescript-sdk/funcs/ucUpdateUcRecording.js";
|
|
1554
|
+
|
|
1555
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1556
|
+
// You can create one instance of it to use across an application.
|
|
1557
|
+
const unifiedTo = new UnifiedToCore({
|
|
1558
|
+
security: {
|
|
1559
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1560
|
+
},
|
|
1561
|
+
});
|
|
1562
|
+
|
|
1563
|
+
async function run() {
|
|
1564
|
+
const res = await ucUpdateUcRecording(unifiedTo, {
|
|
1565
|
+
ucRecording: {},
|
|
1566
|
+
connectionId: "<id>",
|
|
1567
|
+
id: "<id>",
|
|
1568
|
+
});
|
|
1569
|
+
|
|
1570
|
+
if (!res.ok) {
|
|
1571
|
+
throw res.error;
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
const { value: result } = res;
|
|
1575
|
+
|
|
1576
|
+
// Handle the result
|
|
1577
|
+
console.log(result);
|
|
1578
|
+
}
|
|
1579
|
+
|
|
1580
|
+
run();
|
|
1581
|
+
```
|
|
1582
|
+
|
|
1583
|
+
### Parameters
|
|
1584
|
+
|
|
1585
|
+
| Parameter | Type | Required | Description |
|
|
1586
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1587
|
+
| `request` | [operations.UpdateUcRecordingRequest](../../sdk/models/operations/updateucrecordingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1588
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1589
|
+
| `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. |
|
|
1590
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1591
|
+
|
|
1592
|
+
### Response
|
|
1593
|
+
|
|
1594
|
+
**Promise\<[shared.UcRecording](../../sdk/models/shared/ucrecording.md)\>**
|
|
1595
|
+
|
|
1596
|
+
### Errors
|
|
1597
|
+
|
|
586
1598
|
| Error Type | Status Code | Content Type |
|
|
587
1599
|
| --------------- | --------------- | --------------- |
|
|
588
1600
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|