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
|
@@ -105,7 +105,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
105
105
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
106
106
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
107
107
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
108
|
-
* @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.
|
|
108
|
+
* @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.
|
|
109
109
|
* @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.
|
|
110
110
|
* @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.
|
|
111
111
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -117,7 +117,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
117
117
|
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
120
|
-
getArchivedDeals: (filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted'
|
|
120
|
+
getArchivedDeals: (filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
121
121
|
/**
|
|
122
122
|
* Returns the details of a specific deal.
|
|
123
123
|
* @summary Get details of a deal
|
|
@@ -169,7 +169,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
169
169
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
170
170
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
171
171
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
172
|
-
* @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.
|
|
172
|
+
* @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.
|
|
173
173
|
* @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.
|
|
174
174
|
* @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.
|
|
175
175
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -183,7 +183,7 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
183
183
|
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
|
-
getDeals: (filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted'
|
|
186
|
+
getDeals: (filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
187
187
|
/**
|
|
188
188
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
189
189
|
* @summary Add a discount to a deal
|
|
@@ -197,18 +197,18 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
197
197
|
* 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.
|
|
198
198
|
* @summary Search deals
|
|
199
199
|
* @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.
|
|
200
|
-
* @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>.
|
|
200
|
+
* @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>.
|
|
201
201
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
202
202
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
203
203
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
204
|
-
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
205
|
-
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
204
|
+
* @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.
|
|
205
|
+
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
206
206
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
207
207
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
208
208
|
|
|
209
209
|
* @throws {RequiredError}
|
|
210
210
|
*/
|
|
211
|
-
searchDeals: (term: string, fields?: 'custom_fields' | 'notes' | 'title'
|
|
211
|
+
searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: Set<'open' | 'won' | 'lost'>, include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
212
212
|
/**
|
|
213
213
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
|
214
214
|
* @summary Update a discount added to a deal
|
|
@@ -303,7 +303,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
303
303
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
304
304
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
305
305
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
306
|
-
* @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.
|
|
306
|
+
* @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.
|
|
307
307
|
* @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.
|
|
308
308
|
* @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.
|
|
309
309
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -315,7 +315,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
315
315
|
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
318
|
-
getArchivedDeals(filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted'
|
|
318
|
+
getArchivedDeals(filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
319
319
|
/**
|
|
320
320
|
* Returns the details of a specific deal.
|
|
321
321
|
* @summary Get details of a deal
|
|
@@ -367,7 +367,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
367
367
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
368
368
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
369
369
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
370
|
-
* @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.
|
|
370
|
+
* @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.
|
|
371
371
|
* @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.
|
|
372
372
|
* @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.
|
|
373
373
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -381,7 +381,7 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
381
381
|
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
*/
|
|
384
|
-
getDeals(filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted'
|
|
384
|
+
getDeals(filter_id?: number, ids?: Set<string>, owner_id?: number, person_id?: number, org_id?: number, pipeline_id?: number, stage_id?: number, status?: Set<'open' | 'won' | 'lost' | 'deleted'>, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: Set<'next_activity_id' | 'last_activity_id' | 'first_won_time' | 'products_count' | 'files_count' | 'notes_count' | 'followers_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'participants_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'smart_bcc_email' | 'source_lead_id'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsResponse>>;
|
|
385
385
|
/**
|
|
386
386
|
* Adds a discount to a deal, changing the deal value if the deal has one-time products attached.
|
|
387
387
|
* @summary Add a discount to a deal
|
|
@@ -395,18 +395,18 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
395
395
|
* 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.
|
|
396
396
|
* @summary Search deals
|
|
397
397
|
* @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.
|
|
398
|
-
* @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>.
|
|
398
|
+
* @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>.
|
|
399
399
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
400
400
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
401
401
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
402
|
-
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
403
|
-
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
402
|
+
* @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.
|
|
403
|
+
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
404
404
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
405
405
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
406
406
|
|
|
407
407
|
* @throws {RequiredError}
|
|
408
408
|
*/
|
|
409
|
-
searchDeals(term: string, fields?: 'custom_fields' | 'notes' | 'title'
|
|
409
|
+
searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: Set<'open' | 'won' | 'lost'>, include_fields?: Set<'deal.cc_email'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealSearchResponse>>;
|
|
410
410
|
/**
|
|
411
411
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
|
412
412
|
* @summary Update a discount added to a deal
|
|
@@ -728,10 +728,10 @@ export interface DealsApiGetArchivedDealsRequest {
|
|
|
728
728
|
readonly stage_id?: number;
|
|
729
729
|
/**
|
|
730
730
|
* 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.
|
|
731
|
-
* @type {'open' | 'won' | 'lost' | 'deleted'}
|
|
731
|
+
* @type {Set<'open' | 'won' | 'lost' | 'deleted'>}
|
|
732
732
|
* @memberof DealsApiGetArchivedDeals
|
|
733
733
|
*/
|
|
734
|
-
readonly status?: 'open' | 'won' | 'lost' | 'deleted'
|
|
734
|
+
readonly status?: Set<'open' | 'won' | 'lost' | 'deleted'>;
|
|
735
735
|
/**
|
|
736
736
|
* 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.
|
|
737
737
|
* @type {string}
|
|
@@ -937,10 +937,10 @@ export interface DealsApiGetDealsRequest {
|
|
|
937
937
|
readonly stage_id?: number;
|
|
938
938
|
/**
|
|
939
939
|
* 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.
|
|
940
|
-
* @type {'open' | 'won' | 'lost' | 'deleted'}
|
|
940
|
+
* @type {Set<'open' | 'won' | 'lost' | 'deleted'>}
|
|
941
941
|
* @memberof DealsApiGetDeals
|
|
942
942
|
*/
|
|
943
|
-
readonly status?: 'open' | 'won' | 'lost' | 'deleted'
|
|
943
|
+
readonly status?: Set<'open' | 'won' | 'lost' | 'deleted'>;
|
|
944
944
|
/**
|
|
945
945
|
* 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.
|
|
946
946
|
* @type {string}
|
|
@@ -1035,10 +1035,10 @@ export interface DealsApiSearchDealsRequest {
|
|
|
1035
1035
|
readonly term: string;
|
|
1036
1036
|
/**
|
|
1037
1037
|
* 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>.
|
|
1038
|
-
* @type {'custom_fields' | 'notes' | 'title'}
|
|
1038
|
+
* @type {Set<'custom_fields' | 'notes' | 'title'>}
|
|
1039
1039
|
* @memberof DealsApiSearchDeals
|
|
1040
1040
|
*/
|
|
1041
|
-
readonly fields?: 'custom_fields' | 'notes' | 'title'
|
|
1041
|
+
readonly fields?: Set<'custom_fields' | 'notes' | 'title'>;
|
|
1042
1042
|
/**
|
|
1043
1043
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1044
1044
|
* @type {boolean}
|
|
@@ -1059,16 +1059,16 @@ export interface DealsApiSearchDealsRequest {
|
|
|
1059
1059
|
readonly organization_id?: number;
|
|
1060
1060
|
/**
|
|
1061
1061
|
* 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.
|
|
1062
|
-
* @type {'open' | 'won' | 'lost'}
|
|
1062
|
+
* @type {Set<'open' | 'won' | 'lost'>}
|
|
1063
1063
|
* @memberof DealsApiSearchDeals
|
|
1064
1064
|
*/
|
|
1065
|
-
readonly status?: 'open' | 'won' | 'lost'
|
|
1065
|
+
readonly status?: Set<'open' | 'won' | 'lost'>;
|
|
1066
1066
|
/**
|
|
1067
1067
|
* Supports including optional fields in the results which are not provided by default
|
|
1068
|
-
* @type {'deal.cc_email'}
|
|
1068
|
+
* @type {Set<'deal.cc_email'>}
|
|
1069
1069
|
* @memberof DealsApiSearchDeals
|
|
1070
1070
|
*/
|
|
1071
|
-
readonly include_fields?: 'deal.cc_email'
|
|
1071
|
+
readonly include_fields?: Set<'deal.cc_email'>;
|
|
1072
1072
|
/**
|
|
1073
1073
|
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
1074
1074
|
* @type {number}
|
|
@@ -296,7 +296,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
296
296
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
297
297
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
298
298
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
299
|
-
* @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.
|
|
299
|
+
* @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.
|
|
300
300
|
* @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.
|
|
301
301
|
* @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.
|
|
302
302
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -345,8 +345,8 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
345
345
|
if (stage_id !== undefined) {
|
|
346
346
|
localVarQueryParameter['stage_id'] = stage_id;
|
|
347
347
|
}
|
|
348
|
-
if (status
|
|
349
|
-
localVarQueryParameter['status'] = status;
|
|
348
|
+
if (status) {
|
|
349
|
+
localVarQueryParameter['status'] = Array.from(status).join(base_1.COLLECTION_FORMATS.csv);
|
|
350
350
|
}
|
|
351
351
|
if (updated_since !== undefined) {
|
|
352
352
|
localVarQueryParameter['updated_since'] = updated_since;
|
|
@@ -562,7 +562,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
562
562
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
563
563
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
564
564
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
565
|
-
* @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.
|
|
565
|
+
* @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.
|
|
566
566
|
* @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.
|
|
567
567
|
* @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.
|
|
568
568
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -613,8 +613,8 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
613
613
|
if (stage_id !== undefined) {
|
|
614
614
|
localVarQueryParameter['stage_id'] = stage_id;
|
|
615
615
|
}
|
|
616
|
-
if (status
|
|
617
|
-
localVarQueryParameter['status'] = status;
|
|
616
|
+
if (status) {
|
|
617
|
+
localVarQueryParameter['status'] = Array.from(status).join(base_1.COLLECTION_FORMATS.csv);
|
|
618
618
|
}
|
|
619
619
|
if (updated_since !== undefined) {
|
|
620
620
|
localVarQueryParameter['updated_since'] = updated_since;
|
|
@@ -695,12 +695,12 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
695
695
|
* 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.
|
|
696
696
|
* @summary Search deals
|
|
697
697
|
* @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.
|
|
698
|
-
* @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>.
|
|
698
|
+
* @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>.
|
|
699
699
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
700
700
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
701
701
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
702
|
-
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
703
|
-
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
702
|
+
* @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.
|
|
703
|
+
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
704
704
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
705
705
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
706
706
|
|
|
@@ -727,8 +727,8 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
727
727
|
if (term !== undefined) {
|
|
728
728
|
localVarQueryParameter['term'] = term;
|
|
729
729
|
}
|
|
730
|
-
if (fields
|
|
731
|
-
localVarQueryParameter['fields'] = fields;
|
|
730
|
+
if (fields) {
|
|
731
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
732
732
|
}
|
|
733
733
|
if (exact_match !== undefined) {
|
|
734
734
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -739,11 +739,11 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
739
739
|
if (organization_id !== undefined) {
|
|
740
740
|
localVarQueryParameter['organization_id'] = organization_id;
|
|
741
741
|
}
|
|
742
|
-
if (status
|
|
743
|
-
localVarQueryParameter['status'] = status;
|
|
742
|
+
if (status) {
|
|
743
|
+
localVarQueryParameter['status'] = Array.from(status).join(base_1.COLLECTION_FORMATS.csv);
|
|
744
744
|
}
|
|
745
|
-
if (include_fields
|
|
746
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
745
|
+
if (include_fields) {
|
|
746
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
747
747
|
}
|
|
748
748
|
if (limit !== undefined) {
|
|
749
749
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -951,7 +951,7 @@ const DealsApiFp = function (configuration) {
|
|
|
951
951
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
952
952
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
953
953
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
954
|
-
* @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.
|
|
954
|
+
* @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.
|
|
955
955
|
* @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.
|
|
956
956
|
* @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.
|
|
957
957
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -1040,7 +1040,7 @@ const DealsApiFp = function (configuration) {
|
|
|
1040
1040
|
* @param {number} [org_id] If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
1041
1041
|
* @param {number} [pipeline_id] If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
|
|
1042
1042
|
* @param {number} [stage_id] If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
|
|
1043
|
-
* @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.
|
|
1043
|
+
* @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.
|
|
1044
1044
|
* @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.
|
|
1045
1045
|
* @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.
|
|
1046
1046
|
* @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: `id`, `update_time`, `add_time`.
|
|
@@ -1078,12 +1078,12 @@ const DealsApiFp = function (configuration) {
|
|
|
1078
1078
|
* 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.
|
|
1079
1079
|
* @summary Search deals
|
|
1080
1080
|
* @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.
|
|
1081
|
-
* @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>.
|
|
1081
|
+
* @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>.
|
|
1082
1082
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1083
1083
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
1084
1084
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
1085
|
-
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
1086
|
-
* @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1085
|
+
* @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.
|
|
1086
|
+
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1087
1087
|
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
|
|
1088
1088
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1089
1089
|
|
|
@@ -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}
|
|
@@ -42,11 +42,11 @@ const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
|
42
42
|
* Performs a search from your choice of item types and fields.
|
|
43
43
|
* @summary Perform a search from multiple item types
|
|
44
44
|
* @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.
|
|
45
|
-
* @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.
|
|
46
|
-
* @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>.
|
|
45
|
+
* @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.
|
|
46
|
+
* @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>.
|
|
47
47
|
* @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
|
|
48
48
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
49
|
-
* @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.
|
|
49
|
+
* @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.
|
|
50
50
|
* @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.
|
|
51
51
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
52
52
|
|
|
@@ -73,11 +73,11 @@ const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
|
73
73
|
if (term !== undefined) {
|
|
74
74
|
localVarQueryParameter['term'] = term;
|
|
75
75
|
}
|
|
76
|
-
if (item_types
|
|
77
|
-
localVarQueryParameter['item_types'] = item_types;
|
|
76
|
+
if (item_types) {
|
|
77
|
+
localVarQueryParameter['item_types'] = Array.from(item_types).join(base_1.COLLECTION_FORMATS.csv);
|
|
78
78
|
}
|
|
79
|
-
if (fields
|
|
80
|
-
localVarQueryParameter['fields'] = fields;
|
|
79
|
+
if (fields) {
|
|
80
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
81
81
|
}
|
|
82
82
|
if (search_for_related_items !== undefined) {
|
|
83
83
|
localVarQueryParameter['search_for_related_items'] = search_for_related_items;
|
|
@@ -85,8 +85,8 @@ const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
|
85
85
|
if (exact_match !== undefined) {
|
|
86
86
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
87
87
|
}
|
|
88
|
-
if (include_fields
|
|
89
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
88
|
+
if (include_fields) {
|
|
89
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
90
90
|
}
|
|
91
91
|
if (limit !== undefined) {
|
|
92
92
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -176,11 +176,11 @@ const ItemSearchApiFp = function (configuration) {
|
|
|
176
176
|
* Performs a search from your choice of item types and fields.
|
|
177
177
|
* @summary Perform a search from multiple item types
|
|
178
178
|
* @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.
|
|
179
|
-
* @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.
|
|
180
|
-
* @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>.
|
|
179
|
+
* @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.
|
|
180
|
+
* @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>.
|
|
181
181
|
* @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
|
|
182
182
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
183
|
-
* @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.
|
|
183
|
+
* @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.
|
|
184
184
|
* @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.
|
|
185
185
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
186
186
|
|