@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,1935 +0,0 @@
1
- # Ticketing
2
- (*ticketing*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createTicketingCategory](#createticketingcategory) - Create a category
9
- * [createTicketingCustomer](#createticketingcustomer) - Create a customer
10
- * [createTicketingNote](#createticketingnote) - Create a note
11
- * [createTicketingTicket](#createticketingticket) - Create a ticket
12
- * [getTicketingCategory](#getticketingcategory) - Retrieve a category
13
- * [getTicketingCustomer](#getticketingcustomer) - Retrieve a customer
14
- * [getTicketingNote](#getticketingnote) - Retrieve a note
15
- * [getTicketingTicket](#getticketingticket) - Retrieve a ticket
16
- * [listTicketingCategories](#listticketingcategories) - List all categories
17
- * [listTicketingCustomers](#listticketingcustomers) - List all customers
18
- * [listTicketingNotes](#listticketingnotes) - List all notes
19
- * [listTicketingTickets](#listticketingtickets) - List all tickets
20
- * [patchTicketingCategory](#patchticketingcategory) - Update a category
21
- * [patchTicketingCustomer](#patchticketingcustomer) - Update a customer
22
- * [patchTicketingNote](#patchticketingnote) - Update a note
23
- * [patchTicketingTicket](#patchticketingticket) - Update a ticket
24
- * [removeTicketingCategory](#removeticketingcategory) - Remove a category
25
- * [removeTicketingCustomer](#removeticketingcustomer) - Remove a customer
26
- * [removeTicketingNote](#removeticketingnote) - Remove a note
27
- * [removeTicketingTicket](#removeticketingticket) - Remove a ticket
28
- * [updateTicketingCategory](#updateticketingcategory) - Update a category
29
- * [updateTicketingCustomer](#updateticketingcustomer) - Update a customer
30
- * [updateTicketingNote](#updateticketingnote) - Update a note
31
- * [updateTicketingTicket](#updateticketingticket) - Update a ticket
32
-
33
- ## createTicketingCategory
34
-
35
- Create a category
36
-
37
- ### Example Usage
38
-
39
- <!-- UsageSnippet language="typescript" operationID="createTicketingCategory" method="post" path="/ticketing/{connection_id}/category" -->
40
- ```typescript
41
- import { UnifiedTo } from "@unified-api/typescript-sdk";
42
-
43
- const unifiedTo = new UnifiedTo({
44
- security: {
45
- jwt: "<YOUR_API_KEY_HERE>",
46
- },
47
- });
48
-
49
- async function run() {
50
- const result = await unifiedTo.ticketing.createTicketingCategory({
51
- ticketingCategory: {},
52
- connectionId: "<id>",
53
- });
54
-
55
- console.log(result);
56
- }
57
-
58
- run();
59
- ```
60
-
61
- ### Standalone function
62
-
63
- The standalone function version of this method:
64
-
65
- ```typescript
66
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
67
- import { categoryCreateTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryCreateTicketingCategory.js";
68
-
69
- // Use `UnifiedToCore` for best tree-shaking performance.
70
- // You can create one instance of it to use across an application.
71
- const unifiedTo = new UnifiedToCore({
72
- security: {
73
- jwt: "<YOUR_API_KEY_HERE>",
74
- },
75
- });
76
-
77
- async function run() {
78
- const res = await categoryCreateTicketingCategory(unifiedTo, {
79
- ticketingCategory: {},
80
- connectionId: "<id>",
81
- });
82
- if (res.ok) {
83
- const { value: result } = res;
84
- console.log(result);
85
- } else {
86
- console.log("categoryCreateTicketingCategory failed:", res.error);
87
- }
88
- }
89
-
90
- run();
91
- ```
92
-
93
- ### Parameters
94
-
95
- | Parameter | Type | Required | Description |
96
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
97
- | `request` | [operations.CreateTicketingCategoryRequest](../../sdk/models/operations/createticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
98
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
99
- | `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. |
100
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
101
-
102
- ### Response
103
-
104
- **Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
105
-
106
- ### Errors
107
-
108
- | Error Type | Status Code | Content Type |
109
- | --------------- | --------------- | --------------- |
110
- | errors.SDKError | 4XX, 5XX | \*/\* |
111
-
112
- ## createTicketingCustomer
113
-
114
- Create a customer
115
-
116
- ### Example Usage
117
-
118
- <!-- UsageSnippet language="typescript" operationID="createTicketingCustomer" method="post" path="/ticketing/{connection_id}/customer" -->
119
- ```typescript
120
- import { UnifiedTo } from "@unified-api/typescript-sdk";
121
-
122
- const unifiedTo = new UnifiedTo({
123
- security: {
124
- jwt: "<YOUR_API_KEY_HERE>",
125
- },
126
- });
127
-
128
- async function run() {
129
- const result = await unifiedTo.ticketing.createTicketingCustomer({
130
- ticketingCustomer: {},
131
- connectionId: "<id>",
132
- });
133
-
134
- console.log(result);
135
- }
136
-
137
- run();
138
- ```
139
-
140
- ### Standalone function
141
-
142
- The standalone function version of this method:
143
-
144
- ```typescript
145
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
146
- import { ticketingCreateTicketingCustomer } from "@unified-api/typescript-sdk/funcs/ticketingCreateTicketingCustomer.js";
147
-
148
- // Use `UnifiedToCore` for best tree-shaking performance.
149
- // You can create one instance of it to use across an application.
150
- const unifiedTo = new UnifiedToCore({
151
- security: {
152
- jwt: "<YOUR_API_KEY_HERE>",
153
- },
154
- });
155
-
156
- async function run() {
157
- const res = await ticketingCreateTicketingCustomer(unifiedTo, {
158
- ticketingCustomer: {},
159
- connectionId: "<id>",
160
- });
161
- if (res.ok) {
162
- const { value: result } = res;
163
- console.log(result);
164
- } else {
165
- console.log("ticketingCreateTicketingCustomer failed:", res.error);
166
- }
167
- }
168
-
169
- run();
170
- ```
171
-
172
- ### Parameters
173
-
174
- | Parameter | Type | Required | Description |
175
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
176
- | `request` | [operations.CreateTicketingCustomerRequest](../../sdk/models/operations/createticketingcustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
177
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
178
- | `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. |
179
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
180
-
181
- ### Response
182
-
183
- **Promise\<[shared.TicketingCustomer](../../sdk/models/shared/ticketingcustomer.md)\>**
184
-
185
- ### Errors
186
-
187
- | Error Type | Status Code | Content Type |
188
- | --------------- | --------------- | --------------- |
189
- | errors.SDKError | 4XX, 5XX | \*/\* |
190
-
191
- ## createTicketingNote
192
-
193
- Create a note
194
-
195
- ### Example Usage
196
-
197
- <!-- UsageSnippet language="typescript" operationID="createTicketingNote" method="post" path="/ticketing/{connection_id}/note" -->
198
- ```typescript
199
- import { UnifiedTo } from "@unified-api/typescript-sdk";
200
-
201
- const unifiedTo = new UnifiedTo({
202
- security: {
203
- jwt: "<YOUR_API_KEY_HERE>",
204
- },
205
- });
206
-
207
- async function run() {
208
- const result = await unifiedTo.ticketing.createTicketingNote({
209
- ticketingNote: {},
210
- connectionId: "<id>",
211
- });
212
-
213
- console.log(result);
214
- }
215
-
216
- run();
217
- ```
218
-
219
- ### Standalone function
220
-
221
- The standalone function version of this method:
222
-
223
- ```typescript
224
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
225
- import { ticketingCreateTicketingNote } from "@unified-api/typescript-sdk/funcs/ticketingCreateTicketingNote.js";
226
-
227
- // Use `UnifiedToCore` for best tree-shaking performance.
228
- // You can create one instance of it to use across an application.
229
- const unifiedTo = new UnifiedToCore({
230
- security: {
231
- jwt: "<YOUR_API_KEY_HERE>",
232
- },
233
- });
234
-
235
- async function run() {
236
- const res = await ticketingCreateTicketingNote(unifiedTo, {
237
- ticketingNote: {},
238
- connectionId: "<id>",
239
- });
240
- if (res.ok) {
241
- const { value: result } = res;
242
- console.log(result);
243
- } else {
244
- console.log("ticketingCreateTicketingNote failed:", res.error);
245
- }
246
- }
247
-
248
- run();
249
- ```
250
-
251
- ### Parameters
252
-
253
- | Parameter | Type | Required | Description |
254
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
255
- | `request` | [operations.CreateTicketingNoteRequest](../../sdk/models/operations/createticketingnoterequest.md) | :heavy_check_mark: | The request object to use for the request. |
256
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
257
- | `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. |
258
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
259
-
260
- ### Response
261
-
262
- **Promise\<[shared.TicketingNote](../../sdk/models/shared/ticketingnote.md)\>**
263
-
264
- ### Errors
265
-
266
- | Error Type | Status Code | Content Type |
267
- | --------------- | --------------- | --------------- |
268
- | errors.SDKError | 4XX, 5XX | \*/\* |
269
-
270
- ## createTicketingTicket
271
-
272
- Create a ticket
273
-
274
- ### Example Usage
275
-
276
- <!-- UsageSnippet language="typescript" operationID="createTicketingTicket" method="post" path="/ticketing/{connection_id}/ticket" -->
277
- ```typescript
278
- import { UnifiedTo } from "@unified-api/typescript-sdk";
279
-
280
- const unifiedTo = new UnifiedTo({
281
- security: {
282
- jwt: "<YOUR_API_KEY_HERE>",
283
- },
284
- });
285
-
286
- async function run() {
287
- const result = await unifiedTo.ticketing.createTicketingTicket({
288
- ticketingTicket: {},
289
- connectionId: "<id>",
290
- });
291
-
292
- console.log(result);
293
- }
294
-
295
- run();
296
- ```
297
-
298
- ### Standalone function
299
-
300
- The standalone function version of this method:
301
-
302
- ```typescript
303
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
304
- import { ticketingCreateTicketingTicket } from "@unified-api/typescript-sdk/funcs/ticketingCreateTicketingTicket.js";
305
-
306
- // Use `UnifiedToCore` for best tree-shaking performance.
307
- // You can create one instance of it to use across an application.
308
- const unifiedTo = new UnifiedToCore({
309
- security: {
310
- jwt: "<YOUR_API_KEY_HERE>",
311
- },
312
- });
313
-
314
- async function run() {
315
- const res = await ticketingCreateTicketingTicket(unifiedTo, {
316
- ticketingTicket: {},
317
- connectionId: "<id>",
318
- });
319
- if (res.ok) {
320
- const { value: result } = res;
321
- console.log(result);
322
- } else {
323
- console.log("ticketingCreateTicketingTicket failed:", res.error);
324
- }
325
- }
326
-
327
- run();
328
- ```
329
-
330
- ### Parameters
331
-
332
- | Parameter | Type | Required | Description |
333
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
334
- | `request` | [operations.CreateTicketingTicketRequest](../../sdk/models/operations/createticketingticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
335
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
336
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
337
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
338
-
339
- ### Response
340
-
341
- **Promise\<[shared.TicketingTicket](../../sdk/models/shared/ticketingticket.md)\>**
342
-
343
- ### Errors
344
-
345
- | Error Type | Status Code | Content Type |
346
- | --------------- | --------------- | --------------- |
347
- | errors.SDKError | 4XX, 5XX | \*/\* |
348
-
349
- ## getTicketingCategory
350
-
351
- Retrieve a category
352
-
353
- ### Example Usage
354
-
355
- <!-- UsageSnippet language="typescript" operationID="getTicketingCategory" method="get" path="/ticketing/{connection_id}/category/{id}" -->
356
- ```typescript
357
- import { UnifiedTo } from "@unified-api/typescript-sdk";
358
-
359
- const unifiedTo = new UnifiedTo({
360
- security: {
361
- jwt: "<YOUR_API_KEY_HERE>",
362
- },
363
- });
364
-
365
- async function run() {
366
- const result = await unifiedTo.ticketing.getTicketingCategory({
367
- connectionId: "<id>",
368
- id: "<id>",
369
- });
370
-
371
- console.log(result);
372
- }
373
-
374
- run();
375
- ```
376
-
377
- ### Standalone function
378
-
379
- The standalone function version of this method:
380
-
381
- ```typescript
382
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
383
- import { categoryGetTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryGetTicketingCategory.js";
384
-
385
- // Use `UnifiedToCore` for best tree-shaking performance.
386
- // You can create one instance of it to use across an application.
387
- const unifiedTo = new UnifiedToCore({
388
- security: {
389
- jwt: "<YOUR_API_KEY_HERE>",
390
- },
391
- });
392
-
393
- async function run() {
394
- const res = await categoryGetTicketingCategory(unifiedTo, {
395
- connectionId: "<id>",
396
- id: "<id>",
397
- });
398
- if (res.ok) {
399
- const { value: result } = res;
400
- console.log(result);
401
- } else {
402
- console.log("categoryGetTicketingCategory failed:", res.error);
403
- }
404
- }
405
-
406
- run();
407
- ```
408
-
409
- ### Parameters
410
-
411
- | Parameter | Type | Required | Description |
412
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
413
- | `request` | [operations.GetTicketingCategoryRequest](../../sdk/models/operations/getticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
414
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
415
- | `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. |
416
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
417
-
418
- ### Response
419
-
420
- **Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
421
-
422
- ### Errors
423
-
424
- | Error Type | Status Code | Content Type |
425
- | --------------- | --------------- | --------------- |
426
- | errors.SDKError | 4XX, 5XX | \*/\* |
427
-
428
- ## getTicketingCustomer
429
-
430
- Retrieve a customer
431
-
432
- ### Example Usage
433
-
434
- <!-- UsageSnippet language="typescript" operationID="getTicketingCustomer" method="get" path="/ticketing/{connection_id}/customer/{id}" -->
435
- ```typescript
436
- import { UnifiedTo } from "@unified-api/typescript-sdk";
437
-
438
- const unifiedTo = new UnifiedTo({
439
- security: {
440
- jwt: "<YOUR_API_KEY_HERE>",
441
- },
442
- });
443
-
444
- async function run() {
445
- const result = await unifiedTo.ticketing.getTicketingCustomer({
446
- connectionId: "<id>",
447
- id: "<id>",
448
- });
449
-
450
- console.log(result);
451
- }
452
-
453
- run();
454
- ```
455
-
456
- ### Standalone function
457
-
458
- The standalone function version of this method:
459
-
460
- ```typescript
461
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
462
- import { ticketingGetTicketingCustomer } from "@unified-api/typescript-sdk/funcs/ticketingGetTicketingCustomer.js";
463
-
464
- // Use `UnifiedToCore` for best tree-shaking performance.
465
- // You can create one instance of it to use across an application.
466
- const unifiedTo = new UnifiedToCore({
467
- security: {
468
- jwt: "<YOUR_API_KEY_HERE>",
469
- },
470
- });
471
-
472
- async function run() {
473
- const res = await ticketingGetTicketingCustomer(unifiedTo, {
474
- connectionId: "<id>",
475
- id: "<id>",
476
- });
477
- if (res.ok) {
478
- const { value: result } = res;
479
- console.log(result);
480
- } else {
481
- console.log("ticketingGetTicketingCustomer failed:", res.error);
482
- }
483
- }
484
-
485
- run();
486
- ```
487
-
488
- ### Parameters
489
-
490
- | Parameter | Type | Required | Description |
491
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
492
- | `request` | [operations.GetTicketingCustomerRequest](../../sdk/models/operations/getticketingcustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
493
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
494
- | `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. |
495
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
496
-
497
- ### Response
498
-
499
- **Promise\<[shared.TicketingCustomer](../../sdk/models/shared/ticketingcustomer.md)\>**
500
-
501
- ### Errors
502
-
503
- | Error Type | Status Code | Content Type |
504
- | --------------- | --------------- | --------------- |
505
- | errors.SDKError | 4XX, 5XX | \*/\* |
506
-
507
- ## getTicketingNote
508
-
509
- Retrieve a note
510
-
511
- ### Example Usage
512
-
513
- <!-- UsageSnippet language="typescript" operationID="getTicketingNote" method="get" path="/ticketing/{connection_id}/note/{id}" -->
514
- ```typescript
515
- import { UnifiedTo } from "@unified-api/typescript-sdk";
516
-
517
- const unifiedTo = new UnifiedTo({
518
- security: {
519
- jwt: "<YOUR_API_KEY_HERE>",
520
- },
521
- });
522
-
523
- async function run() {
524
- const result = await unifiedTo.ticketing.getTicketingNote({
525
- connectionId: "<id>",
526
- id: "<id>",
527
- });
528
-
529
- console.log(result);
530
- }
531
-
532
- run();
533
- ```
534
-
535
- ### Standalone function
536
-
537
- The standalone function version of this method:
538
-
539
- ```typescript
540
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
541
- import { ticketingGetTicketingNote } from "@unified-api/typescript-sdk/funcs/ticketingGetTicketingNote.js";
542
-
543
- // Use `UnifiedToCore` for best tree-shaking performance.
544
- // You can create one instance of it to use across an application.
545
- const unifiedTo = new UnifiedToCore({
546
- security: {
547
- jwt: "<YOUR_API_KEY_HERE>",
548
- },
549
- });
550
-
551
- async function run() {
552
- const res = await ticketingGetTicketingNote(unifiedTo, {
553
- connectionId: "<id>",
554
- id: "<id>",
555
- });
556
- if (res.ok) {
557
- const { value: result } = res;
558
- console.log(result);
559
- } else {
560
- console.log("ticketingGetTicketingNote failed:", res.error);
561
- }
562
- }
563
-
564
- run();
565
- ```
566
-
567
- ### Parameters
568
-
569
- | Parameter | Type | Required | Description |
570
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
571
- | `request` | [operations.GetTicketingNoteRequest](../../sdk/models/operations/getticketingnoterequest.md) | :heavy_check_mark: | The request object to use for the request. |
572
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
573
- | `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. |
574
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
575
-
576
- ### Response
577
-
578
- **Promise\<[shared.TicketingNote](../../sdk/models/shared/ticketingnote.md)\>**
579
-
580
- ### Errors
581
-
582
- | Error Type | Status Code | Content Type |
583
- | --------------- | --------------- | --------------- |
584
- | errors.SDKError | 4XX, 5XX | \*/\* |
585
-
586
- ## getTicketingTicket
587
-
588
- Retrieve a ticket
589
-
590
- ### Example Usage
591
-
592
- <!-- UsageSnippet language="typescript" operationID="getTicketingTicket" method="get" path="/ticketing/{connection_id}/ticket/{id}" -->
593
- ```typescript
594
- import { UnifiedTo } from "@unified-api/typescript-sdk";
595
-
596
- const unifiedTo = new UnifiedTo({
597
- security: {
598
- jwt: "<YOUR_API_KEY_HERE>",
599
- },
600
- });
601
-
602
- async function run() {
603
- const result = await unifiedTo.ticketing.getTicketingTicket({
604
- connectionId: "<id>",
605
- id: "<id>",
606
- });
607
-
608
- console.log(result);
609
- }
610
-
611
- run();
612
- ```
613
-
614
- ### Standalone function
615
-
616
- The standalone function version of this method:
617
-
618
- ```typescript
619
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
620
- import { ticketingGetTicketingTicket } from "@unified-api/typescript-sdk/funcs/ticketingGetTicketingTicket.js";
621
-
622
- // Use `UnifiedToCore` for best tree-shaking performance.
623
- // You can create one instance of it to use across an application.
624
- const unifiedTo = new UnifiedToCore({
625
- security: {
626
- jwt: "<YOUR_API_KEY_HERE>",
627
- },
628
- });
629
-
630
- async function run() {
631
- const res = await ticketingGetTicketingTicket(unifiedTo, {
632
- connectionId: "<id>",
633
- id: "<id>",
634
- });
635
- if (res.ok) {
636
- const { value: result } = res;
637
- console.log(result);
638
- } else {
639
- console.log("ticketingGetTicketingTicket failed:", res.error);
640
- }
641
- }
642
-
643
- run();
644
- ```
645
-
646
- ### Parameters
647
-
648
- | Parameter | Type | Required | Description |
649
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
650
- | `request` | [operations.GetTicketingTicketRequest](../../sdk/models/operations/getticketingticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
651
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
652
- | `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. |
653
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
654
-
655
- ### Response
656
-
657
- **Promise\<[shared.TicketingTicket](../../sdk/models/shared/ticketingticket.md)\>**
658
-
659
- ### Errors
660
-
661
- | Error Type | Status Code | Content Type |
662
- | --------------- | --------------- | --------------- |
663
- | errors.SDKError | 4XX, 5XX | \*/\* |
664
-
665
- ## listTicketingCategories
666
-
667
- List all categories
668
-
669
- ### Example Usage
670
-
671
- <!-- UsageSnippet language="typescript" operationID="listTicketingCategories" method="get" path="/ticketing/{connection_id}/category" -->
672
- ```typescript
673
- import { UnifiedTo } from "@unified-api/typescript-sdk";
674
-
675
- const unifiedTo = new UnifiedTo({
676
- security: {
677
- jwt: "<YOUR_API_KEY_HERE>",
678
- },
679
- });
680
-
681
- async function run() {
682
- const result = await unifiedTo.ticketing.listTicketingCategories({
683
- connectionId: "<id>",
684
- });
685
-
686
- console.log(result);
687
- }
688
-
689
- run();
690
- ```
691
-
692
- ### Standalone function
693
-
694
- The standalone function version of this method:
695
-
696
- ```typescript
697
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
698
- import { categoryListTicketingCategories } from "@unified-api/typescript-sdk/funcs/categoryListTicketingCategories.js";
699
-
700
- // Use `UnifiedToCore` for best tree-shaking performance.
701
- // You can create one instance of it to use across an application.
702
- const unifiedTo = new UnifiedToCore({
703
- security: {
704
- jwt: "<YOUR_API_KEY_HERE>",
705
- },
706
- });
707
-
708
- async function run() {
709
- const res = await categoryListTicketingCategories(unifiedTo, {
710
- connectionId: "<id>",
711
- });
712
- if (res.ok) {
713
- const { value: result } = res;
714
- console.log(result);
715
- } else {
716
- console.log("categoryListTicketingCategories failed:", res.error);
717
- }
718
- }
719
-
720
- run();
721
- ```
722
-
723
- ### Parameters
724
-
725
- | Parameter | Type | Required | Description |
726
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
727
- | `request` | [operations.ListTicketingCategoriesRequest](../../sdk/models/operations/listticketingcategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
728
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
729
- | `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. |
730
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
731
-
732
- ### Response
733
-
734
- **Promise\<[shared.TicketingCategory[]](../../models/.md)\>**
735
-
736
- ### Errors
737
-
738
- | Error Type | Status Code | Content Type |
739
- | --------------- | --------------- | --------------- |
740
- | errors.SDKError | 4XX, 5XX | \*/\* |
741
-
742
- ## listTicketingCustomers
743
-
744
- List all customers
745
-
746
- ### Example Usage
747
-
748
- <!-- UsageSnippet language="typescript" operationID="listTicketingCustomers" method="get" path="/ticketing/{connection_id}/customer" -->
749
- ```typescript
750
- import { UnifiedTo } from "@unified-api/typescript-sdk";
751
-
752
- const unifiedTo = new UnifiedTo({
753
- security: {
754
- jwt: "<YOUR_API_KEY_HERE>",
755
- },
756
- });
757
-
758
- async function run() {
759
- const result = await unifiedTo.ticketing.listTicketingCustomers({
760
- connectionId: "<id>",
761
- });
762
-
763
- console.log(result);
764
- }
765
-
766
- run();
767
- ```
768
-
769
- ### Standalone function
770
-
771
- The standalone function version of this method:
772
-
773
- ```typescript
774
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
775
- import { ticketingListTicketingCustomers } from "@unified-api/typescript-sdk/funcs/ticketingListTicketingCustomers.js";
776
-
777
- // Use `UnifiedToCore` for best tree-shaking performance.
778
- // You can create one instance of it to use across an application.
779
- const unifiedTo = new UnifiedToCore({
780
- security: {
781
- jwt: "<YOUR_API_KEY_HERE>",
782
- },
783
- });
784
-
785
- async function run() {
786
- const res = await ticketingListTicketingCustomers(unifiedTo, {
787
- connectionId: "<id>",
788
- });
789
- if (res.ok) {
790
- const { value: result } = res;
791
- console.log(result);
792
- } else {
793
- console.log("ticketingListTicketingCustomers failed:", res.error);
794
- }
795
- }
796
-
797
- run();
798
- ```
799
-
800
- ### Parameters
801
-
802
- | Parameter | Type | Required | Description |
803
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
804
- | `request` | [operations.ListTicketingCustomersRequest](../../sdk/models/operations/listticketingcustomersrequest.md) | :heavy_check_mark: | The request object to use for the request. |
805
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
806
- | `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. |
807
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
808
-
809
- ### Response
810
-
811
- **Promise\<[shared.TicketingCustomer[]](../../models/.md)\>**
812
-
813
- ### Errors
814
-
815
- | Error Type | Status Code | Content Type |
816
- | --------------- | --------------- | --------------- |
817
- | errors.SDKError | 4XX, 5XX | \*/\* |
818
-
819
- ## listTicketingNotes
820
-
821
- List all notes
822
-
823
- ### Example Usage
824
-
825
- <!-- UsageSnippet language="typescript" operationID="listTicketingNotes" method="get" path="/ticketing/{connection_id}/note" -->
826
- ```typescript
827
- import { UnifiedTo } from "@unified-api/typescript-sdk";
828
-
829
- const unifiedTo = new UnifiedTo({
830
- security: {
831
- jwt: "<YOUR_API_KEY_HERE>",
832
- },
833
- });
834
-
835
- async function run() {
836
- const result = await unifiedTo.ticketing.listTicketingNotes({
837
- connectionId: "<id>",
838
- });
839
-
840
- console.log(result);
841
- }
842
-
843
- run();
844
- ```
845
-
846
- ### Standalone function
847
-
848
- The standalone function version of this method:
849
-
850
- ```typescript
851
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
852
- import { ticketingListTicketingNotes } from "@unified-api/typescript-sdk/funcs/ticketingListTicketingNotes.js";
853
-
854
- // Use `UnifiedToCore` for best tree-shaking performance.
855
- // You can create one instance of it to use across an application.
856
- const unifiedTo = new UnifiedToCore({
857
- security: {
858
- jwt: "<YOUR_API_KEY_HERE>",
859
- },
860
- });
861
-
862
- async function run() {
863
- const res = await ticketingListTicketingNotes(unifiedTo, {
864
- connectionId: "<id>",
865
- });
866
- if (res.ok) {
867
- const { value: result } = res;
868
- console.log(result);
869
- } else {
870
- console.log("ticketingListTicketingNotes failed:", res.error);
871
- }
872
- }
873
-
874
- run();
875
- ```
876
-
877
- ### Parameters
878
-
879
- | Parameter | Type | Required | Description |
880
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
881
- | `request` | [operations.ListTicketingNotesRequest](../../sdk/models/operations/listticketingnotesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
882
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
883
- | `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. |
884
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
885
-
886
- ### Response
887
-
888
- **Promise\<[shared.TicketingNote[]](../../models/.md)\>**
889
-
890
- ### Errors
891
-
892
- | Error Type | Status Code | Content Type |
893
- | --------------- | --------------- | --------------- |
894
- | errors.SDKError | 4XX, 5XX | \*/\* |
895
-
896
- ## listTicketingTickets
897
-
898
- List all tickets
899
-
900
- ### Example Usage
901
-
902
- <!-- UsageSnippet language="typescript" operationID="listTicketingTickets" method="get" path="/ticketing/{connection_id}/ticket" -->
903
- ```typescript
904
- import { UnifiedTo } from "@unified-api/typescript-sdk";
905
-
906
- const unifiedTo = new UnifiedTo({
907
- security: {
908
- jwt: "<YOUR_API_KEY_HERE>",
909
- },
910
- });
911
-
912
- async function run() {
913
- const result = await unifiedTo.ticketing.listTicketingTickets({
914
- connectionId: "<id>",
915
- });
916
-
917
- console.log(result);
918
- }
919
-
920
- run();
921
- ```
922
-
923
- ### Standalone function
924
-
925
- The standalone function version of this method:
926
-
927
- ```typescript
928
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
929
- import { ticketingListTicketingTickets } from "@unified-api/typescript-sdk/funcs/ticketingListTicketingTickets.js";
930
-
931
- // Use `UnifiedToCore` for best tree-shaking performance.
932
- // You can create one instance of it to use across an application.
933
- const unifiedTo = new UnifiedToCore({
934
- security: {
935
- jwt: "<YOUR_API_KEY_HERE>",
936
- },
937
- });
938
-
939
- async function run() {
940
- const res = await ticketingListTicketingTickets(unifiedTo, {
941
- connectionId: "<id>",
942
- });
943
- if (res.ok) {
944
- const { value: result } = res;
945
- console.log(result);
946
- } else {
947
- console.log("ticketingListTicketingTickets failed:", res.error);
948
- }
949
- }
950
-
951
- run();
952
- ```
953
-
954
- ### Parameters
955
-
956
- | Parameter | Type | Required | Description |
957
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
958
- | `request` | [operations.ListTicketingTicketsRequest](../../sdk/models/operations/listticketingticketsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
959
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
960
- | `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. |
961
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
962
-
963
- ### Response
964
-
965
- **Promise\<[shared.TicketingTicket[]](../../models/.md)\>**
966
-
967
- ### Errors
968
-
969
- | Error Type | Status Code | Content Type |
970
- | --------------- | --------------- | --------------- |
971
- | errors.SDKError | 4XX, 5XX | \*/\* |
972
-
973
- ## patchTicketingCategory
974
-
975
- Update a category
976
-
977
- ### Example Usage
978
-
979
- <!-- UsageSnippet language="typescript" operationID="patchTicketingCategory" method="patch" path="/ticketing/{connection_id}/category/{id}" -->
980
- ```typescript
981
- import { UnifiedTo } from "@unified-api/typescript-sdk";
982
-
983
- const unifiedTo = new UnifiedTo({
984
- security: {
985
- jwt: "<YOUR_API_KEY_HERE>",
986
- },
987
- });
988
-
989
- async function run() {
990
- const result = await unifiedTo.ticketing.patchTicketingCategory({
991
- ticketingCategory: {},
992
- connectionId: "<id>",
993
- id: "<id>",
994
- });
995
-
996
- console.log(result);
997
- }
998
-
999
- run();
1000
- ```
1001
-
1002
- ### Standalone function
1003
-
1004
- The standalone function version of this method:
1005
-
1006
- ```typescript
1007
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1008
- import { categoryPatchTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryPatchTicketingCategory.js";
1009
-
1010
- // Use `UnifiedToCore` for best tree-shaking performance.
1011
- // You can create one instance of it to use across an application.
1012
- const unifiedTo = new UnifiedToCore({
1013
- security: {
1014
- jwt: "<YOUR_API_KEY_HERE>",
1015
- },
1016
- });
1017
-
1018
- async function run() {
1019
- const res = await categoryPatchTicketingCategory(unifiedTo, {
1020
- ticketingCategory: {},
1021
- connectionId: "<id>",
1022
- id: "<id>",
1023
- });
1024
- if (res.ok) {
1025
- const { value: result } = res;
1026
- console.log(result);
1027
- } else {
1028
- console.log("categoryPatchTicketingCategory failed:", res.error);
1029
- }
1030
- }
1031
-
1032
- run();
1033
- ```
1034
-
1035
- ### Parameters
1036
-
1037
- | Parameter | Type | Required | Description |
1038
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1039
- | `request` | [operations.PatchTicketingCategoryRequest](../../sdk/models/operations/patchticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1040
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1041
- | `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. |
1042
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1043
-
1044
- ### Response
1045
-
1046
- **Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
1047
-
1048
- ### Errors
1049
-
1050
- | Error Type | Status Code | Content Type |
1051
- | --------------- | --------------- | --------------- |
1052
- | errors.SDKError | 4XX, 5XX | \*/\* |
1053
-
1054
- ## patchTicketingCustomer
1055
-
1056
- Update a customer
1057
-
1058
- ### Example Usage
1059
-
1060
- <!-- UsageSnippet language="typescript" operationID="patchTicketingCustomer" method="patch" path="/ticketing/{connection_id}/customer/{id}" -->
1061
- ```typescript
1062
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1063
-
1064
- const unifiedTo = new UnifiedTo({
1065
- security: {
1066
- jwt: "<YOUR_API_KEY_HERE>",
1067
- },
1068
- });
1069
-
1070
- async function run() {
1071
- const result = await unifiedTo.ticketing.patchTicketingCustomer({
1072
- ticketingCustomer: {},
1073
- connectionId: "<id>",
1074
- id: "<id>",
1075
- });
1076
-
1077
- console.log(result);
1078
- }
1079
-
1080
- run();
1081
- ```
1082
-
1083
- ### Standalone function
1084
-
1085
- The standalone function version of this method:
1086
-
1087
- ```typescript
1088
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1089
- import { ticketingPatchTicketingCustomer } from "@unified-api/typescript-sdk/funcs/ticketingPatchTicketingCustomer.js";
1090
-
1091
- // Use `UnifiedToCore` for best tree-shaking performance.
1092
- // You can create one instance of it to use across an application.
1093
- const unifiedTo = new UnifiedToCore({
1094
- security: {
1095
- jwt: "<YOUR_API_KEY_HERE>",
1096
- },
1097
- });
1098
-
1099
- async function run() {
1100
- const res = await ticketingPatchTicketingCustomer(unifiedTo, {
1101
- ticketingCustomer: {},
1102
- connectionId: "<id>",
1103
- id: "<id>",
1104
- });
1105
- if (res.ok) {
1106
- const { value: result } = res;
1107
- console.log(result);
1108
- } else {
1109
- console.log("ticketingPatchTicketingCustomer failed:", res.error);
1110
- }
1111
- }
1112
-
1113
- run();
1114
- ```
1115
-
1116
- ### Parameters
1117
-
1118
- | Parameter | Type | Required | Description |
1119
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1120
- | `request` | [operations.PatchTicketingCustomerRequest](../../sdk/models/operations/patchticketingcustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1121
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1122
- | `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. |
1123
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1124
-
1125
- ### Response
1126
-
1127
- **Promise\<[shared.TicketingCustomer](../../sdk/models/shared/ticketingcustomer.md)\>**
1128
-
1129
- ### Errors
1130
-
1131
- | Error Type | Status Code | Content Type |
1132
- | --------------- | --------------- | --------------- |
1133
- | errors.SDKError | 4XX, 5XX | \*/\* |
1134
-
1135
- ## patchTicketingNote
1136
-
1137
- Update a note
1138
-
1139
- ### Example Usage
1140
-
1141
- <!-- UsageSnippet language="typescript" operationID="patchTicketingNote" method="patch" path="/ticketing/{connection_id}/note/{id}" -->
1142
- ```typescript
1143
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1144
-
1145
- const unifiedTo = new UnifiedTo({
1146
- security: {
1147
- jwt: "<YOUR_API_KEY_HERE>",
1148
- },
1149
- });
1150
-
1151
- async function run() {
1152
- const result = await unifiedTo.ticketing.patchTicketingNote({
1153
- ticketingNote: {},
1154
- connectionId: "<id>",
1155
- id: "<id>",
1156
- });
1157
-
1158
- console.log(result);
1159
- }
1160
-
1161
- run();
1162
- ```
1163
-
1164
- ### Standalone function
1165
-
1166
- The standalone function version of this method:
1167
-
1168
- ```typescript
1169
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1170
- import { ticketingPatchTicketingNote } from "@unified-api/typescript-sdk/funcs/ticketingPatchTicketingNote.js";
1171
-
1172
- // Use `UnifiedToCore` for best tree-shaking performance.
1173
- // You can create one instance of it to use across an application.
1174
- const unifiedTo = new UnifiedToCore({
1175
- security: {
1176
- jwt: "<YOUR_API_KEY_HERE>",
1177
- },
1178
- });
1179
-
1180
- async function run() {
1181
- const res = await ticketingPatchTicketingNote(unifiedTo, {
1182
- ticketingNote: {},
1183
- connectionId: "<id>",
1184
- id: "<id>",
1185
- });
1186
- if (res.ok) {
1187
- const { value: result } = res;
1188
- console.log(result);
1189
- } else {
1190
- console.log("ticketingPatchTicketingNote failed:", res.error);
1191
- }
1192
- }
1193
-
1194
- run();
1195
- ```
1196
-
1197
- ### Parameters
1198
-
1199
- | Parameter | Type | Required | Description |
1200
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1201
- | `request` | [operations.PatchTicketingNoteRequest](../../sdk/models/operations/patchticketingnoterequest.md) | :heavy_check_mark: | The request object to use for the request. |
1202
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1203
- | `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. |
1204
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1205
-
1206
- ### Response
1207
-
1208
- **Promise\<[shared.TicketingNote](../../sdk/models/shared/ticketingnote.md)\>**
1209
-
1210
- ### Errors
1211
-
1212
- | Error Type | Status Code | Content Type |
1213
- | --------------- | --------------- | --------------- |
1214
- | errors.SDKError | 4XX, 5XX | \*/\* |
1215
-
1216
- ## patchTicketingTicket
1217
-
1218
- Update a ticket
1219
-
1220
- ### Example Usage
1221
-
1222
- <!-- UsageSnippet language="typescript" operationID="patchTicketingTicket" method="patch" path="/ticketing/{connection_id}/ticket/{id}" -->
1223
- ```typescript
1224
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1225
-
1226
- const unifiedTo = new UnifiedTo({
1227
- security: {
1228
- jwt: "<YOUR_API_KEY_HERE>",
1229
- },
1230
- });
1231
-
1232
- async function run() {
1233
- const result = await unifiedTo.ticketing.patchTicketingTicket({
1234
- ticketingTicket: {},
1235
- connectionId: "<id>",
1236
- id: "<id>",
1237
- });
1238
-
1239
- console.log(result);
1240
- }
1241
-
1242
- run();
1243
- ```
1244
-
1245
- ### Standalone function
1246
-
1247
- The standalone function version of this method:
1248
-
1249
- ```typescript
1250
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1251
- import { ticketingPatchTicketingTicket } from "@unified-api/typescript-sdk/funcs/ticketingPatchTicketingTicket.js";
1252
-
1253
- // Use `UnifiedToCore` for best tree-shaking performance.
1254
- // You can create one instance of it to use across an application.
1255
- const unifiedTo = new UnifiedToCore({
1256
- security: {
1257
- jwt: "<YOUR_API_KEY_HERE>",
1258
- },
1259
- });
1260
-
1261
- async function run() {
1262
- const res = await ticketingPatchTicketingTicket(unifiedTo, {
1263
- ticketingTicket: {},
1264
- connectionId: "<id>",
1265
- id: "<id>",
1266
- });
1267
- if (res.ok) {
1268
- const { value: result } = res;
1269
- console.log(result);
1270
- } else {
1271
- console.log("ticketingPatchTicketingTicket failed:", res.error);
1272
- }
1273
- }
1274
-
1275
- run();
1276
- ```
1277
-
1278
- ### Parameters
1279
-
1280
- | Parameter | Type | Required | Description |
1281
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1282
- | `request` | [operations.PatchTicketingTicketRequest](../../sdk/models/operations/patchticketingticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1283
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1284
- | `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. |
1285
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1286
-
1287
- ### Response
1288
-
1289
- **Promise\<[shared.TicketingTicket](../../sdk/models/shared/ticketingticket.md)\>**
1290
-
1291
- ### Errors
1292
-
1293
- | Error Type | Status Code | Content Type |
1294
- | --------------- | --------------- | --------------- |
1295
- | errors.SDKError | 4XX, 5XX | \*/\* |
1296
-
1297
- ## removeTicketingCategory
1298
-
1299
- Remove a category
1300
-
1301
- ### Example Usage
1302
-
1303
- <!-- UsageSnippet language="typescript" operationID="removeTicketingCategory" method="delete" path="/ticketing/{connection_id}/category/{id}" -->
1304
- ```typescript
1305
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1306
-
1307
- const unifiedTo = new UnifiedTo({
1308
- security: {
1309
- jwt: "<YOUR_API_KEY_HERE>",
1310
- },
1311
- });
1312
-
1313
- async function run() {
1314
- const result = await unifiedTo.ticketing.removeTicketingCategory({
1315
- connectionId: "<id>",
1316
- id: "<id>",
1317
- });
1318
-
1319
- console.log(result);
1320
- }
1321
-
1322
- run();
1323
- ```
1324
-
1325
- ### Standalone function
1326
-
1327
- The standalone function version of this method:
1328
-
1329
- ```typescript
1330
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1331
- import { categoryRemoveTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryRemoveTicketingCategory.js";
1332
-
1333
- // Use `UnifiedToCore` for best tree-shaking performance.
1334
- // You can create one instance of it to use across an application.
1335
- const unifiedTo = new UnifiedToCore({
1336
- security: {
1337
- jwt: "<YOUR_API_KEY_HERE>",
1338
- },
1339
- });
1340
-
1341
- async function run() {
1342
- const res = await categoryRemoveTicketingCategory(unifiedTo, {
1343
- connectionId: "<id>",
1344
- id: "<id>",
1345
- });
1346
- if (res.ok) {
1347
- const { value: result } = res;
1348
- console.log(result);
1349
- } else {
1350
- console.log("categoryRemoveTicketingCategory failed:", res.error);
1351
- }
1352
- }
1353
-
1354
- run();
1355
- ```
1356
-
1357
- ### Parameters
1358
-
1359
- | Parameter | Type | Required | Description |
1360
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1361
- | `request` | [operations.RemoveTicketingCategoryRequest](../../sdk/models/operations/removeticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1362
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1363
- | `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. |
1364
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1365
-
1366
- ### Response
1367
-
1368
- **Promise\<[operations.RemoveTicketingCategoryResponse](../../sdk/models/operations/removeticketingcategoryresponse.md)\>**
1369
-
1370
- ### Errors
1371
-
1372
- | Error Type | Status Code | Content Type |
1373
- | --------------- | --------------- | --------------- |
1374
- | errors.SDKError | 4XX, 5XX | \*/\* |
1375
-
1376
- ## removeTicketingCustomer
1377
-
1378
- Remove a customer
1379
-
1380
- ### Example Usage
1381
-
1382
- <!-- UsageSnippet language="typescript" operationID="removeTicketingCustomer" method="delete" path="/ticketing/{connection_id}/customer/{id}" -->
1383
- ```typescript
1384
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1385
-
1386
- const unifiedTo = new UnifiedTo({
1387
- security: {
1388
- jwt: "<YOUR_API_KEY_HERE>",
1389
- },
1390
- });
1391
-
1392
- async function run() {
1393
- const result = await unifiedTo.ticketing.removeTicketingCustomer({
1394
- connectionId: "<id>",
1395
- id: "<id>",
1396
- });
1397
-
1398
- console.log(result);
1399
- }
1400
-
1401
- run();
1402
- ```
1403
-
1404
- ### Standalone function
1405
-
1406
- The standalone function version of this method:
1407
-
1408
- ```typescript
1409
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1410
- import { ticketingRemoveTicketingCustomer } from "@unified-api/typescript-sdk/funcs/ticketingRemoveTicketingCustomer.js";
1411
-
1412
- // Use `UnifiedToCore` for best tree-shaking performance.
1413
- // You can create one instance of it to use across an application.
1414
- const unifiedTo = new UnifiedToCore({
1415
- security: {
1416
- jwt: "<YOUR_API_KEY_HERE>",
1417
- },
1418
- });
1419
-
1420
- async function run() {
1421
- const res = await ticketingRemoveTicketingCustomer(unifiedTo, {
1422
- connectionId: "<id>",
1423
- id: "<id>",
1424
- });
1425
- if (res.ok) {
1426
- const { value: result } = res;
1427
- console.log(result);
1428
- } else {
1429
- console.log("ticketingRemoveTicketingCustomer failed:", res.error);
1430
- }
1431
- }
1432
-
1433
- run();
1434
- ```
1435
-
1436
- ### Parameters
1437
-
1438
- | Parameter | Type | Required | Description |
1439
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1440
- | `request` | [operations.RemoveTicketingCustomerRequest](../../sdk/models/operations/removeticketingcustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1441
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1442
- | `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. |
1443
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1444
-
1445
- ### Response
1446
-
1447
- **Promise\<[operations.RemoveTicketingCustomerResponse](../../sdk/models/operations/removeticketingcustomerresponse.md)\>**
1448
-
1449
- ### Errors
1450
-
1451
- | Error Type | Status Code | Content Type |
1452
- | --------------- | --------------- | --------------- |
1453
- | errors.SDKError | 4XX, 5XX | \*/\* |
1454
-
1455
- ## removeTicketingNote
1456
-
1457
- Remove a note
1458
-
1459
- ### Example Usage
1460
-
1461
- <!-- UsageSnippet language="typescript" operationID="removeTicketingNote" method="delete" path="/ticketing/{connection_id}/note/{id}" -->
1462
- ```typescript
1463
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1464
-
1465
- const unifiedTo = new UnifiedTo({
1466
- security: {
1467
- jwt: "<YOUR_API_KEY_HERE>",
1468
- },
1469
- });
1470
-
1471
- async function run() {
1472
- const result = await unifiedTo.ticketing.removeTicketingNote({
1473
- connectionId: "<id>",
1474
- id: "<id>",
1475
- });
1476
-
1477
- console.log(result);
1478
- }
1479
-
1480
- run();
1481
- ```
1482
-
1483
- ### Standalone function
1484
-
1485
- The standalone function version of this method:
1486
-
1487
- ```typescript
1488
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1489
- import { ticketingRemoveTicketingNote } from "@unified-api/typescript-sdk/funcs/ticketingRemoveTicketingNote.js";
1490
-
1491
- // Use `UnifiedToCore` for best tree-shaking performance.
1492
- // You can create one instance of it to use across an application.
1493
- const unifiedTo = new UnifiedToCore({
1494
- security: {
1495
- jwt: "<YOUR_API_KEY_HERE>",
1496
- },
1497
- });
1498
-
1499
- async function run() {
1500
- const res = await ticketingRemoveTicketingNote(unifiedTo, {
1501
- connectionId: "<id>",
1502
- id: "<id>",
1503
- });
1504
- if (res.ok) {
1505
- const { value: result } = res;
1506
- console.log(result);
1507
- } else {
1508
- console.log("ticketingRemoveTicketingNote failed:", res.error);
1509
- }
1510
- }
1511
-
1512
- run();
1513
- ```
1514
-
1515
- ### Parameters
1516
-
1517
- | Parameter | Type | Required | Description |
1518
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1519
- | `request` | [operations.RemoveTicketingNoteRequest](../../sdk/models/operations/removeticketingnoterequest.md) | :heavy_check_mark: | The request object to use for the request. |
1520
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1521
- | `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. |
1522
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1523
-
1524
- ### Response
1525
-
1526
- **Promise\<[operations.RemoveTicketingNoteResponse](../../sdk/models/operations/removeticketingnoteresponse.md)\>**
1527
-
1528
- ### Errors
1529
-
1530
- | Error Type | Status Code | Content Type |
1531
- | --------------- | --------------- | --------------- |
1532
- | errors.SDKError | 4XX, 5XX | \*/\* |
1533
-
1534
- ## removeTicketingTicket
1535
-
1536
- Remove a ticket
1537
-
1538
- ### Example Usage
1539
-
1540
- <!-- UsageSnippet language="typescript" operationID="removeTicketingTicket" method="delete" path="/ticketing/{connection_id}/ticket/{id}" -->
1541
- ```typescript
1542
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1543
-
1544
- const unifiedTo = new UnifiedTo({
1545
- security: {
1546
- jwt: "<YOUR_API_KEY_HERE>",
1547
- },
1548
- });
1549
-
1550
- async function run() {
1551
- const result = await unifiedTo.ticketing.removeTicketingTicket({
1552
- connectionId: "<id>",
1553
- id: "<id>",
1554
- });
1555
-
1556
- console.log(result);
1557
- }
1558
-
1559
- run();
1560
- ```
1561
-
1562
- ### Standalone function
1563
-
1564
- The standalone function version of this method:
1565
-
1566
- ```typescript
1567
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1568
- import { ticketingRemoveTicketingTicket } from "@unified-api/typescript-sdk/funcs/ticketingRemoveTicketingTicket.js";
1569
-
1570
- // Use `UnifiedToCore` for best tree-shaking performance.
1571
- // You can create one instance of it to use across an application.
1572
- const unifiedTo = new UnifiedToCore({
1573
- security: {
1574
- jwt: "<YOUR_API_KEY_HERE>",
1575
- },
1576
- });
1577
-
1578
- async function run() {
1579
- const res = await ticketingRemoveTicketingTicket(unifiedTo, {
1580
- connectionId: "<id>",
1581
- id: "<id>",
1582
- });
1583
- if (res.ok) {
1584
- const { value: result } = res;
1585
- console.log(result);
1586
- } else {
1587
- console.log("ticketingRemoveTicketingTicket failed:", res.error);
1588
- }
1589
- }
1590
-
1591
- run();
1592
- ```
1593
-
1594
- ### Parameters
1595
-
1596
- | Parameter | Type | Required | Description |
1597
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1598
- | `request` | [operations.RemoveTicketingTicketRequest](../../sdk/models/operations/removeticketingticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1599
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1600
- | `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. |
1601
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1602
-
1603
- ### Response
1604
-
1605
- **Promise\<[operations.RemoveTicketingTicketResponse](../../sdk/models/operations/removeticketingticketresponse.md)\>**
1606
-
1607
- ### Errors
1608
-
1609
- | Error Type | Status Code | Content Type |
1610
- | --------------- | --------------- | --------------- |
1611
- | errors.SDKError | 4XX, 5XX | \*/\* |
1612
-
1613
- ## updateTicketingCategory
1614
-
1615
- Update a category
1616
-
1617
- ### Example Usage
1618
-
1619
- <!-- UsageSnippet language="typescript" operationID="updateTicketingCategory" method="put" path="/ticketing/{connection_id}/category/{id}" -->
1620
- ```typescript
1621
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1622
-
1623
- const unifiedTo = new UnifiedTo({
1624
- security: {
1625
- jwt: "<YOUR_API_KEY_HERE>",
1626
- },
1627
- });
1628
-
1629
- async function run() {
1630
- const result = await unifiedTo.ticketing.updateTicketingCategory({
1631
- ticketingCategory: {},
1632
- connectionId: "<id>",
1633
- id: "<id>",
1634
- });
1635
-
1636
- console.log(result);
1637
- }
1638
-
1639
- run();
1640
- ```
1641
-
1642
- ### Standalone function
1643
-
1644
- The standalone function version of this method:
1645
-
1646
- ```typescript
1647
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1648
- import { categoryUpdateTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryUpdateTicketingCategory.js";
1649
-
1650
- // Use `UnifiedToCore` for best tree-shaking performance.
1651
- // You can create one instance of it to use across an application.
1652
- const unifiedTo = new UnifiedToCore({
1653
- security: {
1654
- jwt: "<YOUR_API_KEY_HERE>",
1655
- },
1656
- });
1657
-
1658
- async function run() {
1659
- const res = await categoryUpdateTicketingCategory(unifiedTo, {
1660
- ticketingCategory: {},
1661
- connectionId: "<id>",
1662
- id: "<id>",
1663
- });
1664
- if (res.ok) {
1665
- const { value: result } = res;
1666
- console.log(result);
1667
- } else {
1668
- console.log("categoryUpdateTicketingCategory failed:", res.error);
1669
- }
1670
- }
1671
-
1672
- run();
1673
- ```
1674
-
1675
- ### Parameters
1676
-
1677
- | Parameter | Type | Required | Description |
1678
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1679
- | `request` | [operations.UpdateTicketingCategoryRequest](../../sdk/models/operations/updateticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1680
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1681
- | `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. |
1682
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1683
-
1684
- ### Response
1685
-
1686
- **Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
1687
-
1688
- ### Errors
1689
-
1690
- | Error Type | Status Code | Content Type |
1691
- | --------------- | --------------- | --------------- |
1692
- | errors.SDKError | 4XX, 5XX | \*/\* |
1693
-
1694
- ## updateTicketingCustomer
1695
-
1696
- Update a customer
1697
-
1698
- ### Example Usage
1699
-
1700
- <!-- UsageSnippet language="typescript" operationID="updateTicketingCustomer" method="put" path="/ticketing/{connection_id}/customer/{id}" -->
1701
- ```typescript
1702
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1703
-
1704
- const unifiedTo = new UnifiedTo({
1705
- security: {
1706
- jwt: "<YOUR_API_KEY_HERE>",
1707
- },
1708
- });
1709
-
1710
- async function run() {
1711
- const result = await unifiedTo.ticketing.updateTicketingCustomer({
1712
- ticketingCustomer: {},
1713
- connectionId: "<id>",
1714
- id: "<id>",
1715
- });
1716
-
1717
- console.log(result);
1718
- }
1719
-
1720
- run();
1721
- ```
1722
-
1723
- ### Standalone function
1724
-
1725
- The standalone function version of this method:
1726
-
1727
- ```typescript
1728
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1729
- import { ticketingUpdateTicketingCustomer } from "@unified-api/typescript-sdk/funcs/ticketingUpdateTicketingCustomer.js";
1730
-
1731
- // Use `UnifiedToCore` for best tree-shaking performance.
1732
- // You can create one instance of it to use across an application.
1733
- const unifiedTo = new UnifiedToCore({
1734
- security: {
1735
- jwt: "<YOUR_API_KEY_HERE>",
1736
- },
1737
- });
1738
-
1739
- async function run() {
1740
- const res = await ticketingUpdateTicketingCustomer(unifiedTo, {
1741
- ticketingCustomer: {},
1742
- connectionId: "<id>",
1743
- id: "<id>",
1744
- });
1745
- if (res.ok) {
1746
- const { value: result } = res;
1747
- console.log(result);
1748
- } else {
1749
- console.log("ticketingUpdateTicketingCustomer failed:", res.error);
1750
- }
1751
- }
1752
-
1753
- run();
1754
- ```
1755
-
1756
- ### Parameters
1757
-
1758
- | Parameter | Type | Required | Description |
1759
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1760
- | `request` | [operations.UpdateTicketingCustomerRequest](../../sdk/models/operations/updateticketingcustomerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1761
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1762
- | `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. |
1763
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1764
-
1765
- ### Response
1766
-
1767
- **Promise\<[shared.TicketingCustomer](../../sdk/models/shared/ticketingcustomer.md)\>**
1768
-
1769
- ### Errors
1770
-
1771
- | Error Type | Status Code | Content Type |
1772
- | --------------- | --------------- | --------------- |
1773
- | errors.SDKError | 4XX, 5XX | \*/\* |
1774
-
1775
- ## updateTicketingNote
1776
-
1777
- Update a note
1778
-
1779
- ### Example Usage
1780
-
1781
- <!-- UsageSnippet language="typescript" operationID="updateTicketingNote" method="put" path="/ticketing/{connection_id}/note/{id}" -->
1782
- ```typescript
1783
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1784
-
1785
- const unifiedTo = new UnifiedTo({
1786
- security: {
1787
- jwt: "<YOUR_API_KEY_HERE>",
1788
- },
1789
- });
1790
-
1791
- async function run() {
1792
- const result = await unifiedTo.ticketing.updateTicketingNote({
1793
- ticketingNote: {},
1794
- connectionId: "<id>",
1795
- id: "<id>",
1796
- });
1797
-
1798
- console.log(result);
1799
- }
1800
-
1801
- run();
1802
- ```
1803
-
1804
- ### Standalone function
1805
-
1806
- The standalone function version of this method:
1807
-
1808
- ```typescript
1809
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1810
- import { ticketingUpdateTicketingNote } from "@unified-api/typescript-sdk/funcs/ticketingUpdateTicketingNote.js";
1811
-
1812
- // Use `UnifiedToCore` for best tree-shaking performance.
1813
- // You can create one instance of it to use across an application.
1814
- const unifiedTo = new UnifiedToCore({
1815
- security: {
1816
- jwt: "<YOUR_API_KEY_HERE>",
1817
- },
1818
- });
1819
-
1820
- async function run() {
1821
- const res = await ticketingUpdateTicketingNote(unifiedTo, {
1822
- ticketingNote: {},
1823
- connectionId: "<id>",
1824
- id: "<id>",
1825
- });
1826
- if (res.ok) {
1827
- const { value: result } = res;
1828
- console.log(result);
1829
- } else {
1830
- console.log("ticketingUpdateTicketingNote failed:", res.error);
1831
- }
1832
- }
1833
-
1834
- run();
1835
- ```
1836
-
1837
- ### Parameters
1838
-
1839
- | Parameter | Type | Required | Description |
1840
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1841
- | `request` | [operations.UpdateTicketingNoteRequest](../../sdk/models/operations/updateticketingnoterequest.md) | :heavy_check_mark: | The request object to use for the request. |
1842
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1843
- | `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. |
1844
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1845
-
1846
- ### Response
1847
-
1848
- **Promise\<[shared.TicketingNote](../../sdk/models/shared/ticketingnote.md)\>**
1849
-
1850
- ### Errors
1851
-
1852
- | Error Type | Status Code | Content Type |
1853
- | --------------- | --------------- | --------------- |
1854
- | errors.SDKError | 4XX, 5XX | \*/\* |
1855
-
1856
- ## updateTicketingTicket
1857
-
1858
- Update a ticket
1859
-
1860
- ### Example Usage
1861
-
1862
- <!-- UsageSnippet language="typescript" operationID="updateTicketingTicket" method="put" path="/ticketing/{connection_id}/ticket/{id}" -->
1863
- ```typescript
1864
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1865
-
1866
- const unifiedTo = new UnifiedTo({
1867
- security: {
1868
- jwt: "<YOUR_API_KEY_HERE>",
1869
- },
1870
- });
1871
-
1872
- async function run() {
1873
- const result = await unifiedTo.ticketing.updateTicketingTicket({
1874
- ticketingTicket: {},
1875
- connectionId: "<id>",
1876
- id: "<id>",
1877
- });
1878
-
1879
- console.log(result);
1880
- }
1881
-
1882
- run();
1883
- ```
1884
-
1885
- ### Standalone function
1886
-
1887
- The standalone function version of this method:
1888
-
1889
- ```typescript
1890
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1891
- import { ticketingUpdateTicketingTicket } from "@unified-api/typescript-sdk/funcs/ticketingUpdateTicketingTicket.js";
1892
-
1893
- // Use `UnifiedToCore` for best tree-shaking performance.
1894
- // You can create one instance of it to use across an application.
1895
- const unifiedTo = new UnifiedToCore({
1896
- security: {
1897
- jwt: "<YOUR_API_KEY_HERE>",
1898
- },
1899
- });
1900
-
1901
- async function run() {
1902
- const res = await ticketingUpdateTicketingTicket(unifiedTo, {
1903
- ticketingTicket: {},
1904
- connectionId: "<id>",
1905
- id: "<id>",
1906
- });
1907
- if (res.ok) {
1908
- const { value: result } = res;
1909
- console.log(result);
1910
- } else {
1911
- console.log("ticketingUpdateTicketingTicket failed:", res.error);
1912
- }
1913
- }
1914
-
1915
- run();
1916
- ```
1917
-
1918
- ### Parameters
1919
-
1920
- | Parameter | Type | Required | Description |
1921
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1922
- | `request` | [operations.UpdateTicketingTicketRequest](../../sdk/models/operations/updateticketingticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1923
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1924
- | `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. |
1925
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1926
-
1927
- ### Response
1928
-
1929
- **Promise\<[shared.TicketingTicket](../../sdk/models/shared/ticketingticket.md)\>**
1930
-
1931
- ### Errors
1932
-
1933
- | Error Type | Status Code | Content Type |
1934
- | --------------- | --------------- | --------------- |
1935
- | errors.SDKError | 4XX, 5XX | \*/\* |