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
|
@@ -126,11 +126,11 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
126
126
|
* @param {number} [start] Pagination start
|
|
127
127
|
* @param {number} [limit] Items shown per page
|
|
128
128
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
129
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
129
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
130
130
|
|
|
131
131
|
* @throws {RequiredError}
|
|
132
132
|
*/
|
|
133
|
-
getPersonUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: string) => Promise<RequestArgs>;
|
|
133
|
+
getPersonUpdates: (id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>) => Promise<RequestArgs>;
|
|
134
134
|
/**
|
|
135
135
|
* List users permitted to access a person.
|
|
136
136
|
* @summary List permitted users
|
|
@@ -250,11 +250,11 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
250
250
|
* @param {number} [start] Pagination start
|
|
251
251
|
* @param {number} [limit] Items shown per page
|
|
252
252
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
253
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
253
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
254
254
|
|
|
255
255
|
* @throws {RequiredError}
|
|
256
256
|
*/
|
|
257
|
-
getPersonUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedPersonUpdatesResponse>>;
|
|
257
|
+
getPersonUpdates(id: number, start?: number, limit?: number, all_changes?: string, items?: Set<string>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetAssociatedPersonUpdatesResponse>>;
|
|
258
258
|
/**
|
|
259
259
|
* List users permitted to access a person.
|
|
260
260
|
* @summary List permitted users
|
|
@@ -626,10 +626,10 @@ export interface PersonsApiGetPersonUpdatesRequest {
|
|
|
626
626
|
readonly all_changes?: string;
|
|
627
627
|
/**
|
|
628
628
|
* A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
629
|
-
* @type {string}
|
|
629
|
+
* @type {Set<string>}
|
|
630
630
|
* @memberof PersonsApiGetPersonUpdates
|
|
631
631
|
*/
|
|
632
|
-
readonly items?: string
|
|
632
|
+
readonly items?: Set<string>;
|
|
633
633
|
}
|
|
634
634
|
/**
|
|
635
635
|
* Request parameters for getPersonUsers operation in PersonsApi.
|
|
@@ -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
|
* PersonsApi - axios parameter creator
|
|
31
31
|
* @export
|
|
@@ -417,7 +417,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
417
417
|
* @param {number} [start] Pagination start
|
|
418
418
|
* @param {number} [limit] Items shown per page
|
|
419
419
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
420
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
420
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
421
421
|
|
|
422
422
|
* @throws {RequiredError}
|
|
423
423
|
*/
|
|
@@ -449,8 +449,8 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
449
449
|
if (all_changes !== undefined) {
|
|
450
450
|
localVarQueryParameter['all_changes'] = all_changes;
|
|
451
451
|
}
|
|
452
|
-
if (items
|
|
453
|
-
localVarQueryParameter['items'] = items;
|
|
452
|
+
if (items) {
|
|
453
|
+
localVarQueryParameter['items'] = Array.from(items).join(COLLECTION_FORMATS.csv);
|
|
454
454
|
}
|
|
455
455
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
456
456
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -681,7 +681,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
681
681
|
* @param {number} [start] Pagination start
|
|
682
682
|
* @param {number} [limit] Items shown per page
|
|
683
683
|
* @param {string} [all_changes] Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
|
|
684
|
-
* @param {string} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
684
|
+
* @param {Set<string>} [items] A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
|
|
685
685
|
|
|
686
686
|
* @throws {RequiredError}
|
|
687
687
|
*/
|
|
@@ -42,11 +42,11 @@ export declare const ProductFieldsApiAxiosParamCreator: (configuration?: Configu
|
|
|
42
42
|
/**
|
|
43
43
|
* Marks multiple fields as deleted.
|
|
44
44
|
* @summary Delete multiple product fields in bulk
|
|
45
|
-
* @param {
|
|
45
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
46
46
|
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
|
-
deleteProductFields: (ids:
|
|
49
|
+
deleteProductFields: (ids: Set<number>) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
51
|
* Returns data about a specific product field.
|
|
52
52
|
* @summary Get one product field
|
|
@@ -98,11 +98,11 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
|
|
|
98
98
|
/**
|
|
99
99
|
* Marks multiple fields as deleted.
|
|
100
100
|
* @summary Delete multiple product fields in bulk
|
|
101
|
-
* @param {
|
|
101
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
102
102
|
|
|
103
103
|
* @throws {RequiredError}
|
|
104
104
|
*/
|
|
105
|
-
deleteProductFields(ids:
|
|
105
|
+
deleteProductFields(ids: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProductFieldsResponse>>;
|
|
106
106
|
/**
|
|
107
107
|
* Returns data about a specific product field.
|
|
108
108
|
* @summary Get one product field
|
|
@@ -218,10 +218,10 @@ export interface ProductFieldsApiDeleteProductFieldRequest {
|
|
|
218
218
|
export interface ProductFieldsApiDeleteProductFieldsRequest {
|
|
219
219
|
/**
|
|
220
220
|
* The comma-separated field IDs to delete
|
|
221
|
-
* @type {
|
|
221
|
+
* @type {Set<number>}
|
|
222
222
|
* @memberof ProductFieldsApiDeleteProductFields
|
|
223
223
|
*/
|
|
224
|
-
readonly ids:
|
|
224
|
+
readonly ids: Set<number>;
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
227
|
* Request parameters for getProductField operation in ProductFieldsApi.
|
|
@@ -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
|
* ProductFieldsApi - axios parameter creator
|
|
31
31
|
* @export
|
|
@@ -102,7 +102,7 @@ export const ProductFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
102
102
|
/**
|
|
103
103
|
* Marks multiple fields as deleted.
|
|
104
104
|
* @summary Delete multiple product fields in bulk
|
|
105
|
-
* @param {
|
|
105
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
106
106
|
|
|
107
107
|
* @throws {RequiredError}
|
|
108
108
|
*/
|
|
@@ -124,8 +124,8 @@ export const ProductFieldsApiAxiosParamCreator = function (configuration) {
|
|
|
124
124
|
// authentication oauth2 required
|
|
125
125
|
// oauth required
|
|
126
126
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["product-fields:full", "products:full"], configuration);
|
|
127
|
-
if (ids
|
|
128
|
-
localVarQueryParameter['ids'] = ids;
|
|
127
|
+
if (ids) {
|
|
128
|
+
localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
|
|
129
129
|
}
|
|
130
130
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131
131
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -282,7 +282,7 @@ export const ProductFieldsApiFp = function (configuration) {
|
|
|
282
282
|
/**
|
|
283
283
|
* Marks multiple fields as deleted.
|
|
284
284
|
* @summary Delete multiple product fields in bulk
|
|
285
|
-
* @param {
|
|
285
|
+
* @param {Set<number>} ids The comma-separated field IDs to delete
|
|
286
286
|
|
|
287
287
|
* @throws {RequiredError}
|
|
288
288
|
*/
|
|
@@ -200,7 +200,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
200
200
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
201
201
|
* @summary Search projects
|
|
202
202
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
203
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
203
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
204
204
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
205
205
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
206
206
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
@@ -209,7 +209,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
209
209
|
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
*/
|
|
212
|
-
searchProjects: (term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
212
|
+
searchProjects: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>, exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
213
213
|
/**
|
|
214
214
|
* Updates the properties of a project board.
|
|
215
215
|
* @summary Update a project board
|
|
@@ -417,7 +417,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
|
417
417
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
418
418
|
* @summary Search projects
|
|
419
419
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
420
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
420
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
421
421
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
422
422
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
423
423
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
@@ -426,7 +426,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
|
426
426
|
|
|
427
427
|
* @throws {RequiredError}
|
|
428
428
|
*/
|
|
429
|
-
searchProjects(term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
429
|
+
searchProjects(term: string, fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>, exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectSearchResponse>>;
|
|
430
430
|
/**
|
|
431
431
|
* Updates the properties of a project board.
|
|
432
432
|
* @summary Update a project board
|
|
@@ -959,10 +959,10 @@ export interface BetaApiSearchProjectsRequest {
|
|
|
959
959
|
readonly term: string;
|
|
960
960
|
/**
|
|
961
961
|
* A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
962
|
-
* @type {'custom_fields' | 'notes' | 'title' | 'description'}
|
|
962
|
+
* @type {Set<'custom_fields' | 'notes' | 'title' | 'description'>}
|
|
963
963
|
* @memberof BetaApiSearchProjects
|
|
964
964
|
*/
|
|
965
|
-
readonly fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
965
|
+
readonly fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>;
|
|
966
966
|
/**
|
|
967
967
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
968
968
|
* @type {boolean}
|
|
@@ -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
|
* BetaApi - axios parameter creator
|
|
31
31
|
* @export
|
|
@@ -688,7 +688,7 @@ export const BetaApiAxiosParamCreator = function (configuration) {
|
|
|
688
688
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
689
689
|
* @summary Search projects
|
|
690
690
|
* @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.
|
|
691
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
691
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
692
692
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
693
693
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
694
694
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
@@ -718,8 +718,8 @@ export const BetaApiAxiosParamCreator = function (configuration) {
|
|
|
718
718
|
if (term !== undefined) {
|
|
719
719
|
localVarQueryParameter['term'] = term;
|
|
720
720
|
}
|
|
721
|
-
if (fields
|
|
722
|
-
localVarQueryParameter['fields'] = fields;
|
|
721
|
+
if (fields) {
|
|
722
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
723
723
|
}
|
|
724
724
|
if (exact_match !== undefined) {
|
|
725
725
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -1188,7 +1188,7 @@ export const BetaApiFp = function (configuration) {
|
|
|
1188
1188
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
1189
1189
|
* @summary Search projects
|
|
1190
1190
|
* @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.
|
|
1191
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
1191
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
1192
1192
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1193
1193
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
1194
1194
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
@@ -56,11 +56,11 @@ export declare const DealProductsApiAxiosParamCreator: (configuration?: Configur
|
|
|
56
56
|
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
57
57
|
* @summary Delete many products from a deal
|
|
58
58
|
* @param {number} id The ID of the deal
|
|
59
|
-
* @param {
|
|
59
|
+
* @param {Set<number>} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
60
60
|
|
|
61
61
|
* @throws {RequiredError}
|
|
62
62
|
*/
|
|
63
|
-
deleteManyDealProducts: (id: number, ids?:
|
|
63
|
+
deleteManyDealProducts: (id: number, ids?: Set<number>) => Promise<RequestArgs>;
|
|
64
64
|
/**
|
|
65
65
|
* Lists products attached to a deal.
|
|
66
66
|
* @summary List products attached to a deal
|
|
@@ -132,11 +132,11 @@ export declare const DealProductsApiFp: (configuration?: Configuration) => {
|
|
|
132
132
|
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
133
133
|
* @summary Delete many products from a deal
|
|
134
134
|
* @param {number} id The ID of the deal
|
|
135
|
-
* @param {
|
|
135
|
+
* @param {Set<number>} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
136
136
|
|
|
137
137
|
* @throws {RequiredError}
|
|
138
138
|
*/
|
|
139
|
-
deleteManyDealProducts(id: number, ids?:
|
|
139
|
+
deleteManyDealProducts(id: number, ids?: Set<number>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteManyDealProductResponse>>;
|
|
140
140
|
/**
|
|
141
141
|
* Lists products attached to a deal.
|
|
142
142
|
* @summary List products attached to a deal
|
|
@@ -305,10 +305,10 @@ export interface DealProductsApiDeleteManyDealProductsRequest {
|
|
|
305
305
|
readonly id: number;
|
|
306
306
|
/**
|
|
307
307
|
* Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
308
|
-
* @type {
|
|
308
|
+
* @type {Set<number>}
|
|
309
309
|
* @memberof DealProductsApiDeleteManyDealProducts
|
|
310
310
|
*/
|
|
311
|
-
readonly ids?:
|
|
311
|
+
readonly ids?: Set<number>;
|
|
312
312
|
}
|
|
313
313
|
/**
|
|
314
314
|
* Request parameters for getDealProducts operation in DealProductsApi.
|
|
@@ -148,7 +148,7 @@ export const DealProductsApiAxiosParamCreator = function (configuration) {
|
|
|
148
148
|
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
149
149
|
* @summary Delete many products from a deal
|
|
150
150
|
* @param {number} id The ID of the deal
|
|
151
|
-
* @param {
|
|
151
|
+
* @param {Set<number>} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
152
152
|
|
|
153
153
|
* @throws {RequiredError}
|
|
154
154
|
*/
|
|
@@ -171,8 +171,8 @@ export const DealProductsApiAxiosParamCreator = function (configuration) {
|
|
|
171
171
|
// authentication oauth2 required
|
|
172
172
|
// oauth required
|
|
173
173
|
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
|
174
|
-
if (ids
|
|
175
|
-
localVarQueryParameter['ids'] = ids;
|
|
174
|
+
if (ids) {
|
|
175
|
+
localVarQueryParameter['ids'] = Array.from(ids).join(COLLECTION_FORMATS.csv);
|
|
176
176
|
}
|
|
177
177
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
178
178
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -380,7 +380,7 @@ export const DealProductsApiFp = function (configuration) {
|
|
|
380
380
|
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
|
381
381
|
* @summary Delete many products from a deal
|
|
382
382
|
* @param {number} id The ID of the deal
|
|
383
|
-
* @param {
|
|
383
|
+
* @param {Set<number>} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
|
384
384
|
|
|
385
385
|
* @throws {RequiredError}
|
|
386
386
|
*/
|
|
@@ -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}
|