@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,971 +0,0 @@
1
- # Category
2
- (*category*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createAccountingCategory](#createaccountingcategory) - Create a category
9
- * [createTicketingCategory](#createticketingcategory) - Create a category
10
- * [getAccountingCategory](#getaccountingcategory) - Retrieve a category
11
- * [getTicketingCategory](#getticketingcategory) - Retrieve a category
12
- * [listAccountingCategories](#listaccountingcategories) - List all categories
13
- * [listTicketingCategories](#listticketingcategories) - List all categories
14
- * [patchAccountingCategory](#patchaccountingcategory) - Update a category
15
- * [patchTicketingCategory](#patchticketingcategory) - Update a category
16
- * [removeAccountingCategory](#removeaccountingcategory) - Remove a category
17
- * [removeTicketingCategory](#removeticketingcategory) - Remove a category
18
- * [updateAccountingCategory](#updateaccountingcategory) - Update a category
19
- * [updateTicketingCategory](#updateticketingcategory) - Update a category
20
-
21
- ## createAccountingCategory
22
-
23
- Create a category
24
-
25
- ### Example Usage
26
-
27
- <!-- UsageSnippet language="typescript" operationID="createAccountingCategory" method="post" path="/accounting/{connection_id}/category" -->
28
- ```typescript
29
- import { UnifiedTo } from "@unified-api/typescript-sdk";
30
-
31
- const unifiedTo = new UnifiedTo({
32
- security: {
33
- jwt: "<YOUR_API_KEY_HERE>",
34
- },
35
- });
36
-
37
- async function run() {
38
- const result = await unifiedTo.category.createAccountingCategory({
39
- accountingCategory: {},
40
- connectionId: "<id>",
41
- });
42
-
43
- console.log(result);
44
- }
45
-
46
- run();
47
- ```
48
-
49
- ### Standalone function
50
-
51
- The standalone function version of this method:
52
-
53
- ```typescript
54
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
55
- import { accountingCreateAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingCreateAccountingCategory.js";
56
-
57
- // Use `UnifiedToCore` for best tree-shaking performance.
58
- // You can create one instance of it to use across an application.
59
- const unifiedTo = new UnifiedToCore({
60
- security: {
61
- jwt: "<YOUR_API_KEY_HERE>",
62
- },
63
- });
64
-
65
- async function run() {
66
- const res = await accountingCreateAccountingCategory(unifiedTo, {
67
- accountingCategory: {},
68
- connectionId: "<id>",
69
- });
70
- if (res.ok) {
71
- const { value: result } = res;
72
- console.log(result);
73
- } else {
74
- console.log("accountingCreateAccountingCategory failed:", res.error);
75
- }
76
- }
77
-
78
- run();
79
- ```
80
-
81
- ### Parameters
82
-
83
- | Parameter | Type | Required | Description |
84
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
85
- | `request` | [operations.CreateAccountingCategoryRequest](../../sdk/models/operations/createaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
86
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
87
- | `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. |
88
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
89
-
90
- ### Response
91
-
92
- **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
93
-
94
- ### Errors
95
-
96
- | Error Type | Status Code | Content Type |
97
- | --------------- | --------------- | --------------- |
98
- | errors.SDKError | 4XX, 5XX | \*/\* |
99
-
100
- ## createTicketingCategory
101
-
102
- Create a category
103
-
104
- ### Example Usage
105
-
106
- <!-- UsageSnippet language="typescript" operationID="createTicketingCategory" method="post" path="/ticketing/{connection_id}/category" -->
107
- ```typescript
108
- import { UnifiedTo } from "@unified-api/typescript-sdk";
109
-
110
- const unifiedTo = new UnifiedTo({
111
- security: {
112
- jwt: "<YOUR_API_KEY_HERE>",
113
- },
114
- });
115
-
116
- async function run() {
117
- const result = await unifiedTo.category.createTicketingCategory({
118
- ticketingCategory: {},
119
- connectionId: "<id>",
120
- });
121
-
122
- console.log(result);
123
- }
124
-
125
- run();
126
- ```
127
-
128
- ### Standalone function
129
-
130
- The standalone function version of this method:
131
-
132
- ```typescript
133
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
134
- import { categoryCreateTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryCreateTicketingCategory.js";
135
-
136
- // Use `UnifiedToCore` for best tree-shaking performance.
137
- // You can create one instance of it to use across an application.
138
- const unifiedTo = new UnifiedToCore({
139
- security: {
140
- jwt: "<YOUR_API_KEY_HERE>",
141
- },
142
- });
143
-
144
- async function run() {
145
- const res = await categoryCreateTicketingCategory(unifiedTo, {
146
- ticketingCategory: {},
147
- connectionId: "<id>",
148
- });
149
- if (res.ok) {
150
- const { value: result } = res;
151
- console.log(result);
152
- } else {
153
- console.log("categoryCreateTicketingCategory failed:", res.error);
154
- }
155
- }
156
-
157
- run();
158
- ```
159
-
160
- ### Parameters
161
-
162
- | Parameter | Type | Required | Description |
163
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
164
- | `request` | [operations.CreateTicketingCategoryRequest](../../sdk/models/operations/createticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
165
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
166
- | `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. |
167
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
168
-
169
- ### Response
170
-
171
- **Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
172
-
173
- ### Errors
174
-
175
- | Error Type | Status Code | Content Type |
176
- | --------------- | --------------- | --------------- |
177
- | errors.SDKError | 4XX, 5XX | \*/\* |
178
-
179
- ## getAccountingCategory
180
-
181
- Retrieve a category
182
-
183
- ### Example Usage
184
-
185
- <!-- UsageSnippet language="typescript" operationID="getAccountingCategory" method="get" path="/accounting/{connection_id}/category/{id}" -->
186
- ```typescript
187
- import { UnifiedTo } from "@unified-api/typescript-sdk";
188
-
189
- const unifiedTo = new UnifiedTo({
190
- security: {
191
- jwt: "<YOUR_API_KEY_HERE>",
192
- },
193
- });
194
-
195
- async function run() {
196
- const result = await unifiedTo.category.getAccountingCategory({
197
- connectionId: "<id>",
198
- id: "<id>",
199
- });
200
-
201
- console.log(result);
202
- }
203
-
204
- run();
205
- ```
206
-
207
- ### Standalone function
208
-
209
- The standalone function version of this method:
210
-
211
- ```typescript
212
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
213
- import { accountingGetAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingGetAccountingCategory.js";
214
-
215
- // Use `UnifiedToCore` for best tree-shaking performance.
216
- // You can create one instance of it to use across an application.
217
- const unifiedTo = new UnifiedToCore({
218
- security: {
219
- jwt: "<YOUR_API_KEY_HERE>",
220
- },
221
- });
222
-
223
- async function run() {
224
- const res = await accountingGetAccountingCategory(unifiedTo, {
225
- connectionId: "<id>",
226
- id: "<id>",
227
- });
228
- if (res.ok) {
229
- const { value: result } = res;
230
- console.log(result);
231
- } else {
232
- console.log("accountingGetAccountingCategory failed:", res.error);
233
- }
234
- }
235
-
236
- run();
237
- ```
238
-
239
- ### Parameters
240
-
241
- | Parameter | Type | Required | Description |
242
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
243
- | `request` | [operations.GetAccountingCategoryRequest](../../sdk/models/operations/getaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
244
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
245
- | `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. |
246
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
247
-
248
- ### Response
249
-
250
- **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
251
-
252
- ### Errors
253
-
254
- | Error Type | Status Code | Content Type |
255
- | --------------- | --------------- | --------------- |
256
- | errors.SDKError | 4XX, 5XX | \*/\* |
257
-
258
- ## getTicketingCategory
259
-
260
- Retrieve a category
261
-
262
- ### Example Usage
263
-
264
- <!-- UsageSnippet language="typescript" operationID="getTicketingCategory" method="get" path="/ticketing/{connection_id}/category/{id}" -->
265
- ```typescript
266
- import { UnifiedTo } from "@unified-api/typescript-sdk";
267
-
268
- const unifiedTo = new UnifiedTo({
269
- security: {
270
- jwt: "<YOUR_API_KEY_HERE>",
271
- },
272
- });
273
-
274
- async function run() {
275
- const result = await unifiedTo.category.getTicketingCategory({
276
- connectionId: "<id>",
277
- id: "<id>",
278
- });
279
-
280
- console.log(result);
281
- }
282
-
283
- run();
284
- ```
285
-
286
- ### Standalone function
287
-
288
- The standalone function version of this method:
289
-
290
- ```typescript
291
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
292
- import { categoryGetTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryGetTicketingCategory.js";
293
-
294
- // Use `UnifiedToCore` for best tree-shaking performance.
295
- // You can create one instance of it to use across an application.
296
- const unifiedTo = new UnifiedToCore({
297
- security: {
298
- jwt: "<YOUR_API_KEY_HERE>",
299
- },
300
- });
301
-
302
- async function run() {
303
- const res = await categoryGetTicketingCategory(unifiedTo, {
304
- connectionId: "<id>",
305
- id: "<id>",
306
- });
307
- if (res.ok) {
308
- const { value: result } = res;
309
- console.log(result);
310
- } else {
311
- console.log("categoryGetTicketingCategory failed:", res.error);
312
- }
313
- }
314
-
315
- run();
316
- ```
317
-
318
- ### Parameters
319
-
320
- | Parameter | Type | Required | Description |
321
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
322
- | `request` | [operations.GetTicketingCategoryRequest](../../sdk/models/operations/getticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
323
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
324
- | `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. |
325
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
326
-
327
- ### Response
328
-
329
- **Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
330
-
331
- ### Errors
332
-
333
- | Error Type | Status Code | Content Type |
334
- | --------------- | --------------- | --------------- |
335
- | errors.SDKError | 4XX, 5XX | \*/\* |
336
-
337
- ## listAccountingCategories
338
-
339
- List all categories
340
-
341
- ### Example Usage
342
-
343
- <!-- UsageSnippet language="typescript" operationID="listAccountingCategories" method="get" path="/accounting/{connection_id}/category" -->
344
- ```typescript
345
- import { UnifiedTo } from "@unified-api/typescript-sdk";
346
-
347
- const unifiedTo = new UnifiedTo({
348
- security: {
349
- jwt: "<YOUR_API_KEY_HERE>",
350
- },
351
- });
352
-
353
- async function run() {
354
- const result = await unifiedTo.category.listAccountingCategories({
355
- connectionId: "<id>",
356
- });
357
-
358
- console.log(result);
359
- }
360
-
361
- run();
362
- ```
363
-
364
- ### Standalone function
365
-
366
- The standalone function version of this method:
367
-
368
- ```typescript
369
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
370
- import { accountingListAccountingCategories } from "@unified-api/typescript-sdk/funcs/accountingListAccountingCategories.js";
371
-
372
- // Use `UnifiedToCore` for best tree-shaking performance.
373
- // You can create one instance of it to use across an application.
374
- const unifiedTo = new UnifiedToCore({
375
- security: {
376
- jwt: "<YOUR_API_KEY_HERE>",
377
- },
378
- });
379
-
380
- async function run() {
381
- const res = await accountingListAccountingCategories(unifiedTo, {
382
- connectionId: "<id>",
383
- });
384
- if (res.ok) {
385
- const { value: result } = res;
386
- console.log(result);
387
- } else {
388
- console.log("accountingListAccountingCategories failed:", res.error);
389
- }
390
- }
391
-
392
- run();
393
- ```
394
-
395
- ### Parameters
396
-
397
- | Parameter | Type | Required | Description |
398
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
399
- | `request` | [operations.ListAccountingCategoriesRequest](../../sdk/models/operations/listaccountingcategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
400
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
401
- | `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. |
402
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
403
-
404
- ### Response
405
-
406
- **Promise\<[shared.AccountingCategory[]](../../models/.md)\>**
407
-
408
- ### Errors
409
-
410
- | Error Type | Status Code | Content Type |
411
- | --------------- | --------------- | --------------- |
412
- | errors.SDKError | 4XX, 5XX | \*/\* |
413
-
414
- ## listTicketingCategories
415
-
416
- List all categories
417
-
418
- ### Example Usage
419
-
420
- <!-- UsageSnippet language="typescript" operationID="listTicketingCategories" method="get" path="/ticketing/{connection_id}/category" -->
421
- ```typescript
422
- import { UnifiedTo } from "@unified-api/typescript-sdk";
423
-
424
- const unifiedTo = new UnifiedTo({
425
- security: {
426
- jwt: "<YOUR_API_KEY_HERE>",
427
- },
428
- });
429
-
430
- async function run() {
431
- const result = await unifiedTo.category.listTicketingCategories({
432
- connectionId: "<id>",
433
- });
434
-
435
- console.log(result);
436
- }
437
-
438
- run();
439
- ```
440
-
441
- ### Standalone function
442
-
443
- The standalone function version of this method:
444
-
445
- ```typescript
446
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
447
- import { categoryListTicketingCategories } from "@unified-api/typescript-sdk/funcs/categoryListTicketingCategories.js";
448
-
449
- // Use `UnifiedToCore` for best tree-shaking performance.
450
- // You can create one instance of it to use across an application.
451
- const unifiedTo = new UnifiedToCore({
452
- security: {
453
- jwt: "<YOUR_API_KEY_HERE>",
454
- },
455
- });
456
-
457
- async function run() {
458
- const res = await categoryListTicketingCategories(unifiedTo, {
459
- connectionId: "<id>",
460
- });
461
- if (res.ok) {
462
- const { value: result } = res;
463
- console.log(result);
464
- } else {
465
- console.log("categoryListTicketingCategories failed:", res.error);
466
- }
467
- }
468
-
469
- run();
470
- ```
471
-
472
- ### Parameters
473
-
474
- | Parameter | Type | Required | Description |
475
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
476
- | `request` | [operations.ListTicketingCategoriesRequest](../../sdk/models/operations/listticketingcategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
477
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
478
- | `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. |
479
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
480
-
481
- ### Response
482
-
483
- **Promise\<[shared.TicketingCategory[]](../../models/.md)\>**
484
-
485
- ### Errors
486
-
487
- | Error Type | Status Code | Content Type |
488
- | --------------- | --------------- | --------------- |
489
- | errors.SDKError | 4XX, 5XX | \*/\* |
490
-
491
- ## patchAccountingCategory
492
-
493
- Update a category
494
-
495
- ### Example Usage
496
-
497
- <!-- UsageSnippet language="typescript" operationID="patchAccountingCategory" method="patch" path="/accounting/{connection_id}/category/{id}" -->
498
- ```typescript
499
- import { UnifiedTo } from "@unified-api/typescript-sdk";
500
-
501
- const unifiedTo = new UnifiedTo({
502
- security: {
503
- jwt: "<YOUR_API_KEY_HERE>",
504
- },
505
- });
506
-
507
- async function run() {
508
- const result = await unifiedTo.category.patchAccountingCategory({
509
- accountingCategory: {},
510
- connectionId: "<id>",
511
- id: "<id>",
512
- });
513
-
514
- console.log(result);
515
- }
516
-
517
- run();
518
- ```
519
-
520
- ### Standalone function
521
-
522
- The standalone function version of this method:
523
-
524
- ```typescript
525
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
526
- import { accountingPatchAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingPatchAccountingCategory.js";
527
-
528
- // Use `UnifiedToCore` for best tree-shaking performance.
529
- // You can create one instance of it to use across an application.
530
- const unifiedTo = new UnifiedToCore({
531
- security: {
532
- jwt: "<YOUR_API_KEY_HERE>",
533
- },
534
- });
535
-
536
- async function run() {
537
- const res = await accountingPatchAccountingCategory(unifiedTo, {
538
- accountingCategory: {},
539
- connectionId: "<id>",
540
- id: "<id>",
541
- });
542
- if (res.ok) {
543
- const { value: result } = res;
544
- console.log(result);
545
- } else {
546
- console.log("accountingPatchAccountingCategory failed:", res.error);
547
- }
548
- }
549
-
550
- run();
551
- ```
552
-
553
- ### Parameters
554
-
555
- | Parameter | Type | Required | Description |
556
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
557
- | `request` | [operations.PatchAccountingCategoryRequest](../../sdk/models/operations/patchaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
558
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
559
- | `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. |
560
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
561
-
562
- ### Response
563
-
564
- **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
565
-
566
- ### Errors
567
-
568
- | Error Type | Status Code | Content Type |
569
- | --------------- | --------------- | --------------- |
570
- | errors.SDKError | 4XX, 5XX | \*/\* |
571
-
572
- ## patchTicketingCategory
573
-
574
- Update a category
575
-
576
- ### Example Usage
577
-
578
- <!-- UsageSnippet language="typescript" operationID="patchTicketingCategory" method="patch" path="/ticketing/{connection_id}/category/{id}" -->
579
- ```typescript
580
- import { UnifiedTo } from "@unified-api/typescript-sdk";
581
-
582
- const unifiedTo = new UnifiedTo({
583
- security: {
584
- jwt: "<YOUR_API_KEY_HERE>",
585
- },
586
- });
587
-
588
- async function run() {
589
- const result = await unifiedTo.category.patchTicketingCategory({
590
- ticketingCategory: {},
591
- connectionId: "<id>",
592
- id: "<id>",
593
- });
594
-
595
- console.log(result);
596
- }
597
-
598
- run();
599
- ```
600
-
601
- ### Standalone function
602
-
603
- The standalone function version of this method:
604
-
605
- ```typescript
606
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
607
- import { categoryPatchTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryPatchTicketingCategory.js";
608
-
609
- // Use `UnifiedToCore` for best tree-shaking performance.
610
- // You can create one instance of it to use across an application.
611
- const unifiedTo = new UnifiedToCore({
612
- security: {
613
- jwt: "<YOUR_API_KEY_HERE>",
614
- },
615
- });
616
-
617
- async function run() {
618
- const res = await categoryPatchTicketingCategory(unifiedTo, {
619
- ticketingCategory: {},
620
- connectionId: "<id>",
621
- id: "<id>",
622
- });
623
- if (res.ok) {
624
- const { value: result } = res;
625
- console.log(result);
626
- } else {
627
- console.log("categoryPatchTicketingCategory failed:", res.error);
628
- }
629
- }
630
-
631
- run();
632
- ```
633
-
634
- ### Parameters
635
-
636
- | Parameter | Type | Required | Description |
637
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
638
- | `request` | [operations.PatchTicketingCategoryRequest](../../sdk/models/operations/patchticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
639
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
640
- | `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. |
641
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
642
-
643
- ### Response
644
-
645
- **Promise\<[shared.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
646
-
647
- ### Errors
648
-
649
- | Error Type | Status Code | Content Type |
650
- | --------------- | --------------- | --------------- |
651
- | errors.SDKError | 4XX, 5XX | \*/\* |
652
-
653
- ## removeAccountingCategory
654
-
655
- Remove a category
656
-
657
- ### Example Usage
658
-
659
- <!-- UsageSnippet language="typescript" operationID="removeAccountingCategory" method="delete" path="/accounting/{connection_id}/category/{id}" -->
660
- ```typescript
661
- import { UnifiedTo } from "@unified-api/typescript-sdk";
662
-
663
- const unifiedTo = new UnifiedTo({
664
- security: {
665
- jwt: "<YOUR_API_KEY_HERE>",
666
- },
667
- });
668
-
669
- async function run() {
670
- const result = await unifiedTo.category.removeAccountingCategory({
671
- connectionId: "<id>",
672
- id: "<id>",
673
- });
674
-
675
- console.log(result);
676
- }
677
-
678
- run();
679
- ```
680
-
681
- ### Standalone function
682
-
683
- The standalone function version of this method:
684
-
685
- ```typescript
686
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
687
- import { accountingRemoveAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingRemoveAccountingCategory.js";
688
-
689
- // Use `UnifiedToCore` for best tree-shaking performance.
690
- // You can create one instance of it to use across an application.
691
- const unifiedTo = new UnifiedToCore({
692
- security: {
693
- jwt: "<YOUR_API_KEY_HERE>",
694
- },
695
- });
696
-
697
- async function run() {
698
- const res = await accountingRemoveAccountingCategory(unifiedTo, {
699
- connectionId: "<id>",
700
- id: "<id>",
701
- });
702
- if (res.ok) {
703
- const { value: result } = res;
704
- console.log(result);
705
- } else {
706
- console.log("accountingRemoveAccountingCategory failed:", res.error);
707
- }
708
- }
709
-
710
- run();
711
- ```
712
-
713
- ### Parameters
714
-
715
- | Parameter | Type | Required | Description |
716
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
717
- | `request` | [operations.RemoveAccountingCategoryRequest](../../sdk/models/operations/removeaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
718
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
719
- | `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. |
720
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
721
-
722
- ### Response
723
-
724
- **Promise\<[operations.RemoveAccountingCategoryResponse](../../sdk/models/operations/removeaccountingcategoryresponse.md)\>**
725
-
726
- ### Errors
727
-
728
- | Error Type | Status Code | Content Type |
729
- | --------------- | --------------- | --------------- |
730
- | errors.SDKError | 4XX, 5XX | \*/\* |
731
-
732
- ## removeTicketingCategory
733
-
734
- Remove a category
735
-
736
- ### Example Usage
737
-
738
- <!-- UsageSnippet language="typescript" operationID="removeTicketingCategory" method="delete" path="/ticketing/{connection_id}/category/{id}" -->
739
- ```typescript
740
- import { UnifiedTo } from "@unified-api/typescript-sdk";
741
-
742
- const unifiedTo = new UnifiedTo({
743
- security: {
744
- jwt: "<YOUR_API_KEY_HERE>",
745
- },
746
- });
747
-
748
- async function run() {
749
- const result = await unifiedTo.category.removeTicketingCategory({
750
- connectionId: "<id>",
751
- id: "<id>",
752
- });
753
-
754
- console.log(result);
755
- }
756
-
757
- run();
758
- ```
759
-
760
- ### Standalone function
761
-
762
- The standalone function version of this method:
763
-
764
- ```typescript
765
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
766
- import { categoryRemoveTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryRemoveTicketingCategory.js";
767
-
768
- // Use `UnifiedToCore` for best tree-shaking performance.
769
- // You can create one instance of it to use across an application.
770
- const unifiedTo = new UnifiedToCore({
771
- security: {
772
- jwt: "<YOUR_API_KEY_HERE>",
773
- },
774
- });
775
-
776
- async function run() {
777
- const res = await categoryRemoveTicketingCategory(unifiedTo, {
778
- connectionId: "<id>",
779
- id: "<id>",
780
- });
781
- if (res.ok) {
782
- const { value: result } = res;
783
- console.log(result);
784
- } else {
785
- console.log("categoryRemoveTicketingCategory failed:", res.error);
786
- }
787
- }
788
-
789
- run();
790
- ```
791
-
792
- ### Parameters
793
-
794
- | Parameter | Type | Required | Description |
795
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
796
- | `request` | [operations.RemoveTicketingCategoryRequest](../../sdk/models/operations/removeticketingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
797
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
798
- | `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. |
799
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
800
-
801
- ### Response
802
-
803
- **Promise\<[operations.RemoveTicketingCategoryResponse](../../sdk/models/operations/removeticketingcategoryresponse.md)\>**
804
-
805
- ### Errors
806
-
807
- | Error Type | Status Code | Content Type |
808
- | --------------- | --------------- | --------------- |
809
- | errors.SDKError | 4XX, 5XX | \*/\* |
810
-
811
- ## updateAccountingCategory
812
-
813
- Update a category
814
-
815
- ### Example Usage
816
-
817
- <!-- UsageSnippet language="typescript" operationID="updateAccountingCategory" method="put" path="/accounting/{connection_id}/category/{id}" -->
818
- ```typescript
819
- import { UnifiedTo } from "@unified-api/typescript-sdk";
820
-
821
- const unifiedTo = new UnifiedTo({
822
- security: {
823
- jwt: "<YOUR_API_KEY_HERE>",
824
- },
825
- });
826
-
827
- async function run() {
828
- const result = await unifiedTo.category.updateAccountingCategory({
829
- accountingCategory: {},
830
- connectionId: "<id>",
831
- id: "<id>",
832
- });
833
-
834
- console.log(result);
835
- }
836
-
837
- run();
838
- ```
839
-
840
- ### Standalone function
841
-
842
- The standalone function version of this method:
843
-
844
- ```typescript
845
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
846
- import { accountingUpdateAccountingCategory } from "@unified-api/typescript-sdk/funcs/accountingUpdateAccountingCategory.js";
847
-
848
- // Use `UnifiedToCore` for best tree-shaking performance.
849
- // You can create one instance of it to use across an application.
850
- const unifiedTo = new UnifiedToCore({
851
- security: {
852
- jwt: "<YOUR_API_KEY_HERE>",
853
- },
854
- });
855
-
856
- async function run() {
857
- const res = await accountingUpdateAccountingCategory(unifiedTo, {
858
- accountingCategory: {},
859
- connectionId: "<id>",
860
- id: "<id>",
861
- });
862
- if (res.ok) {
863
- const { value: result } = res;
864
- console.log(result);
865
- } else {
866
- console.log("accountingUpdateAccountingCategory failed:", res.error);
867
- }
868
- }
869
-
870
- run();
871
- ```
872
-
873
- ### Parameters
874
-
875
- | Parameter | Type | Required | Description |
876
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
877
- | `request` | [operations.UpdateAccountingCategoryRequest](../../sdk/models/operations/updateaccountingcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
878
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
879
- | `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. |
880
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
881
-
882
- ### Response
883
-
884
- **Promise\<[shared.AccountingCategory](../../sdk/models/shared/accountingcategory.md)\>**
885
-
886
- ### Errors
887
-
888
- | Error Type | Status Code | Content Type |
889
- | --------------- | --------------- | --------------- |
890
- | errors.SDKError | 4XX, 5XX | \*/\* |
891
-
892
- ## updateTicketingCategory
893
-
894
- Update a category
895
-
896
- ### Example Usage
897
-
898
- <!-- UsageSnippet language="typescript" operationID="updateTicketingCategory" method="put" path="/ticketing/{connection_id}/category/{id}" -->
899
- ```typescript
900
- import { UnifiedTo } from "@unified-api/typescript-sdk";
901
-
902
- const unifiedTo = new UnifiedTo({
903
- security: {
904
- jwt: "<YOUR_API_KEY_HERE>",
905
- },
906
- });
907
-
908
- async function run() {
909
- const result = await unifiedTo.category.updateTicketingCategory({
910
- ticketingCategory: {},
911
- connectionId: "<id>",
912
- id: "<id>",
913
- });
914
-
915
- console.log(result);
916
- }
917
-
918
- run();
919
- ```
920
-
921
- ### Standalone function
922
-
923
- The standalone function version of this method:
924
-
925
- ```typescript
926
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
927
- import { categoryUpdateTicketingCategory } from "@unified-api/typescript-sdk/funcs/categoryUpdateTicketingCategory.js";
928
-
929
- // Use `UnifiedToCore` for best tree-shaking performance.
930
- // You can create one instance of it to use across an application.
931
- const unifiedTo = new UnifiedToCore({
932
- security: {
933
- jwt: "<YOUR_API_KEY_HERE>",
934
- },
935
- });
936
-
937
- async function run() {
938
- const res = await categoryUpdateTicketingCategory(unifiedTo, {
939
- ticketingCategory: {},
940
- connectionId: "<id>",
941
- id: "<id>",
942
- });
943
- if (res.ok) {
944
- const { value: result } = res;
945
- console.log(result);
946
- } else {
947
- console.log("categoryUpdateTicketingCategory failed:", res.error);
948
- }
949
- }
950
-
951
- run();
952
- ```
953
-
954
- ### Parameters
955
-
956
- | Parameter | Type | Required | Description |
957
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
958
- | `request` | [operations.UpdateTicketingCategoryRequest](../../sdk/models/operations/updateticketingcategoryrequest.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.TicketingCategory](../../sdk/models/shared/ticketingcategory.md)\>**
966
-
967
- ### Errors
968
-
969
- | Error Type | Status Code | Content Type |
970
- | --------------- | --------------- | --------------- |
971
- | errors.SDKError | 4XX, 5XX | \*/\* |