pipedrive 35.1.1 → 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/beta-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/beta-api.js +2 -2
- package/dist/esm/versions/v2/api/deals-api.d.ts +17 -17
- package/dist/esm/versions/v2/api/deals-api.js +6 -6
- package/dist/esm/versions/v2/api/leads-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/leads-api.js +2 -2
- package/dist/esm/versions/v2/api/organizations-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/organizations-api.js +4 -4
- package/dist/esm/versions/v2/api/persons-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/persons-api.js +4 -4
- package/dist/esm/versions/v2/api/products-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/products-api.js +4 -4
- package/dist/esm/versions/v2/api/projects-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/projects-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/beta-api.d.ts +3 -3
- package/dist/versions/v2/api/beta-api.js +2 -2
- package/dist/versions/v2/api/deals-api.d.ts +17 -17
- package/dist/versions/v2/api/deals-api.js +6 -6
- package/dist/versions/v2/api/leads-api.d.ts +3 -3
- package/dist/versions/v2/api/leads-api.js +2 -2
- package/dist/versions/v2/api/organizations-api.d.ts +10 -10
- package/dist/versions/v2/api/organizations-api.js +4 -4
- package/dist/versions/v2/api/persons-api.d.ts +10 -10
- package/dist/versions/v2/api/persons-api.js +4 -4
- package/dist/versions/v2/api/products-api.d.ts +10 -10
- package/dist/versions/v2/api/products-api.js +4 -4
- package/dist/versions/v2/api/projects-api.d.ts +3 -3
- package/dist/versions/v2/api/projects-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.
|
|
@@ -204,7 +204,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
204
204
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
205
205
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
206
206
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
207
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
207
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
208
208
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
209
209
|
|
|
210
210
|
* @throws {RequiredError}
|
|
@@ -421,7 +421,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
|
421
421
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
422
422
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
423
423
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
424
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
424
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
425
425
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
426
426
|
|
|
427
427
|
* @throws {RequiredError}
|
|
@@ -982,7 +982,7 @@ export interface BetaApiSearchProjectsRequest {
|
|
|
982
982
|
*/
|
|
983
983
|
readonly organization_id?: number;
|
|
984
984
|
/**
|
|
985
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
985
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
986
986
|
* @type {number}
|
|
987
987
|
* @memberof BetaApiSearchProjects
|
|
988
988
|
*/
|
|
@@ -692,7 +692,7 @@ export const BetaApiAxiosParamCreator = function (configuration) {
|
|
|
692
692
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
693
693
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
694
694
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
695
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
695
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
696
696
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
697
697
|
|
|
698
698
|
* @throws {RequiredError}
|
|
@@ -1192,7 +1192,7 @@ export const BetaApiFp = function (configuration) {
|
|
|
1192
1192
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1193
1193
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
1194
1194
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
1195
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
1195
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
1196
1196
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1197
1197
|
|
|
1198
1198
|
* @throws {RequiredError}
|
|
@@ -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
|
|
@@ -203,7 +203,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
203
203
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
204
204
|
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
205
205
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
206
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
206
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
207
207
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
208
208
|
|
|
209
209
|
* @throws {RequiredError}
|
|
@@ -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
|
|
@@ -401,7 +401,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
401
401
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
402
402
|
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
403
403
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
404
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
404
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
405
405
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
406
406
|
|
|
407
407
|
* @throws {RequiredError}
|
|
@@ -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}
|
|
@@ -1070,7 +1070,7 @@ export interface DealsApiSearchDealsRequest {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
readonly include_fields?: Set<'deal.cc_email'>;
|
|
1072
1072
|
/**
|
|
1073
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
1073
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
1074
1074
|
* @type {number}
|
|
1075
1075
|
* @memberof DealsApiSearchDeals
|
|
1076
1076
|
*/
|
|
@@ -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.
|
|
@@ -695,7 +695,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
695
695
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
696
696
|
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
697
697
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
698
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
698
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
699
699
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
700
700
|
|
|
701
701
|
* @throws {RequiredError}
|
|
@@ -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.
|
|
@@ -1077,7 +1077,7 @@ export const DealsApiFp = function (configuration) {
|
|
|
1077
1077
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
1078
1078
|
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
1079
1079
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1080
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
1080
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
1081
1081
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1082
1082
|
|
|
1083
1083
|
* @throws {RequiredError}
|
|
@@ -48,7 +48,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
48
48
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
49
49
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
50
50
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
51
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
51
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
52
52
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
53
53
|
|
|
54
54
|
* @throws {RequiredError}
|
|
@@ -87,7 +87,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
87
87
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
88
88
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
89
89
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
90
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
90
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
91
91
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
92
92
|
|
|
93
93
|
* @throws {RequiredError}
|
|
@@ -205,7 +205,7 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
205
205
|
*/
|
|
206
206
|
readonly include_fields?: Set<'lead.was_seen'>;
|
|
207
207
|
/**
|
|
208
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
208
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
209
209
|
* @type {number}
|
|
210
210
|
* @memberof LeadsApiSearchLeads
|
|
211
211
|
*/
|
|
@@ -116,7 +116,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
116
116
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
117
117
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
118
118
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
119
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
119
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
120
120
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
121
121
|
|
|
122
122
|
* @throws {RequiredError}
|
|
@@ -217,7 +217,7 @@ export const LeadsApiFp = function (configuration) {
|
|
|
217
217
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
218
218
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
219
219
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
220
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
220
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
221
221
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
222
222
|
|
|
223
223
|
* @throws {RequiredError}
|
|
@@ -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,14 +113,14 @@ 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
|
|
120
120
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
121
121
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
122
122
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
123
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
123
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
124
124
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
125
125
|
|
|
126
126
|
* @throws {RequiredError}
|
|
@@ -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,14 +226,14 @@ 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
|
|
233
233
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
234
234
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
235
235
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
236
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
236
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
237
237
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
238
238
|
|
|
239
239
|
* @throws {RequiredError}
|
|
@@ -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}
|
|
@@ -596,7 +596,7 @@ export interface OrganizationsApiSearchOrganizationRequest {
|
|
|
596
596
|
*/
|
|
597
597
|
readonly exact_match?: boolean;
|
|
598
598
|
/**
|
|
599
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
599
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
600
600
|
* @type {number}
|
|
601
601
|
* @memberof OrganizationsApiSearchOrganization
|
|
602
602
|
*/
|
|
@@ -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.
|
|
@@ -396,7 +396,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
396
396
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
397
397
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
398
398
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
399
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
399
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
400
400
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
401
401
|
|
|
402
402
|
* @throws {RequiredError}
|
|
@@ -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.
|
|
@@ -620,7 +620,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
620
620
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
621
621
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
622
622
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
623
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
623
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
624
624
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
625
625
|
|
|
626
626
|
* @throws {RequiredError}
|