pipedrive 35.1.1 → 36.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/leads-api.d.ts +7 -7
- package/dist/esm/versions/v1/api/leads-api.js +2 -2
- package/dist/esm/versions/v2/api/activities-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/activities-api.js +2 -2
- 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 +17 -17
- package/dist/esm/versions/v2/api/deals-api.js +6 -6
- 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 +10 -10
- 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 +4 -4
- package/dist/esm/versions/v2/api/products-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/products-api.js +4 -4
- 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/v1/api/leads-api.d.ts +7 -7
- package/dist/versions/v1/api/leads-api.js +2 -2
- package/dist/versions/v2/api/activities-api.d.ts +7 -7
- package/dist/versions/v2/api/activities-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 +17 -17
- package/dist/versions/v2/api/deals-api.js +6 -6
- 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 +10 -10
- 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 +4 -4
- package/dist/versions/v2/api/products-api.d.ts +10 -10
- package/dist/versions/v2/api/products-api.js +4 -4
- 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
|
@@ -107,7 +107,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
107
107
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
108
108
|
* @summary Get all persons
|
|
109
109
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
110
|
-
* @param {Set<
|
|
110
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
111
111
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
112
112
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
113
113
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -124,7 +124,7 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
124
124
|
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
127
|
-
getPersons: (filter_id?: number, ids?: Set<
|
|
127
|
+
getPersons: (filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, 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' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
128
128
|
/**
|
|
129
129
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
|
130
130
|
* @summary Search persons
|
|
@@ -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}
|
|
@@ -232,7 +232,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
232
232
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
233
233
|
* @summary Get all persons
|
|
234
234
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
235
|
-
* @param {Set<
|
|
235
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
236
236
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
237
237
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
238
238
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -249,7 +249,7 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
249
249
|
|
|
250
250
|
* @throws {RequiredError}
|
|
251
251
|
*/
|
|
252
|
-
getPersons(filter_id?: number, ids?: Set<
|
|
252
|
+
getPersons(filter_id?: number, ids?: Set<number>, owner_id?: number, org_id?: number, deal_id?: number, 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' | 'open_deals_count' | 'related_open_deals_count' | 'closed_deals_count' | 'related_closed_deals_count' | 'participant_open_deals_count' | 'participant_closed_deals_count' | 'email_messages_count' | 'activities_count' | 'done_activities_count' | 'undone_activities_count' | 'files_count' | 'notes_count' | 'followers_count' | 'won_deals_count' | 'related_won_deals_count' | 'lost_deals_count' | 'related_lost_deals_count' | 'last_incoming_mail_time' | 'last_outgoing_mail_time' | 'marketing_status' | 'doi_status' | 'smart_bcc_email'>, custom_fields?: Set<string>, include_option_labels?: boolean, include_labels?: boolean, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonsResponse>>;
|
|
253
253
|
/**
|
|
254
254
|
* Searches all persons by name, email, phone, 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 persons can be filtered by organization ID.
|
|
255
255
|
* @summary Search persons
|
|
@@ -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}
|
|
@@ -545,11 +545,11 @@ export interface PersonsApiGetPersonsRequest {
|
|
|
545
545
|
*/
|
|
546
546
|
readonly filter_id?: number;
|
|
547
547
|
/**
|
|
548
|
-
* Optional comma separated
|
|
549
|
-
* @type {Set<
|
|
548
|
+
* Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
549
|
+
* @type {Set<number>}
|
|
550
550
|
* @memberof PersonsApiGetPersons
|
|
551
551
|
*/
|
|
552
|
-
readonly ids?: Set<
|
|
552
|
+
readonly ids?: Set<number>;
|
|
553
553
|
/**
|
|
554
554
|
* If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
555
555
|
* @type {number}
|
|
@@ -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
|
*/
|
|
@@ -346,7 +346,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
346
346
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
347
347
|
* @summary Get all persons
|
|
348
348
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
349
|
-
* @param {Set<
|
|
349
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
350
350
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
351
351
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
352
352
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -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}
|
|
@@ -656,7 +656,7 @@ export const PersonsApiFp = function (configuration) {
|
|
|
656
656
|
* Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
|
|
657
657
|
* @summary Get all persons
|
|
658
658
|
* @param {number} [filter_id] If supplied, only persons matching the specified filter are returned
|
|
659
|
-
* @param {Set<
|
|
659
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
660
660
|
* @param {number} [owner_id] If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
661
661
|
* @param {number} [org_id] If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored.
|
|
662
662
|
* @param {number} [deal_id] If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
@@ -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}
|
|
@@ -156,7 +156,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
156
156
|
* Returns data about all products.
|
|
157
157
|
* @summary Get all products
|
|
158
158
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
159
|
-
* @param {Set<
|
|
159
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
160
160
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
161
161
|
* @param {number} [filter_id] The ID of the filter to use
|
|
162
162
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -167,7 +167,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
167
167
|
|
|
168
168
|
* @throws {RequiredError}
|
|
169
169
|
*/
|
|
170
|
-
getProducts: (owner_id?: number, ids?: Set<
|
|
170
|
+
getProducts: (owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string) => Promise<RequestArgs>;
|
|
171
171
|
/**
|
|
172
172
|
* Searches all products by name, code 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.
|
|
173
173
|
* @summary Search products
|
|
@@ -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}
|
|
@@ -342,7 +342,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
342
342
|
* Returns data about all products.
|
|
343
343
|
* @summary Get all products
|
|
344
344
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
345
|
-
* @param {Set<
|
|
345
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
346
346
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
347
347
|
* @param {number} [filter_id] The ID of the filter to use
|
|
348
348
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -353,7 +353,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
353
353
|
|
|
354
354
|
* @throws {RequiredError}
|
|
355
355
|
*/
|
|
356
|
-
getProducts(owner_id?: number, ids?: Set<
|
|
356
|
+
getProducts(owner_id?: number, ids?: Set<number>, custom_fields?: Set<string>, filter_id?: number, cursor?: string, limit?: number, sort_by?: 'id' | 'name' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc', updated_since?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductsResponse>>;
|
|
357
357
|
/**
|
|
358
358
|
* Searches all products by name, code 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.
|
|
359
359
|
* @summary Search products
|
|
@@ -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}
|
|
@@ -805,11 +805,11 @@ export interface ProductsApiGetProductsRequest {
|
|
|
805
805
|
*/
|
|
806
806
|
readonly owner_id?: number;
|
|
807
807
|
/**
|
|
808
|
-
* Optional comma separated
|
|
809
|
-
* @type {Set<
|
|
808
|
+
* Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
809
|
+
* @type {Set<number>}
|
|
810
810
|
* @memberof ProductsApiGetProducts
|
|
811
811
|
*/
|
|
812
|
-
readonly ids?: Set<
|
|
812
|
+
readonly ids?: Set<number>;
|
|
813
813
|
/**
|
|
814
814
|
* Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
815
815
|
* @type {Set<string>}
|
|
@@ -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
|
*/
|
|
@@ -515,7 +515,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
515
515
|
* Returns data about all products.
|
|
516
516
|
* @summary Get all products
|
|
517
517
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
518
|
-
* @param {Set<
|
|
518
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
519
519
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
520
520
|
* @param {number} [filter_id] The ID of the filter to use
|
|
521
521
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -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}
|
|
@@ -989,7 +989,7 @@ export const ProductsApiFp = function (configuration) {
|
|
|
989
989
|
* Returns data about all products.
|
|
990
990
|
* @summary Get all products
|
|
991
991
|
* @param {number} [owner_id] If supplied, only products owned by the given user will be returned
|
|
992
|
-
* @param {Set<
|
|
992
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
993
993
|
* @param {Set<string>} [custom_fields] Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed.
|
|
994
994
|
* @param {number} [filter_id] The ID of the filter to use
|
|
995
995
|
* @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
|
|
@@ -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}
|
|
@@ -80,11 +80,11 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
80
80
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
81
81
|
* @param {number} [filter_id] The ID of the filter to use
|
|
82
82
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
83
|
-
* @param {
|
|
83
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
84
84
|
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
*/
|
|
87
|
-
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?:
|
|
87
|
+
getLeads: (limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
89
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
90
90
|
* @summary Search leads
|
|
@@ -171,11 +171,11 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
|
|
|
171
171
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
172
172
|
* @param {number} [filter_id] The ID of the filter to use
|
|
173
173
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
174
|
-
* @param {
|
|
174
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
175
175
|
|
|
176
176
|
* @throws {RequiredError}
|
|
177
177
|
*/
|
|
178
|
-
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?:
|
|
178
|
+
getLeads(limit?: number, start?: number, owner_id?: number, person_id?: number, organization_id?: number, filter_id?: number, updated_since?: string, sort?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadsResponse>>;
|
|
179
179
|
/**
|
|
180
180
|
* Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
|
|
181
181
|
* @summary Search leads
|
|
@@ -421,11 +421,11 @@ export interface LeadsApiGetLeadsRequest {
|
|
|
421
421
|
*/
|
|
422
422
|
readonly updated_since?: string;
|
|
423
423
|
/**
|
|
424
|
-
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
|
|
425
|
-
* @type {
|
|
424
|
+
* The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
425
|
+
* @type {string}
|
|
426
426
|
* @memberof LeadsApiGetLeads
|
|
427
427
|
*/
|
|
428
|
-
readonly sort?:
|
|
428
|
+
readonly sort?: string;
|
|
429
429
|
}
|
|
430
430
|
/**
|
|
431
431
|
* Request parameters for searchLeads operation in LeadsApi.
|
|
@@ -241,7 +241,7 @@ const LeadsApiAxiosParamCreator = function (configuration) {
|
|
|
241
241
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
242
242
|
* @param {number} [filter_id] The ID of the filter to use
|
|
243
243
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
244
|
-
* @param {
|
|
244
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
245
245
|
|
|
246
246
|
* @throws {RequiredError}
|
|
247
247
|
*/
|
|
@@ -485,7 +485,7 @@ const LeadsApiFp = function (configuration) {
|
|
|
485
485
|
* @param {number} [organization_id] If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
|
|
486
486
|
* @param {number} [filter_id] The ID of the filter to use
|
|
487
487
|
* @param {string} [updated_since] If set, only leads with an `update_time` later than or equal to this time are returned. In ISO 8601 format, e.g. 2025-01-01T10:20:00Z.
|
|
488
|
-
* @param {
|
|
488
|
+
* @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: id, title, owner_id, creator_id, label_ids, value, source_name, was_seen, expected_close_date, next_activity_id, add_time, update_time, visible_to, and custom fields.
|
|
489
489
|
|
|
490
490
|
* @throws {RequiredError}
|
|
491
491
|
*/
|
|
@@ -41,7 +41,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
41
41
|
* Returns data about all activities.
|
|
42
42
|
* @summary Get all activities
|
|
43
43
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
44
|
-
* @param {Set<
|
|
44
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
45
45
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
46
46
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
47
47
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -58,7 +58,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
58
58
|
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
*/
|
|
61
|
-
getActivities: (filter_id?: number, ids?: Set<
|
|
61
|
+
getActivities: (filter_id?: number, ids?: Set<number>, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: Set<'attendees'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
62
62
|
/**
|
|
63
63
|
* Returns the details of a specific activity.
|
|
64
64
|
* @summary Get details of an activity
|
|
@@ -103,7 +103,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
|
103
103
|
* Returns data about all activities.
|
|
104
104
|
* @summary Get all activities
|
|
105
105
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
106
|
-
* @param {Set<
|
|
106
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
107
107
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
108
108
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
109
109
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -120,7 +120,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
|
|
|
120
120
|
|
|
121
121
|
* @throws {RequiredError}
|
|
122
122
|
*/
|
|
123
|
-
getActivities(filter_id?: number, ids?: Set<
|
|
123
|
+
getActivities(filter_id?: number, ids?: Set<number>, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, done?: boolean, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time' | 'due_date', sort_direction?: 'asc' | 'desc', include_fields?: Set<'attendees'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
|
|
124
124
|
/**
|
|
125
125
|
* Returns the details of a specific activity.
|
|
126
126
|
* @summary Get details of an activity
|
|
@@ -225,11 +225,11 @@ export interface ActivitiesApiGetActivitiesRequest {
|
|
|
225
225
|
*/
|
|
226
226
|
readonly filter_id?: number;
|
|
227
227
|
/**
|
|
228
|
-
* Optional comma separated
|
|
229
|
-
* @type {Set<
|
|
228
|
+
* Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
229
|
+
* @type {Set<number>}
|
|
230
230
|
* @memberof ActivitiesApiGetActivities
|
|
231
231
|
*/
|
|
232
|
-
readonly ids?: Set<
|
|
232
|
+
readonly ids?: Set<number>;
|
|
233
233
|
/**
|
|
234
234
|
* If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
235
235
|
* @type {number}
|
|
@@ -109,7 +109,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
|
|
|
109
109
|
* Returns data about all activities.
|
|
110
110
|
* @summary Get all activities
|
|
111
111
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
112
|
-
* @param {Set<
|
|
112
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
113
113
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
114
114
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
115
115
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -310,7 +310,7 @@ const ActivitiesApiFp = function (configuration) {
|
|
|
310
310
|
* Returns data about all activities.
|
|
311
311
|
* @summary Get all activities
|
|
312
312
|
* @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
|
|
313
|
-
* @param {Set<
|
|
313
|
+
* @param {Set<number>} [ids] Optional comma separated array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
|
|
314
314
|
* @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
|
|
315
315
|
* @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
|
|
316
316
|
* @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
|
|
@@ -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}
|