@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,2048 +0,0 @@
1
- # Crm
2
- (*crm*)
3
-
4
- ### Available Operations
5
-
6
- * [createCrmCompany](#createcrmcompany) - Create a company
7
- * [createCrmContact](#createcrmcontact) - Create a contact
8
- * [createCrmDeal](#createcrmdeal) - Create a deal
9
- * [createCrmEvent](#createcrmevent) - Create a event
10
- * [createCrmLead](#createcrmlead) - Create a lead
11
- * [createCrmPipeline](#createcrmpipeline) - Create a pipeline
12
- * [getCrmCompany](#getcrmcompany) - Retrieve a company
13
- * [getCrmContact](#getcrmcontact) - Retrieve a contact
14
- * [getCrmDeal](#getcrmdeal) - Retrieve a deal
15
- * [getCrmEvent](#getcrmevent) - Retrieve a event
16
- * [getCrmLead](#getcrmlead) - Retrieve a lead
17
- * [getCrmPipeline](#getcrmpipeline) - Retrieve a pipeline
18
- * [listCrmCompanies](#listcrmcompanies) - List all companies
19
- * [listCrmContacts](#listcrmcontacts) - List all contacts
20
- * [listCrmDeals](#listcrmdeals) - List all deals
21
- * [listCrmEvents](#listcrmevents) - List all events
22
- * [listCrmLeads](#listcrmleads) - List all leads
23
- * [listCrmPipelines](#listcrmpipelines) - List all pipelines
24
- * [patchCrmCompany](#patchcrmcompany) - Update a company
25
- * [patchCrmContact](#patchcrmcontact) - Update a contact
26
- * [patchCrmDeal](#patchcrmdeal) - Update a deal
27
- * [patchCrmEvent](#patchcrmevent) - Update a event
28
- * [patchCrmLead](#patchcrmlead) - Update a lead
29
- * [patchCrmPipeline](#patchcrmpipeline) - Update a pipeline
30
- * [removeCrmCompany](#removecrmcompany) - Remove a company
31
- * [removeCrmContact](#removecrmcontact) - Remove a contact
32
- * [removeCrmDeal](#removecrmdeal) - Remove a deal
33
- * [removeCrmEvent](#removecrmevent) - Remove a event
34
- * [removeCrmLead](#removecrmlead) - Remove a lead
35
- * [removeCrmPipeline](#removecrmpipeline) - Remove a pipeline
36
- * [updateCrmCompany](#updatecrmcompany) - Update a company
37
- * [updateCrmContact](#updatecrmcontact) - Update a contact
38
- * [updateCrmDeal](#updatecrmdeal) - Update a deal
39
- * [updateCrmEvent](#updatecrmevent) - Update a event
40
- * [updateCrmLead](#updatecrmlead) - Update a lead
41
- * [updateCrmPipeline](#updatecrmpipeline) - Update a pipeline
42
-
43
- ## createCrmCompany
44
-
45
- Create a company
46
-
47
- ### Example Usage
48
-
49
- ```typescript
50
- import { UnifiedTo } from "@unified-api/typescript-sdk";
51
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
52
-
53
- async function run() {
54
- const sdk = new UnifiedTo({
55
- security: {
56
- jwt: "<YOUR_API_KEY_HERE>",
57
- },
58
- });
59
-
60
- const res = await sdk.crm.createCrmCompany({
61
- crmCompany: {
62
- address: {},
63
- dealIds: [
64
- "<value>",
65
- ],
66
- emails: [
67
- {},
68
- ],
69
- linkUrls: [
70
- "<value>",
71
- ],
72
- raw: {
73
- "key": "<value>",
74
- },
75
- tags: [
76
- "<value>",
77
- ],
78
- telephones: [
79
- {
80
- telephone: "<value>",
81
- },
82
- ],
83
- websites: [
84
- "<value>",
85
- ],
86
- },
87
- connectionId: "<value>",
88
- });
89
-
90
- if (res.statusCode == 200) {
91
- // handle response
92
- }
93
- }
94
-
95
- run();
96
- ```
97
-
98
- ### Parameters
99
-
100
- | Parameter | Type | Required | Description |
101
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
102
- | `request` | [operations.CreateCrmCompanyRequest](../../sdk/models/operations/createcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
103
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
104
-
105
-
106
- ### Response
107
-
108
- **Promise<[operations.CreateCrmCompanyResponse](../../sdk/models/operations/createcrmcompanyresponse.md)>**
109
- ### Errors
110
-
111
- | Error Object | Status Code | Content Type |
112
- | --------------- | --------------- | --------------- |
113
- | errors.SDKError | 4xx-5xx | */* |
114
-
115
- ## createCrmContact
116
-
117
- Create a contact
118
-
119
- ### Example Usage
120
-
121
- ```typescript
122
- import { UnifiedTo } from "@unified-api/typescript-sdk";
123
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
124
-
125
- async function run() {
126
- const sdk = new UnifiedTo({
127
- security: {
128
- jwt: "<YOUR_API_KEY_HERE>",
129
- },
130
- });
131
-
132
- const res = await sdk.crm.createCrmContact({
133
- crmContact: {
134
- address: {},
135
- companyIds: [
136
- "<value>",
137
- ],
138
- dealIds: [
139
- "<value>",
140
- ],
141
- emails: [
142
- {},
143
- ],
144
- raw: {
145
- "key": "<value>",
146
- },
147
- telephones: [
148
- {
149
- telephone: "<value>",
150
- },
151
- ],
152
- },
153
- connectionId: "<value>",
154
- });
155
-
156
- if (res.statusCode == 200) {
157
- // handle response
158
- }
159
- }
160
-
161
- run();
162
- ```
163
-
164
- ### Parameters
165
-
166
- | Parameter | Type | Required | Description |
167
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
168
- | `request` | [operations.CreateCrmContactRequest](../../sdk/models/operations/createcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
169
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
170
-
171
-
172
- ### Response
173
-
174
- **Promise<[operations.CreateCrmContactResponse](../../sdk/models/operations/createcrmcontactresponse.md)>**
175
- ### Errors
176
-
177
- | Error Object | Status Code | Content Type |
178
- | --------------- | --------------- | --------------- |
179
- | errors.SDKError | 4xx-5xx | */* |
180
-
181
- ## createCrmDeal
182
-
183
- Create a deal
184
-
185
- ### Example Usage
186
-
187
- ```typescript
188
- import { UnifiedTo } from "@unified-api/typescript-sdk";
189
-
190
- async function run() {
191
- const sdk = new UnifiedTo({
192
- security: {
193
- jwt: "<YOUR_API_KEY_HERE>",
194
- },
195
- });
196
-
197
- const res = await sdk.crm.createCrmDeal({
198
- crmDeal: {
199
- raw: {
200
- "key": "<value>",
201
- },
202
- tags: [
203
- "<value>",
204
- ],
205
- },
206
- connectionId: "<value>",
207
- });
208
-
209
- if (res.statusCode == 200) {
210
- // handle response
211
- }
212
- }
213
-
214
- run();
215
- ```
216
-
217
- ### Parameters
218
-
219
- | Parameter | Type | Required | Description |
220
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
221
- | `request` | [operations.CreateCrmDealRequest](../../sdk/models/operations/createcrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
222
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
223
-
224
-
225
- ### Response
226
-
227
- **Promise<[operations.CreateCrmDealResponse](../../sdk/models/operations/createcrmdealresponse.md)>**
228
- ### Errors
229
-
230
- | Error Object | Status Code | Content Type |
231
- | --------------- | --------------- | --------------- |
232
- | errors.SDKError | 4xx-5xx | */* |
233
-
234
- ## createCrmEvent
235
-
236
- Create a event
237
-
238
- ### Example Usage
239
-
240
- ```typescript
241
- import { UnifiedTo } from "@unified-api/typescript-sdk";
242
- import { CrmEventType, PropertyCrmEventTaskStatus } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
243
-
244
- async function run() {
245
- const sdk = new UnifiedTo({
246
- security: {
247
- jwt: "<YOUR_API_KEY_HERE>",
248
- },
249
- });
250
-
251
- const res = await sdk.crm.createCrmEvent({
252
- crmEvent: {
253
- call: {},
254
- companyIds: [
255
- "<value>",
256
- ],
257
- contactIds: [
258
- "<value>",
259
- ],
260
- dealIds: [
261
- "<value>",
262
- ],
263
- email: {
264
- attachmentFileIds: [
265
- "<value>",
266
- ],
267
- cc: [
268
- "<value>",
269
- ],
270
- to: [
271
- "<value>",
272
- ],
273
- },
274
- leadIds: [
275
- "<value>",
276
- ],
277
- meeting: {},
278
- note: {},
279
- raw: {
280
- "key": "<value>",
281
- },
282
- task: {},
283
- },
284
- connectionId: "<value>",
285
- });
286
-
287
- if (res.statusCode == 200) {
288
- // handle response
289
- }
290
- }
291
-
292
- run();
293
- ```
294
-
295
- ### Parameters
296
-
297
- | Parameter | Type | Required | Description |
298
- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
299
- | `request` | [operations.CreateCrmEventRequest](../../sdk/models/operations/createcrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
300
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
301
-
302
-
303
- ### Response
304
-
305
- **Promise<[operations.CreateCrmEventResponse](../../sdk/models/operations/createcrmeventresponse.md)>**
306
- ### Errors
307
-
308
- | Error Object | Status Code | Content Type |
309
- | --------------- | --------------- | --------------- |
310
- | errors.SDKError | 4xx-5xx | */* |
311
-
312
- ## createCrmLead
313
-
314
- Create a lead
315
-
316
- ### Example Usage
317
-
318
- ```typescript
319
- import { UnifiedTo } from "@unified-api/typescript-sdk";
320
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
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.crm.createCrmLead({
330
- crmLead: {
331
- address: {},
332
- emails: [
333
- {},
334
- ],
335
- raw: {
336
- "key": "<value>",
337
- },
338
- telephones: [
339
- {
340
- telephone: "<value>",
341
- },
342
- ],
343
- },
344
- connectionId: "<value>",
345
- });
346
-
347
- if (res.statusCode == 200) {
348
- // handle response
349
- }
350
- }
351
-
352
- run();
353
- ```
354
-
355
- ### Parameters
356
-
357
- | Parameter | Type | Required | Description |
358
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
359
- | `request` | [operations.CreateCrmLeadRequest](../../sdk/models/operations/createcrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
360
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
361
-
362
-
363
- ### Response
364
-
365
- **Promise<[operations.CreateCrmLeadResponse](../../sdk/models/operations/createcrmleadresponse.md)>**
366
- ### Errors
367
-
368
- | Error Object | Status Code | Content Type |
369
- | --------------- | --------------- | --------------- |
370
- | errors.SDKError | 4xx-5xx | */* |
371
-
372
- ## createCrmPipeline
373
-
374
- Create a pipeline
375
-
376
- ### Example Usage
377
-
378
- ```typescript
379
- import { UnifiedTo } from "@unified-api/typescript-sdk";
380
-
381
- async function run() {
382
- const sdk = new UnifiedTo({
383
- security: {
384
- jwt: "<YOUR_API_KEY_HERE>",
385
- },
386
- });
387
-
388
- const res = await sdk.crm.createCrmPipeline({
389
- crmPipeline: {
390
- raw: {
391
- "key": "<value>",
392
- },
393
- },
394
- connectionId: "<value>",
395
- });
396
-
397
- if (res.statusCode == 200) {
398
- // handle response
399
- }
400
- }
401
-
402
- run();
403
- ```
404
-
405
- ### Parameters
406
-
407
- | Parameter | Type | Required | Description |
408
- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
409
- | `request` | [operations.CreateCrmPipelineRequest](../../sdk/models/operations/createcrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
410
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
411
-
412
-
413
- ### Response
414
-
415
- **Promise<[operations.CreateCrmPipelineResponse](../../sdk/models/operations/createcrmpipelineresponse.md)>**
416
- ### Errors
417
-
418
- | Error Object | Status Code | Content Type |
419
- | --------------- | --------------- | --------------- |
420
- | errors.SDKError | 4xx-5xx | */* |
421
-
422
- ## getCrmCompany
423
-
424
- Retrieve a company
425
-
426
- ### Example Usage
427
-
428
- ```typescript
429
- import { UnifiedTo } from "@unified-api/typescript-sdk";
430
-
431
- async function run() {
432
- const sdk = new UnifiedTo({
433
- security: {
434
- jwt: "<YOUR_API_KEY_HERE>",
435
- },
436
- });
437
-
438
- const res = await sdk.crm.getCrmCompany({
439
- connectionId: "<value>",
440
- fields: [
441
- "<value>",
442
- ],
443
- id: "<id>",
444
- });
445
-
446
- if (res.statusCode == 200) {
447
- // handle response
448
- }
449
- }
450
-
451
- run();
452
- ```
453
-
454
- ### Parameters
455
-
456
- | Parameter | Type | Required | Description |
457
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
458
- | `request` | [operations.GetCrmCompanyRequest](../../sdk/models/operations/getcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
459
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
460
-
461
-
462
- ### Response
463
-
464
- **Promise<[operations.GetCrmCompanyResponse](../../sdk/models/operations/getcrmcompanyresponse.md)>**
465
- ### Errors
466
-
467
- | Error Object | Status Code | Content Type |
468
- | --------------- | --------------- | --------------- |
469
- | errors.SDKError | 4xx-5xx | */* |
470
-
471
- ## getCrmContact
472
-
473
- Retrieve a contact
474
-
475
- ### Example Usage
476
-
477
- ```typescript
478
- import { UnifiedTo } from "@unified-api/typescript-sdk";
479
-
480
- async function run() {
481
- const sdk = new UnifiedTo({
482
- security: {
483
- jwt: "<YOUR_API_KEY_HERE>",
484
- },
485
- });
486
-
487
- const res = await sdk.crm.getCrmContact({
488
- connectionId: "<value>",
489
- fields: [
490
- "<value>",
491
- ],
492
- id: "<id>",
493
- });
494
-
495
- if (res.statusCode == 200) {
496
- // handle response
497
- }
498
- }
499
-
500
- run();
501
- ```
502
-
503
- ### Parameters
504
-
505
- | Parameter | Type | Required | Description |
506
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
507
- | `request` | [operations.GetCrmContactRequest](../../sdk/models/operations/getcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
508
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
509
-
510
-
511
- ### Response
512
-
513
- **Promise<[operations.GetCrmContactResponse](../../sdk/models/operations/getcrmcontactresponse.md)>**
514
- ### Errors
515
-
516
- | Error Object | Status Code | Content Type |
517
- | --------------- | --------------- | --------------- |
518
- | errors.SDKError | 4xx-5xx | */* |
519
-
520
- ## getCrmDeal
521
-
522
- Retrieve a deal
523
-
524
- ### Example Usage
525
-
526
- ```typescript
527
- import { UnifiedTo } from "@unified-api/typescript-sdk";
528
-
529
- async function run() {
530
- const sdk = new UnifiedTo({
531
- security: {
532
- jwt: "<YOUR_API_KEY_HERE>",
533
- },
534
- });
535
-
536
- const res = await sdk.crm.getCrmDeal({
537
- connectionId: "<value>",
538
- fields: [
539
- "<value>",
540
- ],
541
- id: "<id>",
542
- });
543
-
544
- if (res.statusCode == 200) {
545
- // handle response
546
- }
547
- }
548
-
549
- run();
550
- ```
551
-
552
- ### Parameters
553
-
554
- | Parameter | Type | Required | Description |
555
- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
556
- | `request` | [operations.GetCrmDealRequest](../../sdk/models/operations/getcrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
557
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
558
-
559
-
560
- ### Response
561
-
562
- **Promise<[operations.GetCrmDealResponse](../../sdk/models/operations/getcrmdealresponse.md)>**
563
- ### Errors
564
-
565
- | Error Object | Status Code | Content Type |
566
- | --------------- | --------------- | --------------- |
567
- | errors.SDKError | 4xx-5xx | */* |
568
-
569
- ## getCrmEvent
570
-
571
- Retrieve a event
572
-
573
- ### Example Usage
574
-
575
- ```typescript
576
- import { UnifiedTo } from "@unified-api/typescript-sdk";
577
-
578
- async function run() {
579
- const sdk = new UnifiedTo({
580
- security: {
581
- jwt: "<YOUR_API_KEY_HERE>",
582
- },
583
- });
584
-
585
- const res = await sdk.crm.getCrmEvent({
586
- connectionId: "<value>",
587
- fields: [
588
- "<value>",
589
- ],
590
- id: "<id>",
591
- });
592
-
593
- if (res.statusCode == 200) {
594
- // handle response
595
- }
596
- }
597
-
598
- run();
599
- ```
600
-
601
- ### Parameters
602
-
603
- | Parameter | Type | Required | Description |
604
- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
605
- | `request` | [operations.GetCrmEventRequest](../../sdk/models/operations/getcrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
606
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
607
-
608
-
609
- ### Response
610
-
611
- **Promise<[operations.GetCrmEventResponse](../../sdk/models/operations/getcrmeventresponse.md)>**
612
- ### Errors
613
-
614
- | Error Object | Status Code | Content Type |
615
- | --------------- | --------------- | --------------- |
616
- | errors.SDKError | 4xx-5xx | */* |
617
-
618
- ## getCrmLead
619
-
620
- Retrieve a lead
621
-
622
- ### Example Usage
623
-
624
- ```typescript
625
- import { UnifiedTo } from "@unified-api/typescript-sdk";
626
-
627
- async function run() {
628
- const sdk = new UnifiedTo({
629
- security: {
630
- jwt: "<YOUR_API_KEY_HERE>",
631
- },
632
- });
633
-
634
- const res = await sdk.crm.getCrmLead({
635
- connectionId: "<value>",
636
- fields: [
637
- "<value>",
638
- ],
639
- id: "<id>",
640
- });
641
-
642
- if (res.statusCode == 200) {
643
- // handle response
644
- }
645
- }
646
-
647
- run();
648
- ```
649
-
650
- ### Parameters
651
-
652
- | Parameter | Type | Required | Description |
653
- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
654
- | `request` | [operations.GetCrmLeadRequest](../../sdk/models/operations/getcrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
655
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
656
-
657
-
658
- ### Response
659
-
660
- **Promise<[operations.GetCrmLeadResponse](../../sdk/models/operations/getcrmleadresponse.md)>**
661
- ### Errors
662
-
663
- | Error Object | Status Code | Content Type |
664
- | --------------- | --------------- | --------------- |
665
- | errors.SDKError | 4xx-5xx | */* |
666
-
667
- ## getCrmPipeline
668
-
669
- Retrieve a pipeline
670
-
671
- ### Example Usage
672
-
673
- ```typescript
674
- import { UnifiedTo } from "@unified-api/typescript-sdk";
675
-
676
- async function run() {
677
- const sdk = new UnifiedTo({
678
- security: {
679
- jwt: "<YOUR_API_KEY_HERE>",
680
- },
681
- });
682
-
683
- const res = await sdk.crm.getCrmPipeline({
684
- connectionId: "<value>",
685
- fields: [
686
- "<value>",
687
- ],
688
- id: "<id>",
689
- });
690
-
691
- if (res.statusCode == 200) {
692
- // handle response
693
- }
694
- }
695
-
696
- run();
697
- ```
698
-
699
- ### Parameters
700
-
701
- | Parameter | Type | Required | Description |
702
- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
703
- | `request` | [operations.GetCrmPipelineRequest](../../sdk/models/operations/getcrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
704
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
705
-
706
-
707
- ### Response
708
-
709
- **Promise<[operations.GetCrmPipelineResponse](../../sdk/models/operations/getcrmpipelineresponse.md)>**
710
- ### Errors
711
-
712
- | Error Object | Status Code | Content Type |
713
- | --------------- | --------------- | --------------- |
714
- | errors.SDKError | 4xx-5xx | */* |
715
-
716
- ## listCrmCompanies
717
-
718
- List all companies
719
-
720
- ### Example Usage
721
-
722
- ```typescript
723
- import { UnifiedTo } from "@unified-api/typescript-sdk";
724
-
725
- async function run() {
726
- const sdk = new UnifiedTo({
727
- security: {
728
- jwt: "<YOUR_API_KEY_HERE>",
729
- },
730
- });
731
-
732
- const res = await sdk.crm.listCrmCompanies({
733
- connectionId: "<value>",
734
- fields: [
735
- "<value>",
736
- ],
737
- });
738
-
739
- if (res.statusCode == 200) {
740
- // handle response
741
- }
742
- }
743
-
744
- run();
745
- ```
746
-
747
- ### Parameters
748
-
749
- | Parameter | Type | Required | Description |
750
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
751
- | `request` | [operations.ListCrmCompaniesRequest](../../sdk/models/operations/listcrmcompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
752
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
753
-
754
-
755
- ### Response
756
-
757
- **Promise<[operations.ListCrmCompaniesResponse](../../sdk/models/operations/listcrmcompaniesresponse.md)>**
758
- ### Errors
759
-
760
- | Error Object | Status Code | Content Type |
761
- | --------------- | --------------- | --------------- |
762
- | errors.SDKError | 4xx-5xx | */* |
763
-
764
- ## listCrmContacts
765
-
766
- List all contacts
767
-
768
- ### Example Usage
769
-
770
- ```typescript
771
- import { UnifiedTo } from "@unified-api/typescript-sdk";
772
-
773
- async function run() {
774
- const sdk = new UnifiedTo({
775
- security: {
776
- jwt: "<YOUR_API_KEY_HERE>",
777
- },
778
- });
779
-
780
- const res = await sdk.crm.listCrmContacts({
781
- connectionId: "<value>",
782
- fields: [
783
- "<value>",
784
- ],
785
- });
786
-
787
- if (res.statusCode == 200) {
788
- // handle response
789
- }
790
- }
791
-
792
- run();
793
- ```
794
-
795
- ### Parameters
796
-
797
- | Parameter | Type | Required | Description |
798
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
799
- | `request` | [operations.ListCrmContactsRequest](../../sdk/models/operations/listcrmcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
800
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
801
-
802
-
803
- ### Response
804
-
805
- **Promise<[operations.ListCrmContactsResponse](../../sdk/models/operations/listcrmcontactsresponse.md)>**
806
- ### Errors
807
-
808
- | Error Object | Status Code | Content Type |
809
- | --------------- | --------------- | --------------- |
810
- | errors.SDKError | 4xx-5xx | */* |
811
-
812
- ## listCrmDeals
813
-
814
- List all deals
815
-
816
- ### Example Usage
817
-
818
- ```typescript
819
- import { UnifiedTo } from "@unified-api/typescript-sdk";
820
-
821
- async function run() {
822
- const sdk = new UnifiedTo({
823
- security: {
824
- jwt: "<YOUR_API_KEY_HERE>",
825
- },
826
- });
827
-
828
- const res = await sdk.crm.listCrmDeals({
829
- connectionId: "<value>",
830
- fields: [
831
- "<value>",
832
- ],
833
- });
834
-
835
- if (res.statusCode == 200) {
836
- // handle response
837
- }
838
- }
839
-
840
- run();
841
- ```
842
-
843
- ### Parameters
844
-
845
- | Parameter | Type | Required | Description |
846
- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
847
- | `request` | [operations.ListCrmDealsRequest](../../sdk/models/operations/listcrmdealsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
848
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
849
-
850
-
851
- ### Response
852
-
853
- **Promise<[operations.ListCrmDealsResponse](../../sdk/models/operations/listcrmdealsresponse.md)>**
854
- ### Errors
855
-
856
- | Error Object | Status Code | Content Type |
857
- | --------------- | --------------- | --------------- |
858
- | errors.SDKError | 4xx-5xx | */* |
859
-
860
- ## listCrmEvents
861
-
862
- List all events
863
-
864
- ### Example Usage
865
-
866
- ```typescript
867
- import { UnifiedTo } from "@unified-api/typescript-sdk";
868
-
869
- async function run() {
870
- const sdk = new UnifiedTo({
871
- security: {
872
- jwt: "<YOUR_API_KEY_HERE>",
873
- },
874
- });
875
-
876
- const res = await sdk.crm.listCrmEvents({
877
- connectionId: "<value>",
878
- fields: [
879
- "<value>",
880
- ],
881
- });
882
-
883
- if (res.statusCode == 200) {
884
- // handle response
885
- }
886
- }
887
-
888
- run();
889
- ```
890
-
891
- ### Parameters
892
-
893
- | Parameter | Type | Required | Description |
894
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
895
- | `request` | [operations.ListCrmEventsRequest](../../sdk/models/operations/listcrmeventsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
896
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
897
-
898
-
899
- ### Response
900
-
901
- **Promise<[operations.ListCrmEventsResponse](../../sdk/models/operations/listcrmeventsresponse.md)>**
902
- ### Errors
903
-
904
- | Error Object | Status Code | Content Type |
905
- | --------------- | --------------- | --------------- |
906
- | errors.SDKError | 4xx-5xx | */* |
907
-
908
- ## listCrmLeads
909
-
910
- List all leads
911
-
912
- ### Example Usage
913
-
914
- ```typescript
915
- import { UnifiedTo } from "@unified-api/typescript-sdk";
916
-
917
- async function run() {
918
- const sdk = new UnifiedTo({
919
- security: {
920
- jwt: "<YOUR_API_KEY_HERE>",
921
- },
922
- });
923
-
924
- const res = await sdk.crm.listCrmLeads({
925
- connectionId: "<value>",
926
- fields: [
927
- "<value>",
928
- ],
929
- });
930
-
931
- if (res.statusCode == 200) {
932
- // handle response
933
- }
934
- }
935
-
936
- run();
937
- ```
938
-
939
- ### Parameters
940
-
941
- | Parameter | Type | Required | Description |
942
- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
943
- | `request` | [operations.ListCrmLeadsRequest](../../sdk/models/operations/listcrmleadsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
944
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
945
-
946
-
947
- ### Response
948
-
949
- **Promise<[operations.ListCrmLeadsResponse](../../sdk/models/operations/listcrmleadsresponse.md)>**
950
- ### Errors
951
-
952
- | Error Object | Status Code | Content Type |
953
- | --------------- | --------------- | --------------- |
954
- | errors.SDKError | 4xx-5xx | */* |
955
-
956
- ## listCrmPipelines
957
-
958
- List all pipelines
959
-
960
- ### Example Usage
961
-
962
- ```typescript
963
- import { UnifiedTo } from "@unified-api/typescript-sdk";
964
-
965
- async function run() {
966
- const sdk = new UnifiedTo({
967
- security: {
968
- jwt: "<YOUR_API_KEY_HERE>",
969
- },
970
- });
971
-
972
- const res = await sdk.crm.listCrmPipelines({
973
- connectionId: "<value>",
974
- fields: [
975
- "<value>",
976
- ],
977
- });
978
-
979
- if (res.statusCode == 200) {
980
- // handle response
981
- }
982
- }
983
-
984
- run();
985
- ```
986
-
987
- ### Parameters
988
-
989
- | Parameter | Type | Required | Description |
990
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
991
- | `request` | [operations.ListCrmPipelinesRequest](../../sdk/models/operations/listcrmpipelinesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
992
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
993
-
994
-
995
- ### Response
996
-
997
- **Promise<[operations.ListCrmPipelinesResponse](../../sdk/models/operations/listcrmpipelinesresponse.md)>**
998
- ### Errors
999
-
1000
- | Error Object | Status Code | Content Type |
1001
- | --------------- | --------------- | --------------- |
1002
- | errors.SDKError | 4xx-5xx | */* |
1003
-
1004
- ## patchCrmCompany
1005
-
1006
- Update a company
1007
-
1008
- ### Example Usage
1009
-
1010
- ```typescript
1011
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1012
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1013
-
1014
- async function run() {
1015
- const sdk = new UnifiedTo({
1016
- security: {
1017
- jwt: "<YOUR_API_KEY_HERE>",
1018
- },
1019
- });
1020
-
1021
- const res = await sdk.crm.patchCrmCompany({
1022
- crmCompany: {
1023
- address: {},
1024
- dealIds: [
1025
- "<value>",
1026
- ],
1027
- emails: [
1028
- {},
1029
- ],
1030
- linkUrls: [
1031
- "<value>",
1032
- ],
1033
- raw: {
1034
- "key": "<value>",
1035
- },
1036
- tags: [
1037
- "<value>",
1038
- ],
1039
- telephones: [
1040
- {
1041
- telephone: "<value>",
1042
- },
1043
- ],
1044
- websites: [
1045
- "<value>",
1046
- ],
1047
- },
1048
- connectionId: "<value>",
1049
- id: "<id>",
1050
- });
1051
-
1052
- if (res.statusCode == 200) {
1053
- // handle response
1054
- }
1055
- }
1056
-
1057
- run();
1058
- ```
1059
-
1060
- ### Parameters
1061
-
1062
- | Parameter | Type | Required | Description |
1063
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
1064
- | `request` | [operations.PatchCrmCompanyRequest](../../sdk/models/operations/patchcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1065
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1066
-
1067
-
1068
- ### Response
1069
-
1070
- **Promise<[operations.PatchCrmCompanyResponse](../../sdk/models/operations/patchcrmcompanyresponse.md)>**
1071
- ### Errors
1072
-
1073
- | Error Object | Status Code | Content Type |
1074
- | --------------- | --------------- | --------------- |
1075
- | errors.SDKError | 4xx-5xx | */* |
1076
-
1077
- ## patchCrmContact
1078
-
1079
- Update a contact
1080
-
1081
- ### Example Usage
1082
-
1083
- ```typescript
1084
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1085
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1086
-
1087
- async function run() {
1088
- const sdk = new UnifiedTo({
1089
- security: {
1090
- jwt: "<YOUR_API_KEY_HERE>",
1091
- },
1092
- });
1093
-
1094
- const res = await sdk.crm.patchCrmContact({
1095
- crmContact: {
1096
- address: {},
1097
- companyIds: [
1098
- "<value>",
1099
- ],
1100
- dealIds: [
1101
- "<value>",
1102
- ],
1103
- emails: [
1104
- {},
1105
- ],
1106
- raw: {
1107
- "key": "<value>",
1108
- },
1109
- telephones: [
1110
- {
1111
- telephone: "<value>",
1112
- },
1113
- ],
1114
- },
1115
- connectionId: "<value>",
1116
- id: "<id>",
1117
- });
1118
-
1119
- if (res.statusCode == 200) {
1120
- // handle response
1121
- }
1122
- }
1123
-
1124
- run();
1125
- ```
1126
-
1127
- ### Parameters
1128
-
1129
- | Parameter | Type | Required | Description |
1130
- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
1131
- | `request` | [operations.PatchCrmContactRequest](../../sdk/models/operations/patchcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1132
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1133
-
1134
-
1135
- ### Response
1136
-
1137
- **Promise<[operations.PatchCrmContactResponse](../../sdk/models/operations/patchcrmcontactresponse.md)>**
1138
- ### Errors
1139
-
1140
- | Error Object | Status Code | Content Type |
1141
- | --------------- | --------------- | --------------- |
1142
- | errors.SDKError | 4xx-5xx | */* |
1143
-
1144
- ## patchCrmDeal
1145
-
1146
- Update a deal
1147
-
1148
- ### Example Usage
1149
-
1150
- ```typescript
1151
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1152
-
1153
- async function run() {
1154
- const sdk = new UnifiedTo({
1155
- security: {
1156
- jwt: "<YOUR_API_KEY_HERE>",
1157
- },
1158
- });
1159
-
1160
- const res = await sdk.crm.patchCrmDeal({
1161
- crmDeal: {
1162
- raw: {
1163
- "key": "<value>",
1164
- },
1165
- tags: [
1166
- "<value>",
1167
- ],
1168
- },
1169
- connectionId: "<value>",
1170
- id: "<id>",
1171
- });
1172
-
1173
- if (res.statusCode == 200) {
1174
- // handle response
1175
- }
1176
- }
1177
-
1178
- run();
1179
- ```
1180
-
1181
- ### Parameters
1182
-
1183
- | Parameter | Type | Required | Description |
1184
- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
1185
- | `request` | [operations.PatchCrmDealRequest](../../sdk/models/operations/patchcrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1186
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1187
-
1188
-
1189
- ### Response
1190
-
1191
- **Promise<[operations.PatchCrmDealResponse](../../sdk/models/operations/patchcrmdealresponse.md)>**
1192
- ### Errors
1193
-
1194
- | Error Object | Status Code | Content Type |
1195
- | --------------- | --------------- | --------------- |
1196
- | errors.SDKError | 4xx-5xx | */* |
1197
-
1198
- ## patchCrmEvent
1199
-
1200
- Update a event
1201
-
1202
- ### Example Usage
1203
-
1204
- ```typescript
1205
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1206
- import { CrmEventType, PropertyCrmEventTaskStatus } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1207
-
1208
- async function run() {
1209
- const sdk = new UnifiedTo({
1210
- security: {
1211
- jwt: "<YOUR_API_KEY_HERE>",
1212
- },
1213
- });
1214
-
1215
- const res = await sdk.crm.patchCrmEvent({
1216
- crmEvent: {
1217
- call: {},
1218
- companyIds: [
1219
- "<value>",
1220
- ],
1221
- contactIds: [
1222
- "<value>",
1223
- ],
1224
- dealIds: [
1225
- "<value>",
1226
- ],
1227
- email: {
1228
- attachmentFileIds: [
1229
- "<value>",
1230
- ],
1231
- cc: [
1232
- "<value>",
1233
- ],
1234
- to: [
1235
- "<value>",
1236
- ],
1237
- },
1238
- leadIds: [
1239
- "<value>",
1240
- ],
1241
- meeting: {},
1242
- note: {},
1243
- raw: {
1244
- "key": "<value>",
1245
- },
1246
- task: {},
1247
- },
1248
- connectionId: "<value>",
1249
- id: "<id>",
1250
- });
1251
-
1252
- if (res.statusCode == 200) {
1253
- // handle response
1254
- }
1255
- }
1256
-
1257
- run();
1258
- ```
1259
-
1260
- ### Parameters
1261
-
1262
- | Parameter | Type | Required | Description |
1263
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1264
- | `request` | [operations.PatchCrmEventRequest](../../sdk/models/operations/patchcrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1265
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1266
-
1267
-
1268
- ### Response
1269
-
1270
- **Promise<[operations.PatchCrmEventResponse](../../sdk/models/operations/patchcrmeventresponse.md)>**
1271
- ### Errors
1272
-
1273
- | Error Object | Status Code | Content Type |
1274
- | --------------- | --------------- | --------------- |
1275
- | errors.SDKError | 4xx-5xx | */* |
1276
-
1277
- ## patchCrmLead
1278
-
1279
- Update a lead
1280
-
1281
- ### Example Usage
1282
-
1283
- ```typescript
1284
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1285
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1286
-
1287
- async function run() {
1288
- const sdk = new UnifiedTo({
1289
- security: {
1290
- jwt: "<YOUR_API_KEY_HERE>",
1291
- },
1292
- });
1293
-
1294
- const res = await sdk.crm.patchCrmLead({
1295
- crmLead: {
1296
- address: {},
1297
- emails: [
1298
- {},
1299
- ],
1300
- raw: {
1301
- "key": "<value>",
1302
- },
1303
- telephones: [
1304
- {
1305
- telephone: "<value>",
1306
- },
1307
- ],
1308
- },
1309
- connectionId: "<value>",
1310
- id: "<id>",
1311
- });
1312
-
1313
- if (res.statusCode == 200) {
1314
- // handle response
1315
- }
1316
- }
1317
-
1318
- run();
1319
- ```
1320
-
1321
- ### Parameters
1322
-
1323
- | Parameter | Type | Required | Description |
1324
- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
1325
- | `request` | [operations.PatchCrmLeadRequest](../../sdk/models/operations/patchcrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1326
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1327
-
1328
-
1329
- ### Response
1330
-
1331
- **Promise<[operations.PatchCrmLeadResponse](../../sdk/models/operations/patchcrmleadresponse.md)>**
1332
- ### Errors
1333
-
1334
- | Error Object | Status Code | Content Type |
1335
- | --------------- | --------------- | --------------- |
1336
- | errors.SDKError | 4xx-5xx | */* |
1337
-
1338
- ## patchCrmPipeline
1339
-
1340
- Update a pipeline
1341
-
1342
- ### Example Usage
1343
-
1344
- ```typescript
1345
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1346
-
1347
- async function run() {
1348
- const sdk = new UnifiedTo({
1349
- security: {
1350
- jwt: "<YOUR_API_KEY_HERE>",
1351
- },
1352
- });
1353
-
1354
- const res = await sdk.crm.patchCrmPipeline({
1355
- crmPipeline: {
1356
- raw: {
1357
- "key": "<value>",
1358
- },
1359
- },
1360
- connectionId: "<value>",
1361
- id: "<id>",
1362
- });
1363
-
1364
- if (res.statusCode == 200) {
1365
- // handle response
1366
- }
1367
- }
1368
-
1369
- run();
1370
- ```
1371
-
1372
- ### Parameters
1373
-
1374
- | Parameter | Type | Required | Description |
1375
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
1376
- | `request` | [operations.PatchCrmPipelineRequest](../../sdk/models/operations/patchcrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1377
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1378
-
1379
-
1380
- ### Response
1381
-
1382
- **Promise<[operations.PatchCrmPipelineResponse](../../sdk/models/operations/patchcrmpipelineresponse.md)>**
1383
- ### Errors
1384
-
1385
- | Error Object | Status Code | Content Type |
1386
- | --------------- | --------------- | --------------- |
1387
- | errors.SDKError | 4xx-5xx | */* |
1388
-
1389
- ## removeCrmCompany
1390
-
1391
- Remove a company
1392
-
1393
- ### Example Usage
1394
-
1395
- ```typescript
1396
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1397
-
1398
- async function run() {
1399
- const sdk = new UnifiedTo({
1400
- security: {
1401
- jwt: "<YOUR_API_KEY_HERE>",
1402
- },
1403
- });
1404
-
1405
- const res = await sdk.crm.removeCrmCompany({
1406
- connectionId: "<value>",
1407
- id: "<id>",
1408
- });
1409
-
1410
- if (res.statusCode == 200) {
1411
- // handle response
1412
- }
1413
- }
1414
-
1415
- run();
1416
- ```
1417
-
1418
- ### Parameters
1419
-
1420
- | Parameter | Type | Required | Description |
1421
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
1422
- | `request` | [operations.RemoveCrmCompanyRequest](../../sdk/models/operations/removecrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1423
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1424
-
1425
-
1426
- ### Response
1427
-
1428
- **Promise<[operations.RemoveCrmCompanyResponse](../../sdk/models/operations/removecrmcompanyresponse.md)>**
1429
- ### Errors
1430
-
1431
- | Error Object | Status Code | Content Type |
1432
- | --------------- | --------------- | --------------- |
1433
- | errors.SDKError | 4xx-5xx | */* |
1434
-
1435
- ## removeCrmContact
1436
-
1437
- Remove a contact
1438
-
1439
- ### Example Usage
1440
-
1441
- ```typescript
1442
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1443
-
1444
- async function run() {
1445
- const sdk = new UnifiedTo({
1446
- security: {
1447
- jwt: "<YOUR_API_KEY_HERE>",
1448
- },
1449
- });
1450
-
1451
- const res = await sdk.crm.removeCrmContact({
1452
- connectionId: "<value>",
1453
- id: "<id>",
1454
- });
1455
-
1456
- if (res.statusCode == 200) {
1457
- // handle response
1458
- }
1459
- }
1460
-
1461
- run();
1462
- ```
1463
-
1464
- ### Parameters
1465
-
1466
- | Parameter | Type | Required | Description |
1467
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
1468
- | `request` | [operations.RemoveCrmContactRequest](../../sdk/models/operations/removecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1469
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1470
-
1471
-
1472
- ### Response
1473
-
1474
- **Promise<[operations.RemoveCrmContactResponse](../../sdk/models/operations/removecrmcontactresponse.md)>**
1475
- ### Errors
1476
-
1477
- | Error Object | Status Code | Content Type |
1478
- | --------------- | --------------- | --------------- |
1479
- | errors.SDKError | 4xx-5xx | */* |
1480
-
1481
- ## removeCrmDeal
1482
-
1483
- Remove a deal
1484
-
1485
- ### Example Usage
1486
-
1487
- ```typescript
1488
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1489
-
1490
- async function run() {
1491
- const sdk = new UnifiedTo({
1492
- security: {
1493
- jwt: "<YOUR_API_KEY_HERE>",
1494
- },
1495
- });
1496
-
1497
- const res = await sdk.crm.removeCrmDeal({
1498
- connectionId: "<value>",
1499
- id: "<id>",
1500
- });
1501
-
1502
- if (res.statusCode == 200) {
1503
- // handle response
1504
- }
1505
- }
1506
-
1507
- run();
1508
- ```
1509
-
1510
- ### Parameters
1511
-
1512
- | Parameter | Type | Required | Description |
1513
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1514
- | `request` | [operations.RemoveCrmDealRequest](../../sdk/models/operations/removecrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1515
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1516
-
1517
-
1518
- ### Response
1519
-
1520
- **Promise<[operations.RemoveCrmDealResponse](../../sdk/models/operations/removecrmdealresponse.md)>**
1521
- ### Errors
1522
-
1523
- | Error Object | Status Code | Content Type |
1524
- | --------------- | --------------- | --------------- |
1525
- | errors.SDKError | 4xx-5xx | */* |
1526
-
1527
- ## removeCrmEvent
1528
-
1529
- Remove a event
1530
-
1531
- ### Example Usage
1532
-
1533
- ```typescript
1534
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1535
-
1536
- async function run() {
1537
- const sdk = new UnifiedTo({
1538
- security: {
1539
- jwt: "<YOUR_API_KEY_HERE>",
1540
- },
1541
- });
1542
-
1543
- const res = await sdk.crm.removeCrmEvent({
1544
- connectionId: "<value>",
1545
- id: "<id>",
1546
- });
1547
-
1548
- if (res.statusCode == 200) {
1549
- // handle response
1550
- }
1551
- }
1552
-
1553
- run();
1554
- ```
1555
-
1556
- ### Parameters
1557
-
1558
- | Parameter | Type | Required | Description |
1559
- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
1560
- | `request` | [operations.RemoveCrmEventRequest](../../sdk/models/operations/removecrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1561
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1562
-
1563
-
1564
- ### Response
1565
-
1566
- **Promise<[operations.RemoveCrmEventResponse](../../sdk/models/operations/removecrmeventresponse.md)>**
1567
- ### Errors
1568
-
1569
- | Error Object | Status Code | Content Type |
1570
- | --------------- | --------------- | --------------- |
1571
- | errors.SDKError | 4xx-5xx | */* |
1572
-
1573
- ## removeCrmLead
1574
-
1575
- Remove a lead
1576
-
1577
- ### Example Usage
1578
-
1579
- ```typescript
1580
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1581
-
1582
- async function run() {
1583
- const sdk = new UnifiedTo({
1584
- security: {
1585
- jwt: "<YOUR_API_KEY_HERE>",
1586
- },
1587
- });
1588
-
1589
- const res = await sdk.crm.removeCrmLead({
1590
- connectionId: "<value>",
1591
- id: "<id>",
1592
- });
1593
-
1594
- if (res.statusCode == 200) {
1595
- // handle response
1596
- }
1597
- }
1598
-
1599
- run();
1600
- ```
1601
-
1602
- ### Parameters
1603
-
1604
- | Parameter | Type | Required | Description |
1605
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1606
- | `request` | [operations.RemoveCrmLeadRequest](../../sdk/models/operations/removecrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1607
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1608
-
1609
-
1610
- ### Response
1611
-
1612
- **Promise<[operations.RemoveCrmLeadResponse](../../sdk/models/operations/removecrmleadresponse.md)>**
1613
- ### Errors
1614
-
1615
- | Error Object | Status Code | Content Type |
1616
- | --------------- | --------------- | --------------- |
1617
- | errors.SDKError | 4xx-5xx | */* |
1618
-
1619
- ## removeCrmPipeline
1620
-
1621
- Remove a pipeline
1622
-
1623
- ### Example Usage
1624
-
1625
- ```typescript
1626
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1627
-
1628
- async function run() {
1629
- const sdk = new UnifiedTo({
1630
- security: {
1631
- jwt: "<YOUR_API_KEY_HERE>",
1632
- },
1633
- });
1634
-
1635
- const res = await sdk.crm.removeCrmPipeline({
1636
- connectionId: "<value>",
1637
- id: "<id>",
1638
- });
1639
-
1640
- if (res.statusCode == 200) {
1641
- // handle response
1642
- }
1643
- }
1644
-
1645
- run();
1646
- ```
1647
-
1648
- ### Parameters
1649
-
1650
- | Parameter | Type | Required | Description |
1651
- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
1652
- | `request` | [operations.RemoveCrmPipelineRequest](../../sdk/models/operations/removecrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1653
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1654
-
1655
-
1656
- ### Response
1657
-
1658
- **Promise<[operations.RemoveCrmPipelineResponse](../../sdk/models/operations/removecrmpipelineresponse.md)>**
1659
- ### Errors
1660
-
1661
- | Error Object | Status Code | Content Type |
1662
- | --------------- | --------------- | --------------- |
1663
- | errors.SDKError | 4xx-5xx | */* |
1664
-
1665
- ## updateCrmCompany
1666
-
1667
- Update a company
1668
-
1669
- ### Example Usage
1670
-
1671
- ```typescript
1672
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1673
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1674
-
1675
- async function run() {
1676
- const sdk = new UnifiedTo({
1677
- security: {
1678
- jwt: "<YOUR_API_KEY_HERE>",
1679
- },
1680
- });
1681
-
1682
- const res = await sdk.crm.updateCrmCompany({
1683
- crmCompany: {
1684
- address: {},
1685
- dealIds: [
1686
- "<value>",
1687
- ],
1688
- emails: [
1689
- {},
1690
- ],
1691
- linkUrls: [
1692
- "<value>",
1693
- ],
1694
- raw: {
1695
- "key": "<value>",
1696
- },
1697
- tags: [
1698
- "<value>",
1699
- ],
1700
- telephones: [
1701
- {
1702
- telephone: "<value>",
1703
- },
1704
- ],
1705
- websites: [
1706
- "<value>",
1707
- ],
1708
- },
1709
- connectionId: "<value>",
1710
- id: "<id>",
1711
- });
1712
-
1713
- if (res.statusCode == 200) {
1714
- // handle response
1715
- }
1716
- }
1717
-
1718
- run();
1719
- ```
1720
-
1721
- ### Parameters
1722
-
1723
- | Parameter | Type | Required | Description |
1724
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
1725
- | `request` | [operations.UpdateCrmCompanyRequest](../../sdk/models/operations/updatecrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1726
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1727
-
1728
-
1729
- ### Response
1730
-
1731
- **Promise<[operations.UpdateCrmCompanyResponse](../../sdk/models/operations/updatecrmcompanyresponse.md)>**
1732
- ### Errors
1733
-
1734
- | Error Object | Status Code | Content Type |
1735
- | --------------- | --------------- | --------------- |
1736
- | errors.SDKError | 4xx-5xx | */* |
1737
-
1738
- ## updateCrmContact
1739
-
1740
- Update a contact
1741
-
1742
- ### Example Usage
1743
-
1744
- ```typescript
1745
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1746
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1747
-
1748
- async function run() {
1749
- const sdk = new UnifiedTo({
1750
- security: {
1751
- jwt: "<YOUR_API_KEY_HERE>",
1752
- },
1753
- });
1754
-
1755
- const res = await sdk.crm.updateCrmContact({
1756
- crmContact: {
1757
- address: {},
1758
- companyIds: [
1759
- "<value>",
1760
- ],
1761
- dealIds: [
1762
- "<value>",
1763
- ],
1764
- emails: [
1765
- {},
1766
- ],
1767
- raw: {
1768
- "key": "<value>",
1769
- },
1770
- telephones: [
1771
- {
1772
- telephone: "<value>",
1773
- },
1774
- ],
1775
- },
1776
- connectionId: "<value>",
1777
- id: "<id>",
1778
- });
1779
-
1780
- if (res.statusCode == 200) {
1781
- // handle response
1782
- }
1783
- }
1784
-
1785
- run();
1786
- ```
1787
-
1788
- ### Parameters
1789
-
1790
- | Parameter | Type | Required | Description |
1791
- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
1792
- | `request` | [operations.UpdateCrmContactRequest](../../sdk/models/operations/updatecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1793
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1794
-
1795
-
1796
- ### Response
1797
-
1798
- **Promise<[operations.UpdateCrmContactResponse](../../sdk/models/operations/updatecrmcontactresponse.md)>**
1799
- ### Errors
1800
-
1801
- | Error Object | Status Code | Content Type |
1802
- | --------------- | --------------- | --------------- |
1803
- | errors.SDKError | 4xx-5xx | */* |
1804
-
1805
- ## updateCrmDeal
1806
-
1807
- Update a deal
1808
-
1809
- ### Example Usage
1810
-
1811
- ```typescript
1812
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1813
-
1814
- async function run() {
1815
- const sdk = new UnifiedTo({
1816
- security: {
1817
- jwt: "<YOUR_API_KEY_HERE>",
1818
- },
1819
- });
1820
-
1821
- const res = await sdk.crm.updateCrmDeal({
1822
- crmDeal: {
1823
- raw: {
1824
- "key": "<value>",
1825
- },
1826
- tags: [
1827
- "<value>",
1828
- ],
1829
- },
1830
- connectionId: "<value>",
1831
- id: "<id>",
1832
- });
1833
-
1834
- if (res.statusCode == 200) {
1835
- // handle response
1836
- }
1837
- }
1838
-
1839
- run();
1840
- ```
1841
-
1842
- ### Parameters
1843
-
1844
- | Parameter | Type | Required | Description |
1845
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1846
- | `request` | [operations.UpdateCrmDealRequest](../../sdk/models/operations/updatecrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1847
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1848
-
1849
-
1850
- ### Response
1851
-
1852
- **Promise<[operations.UpdateCrmDealResponse](../../sdk/models/operations/updatecrmdealresponse.md)>**
1853
- ### Errors
1854
-
1855
- | Error Object | Status Code | Content Type |
1856
- | --------------- | --------------- | --------------- |
1857
- | errors.SDKError | 4xx-5xx | */* |
1858
-
1859
- ## updateCrmEvent
1860
-
1861
- Update a event
1862
-
1863
- ### Example Usage
1864
-
1865
- ```typescript
1866
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1867
- import { CrmEventType, PropertyCrmEventTaskStatus } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1868
-
1869
- async function run() {
1870
- const sdk = new UnifiedTo({
1871
- security: {
1872
- jwt: "<YOUR_API_KEY_HERE>",
1873
- },
1874
- });
1875
-
1876
- const res = await sdk.crm.updateCrmEvent({
1877
- crmEvent: {
1878
- call: {},
1879
- companyIds: [
1880
- "<value>",
1881
- ],
1882
- contactIds: [
1883
- "<value>",
1884
- ],
1885
- dealIds: [
1886
- "<value>",
1887
- ],
1888
- email: {
1889
- attachmentFileIds: [
1890
- "<value>",
1891
- ],
1892
- cc: [
1893
- "<value>",
1894
- ],
1895
- to: [
1896
- "<value>",
1897
- ],
1898
- },
1899
- leadIds: [
1900
- "<value>",
1901
- ],
1902
- meeting: {},
1903
- note: {},
1904
- raw: {
1905
- "key": "<value>",
1906
- },
1907
- task: {},
1908
- },
1909
- connectionId: "<value>",
1910
- id: "<id>",
1911
- });
1912
-
1913
- if (res.statusCode == 200) {
1914
- // handle response
1915
- }
1916
- }
1917
-
1918
- run();
1919
- ```
1920
-
1921
- ### Parameters
1922
-
1923
- | Parameter | Type | Required | Description |
1924
- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
1925
- | `request` | [operations.UpdateCrmEventRequest](../../sdk/models/operations/updatecrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1926
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1927
-
1928
-
1929
- ### Response
1930
-
1931
- **Promise<[operations.UpdateCrmEventResponse](../../sdk/models/operations/updatecrmeventresponse.md)>**
1932
- ### Errors
1933
-
1934
- | Error Object | Status Code | Content Type |
1935
- | --------------- | --------------- | --------------- |
1936
- | errors.SDKError | 4xx-5xx | */* |
1937
-
1938
- ## updateCrmLead
1939
-
1940
- Update a lead
1941
-
1942
- ### Example Usage
1943
-
1944
- ```typescript
1945
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1946
- import { CrmEmailType, CrmTelephoneType } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
1947
-
1948
- async function run() {
1949
- const sdk = new UnifiedTo({
1950
- security: {
1951
- jwt: "<YOUR_API_KEY_HERE>",
1952
- },
1953
- });
1954
-
1955
- const res = await sdk.crm.updateCrmLead({
1956
- crmLead: {
1957
- address: {},
1958
- emails: [
1959
- {},
1960
- ],
1961
- raw: {
1962
- "key": "<value>",
1963
- },
1964
- telephones: [
1965
- {
1966
- telephone: "<value>",
1967
- },
1968
- ],
1969
- },
1970
- connectionId: "<value>",
1971
- id: "<id>",
1972
- });
1973
-
1974
- if (res.statusCode == 200) {
1975
- // handle response
1976
- }
1977
- }
1978
-
1979
- run();
1980
- ```
1981
-
1982
- ### Parameters
1983
-
1984
- | Parameter | Type | Required | Description |
1985
- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
1986
- | `request` | [operations.UpdateCrmLeadRequest](../../sdk/models/operations/updatecrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1987
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
1988
-
1989
-
1990
- ### Response
1991
-
1992
- **Promise<[operations.UpdateCrmLeadResponse](../../sdk/models/operations/updatecrmleadresponse.md)>**
1993
- ### Errors
1994
-
1995
- | Error Object | Status Code | Content Type |
1996
- | --------------- | --------------- | --------------- |
1997
- | errors.SDKError | 4xx-5xx | */* |
1998
-
1999
- ## updateCrmPipeline
2000
-
2001
- Update a pipeline
2002
-
2003
- ### Example Usage
2004
-
2005
- ```typescript
2006
- import { UnifiedTo } from "@unified-api/typescript-sdk";
2007
-
2008
- async function run() {
2009
- const sdk = new UnifiedTo({
2010
- security: {
2011
- jwt: "<YOUR_API_KEY_HERE>",
2012
- },
2013
- });
2014
-
2015
- const res = await sdk.crm.updateCrmPipeline({
2016
- crmPipeline: {
2017
- raw: {
2018
- "key": "<value>",
2019
- },
2020
- },
2021
- connectionId: "<value>",
2022
- id: "<id>",
2023
- });
2024
-
2025
- if (res.statusCode == 200) {
2026
- // handle response
2027
- }
2028
- }
2029
-
2030
- run();
2031
- ```
2032
-
2033
- ### Parameters
2034
-
2035
- | Parameter | Type | Required | Description |
2036
- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
2037
- | `request` | [operations.UpdateCrmPipelineRequest](../../sdk/models/operations/updatecrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
2038
- | `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
2039
-
2040
-
2041
- ### Response
2042
-
2043
- **Promise<[operations.UpdateCrmPipelineResponse](../../sdk/models/operations/updatecrmpipelineresponse.md)>**
2044
- ### Errors
2045
-
2046
- | Error Object | Status Code | Content Type |
2047
- | --------------- | --------------- | --------------- |
2048
- | errors.SDKError | 4xx-5xx | */* |