pipedrive 34.0.0 → 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/product-fields-api.d.ts +14 -14
- 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/esm/versions/v2/models/add-product-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-product-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
- package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
- package/dist/esm/versions/v2/models/index.d.ts +3 -0
- package/dist/esm/versions/v2/models/index.js +3 -0
- 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/product-fields-api.d.ts +14 -14
- 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/dist/versions/v2/models/add-product-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/add-product-field200-response.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
- package/dist/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
- package/dist/versions/v2/models/get-product-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-product-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-product-fields200-response.js +15 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
- package/dist/versions/v2/models/index.d.ts +3 -0
- package/dist/versions/v2/models/index.js +3 -0
- package/package.json +1 -1
|
@@ -290,7 +290,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
290
290
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
291
291
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
292
292
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
293
|
-
* @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
293
|
+
* @param {Set<'open' | 'won' | 'lost' | 'deleted'>} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
294
294
|
* @param {string} [updated_since] If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
295
295
|
* @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
296
296
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -339,8 +339,8 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
339
339
|
if (stage_id !== undefined) {
|
|
340
340
|
localVarQueryParameter['stage_id'] = stage_id;
|
|
341
341
|
}
|
|
342
|
-
if (status
|
|
343
|
-
localVarQueryParameter['status'] = status;
|
|
342
|
+
if (status) {
|
|
343
|
+
localVarQueryParameter['status'] = Array.from(status).join(COLLECTION_FORMATS.csv);
|
|
344
344
|
}
|
|
345
345
|
if (updated_since !== undefined) {
|
|
346
346
|
localVarQueryParameter['updated_since'] = updated_since;
|
|
@@ -556,7 +556,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
556
556
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
557
557
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
558
558
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
559
|
-
* @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
559
|
+
* @param {Set<'open' | 'won' | 'lost' | 'deleted'>} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
560
560
|
* @param {string} [updated_since] If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
561
561
|
* @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
562
562
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -607,8 +607,8 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
607
607
|
if (stage_id !== undefined) {
|
|
608
608
|
localVarQueryParameter['stage_id'] = stage_id;
|
|
609
609
|
}
|
|
610
|
-
if (status
|
|
611
|
-
localVarQueryParameter['status'] = status;
|
|
610
|
+
if (status) {
|
|
611
|
+
localVarQueryParameter['status'] = Array.from(status).join(COLLECTION_FORMATS.csv);
|
|
612
612
|
}
|
|
613
613
|
if (updated_since !== undefined) {
|
|
614
614
|
localVarQueryParameter['updated_since'] = updated_since;
|
|
@@ -689,12 +689,12 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
689
689
|
* Searches all deals 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 deals can be filtered by the person ID and the organization ID.
|
|
690
690
|
* @summary Search deals
|
|
691
691
|
* @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.
|
|
692
|
-
* @param {'custom_fields' | 'notes' | 'title'} [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>.
|
|
692
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [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>.
|
|
693
693
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
694
694
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
695
695
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
696
|
-
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
697
|
-
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
696
|
+
* @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
697
|
+
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
698
698
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
699
699
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
700
700
|
|
|
@@ -721,8 +721,8 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
721
721
|
if (term !== undefined) {
|
|
722
722
|
localVarQueryParameter['term'] = term;
|
|
723
723
|
}
|
|
724
|
-
if (fields
|
|
725
|
-
localVarQueryParameter['fields'] = fields;
|
|
724
|
+
if (fields) {
|
|
725
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
726
726
|
}
|
|
727
727
|
if (exact_match !== undefined) {
|
|
728
728
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -733,11 +733,11 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
733
733
|
if (organization_id !== undefined) {
|
|
734
734
|
localVarQueryParameter['organization_id'] = organization_id;
|
|
735
735
|
}
|
|
736
|
-
if (status
|
|
737
|
-
localVarQueryParameter['status'] = status;
|
|
736
|
+
if (status) {
|
|
737
|
+
localVarQueryParameter['status'] = Array.from(status).join(COLLECTION_FORMATS.csv);
|
|
738
738
|
}
|
|
739
|
-
if (include_fields
|
|
740
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
739
|
+
if (include_fields) {
|
|
740
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
|
|
741
741
|
}
|
|
742
742
|
if (limit !== undefined) {
|
|
743
743
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -944,7 +944,7 @@ export const DealsApiFp = function (configuration) {
|
|
|
944
944
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
945
945
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
946
946
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
947
|
-
* @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
947
|
+
* @param {Set<'open' | 'won' | 'lost' | 'deleted'>} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
948
948
|
* @param {string} [updated_since] If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
949
949
|
* @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
950
950
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -1033,7 +1033,7 @@ export const DealsApiFp = function (configuration) {
|
|
|
1033
1033
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
1034
1034
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
1035
1035
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
1036
|
-
* @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
1036
|
+
* @param {Set<'open' | 'won' | 'lost' | 'deleted'>} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
|
|
1037
1037
|
* @param {string} [updated_since] If set, only deals with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
1038
1038
|
* @param {string} [updated_until] If set, only deals with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
|
|
1039
1039
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -1071,12 +1071,12 @@ export const DealsApiFp = function (configuration) {
|
|
|
1071
1071
|
* Searches all deals 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 deals can be filtered by the person ID and the organization ID.
|
|
1072
1072
|
* @summary Search deals
|
|
1073
1073
|
* @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.
|
|
1074
|
-
* @param {'custom_fields' | 'notes' | 'title'} [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>.
|
|
1074
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [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>.
|
|
1075
1075
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1076
1076
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
1077
1077
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
1078
|
-
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
1079
|
-
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1078
|
+
* @param {Set<'open' | 'won' | 'lost'>} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
1079
|
+
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1080
1080
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
1081
1081
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1082
1082
|
|
|
@@ -23,17 +23,17 @@ export declare const ItemSearchApiAxiosParamCreator: (configuration?: Configurat
|
|
|
23
23
|
* Performs a search from your choice of item types and fields.
|
|
24
24
|
* @summary Perform a search from multiple item types
|
|
25
25
|
* @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.
|
|
26
|
-
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
27
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
26
|
+
* @param {Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
27
|
+
* @param {Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
28
28
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
|
29
29
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
30
|
-
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
30
|
+
* @param {Set<'deal.cc_email' | 'person.picture' | 'product.price'>} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
31
31
|
* @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.
|
|
32
32
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
33
33
|
|
|
34
34
|
* @throws {RequiredError}
|
|
35
35
|
*/
|
|
36
|
-
searchItem: (term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'
|
|
36
|
+
searchItem: (term: string, item_types?: Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>, fields?: Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>, search_for_related_items?: boolean, exact_match?: boolean, include_fields?: Set<'deal.cc_email' | 'person.picture' | 'product.price'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
38
|
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
|
|
39
39
|
* @summary Perform a search using a specific field from an item type
|
|
@@ -57,17 +57,17 @@ export declare const ItemSearchApiFp: (configuration?: Configuration) => {
|
|
|
57
57
|
* Performs a search from your choice of item types and fields.
|
|
58
58
|
* @summary Perform a search from multiple item types
|
|
59
59
|
* @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.
|
|
60
|
-
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
61
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
60
|
+
* @param {Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
61
|
+
* @param {Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
62
62
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
|
63
63
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
64
|
-
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
64
|
+
* @param {Set<'deal.cc_email' | 'person.picture' | 'product.price'>} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
65
65
|
* @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.
|
|
66
66
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
67
67
|
|
|
68
68
|
* @throws {RequiredError}
|
|
69
69
|
*/
|
|
70
|
-
searchItem(term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'
|
|
70
|
+
searchItem(term: string, item_types?: Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>, fields?: Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>, search_for_related_items?: boolean, exact_match?: boolean, include_fields?: Set<'deal.cc_email' | 'person.picture' | 'product.price'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchResponse>>;
|
|
71
71
|
/**
|
|
72
72
|
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
|
|
73
73
|
* @summary Perform a search using a specific field from an item type
|
|
@@ -118,16 +118,16 @@ export interface ItemSearchApiSearchItemRequest {
|
|
|
118
118
|
readonly term: string;
|
|
119
119
|
/**
|
|
120
120
|
* A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
121
|
-
* @type {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'}
|
|
121
|
+
* @type {Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>}
|
|
122
122
|
* @memberof ItemSearchApiSearchItem
|
|
123
123
|
*/
|
|
124
|
-
readonly item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'
|
|
124
|
+
readonly item_types?: Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>;
|
|
125
125
|
/**
|
|
126
126
|
* A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
127
|
-
* @type {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'}
|
|
127
|
+
* @type {Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>}
|
|
128
128
|
* @memberof ItemSearchApiSearchItem
|
|
129
129
|
*/
|
|
130
|
-
readonly fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'
|
|
130
|
+
readonly fields?: Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>;
|
|
131
131
|
/**
|
|
132
132
|
* When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
|
133
133
|
* @type {boolean}
|
|
@@ -142,10 +142,10 @@ export interface ItemSearchApiSearchItemRequest {
|
|
|
142
142
|
readonly exact_match?: boolean;
|
|
143
143
|
/**
|
|
144
144
|
* A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
145
|
-
* @type {'deal.cc_email' | 'person.picture' | 'product.price'}
|
|
145
|
+
* @type {Set<'deal.cc_email' | 'person.picture' | 'product.price'>}
|
|
146
146
|
* @memberof ItemSearchApiSearchItem
|
|
147
147
|
*/
|
|
148
|
-
readonly include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price'
|
|
148
|
+
readonly include_fields?: Set<'deal.cc_email' | 'person.picture' | 'product.price'>;
|
|
149
149
|
/**
|
|
150
150
|
* 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.
|
|
151
151
|
* @type {number}
|
|
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import { BASE_PATH, BaseAPI } from '../base';
|
|
28
|
+
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
29
29
|
/**
|
|
30
30
|
* ItemSearchApi - axios parameter creator
|
|
31
31
|
* @export
|
|
@@ -36,11 +36,11 @@ export const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
|
36
36
|
* Performs a search from your choice of item types and fields.
|
|
37
37
|
* @summary Perform a search from multiple item types
|
|
38
38
|
* @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.
|
|
39
|
-
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
40
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
39
|
+
* @param {Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
40
|
+
* @param {Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
41
41
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
|
42
42
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
43
|
-
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
43
|
+
* @param {Set<'deal.cc_email' | 'person.picture' | 'product.price'>} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
44
44
|
* @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.
|
|
45
45
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
46
46
|
|
|
@@ -67,11 +67,11 @@ export const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
|
67
67
|
if (term !== undefined) {
|
|
68
68
|
localVarQueryParameter['term'] = term;
|
|
69
69
|
}
|
|
70
|
-
if (item_types
|
|
71
|
-
localVarQueryParameter['item_types'] = item_types;
|
|
70
|
+
if (item_types) {
|
|
71
|
+
localVarQueryParameter['item_types'] = Array.from(item_types).join(COLLECTION_FORMATS.csv);
|
|
72
72
|
}
|
|
73
|
-
if (fields
|
|
74
|
-
localVarQueryParameter['fields'] = fields;
|
|
73
|
+
if (fields) {
|
|
74
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
75
75
|
}
|
|
76
76
|
if (search_for_related_items !== undefined) {
|
|
77
77
|
localVarQueryParameter['search_for_related_items'] = search_for_related_items;
|
|
@@ -79,8 +79,8 @@ export const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
|
79
79
|
if (exact_match !== undefined) {
|
|
80
80
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
81
81
|
}
|
|
82
|
-
if (include_fields
|
|
83
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
82
|
+
if (include_fields) {
|
|
83
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
|
|
84
84
|
}
|
|
85
85
|
if (limit !== undefined) {
|
|
86
86
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -169,11 +169,11 @@ export const ItemSearchApiFp = function (configuration) {
|
|
|
169
169
|
* Performs a search from your choice of item types and fields.
|
|
170
170
|
* @summary Perform a search from multiple item types
|
|
171
171
|
* @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.
|
|
172
|
-
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
173
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
172
|
+
* @param {Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
|
173
|
+
* @param {Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> 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>.
|
|
174
174
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
|
175
175
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
176
|
-
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
176
|
+
* @param {Set<'deal.cc_email' | 'person.picture' | 'product.price'>} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
|
177
177
|
* @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.
|
|
178
178
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
179
179
|
|
|
@@ -43,17 +43,17 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
43
43
|
* 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.
|
|
44
44
|
* @summary Search leads
|
|
45
45
|
* @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.
|
|
46
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
46
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
47
47
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
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
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
50
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
51
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 500 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}
|
|
55
55
|
*/
|
|
56
|
-
searchLeads: (term: string, fields?: 'custom_fields' | 'notes' | 'title'
|
|
56
|
+
searchLeads: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
57
57
|
};
|
|
58
58
|
/**
|
|
59
59
|
* LeadsApi - functional programming interface
|
|
@@ -82,17 +82,17 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
82
82
|
* 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.
|
|
83
83
|
* @summary Search leads
|
|
84
84
|
* @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.
|
|
85
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
85
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
86
86
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
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
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
89
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
90
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 500 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}
|
|
94
94
|
*/
|
|
95
|
-
searchLeads(term: string, fields?: 'custom_fields' | 'notes' | 'title'
|
|
95
|
+
searchLeads(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
|
|
96
96
|
};
|
|
97
97
|
/**
|
|
98
98
|
* LeadsApi - factory interface
|
|
@@ -176,10 +176,10 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
176
176
|
readonly term: string;
|
|
177
177
|
/**
|
|
178
178
|
* A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
179
|
-
* @type {'custom_fields' | 'notes' | 'title'}
|
|
179
|
+
* @type {Set<'custom_fields' | 'notes' | 'title'>}
|
|
180
180
|
* @memberof LeadsApiSearchLeads
|
|
181
181
|
*/
|
|
182
|
-
readonly fields?: 'custom_fields' | 'notes' | 'title'
|
|
182
|
+
readonly fields?: Set<'custom_fields' | 'notes' | 'title'>;
|
|
183
183
|
/**
|
|
184
184
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
185
185
|
* @type {boolean}
|
|
@@ -200,10 +200,10 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
200
200
|
readonly organization_id?: number;
|
|
201
201
|
/**
|
|
202
202
|
* Supports including optional fields in the results which are not provided by default
|
|
203
|
-
* @type {'lead.was_seen'}
|
|
203
|
+
* @type {Set<'lead.was_seen'>}
|
|
204
204
|
* @memberof LeadsApiSearchLeads
|
|
205
205
|
*/
|
|
206
|
-
readonly include_fields?: 'lead.was_seen'
|
|
206
|
+
readonly include_fields?: Set<'lead.was_seen'>;
|
|
207
207
|
/**
|
|
208
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 500 is allowed.
|
|
209
209
|
* @type {number}
|
|
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import { BASE_PATH, BaseAPI } from '../base';
|
|
28
|
+
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
29
29
|
/**
|
|
30
30
|
* LeadsApi - axios parameter creator
|
|
31
31
|
* @export
|
|
@@ -111,11 +111,11 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
111
111
|
* 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.
|
|
112
112
|
* @summary Search leads
|
|
113
113
|
* @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.
|
|
114
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
114
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
115
115
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
116
116
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
117
117
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
118
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
118
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
119
119
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
120
120
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
121
121
|
|
|
@@ -142,8 +142,8 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
if (term !== undefined) {
|
|
143
143
|
localVarQueryParameter['term'] = term;
|
|
144
144
|
}
|
|
145
|
-
if (fields
|
|
146
|
-
localVarQueryParameter['fields'] = fields;
|
|
145
|
+
if (fields) {
|
|
146
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
147
147
|
}
|
|
148
148
|
if (exact_match !== undefined) {
|
|
149
149
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -154,8 +154,8 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
154
154
|
if (organization_id !== undefined) {
|
|
155
155
|
localVarQueryParameter['organization_id'] = organization_id;
|
|
156
156
|
}
|
|
157
|
-
if (include_fields
|
|
158
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
157
|
+
if (include_fields) {
|
|
158
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
|
|
159
159
|
}
|
|
160
160
|
if (limit !== undefined) {
|
|
161
161
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -212,11 +212,11 @@ export const LeadsApiFp = function (configuration) {
|
|
|
212
212
|
* 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.
|
|
213
213
|
* @summary Search leads
|
|
214
214
|
* @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.
|
|
215
|
-
* @param {'custom_fields' | 'notes' | 'title'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
215
|
+
* @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
|
|
216
216
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
217
217
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
218
218
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
219
|
-
* @param {'lead.was_seen'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
219
|
+
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
220
220
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
221
221
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
222
222
|
|
|
@@ -118,14 +118,14 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
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
|
-
* @param {'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>.
|
|
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
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 500 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}
|
|
127
127
|
*/
|
|
128
|
-
searchOrganization: (term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name'
|
|
128
|
+
searchOrganization: (term: string, fields?: Set<'address' | 'custom_fields' | 'notes' | 'name'>, exact_match?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
129
129
|
/**
|
|
130
130
|
* Updates the properties of a organization.
|
|
131
131
|
* @summary Update a organization
|
|
@@ -231,14 +231,14 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
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
|
-
* @param {'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>.
|
|
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
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 500 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}
|
|
240
240
|
*/
|
|
241
|
-
searchOrganization(term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name'
|
|
241
|
+
searchOrganization(term: string, fields?: Set<'address' | 'custom_fields' | 'notes' | 'name'>, exact_match?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationSearchResponse>>;
|
|
242
242
|
/**
|
|
243
243
|
* Updates the properties of a organization.
|
|
244
244
|
* @summary Update a organization
|
|
@@ -585,10 +585,10 @@ export interface OrganizationsApiSearchOrganizationRequest {
|
|
|
585
585
|
readonly term: string;
|
|
586
586
|
/**
|
|
587
587
|
* 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>.
|
|
588
|
-
* @type {'address' | 'custom_fields' | 'notes' | 'name'}
|
|
588
|
+
* @type {Set<'address' | 'custom_fields' | 'notes' | 'name'>}
|
|
589
589
|
* @memberof OrganizationsApiSearchOrganization
|
|
590
590
|
*/
|
|
591
|
-
readonly fields?: 'address' | 'custom_fields' | 'notes' | 'name'
|
|
591
|
+
readonly fields?: Set<'address' | 'custom_fields' | 'notes' | 'name'>;
|
|
592
592
|
/**
|
|
593
593
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
594
594
|
* @type {boolean}
|
|
@@ -394,7 +394,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
394
394
|
* 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.
|
|
395
395
|
* @summary Search organizations
|
|
396
396
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
397
|
-
* @param {'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>.
|
|
397
|
+
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
398
398
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
399
399
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
400
400
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -422,8 +422,8 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
422
422
|
if (term !== undefined) {
|
|
423
423
|
localVarQueryParameter['term'] = term;
|
|
424
424
|
}
|
|
425
|
-
if (fields
|
|
426
|
-
localVarQueryParameter['fields'] = fields;
|
|
425
|
+
if (fields) {
|
|
426
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
427
427
|
}
|
|
428
428
|
if (exact_match !== undefined) {
|
|
429
429
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -618,7 +618,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
618
618
|
* 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.
|
|
619
619
|
* @summary Search organizations
|
|
620
620
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
621
|
-
* @param {'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>.
|
|
621
|
+
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
622
622
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
623
623
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
624
624
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|