@unified-api/typescript-sdk 2.9.3 → 2.9.5
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.
- package/FUNCTIONS.md +108 -0
- package/README.md +36 -15
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +501 -0
- package/docs/sdks/accounting/README.md +3629 -0
- package/docs/sdks/activity/README.md +501 -0
- package/docs/sdks/apicall/README.md +165 -0
- package/docs/sdks/application/README.md +501 -0
- package/docs/sdks/applicationstatus/README.md +88 -0
- package/docs/sdks/ats/README.md +3710 -0
- package/docs/sdks/auth/README.md +173 -0
- package/docs/sdks/branch/README.md +501 -0
- package/docs/sdks/call/README.md +88 -0
- package/docs/sdks/candidate/README.md +501 -0
- package/docs/sdks/channel/README.md +171 -0
- package/docs/sdks/class/README.md +501 -0
- package/docs/sdks/collection/README.md +501 -0
- package/docs/sdks/commerce/README.md +2477 -0
- package/docs/sdks/commit/README.md +501 -0
- package/docs/sdks/company/README.md +1240 -0
- package/docs/sdks/connection/README.md +485 -0
- package/docs/sdks/contact/README.md +1489 -0
- package/docs/sdks/course/README.md +501 -0
- package/docs/sdks/crm/README.md +2971 -0
- package/docs/sdks/customer/README.md +501 -0
- package/docs/sdks/deal/README.md +501 -0
- package/docs/sdks/document/README.md +501 -0
- package/docs/sdks/employee/README.md +501 -0
- package/docs/sdks/enrich/README.md +169 -0
- package/docs/sdks/event/README.md +501 -0
- package/docs/sdks/file/README.md +501 -0
- package/docs/sdks/genai/README.md +169 -0
- package/docs/sdks/group/README.md +995 -0
- package/docs/sdks/hris/README.md +2311 -0
- package/docs/sdks/instructor/README.md +501 -0
- package/docs/sdks/integration/README.md +248 -0
- package/docs/sdks/interview/README.md +501 -0
- package/docs/sdks/inventory/README.md +501 -0
- package/docs/sdks/invoice/README.md +501 -0
- package/docs/sdks/issue/README.md +84 -0
- package/docs/sdks/item/README.md +501 -0
- package/docs/sdks/job/README.md +501 -0
- package/docs/sdks/journal/README.md +501 -0
- package/docs/sdks/kms/README.md +995 -0
- package/docs/sdks/lead/README.md +501 -0
- package/docs/sdks/link/README.md +501 -0
- package/docs/sdks/list/README.md +501 -0
- package/docs/sdks/lms/README.md +1983 -0
- package/docs/sdks/location/README.md +995 -0
- package/docs/sdks/login/README.md +90 -0
- package/docs/sdks/martech/README.md +995 -0
- package/docs/sdks/member/README.md +501 -0
- package/docs/sdks/message/README.md +501 -0
- package/docs/sdks/messaging/README.md +665 -0
- package/docs/sdks/metadata/README.md +501 -0
- package/docs/sdks/model/README.md +88 -0
- package/docs/sdks/note/README.md +501 -0
- package/docs/sdks/order/README.md +501 -0
- package/docs/sdks/organization/README.md +665 -0
- package/docs/sdks/page/README.md +501 -0
- package/docs/sdks/passthrough/README.md +671 -0
- package/docs/sdks/payment/README.md +1323 -0
- package/docs/sdks/payout/README.md +171 -0
- package/docs/sdks/payslip/README.md +171 -0
- package/docs/sdks/person/README.md +88 -0
- package/docs/sdks/pipeline/README.md +501 -0
- package/docs/sdks/project/README.md +501 -0
- package/docs/sdks/prompt/README.md +88 -0
- package/docs/sdks/pullrequest/README.md +501 -0
- package/docs/sdks/refund/README.md +171 -0
- package/docs/sdks/repo/README.md +2477 -0
- package/docs/sdks/repository/README.md +501 -0
- package/docs/sdks/scim/README.md +995 -0
- package/docs/sdks/scorecard/README.md +501 -0
- package/docs/sdks/space/README.md +501 -0
- package/docs/sdks/storage/README.md +501 -0
- package/docs/sdks/student/README.md +501 -0
- package/docs/sdks/task/README.md +995 -0
- package/docs/sdks/taxrate/README.md +501 -0
- package/docs/sdks/ticket/README.md +501 -0
- package/docs/sdks/ticketing/README.md +1489 -0
- package/docs/sdks/timeoff/README.md +171 -0
- package/docs/sdks/transaction/README.md +501 -0
- package/docs/sdks/uc/README.md +582 -0
- package/docs/sdks/unified/README.md +1601 -0
- package/docs/sdks/unifiedto/README.md +7 -0
- package/docs/sdks/user/README.md +501 -0
- package/docs/sdks/webhook/README.md +647 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/package.json +3 -1
- package/sdk/models/shared/index.d.ts +1 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +1 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/kmspage.d.ts +5 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +7 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
- package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
- package/sdk/models/shared/kmspagemetadata.js +63 -0
- package/sdk/models/shared/kmspagemetadata.js.map +1 -0
- package/sdk/models/shared/kmsspace.d.ts +2 -0
- package/sdk/models/shared/kmsspace.d.ts.map +1 -1
- package/sdk/models/shared/kmsspace.js +4 -0
- package/sdk/models/shared/kmsspace.js.map +1 -1
- package/sdk/models/shared/security.d.ts +2 -2
- package/sdk/models/shared/security.d.ts.map +1 -1
- package/sdk/models/shared/security.js +2 -2
- package/sdk/models/shared/security.js.map +1 -1
- package/sdk/types/operations.d.ts +5 -3
- package/sdk/types/operations.d.ts.map +1 -1
- package/sdk/types/operations.js +3 -0
- package/sdk/types/operations.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/models/shared/kmspage.ts +16 -0
- package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
- package/src/sdk/models/shared/kmsspace.ts +6 -0
- package/src/sdk/models/shared/security.ts +4 -4
- package/src/sdk/types/operations.ts +11 -5
|
@@ -0,0 +1,2971 @@
|
|
|
1
|
+
# Crm
|
|
2
|
+
(*crm*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createCrmCompany](#createcrmcompany) - Create a company
|
|
9
|
+
* [createCrmContact](#createcrmcontact) - Create a contact
|
|
10
|
+
* [createCrmDeal](#createcrmdeal) - Create a deal
|
|
11
|
+
* [createCrmEvent](#createcrmevent) - Create an event
|
|
12
|
+
* [createCrmLead](#createcrmlead) - Create a lead
|
|
13
|
+
* [createCrmPipeline](#createcrmpipeline) - Create a pipeline
|
|
14
|
+
* [getCrmCompany](#getcrmcompany) - Retrieve a company
|
|
15
|
+
* [getCrmContact](#getcrmcontact) - Retrieve a contact
|
|
16
|
+
* [getCrmDeal](#getcrmdeal) - Retrieve a deal
|
|
17
|
+
* [getCrmEvent](#getcrmevent) - Retrieve an event
|
|
18
|
+
* [getCrmLead](#getcrmlead) - Retrieve a lead
|
|
19
|
+
* [getCrmPipeline](#getcrmpipeline) - Retrieve a pipeline
|
|
20
|
+
* [listCrmCompanies](#listcrmcompanies) - List all companies
|
|
21
|
+
* [listCrmContacts](#listcrmcontacts) - List all contacts
|
|
22
|
+
* [listCrmDeals](#listcrmdeals) - List all deals
|
|
23
|
+
* [listCrmEvents](#listcrmevents) - List all events
|
|
24
|
+
* [listCrmLeads](#listcrmleads) - List all leads
|
|
25
|
+
* [listCrmPipelines](#listcrmpipelines) - List all pipelines
|
|
26
|
+
* [patchCrmCompany](#patchcrmcompany) - Update a company
|
|
27
|
+
* [patchCrmContact](#patchcrmcontact) - Update a contact
|
|
28
|
+
* [patchCrmDeal](#patchcrmdeal) - Update a deal
|
|
29
|
+
* [patchCrmEvent](#patchcrmevent) - Update an event
|
|
30
|
+
* [patchCrmLead](#patchcrmlead) - Update a lead
|
|
31
|
+
* [patchCrmPipeline](#patchcrmpipeline) - Update a pipeline
|
|
32
|
+
* [removeCrmCompany](#removecrmcompany) - Remove a company
|
|
33
|
+
* [removeCrmContact](#removecrmcontact) - Remove a contact
|
|
34
|
+
* [removeCrmDeal](#removecrmdeal) - Remove a deal
|
|
35
|
+
* [removeCrmEvent](#removecrmevent) - Remove an event
|
|
36
|
+
* [removeCrmLead](#removecrmlead) - Remove a lead
|
|
37
|
+
* [removeCrmPipeline](#removecrmpipeline) - Remove a pipeline
|
|
38
|
+
* [updateCrmCompany](#updatecrmcompany) - Update a company
|
|
39
|
+
* [updateCrmContact](#updatecrmcontact) - Update a contact
|
|
40
|
+
* [updateCrmDeal](#updatecrmdeal) - Update a deal
|
|
41
|
+
* [updateCrmEvent](#updatecrmevent) - Update an event
|
|
42
|
+
* [updateCrmLead](#updatecrmlead) - Update a lead
|
|
43
|
+
* [updateCrmPipeline](#updatecrmpipeline) - Update a pipeline
|
|
44
|
+
|
|
45
|
+
## createCrmCompany
|
|
46
|
+
|
|
47
|
+
Create a company
|
|
48
|
+
|
|
49
|
+
### Example Usage
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
53
|
+
|
|
54
|
+
const unifiedTo = new UnifiedTo({
|
|
55
|
+
security: {
|
|
56
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
async function run() {
|
|
61
|
+
const result = await unifiedTo.crm.createCrmCompany({
|
|
62
|
+
connectionId: "<value>",
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
// Handle the result
|
|
66
|
+
console.log(result);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
run();
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Standalone function
|
|
73
|
+
|
|
74
|
+
The standalone function version of this method:
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
78
|
+
import { crmCreateCrmCompany } from "@unified-api/typescript-sdk/funcs/crmCreateCrmCompany.js";
|
|
79
|
+
|
|
80
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
81
|
+
// You can create one instance of it to use across an application.
|
|
82
|
+
const unifiedTo = new UnifiedToCore({
|
|
83
|
+
security: {
|
|
84
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
85
|
+
},
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
async function run() {
|
|
89
|
+
const res = await crmCreateCrmCompany(unifiedTo, {
|
|
90
|
+
connectionId: "<value>",
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
if (!res.ok) {
|
|
94
|
+
throw res.error;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
const { value: result } = res;
|
|
98
|
+
|
|
99
|
+
// Handle the result
|
|
100
|
+
console.log(result);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
run();
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Parameters
|
|
107
|
+
|
|
108
|
+
| Parameter | Type | Required | Description |
|
|
109
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
110
|
+
| `request` | [operations.CreateCrmCompanyRequest](../../sdk/models/operations/createcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
111
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
112
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
113
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
114
|
+
|
|
115
|
+
### Response
|
|
116
|
+
|
|
117
|
+
**Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
|
|
118
|
+
|
|
119
|
+
### Errors
|
|
120
|
+
|
|
121
|
+
| Error Type | Status Code | Content Type |
|
|
122
|
+
| --------------- | --------------- | --------------- |
|
|
123
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
124
|
+
|
|
125
|
+
## createCrmContact
|
|
126
|
+
|
|
127
|
+
Create a contact
|
|
128
|
+
|
|
129
|
+
### Example Usage
|
|
130
|
+
|
|
131
|
+
```typescript
|
|
132
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
133
|
+
|
|
134
|
+
const unifiedTo = new UnifiedTo({
|
|
135
|
+
security: {
|
|
136
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
137
|
+
},
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
async function run() {
|
|
141
|
+
const result = await unifiedTo.crm.createCrmContact({
|
|
142
|
+
connectionId: "<value>",
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
// Handle the result
|
|
146
|
+
console.log(result);
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
run();
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Standalone function
|
|
153
|
+
|
|
154
|
+
The standalone function version of this method:
|
|
155
|
+
|
|
156
|
+
```typescript
|
|
157
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
158
|
+
import { crmCreateCrmContact } from "@unified-api/typescript-sdk/funcs/crmCreateCrmContact.js";
|
|
159
|
+
|
|
160
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
161
|
+
// You can create one instance of it to use across an application.
|
|
162
|
+
const unifiedTo = new UnifiedToCore({
|
|
163
|
+
security: {
|
|
164
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
165
|
+
},
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
async function run() {
|
|
169
|
+
const res = await crmCreateCrmContact(unifiedTo, {
|
|
170
|
+
connectionId: "<value>",
|
|
171
|
+
});
|
|
172
|
+
|
|
173
|
+
if (!res.ok) {
|
|
174
|
+
throw res.error;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
const { value: result } = res;
|
|
178
|
+
|
|
179
|
+
// Handle the result
|
|
180
|
+
console.log(result);
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
run();
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
|
|
188
|
+
| Parameter | Type | Required | Description |
|
|
189
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
190
|
+
| `request` | [operations.CreateCrmContactRequest](../../sdk/models/operations/createcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
191
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
192
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
193
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
194
|
+
|
|
195
|
+
### Response
|
|
196
|
+
|
|
197
|
+
**Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
|
|
198
|
+
|
|
199
|
+
### Errors
|
|
200
|
+
|
|
201
|
+
| Error Type | Status Code | Content Type |
|
|
202
|
+
| --------------- | --------------- | --------------- |
|
|
203
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
204
|
+
|
|
205
|
+
## createCrmDeal
|
|
206
|
+
|
|
207
|
+
Create a deal
|
|
208
|
+
|
|
209
|
+
### Example Usage
|
|
210
|
+
|
|
211
|
+
```typescript
|
|
212
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
213
|
+
|
|
214
|
+
const unifiedTo = new UnifiedTo({
|
|
215
|
+
security: {
|
|
216
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
217
|
+
},
|
|
218
|
+
});
|
|
219
|
+
|
|
220
|
+
async function run() {
|
|
221
|
+
const result = await unifiedTo.crm.createCrmDeal({
|
|
222
|
+
connectionId: "<value>",
|
|
223
|
+
});
|
|
224
|
+
|
|
225
|
+
// Handle the result
|
|
226
|
+
console.log(result);
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
run();
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Standalone function
|
|
233
|
+
|
|
234
|
+
The standalone function version of this method:
|
|
235
|
+
|
|
236
|
+
```typescript
|
|
237
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
238
|
+
import { crmCreateCrmDeal } from "@unified-api/typescript-sdk/funcs/crmCreateCrmDeal.js";
|
|
239
|
+
|
|
240
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
241
|
+
// You can create one instance of it to use across an application.
|
|
242
|
+
const unifiedTo = new UnifiedToCore({
|
|
243
|
+
security: {
|
|
244
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
245
|
+
},
|
|
246
|
+
});
|
|
247
|
+
|
|
248
|
+
async function run() {
|
|
249
|
+
const res = await crmCreateCrmDeal(unifiedTo, {
|
|
250
|
+
connectionId: "<value>",
|
|
251
|
+
});
|
|
252
|
+
|
|
253
|
+
if (!res.ok) {
|
|
254
|
+
throw res.error;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
const { value: result } = res;
|
|
258
|
+
|
|
259
|
+
// Handle the result
|
|
260
|
+
console.log(result);
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
run();
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### Parameters
|
|
267
|
+
|
|
268
|
+
| Parameter | Type | Required | Description |
|
|
269
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
270
|
+
| `request` | [operations.CreateCrmDealRequest](../../sdk/models/operations/createcrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
271
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
272
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
273
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
274
|
+
|
|
275
|
+
### Response
|
|
276
|
+
|
|
277
|
+
**Promise\<[shared.CrmDeal](../../sdk/models/shared/crmdeal.md)\>**
|
|
278
|
+
|
|
279
|
+
### Errors
|
|
280
|
+
|
|
281
|
+
| Error Type | Status Code | Content Type |
|
|
282
|
+
| --------------- | --------------- | --------------- |
|
|
283
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
284
|
+
|
|
285
|
+
## createCrmEvent
|
|
286
|
+
|
|
287
|
+
Create an event
|
|
288
|
+
|
|
289
|
+
### Example Usage
|
|
290
|
+
|
|
291
|
+
```typescript
|
|
292
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
293
|
+
|
|
294
|
+
const unifiedTo = new UnifiedTo({
|
|
295
|
+
security: {
|
|
296
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
297
|
+
},
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
async function run() {
|
|
301
|
+
const result = await unifiedTo.crm.createCrmEvent({
|
|
302
|
+
connectionId: "<value>",
|
|
303
|
+
});
|
|
304
|
+
|
|
305
|
+
// Handle the result
|
|
306
|
+
console.log(result);
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
run();
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### Standalone function
|
|
313
|
+
|
|
314
|
+
The standalone function version of this method:
|
|
315
|
+
|
|
316
|
+
```typescript
|
|
317
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
318
|
+
import { crmCreateCrmEvent } from "@unified-api/typescript-sdk/funcs/crmCreateCrmEvent.js";
|
|
319
|
+
|
|
320
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
321
|
+
// You can create one instance of it to use across an application.
|
|
322
|
+
const unifiedTo = new UnifiedToCore({
|
|
323
|
+
security: {
|
|
324
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
325
|
+
},
|
|
326
|
+
});
|
|
327
|
+
|
|
328
|
+
async function run() {
|
|
329
|
+
const res = await crmCreateCrmEvent(unifiedTo, {
|
|
330
|
+
connectionId: "<value>",
|
|
331
|
+
});
|
|
332
|
+
|
|
333
|
+
if (!res.ok) {
|
|
334
|
+
throw res.error;
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
const { value: result } = res;
|
|
338
|
+
|
|
339
|
+
// Handle the result
|
|
340
|
+
console.log(result);
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
run();
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### Parameters
|
|
347
|
+
|
|
348
|
+
| Parameter | Type | Required | Description |
|
|
349
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
350
|
+
| `request` | [operations.CreateCrmEventRequest](../../sdk/models/operations/createcrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
351
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
352
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
353
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
354
|
+
|
|
355
|
+
### Response
|
|
356
|
+
|
|
357
|
+
**Promise\<[shared.CrmEvent](../../sdk/models/shared/crmevent.md)\>**
|
|
358
|
+
|
|
359
|
+
### Errors
|
|
360
|
+
|
|
361
|
+
| Error Type | Status Code | Content Type |
|
|
362
|
+
| --------------- | --------------- | --------------- |
|
|
363
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
364
|
+
|
|
365
|
+
## createCrmLead
|
|
366
|
+
|
|
367
|
+
Create a lead
|
|
368
|
+
|
|
369
|
+
### Example Usage
|
|
370
|
+
|
|
371
|
+
```typescript
|
|
372
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
373
|
+
|
|
374
|
+
const unifiedTo = new UnifiedTo({
|
|
375
|
+
security: {
|
|
376
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
377
|
+
},
|
|
378
|
+
});
|
|
379
|
+
|
|
380
|
+
async function run() {
|
|
381
|
+
const result = await unifiedTo.crm.createCrmLead({
|
|
382
|
+
connectionId: "<value>",
|
|
383
|
+
});
|
|
384
|
+
|
|
385
|
+
// Handle the result
|
|
386
|
+
console.log(result);
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
run();
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Standalone function
|
|
393
|
+
|
|
394
|
+
The standalone function version of this method:
|
|
395
|
+
|
|
396
|
+
```typescript
|
|
397
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
398
|
+
import { crmCreateCrmLead } from "@unified-api/typescript-sdk/funcs/crmCreateCrmLead.js";
|
|
399
|
+
|
|
400
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
401
|
+
// You can create one instance of it to use across an application.
|
|
402
|
+
const unifiedTo = new UnifiedToCore({
|
|
403
|
+
security: {
|
|
404
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
405
|
+
},
|
|
406
|
+
});
|
|
407
|
+
|
|
408
|
+
async function run() {
|
|
409
|
+
const res = await crmCreateCrmLead(unifiedTo, {
|
|
410
|
+
connectionId: "<value>",
|
|
411
|
+
});
|
|
412
|
+
|
|
413
|
+
if (!res.ok) {
|
|
414
|
+
throw res.error;
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
const { value: result } = res;
|
|
418
|
+
|
|
419
|
+
// Handle the result
|
|
420
|
+
console.log(result);
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
run();
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
| Parameter | Type | Required | Description |
|
|
429
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
430
|
+
| `request` | [operations.CreateCrmLeadRequest](../../sdk/models/operations/createcrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
431
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
432
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
433
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
434
|
+
|
|
435
|
+
### Response
|
|
436
|
+
|
|
437
|
+
**Promise\<[shared.CrmLead](../../sdk/models/shared/crmlead.md)\>**
|
|
438
|
+
|
|
439
|
+
### Errors
|
|
440
|
+
|
|
441
|
+
| Error Type | Status Code | Content Type |
|
|
442
|
+
| --------------- | --------------- | --------------- |
|
|
443
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
444
|
+
|
|
445
|
+
## createCrmPipeline
|
|
446
|
+
|
|
447
|
+
Create a pipeline
|
|
448
|
+
|
|
449
|
+
### Example Usage
|
|
450
|
+
|
|
451
|
+
```typescript
|
|
452
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
453
|
+
|
|
454
|
+
const unifiedTo = new UnifiedTo({
|
|
455
|
+
security: {
|
|
456
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
457
|
+
},
|
|
458
|
+
});
|
|
459
|
+
|
|
460
|
+
async function run() {
|
|
461
|
+
const result = await unifiedTo.crm.createCrmPipeline({
|
|
462
|
+
connectionId: "<value>",
|
|
463
|
+
});
|
|
464
|
+
|
|
465
|
+
// Handle the result
|
|
466
|
+
console.log(result);
|
|
467
|
+
}
|
|
468
|
+
|
|
469
|
+
run();
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
### Standalone function
|
|
473
|
+
|
|
474
|
+
The standalone function version of this method:
|
|
475
|
+
|
|
476
|
+
```typescript
|
|
477
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
478
|
+
import { crmCreateCrmPipeline } from "@unified-api/typescript-sdk/funcs/crmCreateCrmPipeline.js";
|
|
479
|
+
|
|
480
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
481
|
+
// You can create one instance of it to use across an application.
|
|
482
|
+
const unifiedTo = new UnifiedToCore({
|
|
483
|
+
security: {
|
|
484
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
485
|
+
},
|
|
486
|
+
});
|
|
487
|
+
|
|
488
|
+
async function run() {
|
|
489
|
+
const res = await crmCreateCrmPipeline(unifiedTo, {
|
|
490
|
+
connectionId: "<value>",
|
|
491
|
+
});
|
|
492
|
+
|
|
493
|
+
if (!res.ok) {
|
|
494
|
+
throw res.error;
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
const { value: result } = res;
|
|
498
|
+
|
|
499
|
+
// Handle the result
|
|
500
|
+
console.log(result);
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
run();
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
### Parameters
|
|
507
|
+
|
|
508
|
+
| Parameter | Type | Required | Description |
|
|
509
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
510
|
+
| `request` | [operations.CreateCrmPipelineRequest](../../sdk/models/operations/createcrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
511
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
512
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
513
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
514
|
+
|
|
515
|
+
### Response
|
|
516
|
+
|
|
517
|
+
**Promise\<[shared.CrmPipeline](../../sdk/models/shared/crmpipeline.md)\>**
|
|
518
|
+
|
|
519
|
+
### Errors
|
|
520
|
+
|
|
521
|
+
| Error Type | Status Code | Content Type |
|
|
522
|
+
| --------------- | --------------- | --------------- |
|
|
523
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
524
|
+
|
|
525
|
+
## getCrmCompany
|
|
526
|
+
|
|
527
|
+
Retrieve a company
|
|
528
|
+
|
|
529
|
+
### Example Usage
|
|
530
|
+
|
|
531
|
+
```typescript
|
|
532
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
533
|
+
|
|
534
|
+
const unifiedTo = new UnifiedTo({
|
|
535
|
+
security: {
|
|
536
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
537
|
+
},
|
|
538
|
+
});
|
|
539
|
+
|
|
540
|
+
async function run() {
|
|
541
|
+
const result = await unifiedTo.crm.getCrmCompany({
|
|
542
|
+
connectionId: "<value>",
|
|
543
|
+
id: "<id>",
|
|
544
|
+
});
|
|
545
|
+
|
|
546
|
+
// Handle the result
|
|
547
|
+
console.log(result);
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
run();
|
|
551
|
+
```
|
|
552
|
+
|
|
553
|
+
### Standalone function
|
|
554
|
+
|
|
555
|
+
The standalone function version of this method:
|
|
556
|
+
|
|
557
|
+
```typescript
|
|
558
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
559
|
+
import { crmGetCrmCompany } from "@unified-api/typescript-sdk/funcs/crmGetCrmCompany.js";
|
|
560
|
+
|
|
561
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
562
|
+
// You can create one instance of it to use across an application.
|
|
563
|
+
const unifiedTo = new UnifiedToCore({
|
|
564
|
+
security: {
|
|
565
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
566
|
+
},
|
|
567
|
+
});
|
|
568
|
+
|
|
569
|
+
async function run() {
|
|
570
|
+
const res = await crmGetCrmCompany(unifiedTo, {
|
|
571
|
+
connectionId: "<value>",
|
|
572
|
+
id: "<id>",
|
|
573
|
+
});
|
|
574
|
+
|
|
575
|
+
if (!res.ok) {
|
|
576
|
+
throw res.error;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
const { value: result } = res;
|
|
580
|
+
|
|
581
|
+
// Handle the result
|
|
582
|
+
console.log(result);
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
run();
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
### Parameters
|
|
589
|
+
|
|
590
|
+
| Parameter | Type | Required | Description |
|
|
591
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
592
|
+
| `request` | [operations.GetCrmCompanyRequest](../../sdk/models/operations/getcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
593
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
594
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
595
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
596
|
+
|
|
597
|
+
### Response
|
|
598
|
+
|
|
599
|
+
**Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
|
|
600
|
+
|
|
601
|
+
### Errors
|
|
602
|
+
|
|
603
|
+
| Error Type | Status Code | Content Type |
|
|
604
|
+
| --------------- | --------------- | --------------- |
|
|
605
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
606
|
+
|
|
607
|
+
## getCrmContact
|
|
608
|
+
|
|
609
|
+
Retrieve a contact
|
|
610
|
+
|
|
611
|
+
### Example Usage
|
|
612
|
+
|
|
613
|
+
```typescript
|
|
614
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
615
|
+
|
|
616
|
+
const unifiedTo = new UnifiedTo({
|
|
617
|
+
security: {
|
|
618
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
619
|
+
},
|
|
620
|
+
});
|
|
621
|
+
|
|
622
|
+
async function run() {
|
|
623
|
+
const result = await unifiedTo.crm.getCrmContact({
|
|
624
|
+
connectionId: "<value>",
|
|
625
|
+
id: "<id>",
|
|
626
|
+
});
|
|
627
|
+
|
|
628
|
+
// Handle the result
|
|
629
|
+
console.log(result);
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
run();
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
### Standalone function
|
|
636
|
+
|
|
637
|
+
The standalone function version of this method:
|
|
638
|
+
|
|
639
|
+
```typescript
|
|
640
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
641
|
+
import { crmGetCrmContact } from "@unified-api/typescript-sdk/funcs/crmGetCrmContact.js";
|
|
642
|
+
|
|
643
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
644
|
+
// You can create one instance of it to use across an application.
|
|
645
|
+
const unifiedTo = new UnifiedToCore({
|
|
646
|
+
security: {
|
|
647
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
648
|
+
},
|
|
649
|
+
});
|
|
650
|
+
|
|
651
|
+
async function run() {
|
|
652
|
+
const res = await crmGetCrmContact(unifiedTo, {
|
|
653
|
+
connectionId: "<value>",
|
|
654
|
+
id: "<id>",
|
|
655
|
+
});
|
|
656
|
+
|
|
657
|
+
if (!res.ok) {
|
|
658
|
+
throw res.error;
|
|
659
|
+
}
|
|
660
|
+
|
|
661
|
+
const { value: result } = res;
|
|
662
|
+
|
|
663
|
+
// Handle the result
|
|
664
|
+
console.log(result);
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
run();
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
### Parameters
|
|
671
|
+
|
|
672
|
+
| Parameter | Type | Required | Description |
|
|
673
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
674
|
+
| `request` | [operations.GetCrmContactRequest](../../sdk/models/operations/getcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
675
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
676
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
677
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
678
|
+
|
|
679
|
+
### Response
|
|
680
|
+
|
|
681
|
+
**Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
|
|
682
|
+
|
|
683
|
+
### Errors
|
|
684
|
+
|
|
685
|
+
| Error Type | Status Code | Content Type |
|
|
686
|
+
| --------------- | --------------- | --------------- |
|
|
687
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
688
|
+
|
|
689
|
+
## getCrmDeal
|
|
690
|
+
|
|
691
|
+
Retrieve a deal
|
|
692
|
+
|
|
693
|
+
### Example Usage
|
|
694
|
+
|
|
695
|
+
```typescript
|
|
696
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
697
|
+
|
|
698
|
+
const unifiedTo = new UnifiedTo({
|
|
699
|
+
security: {
|
|
700
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
701
|
+
},
|
|
702
|
+
});
|
|
703
|
+
|
|
704
|
+
async function run() {
|
|
705
|
+
const result = await unifiedTo.crm.getCrmDeal({
|
|
706
|
+
connectionId: "<value>",
|
|
707
|
+
id: "<id>",
|
|
708
|
+
});
|
|
709
|
+
|
|
710
|
+
// Handle the result
|
|
711
|
+
console.log(result);
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
run();
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
### Standalone function
|
|
718
|
+
|
|
719
|
+
The standalone function version of this method:
|
|
720
|
+
|
|
721
|
+
```typescript
|
|
722
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
723
|
+
import { crmGetCrmDeal } from "@unified-api/typescript-sdk/funcs/crmGetCrmDeal.js";
|
|
724
|
+
|
|
725
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
726
|
+
// You can create one instance of it to use across an application.
|
|
727
|
+
const unifiedTo = new UnifiedToCore({
|
|
728
|
+
security: {
|
|
729
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
730
|
+
},
|
|
731
|
+
});
|
|
732
|
+
|
|
733
|
+
async function run() {
|
|
734
|
+
const res = await crmGetCrmDeal(unifiedTo, {
|
|
735
|
+
connectionId: "<value>",
|
|
736
|
+
id: "<id>",
|
|
737
|
+
});
|
|
738
|
+
|
|
739
|
+
if (!res.ok) {
|
|
740
|
+
throw res.error;
|
|
741
|
+
}
|
|
742
|
+
|
|
743
|
+
const { value: result } = res;
|
|
744
|
+
|
|
745
|
+
// Handle the result
|
|
746
|
+
console.log(result);
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
run();
|
|
750
|
+
```
|
|
751
|
+
|
|
752
|
+
### Parameters
|
|
753
|
+
|
|
754
|
+
| Parameter | Type | Required | Description |
|
|
755
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
756
|
+
| `request` | [operations.GetCrmDealRequest](../../sdk/models/operations/getcrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
757
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
758
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
759
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
760
|
+
|
|
761
|
+
### Response
|
|
762
|
+
|
|
763
|
+
**Promise\<[shared.CrmDeal](../../sdk/models/shared/crmdeal.md)\>**
|
|
764
|
+
|
|
765
|
+
### Errors
|
|
766
|
+
|
|
767
|
+
| Error Type | Status Code | Content Type |
|
|
768
|
+
| --------------- | --------------- | --------------- |
|
|
769
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
770
|
+
|
|
771
|
+
## getCrmEvent
|
|
772
|
+
|
|
773
|
+
Retrieve an event
|
|
774
|
+
|
|
775
|
+
### Example Usage
|
|
776
|
+
|
|
777
|
+
```typescript
|
|
778
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
779
|
+
|
|
780
|
+
const unifiedTo = new UnifiedTo({
|
|
781
|
+
security: {
|
|
782
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
783
|
+
},
|
|
784
|
+
});
|
|
785
|
+
|
|
786
|
+
async function run() {
|
|
787
|
+
const result = await unifiedTo.crm.getCrmEvent({
|
|
788
|
+
connectionId: "<value>",
|
|
789
|
+
id: "<id>",
|
|
790
|
+
});
|
|
791
|
+
|
|
792
|
+
// Handle the result
|
|
793
|
+
console.log(result);
|
|
794
|
+
}
|
|
795
|
+
|
|
796
|
+
run();
|
|
797
|
+
```
|
|
798
|
+
|
|
799
|
+
### Standalone function
|
|
800
|
+
|
|
801
|
+
The standalone function version of this method:
|
|
802
|
+
|
|
803
|
+
```typescript
|
|
804
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
805
|
+
import { crmGetCrmEvent } from "@unified-api/typescript-sdk/funcs/crmGetCrmEvent.js";
|
|
806
|
+
|
|
807
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
808
|
+
// You can create one instance of it to use across an application.
|
|
809
|
+
const unifiedTo = new UnifiedToCore({
|
|
810
|
+
security: {
|
|
811
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
812
|
+
},
|
|
813
|
+
});
|
|
814
|
+
|
|
815
|
+
async function run() {
|
|
816
|
+
const res = await crmGetCrmEvent(unifiedTo, {
|
|
817
|
+
connectionId: "<value>",
|
|
818
|
+
id: "<id>",
|
|
819
|
+
});
|
|
820
|
+
|
|
821
|
+
if (!res.ok) {
|
|
822
|
+
throw res.error;
|
|
823
|
+
}
|
|
824
|
+
|
|
825
|
+
const { value: result } = res;
|
|
826
|
+
|
|
827
|
+
// Handle the result
|
|
828
|
+
console.log(result);
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
run();
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
### Parameters
|
|
835
|
+
|
|
836
|
+
| Parameter | Type | Required | Description |
|
|
837
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
838
|
+
| `request` | [operations.GetCrmEventRequest](../../sdk/models/operations/getcrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
839
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
840
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
841
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
842
|
+
|
|
843
|
+
### Response
|
|
844
|
+
|
|
845
|
+
**Promise\<[shared.CrmEvent](../../sdk/models/shared/crmevent.md)\>**
|
|
846
|
+
|
|
847
|
+
### Errors
|
|
848
|
+
|
|
849
|
+
| Error Type | Status Code | Content Type |
|
|
850
|
+
| --------------- | --------------- | --------------- |
|
|
851
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
852
|
+
|
|
853
|
+
## getCrmLead
|
|
854
|
+
|
|
855
|
+
Retrieve a lead
|
|
856
|
+
|
|
857
|
+
### Example Usage
|
|
858
|
+
|
|
859
|
+
```typescript
|
|
860
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
861
|
+
|
|
862
|
+
const unifiedTo = new UnifiedTo({
|
|
863
|
+
security: {
|
|
864
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
865
|
+
},
|
|
866
|
+
});
|
|
867
|
+
|
|
868
|
+
async function run() {
|
|
869
|
+
const result = await unifiedTo.crm.getCrmLead({
|
|
870
|
+
connectionId: "<value>",
|
|
871
|
+
id: "<id>",
|
|
872
|
+
});
|
|
873
|
+
|
|
874
|
+
// Handle the result
|
|
875
|
+
console.log(result);
|
|
876
|
+
}
|
|
877
|
+
|
|
878
|
+
run();
|
|
879
|
+
```
|
|
880
|
+
|
|
881
|
+
### Standalone function
|
|
882
|
+
|
|
883
|
+
The standalone function version of this method:
|
|
884
|
+
|
|
885
|
+
```typescript
|
|
886
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
887
|
+
import { crmGetCrmLead } from "@unified-api/typescript-sdk/funcs/crmGetCrmLead.js";
|
|
888
|
+
|
|
889
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
890
|
+
// You can create one instance of it to use across an application.
|
|
891
|
+
const unifiedTo = new UnifiedToCore({
|
|
892
|
+
security: {
|
|
893
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
894
|
+
},
|
|
895
|
+
});
|
|
896
|
+
|
|
897
|
+
async function run() {
|
|
898
|
+
const res = await crmGetCrmLead(unifiedTo, {
|
|
899
|
+
connectionId: "<value>",
|
|
900
|
+
id: "<id>",
|
|
901
|
+
});
|
|
902
|
+
|
|
903
|
+
if (!res.ok) {
|
|
904
|
+
throw res.error;
|
|
905
|
+
}
|
|
906
|
+
|
|
907
|
+
const { value: result } = res;
|
|
908
|
+
|
|
909
|
+
// Handle the result
|
|
910
|
+
console.log(result);
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
run();
|
|
914
|
+
```
|
|
915
|
+
|
|
916
|
+
### Parameters
|
|
917
|
+
|
|
918
|
+
| Parameter | Type | Required | Description |
|
|
919
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
920
|
+
| `request` | [operations.GetCrmLeadRequest](../../sdk/models/operations/getcrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
921
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
922
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
923
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
924
|
+
|
|
925
|
+
### Response
|
|
926
|
+
|
|
927
|
+
**Promise\<[shared.CrmLead](../../sdk/models/shared/crmlead.md)\>**
|
|
928
|
+
|
|
929
|
+
### Errors
|
|
930
|
+
|
|
931
|
+
| Error Type | Status Code | Content Type |
|
|
932
|
+
| --------------- | --------------- | --------------- |
|
|
933
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
934
|
+
|
|
935
|
+
## getCrmPipeline
|
|
936
|
+
|
|
937
|
+
Retrieve a pipeline
|
|
938
|
+
|
|
939
|
+
### Example Usage
|
|
940
|
+
|
|
941
|
+
```typescript
|
|
942
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
943
|
+
|
|
944
|
+
const unifiedTo = new UnifiedTo({
|
|
945
|
+
security: {
|
|
946
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
947
|
+
},
|
|
948
|
+
});
|
|
949
|
+
|
|
950
|
+
async function run() {
|
|
951
|
+
const result = await unifiedTo.crm.getCrmPipeline({
|
|
952
|
+
connectionId: "<value>",
|
|
953
|
+
id: "<id>",
|
|
954
|
+
});
|
|
955
|
+
|
|
956
|
+
// Handle the result
|
|
957
|
+
console.log(result);
|
|
958
|
+
}
|
|
959
|
+
|
|
960
|
+
run();
|
|
961
|
+
```
|
|
962
|
+
|
|
963
|
+
### Standalone function
|
|
964
|
+
|
|
965
|
+
The standalone function version of this method:
|
|
966
|
+
|
|
967
|
+
```typescript
|
|
968
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
969
|
+
import { crmGetCrmPipeline } from "@unified-api/typescript-sdk/funcs/crmGetCrmPipeline.js";
|
|
970
|
+
|
|
971
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
972
|
+
// You can create one instance of it to use across an application.
|
|
973
|
+
const unifiedTo = new UnifiedToCore({
|
|
974
|
+
security: {
|
|
975
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
976
|
+
},
|
|
977
|
+
});
|
|
978
|
+
|
|
979
|
+
async function run() {
|
|
980
|
+
const res = await crmGetCrmPipeline(unifiedTo, {
|
|
981
|
+
connectionId: "<value>",
|
|
982
|
+
id: "<id>",
|
|
983
|
+
});
|
|
984
|
+
|
|
985
|
+
if (!res.ok) {
|
|
986
|
+
throw res.error;
|
|
987
|
+
}
|
|
988
|
+
|
|
989
|
+
const { value: result } = res;
|
|
990
|
+
|
|
991
|
+
// Handle the result
|
|
992
|
+
console.log(result);
|
|
993
|
+
}
|
|
994
|
+
|
|
995
|
+
run();
|
|
996
|
+
```
|
|
997
|
+
|
|
998
|
+
### Parameters
|
|
999
|
+
|
|
1000
|
+
| Parameter | Type | Required | Description |
|
|
1001
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1002
|
+
| `request` | [operations.GetCrmPipelineRequest](../../sdk/models/operations/getcrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1003
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1004
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1005
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1006
|
+
|
|
1007
|
+
### Response
|
|
1008
|
+
|
|
1009
|
+
**Promise\<[shared.CrmPipeline](../../sdk/models/shared/crmpipeline.md)\>**
|
|
1010
|
+
|
|
1011
|
+
### Errors
|
|
1012
|
+
|
|
1013
|
+
| Error Type | Status Code | Content Type |
|
|
1014
|
+
| --------------- | --------------- | --------------- |
|
|
1015
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1016
|
+
|
|
1017
|
+
## listCrmCompanies
|
|
1018
|
+
|
|
1019
|
+
List all companies
|
|
1020
|
+
|
|
1021
|
+
### Example Usage
|
|
1022
|
+
|
|
1023
|
+
```typescript
|
|
1024
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1025
|
+
|
|
1026
|
+
const unifiedTo = new UnifiedTo({
|
|
1027
|
+
security: {
|
|
1028
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1029
|
+
},
|
|
1030
|
+
});
|
|
1031
|
+
|
|
1032
|
+
async function run() {
|
|
1033
|
+
const result = await unifiedTo.crm.listCrmCompanies({
|
|
1034
|
+
connectionId: "<value>",
|
|
1035
|
+
});
|
|
1036
|
+
|
|
1037
|
+
// Handle the result
|
|
1038
|
+
console.log(result);
|
|
1039
|
+
}
|
|
1040
|
+
|
|
1041
|
+
run();
|
|
1042
|
+
```
|
|
1043
|
+
|
|
1044
|
+
### Standalone function
|
|
1045
|
+
|
|
1046
|
+
The standalone function version of this method:
|
|
1047
|
+
|
|
1048
|
+
```typescript
|
|
1049
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1050
|
+
import { crmListCrmCompanies } from "@unified-api/typescript-sdk/funcs/crmListCrmCompanies.js";
|
|
1051
|
+
|
|
1052
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1053
|
+
// You can create one instance of it to use across an application.
|
|
1054
|
+
const unifiedTo = new UnifiedToCore({
|
|
1055
|
+
security: {
|
|
1056
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1057
|
+
},
|
|
1058
|
+
});
|
|
1059
|
+
|
|
1060
|
+
async function run() {
|
|
1061
|
+
const res = await crmListCrmCompanies(unifiedTo, {
|
|
1062
|
+
connectionId: "<value>",
|
|
1063
|
+
});
|
|
1064
|
+
|
|
1065
|
+
if (!res.ok) {
|
|
1066
|
+
throw res.error;
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1069
|
+
const { value: result } = res;
|
|
1070
|
+
|
|
1071
|
+
// Handle the result
|
|
1072
|
+
console.log(result);
|
|
1073
|
+
}
|
|
1074
|
+
|
|
1075
|
+
run();
|
|
1076
|
+
```
|
|
1077
|
+
|
|
1078
|
+
### Parameters
|
|
1079
|
+
|
|
1080
|
+
| Parameter | Type | Required | Description |
|
|
1081
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1082
|
+
| `request` | [operations.ListCrmCompaniesRequest](../../sdk/models/operations/listcrmcompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1083
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1084
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1085
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1086
|
+
|
|
1087
|
+
### Response
|
|
1088
|
+
|
|
1089
|
+
**Promise\<[shared.CrmCompany[]](../../models/.md)\>**
|
|
1090
|
+
|
|
1091
|
+
### Errors
|
|
1092
|
+
|
|
1093
|
+
| Error Type | Status Code | Content Type |
|
|
1094
|
+
| --------------- | --------------- | --------------- |
|
|
1095
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1096
|
+
|
|
1097
|
+
## listCrmContacts
|
|
1098
|
+
|
|
1099
|
+
List all contacts
|
|
1100
|
+
|
|
1101
|
+
### Example Usage
|
|
1102
|
+
|
|
1103
|
+
```typescript
|
|
1104
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1105
|
+
|
|
1106
|
+
const unifiedTo = new UnifiedTo({
|
|
1107
|
+
security: {
|
|
1108
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1109
|
+
},
|
|
1110
|
+
});
|
|
1111
|
+
|
|
1112
|
+
async function run() {
|
|
1113
|
+
const result = await unifiedTo.crm.listCrmContacts({
|
|
1114
|
+
connectionId: "<value>",
|
|
1115
|
+
});
|
|
1116
|
+
|
|
1117
|
+
// Handle the result
|
|
1118
|
+
console.log(result);
|
|
1119
|
+
}
|
|
1120
|
+
|
|
1121
|
+
run();
|
|
1122
|
+
```
|
|
1123
|
+
|
|
1124
|
+
### Standalone function
|
|
1125
|
+
|
|
1126
|
+
The standalone function version of this method:
|
|
1127
|
+
|
|
1128
|
+
```typescript
|
|
1129
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1130
|
+
import { crmListCrmContacts } from "@unified-api/typescript-sdk/funcs/crmListCrmContacts.js";
|
|
1131
|
+
|
|
1132
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1133
|
+
// You can create one instance of it to use across an application.
|
|
1134
|
+
const unifiedTo = new UnifiedToCore({
|
|
1135
|
+
security: {
|
|
1136
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1137
|
+
},
|
|
1138
|
+
});
|
|
1139
|
+
|
|
1140
|
+
async function run() {
|
|
1141
|
+
const res = await crmListCrmContacts(unifiedTo, {
|
|
1142
|
+
connectionId: "<value>",
|
|
1143
|
+
});
|
|
1144
|
+
|
|
1145
|
+
if (!res.ok) {
|
|
1146
|
+
throw res.error;
|
|
1147
|
+
}
|
|
1148
|
+
|
|
1149
|
+
const { value: result } = res;
|
|
1150
|
+
|
|
1151
|
+
// Handle the result
|
|
1152
|
+
console.log(result);
|
|
1153
|
+
}
|
|
1154
|
+
|
|
1155
|
+
run();
|
|
1156
|
+
```
|
|
1157
|
+
|
|
1158
|
+
### Parameters
|
|
1159
|
+
|
|
1160
|
+
| Parameter | Type | Required | Description |
|
|
1161
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1162
|
+
| `request` | [operations.ListCrmContactsRequest](../../sdk/models/operations/listcrmcontactsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1163
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1164
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1165
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1166
|
+
|
|
1167
|
+
### Response
|
|
1168
|
+
|
|
1169
|
+
**Promise\<[shared.CrmContact[]](../../models/.md)\>**
|
|
1170
|
+
|
|
1171
|
+
### Errors
|
|
1172
|
+
|
|
1173
|
+
| Error Type | Status Code | Content Type |
|
|
1174
|
+
| --------------- | --------------- | --------------- |
|
|
1175
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1176
|
+
|
|
1177
|
+
## listCrmDeals
|
|
1178
|
+
|
|
1179
|
+
List all deals
|
|
1180
|
+
|
|
1181
|
+
### Example Usage
|
|
1182
|
+
|
|
1183
|
+
```typescript
|
|
1184
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1185
|
+
|
|
1186
|
+
const unifiedTo = new UnifiedTo({
|
|
1187
|
+
security: {
|
|
1188
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1189
|
+
},
|
|
1190
|
+
});
|
|
1191
|
+
|
|
1192
|
+
async function run() {
|
|
1193
|
+
const result = await unifiedTo.crm.listCrmDeals({
|
|
1194
|
+
connectionId: "<value>",
|
|
1195
|
+
});
|
|
1196
|
+
|
|
1197
|
+
// Handle the result
|
|
1198
|
+
console.log(result);
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1201
|
+
run();
|
|
1202
|
+
```
|
|
1203
|
+
|
|
1204
|
+
### Standalone function
|
|
1205
|
+
|
|
1206
|
+
The standalone function version of this method:
|
|
1207
|
+
|
|
1208
|
+
```typescript
|
|
1209
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1210
|
+
import { crmListCrmDeals } from "@unified-api/typescript-sdk/funcs/crmListCrmDeals.js";
|
|
1211
|
+
|
|
1212
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1213
|
+
// You can create one instance of it to use across an application.
|
|
1214
|
+
const unifiedTo = new UnifiedToCore({
|
|
1215
|
+
security: {
|
|
1216
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1217
|
+
},
|
|
1218
|
+
});
|
|
1219
|
+
|
|
1220
|
+
async function run() {
|
|
1221
|
+
const res = await crmListCrmDeals(unifiedTo, {
|
|
1222
|
+
connectionId: "<value>",
|
|
1223
|
+
});
|
|
1224
|
+
|
|
1225
|
+
if (!res.ok) {
|
|
1226
|
+
throw res.error;
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1229
|
+
const { value: result } = res;
|
|
1230
|
+
|
|
1231
|
+
// Handle the result
|
|
1232
|
+
console.log(result);
|
|
1233
|
+
}
|
|
1234
|
+
|
|
1235
|
+
run();
|
|
1236
|
+
```
|
|
1237
|
+
|
|
1238
|
+
### Parameters
|
|
1239
|
+
|
|
1240
|
+
| Parameter | Type | Required | Description |
|
|
1241
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1242
|
+
| `request` | [operations.ListCrmDealsRequest](../../sdk/models/operations/listcrmdealsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1243
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1244
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1245
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1246
|
+
|
|
1247
|
+
### Response
|
|
1248
|
+
|
|
1249
|
+
**Promise\<[shared.CrmDeal[]](../../models/.md)\>**
|
|
1250
|
+
|
|
1251
|
+
### Errors
|
|
1252
|
+
|
|
1253
|
+
| Error Type | Status Code | Content Type |
|
|
1254
|
+
| --------------- | --------------- | --------------- |
|
|
1255
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1256
|
+
|
|
1257
|
+
## listCrmEvents
|
|
1258
|
+
|
|
1259
|
+
List all events
|
|
1260
|
+
|
|
1261
|
+
### Example Usage
|
|
1262
|
+
|
|
1263
|
+
```typescript
|
|
1264
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1265
|
+
|
|
1266
|
+
const unifiedTo = new UnifiedTo({
|
|
1267
|
+
security: {
|
|
1268
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1269
|
+
},
|
|
1270
|
+
});
|
|
1271
|
+
|
|
1272
|
+
async function run() {
|
|
1273
|
+
const result = await unifiedTo.crm.listCrmEvents({
|
|
1274
|
+
connectionId: "<value>",
|
|
1275
|
+
});
|
|
1276
|
+
|
|
1277
|
+
// Handle the result
|
|
1278
|
+
console.log(result);
|
|
1279
|
+
}
|
|
1280
|
+
|
|
1281
|
+
run();
|
|
1282
|
+
```
|
|
1283
|
+
|
|
1284
|
+
### Standalone function
|
|
1285
|
+
|
|
1286
|
+
The standalone function version of this method:
|
|
1287
|
+
|
|
1288
|
+
```typescript
|
|
1289
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1290
|
+
import { crmListCrmEvents } from "@unified-api/typescript-sdk/funcs/crmListCrmEvents.js";
|
|
1291
|
+
|
|
1292
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1293
|
+
// You can create one instance of it to use across an application.
|
|
1294
|
+
const unifiedTo = new UnifiedToCore({
|
|
1295
|
+
security: {
|
|
1296
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1297
|
+
},
|
|
1298
|
+
});
|
|
1299
|
+
|
|
1300
|
+
async function run() {
|
|
1301
|
+
const res = await crmListCrmEvents(unifiedTo, {
|
|
1302
|
+
connectionId: "<value>",
|
|
1303
|
+
});
|
|
1304
|
+
|
|
1305
|
+
if (!res.ok) {
|
|
1306
|
+
throw res.error;
|
|
1307
|
+
}
|
|
1308
|
+
|
|
1309
|
+
const { value: result } = res;
|
|
1310
|
+
|
|
1311
|
+
// Handle the result
|
|
1312
|
+
console.log(result);
|
|
1313
|
+
}
|
|
1314
|
+
|
|
1315
|
+
run();
|
|
1316
|
+
```
|
|
1317
|
+
|
|
1318
|
+
### Parameters
|
|
1319
|
+
|
|
1320
|
+
| Parameter | Type | Required | Description |
|
|
1321
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1322
|
+
| `request` | [operations.ListCrmEventsRequest](../../sdk/models/operations/listcrmeventsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1323
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1324
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1325
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1326
|
+
|
|
1327
|
+
### Response
|
|
1328
|
+
|
|
1329
|
+
**Promise\<[shared.CrmEvent[]](../../models/.md)\>**
|
|
1330
|
+
|
|
1331
|
+
### Errors
|
|
1332
|
+
|
|
1333
|
+
| Error Type | Status Code | Content Type |
|
|
1334
|
+
| --------------- | --------------- | --------------- |
|
|
1335
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1336
|
+
|
|
1337
|
+
## listCrmLeads
|
|
1338
|
+
|
|
1339
|
+
List all leads
|
|
1340
|
+
|
|
1341
|
+
### Example Usage
|
|
1342
|
+
|
|
1343
|
+
```typescript
|
|
1344
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1345
|
+
|
|
1346
|
+
const unifiedTo = new UnifiedTo({
|
|
1347
|
+
security: {
|
|
1348
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1349
|
+
},
|
|
1350
|
+
});
|
|
1351
|
+
|
|
1352
|
+
async function run() {
|
|
1353
|
+
const result = await unifiedTo.crm.listCrmLeads({
|
|
1354
|
+
connectionId: "<value>",
|
|
1355
|
+
});
|
|
1356
|
+
|
|
1357
|
+
// Handle the result
|
|
1358
|
+
console.log(result);
|
|
1359
|
+
}
|
|
1360
|
+
|
|
1361
|
+
run();
|
|
1362
|
+
```
|
|
1363
|
+
|
|
1364
|
+
### Standalone function
|
|
1365
|
+
|
|
1366
|
+
The standalone function version of this method:
|
|
1367
|
+
|
|
1368
|
+
```typescript
|
|
1369
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1370
|
+
import { crmListCrmLeads } from "@unified-api/typescript-sdk/funcs/crmListCrmLeads.js";
|
|
1371
|
+
|
|
1372
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1373
|
+
// You can create one instance of it to use across an application.
|
|
1374
|
+
const unifiedTo = new UnifiedToCore({
|
|
1375
|
+
security: {
|
|
1376
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1377
|
+
},
|
|
1378
|
+
});
|
|
1379
|
+
|
|
1380
|
+
async function run() {
|
|
1381
|
+
const res = await crmListCrmLeads(unifiedTo, {
|
|
1382
|
+
connectionId: "<value>",
|
|
1383
|
+
});
|
|
1384
|
+
|
|
1385
|
+
if (!res.ok) {
|
|
1386
|
+
throw res.error;
|
|
1387
|
+
}
|
|
1388
|
+
|
|
1389
|
+
const { value: result } = res;
|
|
1390
|
+
|
|
1391
|
+
// Handle the result
|
|
1392
|
+
console.log(result);
|
|
1393
|
+
}
|
|
1394
|
+
|
|
1395
|
+
run();
|
|
1396
|
+
```
|
|
1397
|
+
|
|
1398
|
+
### Parameters
|
|
1399
|
+
|
|
1400
|
+
| Parameter | Type | Required | Description |
|
|
1401
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1402
|
+
| `request` | [operations.ListCrmLeadsRequest](../../sdk/models/operations/listcrmleadsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1403
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1404
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1405
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1406
|
+
|
|
1407
|
+
### Response
|
|
1408
|
+
|
|
1409
|
+
**Promise\<[shared.CrmLead[]](../../models/.md)\>**
|
|
1410
|
+
|
|
1411
|
+
### Errors
|
|
1412
|
+
|
|
1413
|
+
| Error Type | Status Code | Content Type |
|
|
1414
|
+
| --------------- | --------------- | --------------- |
|
|
1415
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1416
|
+
|
|
1417
|
+
## listCrmPipelines
|
|
1418
|
+
|
|
1419
|
+
List all pipelines
|
|
1420
|
+
|
|
1421
|
+
### Example Usage
|
|
1422
|
+
|
|
1423
|
+
```typescript
|
|
1424
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1425
|
+
|
|
1426
|
+
const unifiedTo = new UnifiedTo({
|
|
1427
|
+
security: {
|
|
1428
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1429
|
+
},
|
|
1430
|
+
});
|
|
1431
|
+
|
|
1432
|
+
async function run() {
|
|
1433
|
+
const result = await unifiedTo.crm.listCrmPipelines({
|
|
1434
|
+
connectionId: "<value>",
|
|
1435
|
+
});
|
|
1436
|
+
|
|
1437
|
+
// Handle the result
|
|
1438
|
+
console.log(result);
|
|
1439
|
+
}
|
|
1440
|
+
|
|
1441
|
+
run();
|
|
1442
|
+
```
|
|
1443
|
+
|
|
1444
|
+
### Standalone function
|
|
1445
|
+
|
|
1446
|
+
The standalone function version of this method:
|
|
1447
|
+
|
|
1448
|
+
```typescript
|
|
1449
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1450
|
+
import { crmListCrmPipelines } from "@unified-api/typescript-sdk/funcs/crmListCrmPipelines.js";
|
|
1451
|
+
|
|
1452
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1453
|
+
// You can create one instance of it to use across an application.
|
|
1454
|
+
const unifiedTo = new UnifiedToCore({
|
|
1455
|
+
security: {
|
|
1456
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1457
|
+
},
|
|
1458
|
+
});
|
|
1459
|
+
|
|
1460
|
+
async function run() {
|
|
1461
|
+
const res = await crmListCrmPipelines(unifiedTo, {
|
|
1462
|
+
connectionId: "<value>",
|
|
1463
|
+
});
|
|
1464
|
+
|
|
1465
|
+
if (!res.ok) {
|
|
1466
|
+
throw res.error;
|
|
1467
|
+
}
|
|
1468
|
+
|
|
1469
|
+
const { value: result } = res;
|
|
1470
|
+
|
|
1471
|
+
// Handle the result
|
|
1472
|
+
console.log(result);
|
|
1473
|
+
}
|
|
1474
|
+
|
|
1475
|
+
run();
|
|
1476
|
+
```
|
|
1477
|
+
|
|
1478
|
+
### Parameters
|
|
1479
|
+
|
|
1480
|
+
| Parameter | Type | Required | Description |
|
|
1481
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1482
|
+
| `request` | [operations.ListCrmPipelinesRequest](../../sdk/models/operations/listcrmpipelinesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1483
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1484
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1485
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1486
|
+
|
|
1487
|
+
### Response
|
|
1488
|
+
|
|
1489
|
+
**Promise\<[shared.CrmPipeline[]](../../models/.md)\>**
|
|
1490
|
+
|
|
1491
|
+
### Errors
|
|
1492
|
+
|
|
1493
|
+
| Error Type | Status Code | Content Type |
|
|
1494
|
+
| --------------- | --------------- | --------------- |
|
|
1495
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1496
|
+
|
|
1497
|
+
## patchCrmCompany
|
|
1498
|
+
|
|
1499
|
+
Update a company
|
|
1500
|
+
|
|
1501
|
+
### Example Usage
|
|
1502
|
+
|
|
1503
|
+
```typescript
|
|
1504
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1505
|
+
|
|
1506
|
+
const unifiedTo = new UnifiedTo({
|
|
1507
|
+
security: {
|
|
1508
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1509
|
+
},
|
|
1510
|
+
});
|
|
1511
|
+
|
|
1512
|
+
async function run() {
|
|
1513
|
+
const result = await unifiedTo.crm.patchCrmCompany({
|
|
1514
|
+
connectionId: "<value>",
|
|
1515
|
+
id: "<id>",
|
|
1516
|
+
});
|
|
1517
|
+
|
|
1518
|
+
// Handle the result
|
|
1519
|
+
console.log(result);
|
|
1520
|
+
}
|
|
1521
|
+
|
|
1522
|
+
run();
|
|
1523
|
+
```
|
|
1524
|
+
|
|
1525
|
+
### Standalone function
|
|
1526
|
+
|
|
1527
|
+
The standalone function version of this method:
|
|
1528
|
+
|
|
1529
|
+
```typescript
|
|
1530
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1531
|
+
import { crmPatchCrmCompany } from "@unified-api/typescript-sdk/funcs/crmPatchCrmCompany.js";
|
|
1532
|
+
|
|
1533
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1534
|
+
// You can create one instance of it to use across an application.
|
|
1535
|
+
const unifiedTo = new UnifiedToCore({
|
|
1536
|
+
security: {
|
|
1537
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1538
|
+
},
|
|
1539
|
+
});
|
|
1540
|
+
|
|
1541
|
+
async function run() {
|
|
1542
|
+
const res = await crmPatchCrmCompany(unifiedTo, {
|
|
1543
|
+
connectionId: "<value>",
|
|
1544
|
+
id: "<id>",
|
|
1545
|
+
});
|
|
1546
|
+
|
|
1547
|
+
if (!res.ok) {
|
|
1548
|
+
throw res.error;
|
|
1549
|
+
}
|
|
1550
|
+
|
|
1551
|
+
const { value: result } = res;
|
|
1552
|
+
|
|
1553
|
+
// Handle the result
|
|
1554
|
+
console.log(result);
|
|
1555
|
+
}
|
|
1556
|
+
|
|
1557
|
+
run();
|
|
1558
|
+
```
|
|
1559
|
+
|
|
1560
|
+
### Parameters
|
|
1561
|
+
|
|
1562
|
+
| Parameter | Type | Required | Description |
|
|
1563
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1564
|
+
| `request` | [operations.PatchCrmCompanyRequest](../../sdk/models/operations/patchcrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1565
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1566
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1567
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1568
|
+
|
|
1569
|
+
### Response
|
|
1570
|
+
|
|
1571
|
+
**Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
|
|
1572
|
+
|
|
1573
|
+
### Errors
|
|
1574
|
+
|
|
1575
|
+
| Error Type | Status Code | Content Type |
|
|
1576
|
+
| --------------- | --------------- | --------------- |
|
|
1577
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1578
|
+
|
|
1579
|
+
## patchCrmContact
|
|
1580
|
+
|
|
1581
|
+
Update a contact
|
|
1582
|
+
|
|
1583
|
+
### Example Usage
|
|
1584
|
+
|
|
1585
|
+
```typescript
|
|
1586
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1587
|
+
|
|
1588
|
+
const unifiedTo = new UnifiedTo({
|
|
1589
|
+
security: {
|
|
1590
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1591
|
+
},
|
|
1592
|
+
});
|
|
1593
|
+
|
|
1594
|
+
async function run() {
|
|
1595
|
+
const result = await unifiedTo.crm.patchCrmContact({
|
|
1596
|
+
connectionId: "<value>",
|
|
1597
|
+
id: "<id>",
|
|
1598
|
+
});
|
|
1599
|
+
|
|
1600
|
+
// Handle the result
|
|
1601
|
+
console.log(result);
|
|
1602
|
+
}
|
|
1603
|
+
|
|
1604
|
+
run();
|
|
1605
|
+
```
|
|
1606
|
+
|
|
1607
|
+
### Standalone function
|
|
1608
|
+
|
|
1609
|
+
The standalone function version of this method:
|
|
1610
|
+
|
|
1611
|
+
```typescript
|
|
1612
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1613
|
+
import { crmPatchCrmContact } from "@unified-api/typescript-sdk/funcs/crmPatchCrmContact.js";
|
|
1614
|
+
|
|
1615
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1616
|
+
// You can create one instance of it to use across an application.
|
|
1617
|
+
const unifiedTo = new UnifiedToCore({
|
|
1618
|
+
security: {
|
|
1619
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1620
|
+
},
|
|
1621
|
+
});
|
|
1622
|
+
|
|
1623
|
+
async function run() {
|
|
1624
|
+
const res = await crmPatchCrmContact(unifiedTo, {
|
|
1625
|
+
connectionId: "<value>",
|
|
1626
|
+
id: "<id>",
|
|
1627
|
+
});
|
|
1628
|
+
|
|
1629
|
+
if (!res.ok) {
|
|
1630
|
+
throw res.error;
|
|
1631
|
+
}
|
|
1632
|
+
|
|
1633
|
+
const { value: result } = res;
|
|
1634
|
+
|
|
1635
|
+
// Handle the result
|
|
1636
|
+
console.log(result);
|
|
1637
|
+
}
|
|
1638
|
+
|
|
1639
|
+
run();
|
|
1640
|
+
```
|
|
1641
|
+
|
|
1642
|
+
### Parameters
|
|
1643
|
+
|
|
1644
|
+
| Parameter | Type | Required | Description |
|
|
1645
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1646
|
+
| `request` | [operations.PatchCrmContactRequest](../../sdk/models/operations/patchcrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1647
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1648
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1649
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1650
|
+
|
|
1651
|
+
### Response
|
|
1652
|
+
|
|
1653
|
+
**Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
|
|
1654
|
+
|
|
1655
|
+
### Errors
|
|
1656
|
+
|
|
1657
|
+
| Error Type | Status Code | Content Type |
|
|
1658
|
+
| --------------- | --------------- | --------------- |
|
|
1659
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1660
|
+
|
|
1661
|
+
## patchCrmDeal
|
|
1662
|
+
|
|
1663
|
+
Update a deal
|
|
1664
|
+
|
|
1665
|
+
### Example Usage
|
|
1666
|
+
|
|
1667
|
+
```typescript
|
|
1668
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1669
|
+
|
|
1670
|
+
const unifiedTo = new UnifiedTo({
|
|
1671
|
+
security: {
|
|
1672
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1673
|
+
},
|
|
1674
|
+
});
|
|
1675
|
+
|
|
1676
|
+
async function run() {
|
|
1677
|
+
const result = await unifiedTo.crm.patchCrmDeal({
|
|
1678
|
+
connectionId: "<value>",
|
|
1679
|
+
id: "<id>",
|
|
1680
|
+
});
|
|
1681
|
+
|
|
1682
|
+
// Handle the result
|
|
1683
|
+
console.log(result);
|
|
1684
|
+
}
|
|
1685
|
+
|
|
1686
|
+
run();
|
|
1687
|
+
```
|
|
1688
|
+
|
|
1689
|
+
### Standalone function
|
|
1690
|
+
|
|
1691
|
+
The standalone function version of this method:
|
|
1692
|
+
|
|
1693
|
+
```typescript
|
|
1694
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1695
|
+
import { crmPatchCrmDeal } from "@unified-api/typescript-sdk/funcs/crmPatchCrmDeal.js";
|
|
1696
|
+
|
|
1697
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1698
|
+
// You can create one instance of it to use across an application.
|
|
1699
|
+
const unifiedTo = new UnifiedToCore({
|
|
1700
|
+
security: {
|
|
1701
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1702
|
+
},
|
|
1703
|
+
});
|
|
1704
|
+
|
|
1705
|
+
async function run() {
|
|
1706
|
+
const res = await crmPatchCrmDeal(unifiedTo, {
|
|
1707
|
+
connectionId: "<value>",
|
|
1708
|
+
id: "<id>",
|
|
1709
|
+
});
|
|
1710
|
+
|
|
1711
|
+
if (!res.ok) {
|
|
1712
|
+
throw res.error;
|
|
1713
|
+
}
|
|
1714
|
+
|
|
1715
|
+
const { value: result } = res;
|
|
1716
|
+
|
|
1717
|
+
// Handle the result
|
|
1718
|
+
console.log(result);
|
|
1719
|
+
}
|
|
1720
|
+
|
|
1721
|
+
run();
|
|
1722
|
+
```
|
|
1723
|
+
|
|
1724
|
+
### Parameters
|
|
1725
|
+
|
|
1726
|
+
| Parameter | Type | Required | Description |
|
|
1727
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1728
|
+
| `request` | [operations.PatchCrmDealRequest](../../sdk/models/operations/patchcrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1729
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1730
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1731
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1732
|
+
|
|
1733
|
+
### Response
|
|
1734
|
+
|
|
1735
|
+
**Promise\<[shared.CrmDeal](../../sdk/models/shared/crmdeal.md)\>**
|
|
1736
|
+
|
|
1737
|
+
### Errors
|
|
1738
|
+
|
|
1739
|
+
| Error Type | Status Code | Content Type |
|
|
1740
|
+
| --------------- | --------------- | --------------- |
|
|
1741
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1742
|
+
|
|
1743
|
+
## patchCrmEvent
|
|
1744
|
+
|
|
1745
|
+
Update an event
|
|
1746
|
+
|
|
1747
|
+
### Example Usage
|
|
1748
|
+
|
|
1749
|
+
```typescript
|
|
1750
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1751
|
+
|
|
1752
|
+
const unifiedTo = new UnifiedTo({
|
|
1753
|
+
security: {
|
|
1754
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1755
|
+
},
|
|
1756
|
+
});
|
|
1757
|
+
|
|
1758
|
+
async function run() {
|
|
1759
|
+
const result = await unifiedTo.crm.patchCrmEvent({
|
|
1760
|
+
connectionId: "<value>",
|
|
1761
|
+
id: "<id>",
|
|
1762
|
+
});
|
|
1763
|
+
|
|
1764
|
+
// Handle the result
|
|
1765
|
+
console.log(result);
|
|
1766
|
+
}
|
|
1767
|
+
|
|
1768
|
+
run();
|
|
1769
|
+
```
|
|
1770
|
+
|
|
1771
|
+
### Standalone function
|
|
1772
|
+
|
|
1773
|
+
The standalone function version of this method:
|
|
1774
|
+
|
|
1775
|
+
```typescript
|
|
1776
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1777
|
+
import { crmPatchCrmEvent } from "@unified-api/typescript-sdk/funcs/crmPatchCrmEvent.js";
|
|
1778
|
+
|
|
1779
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1780
|
+
// You can create one instance of it to use across an application.
|
|
1781
|
+
const unifiedTo = new UnifiedToCore({
|
|
1782
|
+
security: {
|
|
1783
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1784
|
+
},
|
|
1785
|
+
});
|
|
1786
|
+
|
|
1787
|
+
async function run() {
|
|
1788
|
+
const res = await crmPatchCrmEvent(unifiedTo, {
|
|
1789
|
+
connectionId: "<value>",
|
|
1790
|
+
id: "<id>",
|
|
1791
|
+
});
|
|
1792
|
+
|
|
1793
|
+
if (!res.ok) {
|
|
1794
|
+
throw res.error;
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1797
|
+
const { value: result } = res;
|
|
1798
|
+
|
|
1799
|
+
// Handle the result
|
|
1800
|
+
console.log(result);
|
|
1801
|
+
}
|
|
1802
|
+
|
|
1803
|
+
run();
|
|
1804
|
+
```
|
|
1805
|
+
|
|
1806
|
+
### Parameters
|
|
1807
|
+
|
|
1808
|
+
| Parameter | Type | Required | Description |
|
|
1809
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1810
|
+
| `request` | [operations.PatchCrmEventRequest](../../sdk/models/operations/patchcrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1811
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1812
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1813
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1814
|
+
|
|
1815
|
+
### Response
|
|
1816
|
+
|
|
1817
|
+
**Promise\<[shared.CrmEvent](../../sdk/models/shared/crmevent.md)\>**
|
|
1818
|
+
|
|
1819
|
+
### Errors
|
|
1820
|
+
|
|
1821
|
+
| Error Type | Status Code | Content Type |
|
|
1822
|
+
| --------------- | --------------- | --------------- |
|
|
1823
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1824
|
+
|
|
1825
|
+
## patchCrmLead
|
|
1826
|
+
|
|
1827
|
+
Update a lead
|
|
1828
|
+
|
|
1829
|
+
### Example Usage
|
|
1830
|
+
|
|
1831
|
+
```typescript
|
|
1832
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1833
|
+
|
|
1834
|
+
const unifiedTo = new UnifiedTo({
|
|
1835
|
+
security: {
|
|
1836
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1837
|
+
},
|
|
1838
|
+
});
|
|
1839
|
+
|
|
1840
|
+
async function run() {
|
|
1841
|
+
const result = await unifiedTo.crm.patchCrmLead({
|
|
1842
|
+
connectionId: "<value>",
|
|
1843
|
+
id: "<id>",
|
|
1844
|
+
});
|
|
1845
|
+
|
|
1846
|
+
// Handle the result
|
|
1847
|
+
console.log(result);
|
|
1848
|
+
}
|
|
1849
|
+
|
|
1850
|
+
run();
|
|
1851
|
+
```
|
|
1852
|
+
|
|
1853
|
+
### Standalone function
|
|
1854
|
+
|
|
1855
|
+
The standalone function version of this method:
|
|
1856
|
+
|
|
1857
|
+
```typescript
|
|
1858
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1859
|
+
import { crmPatchCrmLead } from "@unified-api/typescript-sdk/funcs/crmPatchCrmLead.js";
|
|
1860
|
+
|
|
1861
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1862
|
+
// You can create one instance of it to use across an application.
|
|
1863
|
+
const unifiedTo = new UnifiedToCore({
|
|
1864
|
+
security: {
|
|
1865
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1866
|
+
},
|
|
1867
|
+
});
|
|
1868
|
+
|
|
1869
|
+
async function run() {
|
|
1870
|
+
const res = await crmPatchCrmLead(unifiedTo, {
|
|
1871
|
+
connectionId: "<value>",
|
|
1872
|
+
id: "<id>",
|
|
1873
|
+
});
|
|
1874
|
+
|
|
1875
|
+
if (!res.ok) {
|
|
1876
|
+
throw res.error;
|
|
1877
|
+
}
|
|
1878
|
+
|
|
1879
|
+
const { value: result } = res;
|
|
1880
|
+
|
|
1881
|
+
// Handle the result
|
|
1882
|
+
console.log(result);
|
|
1883
|
+
}
|
|
1884
|
+
|
|
1885
|
+
run();
|
|
1886
|
+
```
|
|
1887
|
+
|
|
1888
|
+
### Parameters
|
|
1889
|
+
|
|
1890
|
+
| Parameter | Type | Required | Description |
|
|
1891
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1892
|
+
| `request` | [operations.PatchCrmLeadRequest](../../sdk/models/operations/patchcrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1893
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1894
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1895
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1896
|
+
|
|
1897
|
+
### Response
|
|
1898
|
+
|
|
1899
|
+
**Promise\<[shared.CrmLead](../../sdk/models/shared/crmlead.md)\>**
|
|
1900
|
+
|
|
1901
|
+
### Errors
|
|
1902
|
+
|
|
1903
|
+
| Error Type | Status Code | Content Type |
|
|
1904
|
+
| --------------- | --------------- | --------------- |
|
|
1905
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1906
|
+
|
|
1907
|
+
## patchCrmPipeline
|
|
1908
|
+
|
|
1909
|
+
Update a pipeline
|
|
1910
|
+
|
|
1911
|
+
### Example Usage
|
|
1912
|
+
|
|
1913
|
+
```typescript
|
|
1914
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1915
|
+
|
|
1916
|
+
const unifiedTo = new UnifiedTo({
|
|
1917
|
+
security: {
|
|
1918
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1919
|
+
},
|
|
1920
|
+
});
|
|
1921
|
+
|
|
1922
|
+
async function run() {
|
|
1923
|
+
const result = await unifiedTo.crm.patchCrmPipeline({
|
|
1924
|
+
connectionId: "<value>",
|
|
1925
|
+
id: "<id>",
|
|
1926
|
+
});
|
|
1927
|
+
|
|
1928
|
+
// Handle the result
|
|
1929
|
+
console.log(result);
|
|
1930
|
+
}
|
|
1931
|
+
|
|
1932
|
+
run();
|
|
1933
|
+
```
|
|
1934
|
+
|
|
1935
|
+
### Standalone function
|
|
1936
|
+
|
|
1937
|
+
The standalone function version of this method:
|
|
1938
|
+
|
|
1939
|
+
```typescript
|
|
1940
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1941
|
+
import { crmPatchCrmPipeline } from "@unified-api/typescript-sdk/funcs/crmPatchCrmPipeline.js";
|
|
1942
|
+
|
|
1943
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1944
|
+
// You can create one instance of it to use across an application.
|
|
1945
|
+
const unifiedTo = new UnifiedToCore({
|
|
1946
|
+
security: {
|
|
1947
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1948
|
+
},
|
|
1949
|
+
});
|
|
1950
|
+
|
|
1951
|
+
async function run() {
|
|
1952
|
+
const res = await crmPatchCrmPipeline(unifiedTo, {
|
|
1953
|
+
connectionId: "<value>",
|
|
1954
|
+
id: "<id>",
|
|
1955
|
+
});
|
|
1956
|
+
|
|
1957
|
+
if (!res.ok) {
|
|
1958
|
+
throw res.error;
|
|
1959
|
+
}
|
|
1960
|
+
|
|
1961
|
+
const { value: result } = res;
|
|
1962
|
+
|
|
1963
|
+
// Handle the result
|
|
1964
|
+
console.log(result);
|
|
1965
|
+
}
|
|
1966
|
+
|
|
1967
|
+
run();
|
|
1968
|
+
```
|
|
1969
|
+
|
|
1970
|
+
### Parameters
|
|
1971
|
+
|
|
1972
|
+
| Parameter | Type | Required | Description |
|
|
1973
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1974
|
+
| `request` | [operations.PatchCrmPipelineRequest](../../sdk/models/operations/patchcrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1975
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1976
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1977
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1978
|
+
|
|
1979
|
+
### Response
|
|
1980
|
+
|
|
1981
|
+
**Promise\<[shared.CrmPipeline](../../sdk/models/shared/crmpipeline.md)\>**
|
|
1982
|
+
|
|
1983
|
+
### Errors
|
|
1984
|
+
|
|
1985
|
+
| Error Type | Status Code | Content Type |
|
|
1986
|
+
| --------------- | --------------- | --------------- |
|
|
1987
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1988
|
+
|
|
1989
|
+
## removeCrmCompany
|
|
1990
|
+
|
|
1991
|
+
Remove a company
|
|
1992
|
+
|
|
1993
|
+
### Example Usage
|
|
1994
|
+
|
|
1995
|
+
```typescript
|
|
1996
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1997
|
+
|
|
1998
|
+
const unifiedTo = new UnifiedTo({
|
|
1999
|
+
security: {
|
|
2000
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2001
|
+
},
|
|
2002
|
+
});
|
|
2003
|
+
|
|
2004
|
+
async function run() {
|
|
2005
|
+
const result = await unifiedTo.crm.removeCrmCompany({
|
|
2006
|
+
connectionId: "<value>",
|
|
2007
|
+
id: "<id>",
|
|
2008
|
+
});
|
|
2009
|
+
|
|
2010
|
+
// Handle the result
|
|
2011
|
+
console.log(result);
|
|
2012
|
+
}
|
|
2013
|
+
|
|
2014
|
+
run();
|
|
2015
|
+
```
|
|
2016
|
+
|
|
2017
|
+
### Standalone function
|
|
2018
|
+
|
|
2019
|
+
The standalone function version of this method:
|
|
2020
|
+
|
|
2021
|
+
```typescript
|
|
2022
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2023
|
+
import { crmRemoveCrmCompany } from "@unified-api/typescript-sdk/funcs/crmRemoveCrmCompany.js";
|
|
2024
|
+
|
|
2025
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2026
|
+
// You can create one instance of it to use across an application.
|
|
2027
|
+
const unifiedTo = new UnifiedToCore({
|
|
2028
|
+
security: {
|
|
2029
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2030
|
+
},
|
|
2031
|
+
});
|
|
2032
|
+
|
|
2033
|
+
async function run() {
|
|
2034
|
+
const res = await crmRemoveCrmCompany(unifiedTo, {
|
|
2035
|
+
connectionId: "<value>",
|
|
2036
|
+
id: "<id>",
|
|
2037
|
+
});
|
|
2038
|
+
|
|
2039
|
+
if (!res.ok) {
|
|
2040
|
+
throw res.error;
|
|
2041
|
+
}
|
|
2042
|
+
|
|
2043
|
+
const { value: result } = res;
|
|
2044
|
+
|
|
2045
|
+
// Handle the result
|
|
2046
|
+
console.log(result);
|
|
2047
|
+
}
|
|
2048
|
+
|
|
2049
|
+
run();
|
|
2050
|
+
```
|
|
2051
|
+
|
|
2052
|
+
### Parameters
|
|
2053
|
+
|
|
2054
|
+
| Parameter | Type | Required | Description |
|
|
2055
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2056
|
+
| `request` | [operations.RemoveCrmCompanyRequest](../../sdk/models/operations/removecrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2057
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2058
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2059
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2060
|
+
|
|
2061
|
+
### Response
|
|
2062
|
+
|
|
2063
|
+
**Promise\<[operations.RemoveCrmCompanyResponse](../../sdk/models/operations/removecrmcompanyresponse.md)\>**
|
|
2064
|
+
|
|
2065
|
+
### Errors
|
|
2066
|
+
|
|
2067
|
+
| Error Type | Status Code | Content Type |
|
|
2068
|
+
| --------------- | --------------- | --------------- |
|
|
2069
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2070
|
+
|
|
2071
|
+
## removeCrmContact
|
|
2072
|
+
|
|
2073
|
+
Remove a contact
|
|
2074
|
+
|
|
2075
|
+
### Example Usage
|
|
2076
|
+
|
|
2077
|
+
```typescript
|
|
2078
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2079
|
+
|
|
2080
|
+
const unifiedTo = new UnifiedTo({
|
|
2081
|
+
security: {
|
|
2082
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2083
|
+
},
|
|
2084
|
+
});
|
|
2085
|
+
|
|
2086
|
+
async function run() {
|
|
2087
|
+
const result = await unifiedTo.crm.removeCrmContact({
|
|
2088
|
+
connectionId: "<value>",
|
|
2089
|
+
id: "<id>",
|
|
2090
|
+
});
|
|
2091
|
+
|
|
2092
|
+
// Handle the result
|
|
2093
|
+
console.log(result);
|
|
2094
|
+
}
|
|
2095
|
+
|
|
2096
|
+
run();
|
|
2097
|
+
```
|
|
2098
|
+
|
|
2099
|
+
### Standalone function
|
|
2100
|
+
|
|
2101
|
+
The standalone function version of this method:
|
|
2102
|
+
|
|
2103
|
+
```typescript
|
|
2104
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2105
|
+
import { crmRemoveCrmContact } from "@unified-api/typescript-sdk/funcs/crmRemoveCrmContact.js";
|
|
2106
|
+
|
|
2107
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2108
|
+
// You can create one instance of it to use across an application.
|
|
2109
|
+
const unifiedTo = new UnifiedToCore({
|
|
2110
|
+
security: {
|
|
2111
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2112
|
+
},
|
|
2113
|
+
});
|
|
2114
|
+
|
|
2115
|
+
async function run() {
|
|
2116
|
+
const res = await crmRemoveCrmContact(unifiedTo, {
|
|
2117
|
+
connectionId: "<value>",
|
|
2118
|
+
id: "<id>",
|
|
2119
|
+
});
|
|
2120
|
+
|
|
2121
|
+
if (!res.ok) {
|
|
2122
|
+
throw res.error;
|
|
2123
|
+
}
|
|
2124
|
+
|
|
2125
|
+
const { value: result } = res;
|
|
2126
|
+
|
|
2127
|
+
// Handle the result
|
|
2128
|
+
console.log(result);
|
|
2129
|
+
}
|
|
2130
|
+
|
|
2131
|
+
run();
|
|
2132
|
+
```
|
|
2133
|
+
|
|
2134
|
+
### Parameters
|
|
2135
|
+
|
|
2136
|
+
| Parameter | Type | Required | Description |
|
|
2137
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2138
|
+
| `request` | [operations.RemoveCrmContactRequest](../../sdk/models/operations/removecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2139
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2140
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2141
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2142
|
+
|
|
2143
|
+
### Response
|
|
2144
|
+
|
|
2145
|
+
**Promise\<[operations.RemoveCrmContactResponse](../../sdk/models/operations/removecrmcontactresponse.md)\>**
|
|
2146
|
+
|
|
2147
|
+
### Errors
|
|
2148
|
+
|
|
2149
|
+
| Error Type | Status Code | Content Type |
|
|
2150
|
+
| --------------- | --------------- | --------------- |
|
|
2151
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2152
|
+
|
|
2153
|
+
## removeCrmDeal
|
|
2154
|
+
|
|
2155
|
+
Remove a deal
|
|
2156
|
+
|
|
2157
|
+
### Example Usage
|
|
2158
|
+
|
|
2159
|
+
```typescript
|
|
2160
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2161
|
+
|
|
2162
|
+
const unifiedTo = new UnifiedTo({
|
|
2163
|
+
security: {
|
|
2164
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2165
|
+
},
|
|
2166
|
+
});
|
|
2167
|
+
|
|
2168
|
+
async function run() {
|
|
2169
|
+
const result = await unifiedTo.crm.removeCrmDeal({
|
|
2170
|
+
connectionId: "<value>",
|
|
2171
|
+
id: "<id>",
|
|
2172
|
+
});
|
|
2173
|
+
|
|
2174
|
+
// Handle the result
|
|
2175
|
+
console.log(result);
|
|
2176
|
+
}
|
|
2177
|
+
|
|
2178
|
+
run();
|
|
2179
|
+
```
|
|
2180
|
+
|
|
2181
|
+
### Standalone function
|
|
2182
|
+
|
|
2183
|
+
The standalone function version of this method:
|
|
2184
|
+
|
|
2185
|
+
```typescript
|
|
2186
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2187
|
+
import { crmRemoveCrmDeal } from "@unified-api/typescript-sdk/funcs/crmRemoveCrmDeal.js";
|
|
2188
|
+
|
|
2189
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2190
|
+
// You can create one instance of it to use across an application.
|
|
2191
|
+
const unifiedTo = new UnifiedToCore({
|
|
2192
|
+
security: {
|
|
2193
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2194
|
+
},
|
|
2195
|
+
});
|
|
2196
|
+
|
|
2197
|
+
async function run() {
|
|
2198
|
+
const res = await crmRemoveCrmDeal(unifiedTo, {
|
|
2199
|
+
connectionId: "<value>",
|
|
2200
|
+
id: "<id>",
|
|
2201
|
+
});
|
|
2202
|
+
|
|
2203
|
+
if (!res.ok) {
|
|
2204
|
+
throw res.error;
|
|
2205
|
+
}
|
|
2206
|
+
|
|
2207
|
+
const { value: result } = res;
|
|
2208
|
+
|
|
2209
|
+
// Handle the result
|
|
2210
|
+
console.log(result);
|
|
2211
|
+
}
|
|
2212
|
+
|
|
2213
|
+
run();
|
|
2214
|
+
```
|
|
2215
|
+
|
|
2216
|
+
### Parameters
|
|
2217
|
+
|
|
2218
|
+
| Parameter | Type | Required | Description |
|
|
2219
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2220
|
+
| `request` | [operations.RemoveCrmDealRequest](../../sdk/models/operations/removecrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2221
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2222
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2223
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2224
|
+
|
|
2225
|
+
### Response
|
|
2226
|
+
|
|
2227
|
+
**Promise\<[operations.RemoveCrmDealResponse](../../sdk/models/operations/removecrmdealresponse.md)\>**
|
|
2228
|
+
|
|
2229
|
+
### Errors
|
|
2230
|
+
|
|
2231
|
+
| Error Type | Status Code | Content Type |
|
|
2232
|
+
| --------------- | --------------- | --------------- |
|
|
2233
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2234
|
+
|
|
2235
|
+
## removeCrmEvent
|
|
2236
|
+
|
|
2237
|
+
Remove an event
|
|
2238
|
+
|
|
2239
|
+
### Example Usage
|
|
2240
|
+
|
|
2241
|
+
```typescript
|
|
2242
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2243
|
+
|
|
2244
|
+
const unifiedTo = new UnifiedTo({
|
|
2245
|
+
security: {
|
|
2246
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2247
|
+
},
|
|
2248
|
+
});
|
|
2249
|
+
|
|
2250
|
+
async function run() {
|
|
2251
|
+
const result = await unifiedTo.crm.removeCrmEvent({
|
|
2252
|
+
connectionId: "<value>",
|
|
2253
|
+
id: "<id>",
|
|
2254
|
+
});
|
|
2255
|
+
|
|
2256
|
+
// Handle the result
|
|
2257
|
+
console.log(result);
|
|
2258
|
+
}
|
|
2259
|
+
|
|
2260
|
+
run();
|
|
2261
|
+
```
|
|
2262
|
+
|
|
2263
|
+
### Standalone function
|
|
2264
|
+
|
|
2265
|
+
The standalone function version of this method:
|
|
2266
|
+
|
|
2267
|
+
```typescript
|
|
2268
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2269
|
+
import { crmRemoveCrmEvent } from "@unified-api/typescript-sdk/funcs/crmRemoveCrmEvent.js";
|
|
2270
|
+
|
|
2271
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2272
|
+
// You can create one instance of it to use across an application.
|
|
2273
|
+
const unifiedTo = new UnifiedToCore({
|
|
2274
|
+
security: {
|
|
2275
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2276
|
+
},
|
|
2277
|
+
});
|
|
2278
|
+
|
|
2279
|
+
async function run() {
|
|
2280
|
+
const res = await crmRemoveCrmEvent(unifiedTo, {
|
|
2281
|
+
connectionId: "<value>",
|
|
2282
|
+
id: "<id>",
|
|
2283
|
+
});
|
|
2284
|
+
|
|
2285
|
+
if (!res.ok) {
|
|
2286
|
+
throw res.error;
|
|
2287
|
+
}
|
|
2288
|
+
|
|
2289
|
+
const { value: result } = res;
|
|
2290
|
+
|
|
2291
|
+
// Handle the result
|
|
2292
|
+
console.log(result);
|
|
2293
|
+
}
|
|
2294
|
+
|
|
2295
|
+
run();
|
|
2296
|
+
```
|
|
2297
|
+
|
|
2298
|
+
### Parameters
|
|
2299
|
+
|
|
2300
|
+
| Parameter | Type | Required | Description |
|
|
2301
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2302
|
+
| `request` | [operations.RemoveCrmEventRequest](../../sdk/models/operations/removecrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2303
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2304
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2305
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2306
|
+
|
|
2307
|
+
### Response
|
|
2308
|
+
|
|
2309
|
+
**Promise\<[operations.RemoveCrmEventResponse](../../sdk/models/operations/removecrmeventresponse.md)\>**
|
|
2310
|
+
|
|
2311
|
+
### Errors
|
|
2312
|
+
|
|
2313
|
+
| Error Type | Status Code | Content Type |
|
|
2314
|
+
| --------------- | --------------- | --------------- |
|
|
2315
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2316
|
+
|
|
2317
|
+
## removeCrmLead
|
|
2318
|
+
|
|
2319
|
+
Remove a lead
|
|
2320
|
+
|
|
2321
|
+
### Example Usage
|
|
2322
|
+
|
|
2323
|
+
```typescript
|
|
2324
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2325
|
+
|
|
2326
|
+
const unifiedTo = new UnifiedTo({
|
|
2327
|
+
security: {
|
|
2328
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2329
|
+
},
|
|
2330
|
+
});
|
|
2331
|
+
|
|
2332
|
+
async function run() {
|
|
2333
|
+
const result = await unifiedTo.crm.removeCrmLead({
|
|
2334
|
+
connectionId: "<value>",
|
|
2335
|
+
id: "<id>",
|
|
2336
|
+
});
|
|
2337
|
+
|
|
2338
|
+
// Handle the result
|
|
2339
|
+
console.log(result);
|
|
2340
|
+
}
|
|
2341
|
+
|
|
2342
|
+
run();
|
|
2343
|
+
```
|
|
2344
|
+
|
|
2345
|
+
### Standalone function
|
|
2346
|
+
|
|
2347
|
+
The standalone function version of this method:
|
|
2348
|
+
|
|
2349
|
+
```typescript
|
|
2350
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2351
|
+
import { crmRemoveCrmLead } from "@unified-api/typescript-sdk/funcs/crmRemoveCrmLead.js";
|
|
2352
|
+
|
|
2353
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2354
|
+
// You can create one instance of it to use across an application.
|
|
2355
|
+
const unifiedTo = new UnifiedToCore({
|
|
2356
|
+
security: {
|
|
2357
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2358
|
+
},
|
|
2359
|
+
});
|
|
2360
|
+
|
|
2361
|
+
async function run() {
|
|
2362
|
+
const res = await crmRemoveCrmLead(unifiedTo, {
|
|
2363
|
+
connectionId: "<value>",
|
|
2364
|
+
id: "<id>",
|
|
2365
|
+
});
|
|
2366
|
+
|
|
2367
|
+
if (!res.ok) {
|
|
2368
|
+
throw res.error;
|
|
2369
|
+
}
|
|
2370
|
+
|
|
2371
|
+
const { value: result } = res;
|
|
2372
|
+
|
|
2373
|
+
// Handle the result
|
|
2374
|
+
console.log(result);
|
|
2375
|
+
}
|
|
2376
|
+
|
|
2377
|
+
run();
|
|
2378
|
+
```
|
|
2379
|
+
|
|
2380
|
+
### Parameters
|
|
2381
|
+
|
|
2382
|
+
| Parameter | Type | Required | Description |
|
|
2383
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2384
|
+
| `request` | [operations.RemoveCrmLeadRequest](../../sdk/models/operations/removecrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2385
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2386
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2387
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2388
|
+
|
|
2389
|
+
### Response
|
|
2390
|
+
|
|
2391
|
+
**Promise\<[operations.RemoveCrmLeadResponse](../../sdk/models/operations/removecrmleadresponse.md)\>**
|
|
2392
|
+
|
|
2393
|
+
### Errors
|
|
2394
|
+
|
|
2395
|
+
| Error Type | Status Code | Content Type |
|
|
2396
|
+
| --------------- | --------------- | --------------- |
|
|
2397
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2398
|
+
|
|
2399
|
+
## removeCrmPipeline
|
|
2400
|
+
|
|
2401
|
+
Remove a pipeline
|
|
2402
|
+
|
|
2403
|
+
### Example Usage
|
|
2404
|
+
|
|
2405
|
+
```typescript
|
|
2406
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2407
|
+
|
|
2408
|
+
const unifiedTo = new UnifiedTo({
|
|
2409
|
+
security: {
|
|
2410
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2411
|
+
},
|
|
2412
|
+
});
|
|
2413
|
+
|
|
2414
|
+
async function run() {
|
|
2415
|
+
const result = await unifiedTo.crm.removeCrmPipeline({
|
|
2416
|
+
connectionId: "<value>",
|
|
2417
|
+
id: "<id>",
|
|
2418
|
+
});
|
|
2419
|
+
|
|
2420
|
+
// Handle the result
|
|
2421
|
+
console.log(result);
|
|
2422
|
+
}
|
|
2423
|
+
|
|
2424
|
+
run();
|
|
2425
|
+
```
|
|
2426
|
+
|
|
2427
|
+
### Standalone function
|
|
2428
|
+
|
|
2429
|
+
The standalone function version of this method:
|
|
2430
|
+
|
|
2431
|
+
```typescript
|
|
2432
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2433
|
+
import { crmRemoveCrmPipeline } from "@unified-api/typescript-sdk/funcs/crmRemoveCrmPipeline.js";
|
|
2434
|
+
|
|
2435
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2436
|
+
// You can create one instance of it to use across an application.
|
|
2437
|
+
const unifiedTo = new UnifiedToCore({
|
|
2438
|
+
security: {
|
|
2439
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2440
|
+
},
|
|
2441
|
+
});
|
|
2442
|
+
|
|
2443
|
+
async function run() {
|
|
2444
|
+
const res = await crmRemoveCrmPipeline(unifiedTo, {
|
|
2445
|
+
connectionId: "<value>",
|
|
2446
|
+
id: "<id>",
|
|
2447
|
+
});
|
|
2448
|
+
|
|
2449
|
+
if (!res.ok) {
|
|
2450
|
+
throw res.error;
|
|
2451
|
+
}
|
|
2452
|
+
|
|
2453
|
+
const { value: result } = res;
|
|
2454
|
+
|
|
2455
|
+
// Handle the result
|
|
2456
|
+
console.log(result);
|
|
2457
|
+
}
|
|
2458
|
+
|
|
2459
|
+
run();
|
|
2460
|
+
```
|
|
2461
|
+
|
|
2462
|
+
### Parameters
|
|
2463
|
+
|
|
2464
|
+
| Parameter | Type | Required | Description |
|
|
2465
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2466
|
+
| `request` | [operations.RemoveCrmPipelineRequest](../../sdk/models/operations/removecrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2467
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2468
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2469
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2470
|
+
|
|
2471
|
+
### Response
|
|
2472
|
+
|
|
2473
|
+
**Promise\<[operations.RemoveCrmPipelineResponse](../../sdk/models/operations/removecrmpipelineresponse.md)\>**
|
|
2474
|
+
|
|
2475
|
+
### Errors
|
|
2476
|
+
|
|
2477
|
+
| Error Type | Status Code | Content Type |
|
|
2478
|
+
| --------------- | --------------- | --------------- |
|
|
2479
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2480
|
+
|
|
2481
|
+
## updateCrmCompany
|
|
2482
|
+
|
|
2483
|
+
Update a company
|
|
2484
|
+
|
|
2485
|
+
### Example Usage
|
|
2486
|
+
|
|
2487
|
+
```typescript
|
|
2488
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2489
|
+
|
|
2490
|
+
const unifiedTo = new UnifiedTo({
|
|
2491
|
+
security: {
|
|
2492
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2493
|
+
},
|
|
2494
|
+
});
|
|
2495
|
+
|
|
2496
|
+
async function run() {
|
|
2497
|
+
const result = await unifiedTo.crm.updateCrmCompany({
|
|
2498
|
+
connectionId: "<value>",
|
|
2499
|
+
id: "<id>",
|
|
2500
|
+
});
|
|
2501
|
+
|
|
2502
|
+
// Handle the result
|
|
2503
|
+
console.log(result);
|
|
2504
|
+
}
|
|
2505
|
+
|
|
2506
|
+
run();
|
|
2507
|
+
```
|
|
2508
|
+
|
|
2509
|
+
### Standalone function
|
|
2510
|
+
|
|
2511
|
+
The standalone function version of this method:
|
|
2512
|
+
|
|
2513
|
+
```typescript
|
|
2514
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2515
|
+
import { crmUpdateCrmCompany } from "@unified-api/typescript-sdk/funcs/crmUpdateCrmCompany.js";
|
|
2516
|
+
|
|
2517
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2518
|
+
// You can create one instance of it to use across an application.
|
|
2519
|
+
const unifiedTo = new UnifiedToCore({
|
|
2520
|
+
security: {
|
|
2521
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2522
|
+
},
|
|
2523
|
+
});
|
|
2524
|
+
|
|
2525
|
+
async function run() {
|
|
2526
|
+
const res = await crmUpdateCrmCompany(unifiedTo, {
|
|
2527
|
+
connectionId: "<value>",
|
|
2528
|
+
id: "<id>",
|
|
2529
|
+
});
|
|
2530
|
+
|
|
2531
|
+
if (!res.ok) {
|
|
2532
|
+
throw res.error;
|
|
2533
|
+
}
|
|
2534
|
+
|
|
2535
|
+
const { value: result } = res;
|
|
2536
|
+
|
|
2537
|
+
// Handle the result
|
|
2538
|
+
console.log(result);
|
|
2539
|
+
}
|
|
2540
|
+
|
|
2541
|
+
run();
|
|
2542
|
+
```
|
|
2543
|
+
|
|
2544
|
+
### Parameters
|
|
2545
|
+
|
|
2546
|
+
| Parameter | Type | Required | Description |
|
|
2547
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2548
|
+
| `request` | [operations.UpdateCrmCompanyRequest](../../sdk/models/operations/updatecrmcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2549
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2550
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2551
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2552
|
+
|
|
2553
|
+
### Response
|
|
2554
|
+
|
|
2555
|
+
**Promise\<[shared.CrmCompany](../../sdk/models/shared/crmcompany.md)\>**
|
|
2556
|
+
|
|
2557
|
+
### Errors
|
|
2558
|
+
|
|
2559
|
+
| Error Type | Status Code | Content Type |
|
|
2560
|
+
| --------------- | --------------- | --------------- |
|
|
2561
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2562
|
+
|
|
2563
|
+
## updateCrmContact
|
|
2564
|
+
|
|
2565
|
+
Update a contact
|
|
2566
|
+
|
|
2567
|
+
### Example Usage
|
|
2568
|
+
|
|
2569
|
+
```typescript
|
|
2570
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2571
|
+
|
|
2572
|
+
const unifiedTo = new UnifiedTo({
|
|
2573
|
+
security: {
|
|
2574
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2575
|
+
},
|
|
2576
|
+
});
|
|
2577
|
+
|
|
2578
|
+
async function run() {
|
|
2579
|
+
const result = await unifiedTo.crm.updateCrmContact({
|
|
2580
|
+
connectionId: "<value>",
|
|
2581
|
+
id: "<id>",
|
|
2582
|
+
});
|
|
2583
|
+
|
|
2584
|
+
// Handle the result
|
|
2585
|
+
console.log(result);
|
|
2586
|
+
}
|
|
2587
|
+
|
|
2588
|
+
run();
|
|
2589
|
+
```
|
|
2590
|
+
|
|
2591
|
+
### Standalone function
|
|
2592
|
+
|
|
2593
|
+
The standalone function version of this method:
|
|
2594
|
+
|
|
2595
|
+
```typescript
|
|
2596
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2597
|
+
import { crmUpdateCrmContact } from "@unified-api/typescript-sdk/funcs/crmUpdateCrmContact.js";
|
|
2598
|
+
|
|
2599
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2600
|
+
// You can create one instance of it to use across an application.
|
|
2601
|
+
const unifiedTo = new UnifiedToCore({
|
|
2602
|
+
security: {
|
|
2603
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2604
|
+
},
|
|
2605
|
+
});
|
|
2606
|
+
|
|
2607
|
+
async function run() {
|
|
2608
|
+
const res = await crmUpdateCrmContact(unifiedTo, {
|
|
2609
|
+
connectionId: "<value>",
|
|
2610
|
+
id: "<id>",
|
|
2611
|
+
});
|
|
2612
|
+
|
|
2613
|
+
if (!res.ok) {
|
|
2614
|
+
throw res.error;
|
|
2615
|
+
}
|
|
2616
|
+
|
|
2617
|
+
const { value: result } = res;
|
|
2618
|
+
|
|
2619
|
+
// Handle the result
|
|
2620
|
+
console.log(result);
|
|
2621
|
+
}
|
|
2622
|
+
|
|
2623
|
+
run();
|
|
2624
|
+
```
|
|
2625
|
+
|
|
2626
|
+
### Parameters
|
|
2627
|
+
|
|
2628
|
+
| Parameter | Type | Required | Description |
|
|
2629
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2630
|
+
| `request` | [operations.UpdateCrmContactRequest](../../sdk/models/operations/updatecrmcontactrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2631
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2632
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2633
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2634
|
+
|
|
2635
|
+
### Response
|
|
2636
|
+
|
|
2637
|
+
**Promise\<[shared.CrmContact](../../sdk/models/shared/crmcontact.md)\>**
|
|
2638
|
+
|
|
2639
|
+
### Errors
|
|
2640
|
+
|
|
2641
|
+
| Error Type | Status Code | Content Type |
|
|
2642
|
+
| --------------- | --------------- | --------------- |
|
|
2643
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2644
|
+
|
|
2645
|
+
## updateCrmDeal
|
|
2646
|
+
|
|
2647
|
+
Update a deal
|
|
2648
|
+
|
|
2649
|
+
### Example Usage
|
|
2650
|
+
|
|
2651
|
+
```typescript
|
|
2652
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2653
|
+
|
|
2654
|
+
const unifiedTo = new UnifiedTo({
|
|
2655
|
+
security: {
|
|
2656
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2657
|
+
},
|
|
2658
|
+
});
|
|
2659
|
+
|
|
2660
|
+
async function run() {
|
|
2661
|
+
const result = await unifiedTo.crm.updateCrmDeal({
|
|
2662
|
+
connectionId: "<value>",
|
|
2663
|
+
id: "<id>",
|
|
2664
|
+
});
|
|
2665
|
+
|
|
2666
|
+
// Handle the result
|
|
2667
|
+
console.log(result);
|
|
2668
|
+
}
|
|
2669
|
+
|
|
2670
|
+
run();
|
|
2671
|
+
```
|
|
2672
|
+
|
|
2673
|
+
### Standalone function
|
|
2674
|
+
|
|
2675
|
+
The standalone function version of this method:
|
|
2676
|
+
|
|
2677
|
+
```typescript
|
|
2678
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2679
|
+
import { crmUpdateCrmDeal } from "@unified-api/typescript-sdk/funcs/crmUpdateCrmDeal.js";
|
|
2680
|
+
|
|
2681
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2682
|
+
// You can create one instance of it to use across an application.
|
|
2683
|
+
const unifiedTo = new UnifiedToCore({
|
|
2684
|
+
security: {
|
|
2685
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2686
|
+
},
|
|
2687
|
+
});
|
|
2688
|
+
|
|
2689
|
+
async function run() {
|
|
2690
|
+
const res = await crmUpdateCrmDeal(unifiedTo, {
|
|
2691
|
+
connectionId: "<value>",
|
|
2692
|
+
id: "<id>",
|
|
2693
|
+
});
|
|
2694
|
+
|
|
2695
|
+
if (!res.ok) {
|
|
2696
|
+
throw res.error;
|
|
2697
|
+
}
|
|
2698
|
+
|
|
2699
|
+
const { value: result } = res;
|
|
2700
|
+
|
|
2701
|
+
// Handle the result
|
|
2702
|
+
console.log(result);
|
|
2703
|
+
}
|
|
2704
|
+
|
|
2705
|
+
run();
|
|
2706
|
+
```
|
|
2707
|
+
|
|
2708
|
+
### Parameters
|
|
2709
|
+
|
|
2710
|
+
| Parameter | Type | Required | Description |
|
|
2711
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2712
|
+
| `request` | [operations.UpdateCrmDealRequest](../../sdk/models/operations/updatecrmdealrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2713
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2714
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2715
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2716
|
+
|
|
2717
|
+
### Response
|
|
2718
|
+
|
|
2719
|
+
**Promise\<[shared.CrmDeal](../../sdk/models/shared/crmdeal.md)\>**
|
|
2720
|
+
|
|
2721
|
+
### Errors
|
|
2722
|
+
|
|
2723
|
+
| Error Type | Status Code | Content Type |
|
|
2724
|
+
| --------------- | --------------- | --------------- |
|
|
2725
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2726
|
+
|
|
2727
|
+
## updateCrmEvent
|
|
2728
|
+
|
|
2729
|
+
Update an event
|
|
2730
|
+
|
|
2731
|
+
### Example Usage
|
|
2732
|
+
|
|
2733
|
+
```typescript
|
|
2734
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2735
|
+
|
|
2736
|
+
const unifiedTo = new UnifiedTo({
|
|
2737
|
+
security: {
|
|
2738
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2739
|
+
},
|
|
2740
|
+
});
|
|
2741
|
+
|
|
2742
|
+
async function run() {
|
|
2743
|
+
const result = await unifiedTo.crm.updateCrmEvent({
|
|
2744
|
+
connectionId: "<value>",
|
|
2745
|
+
id: "<id>",
|
|
2746
|
+
});
|
|
2747
|
+
|
|
2748
|
+
// Handle the result
|
|
2749
|
+
console.log(result);
|
|
2750
|
+
}
|
|
2751
|
+
|
|
2752
|
+
run();
|
|
2753
|
+
```
|
|
2754
|
+
|
|
2755
|
+
### Standalone function
|
|
2756
|
+
|
|
2757
|
+
The standalone function version of this method:
|
|
2758
|
+
|
|
2759
|
+
```typescript
|
|
2760
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2761
|
+
import { crmUpdateCrmEvent } from "@unified-api/typescript-sdk/funcs/crmUpdateCrmEvent.js";
|
|
2762
|
+
|
|
2763
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2764
|
+
// You can create one instance of it to use across an application.
|
|
2765
|
+
const unifiedTo = new UnifiedToCore({
|
|
2766
|
+
security: {
|
|
2767
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2768
|
+
},
|
|
2769
|
+
});
|
|
2770
|
+
|
|
2771
|
+
async function run() {
|
|
2772
|
+
const res = await crmUpdateCrmEvent(unifiedTo, {
|
|
2773
|
+
connectionId: "<value>",
|
|
2774
|
+
id: "<id>",
|
|
2775
|
+
});
|
|
2776
|
+
|
|
2777
|
+
if (!res.ok) {
|
|
2778
|
+
throw res.error;
|
|
2779
|
+
}
|
|
2780
|
+
|
|
2781
|
+
const { value: result } = res;
|
|
2782
|
+
|
|
2783
|
+
// Handle the result
|
|
2784
|
+
console.log(result);
|
|
2785
|
+
}
|
|
2786
|
+
|
|
2787
|
+
run();
|
|
2788
|
+
```
|
|
2789
|
+
|
|
2790
|
+
### Parameters
|
|
2791
|
+
|
|
2792
|
+
| Parameter | Type | Required | Description |
|
|
2793
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2794
|
+
| `request` | [operations.UpdateCrmEventRequest](../../sdk/models/operations/updatecrmeventrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2795
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2796
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2797
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2798
|
+
|
|
2799
|
+
### Response
|
|
2800
|
+
|
|
2801
|
+
**Promise\<[shared.CrmEvent](../../sdk/models/shared/crmevent.md)\>**
|
|
2802
|
+
|
|
2803
|
+
### Errors
|
|
2804
|
+
|
|
2805
|
+
| Error Type | Status Code | Content Type |
|
|
2806
|
+
| --------------- | --------------- | --------------- |
|
|
2807
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2808
|
+
|
|
2809
|
+
## updateCrmLead
|
|
2810
|
+
|
|
2811
|
+
Update a lead
|
|
2812
|
+
|
|
2813
|
+
### Example Usage
|
|
2814
|
+
|
|
2815
|
+
```typescript
|
|
2816
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2817
|
+
|
|
2818
|
+
const unifiedTo = new UnifiedTo({
|
|
2819
|
+
security: {
|
|
2820
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2821
|
+
},
|
|
2822
|
+
});
|
|
2823
|
+
|
|
2824
|
+
async function run() {
|
|
2825
|
+
const result = await unifiedTo.crm.updateCrmLead({
|
|
2826
|
+
connectionId: "<value>",
|
|
2827
|
+
id: "<id>",
|
|
2828
|
+
});
|
|
2829
|
+
|
|
2830
|
+
// Handle the result
|
|
2831
|
+
console.log(result);
|
|
2832
|
+
}
|
|
2833
|
+
|
|
2834
|
+
run();
|
|
2835
|
+
```
|
|
2836
|
+
|
|
2837
|
+
### Standalone function
|
|
2838
|
+
|
|
2839
|
+
The standalone function version of this method:
|
|
2840
|
+
|
|
2841
|
+
```typescript
|
|
2842
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2843
|
+
import { crmUpdateCrmLead } from "@unified-api/typescript-sdk/funcs/crmUpdateCrmLead.js";
|
|
2844
|
+
|
|
2845
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2846
|
+
// You can create one instance of it to use across an application.
|
|
2847
|
+
const unifiedTo = new UnifiedToCore({
|
|
2848
|
+
security: {
|
|
2849
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2850
|
+
},
|
|
2851
|
+
});
|
|
2852
|
+
|
|
2853
|
+
async function run() {
|
|
2854
|
+
const res = await crmUpdateCrmLead(unifiedTo, {
|
|
2855
|
+
connectionId: "<value>",
|
|
2856
|
+
id: "<id>",
|
|
2857
|
+
});
|
|
2858
|
+
|
|
2859
|
+
if (!res.ok) {
|
|
2860
|
+
throw res.error;
|
|
2861
|
+
}
|
|
2862
|
+
|
|
2863
|
+
const { value: result } = res;
|
|
2864
|
+
|
|
2865
|
+
// Handle the result
|
|
2866
|
+
console.log(result);
|
|
2867
|
+
}
|
|
2868
|
+
|
|
2869
|
+
run();
|
|
2870
|
+
```
|
|
2871
|
+
|
|
2872
|
+
### Parameters
|
|
2873
|
+
|
|
2874
|
+
| Parameter | Type | Required | Description |
|
|
2875
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2876
|
+
| `request` | [operations.UpdateCrmLeadRequest](../../sdk/models/operations/updatecrmleadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2877
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2878
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2879
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2880
|
+
|
|
2881
|
+
### Response
|
|
2882
|
+
|
|
2883
|
+
**Promise\<[shared.CrmLead](../../sdk/models/shared/crmlead.md)\>**
|
|
2884
|
+
|
|
2885
|
+
### Errors
|
|
2886
|
+
|
|
2887
|
+
| Error Type | Status Code | Content Type |
|
|
2888
|
+
| --------------- | --------------- | --------------- |
|
|
2889
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2890
|
+
|
|
2891
|
+
## updateCrmPipeline
|
|
2892
|
+
|
|
2893
|
+
Update a pipeline
|
|
2894
|
+
|
|
2895
|
+
### Example Usage
|
|
2896
|
+
|
|
2897
|
+
```typescript
|
|
2898
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
2899
|
+
|
|
2900
|
+
const unifiedTo = new UnifiedTo({
|
|
2901
|
+
security: {
|
|
2902
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2903
|
+
},
|
|
2904
|
+
});
|
|
2905
|
+
|
|
2906
|
+
async function run() {
|
|
2907
|
+
const result = await unifiedTo.crm.updateCrmPipeline({
|
|
2908
|
+
connectionId: "<value>",
|
|
2909
|
+
id: "<id>",
|
|
2910
|
+
});
|
|
2911
|
+
|
|
2912
|
+
// Handle the result
|
|
2913
|
+
console.log(result);
|
|
2914
|
+
}
|
|
2915
|
+
|
|
2916
|
+
run();
|
|
2917
|
+
```
|
|
2918
|
+
|
|
2919
|
+
### Standalone function
|
|
2920
|
+
|
|
2921
|
+
The standalone function version of this method:
|
|
2922
|
+
|
|
2923
|
+
```typescript
|
|
2924
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
2925
|
+
import { crmUpdateCrmPipeline } from "@unified-api/typescript-sdk/funcs/crmUpdateCrmPipeline.js";
|
|
2926
|
+
|
|
2927
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
2928
|
+
// You can create one instance of it to use across an application.
|
|
2929
|
+
const unifiedTo = new UnifiedToCore({
|
|
2930
|
+
security: {
|
|
2931
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
2932
|
+
},
|
|
2933
|
+
});
|
|
2934
|
+
|
|
2935
|
+
async function run() {
|
|
2936
|
+
const res = await crmUpdateCrmPipeline(unifiedTo, {
|
|
2937
|
+
connectionId: "<value>",
|
|
2938
|
+
id: "<id>",
|
|
2939
|
+
});
|
|
2940
|
+
|
|
2941
|
+
if (!res.ok) {
|
|
2942
|
+
throw res.error;
|
|
2943
|
+
}
|
|
2944
|
+
|
|
2945
|
+
const { value: result } = res;
|
|
2946
|
+
|
|
2947
|
+
// Handle the result
|
|
2948
|
+
console.log(result);
|
|
2949
|
+
}
|
|
2950
|
+
|
|
2951
|
+
run();
|
|
2952
|
+
```
|
|
2953
|
+
|
|
2954
|
+
### Parameters
|
|
2955
|
+
|
|
2956
|
+
| Parameter | Type | Required | Description |
|
|
2957
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2958
|
+
| `request` | [operations.UpdateCrmPipelineRequest](../../sdk/models/operations/updatecrmpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2959
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2960
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2961
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2962
|
+
|
|
2963
|
+
### Response
|
|
2964
|
+
|
|
2965
|
+
**Promise\<[shared.CrmPipeline](../../sdk/models/shared/crmpipeline.md)\>**
|
|
2966
|
+
|
|
2967
|
+
### Errors
|
|
2968
|
+
|
|
2969
|
+
| Error Type | Status Code | Content Type |
|
|
2970
|
+
| --------------- | --------------- | --------------- |
|
|
2971
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|