@unified-api/typescript-sdk 2.79.0 → 2.80.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/examples/package-lock.json +1 -1
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +3 -3
  4. package/lib/config.js +3 -3
  5. package/package.json +1 -1
  6. package/sdk/models/shared/calendareventrecurrence.d.ts +2 -5
  7. package/sdk/models/shared/calendareventrecurrence.d.ts.map +1 -1
  8. package/sdk/models/shared/calendareventrecurrence.js +2 -2
  9. package/sdk/models/shared/calendareventrecurrence.js.map +1 -1
  10. package/sdk/models/shared/index.d.ts +5 -0
  11. package/sdk/models/shared/index.d.ts.map +1 -1
  12. package/sdk/models/shared/index.js +5 -0
  13. package/sdk/models/shared/index.js.map +1 -1
  14. package/sdk/models/shared/integration.d.ts +3 -2
  15. package/sdk/models/shared/integration.d.ts.map +1 -1
  16. package/sdk/models/shared/integration.js +3 -2
  17. package/sdk/models/shared/integration.js.map +1 -1
  18. package/sdk/models/shared/integrationsupport.d.ts +2410 -0
  19. package/sdk/models/shared/integrationsupport.d.ts.map +1 -0
  20. package/sdk/models/shared/integrationsupport.js +3440 -0
  21. package/sdk/models/shared/integrationsupport.js.map +1 -0
  22. package/sdk/models/shared/kmspage.d.ts +2 -0
  23. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  24. package/sdk/models/shared/kmspage.js +4 -0
  25. package/sdk/models/shared/kmspage.js.map +1 -1
  26. package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts +36 -0
  27. package/sdk/models/shared/propertyintegrationsupportwebhookevents.d.ts.map +1 -0
  28. package/sdk/models/shared/propertyintegrationsupportwebhookevents.js +79 -0
  29. package/sdk/models/shared/propertyintegrationsupportwebhookevents.js.map +1 -0
  30. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts +22 -0
  31. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.d.ts.map +1 -0
  32. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js +68 -0
  33. package/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.js.map +1 -0
  34. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts +22 -0
  35. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.d.ts.map +1 -0
  36. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js +68 -0
  37. package/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.js.map +1 -0
  38. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts +22 -0
  39. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.d.ts.map +1 -0
  40. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js +68 -0
  41. package/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.js.map +1 -0
  42. package/sdk/models/shared/webhook.d.ts +2 -2
  43. package/sdk/models/shared/webhook.d.ts.map +1 -1
  44. package/sdk/models/shared/webhook.js +2 -2
  45. package/sdk/models/shared/webhook.js.map +1 -1
  46. package/src/lib/config.ts +3 -3
  47. package/src/sdk/models/shared/calendareventrecurrence.ts +4 -7
  48. package/src/sdk/models/shared/index.ts +5 -0
  49. package/src/sdk/models/shared/integration.ts +10 -4
  50. package/src/sdk/models/shared/integrationsupport.ts +4969 -0
  51. package/src/sdk/models/shared/kmspage.ts +6 -0
  52. package/src/sdk/models/shared/propertyintegrationsupportwebhookevents.ts +109 -0
  53. package/src/sdk/models/shared/propertyintegrationsupportwebhookeventscreated.ts +54 -0
  54. package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsdeleted.ts +54 -0
  55. package/src/sdk/models/shared/propertyintegrationsupportwebhookeventsupdated.ts +54 -0
  56. package/src/sdk/models/shared/webhook.ts +4 -4
  57. package/docs/sdks/account/README.md +0 -489
  58. package/docs/sdks/accounting/README.md +0 -7221
  59. package/docs/sdks/activity/README.md +0 -489
  60. package/docs/sdks/apicall/README.md +0 -159
  61. package/docs/sdks/application/README.md +0 -489
  62. package/docs/sdks/applicationstatus/README.md +0 -85
  63. package/docs/sdks/ats/README.md +0 -3953
  64. package/docs/sdks/auth/README.md +0 -167
  65. package/docs/sdks/balancesheet/README.md +0 -165
  66. package/docs/sdks/bill/README.md +0 -489
  67. package/docs/sdks/branch/README.md +0 -507
  68. package/docs/sdks/busy/README.md +0 -85
  69. package/docs/sdks/calendar/README.md +0 -1713
  70. package/docs/sdks/call/README.md +0 -85
  71. package/docs/sdks/candidate/README.md +0 -489
  72. package/docs/sdks/cashflow/README.md +0 -165
  73. package/docs/sdks/category/README.md +0 -971
  74. package/docs/sdks/change/README.md +0 -165
  75. package/docs/sdks/channel/README.md +0 -165
  76. package/docs/sdks/class/README.md +0 -507
  77. package/docs/sdks/collection/README.md +0 -501
  78. package/docs/sdks/comment/README.md +0 -1495
  79. package/docs/sdks/commerce/README.md +0 -2465
  80. package/docs/sdks/commit/README.md +0 -501
  81. package/docs/sdks/company/README.md +0 -1543
  82. package/docs/sdks/connection/README.md +0 -513
  83. package/docs/sdks/contact/README.md +0 -1453
  84. package/docs/sdks/course/README.md +0 -501
  85. package/docs/sdks/creditmemo/README.md +0 -489
  86. package/docs/sdks/crm/README.md +0 -2899
  87. package/docs/sdks/customer/README.md +0 -489
  88. package/docs/sdks/deal/README.md +0 -489
  89. package/docs/sdks/device/README.md +0 -501
  90. package/docs/sdks/document/README.md +0 -489
  91. package/docs/sdks/embedding/README.md +0 -87
  92. package/docs/sdks/employee/README.md +0 -489
  93. package/docs/sdks/enrich/README.md +0 -163
  94. package/docs/sdks/event/README.md +0 -971
  95. package/docs/sdks/expense/README.md +0 -489
  96. package/docs/sdks/file/README.md +0 -489
  97. package/docs/sdks/genai/README.md +0 -325
  98. package/docs/sdks/group/README.md +0 -983
  99. package/docs/sdks/hris/README.md +0 -3251
  100. package/docs/sdks/instructor/README.md +0 -489
  101. package/docs/sdks/integration/README.md +0 -239
  102. package/docs/sdks/interview/README.md +0 -489
  103. package/docs/sdks/inventory/README.md +0 -501
  104. package/docs/sdks/invoice/README.md +0 -489
  105. package/docs/sdks/issue/README.md +0 -159
  106. package/docs/sdks/item/README.md +0 -489
  107. package/docs/sdks/job/README.md +0 -489
  108. package/docs/sdks/journal/README.md +0 -489
  109. package/docs/sdks/kms/README.md +0 -1495
  110. package/docs/sdks/lead/README.md +0 -489
  111. package/docs/sdks/link/README.md +0 -983
  112. package/docs/sdks/list/README.md +0 -489
  113. package/docs/sdks/lms/README.md +0 -1965
  114. package/docs/sdks/location/README.md +0 -983
  115. package/docs/sdks/login/README.md +0 -87
  116. package/docs/sdks/martech/README.md +0 -971
  117. package/docs/sdks/member/README.md +0 -489
  118. package/docs/sdks/message/README.md +0 -489
  119. package/docs/sdks/messaging/README.md +0 -647
  120. package/docs/sdks/metadata/README.md +0 -507
  121. package/docs/sdks/model/README.md +0 -165
  122. package/docs/sdks/note/README.md +0 -489
  123. package/docs/sdks/order/README.md +0 -489
  124. package/docs/sdks/organization/README.md +0 -647
  125. package/docs/sdks/package/README.md +0 -165
  126. package/docs/sdks/page/README.md +0 -507
  127. package/docs/sdks/passthrough/README.md +0 -647
  128. package/docs/sdks/payment/README.md +0 -1769
  129. package/docs/sdks/payout/README.md +0 -165
  130. package/docs/sdks/payslip/README.md +0 -165
  131. package/docs/sdks/person/README.md +0 -85
  132. package/docs/sdks/pipeline/README.md +0 -489
  133. package/docs/sdks/profitloss/README.md +0 -165
  134. package/docs/sdks/project/README.md +0 -489
  135. package/docs/sdks/prompt/README.md +0 -87
  136. package/docs/sdks/pullrequest/README.md +0 -489
  137. package/docs/sdks/purchaseorder/README.md +0 -489
  138. package/docs/sdks/recording/README.md +0 -647
  139. package/docs/sdks/refund/README.md +0 -165
  140. package/docs/sdks/repo/README.md +0 -2459
  141. package/docs/sdks/report/README.md +0 -165
  142. package/docs/sdks/repository/README.md +0 -501
  143. package/docs/sdks/request/README.md +0 -489
  144. package/docs/sdks/review/README.md +0 -501
  145. package/docs/sdks/salesorder/README.md +0 -489
  146. package/docs/sdks/scim/README.md +0 -983
  147. package/docs/sdks/scorecard/README.md +0 -489
  148. package/docs/sdks/space/README.md +0 -501
  149. package/docs/sdks/storage/README.md +0 -489
  150. package/docs/sdks/student/README.md +0 -489
  151. package/docs/sdks/subscription/README.md +0 -489
  152. package/docs/sdks/task/README.md +0 -1629
  153. package/docs/sdks/taxrate/README.md +0 -489
  154. package/docs/sdks/ticket/README.md +0 -489
  155. package/docs/sdks/ticketing/README.md +0 -1935
  156. package/docs/sdks/timeoff/README.md +0 -165
  157. package/docs/sdks/timeshift/README.md +0 -513
  158. package/docs/sdks/transaction/README.md +0 -489
  159. package/docs/sdks/trialbalance/README.md +0 -165
  160. package/docs/sdks/uc/README.md +0 -1543
  161. package/docs/sdks/unified/README.md +0 -1697
  162. package/docs/sdks/user/README.md +0 -489
  163. package/docs/sdks/verification/README.md +0 -647
  164. package/docs/sdks/webhook/README.md +0 -655
  165. package/examples/README.md +0 -31
@@ -1,647 +0,0 @@
1
- # Messaging
2
- (*messaging*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createMessagingMessage](#createmessagingmessage) - Create a message
9
- * [getMessagingChannel](#getmessagingchannel) - Retrieve a channel
10
- * [getMessagingMessage](#getmessagingmessage) - Retrieve a message
11
- * [listMessagingChannels](#listmessagingchannels) - List all channels
12
- * [listMessagingMessages](#listmessagingmessages) - List all messages
13
- * [patchMessagingMessage](#patchmessagingmessage) - Update a message
14
- * [removeMessagingMessage](#removemessagingmessage) - Remove a message
15
- * [updateMessagingMessage](#updatemessagingmessage) - Update a message
16
-
17
- ## createMessagingMessage
18
-
19
- Create a message
20
-
21
- ### Example Usage
22
-
23
- <!-- UsageSnippet language="typescript" operationID="createMessagingMessage" method="post" path="/messaging/{connection_id}/message" -->
24
- ```typescript
25
- import { UnifiedTo } from "@unified-api/typescript-sdk";
26
-
27
- const unifiedTo = new UnifiedTo({
28
- security: {
29
- jwt: "<YOUR_API_KEY_HERE>",
30
- },
31
- });
32
-
33
- async function run() {
34
- const result = await unifiedTo.messaging.createMessagingMessage({
35
- messagingMessage: {},
36
- connectionId: "<id>",
37
- });
38
-
39
- console.log(result);
40
- }
41
-
42
- run();
43
- ```
44
-
45
- ### Standalone function
46
-
47
- The standalone function version of this method:
48
-
49
- ```typescript
50
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
51
- import { messagingCreateMessagingMessage } from "@unified-api/typescript-sdk/funcs/messagingCreateMessagingMessage.js";
52
-
53
- // Use `UnifiedToCore` for best tree-shaking performance.
54
- // You can create one instance of it to use across an application.
55
- const unifiedTo = new UnifiedToCore({
56
- security: {
57
- jwt: "<YOUR_API_KEY_HERE>",
58
- },
59
- });
60
-
61
- async function run() {
62
- const res = await messagingCreateMessagingMessage(unifiedTo, {
63
- messagingMessage: {},
64
- connectionId: "<id>",
65
- });
66
- if (res.ok) {
67
- const { value: result } = res;
68
- console.log(result);
69
- } else {
70
- console.log("messagingCreateMessagingMessage failed:", res.error);
71
- }
72
- }
73
-
74
- run();
75
- ```
76
-
77
- ### Parameters
78
-
79
- | Parameter | Type | Required | Description |
80
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81
- | `request` | [operations.CreateMessagingMessageRequest](../../sdk/models/operations/createmessagingmessagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
82
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
83
- | `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. |
84
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
85
-
86
- ### Response
87
-
88
- **Promise\<[shared.MessagingMessage](../../sdk/models/shared/messagingmessage.md)\>**
89
-
90
- ### Errors
91
-
92
- | Error Type | Status Code | Content Type |
93
- | --------------- | --------------- | --------------- |
94
- | errors.SDKError | 4XX, 5XX | \*/\* |
95
-
96
- ## getMessagingChannel
97
-
98
- Retrieve a channel
99
-
100
- ### Example Usage
101
-
102
- <!-- UsageSnippet language="typescript" operationID="getMessagingChannel" method="get" path="/messaging/{connection_id}/channel/{id}" -->
103
- ```typescript
104
- import { UnifiedTo } from "@unified-api/typescript-sdk";
105
-
106
- const unifiedTo = new UnifiedTo({
107
- security: {
108
- jwt: "<YOUR_API_KEY_HERE>",
109
- },
110
- });
111
-
112
- async function run() {
113
- const result = await unifiedTo.messaging.getMessagingChannel({
114
- connectionId: "<id>",
115
- id: "<id>",
116
- });
117
-
118
- console.log(result);
119
- }
120
-
121
- run();
122
- ```
123
-
124
- ### Standalone function
125
-
126
- The standalone function version of this method:
127
-
128
- ```typescript
129
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
130
- import { messagingGetMessagingChannel } from "@unified-api/typescript-sdk/funcs/messagingGetMessagingChannel.js";
131
-
132
- // Use `UnifiedToCore` for best tree-shaking performance.
133
- // You can create one instance of it to use across an application.
134
- const unifiedTo = new UnifiedToCore({
135
- security: {
136
- jwt: "<YOUR_API_KEY_HERE>",
137
- },
138
- });
139
-
140
- async function run() {
141
- const res = await messagingGetMessagingChannel(unifiedTo, {
142
- connectionId: "<id>",
143
- id: "<id>",
144
- });
145
- if (res.ok) {
146
- const { value: result } = res;
147
- console.log(result);
148
- } else {
149
- console.log("messagingGetMessagingChannel failed:", res.error);
150
- }
151
- }
152
-
153
- run();
154
- ```
155
-
156
- ### Parameters
157
-
158
- | Parameter | Type | Required | Description |
159
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
160
- | `request` | [operations.GetMessagingChannelRequest](../../sdk/models/operations/getmessagingchannelrequest.md) | :heavy_check_mark: | The request object to use for the request. |
161
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
162
- | `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. |
163
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
164
-
165
- ### Response
166
-
167
- **Promise\<[shared.MessagingChannel](../../sdk/models/shared/messagingchannel.md)\>**
168
-
169
- ### Errors
170
-
171
- | Error Type | Status Code | Content Type |
172
- | --------------- | --------------- | --------------- |
173
- | errors.SDKError | 4XX, 5XX | \*/\* |
174
-
175
- ## getMessagingMessage
176
-
177
- Retrieve a message
178
-
179
- ### Example Usage
180
-
181
- <!-- UsageSnippet language="typescript" operationID="getMessagingMessage" method="get" path="/messaging/{connection_id}/message/{id}" -->
182
- ```typescript
183
- import { UnifiedTo } from "@unified-api/typescript-sdk";
184
-
185
- const unifiedTo = new UnifiedTo({
186
- security: {
187
- jwt: "<YOUR_API_KEY_HERE>",
188
- },
189
- });
190
-
191
- async function run() {
192
- const result = await unifiedTo.messaging.getMessagingMessage({
193
- connectionId: "<id>",
194
- id: "<id>",
195
- });
196
-
197
- console.log(result);
198
- }
199
-
200
- run();
201
- ```
202
-
203
- ### Standalone function
204
-
205
- The standalone function version of this method:
206
-
207
- ```typescript
208
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
209
- import { messagingGetMessagingMessage } from "@unified-api/typescript-sdk/funcs/messagingGetMessagingMessage.js";
210
-
211
- // Use `UnifiedToCore` for best tree-shaking performance.
212
- // You can create one instance of it to use across an application.
213
- const unifiedTo = new UnifiedToCore({
214
- security: {
215
- jwt: "<YOUR_API_KEY_HERE>",
216
- },
217
- });
218
-
219
- async function run() {
220
- const res = await messagingGetMessagingMessage(unifiedTo, {
221
- connectionId: "<id>",
222
- id: "<id>",
223
- });
224
- if (res.ok) {
225
- const { value: result } = res;
226
- console.log(result);
227
- } else {
228
- console.log("messagingGetMessagingMessage failed:", res.error);
229
- }
230
- }
231
-
232
- run();
233
- ```
234
-
235
- ### Parameters
236
-
237
- | Parameter | Type | Required | Description |
238
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
239
- | `request` | [operations.GetMessagingMessageRequest](../../sdk/models/operations/getmessagingmessagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
240
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
241
- | `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. |
242
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
243
-
244
- ### Response
245
-
246
- **Promise\<[shared.MessagingMessage](../../sdk/models/shared/messagingmessage.md)\>**
247
-
248
- ### Errors
249
-
250
- | Error Type | Status Code | Content Type |
251
- | --------------- | --------------- | --------------- |
252
- | errors.SDKError | 4XX, 5XX | \*/\* |
253
-
254
- ## listMessagingChannels
255
-
256
- List all channels
257
-
258
- ### Example Usage
259
-
260
- <!-- UsageSnippet language="typescript" operationID="listMessagingChannels" method="get" path="/messaging/{connection_id}/channel" -->
261
- ```typescript
262
- import { UnifiedTo } from "@unified-api/typescript-sdk";
263
-
264
- const unifiedTo = new UnifiedTo({
265
- security: {
266
- jwt: "<YOUR_API_KEY_HERE>",
267
- },
268
- });
269
-
270
- async function run() {
271
- const result = await unifiedTo.messaging.listMessagingChannels({
272
- connectionId: "<id>",
273
- });
274
-
275
- console.log(result);
276
- }
277
-
278
- run();
279
- ```
280
-
281
- ### Standalone function
282
-
283
- The standalone function version of this method:
284
-
285
- ```typescript
286
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
287
- import { messagingListMessagingChannels } from "@unified-api/typescript-sdk/funcs/messagingListMessagingChannels.js";
288
-
289
- // Use `UnifiedToCore` for best tree-shaking performance.
290
- // You can create one instance of it to use across an application.
291
- const unifiedTo = new UnifiedToCore({
292
- security: {
293
- jwt: "<YOUR_API_KEY_HERE>",
294
- },
295
- });
296
-
297
- async function run() {
298
- const res = await messagingListMessagingChannels(unifiedTo, {
299
- connectionId: "<id>",
300
- });
301
- if (res.ok) {
302
- const { value: result } = res;
303
- console.log(result);
304
- } else {
305
- console.log("messagingListMessagingChannels failed:", res.error);
306
- }
307
- }
308
-
309
- run();
310
- ```
311
-
312
- ### Parameters
313
-
314
- | Parameter | Type | Required | Description |
315
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
316
- | `request` | [operations.ListMessagingChannelsRequest](../../sdk/models/operations/listmessagingchannelsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
317
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
318
- | `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. |
319
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
320
-
321
- ### Response
322
-
323
- **Promise\<[shared.MessagingChannel[]](../../models/.md)\>**
324
-
325
- ### Errors
326
-
327
- | Error Type | Status Code | Content Type |
328
- | --------------- | --------------- | --------------- |
329
- | errors.SDKError | 4XX, 5XX | \*/\* |
330
-
331
- ## listMessagingMessages
332
-
333
- List all messages
334
-
335
- ### Example Usage
336
-
337
- <!-- UsageSnippet language="typescript" operationID="listMessagingMessages" method="get" path="/messaging/{connection_id}/message" -->
338
- ```typescript
339
- import { UnifiedTo } from "@unified-api/typescript-sdk";
340
-
341
- const unifiedTo = new UnifiedTo({
342
- security: {
343
- jwt: "<YOUR_API_KEY_HERE>",
344
- },
345
- });
346
-
347
- async function run() {
348
- const result = await unifiedTo.messaging.listMessagingMessages({
349
- connectionId: "<id>",
350
- });
351
-
352
- console.log(result);
353
- }
354
-
355
- run();
356
- ```
357
-
358
- ### Standalone function
359
-
360
- The standalone function version of this method:
361
-
362
- ```typescript
363
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
364
- import { messagingListMessagingMessages } from "@unified-api/typescript-sdk/funcs/messagingListMessagingMessages.js";
365
-
366
- // Use `UnifiedToCore` for best tree-shaking performance.
367
- // You can create one instance of it to use across an application.
368
- const unifiedTo = new UnifiedToCore({
369
- security: {
370
- jwt: "<YOUR_API_KEY_HERE>",
371
- },
372
- });
373
-
374
- async function run() {
375
- const res = await messagingListMessagingMessages(unifiedTo, {
376
- connectionId: "<id>",
377
- });
378
- if (res.ok) {
379
- const { value: result } = res;
380
- console.log(result);
381
- } else {
382
- console.log("messagingListMessagingMessages failed:", res.error);
383
- }
384
- }
385
-
386
- run();
387
- ```
388
-
389
- ### Parameters
390
-
391
- | Parameter | Type | Required | Description |
392
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
393
- | `request` | [operations.ListMessagingMessagesRequest](../../sdk/models/operations/listmessagingmessagesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
394
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
395
- | `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. |
396
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
397
-
398
- ### Response
399
-
400
- **Promise\<[shared.MessagingMessage[]](../../models/.md)\>**
401
-
402
- ### Errors
403
-
404
- | Error Type | Status Code | Content Type |
405
- | --------------- | --------------- | --------------- |
406
- | errors.SDKError | 4XX, 5XX | \*/\* |
407
-
408
- ## patchMessagingMessage
409
-
410
- Update a message
411
-
412
- ### Example Usage
413
-
414
- <!-- UsageSnippet language="typescript" operationID="patchMessagingMessage" method="patch" path="/messaging/{connection_id}/message/{id}" -->
415
- ```typescript
416
- import { UnifiedTo } from "@unified-api/typescript-sdk";
417
-
418
- const unifiedTo = new UnifiedTo({
419
- security: {
420
- jwt: "<YOUR_API_KEY_HERE>",
421
- },
422
- });
423
-
424
- async function run() {
425
- const result = await unifiedTo.messaging.patchMessagingMessage({
426
- messagingMessage: {},
427
- connectionId: "<id>",
428
- id: "<id>",
429
- });
430
-
431
- console.log(result);
432
- }
433
-
434
- run();
435
- ```
436
-
437
- ### Standalone function
438
-
439
- The standalone function version of this method:
440
-
441
- ```typescript
442
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
443
- import { messagingPatchMessagingMessage } from "@unified-api/typescript-sdk/funcs/messagingPatchMessagingMessage.js";
444
-
445
- // Use `UnifiedToCore` for best tree-shaking performance.
446
- // You can create one instance of it to use across an application.
447
- const unifiedTo = new UnifiedToCore({
448
- security: {
449
- jwt: "<YOUR_API_KEY_HERE>",
450
- },
451
- });
452
-
453
- async function run() {
454
- const res = await messagingPatchMessagingMessage(unifiedTo, {
455
- messagingMessage: {},
456
- connectionId: "<id>",
457
- id: "<id>",
458
- });
459
- if (res.ok) {
460
- const { value: result } = res;
461
- console.log(result);
462
- } else {
463
- console.log("messagingPatchMessagingMessage failed:", res.error);
464
- }
465
- }
466
-
467
- run();
468
- ```
469
-
470
- ### Parameters
471
-
472
- | Parameter | Type | Required | Description |
473
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
474
- | `request` | [operations.PatchMessagingMessageRequest](../../sdk/models/operations/patchmessagingmessagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
475
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
476
- | `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. |
477
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
478
-
479
- ### Response
480
-
481
- **Promise\<[shared.MessagingMessage](../../sdk/models/shared/messagingmessage.md)\>**
482
-
483
- ### Errors
484
-
485
- | Error Type | Status Code | Content Type |
486
- | --------------- | --------------- | --------------- |
487
- | errors.SDKError | 4XX, 5XX | \*/\* |
488
-
489
- ## removeMessagingMessage
490
-
491
- Remove a message
492
-
493
- ### Example Usage
494
-
495
- <!-- UsageSnippet language="typescript" operationID="removeMessagingMessage" method="delete" path="/messaging/{connection_id}/message/{id}" -->
496
- ```typescript
497
- import { UnifiedTo } from "@unified-api/typescript-sdk";
498
-
499
- const unifiedTo = new UnifiedTo({
500
- security: {
501
- jwt: "<YOUR_API_KEY_HERE>",
502
- },
503
- });
504
-
505
- async function run() {
506
- const result = await unifiedTo.messaging.removeMessagingMessage({
507
- connectionId: "<id>",
508
- id: "<id>",
509
- });
510
-
511
- console.log(result);
512
- }
513
-
514
- run();
515
- ```
516
-
517
- ### Standalone function
518
-
519
- The standalone function version of this method:
520
-
521
- ```typescript
522
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
523
- import { messagingRemoveMessagingMessage } from "@unified-api/typescript-sdk/funcs/messagingRemoveMessagingMessage.js";
524
-
525
- // Use `UnifiedToCore` for best tree-shaking performance.
526
- // You can create one instance of it to use across an application.
527
- const unifiedTo = new UnifiedToCore({
528
- security: {
529
- jwt: "<YOUR_API_KEY_HERE>",
530
- },
531
- });
532
-
533
- async function run() {
534
- const res = await messagingRemoveMessagingMessage(unifiedTo, {
535
- connectionId: "<id>",
536
- id: "<id>",
537
- });
538
- if (res.ok) {
539
- const { value: result } = res;
540
- console.log(result);
541
- } else {
542
- console.log("messagingRemoveMessagingMessage failed:", res.error);
543
- }
544
- }
545
-
546
- run();
547
- ```
548
-
549
- ### Parameters
550
-
551
- | Parameter | Type | Required | Description |
552
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
553
- | `request` | [operations.RemoveMessagingMessageRequest](../../sdk/models/operations/removemessagingmessagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
554
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
555
- | `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. |
556
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
557
-
558
- ### Response
559
-
560
- **Promise\<[operations.RemoveMessagingMessageResponse](../../sdk/models/operations/removemessagingmessageresponse.md)\>**
561
-
562
- ### Errors
563
-
564
- | Error Type | Status Code | Content Type |
565
- | --------------- | --------------- | --------------- |
566
- | errors.SDKError | 4XX, 5XX | \*/\* |
567
-
568
- ## updateMessagingMessage
569
-
570
- Update a message
571
-
572
- ### Example Usage
573
-
574
- <!-- UsageSnippet language="typescript" operationID="updateMessagingMessage" method="put" path="/messaging/{connection_id}/message/{id}" -->
575
- ```typescript
576
- import { UnifiedTo } from "@unified-api/typescript-sdk";
577
-
578
- const unifiedTo = new UnifiedTo({
579
- security: {
580
- jwt: "<YOUR_API_KEY_HERE>",
581
- },
582
- });
583
-
584
- async function run() {
585
- const result = await unifiedTo.messaging.updateMessagingMessage({
586
- messagingMessage: {},
587
- connectionId: "<id>",
588
- id: "<id>",
589
- });
590
-
591
- console.log(result);
592
- }
593
-
594
- run();
595
- ```
596
-
597
- ### Standalone function
598
-
599
- The standalone function version of this method:
600
-
601
- ```typescript
602
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
603
- import { messagingUpdateMessagingMessage } from "@unified-api/typescript-sdk/funcs/messagingUpdateMessagingMessage.js";
604
-
605
- // Use `UnifiedToCore` for best tree-shaking performance.
606
- // You can create one instance of it to use across an application.
607
- const unifiedTo = new UnifiedToCore({
608
- security: {
609
- jwt: "<YOUR_API_KEY_HERE>",
610
- },
611
- });
612
-
613
- async function run() {
614
- const res = await messagingUpdateMessagingMessage(unifiedTo, {
615
- messagingMessage: {},
616
- connectionId: "<id>",
617
- id: "<id>",
618
- });
619
- if (res.ok) {
620
- const { value: result } = res;
621
- console.log(result);
622
- } else {
623
- console.log("messagingUpdateMessagingMessage failed:", res.error);
624
- }
625
- }
626
-
627
- run();
628
- ```
629
-
630
- ### Parameters
631
-
632
- | Parameter | Type | Required | Description |
633
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
634
- | `request` | [operations.UpdateMessagingMessageRequest](../../sdk/models/operations/updatemessagingmessagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
635
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
636
- | `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. |
637
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
638
-
639
- ### Response
640
-
641
- **Promise\<[shared.MessagingMessage](../../sdk/models/shared/messagingmessage.md)\>**
642
-
643
- ### Errors
644
-
645
- | Error Type | Status Code | Content Type |
646
- | --------------- | --------------- | --------------- |
647
- | errors.SDKError | 4XX, 5XX | \*/\* |