@puppi/adapter-pipedrive 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +25 -2
- package/dist/define.d.ts +19 -0
- package/dist/define.d.ts.map +1 -0
- package/dist/define.js +11 -0
- package/dist/define.js.map +1 -0
- package/dist/index.d.ts +212 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +123 -0
- package/dist/index.js.map +1 -0
- package/dist/openapi.d.ts +1311 -0
- package/dist/openapi.d.ts.map +1 -0
- package/dist/openapi.js +6 -0
- package/dist/openapi.js.map +1 -0
- package/dist/operations.d.ts +16 -0
- package/dist/operations.d.ts.map +1 -0
- package/dist/operations.js +104 -0
- package/dist/operations.js.map +1 -0
- package/package.json +48 -3
|
@@ -0,0 +1,1311 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export type paths = {
|
|
6
|
+
"/deals": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Get all deals
|
|
15
|
+
* @description Returns data about all not archived deals.
|
|
16
|
+
*/
|
|
17
|
+
get: operations["getDeals"];
|
|
18
|
+
put?: never;
|
|
19
|
+
post?: never;
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/persons": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Get all persons
|
|
35
|
+
* @description Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
36
|
+
*/
|
|
37
|
+
get: operations["getPersons"];
|
|
38
|
+
put?: never;
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
"/organizations": {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* Get all organizations
|
|
55
|
+
* @description Returns data about all organizations.
|
|
56
|
+
*/
|
|
57
|
+
get: operations["getOrganizations"];
|
|
58
|
+
put?: never;
|
|
59
|
+
post?: never;
|
|
60
|
+
delete?: never;
|
|
61
|
+
options?: never;
|
|
62
|
+
head?: never;
|
|
63
|
+
patch?: never;
|
|
64
|
+
trace?: never;
|
|
65
|
+
};
|
|
66
|
+
"/activities": {
|
|
67
|
+
parameters: {
|
|
68
|
+
query?: never;
|
|
69
|
+
header?: never;
|
|
70
|
+
path?: never;
|
|
71
|
+
cookie?: never;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* Get all activities
|
|
75
|
+
* @description Returns data about all activities.
|
|
76
|
+
*/
|
|
77
|
+
get: operations["getActivities"];
|
|
78
|
+
put?: never;
|
|
79
|
+
post?: never;
|
|
80
|
+
delete?: never;
|
|
81
|
+
options?: never;
|
|
82
|
+
head?: never;
|
|
83
|
+
patch?: never;
|
|
84
|
+
trace?: never;
|
|
85
|
+
};
|
|
86
|
+
"/pipelines": {
|
|
87
|
+
parameters: {
|
|
88
|
+
query?: never;
|
|
89
|
+
header?: never;
|
|
90
|
+
path?: never;
|
|
91
|
+
cookie?: never;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* Get all pipelines
|
|
95
|
+
* @description Returns data about all pipelines.
|
|
96
|
+
*/
|
|
97
|
+
get: operations["getPipelines"];
|
|
98
|
+
put?: never;
|
|
99
|
+
post?: never;
|
|
100
|
+
delete?: never;
|
|
101
|
+
options?: never;
|
|
102
|
+
head?: never;
|
|
103
|
+
patch?: never;
|
|
104
|
+
trace?: never;
|
|
105
|
+
};
|
|
106
|
+
"/stages": {
|
|
107
|
+
parameters: {
|
|
108
|
+
query?: never;
|
|
109
|
+
header?: never;
|
|
110
|
+
path?: never;
|
|
111
|
+
cookie?: never;
|
|
112
|
+
};
|
|
113
|
+
/**
|
|
114
|
+
* Get all stages
|
|
115
|
+
* @description Returns data about all stages.
|
|
116
|
+
*/
|
|
117
|
+
get: operations["getStages"];
|
|
118
|
+
put?: never;
|
|
119
|
+
post?: never;
|
|
120
|
+
delete?: never;
|
|
121
|
+
options?: never;
|
|
122
|
+
head?: never;
|
|
123
|
+
patch?: never;
|
|
124
|
+
trace?: never;
|
|
125
|
+
};
|
|
126
|
+
"/users/me": {
|
|
127
|
+
parameters: {
|
|
128
|
+
query?: never;
|
|
129
|
+
header?: never;
|
|
130
|
+
path?: never;
|
|
131
|
+
cookie?: never;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* Get current user data
|
|
135
|
+
* @description Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means 'Date/number format' in the Pipedrive account settings, not the chosen language.
|
|
136
|
+
*/
|
|
137
|
+
get: operations["getCurrentUser"];
|
|
138
|
+
put?: never;
|
|
139
|
+
post?: never;
|
|
140
|
+
delete?: never;
|
|
141
|
+
options?: never;
|
|
142
|
+
head?: never;
|
|
143
|
+
patch?: never;
|
|
144
|
+
trace?: never;
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
export type webhooks = Record<string, never>;
|
|
148
|
+
export type components = {
|
|
149
|
+
schemas: never;
|
|
150
|
+
responses: never;
|
|
151
|
+
parameters: never;
|
|
152
|
+
requestBodies: never;
|
|
153
|
+
headers: never;
|
|
154
|
+
pathItems: never;
|
|
155
|
+
};
|
|
156
|
+
export type $defs = Record<string, never>;
|
|
157
|
+
export interface operations {
|
|
158
|
+
getDeals: {
|
|
159
|
+
parameters: {
|
|
160
|
+
query?: {
|
|
161
|
+
/** @description If supplied, only deals matching the specified filter are returned */
|
|
162
|
+
filter_id?: number;
|
|
163
|
+
/** @description Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. */
|
|
164
|
+
ids?: number[];
|
|
165
|
+
/** @description If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored. */
|
|
166
|
+
owner_id?: number;
|
|
167
|
+
/** @description If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored. */
|
|
168
|
+
person_id?: number;
|
|
169
|
+
/** @description If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored. */
|
|
170
|
+
org_id?: number;
|
|
171
|
+
/** @description If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored. */
|
|
172
|
+
pipeline_id?: number;
|
|
173
|
+
/** @description If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored. */
|
|
174
|
+
stage_id?: number;
|
|
175
|
+
/** @description Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored. */
|
|
176
|
+
status?: ("open" | "won" | "lost" | "deleted")[];
|
|
177
|
+
/** @description If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
178
|
+
updated_since?: string;
|
|
179
|
+
/** @description If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
180
|
+
updated_until?: string;
|
|
181
|
+
/** @description The field to sort by. Supported fields: `id`, `update_time`, `add_time`. */
|
|
182
|
+
sort_by?: "id" | "update_time" | "add_time";
|
|
183
|
+
/** @description The sorting direction. Supported values: `asc`, `desc`. */
|
|
184
|
+
sort_direction?: "asc" | "desc";
|
|
185
|
+
/** @description Optional comma separated string array of additional fields to include */
|
|
186
|
+
include_fields?: ("next_activity_id" | "last_activity_id" | "first_won_time" | "products_count" | "files_count" | "notes_count" | "followers_count" | "email_messages_count" | "activities_count" | "done_activities_count" | "undone_activities_count" | "participants_count" | "last_incoming_mail_time" | "last_outgoing_mail_time" | "smart_bcc_email" | "source_lead_id")[];
|
|
187
|
+
/** @description Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. */
|
|
188
|
+
custom_fields?: string[];
|
|
189
|
+
/** @description When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id */
|
|
190
|
+
include_option_labels?: boolean;
|
|
191
|
+
/** @description When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' */
|
|
192
|
+
include_labels?: boolean;
|
|
193
|
+
/** @description For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. */
|
|
194
|
+
limit?: number;
|
|
195
|
+
/** @description For pagination, the marker (an opaque string value) representing the first item on the next page */
|
|
196
|
+
cursor?: string;
|
|
197
|
+
};
|
|
198
|
+
header?: never;
|
|
199
|
+
path?: never;
|
|
200
|
+
cookie?: never;
|
|
201
|
+
};
|
|
202
|
+
requestBody?: never;
|
|
203
|
+
responses: {
|
|
204
|
+
/** @description Get all not archived deals */
|
|
205
|
+
200: {
|
|
206
|
+
headers: {
|
|
207
|
+
[name: string]: unknown;
|
|
208
|
+
};
|
|
209
|
+
content: {
|
|
210
|
+
/**
|
|
211
|
+
* @example {
|
|
212
|
+
* "success": true,
|
|
213
|
+
* "data": [
|
|
214
|
+
* {
|
|
215
|
+
* "id": 1,
|
|
216
|
+
* "title": "Deal Title",
|
|
217
|
+
* "creator_user_id": 1,
|
|
218
|
+
* "owner_id": 1,
|
|
219
|
+
* "value": 200,
|
|
220
|
+
* "person_id": 1,
|
|
221
|
+
* "org_id": 1,
|
|
222
|
+
* "stage_id": 1,
|
|
223
|
+
* "pipeline_id": 1,
|
|
224
|
+
* "currency": "USD",
|
|
225
|
+
* "archive_time": "2021-01-01T00:00:00Z",
|
|
226
|
+
* "add_time": "2021-01-01T00:00:00Z",
|
|
227
|
+
* "update_time": "2021-01-01T00:00:00Z",
|
|
228
|
+
* "stage_change_time": "2021-01-01T00:00:00Z",
|
|
229
|
+
* "status": "open",
|
|
230
|
+
* "is_archived": false,
|
|
231
|
+
* "is_deleted": false,
|
|
232
|
+
* "probability": 90,
|
|
233
|
+
* "lost_reason": "Lost Reason",
|
|
234
|
+
* "visible_to": 7,
|
|
235
|
+
* "close_time": "2021-01-01T00:00:00Z",
|
|
236
|
+
* "won_time": "2021-01-01T00:00:00Z",
|
|
237
|
+
* "lost_time": "2021-01-01T00:00:00Z",
|
|
238
|
+
* "local_won_date": "2021-01-01",
|
|
239
|
+
* "local_lost_date": "2021-01-01",
|
|
240
|
+
* "local_close_date": "2021-01-01",
|
|
241
|
+
* "expected_close_date": "2021-01-01",
|
|
242
|
+
* "label_ids": [
|
|
243
|
+
* 1,
|
|
244
|
+
* 2,
|
|
245
|
+
* 3
|
|
246
|
+
* ],
|
|
247
|
+
* "origin": "ManuallyCreated",
|
|
248
|
+
* "origin_id": null,
|
|
249
|
+
* "channel": 52,
|
|
250
|
+
* "channel_id": "Jun23 Billboards",
|
|
251
|
+
* "source_lead_id": "35b0d604-eb0d-42d0-be11-eac8832051f0",
|
|
252
|
+
* "acv": 120,
|
|
253
|
+
* "arr": 120,
|
|
254
|
+
* "mrr": 10,
|
|
255
|
+
* "custom_fields": {}
|
|
256
|
+
* }
|
|
257
|
+
* ],
|
|
258
|
+
* "additional_data": {
|
|
259
|
+
* "next_cursor": "eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"
|
|
260
|
+
* }
|
|
261
|
+
* }
|
|
262
|
+
*/
|
|
263
|
+
"application/json": {
|
|
264
|
+
/** @description If the response is successful or not */
|
|
265
|
+
success?: boolean;
|
|
266
|
+
} & {
|
|
267
|
+
/** @description Deals array */
|
|
268
|
+
data?: {
|
|
269
|
+
/** @description The ID of the deal */
|
|
270
|
+
id?: number;
|
|
271
|
+
/** @description The title of the deal */
|
|
272
|
+
title?: string;
|
|
273
|
+
/** @description The ID of the user who owns the deal */
|
|
274
|
+
owner_id?: number;
|
|
275
|
+
/** @description The ID of the person linked to the deal */
|
|
276
|
+
person_id?: number | null;
|
|
277
|
+
/** @description The ID of the organization linked to the deal */
|
|
278
|
+
org_id?: number | null;
|
|
279
|
+
/** @description The ID of the pipeline associated with the deal */
|
|
280
|
+
pipeline_id?: number;
|
|
281
|
+
/** @description The ID of the deal stage */
|
|
282
|
+
stage_id?: number;
|
|
283
|
+
/** @description The value of the deal */
|
|
284
|
+
value?: number;
|
|
285
|
+
/** @description The currency associated with the deal */
|
|
286
|
+
currency?: string;
|
|
287
|
+
/** @description The creation date and time of the deal */
|
|
288
|
+
add_time?: string;
|
|
289
|
+
/** @description The last updated date and time of the deal */
|
|
290
|
+
update_time?: string | null;
|
|
291
|
+
/** @description The last updated date and time of the deal stage */
|
|
292
|
+
stage_change_time?: string | null;
|
|
293
|
+
/** @description Whether the deal is deleted or not */
|
|
294
|
+
is_deleted?: boolean;
|
|
295
|
+
/** @description Whether the deal is archived or not */
|
|
296
|
+
is_archived?: boolean;
|
|
297
|
+
/** @description The status of the deal */
|
|
298
|
+
status?: string;
|
|
299
|
+
/** @description The success probability percentage of the deal */
|
|
300
|
+
probability?: number | null;
|
|
301
|
+
/** @description The reason for losing the deal */
|
|
302
|
+
lost_reason?: string | null;
|
|
303
|
+
/** @description The visibility of the deal */
|
|
304
|
+
visible_to?: number;
|
|
305
|
+
/** @description The date and time of closing the deal */
|
|
306
|
+
close_time?: string | null;
|
|
307
|
+
/** @description The date and time of changing the deal status as won */
|
|
308
|
+
won_time?: string | null;
|
|
309
|
+
/** @description The date and time of changing the deal status as lost */
|
|
310
|
+
lost_time?: string | null;
|
|
311
|
+
/**
|
|
312
|
+
* Format: date
|
|
313
|
+
* @description The expected close date of the deal
|
|
314
|
+
*/
|
|
315
|
+
expected_close_date?: string | null;
|
|
316
|
+
/** @description The IDs of labels assigned to the deal */
|
|
317
|
+
label_ids?: number[];
|
|
318
|
+
/** @description The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. */
|
|
319
|
+
origin?: string;
|
|
320
|
+
/** @description The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. */
|
|
321
|
+
origin_id?: string | null;
|
|
322
|
+
/** @description The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href="https://app.pipedrive.com/settings/fields" target="_blank" rel="noopener noreferrer">Company settings</a>. */
|
|
323
|
+
channel?: number | null;
|
|
324
|
+
/** @description The optional ID to further distinguish the Marketing channel. */
|
|
325
|
+
channel_id?: string | null;
|
|
326
|
+
/**
|
|
327
|
+
* Format: uuid
|
|
328
|
+
* @description The ID of the lead if the deal was converted from a lead. Only included when requested via include_fields parameter.
|
|
329
|
+
*/
|
|
330
|
+
source_lead_id?: string | null;
|
|
331
|
+
/**
|
|
332
|
+
* @description Only available in Growth and above plans
|
|
333
|
+
*
|
|
334
|
+
* The Annual Recurring Revenue of the deal
|
|
335
|
+
*
|
|
336
|
+
* Null if there are no products attached to the deal
|
|
337
|
+
*/
|
|
338
|
+
arr?: number | null;
|
|
339
|
+
/**
|
|
340
|
+
* @description Only available in Growth and above plans
|
|
341
|
+
*
|
|
342
|
+
* The Monthly Recurring Revenue of the deal
|
|
343
|
+
*
|
|
344
|
+
* Null if there are no products attached to the deal
|
|
345
|
+
*/
|
|
346
|
+
mrr?: number | null;
|
|
347
|
+
/**
|
|
348
|
+
* @description Only available in Growth and above plans
|
|
349
|
+
*
|
|
350
|
+
* The Annual Contract Value of the deal
|
|
351
|
+
*
|
|
352
|
+
* Null if there are no products attached to the deal
|
|
353
|
+
*/
|
|
354
|
+
acv?: number | null;
|
|
355
|
+
/** @description An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error. */
|
|
356
|
+
custom_fields?: {
|
|
357
|
+
[key: string]: unknown;
|
|
358
|
+
};
|
|
359
|
+
}[];
|
|
360
|
+
/** @description The additional data of the list */
|
|
361
|
+
additional_data?: {
|
|
362
|
+
/** @description The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. */
|
|
363
|
+
next_cursor?: string | null;
|
|
364
|
+
};
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
};
|
|
370
|
+
getPersons: {
|
|
371
|
+
parameters: {
|
|
372
|
+
query?: {
|
|
373
|
+
/** @description If supplied, only persons matching the specified filter are returned */
|
|
374
|
+
filter_id?: number;
|
|
375
|
+
/** @description Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. */
|
|
376
|
+
ids?: number[];
|
|
377
|
+
/** @description If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. */
|
|
378
|
+
owner_id?: number;
|
|
379
|
+
/** @description If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. */
|
|
380
|
+
org_id?: number;
|
|
381
|
+
/** @description If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. */
|
|
382
|
+
deal_id?: number;
|
|
383
|
+
/** @description If set, only persons with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
384
|
+
updated_since?: string;
|
|
385
|
+
/** @description If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
386
|
+
updated_until?: string;
|
|
387
|
+
/** @description The field to sort by. Supported fields: `id`, `update_time`, `add_time`. */
|
|
388
|
+
sort_by?: "id" | "update_time" | "add_time";
|
|
389
|
+
/** @description The sorting direction. Supported values: `asc`, `desc`. */
|
|
390
|
+
sort_direction?: "asc" | "desc";
|
|
391
|
+
/** @description Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. */
|
|
392
|
+
include_fields?: ("next_activity_id" | "last_activity_id" | "open_deals_count" | "related_open_deals_count" | "closed_deals_count" | "related_closed_deals_count" | "participant_open_deals_count" | "participant_closed_deals_count" | "email_messages_count" | "activities_count" | "done_activities_count" | "undone_activities_count" | "files_count" | "notes_count" | "followers_count" | "won_deals_count" | "related_won_deals_count" | "lost_deals_count" | "related_lost_deals_count" | "last_incoming_mail_time" | "last_outgoing_mail_time" | "marketing_status" | "doi_status" | "smart_bcc_email")[];
|
|
393
|
+
/** @description Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. */
|
|
394
|
+
custom_fields?: string[];
|
|
395
|
+
/** @description When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id */
|
|
396
|
+
include_option_labels?: boolean;
|
|
397
|
+
/** @description When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' */
|
|
398
|
+
include_labels?: boolean;
|
|
399
|
+
/** @description For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. */
|
|
400
|
+
limit?: number;
|
|
401
|
+
/** @description For pagination, the marker (an opaque string value) representing the first item on the next page */
|
|
402
|
+
cursor?: string;
|
|
403
|
+
};
|
|
404
|
+
header?: never;
|
|
405
|
+
path?: never;
|
|
406
|
+
cookie?: never;
|
|
407
|
+
};
|
|
408
|
+
requestBody?: never;
|
|
409
|
+
responses: {
|
|
410
|
+
/** @description Get all persons */
|
|
411
|
+
200: {
|
|
412
|
+
headers: {
|
|
413
|
+
[name: string]: unknown;
|
|
414
|
+
};
|
|
415
|
+
content: {
|
|
416
|
+
/**
|
|
417
|
+
* @example {
|
|
418
|
+
* "success": true,
|
|
419
|
+
* "data": [
|
|
420
|
+
* {
|
|
421
|
+
* "id": 1,
|
|
422
|
+
* "name": "Person Name",
|
|
423
|
+
* "first_name": "Person",
|
|
424
|
+
* "last_name": "Name",
|
|
425
|
+
* "owner_id": 1,
|
|
426
|
+
* "org_id": 1,
|
|
427
|
+
* "add_time": "2021-01-01T00:00:00Z",
|
|
428
|
+
* "update_time": "2021-01-01T00:00:00Z",
|
|
429
|
+
* "emails": [
|
|
430
|
+
* {
|
|
431
|
+
* "value": "email1@email.com",
|
|
432
|
+
* "primary": true,
|
|
433
|
+
* "label": "work"
|
|
434
|
+
* },
|
|
435
|
+
* {
|
|
436
|
+
* "value": "email2@email.com",
|
|
437
|
+
* "primary": false,
|
|
438
|
+
* "label": "home"
|
|
439
|
+
* }
|
|
440
|
+
* ],
|
|
441
|
+
* "phones": [
|
|
442
|
+
* {
|
|
443
|
+
* "value": "12345",
|
|
444
|
+
* "primary": true,
|
|
445
|
+
* "label": "work"
|
|
446
|
+
* },
|
|
447
|
+
* {
|
|
448
|
+
* "value": "54321",
|
|
449
|
+
* "primary": false,
|
|
450
|
+
* "label": "home"
|
|
451
|
+
* }
|
|
452
|
+
* ],
|
|
453
|
+
* "is_deleted": false,
|
|
454
|
+
* "visible_to": 7,
|
|
455
|
+
* "label_ids": [
|
|
456
|
+
* 1,
|
|
457
|
+
* 2,
|
|
458
|
+
* 3
|
|
459
|
+
* ],
|
|
460
|
+
* "picture_id": 1,
|
|
461
|
+
* "custom_fields": {},
|
|
462
|
+
* "notes": "Notes from contact sync",
|
|
463
|
+
* "im": [
|
|
464
|
+
* {
|
|
465
|
+
* "value": "skypeusername",
|
|
466
|
+
* "primary": true,
|
|
467
|
+
* "label": "skype"
|
|
468
|
+
* },
|
|
469
|
+
* {
|
|
470
|
+
* "value": "whatsappusername",
|
|
471
|
+
* "primary": false,
|
|
472
|
+
* "label": "whatsapp"
|
|
473
|
+
* }
|
|
474
|
+
* ],
|
|
475
|
+
* "birthday": "2000-12-31",
|
|
476
|
+
* "job_title": "Manager",
|
|
477
|
+
* "postal_address": {
|
|
478
|
+
* "value": "123 Main St",
|
|
479
|
+
* "country": "USA",
|
|
480
|
+
* "admin_area_level_1": "CA",
|
|
481
|
+
* "admin_area_level_2": "Santa Clara",
|
|
482
|
+
* "locality": "Sunnyvale",
|
|
483
|
+
* "sublocality": "Downtown",
|
|
484
|
+
* "route": "Main St",
|
|
485
|
+
* "street_number": "123",
|
|
486
|
+
* "subpremise": "Apt 1",
|
|
487
|
+
* "postal_code": "94085"
|
|
488
|
+
* }
|
|
489
|
+
* }
|
|
490
|
+
* ],
|
|
491
|
+
* "additional_data": {
|
|
492
|
+
* "next_cursor": "eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"
|
|
493
|
+
* }
|
|
494
|
+
* }
|
|
495
|
+
*/
|
|
496
|
+
"application/json": {
|
|
497
|
+
/** @description If the response is successful or not */
|
|
498
|
+
success?: boolean;
|
|
499
|
+
} & {
|
|
500
|
+
/** @description Persons array */
|
|
501
|
+
data?: {
|
|
502
|
+
/** @description The ID of the person */
|
|
503
|
+
id?: number;
|
|
504
|
+
/** @description The name of the person */
|
|
505
|
+
name?: string;
|
|
506
|
+
/** @description The first name of the person */
|
|
507
|
+
first_name?: string;
|
|
508
|
+
/** @description The last name of the person */
|
|
509
|
+
last_name?: string;
|
|
510
|
+
/** @description The ID of the user who owns the person */
|
|
511
|
+
owner_id?: number;
|
|
512
|
+
/** @description The ID of the organization linked to the person */
|
|
513
|
+
org_id?: number;
|
|
514
|
+
/** @description The creation date and time of the person */
|
|
515
|
+
add_time?: string;
|
|
516
|
+
/** @description The last updated date and time of the person */
|
|
517
|
+
update_time?: string | null;
|
|
518
|
+
/** @description The emails of the person */
|
|
519
|
+
emails?: {
|
|
520
|
+
/** @description The email address of the person */
|
|
521
|
+
value?: string;
|
|
522
|
+
/** @description Whether the email is primary or not */
|
|
523
|
+
primary?: boolean;
|
|
524
|
+
/** @description The email address classification label */
|
|
525
|
+
label?: string;
|
|
526
|
+
}[];
|
|
527
|
+
/** @description The phones of the person */
|
|
528
|
+
phones?: {
|
|
529
|
+
/** @description The phone number of the person */
|
|
530
|
+
value?: string;
|
|
531
|
+
/** @description Whether the phone number is primary or not */
|
|
532
|
+
primary?: boolean;
|
|
533
|
+
/** @description The phone number classification label */
|
|
534
|
+
label?: string;
|
|
535
|
+
}[];
|
|
536
|
+
/** @description Whether the person is deleted or not */
|
|
537
|
+
is_deleted?: boolean;
|
|
538
|
+
/** @description The visibility of the person */
|
|
539
|
+
visible_to?: number;
|
|
540
|
+
/** @description The IDs of labels assigned to the person */
|
|
541
|
+
label_ids?: number[];
|
|
542
|
+
/** @description The ID of the picture associated with the person */
|
|
543
|
+
picture_id?: number | null;
|
|
544
|
+
/**
|
|
545
|
+
* PersonItemAddress
|
|
546
|
+
* @description Postal address of the person, included if contact sync is enabled for the company
|
|
547
|
+
*/
|
|
548
|
+
postal_address?: {
|
|
549
|
+
/** @description The full address of the person */
|
|
550
|
+
value?: string;
|
|
551
|
+
/** @description Country of the person */
|
|
552
|
+
country?: string | null;
|
|
553
|
+
/** @description Admin area level 1 (e.g. state) of the person */
|
|
554
|
+
admin_area_level_1?: string | null;
|
|
555
|
+
/** @description Admin area level 2 (e.g. county) of the person */
|
|
556
|
+
admin_area_level_2?: string | null;
|
|
557
|
+
/** @description Locality (e.g. city) of the person */
|
|
558
|
+
locality?: string | null;
|
|
559
|
+
/** @description Sublocality (e.g. neighborhood) of the person */
|
|
560
|
+
sublocality?: string | null;
|
|
561
|
+
/** @description Route (e.g. street) of the person */
|
|
562
|
+
route?: string | null;
|
|
563
|
+
/** @description Street number of the person */
|
|
564
|
+
street_number?: string | null;
|
|
565
|
+
/** @description Subpremise (e.g. apartment/suite number) of the person */
|
|
566
|
+
subpremise?: string | null;
|
|
567
|
+
/** @description Postal code of the person */
|
|
568
|
+
postal_code?: string | null;
|
|
569
|
+
} | null;
|
|
570
|
+
/** @description Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company */
|
|
571
|
+
notes?: string;
|
|
572
|
+
/** @description The instant messaging accounts of the person, included if contact sync is enabled for the company */
|
|
573
|
+
im?: {
|
|
574
|
+
/** @description The instant messaging account of the person */
|
|
575
|
+
value?: string;
|
|
576
|
+
/** @description Whether the instant messaging account is primary or not */
|
|
577
|
+
primary?: boolean;
|
|
578
|
+
/** @description The instant messaging account classification label */
|
|
579
|
+
label?: string;
|
|
580
|
+
}[];
|
|
581
|
+
/** @description The birthday of the person, included if contact sync is enabled for the company */
|
|
582
|
+
birthday?: string;
|
|
583
|
+
/** @description The job title of the person, included if contact sync is enabled for the company */
|
|
584
|
+
job_title?: string;
|
|
585
|
+
/** @description An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error. */
|
|
586
|
+
custom_fields?: {
|
|
587
|
+
[key: string]: unknown;
|
|
588
|
+
};
|
|
589
|
+
}[];
|
|
590
|
+
/** @description The additional data of the list */
|
|
591
|
+
additional_data?: {
|
|
592
|
+
/** @description The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. */
|
|
593
|
+
next_cursor?: string | null;
|
|
594
|
+
};
|
|
595
|
+
};
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
getOrganizations: {
|
|
601
|
+
parameters: {
|
|
602
|
+
query?: {
|
|
603
|
+
/** @description If supplied, only organizations matching the specified filter are returned */
|
|
604
|
+
filter_id?: number;
|
|
605
|
+
/** @description Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. */
|
|
606
|
+
ids?: number[];
|
|
607
|
+
/** @description If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. */
|
|
608
|
+
owner_id?: number;
|
|
609
|
+
/** @description If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
610
|
+
updated_since?: string;
|
|
611
|
+
/** @description If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
612
|
+
updated_until?: string;
|
|
613
|
+
/** @description The field to sort by. Supported fields: `id`, `update_time`, `add_time`. */
|
|
614
|
+
sort_by?: "id" | "update_time" | "add_time";
|
|
615
|
+
/** @description The sorting direction. Supported values: `asc`, `desc`. */
|
|
616
|
+
sort_direction?: "asc" | "desc";
|
|
617
|
+
/** @description Optional comma separated string array of additional fields to include */
|
|
618
|
+
include_fields?: ("next_activity_id" | "last_activity_id" | "open_deals_count" | "related_open_deals_count" | "closed_deals_count" | "related_closed_deals_count" | "email_messages_count" | "people_count" | "activities_count" | "done_activities_count" | "undone_activities_count" | "files_count" | "notes_count" | "followers_count" | "won_deals_count" | "related_won_deals_count" | "lost_deals_count" | "related_lost_deals_count" | "smart_bcc_email")[];
|
|
619
|
+
/** @description Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. */
|
|
620
|
+
custom_fields?: string[];
|
|
621
|
+
/** @description When provided with a 'true' value, single option and multiple option custom fields values contain objects in the form of '{ id: number, label: string }' instead of plain id */
|
|
622
|
+
include_option_labels?: boolean;
|
|
623
|
+
/** @description When provided with 'true' value, response will include an array of label objects in the form of '{ id: number, label: string }' */
|
|
624
|
+
include_labels?: boolean;
|
|
625
|
+
/** @description For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. */
|
|
626
|
+
limit?: number;
|
|
627
|
+
/** @description For pagination, the marker (an opaque string value) representing the first item on the next page */
|
|
628
|
+
cursor?: string;
|
|
629
|
+
};
|
|
630
|
+
header?: never;
|
|
631
|
+
path?: never;
|
|
632
|
+
cookie?: never;
|
|
633
|
+
};
|
|
634
|
+
requestBody?: never;
|
|
635
|
+
responses: {
|
|
636
|
+
/** @description Get all organizations */
|
|
637
|
+
200: {
|
|
638
|
+
headers: {
|
|
639
|
+
[name: string]: unknown;
|
|
640
|
+
};
|
|
641
|
+
content: {
|
|
642
|
+
/**
|
|
643
|
+
* @example {
|
|
644
|
+
* "success": true,
|
|
645
|
+
* "data": [
|
|
646
|
+
* {
|
|
647
|
+
* "id": 1,
|
|
648
|
+
* "name": "Organization Name",
|
|
649
|
+
* "owner_id": 1,
|
|
650
|
+
* "org_id": 1,
|
|
651
|
+
* "add_time": "2021-01-01T00:00:00Z",
|
|
652
|
+
* "update_time": "2021-01-01T00:00:00Z",
|
|
653
|
+
* "address": {
|
|
654
|
+
* "value": "123 Main St",
|
|
655
|
+
* "country": "USA",
|
|
656
|
+
* "admin_area_level_1": "CA",
|
|
657
|
+
* "admin_area_level_2": "Santa Clara",
|
|
658
|
+
* "locality": "Sunnyvale",
|
|
659
|
+
* "sublocality": "Downtown",
|
|
660
|
+
* "route": "Main St",
|
|
661
|
+
* "street_number": "123",
|
|
662
|
+
* "subpremise": "123A",
|
|
663
|
+
* "postal_code": "94085"
|
|
664
|
+
* },
|
|
665
|
+
* "is_deleted": false,
|
|
666
|
+
* "visible_to": 7,
|
|
667
|
+
* "label_ids": [
|
|
668
|
+
* 1,
|
|
669
|
+
* 2,
|
|
670
|
+
* 3
|
|
671
|
+
* ],
|
|
672
|
+
* "website": "https://www.company.com",
|
|
673
|
+
* "linkedin": "https://linkedin.com/company",
|
|
674
|
+
* "industry": 2,
|
|
675
|
+
* "annual_revenue": 0,
|
|
676
|
+
* "employee_count": 10,
|
|
677
|
+
* "custom_fields": {}
|
|
678
|
+
* }
|
|
679
|
+
* ],
|
|
680
|
+
* "additional_data": {
|
|
681
|
+
* "next_cursor": "eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"
|
|
682
|
+
* }
|
|
683
|
+
* }
|
|
684
|
+
*/
|
|
685
|
+
"application/json": {
|
|
686
|
+
/** @description If the response is successful or not */
|
|
687
|
+
success?: boolean;
|
|
688
|
+
} & {
|
|
689
|
+
/** @description Organizations array */
|
|
690
|
+
data?: {
|
|
691
|
+
/** @description The ID of the organization */
|
|
692
|
+
id?: number;
|
|
693
|
+
/** @description The name of the organization */
|
|
694
|
+
name?: string;
|
|
695
|
+
/** @description The ID of the user who owns the organization */
|
|
696
|
+
owner_id?: number;
|
|
697
|
+
/** @description The creation date and time of the organization */
|
|
698
|
+
add_time?: string;
|
|
699
|
+
/** @description The last updated date and time of the organization */
|
|
700
|
+
update_time?: string | null;
|
|
701
|
+
/** @description Whether the organization is deleted or not */
|
|
702
|
+
is_deleted?: boolean;
|
|
703
|
+
/** @description The visibility of the organization */
|
|
704
|
+
visible_to?: number;
|
|
705
|
+
/**
|
|
706
|
+
* OrganizationItemAddress
|
|
707
|
+
* @description The address of the organization
|
|
708
|
+
*/
|
|
709
|
+
address?: {
|
|
710
|
+
/** @description The full address of the organization */
|
|
711
|
+
value?: string;
|
|
712
|
+
/** @description Country of the organization */
|
|
713
|
+
country?: string | null;
|
|
714
|
+
/** @description Admin area level 1 (e.g. state) of the organization */
|
|
715
|
+
admin_area_level_1?: string | null;
|
|
716
|
+
/** @description Admin area level 2 (e.g. county) of the organization */
|
|
717
|
+
admin_area_level_2?: string | null;
|
|
718
|
+
/** @description Locality (e.g. city) of the organization */
|
|
719
|
+
locality?: string | null;
|
|
720
|
+
/** @description Sublocality (e.g. neighborhood) of the organization */
|
|
721
|
+
sublocality?: string | null;
|
|
722
|
+
/** @description Route (e.g. street) of the organization */
|
|
723
|
+
route?: string | null;
|
|
724
|
+
/** @description Street number of the organization */
|
|
725
|
+
street_number?: string | null;
|
|
726
|
+
/** @description Subpremise (e.g. apartment/suite number) of the organization */
|
|
727
|
+
subpremise?: string | null;
|
|
728
|
+
/** @description Postal code of the organization */
|
|
729
|
+
postal_code?: string | null;
|
|
730
|
+
} | null;
|
|
731
|
+
/** @description The IDs of labels assigned to the organization */
|
|
732
|
+
label_ids?: number[];
|
|
733
|
+
/** @description The website of the organization */
|
|
734
|
+
website?: string | null;
|
|
735
|
+
/** @description The LinkedIn profile URL of the organization */
|
|
736
|
+
linkedin?: string | null;
|
|
737
|
+
/** @description The industry the organization belongs to */
|
|
738
|
+
industry?: number | null;
|
|
739
|
+
/** @description The annual revenue of the organization */
|
|
740
|
+
annual_revenue?: number | null;
|
|
741
|
+
/** @description The number of employees in the organization */
|
|
742
|
+
employee_count?: number | null;
|
|
743
|
+
/** @description An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error. */
|
|
744
|
+
custom_fields?: {
|
|
745
|
+
[key: string]: unknown;
|
|
746
|
+
};
|
|
747
|
+
}[];
|
|
748
|
+
/** @description The additional data of the list */
|
|
749
|
+
additional_data?: {
|
|
750
|
+
/** @description The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. */
|
|
751
|
+
next_cursor?: string | null;
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
};
|
|
757
|
+
};
|
|
758
|
+
getActivities: {
|
|
759
|
+
parameters: {
|
|
760
|
+
query?: {
|
|
761
|
+
/** @description If supplied, only activities matching the specified filter are returned */
|
|
762
|
+
filter_id?: number;
|
|
763
|
+
/** @description Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. */
|
|
764
|
+
ids?: number[];
|
|
765
|
+
/** @description If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. */
|
|
766
|
+
owner_id?: number;
|
|
767
|
+
/** @description If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. */
|
|
768
|
+
deal_id?: number;
|
|
769
|
+
/** @description If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. */
|
|
770
|
+
lead_id?: string;
|
|
771
|
+
/** @description If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored. */
|
|
772
|
+
person_id?: number;
|
|
773
|
+
/** @description If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored. */
|
|
774
|
+
org_id?: number;
|
|
775
|
+
/** @description If supplied, only activities with specified 'done' flag value are returned */
|
|
776
|
+
done?: boolean;
|
|
777
|
+
/** @description If set, only activities with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
778
|
+
updated_since?: string;
|
|
779
|
+
/** @description If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. */
|
|
780
|
+
updated_until?: string;
|
|
781
|
+
/** @description The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`. */
|
|
782
|
+
sort_by?: "id" | "update_time" | "add_time" | "due_date";
|
|
783
|
+
/** @description The sorting direction. Supported values: `asc`, `desc`. */
|
|
784
|
+
sort_direction?: "asc" | "desc";
|
|
785
|
+
/** @description Optional comma separated string array of additional fields to include */
|
|
786
|
+
include_fields?: "attendees"[];
|
|
787
|
+
/** @description For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. */
|
|
788
|
+
limit?: number;
|
|
789
|
+
/** @description For pagination, the marker (an opaque string value) representing the first item on the next page */
|
|
790
|
+
cursor?: string;
|
|
791
|
+
};
|
|
792
|
+
header?: never;
|
|
793
|
+
path?: never;
|
|
794
|
+
cookie?: never;
|
|
795
|
+
};
|
|
796
|
+
requestBody?: never;
|
|
797
|
+
responses: {
|
|
798
|
+
/** @description Get all activities */
|
|
799
|
+
200: {
|
|
800
|
+
headers: {
|
|
801
|
+
[name: string]: unknown;
|
|
802
|
+
};
|
|
803
|
+
content: {
|
|
804
|
+
/**
|
|
805
|
+
* @example {
|
|
806
|
+
* "success": true,
|
|
807
|
+
* "data": [
|
|
808
|
+
* {
|
|
809
|
+
* "id": 1,
|
|
810
|
+
* "subject": "Activity Subject",
|
|
811
|
+
* "type": "activity_type",
|
|
812
|
+
* "owner_id": 1,
|
|
813
|
+
* "creator_user_id": 1,
|
|
814
|
+
* "is_deleted": false,
|
|
815
|
+
* "add_time": "2021-01-01T00:00:00Z",
|
|
816
|
+
* "update_time": "2021-01-01T00:00:00Z",
|
|
817
|
+
* "deal_id": 5,
|
|
818
|
+
* "lead_id": "abc-def",
|
|
819
|
+
* "person_id": 6,
|
|
820
|
+
* "org_id": 7,
|
|
821
|
+
* "project_id": 8,
|
|
822
|
+
* "due_date": "2021-01-01",
|
|
823
|
+
* "due_time": "15:00:00",
|
|
824
|
+
* "duration": "01:00:00",
|
|
825
|
+
* "busy": true,
|
|
826
|
+
* "done": true,
|
|
827
|
+
* "marked_as_done_time": "2021-01-01T00:00:00Z",
|
|
828
|
+
* "location": {
|
|
829
|
+
* "value": "123 Main St",
|
|
830
|
+
* "country": "USA",
|
|
831
|
+
* "admin_area_level_1": "CA",
|
|
832
|
+
* "admin_area_level_2": "Santa Clara",
|
|
833
|
+
* "locality": "Sunnyvale",
|
|
834
|
+
* "sublocality": "Downtown",
|
|
835
|
+
* "route": "Main St",
|
|
836
|
+
* "street_number": "123",
|
|
837
|
+
* "subpremise": "Apt 1",
|
|
838
|
+
* "postal_code": "94085"
|
|
839
|
+
* },
|
|
840
|
+
* "participants": [
|
|
841
|
+
* {
|
|
842
|
+
* "person_id": 1,
|
|
843
|
+
* "primary": true
|
|
844
|
+
* }
|
|
845
|
+
* ],
|
|
846
|
+
* "attendees": [
|
|
847
|
+
* {
|
|
848
|
+
* "email": "some@email.com",
|
|
849
|
+
* "name": "Some Name",
|
|
850
|
+
* "status": "accepted",
|
|
851
|
+
* "is_organizer": true,
|
|
852
|
+
* "person_id": 1,
|
|
853
|
+
* "user_id": 1
|
|
854
|
+
* }
|
|
855
|
+
* ],
|
|
856
|
+
* "conference_meeting_client": "google_meet",
|
|
857
|
+
* "conference_meeting_url": "https://meet.google.com/abc-xyz",
|
|
858
|
+
* "conference_meeting_id": "abc-xyz",
|
|
859
|
+
* "public_description": "Public Description",
|
|
860
|
+
* "priority": 263,
|
|
861
|
+
* "outcome": 101,
|
|
862
|
+
* "note": "Note"
|
|
863
|
+
* }
|
|
864
|
+
* ],
|
|
865
|
+
* "additional_data": {
|
|
866
|
+
* "next_cursor": "eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"
|
|
867
|
+
* }
|
|
868
|
+
* }
|
|
869
|
+
*/
|
|
870
|
+
"application/json": {
|
|
871
|
+
/** @description If the response is successful or not */
|
|
872
|
+
success?: boolean;
|
|
873
|
+
} & {
|
|
874
|
+
/** @description Activities array */
|
|
875
|
+
data?: {
|
|
876
|
+
/** @description The ID of the activity */
|
|
877
|
+
id?: number;
|
|
878
|
+
/** @description The subject of the activity */
|
|
879
|
+
subject?: string;
|
|
880
|
+
/** @description The type of the activity */
|
|
881
|
+
type?: string;
|
|
882
|
+
/** @description The ID of the user who owns the activity */
|
|
883
|
+
owner_id?: number;
|
|
884
|
+
/** @description The ID of the user who created the activity */
|
|
885
|
+
creator_user_id?: number;
|
|
886
|
+
/** @description Whether the activity is deleted or not */
|
|
887
|
+
is_deleted?: boolean;
|
|
888
|
+
/** @description The creation date and time of the activity */
|
|
889
|
+
add_time?: string;
|
|
890
|
+
/** @description The last updated date and time of the activity */
|
|
891
|
+
update_time?: string;
|
|
892
|
+
/** @description The ID of the deal linked to the activity */
|
|
893
|
+
deal_id?: number | null;
|
|
894
|
+
/** @description The ID of the lead linked to the activity */
|
|
895
|
+
lead_id?: string | null;
|
|
896
|
+
/** @description The ID of the person linked to the activity */
|
|
897
|
+
person_id?: number | null;
|
|
898
|
+
/** @description The ID of the organization linked to the activity */
|
|
899
|
+
org_id?: number | null;
|
|
900
|
+
/** @description The ID of the project linked to the activity */
|
|
901
|
+
project_id?: number | null;
|
|
902
|
+
/** @description The due date of the activity */
|
|
903
|
+
due_date?: string;
|
|
904
|
+
/** @description The due time of the activity */
|
|
905
|
+
due_time?: string | null;
|
|
906
|
+
/** @description The duration of the activity */
|
|
907
|
+
duration?: string | null;
|
|
908
|
+
/** @description Whether the activity marks the assignee as busy or not in their calendar */
|
|
909
|
+
busy?: boolean;
|
|
910
|
+
/** @description Whether the activity is marked as done or not */
|
|
911
|
+
done?: boolean;
|
|
912
|
+
/** @description The date and time when the activity was marked as done */
|
|
913
|
+
marked_as_done_time?: string | null;
|
|
914
|
+
/** @description Location of the activity */
|
|
915
|
+
location?: {
|
|
916
|
+
/** @description The full address of the activity */
|
|
917
|
+
value?: string;
|
|
918
|
+
/** @description Country of the activity */
|
|
919
|
+
country?: string | null;
|
|
920
|
+
/** @description Admin area level 1 (e.g. state) of the activity */
|
|
921
|
+
admin_area_level_1?: string | null;
|
|
922
|
+
/** @description Admin area level 2 (e.g. county) of the activity */
|
|
923
|
+
admin_area_level_2?: string | null;
|
|
924
|
+
/** @description Locality (e.g. city) of the activity */
|
|
925
|
+
locality?: string | null;
|
|
926
|
+
/** @description Sublocality (e.g. neighborhood) of the activity */
|
|
927
|
+
sublocality?: string | null;
|
|
928
|
+
/** @description Route (e.g. street) of the activity */
|
|
929
|
+
route?: string | null;
|
|
930
|
+
/** @description Street number of the activity */
|
|
931
|
+
street_number?: string | null;
|
|
932
|
+
/** @description Subpremise (e.g. apartment/suite number) of the activity */
|
|
933
|
+
subpremise?: string | null;
|
|
934
|
+
/** @description Postal code of the activity */
|
|
935
|
+
postal_code?: string | null;
|
|
936
|
+
} | null;
|
|
937
|
+
/** @description The participants of the activity */
|
|
938
|
+
participants?: {
|
|
939
|
+
/** @description The ID of the person */
|
|
940
|
+
person_id?: number;
|
|
941
|
+
/** @description Whether the person is the primary participant or not */
|
|
942
|
+
primary?: boolean;
|
|
943
|
+
}[];
|
|
944
|
+
/** @description The attendees of the activity */
|
|
945
|
+
attendees?: {
|
|
946
|
+
/** @description The email address of the attendee */
|
|
947
|
+
email?: string;
|
|
948
|
+
/** @description The name of the attendee */
|
|
949
|
+
name?: string;
|
|
950
|
+
/** @description The status of the attendee */
|
|
951
|
+
status?: string;
|
|
952
|
+
/** @description Whether the attendee is the organizer or not */
|
|
953
|
+
is_organizer?: boolean;
|
|
954
|
+
/** @description The ID of the person if the attendee has a person record */
|
|
955
|
+
person_id?: number;
|
|
956
|
+
/** @description The ID of the user if the attendee is a user */
|
|
957
|
+
user_id?: number;
|
|
958
|
+
}[];
|
|
959
|
+
/** @description The client used for the conference meeting */
|
|
960
|
+
conference_meeting_client?: string;
|
|
961
|
+
/** @description The URL of the conference meeting */
|
|
962
|
+
conference_meeting_url?: string;
|
|
963
|
+
/** @description The ID of the conference meeting */
|
|
964
|
+
conference_meeting_id?: string;
|
|
965
|
+
/** @description The public description of the activity */
|
|
966
|
+
public_description?: string;
|
|
967
|
+
/** @description The priority of the activity. Mappable to a specific string using activityFields API. */
|
|
968
|
+
priority?: number;
|
|
969
|
+
/** @description The ID of the Outcome for the activity. The available Outcome values depend on the activity type and can be retrieved using the Activity Fields API. */
|
|
970
|
+
outcome?: number | null;
|
|
971
|
+
/** @description The note of the activity */
|
|
972
|
+
note?: string;
|
|
973
|
+
}[];
|
|
974
|
+
/** @description The additional data of the list */
|
|
975
|
+
additional_data?: {
|
|
976
|
+
/** @description The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. */
|
|
977
|
+
next_cursor?: string | null;
|
|
978
|
+
};
|
|
979
|
+
};
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
getPipelines: {
|
|
985
|
+
parameters: {
|
|
986
|
+
query?: {
|
|
987
|
+
/** @description The field to sort by. Supported fields: `id`, `update_time`, `add_time`. */
|
|
988
|
+
sort_by?: "id" | "update_time" | "add_time";
|
|
989
|
+
/** @description The sorting direction. Supported values: `asc`, `desc`. */
|
|
990
|
+
sort_direction?: "asc" | "desc";
|
|
991
|
+
/** @description For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. */
|
|
992
|
+
limit?: number;
|
|
993
|
+
/** @description For pagination, the marker (an opaque string value) representing the first item on the next page */
|
|
994
|
+
cursor?: string;
|
|
995
|
+
};
|
|
996
|
+
header?: never;
|
|
997
|
+
path?: never;
|
|
998
|
+
cookie?: never;
|
|
999
|
+
};
|
|
1000
|
+
requestBody?: never;
|
|
1001
|
+
responses: {
|
|
1002
|
+
/** @description Get all pipelines */
|
|
1003
|
+
200: {
|
|
1004
|
+
headers: {
|
|
1005
|
+
[name: string]: unknown;
|
|
1006
|
+
};
|
|
1007
|
+
content: {
|
|
1008
|
+
/**
|
|
1009
|
+
* @example {
|
|
1010
|
+
* "success": true,
|
|
1011
|
+
* "data": [
|
|
1012
|
+
* {
|
|
1013
|
+
* "id": 1,
|
|
1014
|
+
* "name": "Pipeline Name",
|
|
1015
|
+
* "order_nr": 1,
|
|
1016
|
+
* "is_deleted": false,
|
|
1017
|
+
* "is_deal_probability_enabled": true,
|
|
1018
|
+
* "add_time": "2024-01-01T00:00:00Z",
|
|
1019
|
+
* "update_time": "2024-01-01T00:00:00Z"
|
|
1020
|
+
* }
|
|
1021
|
+
* ],
|
|
1022
|
+
* "additional_data": {
|
|
1023
|
+
* "next_cursor": "eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"
|
|
1024
|
+
* }
|
|
1025
|
+
* }
|
|
1026
|
+
*/
|
|
1027
|
+
"application/json": {
|
|
1028
|
+
/** @description If the response is successful or not */
|
|
1029
|
+
success?: boolean;
|
|
1030
|
+
} & {
|
|
1031
|
+
/** @description Pipelines array */
|
|
1032
|
+
data?: {
|
|
1033
|
+
/** @description The ID of the pipeline */
|
|
1034
|
+
id?: number;
|
|
1035
|
+
/** @description The name of the pipeline */
|
|
1036
|
+
name?: string;
|
|
1037
|
+
/** @description Defines the order of pipelines. The pipeline with the lowest `order_nr` is considered the default. */
|
|
1038
|
+
order_nr?: number;
|
|
1039
|
+
/** @description Whether this pipeline is marked as deleted or not */
|
|
1040
|
+
is_deleted?: boolean;
|
|
1041
|
+
/** @description Whether deal probability is disabled or enabled for this pipeline */
|
|
1042
|
+
is_deal_probability_enabled?: boolean;
|
|
1043
|
+
/** @description The pipeline creation time */
|
|
1044
|
+
add_time?: string;
|
|
1045
|
+
/** @description The pipeline update time */
|
|
1046
|
+
update_time?: string;
|
|
1047
|
+
}[];
|
|
1048
|
+
/** @description The additional data of the list */
|
|
1049
|
+
additional_data?: {
|
|
1050
|
+
/** @description The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. */
|
|
1051
|
+
next_cursor?: string | null;
|
|
1052
|
+
};
|
|
1053
|
+
};
|
|
1054
|
+
};
|
|
1055
|
+
};
|
|
1056
|
+
};
|
|
1057
|
+
};
|
|
1058
|
+
getStages: {
|
|
1059
|
+
parameters: {
|
|
1060
|
+
query?: {
|
|
1061
|
+
/** @description The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. */
|
|
1062
|
+
pipeline_id?: number;
|
|
1063
|
+
/** @description The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `order_nr`. */
|
|
1064
|
+
sort_by?: "id" | "update_time" | "add_time" | "order_nr";
|
|
1065
|
+
/** @description The sorting direction. Supported values: `asc`, `desc`. */
|
|
1066
|
+
sort_direction?: "asc" | "desc";
|
|
1067
|
+
/** @description For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. */
|
|
1068
|
+
limit?: number;
|
|
1069
|
+
/** @description For pagination, the marker (an opaque string value) representing the first item on the next page */
|
|
1070
|
+
cursor?: string;
|
|
1071
|
+
};
|
|
1072
|
+
header?: never;
|
|
1073
|
+
path?: never;
|
|
1074
|
+
cookie?: never;
|
|
1075
|
+
};
|
|
1076
|
+
requestBody?: never;
|
|
1077
|
+
responses: {
|
|
1078
|
+
/** @description Get all stages */
|
|
1079
|
+
200: {
|
|
1080
|
+
headers: {
|
|
1081
|
+
[name: string]: unknown;
|
|
1082
|
+
};
|
|
1083
|
+
content: {
|
|
1084
|
+
/**
|
|
1085
|
+
* @example {
|
|
1086
|
+
* "success": true,
|
|
1087
|
+
* "data": [
|
|
1088
|
+
* {
|
|
1089
|
+
* "id": 1,
|
|
1090
|
+
* "order_nr": 1,
|
|
1091
|
+
* "name": "Stage Name",
|
|
1092
|
+
* "is_deleted": false,
|
|
1093
|
+
* "deal_probability": 100,
|
|
1094
|
+
* "pipeline_id": 1,
|
|
1095
|
+
* "is_deal_rot_enabled": true,
|
|
1096
|
+
* "days_to_rotten": 2,
|
|
1097
|
+
* "add_time": "2024-01-01T00:00:00Z",
|
|
1098
|
+
* "update_time": "2024-01-01T00:00:00Z"
|
|
1099
|
+
* }
|
|
1100
|
+
* ],
|
|
1101
|
+
* "additional_data": {
|
|
1102
|
+
* "next_cursor": "eyJmaWVsZCI6ImlkIiwiZmllbGRWYWx1ZSI6Nywic29ydERpcmVjdGlvbiI6ImFzYyIsImlkIjo3fQ"
|
|
1103
|
+
* }
|
|
1104
|
+
* }
|
|
1105
|
+
*/
|
|
1106
|
+
"application/json": {
|
|
1107
|
+
/** @description If the response is successful or not */
|
|
1108
|
+
success?: boolean;
|
|
1109
|
+
/** @description The array of stages */
|
|
1110
|
+
data?: {
|
|
1111
|
+
/** @description The ID of the stage */
|
|
1112
|
+
id?: number;
|
|
1113
|
+
/** @description Defines the order of the stage */
|
|
1114
|
+
order_nr?: number;
|
|
1115
|
+
/** @description The name of the stage */
|
|
1116
|
+
name?: string;
|
|
1117
|
+
/** @description Whether the stage is marked as deleted or not */
|
|
1118
|
+
is_deleted?: boolean;
|
|
1119
|
+
/** @description The success probability percentage of the deal. Used/shown when the deal weighted values are used. */
|
|
1120
|
+
deal_probability?: number;
|
|
1121
|
+
/** @description The ID of the pipeline to add the stage to */
|
|
1122
|
+
pipeline_id?: number;
|
|
1123
|
+
/** @description Whether deals in this stage can become rotten */
|
|
1124
|
+
is_deal_rot_enabled?: boolean;
|
|
1125
|
+
/** @description The number of days the deals not updated in this stage would become rotten. Applies only if the `is_deal_rot_enabled` is set. */
|
|
1126
|
+
days_to_rotten?: number | null;
|
|
1127
|
+
/** @description The stage creation time */
|
|
1128
|
+
add_time?: string;
|
|
1129
|
+
/** @description The stage update time */
|
|
1130
|
+
update_time?: string | null;
|
|
1131
|
+
}[];
|
|
1132
|
+
/** @description The additional data of the list */
|
|
1133
|
+
additional_data?: {
|
|
1134
|
+
/** @description The first item on the next page. The value of the `next_cursor` field will be `null` if you have reached the end of the dataset and there’s no more pages to be returned. */
|
|
1135
|
+
next_cursor?: string | null;
|
|
1136
|
+
};
|
|
1137
|
+
};
|
|
1138
|
+
};
|
|
1139
|
+
};
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
getCurrentUser: {
|
|
1143
|
+
parameters: {
|
|
1144
|
+
query?: never;
|
|
1145
|
+
header?: never;
|
|
1146
|
+
path?: never;
|
|
1147
|
+
cookie?: never;
|
|
1148
|
+
};
|
|
1149
|
+
requestBody?: never;
|
|
1150
|
+
responses: {
|
|
1151
|
+
/** @description The data of the logged in user */
|
|
1152
|
+
200: {
|
|
1153
|
+
headers: {
|
|
1154
|
+
[name: string]: unknown;
|
|
1155
|
+
};
|
|
1156
|
+
content: {
|
|
1157
|
+
/**
|
|
1158
|
+
* @example {
|
|
1159
|
+
* "success": true,
|
|
1160
|
+
* "data": {
|
|
1161
|
+
* "id": 1,
|
|
1162
|
+
* "name": "Me",
|
|
1163
|
+
* "default_currency": "EUR",
|
|
1164
|
+
* "locale": "et_EE",
|
|
1165
|
+
* "lang": 1,
|
|
1166
|
+
* "email": "me@pipedrive.com",
|
|
1167
|
+
* "phone": "0000-0000",
|
|
1168
|
+
* "activated": true,
|
|
1169
|
+
* "last_login": "2019-11-21 08:45:56",
|
|
1170
|
+
* "created": "2018-11-13 09:16:26",
|
|
1171
|
+
* "modified": "2019-11-21 08:45:56",
|
|
1172
|
+
* "has_created_company": true,
|
|
1173
|
+
* "access": [
|
|
1174
|
+
* {
|
|
1175
|
+
* "app": "sales",
|
|
1176
|
+
* "admin": true,
|
|
1177
|
+
* "permission_set_id": "62cc4d7f-4038-4352-abf3-a8c1c822b631"
|
|
1178
|
+
* },
|
|
1179
|
+
* {
|
|
1180
|
+
* "app": "global",
|
|
1181
|
+
* "admin": true,
|
|
1182
|
+
* "permission_set_id": "233b7976-39bd-43a9-b305-ef3a2b0998e5"
|
|
1183
|
+
* },
|
|
1184
|
+
* {
|
|
1185
|
+
* "app": "account_settings",
|
|
1186
|
+
* "admin": true,
|
|
1187
|
+
* "permission_set_id": "982c5ce5-b8ba-4b47-b102-9da024f4b990"
|
|
1188
|
+
* }
|
|
1189
|
+
* ],
|
|
1190
|
+
* "active_flag": true,
|
|
1191
|
+
* "timezone_name": "Europe/Berlin",
|
|
1192
|
+
* "timezone_offset": "+03:00",
|
|
1193
|
+
* "role_id": 1,
|
|
1194
|
+
* "icon_url": "https://upload.wikimedia.org/wikipedia/en/thumb/e/e0/WPVG_icon_2016.svg/1024px-WPVG_icon_2016.svg.png",
|
|
1195
|
+
* "is_you": true,
|
|
1196
|
+
* "is_deleted": false,
|
|
1197
|
+
* "company_id": 54235233,
|
|
1198
|
+
* "company_name": "Pipedrive",
|
|
1199
|
+
* "company_domain": "pipedrive-12g53f",
|
|
1200
|
+
* "company_country": "EE",
|
|
1201
|
+
* "company_industry": "IT Services",
|
|
1202
|
+
* "language": {
|
|
1203
|
+
* "language_code": "en",
|
|
1204
|
+
* "country_code": "US"
|
|
1205
|
+
* }
|
|
1206
|
+
* }
|
|
1207
|
+
* }
|
|
1208
|
+
*/
|
|
1209
|
+
"application/json": {
|
|
1210
|
+
/** @description If the response is successful or not */
|
|
1211
|
+
success?: boolean;
|
|
1212
|
+
} & {
|
|
1213
|
+
data?: {
|
|
1214
|
+
/** @description The user ID */
|
|
1215
|
+
id?: number;
|
|
1216
|
+
/** @description The user name */
|
|
1217
|
+
name?: string;
|
|
1218
|
+
/** @description The user default currency */
|
|
1219
|
+
default_currency?: string;
|
|
1220
|
+
/** @description The user locale */
|
|
1221
|
+
locale?: string;
|
|
1222
|
+
/** @description The user language ID */
|
|
1223
|
+
lang?: number;
|
|
1224
|
+
/** @description The user email */
|
|
1225
|
+
email?: string;
|
|
1226
|
+
/** @description The user phone */
|
|
1227
|
+
phone?: string | null;
|
|
1228
|
+
/** @description Boolean that indicates whether the user is activated */
|
|
1229
|
+
activated?: boolean;
|
|
1230
|
+
/** @description The last login date and time of the user. Format: YYYY-MM-DD HH:MM:SS */
|
|
1231
|
+
last_login?: string;
|
|
1232
|
+
/** @description The creation date and time of the user. Format: YYYY-MM-DD HH:MM:SS */
|
|
1233
|
+
created?: string;
|
|
1234
|
+
/** @description The last modification date and time of the user. Format: YYYY-MM-DD HH:MM:SS */
|
|
1235
|
+
modified?: string | null;
|
|
1236
|
+
/** @description Boolean that indicates whether the user has created a company */
|
|
1237
|
+
has_created_company?: boolean;
|
|
1238
|
+
access?: {
|
|
1239
|
+
/**
|
|
1240
|
+
* @description The granular app access level
|
|
1241
|
+
* @enum {string}
|
|
1242
|
+
*/
|
|
1243
|
+
app?: "global" | "sales" | "campaigns" | "projects" | "account_settings" | "partnership" | "nova";
|
|
1244
|
+
/** @description Whether the user has admin access or not */
|
|
1245
|
+
admin?: boolean;
|
|
1246
|
+
/** @description The ID of the permission set */
|
|
1247
|
+
permission_set_id?: string;
|
|
1248
|
+
}[];
|
|
1249
|
+
/** @description Boolean that indicates whether the user is activated */
|
|
1250
|
+
active_flag?: boolean;
|
|
1251
|
+
/** @description The user timezone name */
|
|
1252
|
+
timezone_name?: string;
|
|
1253
|
+
/** @description The user timezone offset */
|
|
1254
|
+
timezone_offset?: string;
|
|
1255
|
+
/** @description The ID of the user role */
|
|
1256
|
+
role_id?: number;
|
|
1257
|
+
/** @description The user icon URL */
|
|
1258
|
+
icon_url?: string | null;
|
|
1259
|
+
/** @description Boolean that indicates if the requested user is the same which is logged in (in this case, always true) */
|
|
1260
|
+
is_you?: boolean;
|
|
1261
|
+
/** @description Boolean that indicates whether the user is deleted from the company */
|
|
1262
|
+
is_deleted?: boolean;
|
|
1263
|
+
} & {
|
|
1264
|
+
/** @description The user company ID */
|
|
1265
|
+
company_id?: number;
|
|
1266
|
+
/** @description The user company name */
|
|
1267
|
+
company_name?: string;
|
|
1268
|
+
/** @description The user company domain */
|
|
1269
|
+
company_domain?: string;
|
|
1270
|
+
/** @description The user company country */
|
|
1271
|
+
company_country?: string;
|
|
1272
|
+
/** @description The user company industry */
|
|
1273
|
+
company_industry?: string;
|
|
1274
|
+
/** @description The user language details */
|
|
1275
|
+
language?: {
|
|
1276
|
+
/** @description The language code. E.g. en */
|
|
1277
|
+
language_code?: string;
|
|
1278
|
+
/** @description The country code. E.g. US */
|
|
1279
|
+
country_code?: string;
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
};
|
|
1285
|
+
/** @description Unauthorized response */
|
|
1286
|
+
401: {
|
|
1287
|
+
headers: {
|
|
1288
|
+
[name: string]: unknown;
|
|
1289
|
+
};
|
|
1290
|
+
content: {
|
|
1291
|
+
/**
|
|
1292
|
+
* @example {
|
|
1293
|
+
* "success": false,
|
|
1294
|
+
* "error": "unauthorized access",
|
|
1295
|
+
* "errorCode": 401
|
|
1296
|
+
* }
|
|
1297
|
+
*/
|
|
1298
|
+
"application/json": {
|
|
1299
|
+
/** @description If the response is successful or not */
|
|
1300
|
+
success?: boolean;
|
|
1301
|
+
/** @description The error message */
|
|
1302
|
+
error?: string;
|
|
1303
|
+
/** @description The response error code */
|
|
1304
|
+
errorCode?: number;
|
|
1305
|
+
};
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1308
|
+
};
|
|
1309
|
+
};
|
|
1310
|
+
}
|
|
1311
|
+
//# sourceMappingURL=openapi.d.ts.map
|