pipedrive 35.1.0 → 35.1.2
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/v2/api/beta-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/beta-api.js +2 -2
- package/dist/esm/versions/v2/api/deals-api.d.ts +9 -9
- package/dist/esm/versions/v2/api/deals-api.js +5 -5
- package/dist/esm/versions/v2/api/leads-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/leads-api.js +2 -2
- package/dist/esm/versions/v2/api/organizations-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/organizations-api.js +2 -2
- package/dist/esm/versions/v2/api/persons-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/persons-api.js +2 -2
- package/dist/esm/versions/v2/api/products-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/products-api.js +2 -2
- package/dist/esm/versions/v2/api/projects-api.d.ts +3 -3
- package/dist/esm/versions/v2/api/projects-api.js +2 -2
- package/dist/versions/v2/api/beta-api.d.ts +3 -3
- package/dist/versions/v2/api/beta-api.js +2 -2
- package/dist/versions/v2/api/deals-api.d.ts +9 -9
- package/dist/versions/v2/api/deals-api.js +5 -5
- package/dist/versions/v2/api/leads-api.d.ts +3 -3
- package/dist/versions/v2/api/leads-api.js +2 -2
- package/dist/versions/v2/api/organizations-api.d.ts +3 -3
- package/dist/versions/v2/api/organizations-api.js +2 -2
- package/dist/versions/v2/api/persons-api.d.ts +3 -3
- package/dist/versions/v2/api/persons-api.js +2 -2
- package/dist/versions/v2/api/products-api.d.ts +3 -3
- package/dist/versions/v2/api/products-api.js +2 -2
- package/dist/versions/v2/api/projects-api.d.ts +3 -3
- package/dist/versions/v2/api/projects-api.js +2 -2
- package/package.json +1 -1
|
@@ -204,7 +204,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
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
|
|
207
|
-
* @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
|
|
207
|
+
* @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.
|
|
208
208
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
209
209
|
|
|
210
210
|
* @throws {RequiredError}
|
|
@@ -421,7 +421,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
|
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
|
|
424
|
-
* @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
|
|
424
|
+
* @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.
|
|
425
425
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
426
426
|
|
|
427
427
|
* @throws {RequiredError}
|
|
@@ -982,7 +982,7 @@ export interface BetaApiSearchProjectsRequest {
|
|
|
982
982
|
*/
|
|
983
983
|
readonly organization_id?: number;
|
|
984
984
|
/**
|
|
985
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
985
|
+
* 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.
|
|
986
986
|
* @type {number}
|
|
987
987
|
* @memberof BetaApiSearchProjects
|
|
988
988
|
*/
|
|
@@ -692,7 +692,7 @@ export const BetaApiAxiosParamCreator = function (configuration) {
|
|
|
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
|
|
695
|
-
* @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
|
|
695
|
+
* @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.
|
|
696
696
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
697
697
|
|
|
698
698
|
* @throws {RequiredError}
|
|
@@ -1192,7 +1192,7 @@ export const BetaApiFp = function (configuration) {
|
|
|
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
|
|
1195
|
-
* @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
|
|
1195
|
+
* @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.
|
|
1196
1196
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1197
1197
|
|
|
1198
1198
|
* @throws {RequiredError}
|
|
@@ -201,14 +201,14 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
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 {
|
|
204
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
205
205
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
206
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
206
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
207
207
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
208
208
|
|
|
209
209
|
* @throws {RequiredError}
|
|
210
210
|
*/
|
|
211
|
-
searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?:
|
|
211
|
+
searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: '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
|
|
@@ -399,14 +399,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
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 {
|
|
402
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
403
403
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
404
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
404
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
405
405
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
406
406
|
|
|
407
407
|
* @throws {RequiredError}
|
|
408
408
|
*/
|
|
409
|
-
searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?:
|
|
409
|
+
searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: '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
|
|
@@ -1059,10 +1059,10 @@ 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 {
|
|
1062
|
+
* @type {'open' | 'won' | 'lost'}
|
|
1063
1063
|
* @memberof DealsApiSearchDeals
|
|
1064
1064
|
*/
|
|
1065
|
-
readonly status?:
|
|
1065
|
+
readonly status?: 'open' | 'won' | 'lost';
|
|
1066
1066
|
/**
|
|
1067
1067
|
* Supports including optional fields in the results which are not provided by default
|
|
1068
1068
|
* @type {Set<'deal.cc_email'>}
|
|
@@ -1070,7 +1070,7 @@ export interface DealsApiSearchDealsRequest {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
readonly include_fields?: Set<'deal.cc_email'>;
|
|
1072
1072
|
/**
|
|
1073
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
1073
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
1074
1074
|
* @type {number}
|
|
1075
1075
|
* @memberof DealsApiSearchDeals
|
|
1076
1076
|
*/
|
|
@@ -693,9 +693,9 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
693
693
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
694
694
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
695
695
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
696
|
-
* @param {
|
|
696
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
697
697
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
698
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
698
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
699
699
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
700
700
|
|
|
701
701
|
* @throws {RequiredError}
|
|
@@ -734,7 +734,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
734
734
|
localVarQueryParameter['organization_id'] = organization_id;
|
|
735
735
|
}
|
|
736
736
|
if (status) {
|
|
737
|
-
localVarQueryParameter['status'] =
|
|
737
|
+
localVarQueryParameter['status'] = status;
|
|
738
738
|
}
|
|
739
739
|
if (include_fields) {
|
|
740
740
|
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
|
|
@@ -1075,9 +1075,9 @@ export const DealsApiFp = function (configuration) {
|
|
|
1075
1075
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1076
1076
|
* @param {number} [person_id] Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
|
|
1077
1077
|
* @param {number} [organization_id] Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
|
|
1078
|
-
* @param {
|
|
1078
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
1079
1079
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1080
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
1080
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
1081
1081
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1082
1082
|
|
|
1083
1083
|
* @throws {RequiredError}
|
|
@@ -48,7 +48,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
48
48
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
49
49
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
50
50
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
51
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
51
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
52
52
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
53
53
|
|
|
54
54
|
* @throws {RequiredError}
|
|
@@ -87,7 +87,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
87
87
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
88
88
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
89
89
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
90
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
90
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
91
91
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
92
92
|
|
|
93
93
|
* @throws {RequiredError}
|
|
@@ -205,7 +205,7 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
205
205
|
*/
|
|
206
206
|
readonly include_fields?: Set<'lead.was_seen'>;
|
|
207
207
|
/**
|
|
208
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
208
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
209
209
|
* @type {number}
|
|
210
210
|
* @memberof LeadsApiSearchLeads
|
|
211
211
|
*/
|
|
@@ -116,7 +116,7 @@ export const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
116
116
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
117
117
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
118
118
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
119
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
119
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
120
120
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
121
121
|
|
|
122
122
|
* @throws {RequiredError}
|
|
@@ -217,7 +217,7 @@ export const LeadsApiFp = function (configuration) {
|
|
|
217
217
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
218
218
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
219
219
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
220
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
220
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
221
221
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
222
222
|
|
|
223
223
|
* @throws {RequiredError}
|
|
@@ -120,7 +120,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
120
120
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
121
121
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
122
122
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
123
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
123
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
124
124
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
125
125
|
|
|
126
126
|
* @throws {RequiredError}
|
|
@@ -233,7 +233,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
233
233
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
234
234
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
235
235
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
236
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
236
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
237
237
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
238
238
|
|
|
239
239
|
* @throws {RequiredError}
|
|
@@ -596,7 +596,7 @@ export interface OrganizationsApiSearchOrganizationRequest {
|
|
|
596
596
|
*/
|
|
597
597
|
readonly exact_match?: boolean;
|
|
598
598
|
/**
|
|
599
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
599
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
600
600
|
* @type {number}
|
|
601
601
|
* @memberof OrganizationsApiSearchOrganization
|
|
602
602
|
*/
|
|
@@ -396,7 +396,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
396
396
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
397
397
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
398
398
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
399
|
-
* @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
|
|
399
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
400
400
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
401
401
|
|
|
402
402
|
* @throws {RequiredError}
|
|
@@ -620,7 +620,7 @@ export const OrganizationsApiFp = function (configuration) {
|
|
|
620
620
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
621
621
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
622
622
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
623
|
-
* @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
|
|
623
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
624
624
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
625
625
|
|
|
626
626
|
* @throws {RequiredError}
|
|
@@ -133,7 +133,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
133
133
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
134
134
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
135
135
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
136
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
136
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
137
137
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
138
138
|
|
|
139
139
|
* @throws {RequiredError}
|
|
@@ -258,7 +258,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
258
258
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
259
259
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
260
260
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
261
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
261
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
262
262
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
263
263
|
|
|
264
264
|
* @throws {RequiredError}
|
|
@@ -666,7 +666,7 @@ export interface PersonsApiSearchPersonsRequest {
|
|
|
666
666
|
*/
|
|
667
667
|
readonly include_fields?: Set<'person.picture'>;
|
|
668
668
|
/**
|
|
669
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
669
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
670
670
|
* @type {number}
|
|
671
671
|
* @memberof PersonsApiSearchPersons
|
|
672
672
|
*/
|
|
@@ -440,7 +440,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
440
440
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
441
441
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
442
442
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
443
|
-
* @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
|
|
443
|
+
* @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.
|
|
444
444
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
445
445
|
|
|
446
446
|
* @throws {RequiredError}
|
|
@@ -687,7 +687,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
687
687
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
688
688
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
689
689
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
690
|
-
* @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
|
|
690
|
+
* @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.
|
|
691
691
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
692
692
|
|
|
693
693
|
* @throws {RequiredError}
|
|
@@ -175,7 +175,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
175
175
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
176
176
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
177
177
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
178
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
178
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
179
179
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
180
180
|
|
|
181
181
|
* @throws {RequiredError}
|
|
@@ -361,7 +361,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
361
361
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
362
362
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
363
363
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
364
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
364
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
365
365
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
366
366
|
|
|
367
367
|
* @throws {RequiredError}
|
|
@@ -884,7 +884,7 @@ export interface ProductsApiSearchProductsRequest {
|
|
|
884
884
|
*/
|
|
885
885
|
readonly include_fields?: Set<'product.price'>;
|
|
886
886
|
/**
|
|
887
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
887
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
888
888
|
* @type {number}
|
|
889
889
|
* @memberof ProductsApiSearchProducts
|
|
890
890
|
*/
|
|
@@ -584,7 +584,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
584
584
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
585
585
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
586
586
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
587
|
-
* @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
|
|
587
|
+
* @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.
|
|
588
588
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
589
589
|
|
|
590
590
|
* @throws {RequiredError}
|
|
@@ -1013,7 +1013,7 @@ export const ProductsApiFp = function (configuration) {
|
|
|
1013
1013
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
1014
1014
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1015
1015
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1016
|
-
* @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
|
|
1016
|
+
* @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.
|
|
1017
1017
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1018
1018
|
|
|
1019
1019
|
* @throws {RequiredError}
|
|
@@ -110,7 +110,7 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
110
110
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
111
111
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
112
112
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
113
|
-
* @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
|
|
113
|
+
* @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.
|
|
114
114
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
115
115
|
|
|
116
116
|
* @throws {RequiredError}
|
|
@@ -216,7 +216,7 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
216
216
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
217
217
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
218
218
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
219
|
-
* @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
|
|
219
|
+
* @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.
|
|
220
220
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
221
221
|
|
|
222
222
|
* @throws {RequiredError}
|
|
@@ -537,7 +537,7 @@ export interface ProjectsApiSearchProjectsRequest {
|
|
|
537
537
|
*/
|
|
538
538
|
readonly organization_id?: number;
|
|
539
539
|
/**
|
|
540
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
540
|
+
* 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.
|
|
541
541
|
* @type {number}
|
|
542
542
|
* @memberof ProjectsApiSearchProjects
|
|
543
543
|
*/
|
|
@@ -365,7 +365,7 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
365
365
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
366
366
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
367
367
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
368
|
-
* @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
|
|
368
|
+
* @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.
|
|
369
369
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
370
370
|
|
|
371
371
|
* @throws {RequiredError}
|
|
@@ -588,7 +588,7 @@ export const ProjectsApiFp = function (configuration) {
|
|
|
588
588
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
589
589
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
590
590
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
591
|
-
* @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
|
|
591
|
+
* @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.
|
|
592
592
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
593
593
|
|
|
594
594
|
* @throws {RequiredError}
|
|
@@ -204,7 +204,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
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
|
|
207
|
-
* @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
|
|
207
|
+
* @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.
|
|
208
208
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
209
209
|
|
|
210
210
|
* @throws {RequiredError}
|
|
@@ -421,7 +421,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
|
|
|
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
|
|
424
|
-
* @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
|
|
424
|
+
* @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.
|
|
425
425
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
426
426
|
|
|
427
427
|
* @throws {RequiredError}
|
|
@@ -982,7 +982,7 @@ export interface BetaApiSearchProjectsRequest {
|
|
|
982
982
|
*/
|
|
983
983
|
readonly organization_id?: number;
|
|
984
984
|
/**
|
|
985
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
985
|
+
* 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.
|
|
986
986
|
* @type {number}
|
|
987
987
|
* @memberof BetaApiSearchProjects
|
|
988
988
|
*/
|
|
@@ -698,7 +698,7 @@ const BetaApiAxiosParamCreator = function (configuration) {
|
|
|
698
698
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
699
699
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
700
700
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
701
|
-
* @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
|
|
701
|
+
* @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.
|
|
702
702
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
703
703
|
|
|
704
704
|
* @throws {RequiredError}
|
|
@@ -1199,7 +1199,7 @@ const BetaApiFp = function (configuration) {
|
|
|
1199
1199
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1200
1200
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
1201
1201
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
1202
|
-
* @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
|
|
1202
|
+
* @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.
|
|
1203
1203
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1204
1204
|
|
|
1205
1205
|
* @throws {RequiredError}
|
|
@@ -201,14 +201,14 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
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 {
|
|
204
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
205
205
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
206
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
206
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
207
207
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
208
208
|
|
|
209
209
|
* @throws {RequiredError}
|
|
210
210
|
*/
|
|
211
|
-
searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?:
|
|
211
|
+
searchDeals: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: '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
|
|
@@ -399,14 +399,14 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
|
|
|
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 {
|
|
402
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
403
403
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
404
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
404
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
405
405
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
406
406
|
|
|
407
407
|
* @throws {RequiredError}
|
|
408
408
|
*/
|
|
409
|
-
searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?:
|
|
409
|
+
searchDeals(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, status?: '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
|
|
@@ -1059,10 +1059,10 @@ 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 {
|
|
1062
|
+
* @type {'open' | 'won' | 'lost'}
|
|
1063
1063
|
* @memberof DealsApiSearchDeals
|
|
1064
1064
|
*/
|
|
1065
|
-
readonly status?:
|
|
1065
|
+
readonly status?: 'open' | 'won' | 'lost';
|
|
1066
1066
|
/**
|
|
1067
1067
|
* Supports including optional fields in the results which are not provided by default
|
|
1068
1068
|
* @type {Set<'deal.cc_email'>}
|
|
@@ -1070,7 +1070,7 @@ export interface DealsApiSearchDealsRequest {
|
|
|
1070
1070
|
*/
|
|
1071
1071
|
readonly include_fields?: Set<'deal.cc_email'>;
|
|
1072
1072
|
/**
|
|
1073
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
1073
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
1074
1074
|
* @type {number}
|
|
1075
1075
|
* @memberof DealsApiSearchDeals
|
|
1076
1076
|
*/
|
|
@@ -699,9 +699,9 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
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 {
|
|
702
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
703
703
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
704
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
704
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
705
705
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
706
706
|
|
|
707
707
|
* @throws {RequiredError}
|
|
@@ -740,7 +740,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
|
740
740
|
localVarQueryParameter['organization_id'] = organization_id;
|
|
741
741
|
}
|
|
742
742
|
if (status) {
|
|
743
|
-
localVarQueryParameter['status'] =
|
|
743
|
+
localVarQueryParameter['status'] = status;
|
|
744
744
|
}
|
|
745
745
|
if (include_fields) {
|
|
746
746
|
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(base_1.COLLECTION_FORMATS.csv);
|
|
@@ -1082,9 +1082,9 @@ const DealsApiFp = function (configuration) {
|
|
|
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 {
|
|
1085
|
+
* @param {'open' | 'won' | 'lost'} [status] Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
|
|
1086
1086
|
* @param {Set<'deal.cc_email'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1087
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
1087
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
1088
1088
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1089
1089
|
|
|
1090
1090
|
* @throws {RequiredError}
|
|
@@ -48,7 +48,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
48
48
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
49
49
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
50
50
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
51
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
51
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
52
52
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
53
53
|
|
|
54
54
|
* @throws {RequiredError}
|
|
@@ -87,7 +87,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
87
87
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
88
88
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
89
89
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
90
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
90
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
91
91
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
92
92
|
|
|
93
93
|
* @throws {RequiredError}
|
|
@@ -205,7 +205,7 @@ export interface LeadsApiSearchLeadsRequest {
|
|
|
205
205
|
*/
|
|
206
206
|
readonly include_fields?: Set<'lead.was_seen'>;
|
|
207
207
|
/**
|
|
208
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
208
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
209
209
|
* @type {number}
|
|
210
210
|
* @memberof LeadsApiSearchLeads
|
|
211
211
|
*/
|
|
@@ -122,7 +122,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
122
122
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
123
123
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
124
124
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
125
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
125
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
126
126
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
127
127
|
|
|
128
128
|
* @throws {RequiredError}
|
|
@@ -224,7 +224,7 @@ const LeadsApiFp = function (configuration) {
|
|
|
224
224
|
* @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
|
|
225
225
|
* @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
|
|
226
226
|
* @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
227
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
227
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
228
228
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
229
229
|
|
|
230
230
|
* @throws {RequiredError}
|
|
@@ -120,7 +120,7 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
120
120
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
121
121
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
122
122
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
123
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
123
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
124
124
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
125
125
|
|
|
126
126
|
* @throws {RequiredError}
|
|
@@ -233,7 +233,7 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
233
233
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
234
234
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
235
235
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
236
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
236
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
237
237
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
238
238
|
|
|
239
239
|
* @throws {RequiredError}
|
|
@@ -596,7 +596,7 @@ export interface OrganizationsApiSearchOrganizationRequest {
|
|
|
596
596
|
*/
|
|
597
597
|
readonly exact_match?: boolean;
|
|
598
598
|
/**
|
|
599
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
599
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
600
600
|
* @type {number}
|
|
601
601
|
* @memberof OrganizationsApiSearchOrganization
|
|
602
602
|
*/
|
|
@@ -402,7 +402,7 @@ const OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
402
402
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
403
403
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
404
404
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
405
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
405
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
406
406
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
407
407
|
|
|
408
408
|
* @throws {RequiredError}
|
|
@@ -627,7 +627,7 @@ const OrganizationsApiFp = function (configuration) {
|
|
|
627
627
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
628
628
|
* @param {Set<'address' | 'custom_fields' | 'notes' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
629
629
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
630
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
630
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
631
631
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
632
632
|
|
|
633
633
|
* @throws {RequiredError}
|
|
@@ -133,7 +133,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
133
133
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
134
134
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
135
135
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
136
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
136
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
137
137
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
138
138
|
|
|
139
139
|
* @throws {RequiredError}
|
|
@@ -258,7 +258,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
258
258
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
259
259
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
260
260
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
261
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
261
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
262
262
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
263
263
|
|
|
264
264
|
* @throws {RequiredError}
|
|
@@ -666,7 +666,7 @@ export interface PersonsApiSearchPersonsRequest {
|
|
|
666
666
|
*/
|
|
667
667
|
readonly include_fields?: Set<'person.picture'>;
|
|
668
668
|
/**
|
|
669
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
669
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
670
670
|
* @type {number}
|
|
671
671
|
* @memberof PersonsApiSearchPersons
|
|
672
672
|
*/
|
|
@@ -446,7 +446,7 @@ const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
446
446
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
447
447
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
448
448
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
449
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
449
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
450
450
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
451
451
|
|
|
452
452
|
* @throws {RequiredError}
|
|
@@ -694,7 +694,7 @@ const PersonsApiFp = function (configuration) {
|
|
|
694
694
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
695
695
|
* @param {number} [organization_id] Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
|
|
696
696
|
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
697
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
697
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
698
698
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
699
699
|
|
|
700
700
|
* @throws {RequiredError}
|
|
@@ -175,7 +175,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
175
175
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
176
176
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
177
177
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
178
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
178
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
179
179
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
180
180
|
|
|
181
181
|
* @throws {RequiredError}
|
|
@@ -361,7 +361,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
361
361
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
362
362
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
363
363
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
364
|
-
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
364
|
+
* @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
365
365
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
366
366
|
|
|
367
367
|
* @throws {RequiredError}
|
|
@@ -884,7 +884,7 @@ export interface ProductsApiSearchProductsRequest {
|
|
|
884
884
|
*/
|
|
885
885
|
readonly include_fields?: Set<'product.price'>;
|
|
886
886
|
/**
|
|
887
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
887
|
+
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
|
|
888
888
|
* @type {number}
|
|
889
889
|
* @memberof ProductsApiSearchProducts
|
|
890
890
|
*/
|
|
@@ -590,7 +590,7 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
590
590
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
591
591
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
592
592
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
593
|
-
* @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
|
|
593
|
+
* @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.
|
|
594
594
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
595
595
|
|
|
596
596
|
* @throws {RequiredError}
|
|
@@ -1020,7 +1020,7 @@ const ProductsApiFp = function (configuration) {
|
|
|
1020
1020
|
* @param {Set<'code' | 'custom_fields' | 'name'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
1021
1021
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
1022
1022
|
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1023
|
-
* @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
|
|
1023
|
+
* @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.
|
|
1024
1024
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
1025
1025
|
|
|
1026
1026
|
* @throws {RequiredError}
|
|
@@ -110,7 +110,7 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
110
110
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
111
111
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
112
112
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
113
|
-
* @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
|
|
113
|
+
* @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.
|
|
114
114
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
115
115
|
|
|
116
116
|
* @throws {RequiredError}
|
|
@@ -216,7 +216,7 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
216
216
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
217
217
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
218
218
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
219
|
-
* @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
|
|
219
|
+
* @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.
|
|
220
220
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
221
221
|
|
|
222
222
|
* @throws {RequiredError}
|
|
@@ -537,7 +537,7 @@ export interface ProjectsApiSearchProjectsRequest {
|
|
|
537
537
|
*/
|
|
538
538
|
readonly organization_id?: number;
|
|
539
539
|
/**
|
|
540
|
-
* For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of
|
|
540
|
+
* 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.
|
|
541
541
|
* @type {number}
|
|
542
542
|
* @memberof ProjectsApiSearchProjects
|
|
543
543
|
*/
|
|
@@ -371,7 +371,7 @@ const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
371
371
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
372
372
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
373
373
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
374
|
-
* @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
|
|
374
|
+
* @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.
|
|
375
375
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
376
376
|
|
|
377
377
|
* @throws {RequiredError}
|
|
@@ -595,7 +595,7 @@ const ProjectsApiFp = function (configuration) {
|
|
|
595
595
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
596
596
|
* @param {number} [person_id] Will filter projects by the provided person ID
|
|
597
597
|
* @param {number} [organization_id] Will filter projects by the provided organization ID
|
|
598
|
-
* @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
|
|
598
|
+
* @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.
|
|
599
599
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
600
600
|
|
|
601
601
|
* @throws {RequiredError}
|