@unified-api/typescript-sdk 1.0.0 → 1.0.2

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 (196) hide show
  1. package/README.md +54 -700
  2. package/dist/sdk/accounting.d.ts +0 -40
  3. package/dist/sdk/accounting.js +44 -696
  4. package/dist/sdk/link.d.ts +31 -0
  5. package/dist/sdk/link.js +503 -0
  6. package/dist/sdk/models/operations/{createaccountingpayment.d.ts → createpaymentlink.d.ts} +7 -7
  7. package/dist/sdk/models/operations/createpaymentlink.js +95 -0
  8. package/dist/sdk/models/operations/createpaymentpayment.d.ts +28 -0
  9. package/dist/sdk/models/operations/{createaccountingpayment.js → createpaymentpayment.js} +20 -20
  10. package/dist/sdk/models/operations/getpaymentlink.d.ts +35 -0
  11. package/dist/sdk/models/operations/getpaymentlink.js +99 -0
  12. package/dist/sdk/models/operations/{getaccountingpayment.d.ts → getpaymentpayment.d.ts} +6 -6
  13. package/dist/sdk/models/operations/{getaccountingpayment.js → getpaymentpayment.js} +20 -20
  14. package/dist/sdk/models/operations/{getaccountingpayout.d.ts → getpaymentpayout.d.ts} +6 -6
  15. package/dist/sdk/models/operations/{getaccountingpayout.js → getpaymentpayout.js} +20 -20
  16. package/dist/sdk/models/operations/{getaccountingrefund.d.ts → getpaymentrefund.d.ts} +6 -6
  17. package/dist/sdk/models/operations/{getaccountingrefund.js → getpaymentrefund.js} +20 -20
  18. package/dist/sdk/models/operations/getunifiedintegrationauth.d.ts +6 -4
  19. package/dist/sdk/models/operations/getunifiedintegrationauth.js +6 -4
  20. package/dist/sdk/models/operations/index.d.ts +16 -10
  21. package/dist/sdk/models/operations/index.js +16 -10
  22. package/dist/sdk/models/operations/listpaymentlinks.d.ts +51 -0
  23. package/dist/sdk/models/operations/listpaymentlinks.js +127 -0
  24. package/dist/sdk/models/operations/{listaccountingpayments.d.ts → listpaymentpayments.d.ts} +6 -6
  25. package/dist/sdk/models/operations/{listaccountingpayments.js → listpaymentpayments.js} +28 -28
  26. package/dist/sdk/models/operations/{listaccountingpayouts.d.ts → listpaymentpayouts.d.ts} +6 -6
  27. package/dist/sdk/models/operations/{listaccountingpayouts.js → listpaymentpayouts.js} +26 -26
  28. package/dist/sdk/models/operations/{listaccountingrefunds.d.ts → listpaymentrefunds.d.ts} +6 -6
  29. package/dist/sdk/models/operations/{listaccountingrefunds.js → listpaymentrefunds.js} +27 -27
  30. package/dist/sdk/models/operations/listunifiedconnections.d.ts +2 -1
  31. package/dist/sdk/models/operations/listunifiedconnections.js +1 -0
  32. package/dist/sdk/models/operations/listunifiedintegrations.d.ts +2 -1
  33. package/dist/sdk/models/operations/listunifiedintegrations.js +1 -0
  34. package/dist/sdk/models/operations/listunifiedintegrationworkspaces.d.ts +2 -1
  35. package/dist/sdk/models/operations/listunifiedintegrationworkspaces.js +1 -0
  36. package/dist/sdk/models/operations/patchpaymentlink.d.ts +32 -0
  37. package/dist/sdk/models/operations/patchpaymentlink.js +99 -0
  38. package/dist/sdk/models/operations/{patchaccountingpayment.d.ts → patchpaymentpayment.d.ts} +7 -7
  39. package/dist/sdk/models/operations/{patchaccountingpayment.js → patchpaymentpayment.js} +21 -21
  40. package/dist/sdk/models/operations/removepaymentlink.d.ts +30 -0
  41. package/dist/sdk/models/operations/{removeaccountingpayment.js → removepaymentlink.js} +17 -17
  42. package/dist/sdk/models/operations/{removeaccountingpayment.d.ts → removepaymentpayment.d.ts} +2 -2
  43. package/dist/sdk/models/operations/removepaymentpayment.js +71 -0
  44. package/dist/sdk/models/operations/updatepaymentlink.d.ts +32 -0
  45. package/dist/sdk/models/operations/updatepaymentlink.js +99 -0
  46. package/dist/sdk/models/operations/{updateaccountingpayment.d.ts → updatepaymentpayment.d.ts} +7 -7
  47. package/dist/sdk/models/operations/{updateaccountingpayment.js → updatepaymentpayment.js} +21 -21
  48. package/dist/sdk/models/shared/accountinginvoice.d.ts +1 -0
  49. package/dist/sdk/models/shared/accountinginvoice.js +5 -0
  50. package/dist/sdk/models/shared/index.d.ts +5 -3
  51. package/dist/sdk/models/shared/index.js +5 -3
  52. package/dist/sdk/models/shared/paymenntlinklineitem.d.ts +20 -0
  53. package/dist/sdk/models/shared/paymenntlinklineitem.js +137 -0
  54. package/dist/sdk/models/shared/paymentlink.d.ts +15 -0
  55. package/dist/sdk/models/shared/paymentlink.js +105 -0
  56. package/dist/sdk/models/shared/{accountingpayment.d.ts → paymentpayment.d.ts} +1 -1
  57. package/dist/sdk/models/shared/{accountingpayment.js → paymentpayment.js} +18 -18
  58. package/dist/sdk/models/shared/{accountingpayout.d.ts → paymentpayout.d.ts} +3 -3
  59. package/dist/sdk/models/shared/{accountingpayout.js → paymentpayout.js} +21 -21
  60. package/dist/sdk/models/shared/{accountingrefund.d.ts → paymentrefund.d.ts} +3 -3
  61. package/dist/sdk/models/shared/{accountingrefund.js → paymentrefund.js} +23 -23
  62. package/dist/sdk/models/shared/propertyconnectioncategories.d.ts +2 -1
  63. package/dist/sdk/models/shared/propertyconnectioncategories.js +1 -0
  64. package/dist/sdk/models/shared/propertyconnectionpermissions.d.ts +6 -4
  65. package/dist/sdk/models/shared/propertyconnectionpermissions.js +6 -4
  66. package/dist/sdk/models/shared/propertyintegrationcategories.d.ts +2 -1
  67. package/dist/sdk/models/shared/propertyintegrationcategories.js +1 -0
  68. package/dist/sdk/models/shared/webhook.d.ts +4 -3
  69. package/dist/sdk/models/shared/webhook.js +4 -3
  70. package/dist/sdk/payment.d.ts +46 -6
  71. package/dist/sdk/payment.js +705 -53
  72. package/dist/sdk/payout.d.ts +2 -2
  73. package/dist/sdk/payout.js +11 -11
  74. package/dist/sdk/refund.d.ts +2 -2
  75. package/dist/sdk/refund.js +11 -11
  76. package/dist/sdk/sdk.d.ts +5 -3
  77. package/dist/sdk/sdk.js +7 -5
  78. package/docs/sdk/models/operations/categories.md +2 -1
  79. package/docs/sdk/models/operations/createpaymentlinkrequest.md +9 -0
  80. package/docs/sdk/models/operations/createpaymentlinkresponse.md +11 -0
  81. package/docs/sdk/models/operations/createpaymentpaymentrequest.md +9 -0
  82. package/docs/sdk/models/operations/createpaymentpaymentresponse.md +11 -0
  83. package/docs/sdk/models/operations/getpaymentlinkrequest.md +10 -0
  84. package/docs/sdk/models/operations/getpaymentlinkresponse.md +11 -0
  85. package/docs/sdk/models/operations/{getaccountingpaymentrequest.md → getpaymentpaymentrequest.md} +1 -1
  86. package/docs/sdk/models/operations/getpaymentpaymentresponse.md +11 -0
  87. package/docs/sdk/models/operations/{getaccountingpayoutrequest.md → getpaymentpayoutrequest.md} +1 -1
  88. package/docs/sdk/models/operations/getpaymentpayoutresponse.md +11 -0
  89. package/docs/sdk/models/operations/{getaccountingrefundrequest.md → getpaymentrefundrequest.md} +1 -1
  90. package/docs/sdk/models/operations/getpaymentrefundresponse.md +11 -0
  91. package/docs/sdk/models/operations/listpaymentlinksrequest.md +17 -0
  92. package/docs/sdk/models/operations/listpaymentlinksresponse.md +11 -0
  93. package/docs/sdk/models/operations/{listaccountingpaymentsrequest.md → listpaymentpaymentsrequest.md} +1 -1
  94. package/docs/sdk/models/operations/listpaymentpaymentsresponse.md +11 -0
  95. package/docs/sdk/models/operations/{listaccountingpayoutsrequest.md → listpaymentpayoutsrequest.md} +1 -1
  96. package/docs/sdk/models/operations/listpaymentpayoutsresponse.md +11 -0
  97. package/docs/sdk/models/operations/{listaccountingrefundsrequest.md → listpaymentrefundsrequest.md} +1 -1
  98. package/docs/sdk/models/operations/listpaymentrefundsresponse.md +11 -0
  99. package/docs/sdk/models/operations/listunifiedintegrationsqueryparamcategories.md +2 -1
  100. package/docs/sdk/models/operations/patchpaymentlinkrequest.md +10 -0
  101. package/docs/sdk/models/operations/patchpaymentlinkresponse.md +11 -0
  102. package/docs/sdk/models/operations/patchpaymentpaymentrequest.md +10 -0
  103. package/docs/sdk/models/operations/patchpaymentpaymentresponse.md +11 -0
  104. package/docs/sdk/models/operations/queryparamcategories.md +2 -1
  105. package/docs/sdk/models/operations/{removeaccountingpaymentrequest.md → removepaymentlinkrequest.md} +2 -2
  106. package/docs/sdk/models/operations/{removeaccountingpaymentresponse.md → removepaymentlinkresponse.md} +1 -1
  107. package/docs/sdk/models/operations/removepaymentpaymentrequest.md +9 -0
  108. package/docs/sdk/models/operations/removepaymentpaymentresponse.md +11 -0
  109. package/docs/sdk/models/operations/scopes.md +6 -4
  110. package/docs/sdk/models/operations/updatepaymentlinkrequest.md +10 -0
  111. package/docs/sdk/models/operations/updatepaymentlinkresponse.md +11 -0
  112. package/docs/sdk/models/operations/updatepaymentpaymentrequest.md +10 -0
  113. package/docs/sdk/models/operations/updatepaymentpaymentresponse.md +11 -0
  114. package/docs/sdk/models/shared/accountinginvoice.md +2 -1
  115. package/docs/sdk/models/shared/objecttype.md +4 -3
  116. package/docs/sdk/models/shared/paymenntlinklineitem.md +24 -0
  117. package/docs/sdk/models/shared/paymentlink.md +18 -0
  118. package/docs/sdk/models/shared/{accountingpayment.md → paymentpayment.md} +1 -1
  119. package/docs/sdk/models/shared/paymentpayout.md +15 -0
  120. package/docs/sdk/models/shared/{accountingpayoutstatus.md → paymentpayoutstatus.md} +1 -1
  121. package/docs/sdk/models/shared/paymentrefund.md +17 -0
  122. package/docs/sdk/models/shared/{accountingrefundstatus.md → paymentrefundstatus.md} +1 -1
  123. package/docs/sdk/models/shared/propertyconnectioncategories.md +2 -1
  124. package/docs/sdk/models/shared/propertyconnectionpermissions.md +6 -4
  125. package/docs/sdk/models/shared/propertyintegrationcategories.md +2 -1
  126. package/package.json +1 -1
  127. package/docs/sdk/models/operations/createaccountingpaymentrequest.md +0 -9
  128. package/docs/sdk/models/operations/createaccountingpaymentresponse.md +0 -11
  129. package/docs/sdk/models/operations/getaccountingpaymentresponse.md +0 -11
  130. package/docs/sdk/models/operations/getaccountingpayoutresponse.md +0 -11
  131. package/docs/sdk/models/operations/getaccountingrefundresponse.md +0 -11
  132. package/docs/sdk/models/operations/listaccountingpaymentsresponse.md +0 -11
  133. package/docs/sdk/models/operations/listaccountingpayoutsresponse.md +0 -11
  134. package/docs/sdk/models/operations/listaccountingrefundsresponse.md +0 -11
  135. package/docs/sdk/models/operations/patchaccountingpaymentrequest.md +0 -10
  136. package/docs/sdk/models/operations/patchaccountingpaymentresponse.md +0 -11
  137. package/docs/sdk/models/operations/updateaccountingpaymentrequest.md +0 -10
  138. package/docs/sdk/models/operations/updateaccountingpaymentresponse.md +0 -11
  139. package/docs/sdk/models/shared/accountingpayout.md +0 -15
  140. package/docs/sdk/models/shared/accountingrefund.md +0 -17
  141. package/docs/sdks/account/README.md +0 -312
  142. package/docs/sdks/accounting/README.md +0 -2198
  143. package/docs/sdks/activity/README.md +0 -321
  144. package/docs/sdks/apicall/README.md +0 -95
  145. package/docs/sdks/application/README.md +0 -333
  146. package/docs/sdks/applicationstatus/README.md +0 -54
  147. package/docs/sdks/ats/README.md +0 -2488
  148. package/docs/sdks/auth/README.md +0 -103
  149. package/docs/sdks/call/README.md +0 -54
  150. package/docs/sdks/candidate/README.md +0 -369
  151. package/docs/sdks/collection/README.md +0 -348
  152. package/docs/sdks/commerce/README.md +0 -1371
  153. package/docs/sdks/company/README.md +0 -517
  154. package/docs/sdks/connection/README.md +0 -359
  155. package/docs/sdks/contact/README.md +0 -1028
  156. package/docs/sdks/crm/README.md +0 -2048
  157. package/docs/sdks/customer/README.md +0 -348
  158. package/docs/sdks/deal/README.md +0 -315
  159. package/docs/sdks/document/README.md +0 -309
  160. package/docs/sdks/employee/README.md +0 -363
  161. package/docs/sdks/enrich/README.md +0 -97
  162. package/docs/sdks/event/README.md +0 -390
  163. package/docs/sdks/file/README.md +0 -330
  164. package/docs/sdks/group/README.md +0 -327
  165. package/docs/sdks/hris/README.md +0 -685
  166. package/docs/sdks/integration/README.md +0 -155
  167. package/docs/sdks/interview/README.md +0 -318
  168. package/docs/sdks/inventory/README.md +0 -309
  169. package/docs/sdks/invoice/README.md +0 -324
  170. package/docs/sdks/issue/README.md +0 -49
  171. package/docs/sdks/item/README.md +0 -417
  172. package/docs/sdks/job/README.md +0 -396
  173. package/docs/sdks/lead/README.md +0 -336
  174. package/docs/sdks/list/README.md +0 -306
  175. package/docs/sdks/location/README.md +0 -312
  176. package/docs/sdks/login/README.md +0 -52
  177. package/docs/sdks/martech/README.md +0 -643
  178. package/docs/sdks/member/README.md +0 -342
  179. package/docs/sdks/note/README.md +0 -306
  180. package/docs/sdks/organization/README.md +0 -104
  181. package/docs/sdks/passthrough/README.md +0 -249
  182. package/docs/sdks/payment/README.md +0 -306
  183. package/docs/sdks/payout/README.md +0 -104
  184. package/docs/sdks/person/README.md +0 -51
  185. package/docs/sdks/pipeline/README.md +0 -306
  186. package/docs/sdks/refund/README.md +0 -104
  187. package/docs/sdks/scorecard/README.md +0 -324
  188. package/docs/sdks/storage/README.md +0 -330
  189. package/docs/sdks/taxrate/README.md +0 -312
  190. package/docs/sdks/ticket/README.md +0 -318
  191. package/docs/sdks/ticketing/README.md +0 -962
  192. package/docs/sdks/transaction/README.md +0 -327
  193. package/docs/sdks/uc/README.md +0 -388
  194. package/docs/sdks/unified/README.md +0 -929
  195. package/docs/sdks/unifiedto/README.md +0 -9
  196. package/docs/sdks/webhook/README.md +0 -291
@@ -1,1028 +0,0 @@
1
- # Contact
2
- (*contact*)
3
-
4
- ### Available Operations
5
-
6
- * [createAccountingContact](#createaccountingcontact) - Create a contact
7
- * [createCrmContact](#createcrmcontact) - Create a contact
8
- * [createUcContact](#createuccontact) - Create a contact
9
- * [getAccountingContact](#getaccountingcontact) - Retrieve a contact
10
- * [getCrmContact](#getcrmcontact) - Retrieve a contact
11
- * [getUcContact](#getuccontact) - Retrieve a contact
12
- * [listAccountingContacts](#listaccountingcontacts) - List all contacts
13
- * [listCrmContacts](#listcrmcontacts) - List all contacts
14
- * [listUcContacts](#listuccontacts) - List all contacts
15
- * [patchAccountingContact](#patchaccountingcontact) - Update a contact
16
- * [patchCrmContact](#patchcrmcontact) - Update a contact
17
- * [patchUcContact](#patchuccontact) - Update a contact
18
- * [removeAccountingContact](#removeaccountingcontact) - Remove a contact
19
- * [removeCrmContact](#removecrmcontact) - Remove a contact
20
- * [removeUcContact](#removeuccontact) - Remove a contact
21
- * [updateAccountingContact](#updateaccountingcontact) - Update a contact
22
- * [updateCrmContact](#updatecrmcontact) - Update a contact
23
- * [updateUcContact](#updateuccontact) - Update a contact
24
-
25
- ## createAccountingContact
26
-
27
- Create a contact
28
-
29
- ### Example Usage
30
-
31
- ```typescript
32
- import { UnifiedTo } from "@unified-api/typescript-sdk";
33
- import { AccountingEmailType, AccountingTelephoneType, TaxExemption } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
34
-
35
- async function run() {
36
- const sdk = new UnifiedTo({
37
- security: {
38
- jwt: "<YOUR_API_KEY_HERE>",
39
- },
40
- });
41
-
42
- const res = await sdk.contact.createAccountingContact({
43
- accountingContact: {
44
- billingAddress: {},
45
- emails: [
46
- {
47
- email: "Mac36@gmail.com",
48
- },
49
- ],
50
- raw: {
51
- "key": "<value>",
52
- },
53
- shippingAddress: {},
54
- telephones: [
55
- {
56
- telephone: "<value>",
57
- },
58
- ],
59
- },
60
- connectionId: "<value>",
61
- });
62
-
63
- if (res.statusCode == 200) {
64
- // handle response
65
- }
66
- }
67
-
68
- run();
69
- ```
70
-
71
- ### Parameters
72
-
73
- | Parameter | Type | Required | Description |
74
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
75
- | `request` | [operations.CreateAccountingContactRequest](../../sdk/models/operations/createaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
76
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
77
-
78
-
79
- ### Response
80
-
81
- **Promise<[operations.CreateAccountingContactResponse](../../sdk/models/operations/createaccountingcontactresponse.md)>**
82
- ### Errors
83
-
84
- | Error Object | Status Code | Content Type |
85
- | --------------- | --------------- | --------------- |
86
- | errors.SDKError | 4xx-5xx | */* |
87
-
88
- ## createCrmContact
89
-
90
- Create a contact
91
-
92
- ### Example Usage
93
-
94
- ```typescript
95
- import { UnifiedTo } from "@unified-api/typescript-sdk";
96
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
97
-
98
- async function run() {
99
- const sdk = new UnifiedTo({
100
- security: {
101
- jwt: "<YOUR_API_KEY_HERE>",
102
- },
103
- });
104
-
105
- const res = await sdk.contact.createCrmContact({
106
- crmContact: {
107
- address: {},
108
- companyIds: [
109
- "<value>",
110
- ],
111
- dealIds: [
112
- "<value>",
113
- ],
114
- emails: [
115
- {},
116
- ],
117
- raw: {
118
- "key": "<value>",
119
- },
120
- telephones: [
121
- {
122
- telephone: "<value>",
123
- },
124
- ],
125
- },
126
- connectionId: "<value>",
127
- });
128
-
129
- if (res.statusCode == 200) {
130
- // handle response
131
- }
132
- }
133
-
134
- run();
135
- ```
136
-
137
- ### Parameters
138
-
139
- | Parameter | Type | Required | Description |
140
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
141
- | `request` | [operations.CreateCrmContactRequest](../../sdk/models/operations/createcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
142
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
143
-
144
-
145
- ### Response
146
-
147
- **Promise<[operations.CreateCrmContactResponse](../../sdk/models/operations/createcrmcontactresponse.md)>**
148
- ### Errors
149
-
150
- | Error Object | Status Code | Content Type |
151
- | --------------- | --------------- | --------------- |
152
- | errors.SDKError | 4xx-5xx | */* |
153
-
154
- ## createUcContact
155
-
156
- Create a contact
157
-
158
- ### Example Usage
159
-
160
- ```typescript
161
- import { UnifiedTo } from "@unified-api/typescript-sdk";
162
- import { UcEmailType, UcTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
163
-
164
- async function run() {
165
- const sdk = new UnifiedTo({
166
- security: {
167
- jwt: "<YOUR_API_KEY_HERE>",
168
- },
169
- });
170
-
171
- const res = await sdk.contact.createUcContact({
172
- ucContact: {
173
- emails: [
174
- {
175
- email: "Dulce_Becker30@yahoo.com",
176
- },
177
- ],
178
- raw: {
179
- "key": "<value>",
180
- },
181
- telephones: [
182
- {
183
- telephone: "<value>",
184
- },
185
- ],
186
- },
187
- connectionId: "<value>",
188
- });
189
-
190
- if (res.statusCode == 200) {
191
- // handle response
192
- }
193
- }
194
-
195
- run();
196
- ```
197
-
198
- ### Parameters
199
-
200
- | Parameter | Type | Required | Description |
201
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
202
- | `request` | [operations.CreateUcContactRequest](../../sdk/models/operations/createuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
203
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
204
-
205
-
206
- ### Response
207
-
208
- **Promise<[operations.CreateUcContactResponse](../../sdk/models/operations/createuccontactresponse.md)>**
209
- ### Errors
210
-
211
- | Error Object | Status Code | Content Type |
212
- | --------------- | --------------- | --------------- |
213
- | errors.SDKError | 4xx-5xx | */* |
214
-
215
- ## getAccountingContact
216
-
217
- Retrieve a contact
218
-
219
- ### Example Usage
220
-
221
- ```typescript
222
- import { UnifiedTo } from "@unified-api/typescript-sdk";
223
-
224
- async function run() {
225
- const sdk = new UnifiedTo({
226
- security: {
227
- jwt: "<YOUR_API_KEY_HERE>",
228
- },
229
- });
230
-
231
- const res = await sdk.contact.getAccountingContact({
232
- connectionId: "<value>",
233
- fields: [
234
- "<value>",
235
- ],
236
- id: "<id>",
237
- });
238
-
239
- if (res.statusCode == 200) {
240
- // handle response
241
- }
242
- }
243
-
244
- run();
245
- ```
246
-
247
- ### Parameters
248
-
249
- | Parameter | Type | Required | Description |
250
- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
251
- | `request` | [operations.GetAccountingContactRequest](../../sdk/models/operations/getaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
252
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
253
-
254
-
255
- ### Response
256
-
257
- **Promise<[operations.GetAccountingContactResponse](../../sdk/models/operations/getaccountingcontactresponse.md)>**
258
- ### Errors
259
-
260
- | Error Object | Status Code | Content Type |
261
- | --------------- | --------------- | --------------- |
262
- | errors.SDKError | 4xx-5xx | */* |
263
-
264
- ## getCrmContact
265
-
266
- Retrieve a contact
267
-
268
- ### Example Usage
269
-
270
- ```typescript
271
- import { UnifiedTo } from "@unified-api/typescript-sdk";
272
-
273
- async function run() {
274
- const sdk = new UnifiedTo({
275
- security: {
276
- jwt: "<YOUR_API_KEY_HERE>",
277
- },
278
- });
279
-
280
- const res = await sdk.contact.getCrmContact({
281
- connectionId: "<value>",
282
- fields: [
283
- "<value>",
284
- ],
285
- id: "<id>",
286
- });
287
-
288
- if (res.statusCode == 200) {
289
- // handle response
290
- }
291
- }
292
-
293
- run();
294
- ```
295
-
296
- ### Parameters
297
-
298
- | Parameter | Type | Required | Description |
299
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
300
- | `request` | [operations.GetCrmContactRequest](../../sdk/models/operations/getcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
301
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
302
-
303
-
304
- ### Response
305
-
306
- **Promise<[operations.GetCrmContactResponse](../../sdk/models/operations/getcrmcontactresponse.md)>**
307
- ### Errors
308
-
309
- | Error Object | Status Code | Content Type |
310
- | --------------- | --------------- | --------------- |
311
- | errors.SDKError | 4xx-5xx | */* |
312
-
313
- ## getUcContact
314
-
315
- Retrieve a contact
316
-
317
- ### Example Usage
318
-
319
- ```typescript
320
- import { UnifiedTo } from "@unified-api/typescript-sdk";
321
-
322
- async function run() {
323
- const sdk = new UnifiedTo({
324
- security: {
325
- jwt: "<YOUR_API_KEY_HERE>",
326
- },
327
- });
328
-
329
- const res = await sdk.contact.getUcContact({
330
- connectionId: "<value>",
331
- fields: [
332
- "<value>",
333
- ],
334
- id: "<id>",
335
- });
336
-
337
- if (res.statusCode == 200) {
338
- // handle response
339
- }
340
- }
341
-
342
- run();
343
- ```
344
-
345
- ### Parameters
346
-
347
- | Parameter | Type | Required | Description |
348
- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
349
- | `request` | [operations.GetUcContactRequest](../../sdk/models/operations/getuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
350
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
351
-
352
-
353
- ### Response
354
-
355
- **Promise<[operations.GetUcContactResponse](../../sdk/models/operations/getuccontactresponse.md)>**
356
- ### Errors
357
-
358
- | Error Object | Status Code | Content Type |
359
- | --------------- | --------------- | --------------- |
360
- | errors.SDKError | 4xx-5xx | */* |
361
-
362
- ## listAccountingContacts
363
-
364
- List all contacts
365
-
366
- ### Example Usage
367
-
368
- ```typescript
369
- import { UnifiedTo } from "@unified-api/typescript-sdk";
370
-
371
- async function run() {
372
- const sdk = new UnifiedTo({
373
- security: {
374
- jwt: "<YOUR_API_KEY_HERE>",
375
- },
376
- });
377
-
378
- const res = await sdk.contact.listAccountingContacts({
379
- connectionId: "<value>",
380
- fields: [
381
- "<value>",
382
- ],
383
- });
384
-
385
- if (res.statusCode == 200) {
386
- // handle response
387
- }
388
- }
389
-
390
- run();
391
- ```
392
-
393
- ### Parameters
394
-
395
- | Parameter | Type | Required | Description |
396
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
397
- | `request` | [operations.ListAccountingContactsRequest](../../sdk/models/operations/listaccountingcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
398
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
399
-
400
-
401
- ### Response
402
-
403
- **Promise<[operations.ListAccountingContactsResponse](../../sdk/models/operations/listaccountingcontactsresponse.md)>**
404
- ### Errors
405
-
406
- | Error Object | Status Code | Content Type |
407
- | --------------- | --------------- | --------------- |
408
- | errors.SDKError | 4xx-5xx | */* |
409
-
410
- ## listCrmContacts
411
-
412
- List all contacts
413
-
414
- ### Example Usage
415
-
416
- ```typescript
417
- import { UnifiedTo } from "@unified-api/typescript-sdk";
418
-
419
- async function run() {
420
- const sdk = new UnifiedTo({
421
- security: {
422
- jwt: "<YOUR_API_KEY_HERE>",
423
- },
424
- });
425
-
426
- const res = await sdk.contact.listCrmContacts({
427
- connectionId: "<value>",
428
- fields: [
429
- "<value>",
430
- ],
431
- });
432
-
433
- if (res.statusCode == 200) {
434
- // handle response
435
- }
436
- }
437
-
438
- run();
439
- ```
440
-
441
- ### Parameters
442
-
443
- | Parameter | Type | Required | Description |
444
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
445
- | `request` | [operations.ListCrmContactsRequest](../../sdk/models/operations/listcrmcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
446
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
447
-
448
-
449
- ### Response
450
-
451
- **Promise<[operations.ListCrmContactsResponse](../../sdk/models/operations/listcrmcontactsresponse.md)>**
452
- ### Errors
453
-
454
- | Error Object | Status Code | Content Type |
455
- | --------------- | --------------- | --------------- |
456
- | errors.SDKError | 4xx-5xx | */* |
457
-
458
- ## listUcContacts
459
-
460
- List all contacts
461
-
462
- ### Example Usage
463
-
464
- ```typescript
465
- import { UnifiedTo } from "@unified-api/typescript-sdk";
466
-
467
- async function run() {
468
- const sdk = new UnifiedTo({
469
- security: {
470
- jwt: "<YOUR_API_KEY_HERE>",
471
- },
472
- });
473
-
474
- const res = await sdk.contact.listUcContacts({
475
- connectionId: "<value>",
476
- fields: [
477
- "<value>",
478
- ],
479
- });
480
-
481
- if (res.statusCode == 200) {
482
- // handle response
483
- }
484
- }
485
-
486
- run();
487
- ```
488
-
489
- ### Parameters
490
-
491
- | Parameter | Type | Required | Description |
492
- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
493
- | `request` | [operations.ListUcContactsRequest](../../sdk/models/operations/listuccontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
494
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
495
-
496
-
497
- ### Response
498
-
499
- **Promise<[operations.ListUcContactsResponse](../../sdk/models/operations/listuccontactsresponse.md)>**
500
- ### Errors
501
-
502
- | Error Object | Status Code | Content Type |
503
- | --------------- | --------------- | --------------- |
504
- | errors.SDKError | 4xx-5xx | */* |
505
-
506
- ## patchAccountingContact
507
-
508
- Update a contact
509
-
510
- ### Example Usage
511
-
512
- ```typescript
513
- import { UnifiedTo } from "@unified-api/typescript-sdk";
514
- import { AccountingEmailType, AccountingTelephoneType, TaxExemption } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
515
-
516
- async function run() {
517
- const sdk = new UnifiedTo({
518
- security: {
519
- jwt: "<YOUR_API_KEY_HERE>",
520
- },
521
- });
522
-
523
- const res = await sdk.contact.patchAccountingContact({
524
- accountingContact: {
525
- billingAddress: {},
526
- emails: [
527
- {
528
- email: "Sylvester.Kuhic@yahoo.com",
529
- },
530
- ],
531
- raw: {
532
- "key": "<value>",
533
- },
534
- shippingAddress: {},
535
- telephones: [
536
- {
537
- telephone: "<value>",
538
- },
539
- ],
540
- },
541
- connectionId: "<value>",
542
- id: "<id>",
543
- });
544
-
545
- if (res.statusCode == 200) {
546
- // handle response
547
- }
548
- }
549
-
550
- run();
551
- ```
552
-
553
- ### Parameters
554
-
555
- | Parameter | Type | Required | Description |
556
- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
557
- | `request` | [operations.PatchAccountingContactRequest](../../sdk/models/operations/patchaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
558
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
559
-
560
-
561
- ### Response
562
-
563
- **Promise<[operations.PatchAccountingContactResponse](../../sdk/models/operations/patchaccountingcontactresponse.md)>**
564
- ### Errors
565
-
566
- | Error Object | Status Code | Content Type |
567
- | --------------- | --------------- | --------------- |
568
- | errors.SDKError | 4xx-5xx | */* |
569
-
570
- ## patchCrmContact
571
-
572
- Update a contact
573
-
574
- ### Example Usage
575
-
576
- ```typescript
577
- import { UnifiedTo } from "@unified-api/typescript-sdk";
578
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
579
-
580
- async function run() {
581
- const sdk = new UnifiedTo({
582
- security: {
583
- jwt: "<YOUR_API_KEY_HERE>",
584
- },
585
- });
586
-
587
- const res = await sdk.contact.patchCrmContact({
588
- crmContact: {
589
- address: {},
590
- companyIds: [
591
- "<value>",
592
- ],
593
- dealIds: [
594
- "<value>",
595
- ],
596
- emails: [
597
- {},
598
- ],
599
- raw: {
600
- "key": "<value>",
601
- },
602
- telephones: [
603
- {
604
- telephone: "<value>",
605
- },
606
- ],
607
- },
608
- connectionId: "<value>",
609
- id: "<id>",
610
- });
611
-
612
- if (res.statusCode == 200) {
613
- // handle response
614
- }
615
- }
616
-
617
- run();
618
- ```
619
-
620
- ### Parameters
621
-
622
- | Parameter | Type | Required | Description |
623
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
624
- | `request` | [operations.PatchCrmContactRequest](../../sdk/models/operations/patchcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
625
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
626
-
627
-
628
- ### Response
629
-
630
- **Promise<[operations.PatchCrmContactResponse](../../sdk/models/operations/patchcrmcontactresponse.md)>**
631
- ### Errors
632
-
633
- | Error Object | Status Code | Content Type |
634
- | --------------- | --------------- | --------------- |
635
- | errors.SDKError | 4xx-5xx | */* |
636
-
637
- ## patchUcContact
638
-
639
- Update a contact
640
-
641
- ### Example Usage
642
-
643
- ```typescript
644
- import { UnifiedTo } from "@unified-api/typescript-sdk";
645
- import { UcEmailType, UcTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
646
-
647
- async function run() {
648
- const sdk = new UnifiedTo({
649
- security: {
650
- jwt: "<YOUR_API_KEY_HERE>",
651
- },
652
- });
653
-
654
- const res = await sdk.contact.patchUcContact({
655
- ucContact: {
656
- emails: [
657
- {
658
- email: "Norene_Boehm97@hotmail.com",
659
- },
660
- ],
661
- raw: {
662
- "key": "<value>",
663
- },
664
- telephones: [
665
- {
666
- telephone: "<value>",
667
- },
668
- ],
669
- },
670
- connectionId: "<value>",
671
- id: "<id>",
672
- });
673
-
674
- if (res.statusCode == 200) {
675
- // handle response
676
- }
677
- }
678
-
679
- run();
680
- ```
681
-
682
- ### Parameters
683
-
684
- | Parameter | Type | Required | Description |
685
- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
686
- | `request` | [operations.PatchUcContactRequest](../../sdk/models/operations/patchuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
687
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
688
-
689
-
690
- ### Response
691
-
692
- **Promise<[operations.PatchUcContactResponse](../../sdk/models/operations/patchuccontactresponse.md)>**
693
- ### Errors
694
-
695
- | Error Object | Status Code | Content Type |
696
- | --------------- | --------------- | --------------- |
697
- | errors.SDKError | 4xx-5xx | */* |
698
-
699
- ## removeAccountingContact
700
-
701
- Remove a contact
702
-
703
- ### Example Usage
704
-
705
- ```typescript
706
- import { UnifiedTo } from "@unified-api/typescript-sdk";
707
-
708
- async function run() {
709
- const sdk = new UnifiedTo({
710
- security: {
711
- jwt: "<YOUR_API_KEY_HERE>",
712
- },
713
- });
714
-
715
- const res = await sdk.contact.removeAccountingContact({
716
- connectionId: "<value>",
717
- id: "<id>",
718
- });
719
-
720
- if (res.statusCode == 200) {
721
- // handle response
722
- }
723
- }
724
-
725
- run();
726
- ```
727
-
728
- ### Parameters
729
-
730
- | Parameter | Type | Required | Description |
731
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
732
- | `request` | [operations.RemoveAccountingContactRequest](../../sdk/models/operations/removeaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
733
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
734
-
735
-
736
- ### Response
737
-
738
- **Promise<[operations.RemoveAccountingContactResponse](../../sdk/models/operations/removeaccountingcontactresponse.md)>**
739
- ### Errors
740
-
741
- | Error Object | Status Code | Content Type |
742
- | --------------- | --------------- | --------------- |
743
- | errors.SDKError | 4xx-5xx | */* |
744
-
745
- ## removeCrmContact
746
-
747
- Remove a contact
748
-
749
- ### Example Usage
750
-
751
- ```typescript
752
- import { UnifiedTo } from "@unified-api/typescript-sdk";
753
-
754
- async function run() {
755
- const sdk = new UnifiedTo({
756
- security: {
757
- jwt: "<YOUR_API_KEY_HERE>",
758
- },
759
- });
760
-
761
- const res = await sdk.contact.removeCrmContact({
762
- connectionId: "<value>",
763
- id: "<id>",
764
- });
765
-
766
- if (res.statusCode == 200) {
767
- // handle response
768
- }
769
- }
770
-
771
- run();
772
- ```
773
-
774
- ### Parameters
775
-
776
- | Parameter | Type | Required | Description |
777
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
778
- | `request` | [operations.RemoveCrmContactRequest](../../sdk/models/operations/removecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
779
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
780
-
781
-
782
- ### Response
783
-
784
- **Promise<[operations.RemoveCrmContactResponse](../../sdk/models/operations/removecrmcontactresponse.md)>**
785
- ### Errors
786
-
787
- | Error Object | Status Code | Content Type |
788
- | --------------- | --------------- | --------------- |
789
- | errors.SDKError | 4xx-5xx | */* |
790
-
791
- ## removeUcContact
792
-
793
- Remove a contact
794
-
795
- ### Example Usage
796
-
797
- ```typescript
798
- import { UnifiedTo } from "@unified-api/typescript-sdk";
799
-
800
- async function run() {
801
- const sdk = new UnifiedTo({
802
- security: {
803
- jwt: "<YOUR_API_KEY_HERE>",
804
- },
805
- });
806
-
807
- const res = await sdk.contact.removeUcContact({
808
- connectionId: "<value>",
809
- id: "<id>",
810
- });
811
-
812
- if (res.statusCode == 200) {
813
- // handle response
814
- }
815
- }
816
-
817
- run();
818
- ```
819
-
820
- ### Parameters
821
-
822
- | Parameter | Type | Required | Description |
823
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
824
- | `request` | [operations.RemoveUcContactRequest](../../sdk/models/operations/removeuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
825
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
826
-
827
-
828
- ### Response
829
-
830
- **Promise<[operations.RemoveUcContactResponse](../../sdk/models/operations/removeuccontactresponse.md)>**
831
- ### Errors
832
-
833
- | Error Object | Status Code | Content Type |
834
- | --------------- | --------------- | --------------- |
835
- | errors.SDKError | 4xx-5xx | */* |
836
-
837
- ## updateAccountingContact
838
-
839
- Update a contact
840
-
841
- ### Example Usage
842
-
843
- ```typescript
844
- import { UnifiedTo } from "@unified-api/typescript-sdk";
845
- import { AccountingEmailType, AccountingTelephoneType, TaxExemption } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
846
-
847
- async function run() {
848
- const sdk = new UnifiedTo({
849
- security: {
850
- jwt: "<YOUR_API_KEY_HERE>",
851
- },
852
- });
853
-
854
- const res = await sdk.contact.updateAccountingContact({
855
- accountingContact: {
856
- billingAddress: {},
857
- emails: [
858
- {
859
- email: "Kaci_Hane@hotmail.com",
860
- },
861
- ],
862
- raw: {
863
- "key": "<value>",
864
- },
865
- shippingAddress: {},
866
- telephones: [
867
- {
868
- telephone: "<value>",
869
- },
870
- ],
871
- },
872
- connectionId: "<value>",
873
- id: "<id>",
874
- });
875
-
876
- if (res.statusCode == 200) {
877
- // handle response
878
- }
879
- }
880
-
881
- run();
882
- ```
883
-
884
- ### Parameters
885
-
886
- | Parameter | Type | Required | Description |
887
- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
888
- | `request` | [operations.UpdateAccountingContactRequest](../../sdk/models/operations/updateaccountingcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
889
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
890
-
891
-
892
- ### Response
893
-
894
- **Promise<[operations.UpdateAccountingContactResponse](../../sdk/models/operations/updateaccountingcontactresponse.md)>**
895
- ### Errors
896
-
897
- | Error Object | Status Code | Content Type |
898
- | --------------- | --------------- | --------------- |
899
- | errors.SDKError | 4xx-5xx | */* |
900
-
901
- ## updateCrmContact
902
-
903
- Update a contact
904
-
905
- ### Example Usage
906
-
907
- ```typescript
908
- import { UnifiedTo } from "@unified-api/typescript-sdk";
909
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
910
-
911
- async function run() {
912
- const sdk = new UnifiedTo({
913
- security: {
914
- jwt: "<YOUR_API_KEY_HERE>",
915
- },
916
- });
917
-
918
- const res = await sdk.contact.updateCrmContact({
919
- crmContact: {
920
- address: {},
921
- companyIds: [
922
- "<value>",
923
- ],
924
- dealIds: [
925
- "<value>",
926
- ],
927
- emails: [
928
- {},
929
- ],
930
- raw: {
931
- "key": "<value>",
932
- },
933
- telephones: [
934
- {
935
- telephone: "<value>",
936
- },
937
- ],
938
- },
939
- connectionId: "<value>",
940
- id: "<id>",
941
- });
942
-
943
- if (res.statusCode == 200) {
944
- // handle response
945
- }
946
- }
947
-
948
- run();
949
- ```
950
-
951
- ### Parameters
952
-
953
- | Parameter | Type | Required | Description |
954
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
955
- | `request` | [operations.UpdateCrmContactRequest](../../sdk/models/operations/updatecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
956
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
957
-
958
-
959
- ### Response
960
-
961
- **Promise<[operations.UpdateCrmContactResponse](../../sdk/models/operations/updatecrmcontactresponse.md)>**
962
- ### Errors
963
-
964
- | Error Object | Status Code | Content Type |
965
- | --------------- | --------------- | --------------- |
966
- | errors.SDKError | 4xx-5xx | */* |
967
-
968
- ## updateUcContact
969
-
970
- Update a contact
971
-
972
- ### Example Usage
973
-
974
- ```typescript
975
- import { UnifiedTo } from "@unified-api/typescript-sdk";
976
- import { UcEmailType, UcTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
977
-
978
- async function run() {
979
- const sdk = new UnifiedTo({
980
- security: {
981
- jwt: "<YOUR_API_KEY_HERE>",
982
- },
983
- });
984
-
985
- const res = await sdk.contact.updateUcContact({
986
- ucContact: {
987
- emails: [
988
- {
989
- email: "Kianna.Witting90@gmail.com",
990
- },
991
- ],
992
- raw: {
993
- "key": "<value>",
994
- },
995
- telephones: [
996
- {
997
- telephone: "<value>",
998
- },
999
- ],
1000
- },
1001
- connectionId: "<value>",
1002
- id: "<id>",
1003
- });
1004
-
1005
- if (res.statusCode == 200) {
1006
- // handle response
1007
- }
1008
- }
1009
-
1010
- run();
1011
- ```
1012
-
1013
- ### Parameters
1014
-
1015
- | Parameter | Type | Required | Description |
1016
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
1017
- | `request` | [operations.UpdateUcContactRequest](../../sdk/models/operations/updateuccontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1018
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1019
-
1020
-
1021
- ### Response
1022
-
1023
- **Promise<[operations.UpdateUcContactResponse](../../sdk/models/operations/updateuccontactresponse.md)>**
1024
- ### Errors
1025
-
1026
- | Error Object | Status Code | Content Type |
1027
- | --------------- | --------------- | --------------- |
1028
- | errors.SDKError | 4xx-5xx | */* |