pipedrive 34.0.1 → 35.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/deal-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/deal-fields-api.js +5 -5
- package/dist/esm/versions/v1/api/deals-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/deals-api.js +5 -5
- package/dist/esm/versions/v1/api/filters-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/filters-api.js +5 -5
- package/dist/esm/versions/v1/api/leads-api.d.ts +10 -10
- package/dist/esm/versions/v1/api/leads-api.js +9 -9
- package/dist/esm/versions/v1/api/organization-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/organization-fields-api.js +5 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/organizations-api.js +5 -5
- package/dist/esm/versions/v1/api/person-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/person-fields-api.js +5 -5
- package/dist/esm/versions/v1/api/persons-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/persons-api.js +5 -5
- package/dist/esm/versions/v1/api/product-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/product-fields-api.js +5 -5
- package/dist/esm/versions/v2/api/beta-api.d.ts +6 -6
- package/dist/esm/versions/v2/api/beta-api.js +5 -5
- package/dist/esm/versions/v2/api/deal-products-api.d.ts +6 -6
- package/dist/esm/versions/v2/api/deal-products-api.js +4 -4
- package/dist/esm/versions/v2/api/deals-api.d.ts +26 -26
- package/dist/esm/versions/v2/api/deals-api.js +20 -20
- package/dist/esm/versions/v2/api/item-search-api.d.ts +14 -14
- package/dist/esm/versions/v2/api/item-search-api.js +13 -13
- package/dist/esm/versions/v2/api/leads-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/leads-api.js +9 -9
- package/dist/esm/versions/v2/api/organizations-api.d.ts +6 -6
- 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 +8 -8
- package/dist/esm/versions/v2/api/products-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/products-api.js +8 -8
- package/dist/esm/versions/v2/api/projects-api.d.ts +6 -6
- package/dist/esm/versions/v2/api/projects-api.js +5 -5
- package/dist/versions/v1/api/deal-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/deal-fields-api.js +4 -4
- package/dist/versions/v1/api/deals-api.d.ts +6 -6
- package/dist/versions/v1/api/deals-api.js +4 -4
- package/dist/versions/v1/api/filters-api.d.ts +6 -6
- package/dist/versions/v1/api/filters-api.js +4 -4
- package/dist/versions/v1/api/leads-api.d.ts +10 -10
- package/dist/versions/v1/api/leads-api.js +8 -8
- package/dist/versions/v1/api/organization-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/organization-fields-api.js +4 -4
- package/dist/versions/v1/api/organizations-api.d.ts +6 -6
- package/dist/versions/v1/api/organizations-api.js +4 -4
- package/dist/versions/v1/api/person-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/person-fields-api.js +4 -4
- package/dist/versions/v1/api/persons-api.d.ts +6 -6
- package/dist/versions/v1/api/persons-api.js +4 -4
- package/dist/versions/v1/api/product-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/product-fields-api.js +4 -4
- package/dist/versions/v2/api/beta-api.d.ts +6 -6
- package/dist/versions/v2/api/beta-api.js +4 -4
- package/dist/versions/v2/api/deal-products-api.d.ts +6 -6
- package/dist/versions/v2/api/deal-products-api.js +4 -4
- package/dist/versions/v2/api/deals-api.d.ts +26 -26
- package/dist/versions/v2/api/deals-api.js +20 -20
- package/dist/versions/v2/api/item-search-api.d.ts +14 -14
- package/dist/versions/v2/api/item-search-api.js +12 -12
- package/dist/versions/v2/api/leads-api.d.ts +10 -10
- package/dist/versions/v2/api/leads-api.js +8 -8
- package/dist/versions/v2/api/organizations-api.d.ts +6 -6
- 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 +8 -8
- package/dist/versions/v2/api/products-api.d.ts +10 -10
- package/dist/versions/v2/api/products-api.js +8 -8
- package/dist/versions/v2/api/projects-api.d.ts +6 -6
- package/dist/versions/v2/api/projects-api.js +4 -4
- package/package.json +1 -1
|
@@ -89,17 +89,17 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
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
|
|
91
91
|
* @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.
|
|
92
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
92
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
93
93
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
94
94
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
95
95
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
96
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
96
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
97
97
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
|
98
98
|
* @param {number} [limit] Items shown per page
|
|
99
99
|
|
|
100
100
|
* @throws {RequiredError}
|
|
101
101
|
*/
|
|
102
|
-
searchLeads: (term: string, fields?: 'custom_fields' | 'notes' | 'title'
|
|
102
|
+
searchLeads: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, start?: number, limit?: number) => Promise<RequestArgs>;
|
|
103
103
|
/**
|
|
104
104
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
105
105
|
* @summary Update a lead
|
|
@@ -180,17 +180,17 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
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
|
|
182
182
|
* @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.
|
|
183
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
183
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
184
184
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
185
185
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
186
186
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
187
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
187
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
188
188
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
|
189
189
|
* @param {number} [limit] Items shown per page
|
|
190
190
|
|
|
191
191
|
* @throws {RequiredError}
|
|
192
192
|
*/
|
|
193
|
-
searchLeads(term: string, fields?: 'custom_fields' | 'notes' | 'title'
|
|
193
|
+
searchLeads(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
|
|
194
194
|
/**
|
|
195
195
|
* Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields\' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field\'s value hasn\'t been set for the lead, it won\'t appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href=\"https://pipedrive.readme.io/docs/updating-custom-field-value\" target=\"_blank\" rel=\"noopener noreferrer\">updating custom fields’ values tutorial</a>.
|
|
196
196
|
* @summary Update a lead
|
|
@@ -441,10 +441,10 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
441
441
|
readonly term: string;
|
|
442
442
|
/**
|
|
443
443
|
* A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
444
|
-
* @type {'custom_fields' | 'notes' | 'title'}
|
|
444
|
+
* @type {Set<'custom_fields' | 'notes' | 'title'>}
|
|
445
445
|
* @memberof LeadsApiSearchLeads
|
|
446
446
|
*/
|
|
447
|
-
readonly fields?: 'custom_fields' | 'notes' | 'title'
|
|
447
|
+
readonly fields?: Set<'custom_fields' | 'notes' | 'title'>;
|
|
448
448
|
/**
|
|
449
449
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
450
450
|
* @type {boolean}
|
|
@@ -465,10 +465,10 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
465
465
|
readonly organization_id?: number;
|
|
466
466
|
/**
|
|
467
467
|
* Supports including optional fields in the results which are not provided by default
|
|
468
|
-
* @type {'lead.was_seen'}
|
|
468
|
+
* @type {Set<'lead.was_seen'>}
|
|
469
469
|
* @memberof LeadsApiSearchLeads
|
|
470
470
|
*/
|
|
471
|
-
readonly include_fields?: 'lead.was_seen'
|
|
471
|
+
readonly include_fields?: Set<'lead.was_seen'>;
|
|
472
472
|
/**
|
|
473
473
|
* Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
|
474
474
|
* @type {number}
|
|
@@ -297,11 +297,11 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
297
297
|
* 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.
|
|
298
298
|
* @summary Search leads
|
|
299
299
|
* @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.
|
|
300
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
300
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
301
301
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
302
302
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
303
303
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
304
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
304
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
305
305
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
|
306
306
|
* @param {number} [limit] Items shown per page
|
|
307
307
|
|
|
@@ -328,8 +328,8 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
328
328
|
if (term !== undefined) {
|
|
329
329
|
localVarQueryParameter['term'] = term;
|
|
330
330
|
}
|
|
331
|
-
if (fields
|
|
332
|
-
localVarQueryParameter['fields'] = fields;
|
|
331
|
+
if (fields) {
|
|
332
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
333
333
|
}
|
|
334
334
|
if (exact_match !== undefined) {
|
|
335
335
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -340,8 +340,8 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
340
340
|
if (organization_id !== undefined) {
|
|
341
341
|
localVarQueryParameter['organization_id'] = organization_id;
|
|
342
342
|
}
|
|
343
|
-
if (include_fields
|
|
344
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
343
|
+
if (include_fields) {
|
|
344
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
345
345
|
}
|
|
346
346
|
if (start !== undefined) {
|
|
347
347
|
localVarQueryParameter['start'] = start;
|
|
@@ -499,11 +499,11 @@ const LeadsApiFp = function (configuration) {
|
|
|
499
499
|
* 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.
|
|
500
500
|
* @summary Search leads
|
|
501
501
|
* @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.
|
|
502
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
502
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
503
503
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
504
504
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
505
505
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
506
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
506
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
507
507
|
* @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
|
|
508
508
|
* @param {number} [limit] Items shown per page
|
|
509
509
|
|
|
@@ -42,11 +42,11 @@ export declare const OrganizationFieldsApiAxiosParamCreator: (configuration?: Co
|
|
|
42
42
|
/**
|
|
43
43
|
* Marks multiple fields as deleted.
|
|
44
44
|
* @summary Delete multiple organization fields in bulk
|
|
45
|
-
* @param {
|
|
45
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
46
46
|
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
|
-
deleteOrganizationFields: (ids:
|
|
49
|
+
deleteOrganizationFields: (ids: Set<number>) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
51
|
* Returns data about a specific organization field.
|
|
52
52
|
* @summary Get one organization field
|
|
@@ -98,11 +98,11 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
|
|
|
98
98
|
/**
|
|
99
99
|
* Marks multiple fields as deleted.
|
|
100
100
|
* @summary Delete multiple organization fields in bulk
|
|
101
|
-
* @param {
|
|
101
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
102
102
|
|
|
103
103
|
* @throws {RequiredError}
|
|
104
104
|
*/
|
|
105
|
-
deleteOrganizationFields(ids:
|
|
105
|
+
deleteOrganizationFields(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
|
|
106
106
|
/**
|
|
107
107
|
* Returns data about a specific organization field.
|
|
108
108
|
* @summary Get one organization field
|
|
@@ -218,10 +218,10 @@ export interface OrganizationFieldsApiDeleteOrganizationFieldRequest {
|
|
|
218
218
|
export interface OrganizationFieldsApiDeleteOrganizationFieldsRequest {
|
|
219
219
|
/**
|
|
220
220
|
* The comma-separated field IDs to delete
|
|
221
|
-
* @type {
|
|
221
|
+
* @type {Set<number>}
|
|
222
222
|
* @memberof OrganizationFieldsApiDeleteOrganizationFields
|
|
223
223
|
*/
|
|
224
|
-
readonly ids:
|
|
224
|
+
readonly ids: Set<number>;
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
227
|
* Request parameters for getOrganizationField operation in OrganizationFieldsApi.
|
|
@@ -108,7 +108,7 @@ const OrganizationFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
108
108
|
/**
|
|
109
109
|
* Marks multiple fields as deleted.
|
|
110
110
|
* @summary Delete multiple organization fields in bulk
|
|
111
|
-
* @param {
|
|
111
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
112
112
|
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
@@ -130,8 +130,8 @@ const OrganizationFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
130
130
|
// authentication oauth2 required
|
|
131
131
|
// oauth required
|
|
132
132
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contact-fields:full", "admin"], configuration);
|
|
133
|
-
if (ids
|
|
134
|
-
localVarQueryParameter['ids'] = ids;
|
|
133
|
+
if (ids) {
|
|
134
|
+
localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
|
|
135
135
|
}
|
|
136
136
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
137
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -289,7 +289,7 @@ const OrganizationFieldsApiFp = function (configuration) {
|
|
|
289
289
|
/**
|
|
290
290
|
* Marks multiple fields as deleted.
|
|
291
291
|
* @summary Delete multiple organization fields in bulk
|
|
292
|
-
* @param {
|
|
292
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
293
293
|
|
|
294
294
|
* @throws {RequiredError}
|
|
295
295
|
*/
|
|
@@ -93,11 +93,11 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
93
93
|
* @param {number} [start] Pagination start
|
|
94
94
|
* @param {number} [limit] Items shown per page
|
|
95
95
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.
|
|
96
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
96
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
97
97
|
|
|
98
98
|
* @throws {RequiredError}
|
|
99
99
|
*/
|
|
100
|
-
getOrganizationUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: string) => Promise<RequestArgs>;
|
|
100
|
+
getOrganizationUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>) => Promise<RequestArgs>;
|
|
101
101
|
/**
|
|
102
102
|
* List users permitted to access an organization.
|
|
103
103
|
* @summary List permitted users
|
|
@@ -186,11 +186,11 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
186
186
|
* @param {number} [start] Pagination start
|
|
187
187
|
* @param {number} [limit] Items shown per page
|
|
188
188
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.
|
|
189
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
189
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
190
190
|
|
|
191
191
|
* @throws {RequiredError}
|
|
192
192
|
*/
|
|
193
|
-
getOrganizationUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedOrganizationUpdatesResponse>>;
|
|
193
|
+
getOrganizationUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedOrganizationUpdatesResponse>>;
|
|
194
194
|
/**
|
|
195
195
|
* List users permitted to access an organization.
|
|
196
196
|
* @summary List permitted users
|
|
@@ -457,10 +457,10 @@ export interface OrganizationsApiGetOrganizationUpdatesRequest {
|
|
|
457
457
|
readonly all_changes?: string;
|
|
458
458
|
/**
|
|
459
459
|
* A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
460
|
-
* @type {string}
|
|
460
|
+
* @type {Set<string>}
|
|
461
461
|
* @memberof OrganizationsApiGetOrganizationUpdates
|
|
462
462
|
*/
|
|
463
|
-
readonly items?: string
|
|
463
|
+
readonly items?: Set<string>;
|
|
464
464
|
}
|
|
465
465
|
/**
|
|
466
466
|
* Request parameters for getOrganizationUsers operation in OrganizationsApi.
|
|
@@ -288,7 +288,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
288
288
|
* @param {number} [start] Pagination start
|
|
289
289
|
* @param {number} [limit] Items shown per page
|
|
290
290
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.
|
|
291
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
291
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
292
292
|
|
|
293
293
|
* @throws {RequiredError}
|
|
294
294
|
*/
|
|
@@ -320,8 +320,8 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
320
320
|
if (all_changes !== undefined) {
|
|
321
321
|
localVarQueryParameter['all_changes'] = all_changes;
|
|
322
322
|
}
|
|
323
|
-
if (items
|
|
324
|
-
localVarQueryParameter['items'] = items;
|
|
323
|
+
if (items) {
|
|
324
|
+
localVarQueryParameter['items'] = Array.from(items).join(base_1.COLLECTION_FORMATS.csv);
|
|
325
325
|
}
|
|
326
326
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
327
327
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -507,7 +507,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
507
507
|
* @param {number} [start] Pagination start
|
|
508
508
|
* @param {number} [limit] Items shown per page
|
|
509
509
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.
|
|
510
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
510
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
|
|
511
511
|
|
|
512
512
|
* @throws {RequiredError}
|
|
513
513
|
*/
|
|
@@ -42,11 +42,11 @@ export declare const PersonFieldsApiAxiosParamCreator: (configuration?: Configur
|
|
|
42
42
|
/**
|
|
43
43
|
* Marks multiple fields as deleted.
|
|
44
44
|
* @summary Delete multiple person fields in bulk
|
|
45
|
-
* @param {
|
|
45
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
46
46
|
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
|
-
deletePersonFields: (ids:
|
|
49
|
+
deletePersonFields: (ids: Set<number>) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
51
|
* Returns data about a specific person field.
|
|
52
52
|
* @summary Get one person field
|
|
@@ -98,11 +98,11 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
|
|
|
98
98
|
/**
|
|
99
99
|
* Marks multiple fields as deleted.
|
|
100
100
|
* @summary Delete multiple person fields in bulk
|
|
101
|
-
* @param {
|
|
101
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
102
102
|
|
|
103
103
|
* @throws {RequiredError}
|
|
104
104
|
*/
|
|
105
|
-
deletePersonFields(ids:
|
|
105
|
+
deletePersonFields(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteFieldsResponse>>;
|
|
106
106
|
/**
|
|
107
107
|
* Returns data about a specific person field.
|
|
108
108
|
* @summary Get one person field
|
|
@@ -218,10 +218,10 @@ export interface PersonFieldsApiDeletePersonFieldRequest {
|
|
|
218
218
|
export interface PersonFieldsApiDeletePersonFieldsRequest {
|
|
219
219
|
/**
|
|
220
220
|
* The comma-separated field IDs to delete
|
|
221
|
-
* @type {
|
|
221
|
+
* @type {Set<number>}
|
|
222
222
|
* @memberof PersonFieldsApiDeletePersonFields
|
|
223
223
|
*/
|
|
224
|
-
readonly ids:
|
|
224
|
+
readonly ids: Set<number>;
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
227
|
* Request parameters for getPersonField operation in PersonFieldsApi.
|
|
@@ -108,7 +108,7 @@ const PersonFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
108
108
|
/**
|
|
109
109
|
* Marks multiple fields as deleted.
|
|
110
110
|
* @summary Delete multiple person fields in bulk
|
|
111
|
-
* @param {
|
|
111
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
112
112
|
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
@@ -130,8 +130,8 @@ const PersonFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
130
130
|
// authentication oauth2 required
|
|
131
131
|
// oauth required
|
|
132
132
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["contact-fields:full", "admin"], configuration);
|
|
133
|
-
if (ids
|
|
134
|
-
localVarQueryParameter['ids'] = ids;
|
|
133
|
+
if (ids) {
|
|
134
|
+
localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
|
|
135
135
|
}
|
|
136
136
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
137
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -289,7 +289,7 @@ const PersonFieldsApiFp = function (configuration) {
|
|
|
289
289
|
/**
|
|
290
290
|
* Marks multiple fields as deleted.
|
|
291
291
|
* @summary Delete multiple person fields in bulk
|
|
292
|
-
* @param {
|
|
292
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
293
293
|
|
|
294
294
|
* @throws {RequiredError}
|
|
295
295
|
*/
|
|
@@ -126,11 +126,11 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
126
126
|
* @param {number} [start] Pagination start
|
|
127
127
|
* @param {number} [limit] Items shown per page
|
|
128
128
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
129
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
129
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
130
130
|
|
|
131
131
|
* @throws {RequiredError}
|
|
132
132
|
*/
|
|
133
|
-
getPersonUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: string) => Promise<RequestArgs>;
|
|
133
|
+
getPersonUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>) => Promise<RequestArgs>;
|
|
134
134
|
/**
|
|
135
135
|
* List users permitted to access a person.
|
|
136
136
|
* @summary List permitted users
|
|
@@ -250,11 +250,11 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
250
250
|
* @param {number} [start] Pagination start
|
|
251
251
|
* @param {number} [limit] Items shown per page
|
|
252
252
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
253
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
253
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
254
254
|
|
|
255
255
|
* @throws {RequiredError}
|
|
256
256
|
*/
|
|
257
|
-
getPersonUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedPersonUpdatesResponse>>;
|
|
257
|
+
getPersonUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedPersonUpdatesResponse>>;
|
|
258
258
|
/**
|
|
259
259
|
* List users permitted to access a person.
|
|
260
260
|
* @summary List permitted users
|
|
@@ -626,10 +626,10 @@ export interface PersonsApiGetPersonUpdatesRequest {
|
|
|
626
626
|
readonly all_changes?: string;
|
|
627
627
|
/**
|
|
628
628
|
* A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
629
|
-
* @type {string}
|
|
629
|
+
* @type {Set<string>}
|
|
630
630
|
* @memberof PersonsApiGetPersonUpdates
|
|
631
631
|
*/
|
|
632
|
-
readonly items?: string
|
|
632
|
+
readonly items?: Set<string>;
|
|
633
633
|
}
|
|
634
634
|
/**
|
|
635
635
|
* Request parameters for getPersonUsers operation in PersonsApi.
|
|
@@ -423,7 +423,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
423
423
|
* @param {number} [start] Pagination start
|
|
424
424
|
* @param {number} [limit] Items shown per page
|
|
425
425
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
426
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
426
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
427
427
|
|
|
428
428
|
* @throws {RequiredError}
|
|
429
429
|
*/
|
|
@@ -455,8 +455,8 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
455
455
|
if (all_changes !== undefined) {
|
|
456
456
|
localVarQueryParameter['all_changes'] = all_changes;
|
|
457
457
|
}
|
|
458
|
-
if (items
|
|
459
|
-
localVarQueryParameter['items'] = items;
|
|
458
|
+
if (items) {
|
|
459
|
+
localVarQueryParameter['items'] = Array.from(items).join(base_1.COLLECTION_FORMATS.csv);
|
|
460
460
|
}
|
|
461
461
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
462
462
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -688,7 +688,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
688
688
|
* @param {number} [start] Pagination start
|
|
689
689
|
* @param {number} [limit] Items shown per page
|
|
690
690
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
691
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
691
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
692
692
|
|
|
693
693
|
* @throws {RequiredError}
|
|
694
694
|
*/
|
|
@@ -42,11 +42,11 @@ export declare const ProductFieldsApiAxiosParamCreator: (configuration?: Configu
|
|
|
42
42
|
/**
|
|
43
43
|
* Marks multiple fields as deleted.
|
|
44
44
|
* @summary Delete multiple product fields in bulk
|
|
45
|
-
* @param {
|
|
45
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
46
46
|
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
|
-
deleteProductFields: (ids:
|
|
49
|
+
deleteProductFields: (ids: Set<number>) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
51
|
* Returns data about a specific product field.
|
|
52
52
|
* @summary Get one product field
|
|
@@ -98,11 +98,11 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
|
|
|
98
98
|
/**
|
|
99
99
|
* Marks multiple fields as deleted.
|
|
100
100
|
* @summary Delete multiple product fields in bulk
|
|
101
|
-
* @param {
|
|
101
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
102
102
|
|
|
103
103
|
* @throws {RequiredError}
|
|
104
104
|
*/
|
|
105
|
-
deleteProductFields(ids:
|
|
105
|
+
deleteProductFields(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductFieldsResponse>>;
|
|
106
106
|
/**
|
|
107
107
|
* Returns data about a specific product field.
|
|
108
108
|
* @summary Get one product field
|
|
@@ -218,10 +218,10 @@ export interface ProductFieldsApiDeleteProductFieldRequest {
|
|
|
218
218
|
export interface ProductFieldsApiDeleteProductFieldsRequest {
|
|
219
219
|
/**
|
|
220
220
|
* The comma-separated field IDs to delete
|
|
221
|
-
* @type {
|
|
221
|
+
* @type {Set<number>}
|
|
222
222
|
* @memberof ProductFieldsApiDeleteProductFields
|
|
223
223
|
*/
|
|
224
|
-
readonly ids:
|
|
224
|
+
readonly ids: Set<number>;
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
227
|
* Request parameters for getProductField operation in ProductFieldsApi.
|
|
@@ -108,7 +108,7 @@ const ProductFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
108
108
|
/**
|
|
109
109
|
* Marks multiple fields as deleted.
|
|
110
110
|
* @summary Delete multiple product fields in bulk
|
|
111
|
-
* @param {
|
|
111
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
112
112
|
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
@@ -130,8 +130,8 @@ const ProductFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
130
130
|
// authentication oauth2 required
|
|
131
131
|
// oauth required
|
|
132
132
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["product-fields:full", "products:full"], configuration);
|
|
133
|
-
if (ids
|
|
134
|
-
localVarQueryParameter['ids'] = ids;
|
|
133
|
+
if (ids) {
|
|
134
|
+
localVarQueryParameter['ids'] = Array.from(ids).join(base_1.COLLECTION_FORMATS.csv);
|
|
135
135
|
}
|
|
136
136
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
137
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -289,7 +289,7 @@ const ProductFieldsApiFp = function (configuration) {
|
|
|
289
289
|
/**
|
|
290
290
|
* Marks multiple fields as deleted.
|
|
291
291
|
* @summary Delete multiple product fields in bulk
|
|
292
|
-
* @param {
|
|
292
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
293
293
|
|
|
294
294
|
* @throws {RequiredError}
|
|
295
295
|
*/
|
|
@@ -200,7 +200,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
200
200
|
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
201
201
|
* @summary Search projects
|
|
202
202
|
* @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.
|
|
203
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [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>.
|
|
203
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [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>.
|
|
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
|
|
@@ -209,7 +209,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
209
209
|
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
*/
|
|
212
|
-
searchProjects: (term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
212
|
+
searchProjects: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>, exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
213
213
|
/**
|
|
214
214
|
* Updates the properties of a project board.
|
|
215
215
|
* @summary Update a project board
|
|
@@ -417,7 +417,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
|
417
417
|
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
418
418
|
* @summary Search projects
|
|
419
419
|
* @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.
|
|
420
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [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>.
|
|
420
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [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>.
|
|
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
|
|
@@ -426,7 +426,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
|
426
426
|
|
|
427
427
|
* @throws {RequiredError}
|
|
428
428
|
*/
|
|
429
|
-
searchProjects(term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
429
|
+
searchProjects(term: string, fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>, exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectSearchResponse>>;
|
|
430
430
|
/**
|
|
431
431
|
* Updates the properties of a project board.
|
|
432
432
|
* @summary Update a project board
|
|
@@ -959,10 +959,10 @@ export interface BetaApiSearchProjectsRequest {
|
|
|
959
959
|
readonly term: string;
|
|
960
960
|
/**
|
|
961
961
|
* 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>.
|
|
962
|
-
* @type {'custom_fields' | 'notes' | 'title' | 'description'}
|
|
962
|
+
* @type {Set<'custom_fields' | 'notes' | 'title' | 'description'>}
|
|
963
963
|
* @memberof BetaApiSearchProjects
|
|
964
964
|
*/
|
|
965
|
-
readonly fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
965
|
+
readonly fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>;
|
|
966
966
|
/**
|
|
967
967
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
968
968
|
* @type {boolean}
|
|
@@ -694,7 +694,7 @@ const BetaApiAxiosParamCreator = function (configuration) {
|
|
|
694
694
|
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
695
695
|
* @summary Search projects
|
|
696
696
|
* @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.
|
|
697
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [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>.
|
|
697
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [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>.
|
|
698
698
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
699
699
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
700
700
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
@@ -724,8 +724,8 @@ const BetaApiAxiosParamCreator = function (configuration) {
|
|
|
724
724
|
if (term !== undefined) {
|
|
725
725
|
localVarQueryParameter['term'] = term;
|
|
726
726
|
}
|
|
727
|
-
if (fields
|
|
728
|
-
localVarQueryParameter['fields'] = fields;
|
|
727
|
+
if (fields) {
|
|
728
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
729
729
|
}
|
|
730
730
|
if (exact_match !== undefined) {
|
|
731
731
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -1195,7 +1195,7 @@ const BetaApiFp = function (configuration) {
|
|
|
1195
1195
|
* Searches all projects by title, description, 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 projects can be filtered by person ID or organization ID.
|
|
1196
1196
|
* @summary Search projects
|
|
1197
1197
|
* @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.
|
|
1198
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [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>.
|
|
1198
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [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>.
|
|
1199
1199
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1200
1200
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
1201
1201
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|