pipedrive 25.0.0 → 26.0.0
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/dist/esm/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/esm/versions/v1/api/activities-api.js +40 -40
- package/dist/esm/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/esm/versions/v1/api/deals-api.js +417 -88
- package/dist/esm/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/esm/versions/v1/api/item-search-api.js +8 -8
- package/dist/esm/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/esm/versions/v1/api/leads-api.js +107 -14
- package/dist/esm/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/esm/versions/v1/api/notes-api.js +15 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/esm/versions/v1/api/organizations-api.js +68 -68
- package/dist/esm/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/esm/versions/v1/api/persons-api.js +56 -56
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/esm/versions/v1/api/pipelines-api.js +28 -28
- package/dist/esm/versions/v1/api/products-api.d.ts +24 -24
- package/dist/esm/versions/v1/api/products-api.js +24 -24
- package/dist/esm/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/esm/versions/v1/api/stages-api.js +36 -36
- package/dist/esm/versions/v1/base.d.ts +2 -3
- package/dist/esm/versions/v1/configuration.d.ts +2 -2
- package/dist/esm/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/esm/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/esm/versions/v1/models/add-note-request-all-of1.js +4 -0
- package/dist/esm/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v1/models/index.d.ts +1 -0
- package/dist/esm/versions/v1/models/index.js +1 -0
- package/dist/esm/versions/v1/models/note-project.d.ts +23 -0
- package/dist/esm/versions/v1/models/note-project.js +14 -0
- package/dist/esm/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/esm/versions/v1/models/note.d.ts +16 -0
- package/dist/esm/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/esm/versions/v2/api/activities-api.js +12 -7
- package/dist/esm/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/esm/versions/v2/api/beta-api.js +286 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/esm/versions/v2/api/deals-api.js +288 -4
- package/dist/esm/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/esm/versions/v2/api/leads-api.js +146 -1
- package/dist/esm/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/api/products-api.js +1 -1
- package/dist/esm/versions/v2/base.d.ts +2 -3
- package/dist/esm/versions/v2/configuration.d.ts +2 -2
- package/dist/esm/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response-data.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-deal-to-lead-response.js +14 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/esm/versions/v2/models/add-convert-lead-to-deal-response.js +14 -0
- package/dist/esm/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/add-person-request.js +6 -1
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/esm/versions/v2/models/convert-lead-to-deal-request.js +14 -0
- package/dist/esm/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/esm/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/esm/versions/v2/models/get-convert-response.js +14 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/esm/versions/v2/models/get-convert-response1-data.js +20 -0
- package/dist/esm/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/esm/versions/v2/models/get-convert-response1.js +14 -0
- package/dist/esm/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/esm/versions/v2/models/index.d.ts +7 -0
- package/dist/esm/versions/v2/models/index.js +7 -0
- package/dist/esm/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/esm/versions/v2/models/update-person-request.js +6 -1
- package/dist/versions/v1/api/activities-api.d.ts +40 -40
- package/dist/versions/v1/api/activities-api.js +40 -40
- package/dist/versions/v1/api/deals-api.d.ts +410 -88
- package/dist/versions/v1/api/deals-api.js +417 -88
- package/dist/versions/v1/api/item-search-api.d.ts +8 -8
- package/dist/versions/v1/api/item-search-api.js +8 -8
- package/dist/versions/v1/api/leads-api.d.ts +100 -14
- package/dist/versions/v1/api/leads-api.js +107 -14
- package/dist/versions/v1/api/notes-api.d.ts +18 -2
- package/dist/versions/v1/api/notes-api.js +15 -5
- package/dist/versions/v1/api/organizations-api.d.ts +68 -68
- package/dist/versions/v1/api/organizations-api.js +68 -68
- package/dist/versions/v1/api/persons-api.d.ts +56 -56
- package/dist/versions/v1/api/persons-api.js +56 -56
- package/dist/versions/v1/api/pipelines-api.d.ts +28 -28
- package/dist/versions/v1/api/pipelines-api.js +28 -28
- package/dist/versions/v1/api/products-api.d.ts +24 -24
- package/dist/versions/v1/api/products-api.js +24 -24
- package/dist/versions/v1/api/stages-api.d.ts +36 -36
- package/dist/versions/v1/api/stages-api.js +36 -36
- package/dist/versions/v1/base.d.ts +2 -3
- package/dist/versions/v1/configuration.d.ts +2 -2
- package/dist/versions/v1/models/add-note-request-all-of.d.ts +9 -4
- package/dist/versions/v1/models/add-note-request-all-of1.d.ts +10 -0
- package/dist/versions/v1/models/add-note-request-all-of1.js +5 -1
- package/dist/versions/v1/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v1/models/index.d.ts +1 -0
- package/dist/versions/v1/models/index.js +1 -0
- package/dist/versions/v1/models/note-project.d.ts +23 -0
- package/dist/versions/v1/models/note-project.js +15 -0
- package/dist/versions/v1/models/note-request-all-of1.d.ts +5 -0
- package/dist/versions/v1/models/note.d.ts +16 -0
- package/dist/versions/v2/api/activities-api.d.ts +15 -7
- package/dist/versions/v2/api/activities-api.js +12 -7
- package/dist/versions/v2/api/beta-api.d.ts +212 -0
- package/dist/versions/v2/api/beta-api.js +286 -0
- package/dist/versions/v2/api/deals-api.d.ts +272 -4
- package/dist/versions/v2/api/deals-api.js +288 -4
- package/dist/versions/v2/api/leads-api.d.ts +111 -0
- package/dist/versions/v2/api/leads-api.js +145 -0
- package/dist/versions/v2/api/persons-api.d.ts +8 -8
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/api/products-api.js +1 -1
- package/dist/versions/v2/base.d.ts +2 -3
- package/dist/versions/v2/configuration.d.ts +2 -2
- package/dist/versions/v2/models/activity-item.d.ts +5 -0
- package/dist/versions/v2/models/activity-item1.d.ts +5 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.d.ts +23 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response-data.js +15 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-deal-to-lead-response.js +15 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.d.ts +34 -0
- package/dist/versions/v2/models/add-convert-lead-to-deal-response.js +15 -0
- package/dist/versions/v2/models/add-person-request.d.ts +12 -0
- package/dist/versions/v2/models/add-person-request.js +7 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.d.ts +28 -0
- package/dist/versions/v2/models/convert-lead-to-deal-request.js +15 -0
- package/dist/versions/v2/models/deal-item.d.ts +5 -0
- package/dist/versions/v2/models/deal-item1.d.ts +5 -0
- package/dist/versions/v2/models/get-convert-response.d.ts +43 -0
- package/dist/versions/v2/models/get-convert-response.js +15 -0
- package/dist/versions/v2/models/get-convert-response1-data.d.ts +46 -0
- package/dist/versions/v2/models/get-convert-response1-data.js +23 -0
- package/dist/versions/v2/models/get-convert-response1.d.ts +34 -0
- package/dist/versions/v2/models/get-convert-response1.js +15 -0
- package/dist/versions/v2/models/get-deal-search-response-all-of-data-items-inner-item.d.ts +5 -0
- package/dist/versions/v2/models/index.d.ts +7 -0
- package/dist/versions/v2/models/index.js +7 -0
- package/dist/versions/v2/models/update-person-request.d.ts +12 -0
- package/dist/versions/v2/models/update-person-request.js +7 -0
- package/package.json +1 -1
@@ -619,6 +619,7 @@ export * from './note';
|
|
619
619
|
export * from './note-deal';
|
620
620
|
export * from './note-organization';
|
621
621
|
export * from './note-person';
|
622
|
+
export * from './note-project';
|
622
623
|
export * from './note-request';
|
623
624
|
export * from './note-request-all-of';
|
624
625
|
export * from './note-request-all-of1';
|
@@ -619,6 +619,7 @@ export * from './note';
|
|
619
619
|
export * from './note-deal';
|
620
620
|
export * from './note-organization';
|
621
621
|
export * from './note-person';
|
622
|
+
export * from './note-project';
|
622
623
|
export * from './note-request';
|
623
624
|
export * from './note-request-all-of';
|
624
625
|
export * from './note-request-all-of1';
|
@@ -0,0 +1,23 @@
|
|
1
|
+
/**
|
2
|
+
* Pipedrive API v1
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
4
|
+
*
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
6
|
+
*
|
7
|
+
*
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
9
|
+
* https://openapi-generator.tech
|
10
|
+
* Do not edit the class manually.
|
11
|
+
*/
|
12
|
+
/**
|
13
|
+
* The project the note is attached to
|
14
|
+
* @export
|
15
|
+
* @interface NoteProject
|
16
|
+
*/
|
17
|
+
export interface NoteProject {
|
18
|
+
/**
|
19
|
+
* The title of the project the note is attached to
|
20
|
+
* @type {string}
|
21
|
+
*/
|
22
|
+
'title'?: string;
|
23
|
+
}
|
@@ -0,0 +1,14 @@
|
|
1
|
+
/* tslint:disable */
|
2
|
+
/* eslint-disable */
|
3
|
+
/**
|
4
|
+
* Pipedrive API v1
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
*
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
8
|
+
*
|
9
|
+
*
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
11
|
+
* https://openapi-generator.tech
|
12
|
+
* Do not edit the class manually.
|
13
|
+
*/
|
14
|
+
export {};
|
@@ -12,6 +12,7 @@
|
|
12
12
|
import { NoteDeal } from './note-deal';
|
13
13
|
import { NoteOrganization } from './note-organization';
|
14
14
|
import { NotePerson } from './note-person';
|
15
|
+
import { NoteProject } from './note-project';
|
15
16
|
import { NoteUser } from './note-user';
|
16
17
|
/**
|
17
18
|
*
|
@@ -80,6 +81,16 @@ export interface Note {
|
|
80
81
|
*/
|
81
82
|
'person_id'?: number;
|
82
83
|
/**
|
84
|
+
* The ID of the project the note is attached to
|
85
|
+
* @type {number}
|
86
|
+
*/
|
87
|
+
'project_id'?: number;
|
88
|
+
/**
|
89
|
+
*
|
90
|
+
* @type {NoteProject}
|
91
|
+
*/
|
92
|
+
'project'?: NoteProject;
|
93
|
+
/**
|
83
94
|
* If true, the results are filtered by note to deal pinning state
|
84
95
|
* @type {boolean}
|
85
96
|
*/
|
@@ -95,6 +106,11 @@ export interface Note {
|
|
95
106
|
*/
|
96
107
|
'pinned_to_person_flag'?: boolean;
|
97
108
|
/**
|
109
|
+
* If true, the results are filtered by note to project pinning state
|
110
|
+
* @type {boolean}
|
111
|
+
*/
|
112
|
+
'pinned_to_project_flag'?: boolean;
|
113
|
+
/**
|
98
114
|
* The last updated date and time of the note
|
99
115
|
* @type {string}
|
100
116
|
*/
|
@@ -47,9 +47,10 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
47
47
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
48
48
|
* @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
|
49
49
|
* @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
50
|
+
* @param {boolean} [done] If supplied, only activities with specified \'done\' flag value are returned
|
50
51
|
* @param {string} [updated_since] 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.
|
51
52
|
* @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
52
|
-
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
53
|
+
* @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
|
53
54
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
54
55
|
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
55
56
|
* @param {number} [limit] 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.
|
@@ -57,7 +58,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
57
58
|
|
58
59
|
* @throws {RequiredError}
|
59
60
|
*/
|
60
|
-
getActivities: (filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
|
61
|
+
getActivities: (filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
|
61
62
|
/**
|
62
63
|
* Returns the details of a specific activity.
|
63
64
|
* @summary Get details of an activity
|
@@ -108,9 +109,10 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
108
109
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
109
110
|
* @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
|
110
111
|
* @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
112
|
+
* @param {boolean} [done] If supplied, only activities with specified \'done\' flag value are returned
|
111
113
|
* @param {string} [updated_since] 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.
|
112
114
|
* @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
113
|
-
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
115
|
+
* @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
|
114
116
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
115
117
|
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
116
118
|
* @param {number} [limit] 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.
|
@@ -118,7 +120,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
118
120
|
|
119
121
|
* @throws {RequiredError}
|
120
122
|
*/
|
121
|
-
getActivities(filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
|
123
|
+
getActivities(filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
|
122
124
|
/**
|
123
125
|
* Returns the details of a specific activity.
|
124
126
|
* @summary Get details of an activity
|
@@ -258,6 +260,12 @@ export interface ActivitiesApiGetActivitiesRequest {
|
|
258
260
|
* @memberof ActivitiesApiGetActivities
|
259
261
|
*/
|
260
262
|
readonly org_id?: number;
|
263
|
+
/**
|
264
|
+
* If supplied, only activities with specified \'done\' flag value are returned
|
265
|
+
* @type {boolean}
|
266
|
+
* @memberof ActivitiesApiGetActivities
|
267
|
+
*/
|
268
|
+
readonly done?: boolean;
|
261
269
|
/**
|
262
270
|
* 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.
|
263
271
|
* @type {string}
|
@@ -271,11 +279,11 @@ export interface ActivitiesApiGetActivitiesRequest {
|
|
271
279
|
*/
|
272
280
|
readonly updated_until?: string;
|
273
281
|
/**
|
274
|
-
* The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
275
|
-
* @type {'id' | 'update_time' | 'add_time'}
|
282
|
+
* The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
|
283
|
+
* @type {'id' | 'update_time' | 'add_time' | 'due_date'}
|
276
284
|
* @memberof ActivitiesApiGetActivities
|
277
285
|
*/
|
278
|
-
readonly sort_by?: 'id' | 'update_time' | 'add_time';
|
286
|
+
readonly sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date';
|
279
287
|
/**
|
280
288
|
* The sorting direction. Supported values: `asc`, `desc`.
|
281
289
|
* @type {'asc' | 'desc'}
|
@@ -109,9 +109,10 @@ export const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
109
109
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
110
110
|
* @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
|
111
111
|
* @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
112
|
+
* @param {boolean} [done] If supplied, only activities with specified \'done\' flag value are returned
|
112
113
|
* @param {string} [updated_since] 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.
|
113
114
|
* @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
114
|
-
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
115
|
+
* @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
|
115
116
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
116
117
|
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
117
118
|
* @param {number} [limit] 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.
|
@@ -119,7 +120,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
119
120
|
|
120
121
|
* @throws {RequiredError}
|
121
122
|
*/
|
122
|
-
getActivities: (filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
123
|
+
getActivities: (filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, done, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
|
123
124
|
const localVarPath = `/activities`;
|
124
125
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
125
126
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
@@ -156,6 +157,9 @@ export const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
156
157
|
if (org_id !== undefined) {
|
157
158
|
localVarQueryParameter['org_id'] = org_id;
|
158
159
|
}
|
160
|
+
if (done !== undefined) {
|
161
|
+
localVarQueryParameter['done'] = done;
|
162
|
+
}
|
159
163
|
if (updated_since !== undefined) {
|
160
164
|
localVarQueryParameter['updated_since'] = updated_since;
|
161
165
|
}
|
@@ -305,9 +309,10 @@ export const ActivitiesApiFp = function (configuration) {
|
|
305
309
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
306
310
|
* @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
|
307
311
|
* @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
312
|
+
* @param {boolean} [done] If supplied, only activities with specified \'done\' flag value are returned
|
308
313
|
* @param {string} [updated_since] 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.
|
309
314
|
* @param {string} [updated_until] If set, only activities with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
310
|
-
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
315
|
+
* @param {'id' | 'update_time' | 'add_time' | 'due_date'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.
|
311
316
|
* @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: `asc`, `desc`.
|
312
317
|
* @param {'attendees'} [include_fields] Optional comma separated string array of additional fields to include
|
313
318
|
* @param {number} [limit] 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.
|
@@ -315,9 +320,9 @@ export const ActivitiesApiFp = function (configuration) {
|
|
315
320
|
|
316
321
|
* @throws {RequiredError}
|
317
322
|
*/
|
318
|
-
getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) {
|
323
|
+
getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, done, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor) {
|
319
324
|
return __awaiter(this, void 0, void 0, function* () {
|
320
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor);
|
325
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getActivities(filter_id, ids, owner_id, deal_id, lead_id, person_id, org_id, done, updated_since, updated_until, sort_by, sort_direction, include_fields, limit, cursor);
|
321
326
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
322
327
|
});
|
323
328
|
},
|
@@ -386,7 +391,7 @@ export const ActivitiesApiFactory = function (configuration, basePath, axios) {
|
|
386
391
|
* @throws {RequiredError}
|
387
392
|
*/
|
388
393
|
getActivities(requestParameters = {}) {
|
389
|
-
return localVarFp.getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
394
|
+
return localVarFp.getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.done, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
|
390
395
|
},
|
391
396
|
/**
|
392
397
|
* Returns the details of a specific activity.
|
@@ -448,7 +453,7 @@ export class ActivitiesApi extends BaseAPI {
|
|
448
453
|
* @memberof ActivitiesApi
|
449
454
|
*/
|
450
455
|
getActivities(requestParameters = {}) {
|
451
|
-
return ActivitiesApiFp(this.configuration).getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
456
|
+
return ActivitiesApiFp(this.configuration).getActivities(requestParameters.filter_id, requestParameters.ids, requestParameters.owner_id, requestParameters.deal_id, requestParameters.lead_id, requestParameters.person_id, requestParameters.org_id, requestParameters.done, requestParameters.updated_since, requestParameters.updated_until, requestParameters.sort_by, requestParameters.sort_direction, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
|
452
457
|
}
|
453
458
|
/**
|
454
459
|
* Returns the details of a specific activity.
|
@@ -13,8 +13,12 @@ import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
15
15
|
import { AddAInstallmentResponse } from '../models';
|
16
|
+
import { AddConvertDealToLeadResponse } from '../models';
|
17
|
+
import { AddConvertLeadToDealResponse } from '../models';
|
16
18
|
import { AddInstallmentRequestBody } from '../models';
|
19
|
+
import { ConvertLeadToDealRequest } from '../models';
|
17
20
|
import { DeleteInstallmentResponse } from '../models';
|
21
|
+
import { GetConvertResponse1 } from '../models';
|
18
22
|
import { GetInstallmentsResponse } from '../models';
|
19
23
|
import { UpdateInstallmentRequestBody } from '../models';
|
20
24
|
import { UpdateInstallmentResponse } from '../models';
|
@@ -23,6 +27,23 @@ import { UpdateInstallmentResponse } from '../models';
|
|
23
27
|
* @export
|
24
28
|
*/
|
25
29
|
export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) => {
|
30
|
+
/**
|
31
|
+
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
32
|
+
* @summary Convert a deal to a lead (BETA)
|
33
|
+
* @param {number} id The ID of the deal to convert
|
34
|
+
|
35
|
+
* @throws {RequiredError}
|
36
|
+
*/
|
37
|
+
convertDealToLead: (id: number) => Promise<RequestArgs>;
|
38
|
+
/**
|
39
|
+
* Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
|
40
|
+
* @summary Convert a lead to a deal (BETA)
|
41
|
+
* @param {string} id The ID of the lead to convert
|
42
|
+
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
43
|
+
|
44
|
+
* @throws {RequiredError}
|
45
|
+
*/
|
46
|
+
convertLeadToDeal: (id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest) => Promise<RequestArgs>;
|
26
47
|
/**
|
27
48
|
* Removes an installment from a deal. Only available in Advanced and above plans.
|
28
49
|
* @summary Delete an installment from a deal
|
@@ -32,6 +53,15 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
32
53
|
* @throws {RequiredError}
|
33
54
|
*/
|
34
55
|
deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
|
56
|
+
/**
|
57
|
+
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
58
|
+
* @summary Get Deal conversion status (BETA)
|
59
|
+
* @param {number} id The ID of a deal
|
60
|
+
* @param {string} conversion_id The ID of the conversion
|
61
|
+
|
62
|
+
* @throws {RequiredError}
|
63
|
+
*/
|
64
|
+
getDealConversionStatus: (id: number, conversion_id: string) => Promise<RequestArgs>;
|
35
65
|
/**
|
36
66
|
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
37
67
|
* @summary List installments added to a list of deals
|
@@ -44,6 +74,15 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
44
74
|
* @throws {RequiredError}
|
45
75
|
*/
|
46
76
|
getInstallments: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
|
77
|
+
/**
|
78
|
+
* Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
79
|
+
* @summary Get Lead conversion status (BETA)
|
80
|
+
* @param {string} id The ID of a lead
|
81
|
+
* @param {string} conversion_id The ID of the conversion
|
82
|
+
|
83
|
+
* @throws {RequiredError}
|
84
|
+
*/
|
85
|
+
getLeadConversionStatus: (id: string, conversion_id: string) => Promise<RequestArgs>;
|
47
86
|
/**
|
48
87
|
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
49
88
|
* @summary Add an installment to a deal
|
@@ -69,6 +108,23 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
69
108
|
* @export
|
70
109
|
*/
|
71
110
|
export declare const BetaApiFp: (configuration?: Configuration) => {
|
111
|
+
/**
|
112
|
+
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
113
|
+
* @summary Convert a deal to a lead (BETA)
|
114
|
+
* @param {number} id The ID of the deal to convert
|
115
|
+
|
116
|
+
* @throws {RequiredError}
|
117
|
+
*/
|
118
|
+
convertDealToLead(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertDealToLeadResponse>>;
|
119
|
+
/**
|
120
|
+
* Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
|
121
|
+
* @summary Convert a lead to a deal (BETA)
|
122
|
+
* @param {string} id The ID of the lead to convert
|
123
|
+
* @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
|
124
|
+
|
125
|
+
* @throws {RequiredError}
|
126
|
+
*/
|
127
|
+
convertLeadToDeal(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertLeadToDealResponse>>;
|
72
128
|
/**
|
73
129
|
* Removes an installment from a deal. Only available in Advanced and above plans.
|
74
130
|
* @summary Delete an installment from a deal
|
@@ -78,6 +134,15 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
78
134
|
* @throws {RequiredError}
|
79
135
|
*/
|
80
136
|
deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
|
137
|
+
/**
|
138
|
+
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
139
|
+
* @summary Get Deal conversion status (BETA)
|
140
|
+
* @param {number} id The ID of a deal
|
141
|
+
* @param {string} conversion_id The ID of the conversion
|
142
|
+
|
143
|
+
* @throws {RequiredError}
|
144
|
+
*/
|
145
|
+
getDealConversionStatus(id: number, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
|
81
146
|
/**
|
82
147
|
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
83
148
|
* @summary List installments added to a list of deals
|
@@ -90,6 +155,15 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
90
155
|
* @throws {RequiredError}
|
91
156
|
*/
|
92
157
|
getInstallments(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetInstallmentsResponse>>;
|
158
|
+
/**
|
159
|
+
* Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
160
|
+
* @summary Get Lead conversion status (BETA)
|
161
|
+
* @param {string} id The ID of a lead
|
162
|
+
* @param {string} conversion_id The ID of the conversion
|
163
|
+
|
164
|
+
* @throws {RequiredError}
|
165
|
+
*/
|
166
|
+
getLeadConversionStatus(id: string, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
|
93
167
|
/**
|
94
168
|
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
95
169
|
* @summary Add an installment to a deal
|
@@ -115,6 +189,22 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
115
189
|
* @export
|
116
190
|
*/
|
117
191
|
export declare const BetaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
192
|
+
/**
|
193
|
+
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
194
|
+
* @summary Convert a deal to a lead (BETA)
|
195
|
+
* @param {BetaApiConvertDealToLeadRequest} requestParameters Request parameters.
|
196
|
+
|
197
|
+
* @throws {RequiredError}
|
198
|
+
*/
|
199
|
+
convertDealToLead(requestParameters: BetaApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
|
200
|
+
/**
|
201
|
+
* Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
|
202
|
+
* @summary Convert a lead to a deal (BETA)
|
203
|
+
* @param {BetaApiConvertLeadToDealRequest} requestParameters Request parameters.
|
204
|
+
|
205
|
+
* @throws {RequiredError}
|
206
|
+
*/
|
207
|
+
convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
118
208
|
/**
|
119
209
|
* Removes an installment from a deal. Only available in Advanced and above plans.
|
120
210
|
* @summary Delete an installment from a deal
|
@@ -123,6 +213,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
|
|
123
213
|
* @throws {RequiredError}
|
124
214
|
*/
|
125
215
|
deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
216
|
+
/**
|
217
|
+
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
218
|
+
* @summary Get Deal conversion status (BETA)
|
219
|
+
* @param {BetaApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
220
|
+
|
221
|
+
* @throws {RequiredError}
|
222
|
+
*/
|
223
|
+
getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
|
126
224
|
/**
|
127
225
|
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
128
226
|
* @summary List installments added to a list of deals
|
@@ -131,6 +229,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
|
|
131
229
|
* @throws {RequiredError}
|
132
230
|
*/
|
133
231
|
getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
|
232
|
+
/**
|
233
|
+
* Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
234
|
+
* @summary Get Lead conversion status (BETA)
|
235
|
+
* @param {BetaApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
236
|
+
|
237
|
+
* @throws {RequiredError}
|
238
|
+
*/
|
239
|
+
getLeadConversionStatus(requestParameters: BetaApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
|
134
240
|
/**
|
135
241
|
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
136
242
|
* @summary Add an installment to a deal
|
@@ -148,6 +254,38 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
|
|
148
254
|
*/
|
149
255
|
updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
|
150
256
|
};
|
257
|
+
/**
|
258
|
+
* Request parameters for convertDealToLead operation in BetaApi.
|
259
|
+
* @export
|
260
|
+
* @interface BetaApiConvertDealToLeadRequest
|
261
|
+
*/
|
262
|
+
export interface BetaApiConvertDealToLeadRequest {
|
263
|
+
/**
|
264
|
+
* The ID of the deal to convert
|
265
|
+
* @type {number}
|
266
|
+
* @memberof BetaApiConvertDealToLead
|
267
|
+
*/
|
268
|
+
readonly id: number;
|
269
|
+
}
|
270
|
+
/**
|
271
|
+
* Request parameters for convertLeadToDeal operation in BetaApi.
|
272
|
+
* @export
|
273
|
+
* @interface BetaApiConvertLeadToDealRequest
|
274
|
+
*/
|
275
|
+
export interface BetaApiConvertLeadToDealRequest {
|
276
|
+
/**
|
277
|
+
* The ID of the lead to convert
|
278
|
+
* @type {string}
|
279
|
+
* @memberof BetaApiConvertLeadToDeal
|
280
|
+
*/
|
281
|
+
readonly id: string;
|
282
|
+
/**
|
283
|
+
*
|
284
|
+
* @type {ConvertLeadToDealRequest}
|
285
|
+
* @memberof BetaApiConvertLeadToDeal
|
286
|
+
*/
|
287
|
+
readonly ConvertLeadToDealRequest?: ConvertLeadToDealRequest;
|
288
|
+
}
|
151
289
|
/**
|
152
290
|
* Request parameters for deleteInstallment operation in BetaApi.
|
153
291
|
* @export
|
@@ -167,6 +305,25 @@ export interface BetaApiDeleteInstallmentRequest {
|
|
167
305
|
*/
|
168
306
|
readonly installment_id: number;
|
169
307
|
}
|
308
|
+
/**
|
309
|
+
* Request parameters for getDealConversionStatus operation in BetaApi.
|
310
|
+
* @export
|
311
|
+
* @interface BetaApiGetDealConversionStatusRequest
|
312
|
+
*/
|
313
|
+
export interface BetaApiGetDealConversionStatusRequest {
|
314
|
+
/**
|
315
|
+
* The ID of a deal
|
316
|
+
* @type {number}
|
317
|
+
* @memberof BetaApiGetDealConversionStatus
|
318
|
+
*/
|
319
|
+
readonly id: number;
|
320
|
+
/**
|
321
|
+
* The ID of the conversion
|
322
|
+
* @type {string}
|
323
|
+
* @memberof BetaApiGetDealConversionStatus
|
324
|
+
*/
|
325
|
+
readonly conversion_id: string;
|
326
|
+
}
|
170
327
|
/**
|
171
328
|
* Request parameters for getInstallments operation in BetaApi.
|
172
329
|
* @export
|
@@ -204,6 +361,25 @@ export interface BetaApiGetInstallmentsRequest {
|
|
204
361
|
*/
|
205
362
|
readonly sort_direction?: 'asc' | 'desc';
|
206
363
|
}
|
364
|
+
/**
|
365
|
+
* Request parameters for getLeadConversionStatus operation in BetaApi.
|
366
|
+
* @export
|
367
|
+
* @interface BetaApiGetLeadConversionStatusRequest
|
368
|
+
*/
|
369
|
+
export interface BetaApiGetLeadConversionStatusRequest {
|
370
|
+
/**
|
371
|
+
* The ID of a lead
|
372
|
+
* @type {string}
|
373
|
+
* @memberof BetaApiGetLeadConversionStatus
|
374
|
+
*/
|
375
|
+
readonly id: string;
|
376
|
+
/**
|
377
|
+
* The ID of the conversion
|
378
|
+
* @type {string}
|
379
|
+
* @memberof BetaApiGetLeadConversionStatus
|
380
|
+
*/
|
381
|
+
readonly conversion_id: string;
|
382
|
+
}
|
207
383
|
/**
|
208
384
|
* Request parameters for postInstallment operation in BetaApi.
|
209
385
|
* @export
|
@@ -255,6 +431,24 @@ export interface BetaApiUpdateInstallmentRequest {
|
|
255
431
|
* @extends {BaseAPI}
|
256
432
|
*/
|
257
433
|
export declare class BetaApi extends BaseAPI {
|
434
|
+
/**
|
435
|
+
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
436
|
+
* @summary Convert a deal to a lead (BETA)
|
437
|
+
* @param {BetaApiConvertDealToLeadRequest} requestParameters Request parameters.
|
438
|
+
|
439
|
+
* @throws {RequiredError}
|
440
|
+
* @memberof BetaApi
|
441
|
+
*/
|
442
|
+
convertDealToLead(requestParameters: BetaApiConvertDealToLeadRequest): Promise<AddConvertDealToLeadResponse>;
|
443
|
+
/**
|
444
|
+
* Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.
|
445
|
+
* @summary Convert a lead to a deal (BETA)
|
446
|
+
* @param {BetaApiConvertLeadToDealRequest} requestParameters Request parameters.
|
447
|
+
|
448
|
+
* @throws {RequiredError}
|
449
|
+
* @memberof BetaApi
|
450
|
+
*/
|
451
|
+
convertLeadToDeal(requestParameters: BetaApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
|
258
452
|
/**
|
259
453
|
* Removes an installment from a deal. Only available in Advanced and above plans.
|
260
454
|
* @summary Delete an installment from a deal
|
@@ -264,6 +458,15 @@ export declare class BetaApi extends BaseAPI {
|
|
264
458
|
* @memberof BetaApi
|
265
459
|
*/
|
266
460
|
deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
|
461
|
+
/**
|
462
|
+
* Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
463
|
+
* @summary Get Deal conversion status (BETA)
|
464
|
+
* @param {BetaApiGetDealConversionStatusRequest} requestParameters Request parameters.
|
465
|
+
|
466
|
+
* @throws {RequiredError}
|
467
|
+
* @memberof BetaApi
|
468
|
+
*/
|
469
|
+
getDealConversionStatus(requestParameters: BetaApiGetDealConversionStatusRequest): Promise<GetConvertResponse1>;
|
267
470
|
/**
|
268
471
|
* Lists installments attached to a list of deals. Only available in Advanced and above plans.
|
269
472
|
* @summary List installments added to a list of deals
|
@@ -273,6 +476,15 @@ export declare class BetaApi extends BaseAPI {
|
|
273
476
|
* @memberof BetaApi
|
274
477
|
*/
|
275
478
|
getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
|
479
|
+
/**
|
480
|
+
* Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
|
481
|
+
* @summary Get Lead conversion status (BETA)
|
482
|
+
* @param {BetaApiGetLeadConversionStatusRequest} requestParameters Request parameters.
|
483
|
+
|
484
|
+
* @throws {RequiredError}
|
485
|
+
* @memberof BetaApi
|
486
|
+
*/
|
487
|
+
getLeadConversionStatus(requestParameters: BetaApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
|
276
488
|
/**
|
277
489
|
* Adds an installment to a deal. An installment can only be added if the deal includes at least one one-time product. If the deal contains at least one recurring product, adding installments is not allowed. Only available in Advanced and above plans.
|
278
490
|
* @summary Add an installment to a deal
|