@unified-api/typescript-sdk 2.9.4 → 2.9.6

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 (137) hide show
  1. package/FUNCTIONS.md +108 -0
  2. package/README.md +36 -15
  3. package/RUNTIMES.md +22 -0
  4. package/docs/sdks/account/README.md +501 -0
  5. package/docs/sdks/accounting/README.md +3629 -0
  6. package/docs/sdks/activity/README.md +501 -0
  7. package/docs/sdks/apicall/README.md +165 -0
  8. package/docs/sdks/application/README.md +501 -0
  9. package/docs/sdks/applicationstatus/README.md +88 -0
  10. package/docs/sdks/ats/README.md +3710 -0
  11. package/docs/sdks/auth/README.md +173 -0
  12. package/docs/sdks/branch/README.md +501 -0
  13. package/docs/sdks/call/README.md +88 -0
  14. package/docs/sdks/candidate/README.md +501 -0
  15. package/docs/sdks/channel/README.md +171 -0
  16. package/docs/sdks/class/README.md +501 -0
  17. package/docs/sdks/collection/README.md +501 -0
  18. package/docs/sdks/commerce/README.md +2477 -0
  19. package/docs/sdks/commit/README.md +501 -0
  20. package/docs/sdks/company/README.md +1240 -0
  21. package/docs/sdks/connection/README.md +485 -0
  22. package/docs/sdks/contact/README.md +1489 -0
  23. package/docs/sdks/course/README.md +501 -0
  24. package/docs/sdks/crm/README.md +2971 -0
  25. package/docs/sdks/customer/README.md +501 -0
  26. package/docs/sdks/deal/README.md +501 -0
  27. package/docs/sdks/document/README.md +501 -0
  28. package/docs/sdks/employee/README.md +501 -0
  29. package/docs/sdks/enrich/README.md +169 -0
  30. package/docs/sdks/event/README.md +501 -0
  31. package/docs/sdks/file/README.md +501 -0
  32. package/docs/sdks/genai/README.md +169 -0
  33. package/docs/sdks/group/README.md +995 -0
  34. package/docs/sdks/hris/README.md +2311 -0
  35. package/docs/sdks/instructor/README.md +501 -0
  36. package/docs/sdks/integration/README.md +248 -0
  37. package/docs/sdks/interview/README.md +501 -0
  38. package/docs/sdks/inventory/README.md +501 -0
  39. package/docs/sdks/invoice/README.md +501 -0
  40. package/docs/sdks/issue/README.md +84 -0
  41. package/docs/sdks/item/README.md +501 -0
  42. package/docs/sdks/job/README.md +501 -0
  43. package/docs/sdks/journal/README.md +501 -0
  44. package/docs/sdks/kms/README.md +995 -0
  45. package/docs/sdks/lead/README.md +501 -0
  46. package/docs/sdks/link/README.md +501 -0
  47. package/docs/sdks/list/README.md +501 -0
  48. package/docs/sdks/lms/README.md +1983 -0
  49. package/docs/sdks/location/README.md +995 -0
  50. package/docs/sdks/login/README.md +90 -0
  51. package/docs/sdks/martech/README.md +995 -0
  52. package/docs/sdks/member/README.md +501 -0
  53. package/docs/sdks/message/README.md +501 -0
  54. package/docs/sdks/messaging/README.md +665 -0
  55. package/docs/sdks/metadata/README.md +501 -0
  56. package/docs/sdks/model/README.md +88 -0
  57. package/docs/sdks/note/README.md +501 -0
  58. package/docs/sdks/order/README.md +501 -0
  59. package/docs/sdks/organization/README.md +665 -0
  60. package/docs/sdks/page/README.md +501 -0
  61. package/docs/sdks/passthrough/README.md +671 -0
  62. package/docs/sdks/payment/README.md +1323 -0
  63. package/docs/sdks/payout/README.md +171 -0
  64. package/docs/sdks/payslip/README.md +171 -0
  65. package/docs/sdks/person/README.md +88 -0
  66. package/docs/sdks/pipeline/README.md +501 -0
  67. package/docs/sdks/project/README.md +501 -0
  68. package/docs/sdks/prompt/README.md +88 -0
  69. package/docs/sdks/pullrequest/README.md +501 -0
  70. package/docs/sdks/refund/README.md +171 -0
  71. package/docs/sdks/repo/README.md +2477 -0
  72. package/docs/sdks/repository/README.md +501 -0
  73. package/docs/sdks/scim/README.md +995 -0
  74. package/docs/sdks/scorecard/README.md +501 -0
  75. package/docs/sdks/space/README.md +501 -0
  76. package/docs/sdks/storage/README.md +501 -0
  77. package/docs/sdks/student/README.md +501 -0
  78. package/docs/sdks/task/README.md +995 -0
  79. package/docs/sdks/taxrate/README.md +501 -0
  80. package/docs/sdks/ticket/README.md +501 -0
  81. package/docs/sdks/ticketing/README.md +1489 -0
  82. package/docs/sdks/timeoff/README.md +171 -0
  83. package/docs/sdks/transaction/README.md +501 -0
  84. package/docs/sdks/uc/README.md +582 -0
  85. package/docs/sdks/unified/README.md +1601 -0
  86. package/docs/sdks/unifiedto/README.md +7 -0
  87. package/docs/sdks/user/README.md +501 -0
  88. package/docs/sdks/webhook/README.md +647 -0
  89. package/lib/config.d.ts +3 -3
  90. package/lib/config.js +3 -3
  91. package/lib/primitives.d.ts +2 -0
  92. package/lib/primitives.d.ts.map +1 -1
  93. package/lib/primitives.js +53 -0
  94. package/lib/primitives.js.map +1 -1
  95. package/package.json +3 -1
  96. package/sdk/models/shared/crmcontact.d.ts +2 -0
  97. package/sdk/models/shared/crmcontact.d.ts.map +1 -1
  98. package/sdk/models/shared/crmcontact.js +4 -0
  99. package/sdk/models/shared/crmcontact.js.map +1 -1
  100. package/sdk/models/shared/crmlead.d.ts +2 -0
  101. package/sdk/models/shared/crmlead.d.ts.map +1 -1
  102. package/sdk/models/shared/crmlead.js +4 -0
  103. package/sdk/models/shared/crmlead.js.map +1 -1
  104. package/sdk/models/shared/index.d.ts +1 -0
  105. package/sdk/models/shared/index.d.ts.map +1 -1
  106. package/sdk/models/shared/index.js +1 -0
  107. package/sdk/models/shared/index.js.map +1 -1
  108. package/sdk/models/shared/kmspage.d.ts +5 -0
  109. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  110. package/sdk/models/shared/kmspage.js +7 -0
  111. package/sdk/models/shared/kmspage.js.map +1 -1
  112. package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
  113. package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
  114. package/sdk/models/shared/kmspagemetadata.js +63 -0
  115. package/sdk/models/shared/kmspagemetadata.js.map +1 -0
  116. package/sdk/models/shared/kmsspace.d.ts +2 -0
  117. package/sdk/models/shared/kmsspace.d.ts.map +1 -1
  118. package/sdk/models/shared/kmsspace.js +4 -0
  119. package/sdk/models/shared/kmsspace.js.map +1 -1
  120. package/sdk/models/shared/security.d.ts +2 -2
  121. package/sdk/models/shared/security.d.ts.map +1 -1
  122. package/sdk/models/shared/security.js +2 -2
  123. package/sdk/models/shared/security.js.map +1 -1
  124. package/sdk/types/operations.d.ts +5 -3
  125. package/sdk/types/operations.d.ts.map +1 -1
  126. package/sdk/types/operations.js +3 -0
  127. package/sdk/types/operations.js.map +1 -1
  128. package/src/lib/config.ts +3 -3
  129. package/src/lib/primitives.ts +62 -0
  130. package/src/sdk/models/shared/crmcontact.ts +6 -0
  131. package/src/sdk/models/shared/crmlead.ts +6 -0
  132. package/src/sdk/models/shared/index.ts +1 -0
  133. package/src/sdk/models/shared/kmspage.ts +16 -0
  134. package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
  135. package/src/sdk/models/shared/kmsspace.ts +6 -0
  136. package/src/sdk/models/shared/security.ts +4 -4
  137. package/src/sdk/types/operations.ts +11 -5
@@ -0,0 +1,1489 @@
1
+ # Contact
2
+ (*contact*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [createAccountingContact](#createaccountingcontact) - Create a contact
9
+ * [createCrmContact](#createcrmcontact) - Create a contact
10
+ * [createUcContact](#createuccontact) - Create a contact
11
+ * [getAccountingContact](#getaccountingcontact) - Retrieve a contact
12
+ * [getCrmContact](#getcrmcontact) - Retrieve a contact
13
+ * [getUcContact](#getuccontact) - Retrieve a contact
14
+ * [listAccountingContacts](#listaccountingcontacts) - List all contacts
15
+ * [listCrmContacts](#listcrmcontacts) - List all contacts
16
+ * [listUcContacts](#listuccontacts) - List all contacts
17
+ * [patchAccountingContact](#patchaccountingcontact) - Update a contact
18
+ * [patchCrmContact](#patchcrmcontact) - Update a contact
19
+ * [patchUcContact](#patchuccontact) - Update a contact
20
+ * [removeAccountingContact](#removeaccountingcontact) - Remove a contact
21
+ * [removeCrmContact](#removecrmcontact) - Remove a contact
22
+ * [removeUcContact](#removeuccontact) - Remove a contact
23
+ * [updateAccountingContact](#updateaccountingcontact) - Update a contact
24
+ * [updateCrmContact](#updatecrmcontact) - Update a contact
25
+ * [updateUcContact](#updateuccontact) - Update a contact
26
+
27
+ ## createAccountingContact
28
+
29
+ Create a contact
30
+
31
+ ### Example Usage
32
+
33
+ ```typescript
34
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
35
+
36
+ const unifiedTo = new UnifiedTo({
37
+ security: {
38
+ jwt: "<YOUR_API_KEY_HERE>",
39
+ },
40
+ });
41
+
42
+ async function run() {
43
+ const result = await unifiedTo.contact.createAccountingContact({
44
+ connectionId: "<value>",
45
+ });
46
+
47
+ // Handle the result
48
+ console.log(result);
49
+ }
50
+
51
+ run();
52
+ ```
53
+
54
+ ### Standalone function
55
+
56
+ The standalone function version of this method:
57
+
58
+ ```typescript
59
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
60
+ import { contactCreateAccountingContact } from "@unified-api/typescript-sdk/funcs/contactCreateAccountingContact.js";
61
+
62
+ // Use `UnifiedToCore` for best tree-shaking performance.
63
+ // You can create one instance of it to use across an application.
64
+ const unifiedTo = new UnifiedToCore({
65
+ security: {
66
+ jwt: "<YOUR_API_KEY_HERE>",
67
+ },
68
+ });
69
+
70
+ async function run() {
71
+ const res = await contactCreateAccountingContact(unifiedTo, {
72
+ connectionId: "<value>",
73
+ });
74
+
75
+ if (!res.ok) {
76
+ throw res.error;
77
+ }
78
+
79
+ const { value: result } = res;
80
+
81
+ // Handle the result
82
+ console.log(result);
83
+ }
84
+
85
+ run();
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ | Parameter | Type | Required | Description |
91
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
92
+ | `request` | [operations.CreateAccountingContactRequest](../../sdk/models/operations/createaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
93
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
94
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
95
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
96
+
97
+ ### Response
98
+
99
+ **Promise\<[shared.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
100
+
101
+ ### Errors
102
+
103
+ | Error Type | Status Code | Content Type |
104
+ | --------------- | --------------- | --------------- |
105
+ | errors.SDKError | 4XX, 5XX | \*/\* |
106
+
107
+ ## createCrmContact
108
+
109
+ Create a contact
110
+
111
+ ### Example Usage
112
+
113
+ ```typescript
114
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
115
+
116
+ const unifiedTo = new UnifiedTo({
117
+ security: {
118
+ jwt: "<YOUR_API_KEY_HERE>",
119
+ },
120
+ });
121
+
122
+ async function run() {
123
+ const result = await unifiedTo.contact.createCrmContact({
124
+ connectionId: "<value>",
125
+ });
126
+
127
+ // Handle the result
128
+ console.log(result);
129
+ }
130
+
131
+ run();
132
+ ```
133
+
134
+ ### Standalone function
135
+
136
+ The standalone function version of this method:
137
+
138
+ ```typescript
139
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
140
+ import { contactCreateCrmContact } from "@unified-api/typescript-sdk/funcs/contactCreateCrmContact.js";
141
+
142
+ // Use `UnifiedToCore` for best tree-shaking performance.
143
+ // You can create one instance of it to use across an application.
144
+ const unifiedTo = new UnifiedToCore({
145
+ security: {
146
+ jwt: "<YOUR_API_KEY_HERE>",
147
+ },
148
+ });
149
+
150
+ async function run() {
151
+ const res = await contactCreateCrmContact(unifiedTo, {
152
+ connectionId: "<value>",
153
+ });
154
+
155
+ if (!res.ok) {
156
+ throw res.error;
157
+ }
158
+
159
+ const { value: result } = res;
160
+
161
+ // Handle the result
162
+ console.log(result);
163
+ }
164
+
165
+ run();
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+ | Parameter | Type | Required | Description |
171
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
172
+ | `request` | [operations.CreateCrmContactRequest](../../sdk/models/operations/createcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
173
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
174
+ | `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. |
175
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
176
+
177
+ ### Response
178
+
179
+ **Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
180
+
181
+ ### Errors
182
+
183
+ | Error Type | Status Code | Content Type |
184
+ | --------------- | --------------- | --------------- |
185
+ | errors.SDKError | 4XX, 5XX | \*/\* |
186
+
187
+ ## createUcContact
188
+
189
+ Create a contact
190
+
191
+ ### Example Usage
192
+
193
+ ```typescript
194
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
195
+
196
+ const unifiedTo = new UnifiedTo({
197
+ security: {
198
+ jwt: "<YOUR_API_KEY_HERE>",
199
+ },
200
+ });
201
+
202
+ async function run() {
203
+ const result = await unifiedTo.contact.createUcContact({
204
+ connectionId: "<value>",
205
+ });
206
+
207
+ // Handle the result
208
+ console.log(result);
209
+ }
210
+
211
+ run();
212
+ ```
213
+
214
+ ### Standalone function
215
+
216
+ The standalone function version of this method:
217
+
218
+ ```typescript
219
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
220
+ import { contactCreateUcContact } from "@unified-api/typescript-sdk/funcs/contactCreateUcContact.js";
221
+
222
+ // Use `UnifiedToCore` for best tree-shaking performance.
223
+ // You can create one instance of it to use across an application.
224
+ const unifiedTo = new UnifiedToCore({
225
+ security: {
226
+ jwt: "<YOUR_API_KEY_HERE>",
227
+ },
228
+ });
229
+
230
+ async function run() {
231
+ const res = await contactCreateUcContact(unifiedTo, {
232
+ connectionId: "<value>",
233
+ });
234
+
235
+ if (!res.ok) {
236
+ throw res.error;
237
+ }
238
+
239
+ const { value: result } = res;
240
+
241
+ // Handle the result
242
+ console.log(result);
243
+ }
244
+
245
+ run();
246
+ ```
247
+
248
+ ### Parameters
249
+
250
+ | Parameter | Type | Required | Description |
251
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
252
+ | `request` | [operations.CreateUcContactRequest](../../sdk/models/operations/createuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
253
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
254
+ | `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. |
255
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
256
+
257
+ ### Response
258
+
259
+ **Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
260
+
261
+ ### Errors
262
+
263
+ | Error Type | Status Code | Content Type |
264
+ | --------------- | --------------- | --------------- |
265
+ | errors.SDKError | 4XX, 5XX | \*/\* |
266
+
267
+ ## getAccountingContact
268
+
269
+ Retrieve a contact
270
+
271
+ ### Example Usage
272
+
273
+ ```typescript
274
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
275
+
276
+ const unifiedTo = new UnifiedTo({
277
+ security: {
278
+ jwt: "<YOUR_API_KEY_HERE>",
279
+ },
280
+ });
281
+
282
+ async function run() {
283
+ const result = await unifiedTo.contact.getAccountingContact({
284
+ connectionId: "<value>",
285
+ id: "<id>",
286
+ });
287
+
288
+ // Handle the result
289
+ console.log(result);
290
+ }
291
+
292
+ run();
293
+ ```
294
+
295
+ ### Standalone function
296
+
297
+ The standalone function version of this method:
298
+
299
+ ```typescript
300
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
301
+ import { contactGetAccountingContact } from "@unified-api/typescript-sdk/funcs/contactGetAccountingContact.js";
302
+
303
+ // Use `UnifiedToCore` for best tree-shaking performance.
304
+ // You can create one instance of it to use across an application.
305
+ const unifiedTo = new UnifiedToCore({
306
+ security: {
307
+ jwt: "<YOUR_API_KEY_HERE>",
308
+ },
309
+ });
310
+
311
+ async function run() {
312
+ const res = await contactGetAccountingContact(unifiedTo, {
313
+ connectionId: "<value>",
314
+ id: "<id>",
315
+ });
316
+
317
+ if (!res.ok) {
318
+ throw res.error;
319
+ }
320
+
321
+ const { value: result } = res;
322
+
323
+ // Handle the result
324
+ console.log(result);
325
+ }
326
+
327
+ run();
328
+ ```
329
+
330
+ ### Parameters
331
+
332
+ | Parameter | Type | Required | Description |
333
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
334
+ | `request` | [operations.GetAccountingContactRequest](../../sdk/models/operations/getaccountingcontactrequest.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.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
342
+
343
+ ### Errors
344
+
345
+ | Error Type | Status Code | Content Type |
346
+ | --------------- | --------------- | --------------- |
347
+ | errors.SDKError | 4XX, 5XX | \*/\* |
348
+
349
+ ## getCrmContact
350
+
351
+ Retrieve a contact
352
+
353
+ ### Example Usage
354
+
355
+ ```typescript
356
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
357
+
358
+ const unifiedTo = new UnifiedTo({
359
+ security: {
360
+ jwt: "<YOUR_API_KEY_HERE>",
361
+ },
362
+ });
363
+
364
+ async function run() {
365
+ const result = await unifiedTo.contact.getCrmContact({
366
+ connectionId: "<value>",
367
+ id: "<id>",
368
+ });
369
+
370
+ // Handle the result
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 { contactGetCrmContact } from "@unified-api/typescript-sdk/funcs/contactGetCrmContact.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 contactGetCrmContact(unifiedTo, {
395
+ connectionId: "<value>",
396
+ id: "<id>",
397
+ });
398
+
399
+ if (!res.ok) {
400
+ throw res.error;
401
+ }
402
+
403
+ const { value: result } = res;
404
+
405
+ // Handle the result
406
+ console.log(result);
407
+ }
408
+
409
+ run();
410
+ ```
411
+
412
+ ### Parameters
413
+
414
+ | Parameter | Type | Required | Description |
415
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
416
+ | `request` | [operations.GetCrmContactRequest](../../sdk/models/operations/getcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
417
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
418
+ | `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. |
419
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
420
+
421
+ ### Response
422
+
423
+ **Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
424
+
425
+ ### Errors
426
+
427
+ | Error Type | Status Code | Content Type |
428
+ | --------------- | --------------- | --------------- |
429
+ | errors.SDKError | 4XX, 5XX | \*/\* |
430
+
431
+ ## getUcContact
432
+
433
+ Retrieve a contact
434
+
435
+ ### Example Usage
436
+
437
+ ```typescript
438
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
439
+
440
+ const unifiedTo = new UnifiedTo({
441
+ security: {
442
+ jwt: "<YOUR_API_KEY_HERE>",
443
+ },
444
+ });
445
+
446
+ async function run() {
447
+ const result = await unifiedTo.contact.getUcContact({
448
+ connectionId: "<value>",
449
+ id: "<id>",
450
+ });
451
+
452
+ // Handle the result
453
+ console.log(result);
454
+ }
455
+
456
+ run();
457
+ ```
458
+
459
+ ### Standalone function
460
+
461
+ The standalone function version of this method:
462
+
463
+ ```typescript
464
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
465
+ import { contactGetUcContact } from "@unified-api/typescript-sdk/funcs/contactGetUcContact.js";
466
+
467
+ // Use `UnifiedToCore` for best tree-shaking performance.
468
+ // You can create one instance of it to use across an application.
469
+ const unifiedTo = new UnifiedToCore({
470
+ security: {
471
+ jwt: "<YOUR_API_KEY_HERE>",
472
+ },
473
+ });
474
+
475
+ async function run() {
476
+ const res = await contactGetUcContact(unifiedTo, {
477
+ connectionId: "<value>",
478
+ id: "<id>",
479
+ });
480
+
481
+ if (!res.ok) {
482
+ throw res.error;
483
+ }
484
+
485
+ const { value: result } = res;
486
+
487
+ // Handle the result
488
+ console.log(result);
489
+ }
490
+
491
+ run();
492
+ ```
493
+
494
+ ### Parameters
495
+
496
+ | Parameter | Type | Required | Description |
497
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
498
+ | `request` | [operations.GetUcContactRequest](../../sdk/models/operations/getuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
499
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
500
+ | `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. |
501
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
502
+
503
+ ### Response
504
+
505
+ **Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
506
+
507
+ ### Errors
508
+
509
+ | Error Type | Status Code | Content Type |
510
+ | --------------- | --------------- | --------------- |
511
+ | errors.SDKError | 4XX, 5XX | \*/\* |
512
+
513
+ ## listAccountingContacts
514
+
515
+ List all contacts
516
+
517
+ ### Example Usage
518
+
519
+ ```typescript
520
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
521
+
522
+ const unifiedTo = new UnifiedTo({
523
+ security: {
524
+ jwt: "<YOUR_API_KEY_HERE>",
525
+ },
526
+ });
527
+
528
+ async function run() {
529
+ const result = await unifiedTo.contact.listAccountingContacts({
530
+ connectionId: "<value>",
531
+ });
532
+
533
+ // Handle the result
534
+ console.log(result);
535
+ }
536
+
537
+ run();
538
+ ```
539
+
540
+ ### Standalone function
541
+
542
+ The standalone function version of this method:
543
+
544
+ ```typescript
545
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
546
+ import { contactListAccountingContacts } from "@unified-api/typescript-sdk/funcs/contactListAccountingContacts.js";
547
+
548
+ // Use `UnifiedToCore` for best tree-shaking performance.
549
+ // You can create one instance of it to use across an application.
550
+ const unifiedTo = new UnifiedToCore({
551
+ security: {
552
+ jwt: "<YOUR_API_KEY_HERE>",
553
+ },
554
+ });
555
+
556
+ async function run() {
557
+ const res = await contactListAccountingContacts(unifiedTo, {
558
+ connectionId: "<value>",
559
+ });
560
+
561
+ if (!res.ok) {
562
+ throw res.error;
563
+ }
564
+
565
+ const { value: result } = res;
566
+
567
+ // Handle the result
568
+ console.log(result);
569
+ }
570
+
571
+ run();
572
+ ```
573
+
574
+ ### Parameters
575
+
576
+ | Parameter | Type | Required | Description |
577
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
578
+ | `request` | [operations.ListAccountingContactsRequest](../../sdk/models/operations/listaccountingcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
579
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
580
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
581
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
582
+
583
+ ### Response
584
+
585
+ **Promise\<[shared.AccountingContact[]](../../models/.md)\>**
586
+
587
+ ### Errors
588
+
589
+ | Error Type | Status Code | Content Type |
590
+ | --------------- | --------------- | --------------- |
591
+ | errors.SDKError | 4XX, 5XX | \*/\* |
592
+
593
+ ## listCrmContacts
594
+
595
+ List all contacts
596
+
597
+ ### Example Usage
598
+
599
+ ```typescript
600
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
601
+
602
+ const unifiedTo = new UnifiedTo({
603
+ security: {
604
+ jwt: "<YOUR_API_KEY_HERE>",
605
+ },
606
+ });
607
+
608
+ async function run() {
609
+ const result = await unifiedTo.contact.listCrmContacts({
610
+ connectionId: "<value>",
611
+ });
612
+
613
+ // Handle the result
614
+ console.log(result);
615
+ }
616
+
617
+ run();
618
+ ```
619
+
620
+ ### Standalone function
621
+
622
+ The standalone function version of this method:
623
+
624
+ ```typescript
625
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
626
+ import { contactListCrmContacts } from "@unified-api/typescript-sdk/funcs/contactListCrmContacts.js";
627
+
628
+ // Use `UnifiedToCore` for best tree-shaking performance.
629
+ // You can create one instance of it to use across an application.
630
+ const unifiedTo = new UnifiedToCore({
631
+ security: {
632
+ jwt: "<YOUR_API_KEY_HERE>",
633
+ },
634
+ });
635
+
636
+ async function run() {
637
+ const res = await contactListCrmContacts(unifiedTo, {
638
+ connectionId: "<value>",
639
+ });
640
+
641
+ if (!res.ok) {
642
+ throw res.error;
643
+ }
644
+
645
+ const { value: result } = res;
646
+
647
+ // Handle the result
648
+ console.log(result);
649
+ }
650
+
651
+ run();
652
+ ```
653
+
654
+ ### Parameters
655
+
656
+ | Parameter | Type | Required | Description |
657
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
658
+ | `request` | [operations.ListCrmContactsRequest](../../sdk/models/operations/listcrmcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
659
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
660
+ | `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. |
661
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
662
+
663
+ ### Response
664
+
665
+ **Promise\<[shared.CrmContact[]](../../models/.md)\>**
666
+
667
+ ### Errors
668
+
669
+ | Error Type | Status Code | Content Type |
670
+ | --------------- | --------------- | --------------- |
671
+ | errors.SDKError | 4XX, 5XX | \*/\* |
672
+
673
+ ## listUcContacts
674
+
675
+ List all contacts
676
+
677
+ ### Example Usage
678
+
679
+ ```typescript
680
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
681
+
682
+ const unifiedTo = new UnifiedTo({
683
+ security: {
684
+ jwt: "<YOUR_API_KEY_HERE>",
685
+ },
686
+ });
687
+
688
+ async function run() {
689
+ const result = await unifiedTo.contact.listUcContacts({
690
+ connectionId: "<value>",
691
+ });
692
+
693
+ // Handle the result
694
+ console.log(result);
695
+ }
696
+
697
+ run();
698
+ ```
699
+
700
+ ### Standalone function
701
+
702
+ The standalone function version of this method:
703
+
704
+ ```typescript
705
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
706
+ import { contactListUcContacts } from "@unified-api/typescript-sdk/funcs/contactListUcContacts.js";
707
+
708
+ // Use `UnifiedToCore` for best tree-shaking performance.
709
+ // You can create one instance of it to use across an application.
710
+ const unifiedTo = new UnifiedToCore({
711
+ security: {
712
+ jwt: "<YOUR_API_KEY_HERE>",
713
+ },
714
+ });
715
+
716
+ async function run() {
717
+ const res = await contactListUcContacts(unifiedTo, {
718
+ connectionId: "<value>",
719
+ });
720
+
721
+ if (!res.ok) {
722
+ throw res.error;
723
+ }
724
+
725
+ const { value: result } = res;
726
+
727
+ // Handle the result
728
+ console.log(result);
729
+ }
730
+
731
+ run();
732
+ ```
733
+
734
+ ### Parameters
735
+
736
+ | Parameter | Type | Required | Description |
737
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
738
+ | `request` | [operations.ListUcContactsRequest](../../sdk/models/operations/listuccontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
739
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
740
+ | `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. |
741
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
742
+
743
+ ### Response
744
+
745
+ **Promise\<[shared.UcContact[]](../../models/.md)\>**
746
+
747
+ ### Errors
748
+
749
+ | Error Type | Status Code | Content Type |
750
+ | --------------- | --------------- | --------------- |
751
+ | errors.SDKError | 4XX, 5XX | \*/\* |
752
+
753
+ ## patchAccountingContact
754
+
755
+ Update a contact
756
+
757
+ ### Example Usage
758
+
759
+ ```typescript
760
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
761
+
762
+ const unifiedTo = new UnifiedTo({
763
+ security: {
764
+ jwt: "<YOUR_API_KEY_HERE>",
765
+ },
766
+ });
767
+
768
+ async function run() {
769
+ const result = await unifiedTo.contact.patchAccountingContact({
770
+ connectionId: "<value>",
771
+ id: "<id>",
772
+ });
773
+
774
+ // Handle the result
775
+ console.log(result);
776
+ }
777
+
778
+ run();
779
+ ```
780
+
781
+ ### Standalone function
782
+
783
+ The standalone function version of this method:
784
+
785
+ ```typescript
786
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
787
+ import { contactPatchAccountingContact } from "@unified-api/typescript-sdk/funcs/contactPatchAccountingContact.js";
788
+
789
+ // Use `UnifiedToCore` for best tree-shaking performance.
790
+ // You can create one instance of it to use across an application.
791
+ const unifiedTo = new UnifiedToCore({
792
+ security: {
793
+ jwt: "<YOUR_API_KEY_HERE>",
794
+ },
795
+ });
796
+
797
+ async function run() {
798
+ const res = await contactPatchAccountingContact(unifiedTo, {
799
+ connectionId: "<value>",
800
+ id: "<id>",
801
+ });
802
+
803
+ if (!res.ok) {
804
+ throw res.error;
805
+ }
806
+
807
+ const { value: result } = res;
808
+
809
+ // Handle the result
810
+ console.log(result);
811
+ }
812
+
813
+ run();
814
+ ```
815
+
816
+ ### Parameters
817
+
818
+ | Parameter | Type | Required | Description |
819
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
820
+ | `request` | [operations.PatchAccountingContactRequest](../../sdk/models/operations/patchaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
821
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
822
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
823
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
824
+
825
+ ### Response
826
+
827
+ **Promise\<[shared.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
828
+
829
+ ### Errors
830
+
831
+ | Error Type | Status Code | Content Type |
832
+ | --------------- | --------------- | --------------- |
833
+ | errors.SDKError | 4XX, 5XX | \*/\* |
834
+
835
+ ## patchCrmContact
836
+
837
+ Update a contact
838
+
839
+ ### Example Usage
840
+
841
+ ```typescript
842
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
843
+
844
+ const unifiedTo = new UnifiedTo({
845
+ security: {
846
+ jwt: "<YOUR_API_KEY_HERE>",
847
+ },
848
+ });
849
+
850
+ async function run() {
851
+ const result = await unifiedTo.contact.patchCrmContact({
852
+ connectionId: "<value>",
853
+ id: "<id>",
854
+ });
855
+
856
+ // Handle the result
857
+ console.log(result);
858
+ }
859
+
860
+ run();
861
+ ```
862
+
863
+ ### Standalone function
864
+
865
+ The standalone function version of this method:
866
+
867
+ ```typescript
868
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
869
+ import { contactPatchCrmContact } from "@unified-api/typescript-sdk/funcs/contactPatchCrmContact.js";
870
+
871
+ // Use `UnifiedToCore` for best tree-shaking performance.
872
+ // You can create one instance of it to use across an application.
873
+ const unifiedTo = new UnifiedToCore({
874
+ security: {
875
+ jwt: "<YOUR_API_KEY_HERE>",
876
+ },
877
+ });
878
+
879
+ async function run() {
880
+ const res = await contactPatchCrmContact(unifiedTo, {
881
+ connectionId: "<value>",
882
+ id: "<id>",
883
+ });
884
+
885
+ if (!res.ok) {
886
+ throw res.error;
887
+ }
888
+
889
+ const { value: result } = res;
890
+
891
+ // Handle the result
892
+ console.log(result);
893
+ }
894
+
895
+ run();
896
+ ```
897
+
898
+ ### Parameters
899
+
900
+ | Parameter | Type | Required | Description |
901
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
902
+ | `request` | [operations.PatchCrmContactRequest](../../sdk/models/operations/patchcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
903
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
904
+ | `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. |
905
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
906
+
907
+ ### Response
908
+
909
+ **Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
910
+
911
+ ### Errors
912
+
913
+ | Error Type | Status Code | Content Type |
914
+ | --------------- | --------------- | --------------- |
915
+ | errors.SDKError | 4XX, 5XX | \*/\* |
916
+
917
+ ## patchUcContact
918
+
919
+ Update a contact
920
+
921
+ ### Example Usage
922
+
923
+ ```typescript
924
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
925
+
926
+ const unifiedTo = new UnifiedTo({
927
+ security: {
928
+ jwt: "<YOUR_API_KEY_HERE>",
929
+ },
930
+ });
931
+
932
+ async function run() {
933
+ const result = await unifiedTo.contact.patchUcContact({
934
+ connectionId: "<value>",
935
+ id: "<id>",
936
+ });
937
+
938
+ // Handle the result
939
+ console.log(result);
940
+ }
941
+
942
+ run();
943
+ ```
944
+
945
+ ### Standalone function
946
+
947
+ The standalone function version of this method:
948
+
949
+ ```typescript
950
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
951
+ import { contactPatchUcContact } from "@unified-api/typescript-sdk/funcs/contactPatchUcContact.js";
952
+
953
+ // Use `UnifiedToCore` for best tree-shaking performance.
954
+ // You can create one instance of it to use across an application.
955
+ const unifiedTo = new UnifiedToCore({
956
+ security: {
957
+ jwt: "<YOUR_API_KEY_HERE>",
958
+ },
959
+ });
960
+
961
+ async function run() {
962
+ const res = await contactPatchUcContact(unifiedTo, {
963
+ connectionId: "<value>",
964
+ id: "<id>",
965
+ });
966
+
967
+ if (!res.ok) {
968
+ throw res.error;
969
+ }
970
+
971
+ const { value: result } = res;
972
+
973
+ // Handle the result
974
+ console.log(result);
975
+ }
976
+
977
+ run();
978
+ ```
979
+
980
+ ### Parameters
981
+
982
+ | Parameter | Type | Required | Description |
983
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
984
+ | `request` | [operations.PatchUcContactRequest](../../sdk/models/operations/patchuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
985
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
986
+ | `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. |
987
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
988
+
989
+ ### Response
990
+
991
+ **Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
992
+
993
+ ### Errors
994
+
995
+ | Error Type | Status Code | Content Type |
996
+ | --------------- | --------------- | --------------- |
997
+ | errors.SDKError | 4XX, 5XX | \*/\* |
998
+
999
+ ## removeAccountingContact
1000
+
1001
+ Remove a contact
1002
+
1003
+ ### Example Usage
1004
+
1005
+ ```typescript
1006
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1007
+
1008
+ const unifiedTo = new UnifiedTo({
1009
+ security: {
1010
+ jwt: "<YOUR_API_KEY_HERE>",
1011
+ },
1012
+ });
1013
+
1014
+ async function run() {
1015
+ const result = await unifiedTo.contact.removeAccountingContact({
1016
+ connectionId: "<value>",
1017
+ id: "<id>",
1018
+ });
1019
+
1020
+ // Handle the result
1021
+ console.log(result);
1022
+ }
1023
+
1024
+ run();
1025
+ ```
1026
+
1027
+ ### Standalone function
1028
+
1029
+ The standalone function version of this method:
1030
+
1031
+ ```typescript
1032
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1033
+ import { contactRemoveAccountingContact } from "@unified-api/typescript-sdk/funcs/contactRemoveAccountingContact.js";
1034
+
1035
+ // Use `UnifiedToCore` for best tree-shaking performance.
1036
+ // You can create one instance of it to use across an application.
1037
+ const unifiedTo = new UnifiedToCore({
1038
+ security: {
1039
+ jwt: "<YOUR_API_KEY_HERE>",
1040
+ },
1041
+ });
1042
+
1043
+ async function run() {
1044
+ const res = await contactRemoveAccountingContact(unifiedTo, {
1045
+ connectionId: "<value>",
1046
+ id: "<id>",
1047
+ });
1048
+
1049
+ if (!res.ok) {
1050
+ throw res.error;
1051
+ }
1052
+
1053
+ const { value: result } = res;
1054
+
1055
+ // Handle the result
1056
+ console.log(result);
1057
+ }
1058
+
1059
+ run();
1060
+ ```
1061
+
1062
+ ### Parameters
1063
+
1064
+ | Parameter | Type | Required | Description |
1065
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1066
+ | `request` | [operations.RemoveAccountingContactRequest](../../sdk/models/operations/removeaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1067
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1068
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1069
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1070
+
1071
+ ### Response
1072
+
1073
+ **Promise\<[operations.RemoveAccountingContactResponse](../../sdk/models/operations/removeaccountingcontactresponse.md)\>**
1074
+
1075
+ ### Errors
1076
+
1077
+ | Error Type | Status Code | Content Type |
1078
+ | --------------- | --------------- | --------------- |
1079
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1080
+
1081
+ ## removeCrmContact
1082
+
1083
+ Remove a contact
1084
+
1085
+ ### Example Usage
1086
+
1087
+ ```typescript
1088
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1089
+
1090
+ const unifiedTo = new UnifiedTo({
1091
+ security: {
1092
+ jwt: "<YOUR_API_KEY_HERE>",
1093
+ },
1094
+ });
1095
+
1096
+ async function run() {
1097
+ const result = await unifiedTo.contact.removeCrmContact({
1098
+ connectionId: "<value>",
1099
+ id: "<id>",
1100
+ });
1101
+
1102
+ // Handle the result
1103
+ console.log(result);
1104
+ }
1105
+
1106
+ run();
1107
+ ```
1108
+
1109
+ ### Standalone function
1110
+
1111
+ The standalone function version of this method:
1112
+
1113
+ ```typescript
1114
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1115
+ import { contactRemoveCrmContact } from "@unified-api/typescript-sdk/funcs/contactRemoveCrmContact.js";
1116
+
1117
+ // Use `UnifiedToCore` for best tree-shaking performance.
1118
+ // You can create one instance of it to use across an application.
1119
+ const unifiedTo = new UnifiedToCore({
1120
+ security: {
1121
+ jwt: "<YOUR_API_KEY_HERE>",
1122
+ },
1123
+ });
1124
+
1125
+ async function run() {
1126
+ const res = await contactRemoveCrmContact(unifiedTo, {
1127
+ connectionId: "<value>",
1128
+ id: "<id>",
1129
+ });
1130
+
1131
+ if (!res.ok) {
1132
+ throw res.error;
1133
+ }
1134
+
1135
+ const { value: result } = res;
1136
+
1137
+ // Handle the result
1138
+ console.log(result);
1139
+ }
1140
+
1141
+ run();
1142
+ ```
1143
+
1144
+ ### Parameters
1145
+
1146
+ | Parameter | Type | Required | Description |
1147
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1148
+ | `request` | [operations.RemoveCrmContactRequest](../../sdk/models/operations/removecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1149
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1150
+ | `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. |
1151
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1152
+
1153
+ ### Response
1154
+
1155
+ **Promise\<[operations.RemoveCrmContactResponse](../../sdk/models/operations/removecrmcontactresponse.md)\>**
1156
+
1157
+ ### Errors
1158
+
1159
+ | Error Type | Status Code | Content Type |
1160
+ | --------------- | --------------- | --------------- |
1161
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1162
+
1163
+ ## removeUcContact
1164
+
1165
+ Remove a contact
1166
+
1167
+ ### Example Usage
1168
+
1169
+ ```typescript
1170
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1171
+
1172
+ const unifiedTo = new UnifiedTo({
1173
+ security: {
1174
+ jwt: "<YOUR_API_KEY_HERE>",
1175
+ },
1176
+ });
1177
+
1178
+ async function run() {
1179
+ const result = await unifiedTo.contact.removeUcContact({
1180
+ connectionId: "<value>",
1181
+ id: "<id>",
1182
+ });
1183
+
1184
+ // Handle the result
1185
+ console.log(result);
1186
+ }
1187
+
1188
+ run();
1189
+ ```
1190
+
1191
+ ### Standalone function
1192
+
1193
+ The standalone function version of this method:
1194
+
1195
+ ```typescript
1196
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1197
+ import { contactRemoveUcContact } from "@unified-api/typescript-sdk/funcs/contactRemoveUcContact.js";
1198
+
1199
+ // Use `UnifiedToCore` for best tree-shaking performance.
1200
+ // You can create one instance of it to use across an application.
1201
+ const unifiedTo = new UnifiedToCore({
1202
+ security: {
1203
+ jwt: "<YOUR_API_KEY_HERE>",
1204
+ },
1205
+ });
1206
+
1207
+ async function run() {
1208
+ const res = await contactRemoveUcContact(unifiedTo, {
1209
+ connectionId: "<value>",
1210
+ id: "<id>",
1211
+ });
1212
+
1213
+ if (!res.ok) {
1214
+ throw res.error;
1215
+ }
1216
+
1217
+ const { value: result } = res;
1218
+
1219
+ // Handle the result
1220
+ console.log(result);
1221
+ }
1222
+
1223
+ run();
1224
+ ```
1225
+
1226
+ ### Parameters
1227
+
1228
+ | Parameter | Type | Required | Description |
1229
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1230
+ | `request` | [operations.RemoveUcContactRequest](../../sdk/models/operations/removeuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1231
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1232
+ | `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. |
1233
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1234
+
1235
+ ### Response
1236
+
1237
+ **Promise\<[operations.RemoveUcContactResponse](../../sdk/models/operations/removeuccontactresponse.md)\>**
1238
+
1239
+ ### Errors
1240
+
1241
+ | Error Type | Status Code | Content Type |
1242
+ | --------------- | --------------- | --------------- |
1243
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1244
+
1245
+ ## updateAccountingContact
1246
+
1247
+ Update a contact
1248
+
1249
+ ### Example Usage
1250
+
1251
+ ```typescript
1252
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1253
+
1254
+ const unifiedTo = new UnifiedTo({
1255
+ security: {
1256
+ jwt: "<YOUR_API_KEY_HERE>",
1257
+ },
1258
+ });
1259
+
1260
+ async function run() {
1261
+ const result = await unifiedTo.contact.updateAccountingContact({
1262
+ connectionId: "<value>",
1263
+ id: "<id>",
1264
+ });
1265
+
1266
+ // Handle the result
1267
+ console.log(result);
1268
+ }
1269
+
1270
+ run();
1271
+ ```
1272
+
1273
+ ### Standalone function
1274
+
1275
+ The standalone function version of this method:
1276
+
1277
+ ```typescript
1278
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1279
+ import { contactUpdateAccountingContact } from "@unified-api/typescript-sdk/funcs/contactUpdateAccountingContact.js";
1280
+
1281
+ // Use `UnifiedToCore` for best tree-shaking performance.
1282
+ // You can create one instance of it to use across an application.
1283
+ const unifiedTo = new UnifiedToCore({
1284
+ security: {
1285
+ jwt: "<YOUR_API_KEY_HERE>",
1286
+ },
1287
+ });
1288
+
1289
+ async function run() {
1290
+ const res = await contactUpdateAccountingContact(unifiedTo, {
1291
+ connectionId: "<value>",
1292
+ id: "<id>",
1293
+ });
1294
+
1295
+ if (!res.ok) {
1296
+ throw res.error;
1297
+ }
1298
+
1299
+ const { value: result } = res;
1300
+
1301
+ // Handle the result
1302
+ console.log(result);
1303
+ }
1304
+
1305
+ run();
1306
+ ```
1307
+
1308
+ ### Parameters
1309
+
1310
+ | Parameter | Type | Required | Description |
1311
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1312
+ | `request` | [operations.UpdateAccountingContactRequest](../../sdk/models/operations/updateaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1313
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1314
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1315
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1316
+
1317
+ ### Response
1318
+
1319
+ **Promise\<[shared.AccountingContact](../../sdk/models/shared/accountingcontact.md)\>**
1320
+
1321
+ ### Errors
1322
+
1323
+ | Error Type | Status Code | Content Type |
1324
+ | --------------- | --------------- | --------------- |
1325
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1326
+
1327
+ ## updateCrmContact
1328
+
1329
+ Update a contact
1330
+
1331
+ ### Example Usage
1332
+
1333
+ ```typescript
1334
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1335
+
1336
+ const unifiedTo = new UnifiedTo({
1337
+ security: {
1338
+ jwt: "<YOUR_API_KEY_HERE>",
1339
+ },
1340
+ });
1341
+
1342
+ async function run() {
1343
+ const result = await unifiedTo.contact.updateCrmContact({
1344
+ connectionId: "<value>",
1345
+ id: "<id>",
1346
+ });
1347
+
1348
+ // Handle the result
1349
+ console.log(result);
1350
+ }
1351
+
1352
+ run();
1353
+ ```
1354
+
1355
+ ### Standalone function
1356
+
1357
+ The standalone function version of this method:
1358
+
1359
+ ```typescript
1360
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1361
+ import { contactUpdateCrmContact } from "@unified-api/typescript-sdk/funcs/contactUpdateCrmContact.js";
1362
+
1363
+ // Use `UnifiedToCore` for best tree-shaking performance.
1364
+ // You can create one instance of it to use across an application.
1365
+ const unifiedTo = new UnifiedToCore({
1366
+ security: {
1367
+ jwt: "<YOUR_API_KEY_HERE>",
1368
+ },
1369
+ });
1370
+
1371
+ async function run() {
1372
+ const res = await contactUpdateCrmContact(unifiedTo, {
1373
+ connectionId: "<value>",
1374
+ id: "<id>",
1375
+ });
1376
+
1377
+ if (!res.ok) {
1378
+ throw res.error;
1379
+ }
1380
+
1381
+ const { value: result } = res;
1382
+
1383
+ // Handle the result
1384
+ console.log(result);
1385
+ }
1386
+
1387
+ run();
1388
+ ```
1389
+
1390
+ ### Parameters
1391
+
1392
+ | Parameter | Type | Required | Description |
1393
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1394
+ | `request` | [operations.UpdateCrmContactRequest](../../sdk/models/operations/updatecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1395
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1396
+ | `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. |
1397
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1398
+
1399
+ ### Response
1400
+
1401
+ **Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
1402
+
1403
+ ### Errors
1404
+
1405
+ | Error Type | Status Code | Content Type |
1406
+ | --------------- | --------------- | --------------- |
1407
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1408
+
1409
+ ## updateUcContact
1410
+
1411
+ Update a contact
1412
+
1413
+ ### Example Usage
1414
+
1415
+ ```typescript
1416
+ import { UnifiedTo } from "@unified-api/typescript-sdk";
1417
+
1418
+ const unifiedTo = new UnifiedTo({
1419
+ security: {
1420
+ jwt: "<YOUR_API_KEY_HERE>",
1421
+ },
1422
+ });
1423
+
1424
+ async function run() {
1425
+ const result = await unifiedTo.contact.updateUcContact({
1426
+ connectionId: "<value>",
1427
+ id: "<id>",
1428
+ });
1429
+
1430
+ // Handle the result
1431
+ console.log(result);
1432
+ }
1433
+
1434
+ run();
1435
+ ```
1436
+
1437
+ ### Standalone function
1438
+
1439
+ The standalone function version of this method:
1440
+
1441
+ ```typescript
1442
+ import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1443
+ import { contactUpdateUcContact } from "@unified-api/typescript-sdk/funcs/contactUpdateUcContact.js";
1444
+
1445
+ // Use `UnifiedToCore` for best tree-shaking performance.
1446
+ // You can create one instance of it to use across an application.
1447
+ const unifiedTo = new UnifiedToCore({
1448
+ security: {
1449
+ jwt: "<YOUR_API_KEY_HERE>",
1450
+ },
1451
+ });
1452
+
1453
+ async function run() {
1454
+ const res = await contactUpdateUcContact(unifiedTo, {
1455
+ connectionId: "<value>",
1456
+ id: "<id>",
1457
+ });
1458
+
1459
+ if (!res.ok) {
1460
+ throw res.error;
1461
+ }
1462
+
1463
+ const { value: result } = res;
1464
+
1465
+ // Handle the result
1466
+ console.log(result);
1467
+ }
1468
+
1469
+ run();
1470
+ ```
1471
+
1472
+ ### Parameters
1473
+
1474
+ | Parameter | Type | Required | Description |
1475
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1476
+ | `request` | [operations.UpdateUcContactRequest](../../sdk/models/operations/updateuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1477
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1478
+ | `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. |
1479
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1480
+
1481
+ ### Response
1482
+
1483
+ **Promise\<[shared.UcContact](../../sdk/models/shared/uccontact.md)\>**
1484
+
1485
+ ### Errors
1486
+
1487
+ | Error Type | Status Code | Content Type |
1488
+ | --------------- | --------------- | --------------- |
1489
+ | errors.SDKError | 4XX, 5XX | \*/\* |