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
|
@@ -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
|
*/
|
|
@@ -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.
|
|
@@ -701,7 +701,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
701
701
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
702
702
|
* @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.
|
|
703
703
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
704
|
-
* @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
|
|
704
|
+
* @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.
|
|
705
705
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
706
706
|
|
|
707
707
|
* @throws {RequiredError}
|
|
@@ -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.
|
|
@@ -1084,7 +1084,7 @@ const DealsApiFp = function (configuration) {
|
|
|
1084
1084
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
1085
1085
|
* @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.
|
|
1086
1086
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1087
|
-
* @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
|
|
1087
|
+
* @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.
|
|
1088
1088
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1089
1089
|
|
|
1090
1090
|
* @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
|
*/
|
|
@@ -122,7 +122,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
122
122
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
123
123
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
124
124
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
125
|
-
* @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
|
|
125
|
+
* @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.
|
|
126
126
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
127
127
|
|
|
128
128
|
* @throws {RequiredError}
|
|
@@ -224,7 +224,7 @@ const LeadsApiFp = function (configuration) {
|
|
|
224
224
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
225
225
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
226
226
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
227
|
-
* @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
|
|
227
|
+
* @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.
|
|
228
228
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
229
229
|
|
|
230
230
|
* @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
|
*/
|
|
@@ -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.
|
|
@@ -402,7 +402,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
402
402
|
* @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.
|
|
403
403
|
* @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>.
|
|
404
404
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
405
|
-
* @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
|
|
405
|
+
* @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.
|
|
406
406
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
407
407
|
|
|
408
408
|
* @throws {RequiredError}
|
|
@@ -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.
|
|
@@ -627,7 +627,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
627
627
|
* @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.
|
|
628
628
|
* @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>.
|
|
629
629
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
630
|
-
* @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
|
|
630
|
+
* @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.
|
|
631
631
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
632
632
|
|
|
633
633
|
* @throws {RequiredError}
|
|
@@ -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
|
|
@@ -133,7 +133,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
133
133
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
134
134
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
135
135
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
136
|
-
* @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
|
|
136
|
+
* @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.
|
|
137
137
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
138
138
|
|
|
139
139
|
* @throws {RequiredError}
|
|
@@ -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
|
|
@@ -258,7 +258,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
258
258
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
259
259
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
260
260
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
261
|
-
* @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
|
|
261
|
+
* @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.
|
|
262
262
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
263
263
|
|
|
264
264
|
* @throws {RequiredError}
|
|
@@ -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}
|
|
@@ -666,7 +666,7 @@ export interface PersonsApiSearchPersonsRequest {
|
|
|
666
666
|
*/
|
|
667
667
|
readonly include_fields?: Set<'person.picture'>;
|
|
668
668
|
/**
|
|
669
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
669
|
+
* 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.
|
|
670
670
|
* @type {number}
|
|
671
671
|
* @memberof PersonsApiSearchPersons
|
|
672
672
|
*/
|
|
@@ -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.
|
|
@@ -446,7 +446,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
446
446
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
447
447
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
448
448
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
449
|
-
* @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
|
|
449
|
+
* @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.
|
|
450
450
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
451
451
|
|
|
452
452
|
* @throws {RequiredError}
|
|
@@ -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.
|
|
@@ -694,7 +694,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
694
694
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
695
695
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
696
696
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
697
|
-
* @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
|
|
697
|
+
* @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.
|
|
698
698
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
699
699
|
|
|
700
700
|
* @throws {RequiredError}
|
|
@@ -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
|
|
@@ -175,7 +175,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
175
175
|
* @param {Set<'code' | 'custom_fields' | '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>.
|
|
176
176
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
177
177
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
178
|
-
* @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
|
|
178
|
+
* @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.
|
|
179
179
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
180
180
|
|
|
181
181
|
* @throws {RequiredError}
|
|
@@ -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
|
|
@@ -361,7 +361,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
361
361
|
* @param {Set<'code' | 'custom_fields' | '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>.
|
|
362
362
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
363
363
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
364
|
-
* @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
|
|
364
|
+
* @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.
|
|
365
365
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
366
366
|
|
|
367
367
|
* @throws {RequiredError}
|
|
@@ -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>}
|
|
@@ -884,7 +884,7 @@ export interface ProductsApiSearchProductsRequest {
|
|
|
884
884
|
*/
|
|
885
885
|
readonly include_fields?: Set<'product.price'>;
|
|
886
886
|
/**
|
|
887
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
887
|
+
* 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.
|
|
888
888
|
* @type {number}
|
|
889
889
|
* @memberof ProductsApiSearchProducts
|
|
890
890
|
*/
|