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