pipedrive 35.1.2 → 36.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/leads-api.d.ts +7 -7
- package/dist/esm/versions/v1/api/leads-api.js +2 -2
- package/dist/esm/versions/v2/api/activities-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/activities-api.js +2 -2
- package/dist/esm/versions/v2/api/deals-api.d.ts +14 -14
- package/dist/esm/versions/v2/api/deals-api.js +4 -4
- package/dist/esm/versions/v2/api/organizations-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/organizations-api.js +2 -2
- package/dist/esm/versions/v2/api/persons-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/persons-api.js +2 -2
- package/dist/esm/versions/v2/api/products-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/products-api.js +2 -2
- package/dist/versions/v1/api/leads-api.d.ts +7 -7
- package/dist/versions/v1/api/leads-api.js +2 -2
- package/dist/versions/v2/api/activities-api.d.ts +7 -7
- package/dist/versions/v2/api/activities-api.js +2 -2
- package/dist/versions/v2/api/deals-api.d.ts +14 -14
- package/dist/versions/v2/api/deals-api.js +4 -4
- package/dist/versions/v2/api/organizations-api.d.ts +7 -7
- package/dist/versions/v2/api/organizations-api.js +2 -2
- package/dist/versions/v2/api/persons-api.d.ts +7 -7
- package/dist/versions/v2/api/persons-api.js +2 -2
- package/dist/versions/v2/api/products-api.d.ts +7 -7
- package/dist/versions/v2/api/products-api.js +2 -2
- package/package.json +1 -1
|
@@ -80,11 +80,11 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
80
80
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
81
81
|
* @param {number} [filter_id] The ID of the filter to use
|
|
82
82
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
83
|
-
* @param {
|
|
83
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
84
84
|
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
*/
|
|
87
|
-
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?:
|
|
87
|
+
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
89
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
90
90
|
* @summary Search leads
|
|
@@ -171,11 +171,11 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
171
171
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
172
172
|
* @param {number} [filter_id] The ID of the filter to use
|
|
173
173
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
174
|
-
* @param {
|
|
174
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
175
175
|
|
|
176
176
|
* @throws {RequiredError}
|
|
177
177
|
*/
|
|
178
|
-
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?:
|
|
178
|
+
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
179
179
|
/**
|
|
180
180
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
181
181
|
* @summary Search leads
|
|
@@ -421,11 +421,11 @@ export interface LeadsApiGetLeadsRequest {
|
|
|
421
421
|
*/
|
|
422
422
|
readonly updated_since?: string;
|
|
423
423
|
/**
|
|
424
|
-
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
425
|
-
* @type {
|
|
424
|
+
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
425
|
+
* @type {string}
|
|
426
426
|
* @memberof LeadsApiGetLeads
|
|
427
427
|
*/
|
|
428
|
-
readonly sort?:
|
|
428
|
+
readonly sort?: string;
|
|
429
429
|
}
|
|
430
430
|
/**
|
|
431
431
|
* Request parameters for searchLeads operation in LeadsApi.
|
|
@@ -235,7 +235,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
235
235
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
236
236
|
* @param {number} [filter_id] The ID of the filter to use
|
|
237
237
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
238
|
-
* @param {
|
|
238
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
239
239
|
|
|
240
240
|
* @throws {RequiredError}
|
|
241
241
|
*/
|
|
@@ -478,7 +478,7 @@ export const LeadsApiFp = function (configuration) {
|
|
|
478
478
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
479
479
|
* @param {number} [filter_id] The ID of the filter to use
|
|
480
480
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
481
|
-
* @param {
|
|
481
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
482
482
|
|
|
483
483
|
* @throws {RequiredError}
|
|
484
484
|
*/
|
|
@@ -41,7 +41,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
41
41
|
* Returns data about all activities.
|
|
42
42
|
* @summary Get all activities
|
|
43
43
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
44
|
-
* @param {Set<
|
|
44
|
+
* @param {Set<number>} [ids] 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.
|
|
45
45
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
46
46
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
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.
|
|
@@ -58,7 +58,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
58
58
|
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
*/
|
|
61
|
-
getActivities: (filter_id?: number, ids?: Set<
|
|
61
|
+
getActivities: (filter_id?: number, ids?: Set<number>, 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?: Set<'attendees'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
62
62
|
/**
|
|
63
63
|
* Returns the details of a specific activity.
|
|
64
64
|
* @summary Get details of an activity
|
|
@@ -103,7 +103,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
|
103
103
|
* Returns data about all activities.
|
|
104
104
|
* @summary Get all activities
|
|
105
105
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
106
|
-
* @param {Set<
|
|
106
|
+
* @param {Set<number>} [ids] 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.
|
|
107
107
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
108
108
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
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.
|
|
@@ -120,7 +120,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
|
120
120
|
|
|
121
121
|
* @throws {RequiredError}
|
|
122
122
|
*/
|
|
123
|
-
getActivities(filter_id?: number, ids?: Set<
|
|
123
|
+
getActivities(filter_id?: number, ids?: Set<number>, 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?: Set<'attendees'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
|
|
124
124
|
/**
|
|
125
125
|
* Returns the details of a specific activity.
|
|
126
126
|
* @summary Get details of an activity
|
|
@@ -225,11 +225,11 @@ export interface ActivitiesApiGetActivitiesRequest {
|
|
|
225
225
|
*/
|
|
226
226
|
readonly filter_id?: number;
|
|
227
227
|
/**
|
|
228
|
-
* Optional comma separated
|
|
229
|
-
* @type {Set<
|
|
228
|
+
* 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.
|
|
229
|
+
* @type {Set<number>}
|
|
230
230
|
* @memberof ActivitiesApiGetActivities
|
|
231
231
|
*/
|
|
232
|
-
readonly ids?: Set<
|
|
232
|
+
readonly ids?: Set<number>;
|
|
233
233
|
/**
|
|
234
234
|
* If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
235
235
|
* @type {number}
|
|
@@ -103,7 +103,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
103
103
|
* Returns data about all activities.
|
|
104
104
|
* @summary Get all activities
|
|
105
105
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
106
|
-
* @param {Set<
|
|
106
|
+
* @param {Set<number>} [ids] 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.
|
|
107
107
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
108
108
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
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.
|
|
@@ -303,7 +303,7 @@ export const ActivitiesApiFp = function (configuration) {
|
|
|
303
303
|
* Returns data about all activities.
|
|
304
304
|
* @summary Get all activities
|
|
305
305
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
306
|
-
* @param {Set<
|
|
306
|
+
* @param {Set<number>} [ids] 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.
|
|
307
307
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
308
308
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
309
309
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -99,7 +99,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
99
99
|
* Returns data about all archived deals.
|
|
100
100
|
* @summary Get all archived deals
|
|
101
101
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
102
|
-
* @param {Set<
|
|
102
|
+
* @param {Set<number>} [ids] 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.
|
|
103
103
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
104
104
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
105
105
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -117,7 +117,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
117
117
|
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
|
-
getArchivedDeals: (filter_id?: number, ids?: Set<
|
|
120
|
+
getArchivedDeals: (filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
121
121
|
/**
|
|
122
122
|
* Returns the details of a specific deal.
|
|
123
123
|
* @summary Get details of a deal
|
|
@@ -163,7 +163,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
163
163
|
* Returns data about all not archived deals.
|
|
164
164
|
* @summary Get all deals
|
|
165
165
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
166
|
-
* @param {Set<
|
|
166
|
+
* @param {Set<number>} [ids] 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.
|
|
167
167
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
168
168
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
169
169
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -183,7 +183,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
183
183
|
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
|
-
getDeals: (filter_id?: number, ids?: Set<
|
|
186
|
+
getDeals: (filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
187
187
|
/**
|
|
188
188
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
189
189
|
* @summary Add a discount to a deal
|
|
@@ -297,7 +297,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
297
297
|
* Returns data about all archived deals.
|
|
298
298
|
* @summary Get all archived deals
|
|
299
299
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
300
|
-
* @param {Set<
|
|
300
|
+
* @param {Set<number>} [ids] 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.
|
|
301
301
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
302
302
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
303
303
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -315,7 +315,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
315
315
|
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
318
|
-
getArchivedDeals(filter_id?: number, ids?: Set<
|
|
318
|
+
getArchivedDeals(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
319
319
|
/**
|
|
320
320
|
* Returns the details of a specific deal.
|
|
321
321
|
* @summary Get details of a deal
|
|
@@ -361,7 +361,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
361
361
|
* Returns data about all not archived deals.
|
|
362
362
|
* @summary Get all deals
|
|
363
363
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
364
|
-
* @param {Set<
|
|
364
|
+
* @param {Set<number>} [ids] 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.
|
|
365
365
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
366
366
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
367
367
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -381,7 +381,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
381
381
|
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
*/
|
|
384
|
-
getDeals(filter_id?: number, ids?: Set<
|
|
384
|
+
getDeals(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
385
385
|
/**
|
|
386
386
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
387
387
|
* @summary Add a discount to a deal
|
|
@@ -691,11 +691,11 @@ export interface DealsApiGetArchivedDealsRequest {
|
|
|
691
691
|
*/
|
|
692
692
|
readonly filter_id?: number;
|
|
693
693
|
/**
|
|
694
|
-
* Optional comma separated
|
|
695
|
-
* @type {Set<
|
|
694
|
+
* 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.
|
|
695
|
+
* @type {Set<number>}
|
|
696
696
|
* @memberof DealsApiGetArchivedDeals
|
|
697
697
|
*/
|
|
698
|
-
readonly ids?: Set<
|
|
698
|
+
readonly ids?: Set<number>;
|
|
699
699
|
/**
|
|
700
700
|
* If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
701
701
|
* @type {number}
|
|
@@ -900,11 +900,11 @@ export interface DealsApiGetDealsRequest {
|
|
|
900
900
|
*/
|
|
901
901
|
readonly filter_id?: number;
|
|
902
902
|
/**
|
|
903
|
-
* Optional comma separated
|
|
904
|
-
* @type {Set<
|
|
903
|
+
* 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.
|
|
904
|
+
* @type {Set<number>}
|
|
905
905
|
* @memberof DealsApiGetDeals
|
|
906
906
|
*/
|
|
907
|
-
readonly ids?: Set<
|
|
907
|
+
readonly ids?: Set<number>;
|
|
908
908
|
/**
|
|
909
909
|
* If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
910
910
|
* @type {number}
|
|
@@ -284,7 +284,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
284
284
|
* Returns data about all archived deals.
|
|
285
285
|
* @summary Get all archived deals
|
|
286
286
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
287
|
-
* @param {Set<
|
|
287
|
+
* @param {Set<number>} [ids] 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.
|
|
288
288
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
289
289
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
290
290
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -550,7 +550,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
550
550
|
* Returns data about all not archived deals.
|
|
551
551
|
* @summary Get all deals
|
|
552
552
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
553
|
-
* @param {Set<
|
|
553
|
+
* @param {Set<number>} [ids] 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.
|
|
554
554
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
555
555
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
556
556
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -938,7 +938,7 @@ export const DealsApiFp = function (configuration) {
|
|
|
938
938
|
* Returns data about all archived deals.
|
|
939
939
|
* @summary Get all archived deals
|
|
940
940
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
941
|
-
* @param {Set<
|
|
941
|
+
* @param {Set<number>} [ids] 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.
|
|
942
942
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
943
943
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
944
944
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -1027,7 +1027,7 @@ export const DealsApiFp = function (configuration) {
|
|
|
1027
1027
|
* Returns data about all not archived deals.
|
|
1028
1028
|
* @summary Get all deals
|
|
1029
1029
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
1030
|
-
* @param {Set<
|
|
1030
|
+
* @param {Set<number>} [ids] 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.
|
|
1031
1031
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
1032
1032
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
1033
1033
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -98,7 +98,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
98
98
|
* Returns data about all organizations.
|
|
99
99
|
* @summary Get all organizations
|
|
100
100
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
101
|
-
* @param {Set<
|
|
101
|
+
* @param {Set<number>} [ids] 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.
|
|
102
102
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
103
103
|
* @param {string} [updated_since] 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.
|
|
104
104
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -113,7 +113,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
113
113
|
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
116
|
-
getOrganizations: (filter_id?: number, ids?: Set<
|
|
116
|
+
getOrganizations: (filter_id?: number, ids?: Set<number>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
117
117
|
/**
|
|
118
118
|
* Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
119
119
|
* @summary Search organizations
|
|
@@ -211,7 +211,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
211
211
|
* Returns data about all organizations.
|
|
212
212
|
* @summary Get all organizations
|
|
213
213
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
214
|
-
* @param {Set<
|
|
214
|
+
* @param {Set<number>} [ids] 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.
|
|
215
215
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
216
216
|
* @param {string} [updated_since] 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.
|
|
217
217
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -226,7 +226,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
226
226
|
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
getOrganizations(filter_id?: number, ids?: Set<
|
|
229
|
+
getOrganizations(filter_id?: number, ids?: Set<number>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
|
|
230
230
|
/**
|
|
231
231
|
* Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
232
232
|
* @summary Search organizations
|
|
@@ -499,11 +499,11 @@ export interface OrganizationsApiGetOrganizationsRequest {
|
|
|
499
499
|
*/
|
|
500
500
|
readonly filter_id?: number;
|
|
501
501
|
/**
|
|
502
|
-
* Optional comma separated
|
|
503
|
-
* @type {Set<
|
|
502
|
+
* 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.
|
|
503
|
+
* @type {Set<number>}
|
|
504
504
|
* @memberof OrganizationsApiGetOrganizations
|
|
505
505
|
*/
|
|
506
|
-
readonly ids?: Set<
|
|
506
|
+
readonly ids?: Set<number>;
|
|
507
507
|
/**
|
|
508
508
|
* If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
509
509
|
* @type {number}
|
|
@@ -312,7 +312,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
312
312
|
* Returns data about all organizations.
|
|
313
313
|
* @summary Get all organizations
|
|
314
314
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
315
|
-
* @param {Set<
|
|
315
|
+
* @param {Set<number>} [ids] 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.
|
|
316
316
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
317
317
|
* @param {string} [updated_since] 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.
|
|
318
318
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -593,7 +593,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
593
593
|
* Returns data about all organizations.
|
|
594
594
|
* @summary Get all organizations
|
|
595
595
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
596
|
-
* @param {Set<
|
|
596
|
+
* @param {Set<number>} [ids] 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.
|
|
597
597
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
598
598
|
* @param {string} [updated_since] 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.
|
|
599
599
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -107,7 +107,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
107
107
|
* 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.
|
|
108
108
|
* @summary Get all persons
|
|
109
109
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
110
|
-
* @param {Set<
|
|
110
|
+
* @param {Set<number>} [ids] 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.
|
|
111
111
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
112
112
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
113
113
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -124,7 +124,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
124
124
|
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
127
|
-
getPersons: (filter_id?: number, ids?: Set<
|
|
127
|
+
getPersons: (filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
128
128
|
/**
|
|
129
129
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
130
130
|
* @summary Search persons
|
|
@@ -232,7 +232,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
232
232
|
* 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.
|
|
233
233
|
* @summary Get all persons
|
|
234
234
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
235
|
-
* @param {Set<
|
|
235
|
+
* @param {Set<number>} [ids] 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.
|
|
236
236
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
237
237
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
238
238
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -249,7 +249,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
249
249
|
|
|
250
250
|
* @throws {RequiredError}
|
|
251
251
|
*/
|
|
252
|
-
getPersons(filter_id?: number, ids?: Set<
|
|
252
|
+
getPersons(filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
|
253
253
|
/**
|
|
254
254
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
255
255
|
* @summary Search persons
|
|
@@ -545,11 +545,11 @@ export interface PersonsApiGetPersonsRequest {
|
|
|
545
545
|
*/
|
|
546
546
|
readonly filter_id?: number;
|
|
547
547
|
/**
|
|
548
|
-
* Optional comma separated
|
|
549
|
-
* @type {Set<
|
|
548
|
+
* 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.
|
|
549
|
+
* @type {Set<number>}
|
|
550
550
|
* @memberof PersonsApiGetPersons
|
|
551
551
|
*/
|
|
552
|
-
readonly ids?: Set<
|
|
552
|
+
readonly ids?: Set<number>;
|
|
553
553
|
/**
|
|
554
554
|
* If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
555
555
|
* @type {number}
|
|
@@ -346,7 +346,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
346
346
|
* 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.
|
|
347
347
|
* @summary Get all persons
|
|
348
348
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
349
|
-
* @param {Set<
|
|
349
|
+
* @param {Set<number>} [ids] 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.
|
|
350
350
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
351
351
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
352
352
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -656,7 +656,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
656
656
|
* 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.
|
|
657
657
|
* @summary Get all persons
|
|
658
658
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
659
|
-
* @param {Set<
|
|
659
|
+
* @param {Set<number>} [ids] 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.
|
|
660
660
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
661
661
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
662
662
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -156,7 +156,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
156
156
|
* Returns data about all products.
|
|
157
157
|
* @summary Get all products
|
|
158
158
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
159
|
-
* @param {Set<
|
|
159
|
+
* @param {Set<number>} [ids] 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.
|
|
160
160
|
* @param {Set<string>} [custom_fields] 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.
|
|
161
161
|
* @param {number} [filter_id] The ID of the filter to use
|
|
162
162
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -167,7 +167,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
167
167
|
|
|
168
168
|
* @throws {RequiredError}
|
|
169
169
|
*/
|
|
170
|
-
getProducts: (owner_id?: number, ids?: Set<
|
|
170
|
+
getProducts: (owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string) => Promise<RequestArgs>;
|
|
171
171
|
/**
|
|
172
172
|
* Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
173
173
|
* @summary Search products
|
|
@@ -342,7 +342,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
342
342
|
* Returns data about all products.
|
|
343
343
|
* @summary Get all products
|
|
344
344
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
345
|
-
* @param {Set<
|
|
345
|
+
* @param {Set<number>} [ids] 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.
|
|
346
346
|
* @param {Set<string>} [custom_fields] 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.
|
|
347
347
|
* @param {number} [filter_id] The ID of the filter to use
|
|
348
348
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -353,7 +353,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
353
353
|
|
|
354
354
|
* @throws {RequiredError}
|
|
355
355
|
*/
|
|
356
|
-
getProducts(owner_id?: number, ids?: Set<
|
|
356
|
+
getProducts(owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
|
|
357
357
|
/**
|
|
358
358
|
* Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
359
359
|
* @summary Search products
|
|
@@ -805,11 +805,11 @@ export interface ProductsApiGetProductsRequest {
|
|
|
805
805
|
*/
|
|
806
806
|
readonly owner_id?: number;
|
|
807
807
|
/**
|
|
808
|
-
* Optional comma separated
|
|
809
|
-
* @type {Set<
|
|
808
|
+
* 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.
|
|
809
|
+
* @type {Set<number>}
|
|
810
810
|
* @memberof ProductsApiGetProducts
|
|
811
811
|
*/
|
|
812
|
-
readonly ids?: Set<
|
|
812
|
+
readonly ids?: Set<number>;
|
|
813
813
|
/**
|
|
814
814
|
* 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.
|
|
815
815
|
* @type {Set<string>}
|
|
@@ -515,7 +515,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
515
515
|
* Returns data about all products.
|
|
516
516
|
* @summary Get all products
|
|
517
517
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
518
|
-
* @param {Set<
|
|
518
|
+
* @param {Set<number>} [ids] 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.
|
|
519
519
|
* @param {Set<string>} [custom_fields] 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.
|
|
520
520
|
* @param {number} [filter_id] The ID of the filter to use
|
|
521
521
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -989,7 +989,7 @@ export const ProductsApiFp = function (configuration) {
|
|
|
989
989
|
* Returns data about all products.
|
|
990
990
|
* @summary Get all products
|
|
991
991
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
992
|
-
* @param {Set<
|
|
992
|
+
* @param {Set<number>} [ids] 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.
|
|
993
993
|
* @param {Set<string>} [custom_fields] 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.
|
|
994
994
|
* @param {number} [filter_id] The ID of the filter to use
|
|
995
995
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -80,11 +80,11 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
80
80
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
81
81
|
* @param {number} [filter_id] The ID of the filter to use
|
|
82
82
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
83
|
-
* @param {
|
|
83
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
84
84
|
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
*/
|
|
87
|
-
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?:
|
|
87
|
+
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
89
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
90
90
|
* @summary Search leads
|
|
@@ -171,11 +171,11 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
171
171
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
172
172
|
* @param {number} [filter_id] The ID of the filter to use
|
|
173
173
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
174
|
-
* @param {
|
|
174
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
175
175
|
|
|
176
176
|
* @throws {RequiredError}
|
|
177
177
|
*/
|
|
178
|
-
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?:
|
|
178
|
+
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
179
179
|
/**
|
|
180
180
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
181
181
|
* @summary Search leads
|
|
@@ -421,11 +421,11 @@ export interface LeadsApiGetLeadsRequest {
|
|
|
421
421
|
*/
|
|
422
422
|
readonly updated_since?: string;
|
|
423
423
|
/**
|
|
424
|
-
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
425
|
-
* @type {
|
|
424
|
+
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
425
|
+
* @type {string}
|
|
426
426
|
* @memberof LeadsApiGetLeads
|
|
427
427
|
*/
|
|
428
|
-
readonly sort?:
|
|
428
|
+
readonly sort?: string;
|
|
429
429
|
}
|
|
430
430
|
/**
|
|
431
431
|
* Request parameters for searchLeads operation in LeadsApi.
|
|
@@ -241,7 +241,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
241
241
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
242
242
|
* @param {number} [filter_id] The ID of the filter to use
|
|
243
243
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
244
|
-
* @param {
|
|
244
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
245
245
|
|
|
246
246
|
* @throws {RequiredError}
|
|
247
247
|
*/
|
|
@@ -485,7 +485,7 @@ const LeadsApiFp = function (configuration) {
|
|
|
485
485
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
486
486
|
* @param {number} [filter_id] The ID of the filter to use
|
|
487
487
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
488
|
-
* @param {
|
|
488
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
489
489
|
|
|
490
490
|
* @throws {RequiredError}
|
|
491
491
|
*/
|
|
@@ -41,7 +41,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
41
41
|
* Returns data about all activities.
|
|
42
42
|
* @summary Get all activities
|
|
43
43
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
44
|
-
* @param {Set<
|
|
44
|
+
* @param {Set<number>} [ids] 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.
|
|
45
45
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
46
46
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
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.
|
|
@@ -58,7 +58,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
58
58
|
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
*/
|
|
61
|
-
getActivities: (filter_id?: number, ids?: Set<
|
|
61
|
+
getActivities: (filter_id?: number, ids?: Set<number>, 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?: Set<'attendees'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
62
62
|
/**
|
|
63
63
|
* Returns the details of a specific activity.
|
|
64
64
|
* @summary Get details of an activity
|
|
@@ -103,7 +103,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
|
103
103
|
* Returns data about all activities.
|
|
104
104
|
* @summary Get all activities
|
|
105
105
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
106
|
-
* @param {Set<
|
|
106
|
+
* @param {Set<number>} [ids] 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.
|
|
107
107
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
108
108
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
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.
|
|
@@ -120,7 +120,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
|
120
120
|
|
|
121
121
|
* @throws {RequiredError}
|
|
122
122
|
*/
|
|
123
|
-
getActivities(filter_id?: number, ids?: Set<
|
|
123
|
+
getActivities(filter_id?: number, ids?: Set<number>, 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?: Set<'attendees'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
|
|
124
124
|
/**
|
|
125
125
|
* Returns the details of a specific activity.
|
|
126
126
|
* @summary Get details of an activity
|
|
@@ -225,11 +225,11 @@ export interface ActivitiesApiGetActivitiesRequest {
|
|
|
225
225
|
*/
|
|
226
226
|
readonly filter_id?: number;
|
|
227
227
|
/**
|
|
228
|
-
* Optional comma separated
|
|
229
|
-
* @type {Set<
|
|
228
|
+
* 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.
|
|
229
|
+
* @type {Set<number>}
|
|
230
230
|
* @memberof ActivitiesApiGetActivities
|
|
231
231
|
*/
|
|
232
|
-
readonly ids?: Set<
|
|
232
|
+
readonly ids?: Set<number>;
|
|
233
233
|
/**
|
|
234
234
|
* If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
235
235
|
* @type {number}
|
|
@@ -109,7 +109,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
109
109
|
* Returns data about all activities.
|
|
110
110
|
* @summary Get all activities
|
|
111
111
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
112
|
-
* @param {Set<
|
|
112
|
+
* @param {Set<number>} [ids] 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.
|
|
113
113
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
114
114
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
115
115
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -310,7 +310,7 @@ const ActivitiesApiFp = function (configuration) {
|
|
|
310
310
|
* Returns data about all activities.
|
|
311
311
|
* @summary Get all activities
|
|
312
312
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
313
|
-
* @param {Set<
|
|
313
|
+
* @param {Set<number>} [ids] 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.
|
|
314
314
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
315
315
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
316
316
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -99,7 +99,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
99
99
|
* Returns data about all archived deals.
|
|
100
100
|
* @summary Get all archived deals
|
|
101
101
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
102
|
-
* @param {Set<
|
|
102
|
+
* @param {Set<number>} [ids] 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.
|
|
103
103
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
104
104
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
105
105
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -117,7 +117,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
117
117
|
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
|
-
getArchivedDeals: (filter_id?: number, ids?: Set<
|
|
120
|
+
getArchivedDeals: (filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
121
121
|
/**
|
|
122
122
|
* Returns the details of a specific deal.
|
|
123
123
|
* @summary Get details of a deal
|
|
@@ -163,7 +163,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
163
163
|
* Returns data about all not archived deals.
|
|
164
164
|
* @summary Get all deals
|
|
165
165
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
166
|
-
* @param {Set<
|
|
166
|
+
* @param {Set<number>} [ids] 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.
|
|
167
167
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
168
168
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
169
169
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -183,7 +183,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
183
183
|
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
|
-
getDeals: (filter_id?: number, ids?: Set<
|
|
186
|
+
getDeals: (filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
187
187
|
/**
|
|
188
188
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
189
189
|
* @summary Add a discount to a deal
|
|
@@ -297,7 +297,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
297
297
|
* Returns data about all archived deals.
|
|
298
298
|
* @summary Get all archived deals
|
|
299
299
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
300
|
-
* @param {Set<
|
|
300
|
+
* @param {Set<number>} [ids] 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.
|
|
301
301
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
302
302
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
303
303
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -315,7 +315,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
315
315
|
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
318
|
-
getArchivedDeals(filter_id?: number, ids?: Set<
|
|
318
|
+
getArchivedDeals(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
319
319
|
/**
|
|
320
320
|
* Returns the details of a specific deal.
|
|
321
321
|
* @summary Get details of a deal
|
|
@@ -361,7 +361,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
361
361
|
* Returns data about all not archived deals.
|
|
362
362
|
* @summary Get all deals
|
|
363
363
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
364
|
-
* @param {Set<
|
|
364
|
+
* @param {Set<number>} [ids] 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.
|
|
365
365
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
366
366
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
367
367
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -381,7 +381,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
381
381
|
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
*/
|
|
384
|
-
getDeals(filter_id?: number, ids?: Set<
|
|
384
|
+
getDeals(filter_id?: number, ids?: Set<number>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
385
385
|
/**
|
|
386
386
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
387
387
|
* @summary Add a discount to a deal
|
|
@@ -691,11 +691,11 @@ export interface DealsApiGetArchivedDealsRequest {
|
|
|
691
691
|
*/
|
|
692
692
|
readonly filter_id?: number;
|
|
693
693
|
/**
|
|
694
|
-
* Optional comma separated
|
|
695
|
-
* @type {Set<
|
|
694
|
+
* 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.
|
|
695
|
+
* @type {Set<number>}
|
|
696
696
|
* @memberof DealsApiGetArchivedDeals
|
|
697
697
|
*/
|
|
698
|
-
readonly ids?: Set<
|
|
698
|
+
readonly ids?: Set<number>;
|
|
699
699
|
/**
|
|
700
700
|
* If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
701
701
|
* @type {number}
|
|
@@ -900,11 +900,11 @@ export interface DealsApiGetDealsRequest {
|
|
|
900
900
|
*/
|
|
901
901
|
readonly filter_id?: number;
|
|
902
902
|
/**
|
|
903
|
-
* Optional comma separated
|
|
904
|
-
* @type {Set<
|
|
903
|
+
* 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.
|
|
904
|
+
* @type {Set<number>}
|
|
905
905
|
* @memberof DealsApiGetDeals
|
|
906
906
|
*/
|
|
907
|
-
readonly ids?: Set<
|
|
907
|
+
readonly ids?: Set<number>;
|
|
908
908
|
/**
|
|
909
909
|
* If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
910
910
|
* @type {number}
|
|
@@ -290,7 +290,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
290
290
|
* Returns data about all archived deals.
|
|
291
291
|
* @summary Get all archived deals
|
|
292
292
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
293
|
-
* @param {Set<
|
|
293
|
+
* @param {Set<number>} [ids] 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.
|
|
294
294
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
295
295
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
296
296
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -556,7 +556,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
556
556
|
* Returns data about all not archived deals.
|
|
557
557
|
* @summary Get all deals
|
|
558
558
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
559
|
-
* @param {Set<
|
|
559
|
+
* @param {Set<number>} [ids] 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.
|
|
560
560
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
561
561
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
562
562
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -945,7 +945,7 @@ const DealsApiFp = function (configuration) {
|
|
|
945
945
|
* Returns data about all archived deals.
|
|
946
946
|
* @summary Get all archived deals
|
|
947
947
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
948
|
-
* @param {Set<
|
|
948
|
+
* @param {Set<number>} [ids] 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.
|
|
949
949
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
950
950
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
951
951
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -1034,7 +1034,7 @@ const DealsApiFp = function (configuration) {
|
|
|
1034
1034
|
* Returns data about all not archived deals.
|
|
1035
1035
|
* @summary Get all deals
|
|
1036
1036
|
* @param {number} [filter_id] If supplied, only deals matching the specified filter are returned
|
|
1037
|
-
* @param {Set<
|
|
1037
|
+
* @param {Set<number>} [ids] 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.
|
|
1038
1038
|
* @param {number} [owner_id] If supplied, only deals owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
1039
1039
|
* @param {number} [person_id] If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
|
|
1040
1040
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
@@ -98,7 +98,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
98
98
|
* Returns data about all organizations.
|
|
99
99
|
* @summary Get all organizations
|
|
100
100
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
101
|
-
* @param {Set<
|
|
101
|
+
* @param {Set<number>} [ids] 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.
|
|
102
102
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
103
103
|
* @param {string} [updated_since] 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.
|
|
104
104
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -113,7 +113,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
113
113
|
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
116
|
-
getOrganizations: (filter_id?: number, ids?: Set<
|
|
116
|
+
getOrganizations: (filter_id?: number, ids?: Set<number>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
117
117
|
/**
|
|
118
118
|
* Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
119
119
|
* @summary Search organizations
|
|
@@ -211,7 +211,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
211
211
|
* Returns data about all organizations.
|
|
212
212
|
* @summary Get all organizations
|
|
213
213
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
214
|
-
* @param {Set<
|
|
214
|
+
* @param {Set<number>} [ids] 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.
|
|
215
215
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
216
216
|
* @param {string} [updated_since] 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.
|
|
217
217
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -226,7 +226,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
226
226
|
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
getOrganizations(filter_id?: number, ids?: Set<
|
|
229
|
+
getOrganizations(filter_id?: number, ids?: Set<number>, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationsResponse>>;
|
|
230
230
|
/**
|
|
231
231
|
* Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
232
232
|
* @summary Search organizations
|
|
@@ -499,11 +499,11 @@ export interface OrganizationsApiGetOrganizationsRequest {
|
|
|
499
499
|
*/
|
|
500
500
|
readonly filter_id?: number;
|
|
501
501
|
/**
|
|
502
|
-
* Optional comma separated
|
|
503
|
-
* @type {Set<
|
|
502
|
+
* 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.
|
|
503
|
+
* @type {Set<number>}
|
|
504
504
|
* @memberof OrganizationsApiGetOrganizations
|
|
505
505
|
*/
|
|
506
|
-
readonly ids?: Set<
|
|
506
|
+
readonly ids?: Set<number>;
|
|
507
507
|
/**
|
|
508
508
|
* If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
509
509
|
* @type {number}
|
|
@@ -318,7 +318,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
318
318
|
* Returns data about all organizations.
|
|
319
319
|
* @summary Get all organizations
|
|
320
320
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
321
|
-
* @param {Set<
|
|
321
|
+
* @param {Set<number>} [ids] 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.
|
|
322
322
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
323
323
|
* @param {string} [updated_since] 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.
|
|
324
324
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -600,7 +600,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
600
600
|
* Returns data about all organizations.
|
|
601
601
|
* @summary Get all organizations
|
|
602
602
|
* @param {number} [filter_id] If supplied, only organizations matching the specified filter are returned
|
|
603
|
-
* @param {Set<
|
|
603
|
+
* @param {Set<number>} [ids] 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.
|
|
604
604
|
* @param {number} [owner_id] If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
605
605
|
* @param {string} [updated_since] 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.
|
|
606
606
|
* @param {string} [updated_until] If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
@@ -107,7 +107,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
107
107
|
* 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.
|
|
108
108
|
* @summary Get all persons
|
|
109
109
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
110
|
-
* @param {Set<
|
|
110
|
+
* @param {Set<number>} [ids] 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.
|
|
111
111
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
112
112
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
113
113
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -124,7 +124,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
124
124
|
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
127
|
-
getPersons: (filter_id?: number, ids?: Set<
|
|
127
|
+
getPersons: (filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
128
128
|
/**
|
|
129
129
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
130
130
|
* @summary Search persons
|
|
@@ -232,7 +232,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
232
232
|
* 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.
|
|
233
233
|
* @summary Get all persons
|
|
234
234
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
235
|
-
* @param {Set<
|
|
235
|
+
* @param {Set<number>} [ids] 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.
|
|
236
236
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
237
237
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
238
238
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -249,7 +249,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
249
249
|
|
|
250
250
|
* @throws {RequiredError}
|
|
251
251
|
*/
|
|
252
|
-
getPersons(filter_id?: number, ids?: Set<
|
|
252
|
+
getPersons(filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'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'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
|
253
253
|
/**
|
|
254
254
|
* Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found persons can be filtered by organization ID.
|
|
255
255
|
* @summary Search persons
|
|
@@ -545,11 +545,11 @@ export interface PersonsApiGetPersonsRequest {
|
|
|
545
545
|
*/
|
|
546
546
|
readonly filter_id?: number;
|
|
547
547
|
/**
|
|
548
|
-
* Optional comma separated
|
|
549
|
-
* @type {Set<
|
|
548
|
+
* 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.
|
|
549
|
+
* @type {Set<number>}
|
|
550
550
|
* @memberof PersonsApiGetPersons
|
|
551
551
|
*/
|
|
552
|
-
readonly ids?: Set<
|
|
552
|
+
readonly ids?: Set<number>;
|
|
553
553
|
/**
|
|
554
554
|
* If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
555
555
|
* @type {number}
|
|
@@ -352,7 +352,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
352
352
|
* 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.
|
|
353
353
|
* @summary Get all persons
|
|
354
354
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
355
|
-
* @param {Set<
|
|
355
|
+
* @param {Set<number>} [ids] 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.
|
|
356
356
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
357
357
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
358
358
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -663,7 +663,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
663
663
|
* 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.
|
|
664
664
|
* @summary Get all persons
|
|
665
665
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
666
|
-
* @param {Set<
|
|
666
|
+
* @param {Set<number>} [ids] 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.
|
|
667
667
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
668
668
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
669
669
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -156,7 +156,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
156
156
|
* Returns data about all products.
|
|
157
157
|
* @summary Get all products
|
|
158
158
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
159
|
-
* @param {Set<
|
|
159
|
+
* @param {Set<number>} [ids] 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.
|
|
160
160
|
* @param {Set<string>} [custom_fields] 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.
|
|
161
161
|
* @param {number} [filter_id] The ID of the filter to use
|
|
162
162
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -167,7 +167,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
167
167
|
|
|
168
168
|
* @throws {RequiredError}
|
|
169
169
|
*/
|
|
170
|
-
getProducts: (owner_id?: number, ids?: Set<
|
|
170
|
+
getProducts: (owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string) => Promise<RequestArgs>;
|
|
171
171
|
/**
|
|
172
172
|
* Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
173
173
|
* @summary Search products
|
|
@@ -342,7 +342,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
342
342
|
* Returns data about all products.
|
|
343
343
|
* @summary Get all products
|
|
344
344
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
345
|
-
* @param {Set<
|
|
345
|
+
* @param {Set<number>} [ids] 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.
|
|
346
346
|
* @param {Set<string>} [custom_fields] 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.
|
|
347
347
|
* @param {number} [filter_id] The ID of the filter to use
|
|
348
348
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -353,7 +353,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
353
353
|
|
|
354
354
|
* @throws {RequiredError}
|
|
355
355
|
*/
|
|
356
|
-
getProducts(owner_id?: number, ids?: Set<
|
|
356
|
+
getProducts(owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
|
|
357
357
|
/**
|
|
358
358
|
* Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope.
|
|
359
359
|
* @summary Search products
|
|
@@ -805,11 +805,11 @@ export interface ProductsApiGetProductsRequest {
|
|
|
805
805
|
*/
|
|
806
806
|
readonly owner_id?: number;
|
|
807
807
|
/**
|
|
808
|
-
* Optional comma separated
|
|
809
|
-
* @type {Set<
|
|
808
|
+
* 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.
|
|
809
|
+
* @type {Set<number>}
|
|
810
810
|
* @memberof ProductsApiGetProducts
|
|
811
811
|
*/
|
|
812
|
-
readonly ids?: Set<
|
|
812
|
+
readonly ids?: Set<number>;
|
|
813
813
|
/**
|
|
814
814
|
* 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.
|
|
815
815
|
* @type {Set<string>}
|
|
@@ -521,7 +521,7 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
521
521
|
* Returns data about all products.
|
|
522
522
|
* @summary Get all products
|
|
523
523
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
524
|
-
* @param {Set<
|
|
524
|
+
* @param {Set<number>} [ids] 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.
|
|
525
525
|
* @param {Set<string>} [custom_fields] 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.
|
|
526
526
|
* @param {number} [filter_id] The ID of the filter to use
|
|
527
527
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -996,7 +996,7 @@ const ProductsApiFp = function (configuration) {
|
|
|
996
996
|
* Returns data about all products.
|
|
997
997
|
* @summary Get all products
|
|
998
998
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
999
|
-
* @param {Set<
|
|
999
|
+
* @param {Set<number>} [ids] 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.
|
|
1000
1000
|
* @param {Set<string>} [custom_fields] 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.
|
|
1001
1001
|
* @param {number} [filter_id] The ID of the filter to use
|
|
1002
1002
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|