pipedrive 34.0.0 → 35.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/deal-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/deal-fields-api.js +5 -5
- package/dist/esm/versions/v1/api/deals-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/deals-api.js +5 -5
- package/dist/esm/versions/v1/api/filters-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/filters-api.js +5 -5
- package/dist/esm/versions/v1/api/leads-api.d.ts +10 -10
- package/dist/esm/versions/v1/api/leads-api.js +9 -9
- package/dist/esm/versions/v1/api/organization-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/organization-fields-api.js +5 -5
- package/dist/esm/versions/v1/api/organizations-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/organizations-api.js +5 -5
- package/dist/esm/versions/v1/api/person-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/person-fields-api.js +5 -5
- package/dist/esm/versions/v1/api/persons-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/persons-api.js +5 -5
- package/dist/esm/versions/v1/api/product-fields-api.d.ts +6 -6
- package/dist/esm/versions/v1/api/product-fields-api.js +5 -5
- package/dist/esm/versions/v2/api/beta-api.d.ts +6 -6
- package/dist/esm/versions/v2/api/beta-api.js +5 -5
- package/dist/esm/versions/v2/api/deal-products-api.d.ts +6 -6
- package/dist/esm/versions/v2/api/deal-products-api.js +4 -4
- package/dist/esm/versions/v2/api/deals-api.d.ts +26 -26
- package/dist/esm/versions/v2/api/deals-api.js +20 -20
- package/dist/esm/versions/v2/api/item-search-api.d.ts +14 -14
- package/dist/esm/versions/v2/api/item-search-api.js +13 -13
- package/dist/esm/versions/v2/api/leads-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/leads-api.js +9 -9
- package/dist/esm/versions/v2/api/organizations-api.d.ts +6 -6
- package/dist/esm/versions/v2/api/organizations-api.js +4 -4
- package/dist/esm/versions/v2/api/persons-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/persons-api.js +8 -8
- package/dist/esm/versions/v2/api/product-fields-api.d.ts +14 -14
- package/dist/esm/versions/v2/api/products-api.d.ts +10 -10
- package/dist/esm/versions/v2/api/products-api.js +8 -8
- package/dist/esm/versions/v2/api/projects-api.d.ts +6 -6
- package/dist/esm/versions/v2/api/projects-api.js +5 -5
- package/dist/esm/versions/v2/models/add-product-field200-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-product-field200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
- package/dist/esm/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
- package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response-data-inner.js +48 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/get-product-fields200-response.js +14 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
- package/dist/esm/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
- package/dist/esm/versions/v2/models/index.d.ts +3 -0
- package/dist/esm/versions/v2/models/index.js +3 -0
- package/dist/versions/v1/api/deal-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/deal-fields-api.js +4 -4
- package/dist/versions/v1/api/deals-api.d.ts +6 -6
- package/dist/versions/v1/api/deals-api.js +4 -4
- package/dist/versions/v1/api/filters-api.d.ts +6 -6
- package/dist/versions/v1/api/filters-api.js +4 -4
- package/dist/versions/v1/api/leads-api.d.ts +10 -10
- package/dist/versions/v1/api/leads-api.js +8 -8
- package/dist/versions/v1/api/organization-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/organization-fields-api.js +4 -4
- package/dist/versions/v1/api/organizations-api.d.ts +6 -6
- package/dist/versions/v1/api/organizations-api.js +4 -4
- package/dist/versions/v1/api/person-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/person-fields-api.js +4 -4
- package/dist/versions/v1/api/persons-api.d.ts +6 -6
- package/dist/versions/v1/api/persons-api.js +4 -4
- package/dist/versions/v1/api/product-fields-api.d.ts +6 -6
- package/dist/versions/v1/api/product-fields-api.js +4 -4
- package/dist/versions/v2/api/beta-api.d.ts +6 -6
- package/dist/versions/v2/api/beta-api.js +4 -4
- package/dist/versions/v2/api/deal-products-api.d.ts +6 -6
- package/dist/versions/v2/api/deal-products-api.js +4 -4
- package/dist/versions/v2/api/deals-api.d.ts +26 -26
- package/dist/versions/v2/api/deals-api.js +20 -20
- package/dist/versions/v2/api/item-search-api.d.ts +14 -14
- package/dist/versions/v2/api/item-search-api.js +12 -12
- package/dist/versions/v2/api/leads-api.d.ts +10 -10
- package/dist/versions/v2/api/leads-api.js +8 -8
- package/dist/versions/v2/api/organizations-api.d.ts +6 -6
- package/dist/versions/v2/api/organizations-api.js +4 -4
- package/dist/versions/v2/api/persons-api.d.ts +10 -10
- package/dist/versions/v2/api/persons-api.js +8 -8
- package/dist/versions/v2/api/product-fields-api.d.ts +14 -14
- package/dist/versions/v2/api/products-api.d.ts +10 -10
- package/dist/versions/v2/api/products-api.js +8 -8
- package/dist/versions/v2/api/projects-api.d.ts +6 -6
- package/dist/versions/v2/api/projects-api.js +4 -4
- package/dist/versions/v2/models/add-product-field200-response.d.ts +29 -0
- package/dist/versions/v2/models/add-product-field200-response.js +15 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.d.ts +2 -0
- package/dist/versions/v2/models/get-activity-fields200-response-data-inner.js +3 -1
- package/dist/versions/v2/models/get-product-fields200-response-data-inner.d.ts +97 -0
- package/dist/versions/v2/models/get-product-fields200-response-data-inner.js +51 -0
- package/dist/versions/v2/models/get-product-fields200-response.d.ts +35 -0
- package/dist/versions/v2/models/get-product-fields200-response.js +15 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.d.ts +1 -0
- package/dist/versions/v2/models/get-project-fields200-response-data-inner.js +2 -1
- package/dist/versions/v2/models/index.d.ts +3 -0
- package/dist/versions/v2/models/index.js +3 -0
- package/package.json +1 -1
|
@@ -129,16 +129,16 @@ export declare const PersonsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
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
|
|
131
131
|
* @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.
|
|
132
|
-
* @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
132
|
+
* @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
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
|
-
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
135
|
+
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
136
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 500 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}
|
|
140
140
|
*/
|
|
141
|
-
searchPersons: (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name'
|
|
141
|
+
searchPersons: (term: string, fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>, exact_match?: boolean, organization_id?: number, include_fields?: Set<'person.picture'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
142
142
|
/**
|
|
143
143
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
144
144
|
* @summary Update a person
|
|
@@ -254,16 +254,16 @@ export declare const PersonsApiFp: (configuration?: Configuration) => {
|
|
|
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
|
|
256
256
|
* @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.
|
|
257
|
-
* @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
257
|
+
* @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
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
|
-
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
260
|
+
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
261
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 500 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}
|
|
265
265
|
*/
|
|
266
|
-
searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name'
|
|
266
|
+
searchPersons(term: string, fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>, exact_match?: boolean, organization_id?: number, include_fields?: Set<'person.picture'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonSearchResponse>>;
|
|
267
267
|
/**
|
|
268
268
|
* Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. <br>The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don\'t exist by default in Pipedrive and are only created when you set up your contact sync — attempting to set any of them without contact sync enabled returns a 403.
|
|
269
269
|
* @summary Update a person
|
|
@@ -643,10 +643,10 @@ export interface PersonsApiSearchPersonsRequest {
|
|
|
643
643
|
readonly term: string;
|
|
644
644
|
/**
|
|
645
645
|
* 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>.
|
|
646
|
-
* @type {'custom_fields' | 'email' | 'notes' | 'phone' | 'name'}
|
|
646
|
+
* @type {Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>}
|
|
647
647
|
* @memberof PersonsApiSearchPersons
|
|
648
648
|
*/
|
|
649
|
-
readonly fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name'
|
|
649
|
+
readonly fields?: Set<'custom_fields' | 'email' | 'notes' | 'phone' | 'name'>;
|
|
650
650
|
/**
|
|
651
651
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
652
652
|
* @type {boolean}
|
|
@@ -661,10 +661,10 @@ export interface PersonsApiSearchPersonsRequest {
|
|
|
661
661
|
readonly organization_id?: number;
|
|
662
662
|
/**
|
|
663
663
|
* Supports including optional fields in the results which are not provided by default
|
|
664
|
-
* @type {'person.picture'}
|
|
664
|
+
* @type {Set<'person.picture'>}
|
|
665
665
|
* @memberof PersonsApiSearchPersons
|
|
666
666
|
*/
|
|
667
|
-
readonly include_fields?: 'person.picture'
|
|
667
|
+
readonly include_fields?: Set<'person.picture'>;
|
|
668
668
|
/**
|
|
669
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 500 is allowed.
|
|
670
670
|
* @type {number}
|
|
@@ -436,10 +436,10 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
436
436
|
* 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.
|
|
437
437
|
* @summary Search persons
|
|
438
438
|
* @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.
|
|
439
|
-
* @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
439
|
+
* @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
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
|
-
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
442
|
+
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
443
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 500 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
|
|
|
@@ -466,8 +466,8 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
466
466
|
if (term !== undefined) {
|
|
467
467
|
localVarQueryParameter['term'] = term;
|
|
468
468
|
}
|
|
469
|
-
if (fields
|
|
470
|
-
localVarQueryParameter['fields'] = fields;
|
|
469
|
+
if (fields) {
|
|
470
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
471
471
|
}
|
|
472
472
|
if (exact_match !== undefined) {
|
|
473
473
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -475,8 +475,8 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
|
|
|
475
475
|
if (organization_id !== undefined) {
|
|
476
476
|
localVarQueryParameter['organization_id'] = organization_id;
|
|
477
477
|
}
|
|
478
|
-
if (include_fields
|
|
479
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
478
|
+
if (include_fields) {
|
|
479
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
|
|
480
480
|
}
|
|
481
481
|
if (limit !== undefined) {
|
|
482
482
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -683,10 +683,10 @@ export const PersonsApiFp = function (configuration) {
|
|
|
683
683
|
* 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.
|
|
684
684
|
* @summary Search persons
|
|
685
685
|
* @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.
|
|
686
|
-
* @param {'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
686
|
+
* @param {Set<'custom_fields' | 'email' | 'notes' | 'phone' | '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>.
|
|
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
|
-
* @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
689
|
+
* @param {Set<'person.picture'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
690
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 500 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
|
|
|
@@ -14,11 +14,11 @@ import type { AxiosInstance } from 'axios';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { AddDealFieldOptions200Response } from '../models';
|
|
16
16
|
import { AddDealFieldOptionsRequestInner } from '../models';
|
|
17
|
+
import { AddProductField200Response } from '../models';
|
|
17
18
|
import { AddProductFieldRequest } from '../models';
|
|
18
19
|
import { DeleteDealFieldOptionsRequestInner } from '../models';
|
|
19
20
|
import { DeletePersonField200Response } from '../models';
|
|
20
|
-
import {
|
|
21
|
-
import { GetActivityFields200Response } from '../models';
|
|
21
|
+
import { GetProductFields200Response } from '../models';
|
|
22
22
|
import { UpdateDealFieldOptionsRequestInner } from '../models';
|
|
23
23
|
import { UpdateProductFieldRequest } from '../models';
|
|
24
24
|
/**
|
|
@@ -110,7 +110,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
|
|
|
110
110
|
|
|
111
111
|
* @throws {RequiredError}
|
|
112
112
|
*/
|
|
113
|
-
addProductField(AddProductFieldRequest: AddProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<
|
|
113
|
+
addProductField(AddProductFieldRequest: AddProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
|
|
114
114
|
/**
|
|
115
115
|
* Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
116
116
|
* @summary Add product field options in bulk
|
|
@@ -145,7 +145,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
|
|
|
145
145
|
|
|
146
146
|
* @throws {RequiredError}
|
|
147
147
|
*/
|
|
148
|
-
getProductField(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<
|
|
148
|
+
getProductField(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
|
|
149
149
|
/**
|
|
150
150
|
* Returns metadata about all product fields in the company.
|
|
151
151
|
* @summary Get all product fields
|
|
@@ -155,7 +155,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
|
|
|
155
155
|
|
|
156
156
|
* @throws {RequiredError}
|
|
157
157
|
*/
|
|
158
|
-
getProductFields(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<
|
|
158
|
+
getProductFields(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductFields200Response>>;
|
|
159
159
|
/**
|
|
160
160
|
* Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
161
161
|
* @summary Update one product field
|
|
@@ -164,7 +164,7 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
|
|
|
164
164
|
|
|
165
165
|
* @throws {RequiredError}
|
|
166
166
|
*/
|
|
167
|
-
updateProductField(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<
|
|
167
|
+
updateProductField(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
|
|
168
168
|
/**
|
|
169
169
|
* Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
170
170
|
* @summary Update product field options in bulk
|
|
@@ -187,7 +187,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
|
|
|
187
187
|
|
|
188
188
|
* @throws {RequiredError}
|
|
189
189
|
*/
|
|
190
|
-
addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<
|
|
190
|
+
addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<AddProductField200Response>;
|
|
191
191
|
/**
|
|
192
192
|
* Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
193
193
|
* @summary Add product field options in bulk
|
|
@@ -219,7 +219,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
|
|
|
219
219
|
|
|
220
220
|
* @throws {RequiredError}
|
|
221
221
|
*/
|
|
222
|
-
getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<
|
|
222
|
+
getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<AddProductField200Response>;
|
|
223
223
|
/**
|
|
224
224
|
* Returns metadata about all product fields in the company.
|
|
225
225
|
* @summary Get all product fields
|
|
@@ -227,7 +227,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
|
|
|
227
227
|
|
|
228
228
|
* @throws {RequiredError}
|
|
229
229
|
*/
|
|
230
|
-
getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<
|
|
230
|
+
getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetProductFields200Response>;
|
|
231
231
|
/**
|
|
232
232
|
* Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
233
233
|
* @summary Update one product field
|
|
@@ -235,7 +235,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
|
|
|
235
235
|
|
|
236
236
|
* @throws {RequiredError}
|
|
237
237
|
*/
|
|
238
|
-
updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<
|
|
238
|
+
updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<AddProductField200Response>;
|
|
239
239
|
/**
|
|
240
240
|
* Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
241
241
|
* @summary Update product field options in bulk
|
|
@@ -406,7 +406,7 @@ export declare class ProductFieldsApi extends BaseAPI {
|
|
|
406
406
|
* @throws {RequiredError}
|
|
407
407
|
* @memberof ProductFieldsApi
|
|
408
408
|
*/
|
|
409
|
-
addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<
|
|
409
|
+
addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<AddProductField200Response>;
|
|
410
410
|
/**
|
|
411
411
|
* Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
|
|
412
412
|
* @summary Add product field options in bulk
|
|
@@ -442,7 +442,7 @@ export declare class ProductFieldsApi extends BaseAPI {
|
|
|
442
442
|
* @throws {RequiredError}
|
|
443
443
|
* @memberof ProductFieldsApi
|
|
444
444
|
*/
|
|
445
|
-
getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<
|
|
445
|
+
getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<AddProductField200Response>;
|
|
446
446
|
/**
|
|
447
447
|
* Returns metadata about all product fields in the company.
|
|
448
448
|
* @summary Get all product fields
|
|
@@ -451,7 +451,7 @@ export declare class ProductFieldsApi extends BaseAPI {
|
|
|
451
451
|
* @throws {RequiredError}
|
|
452
452
|
* @memberof ProductFieldsApi
|
|
453
453
|
*/
|
|
454
|
-
getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<
|
|
454
|
+
getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetProductFields200Response>;
|
|
455
455
|
/**
|
|
456
456
|
* Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
|
|
457
457
|
* @summary Update one product field
|
|
@@ -460,7 +460,7 @@ export declare class ProductFieldsApi extends BaseAPI {
|
|
|
460
460
|
* @throws {RequiredError}
|
|
461
461
|
* @memberof ProductFieldsApi
|
|
462
462
|
*/
|
|
463
|
-
updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<
|
|
463
|
+
updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<AddProductField200Response>;
|
|
464
464
|
/**
|
|
465
465
|
* Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
|
|
466
466
|
* @summary Update product field options in bulk
|
|
@@ -172,15 +172,15 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
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
|
|
174
174
|
* @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.
|
|
175
|
-
* @param {'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>.
|
|
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
|
-
* @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
177
|
+
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
178
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 500 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}
|
|
182
182
|
*/
|
|
183
|
-
searchProducts: (term: string, fields?: 'code' | 'custom_fields' | 'name'
|
|
183
|
+
searchProducts: (term: string, fields?: Set<'code' | 'custom_fields' | 'name'>, exact_match?: boolean, include_fields?: Set<'product.price'>, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
184
184
|
/**
|
|
185
185
|
* Updates product data.
|
|
186
186
|
* @summary Update a product
|
|
@@ -358,15 +358,15 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
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
|
|
360
360
|
* @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.
|
|
361
|
-
* @param {'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>.
|
|
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
|
-
* @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
363
|
+
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
364
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 500 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}
|
|
368
368
|
*/
|
|
369
|
-
searchProducts(term: string, fields?: 'code' | 'custom_fields' | 'name'
|
|
369
|
+
searchProducts(term: string, fields?: Set<'code' | 'custom_fields' | 'name'>, exact_match?: boolean, include_fields?: Set<'product.price'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductSearchResponse>>;
|
|
370
370
|
/**
|
|
371
371
|
* Updates product data.
|
|
372
372
|
* @summary Update a product
|
|
@@ -867,10 +867,10 @@ export interface ProductsApiSearchProductsRequest {
|
|
|
867
867
|
readonly term: string;
|
|
868
868
|
/**
|
|
869
869
|
* 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>.
|
|
870
|
-
* @type {'code' | 'custom_fields' | 'name'}
|
|
870
|
+
* @type {Set<'code' | 'custom_fields' | 'name'>}
|
|
871
871
|
* @memberof ProductsApiSearchProducts
|
|
872
872
|
*/
|
|
873
|
-
readonly fields?: 'code' | 'custom_fields' | 'name'
|
|
873
|
+
readonly fields?: Set<'code' | 'custom_fields' | 'name'>;
|
|
874
874
|
/**
|
|
875
875
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
876
876
|
* @type {boolean}
|
|
@@ -879,10 +879,10 @@ export interface ProductsApiSearchProductsRequest {
|
|
|
879
879
|
readonly exact_match?: boolean;
|
|
880
880
|
/**
|
|
881
881
|
* Supports including optional fields in the results which are not provided by default
|
|
882
|
-
* @type {'product.price'}
|
|
882
|
+
* @type {Set<'product.price'>}
|
|
883
883
|
* @memberof ProductsApiSearchProducts
|
|
884
884
|
*/
|
|
885
|
-
readonly include_fields?: 'product.price'
|
|
885
|
+
readonly include_fields?: Set<'product.price'>;
|
|
886
886
|
/**
|
|
887
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 500 is allowed.
|
|
888
888
|
* @type {number}
|
|
@@ -581,9 +581,9 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
581
581
|
* 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.
|
|
582
582
|
* @summary Search products
|
|
583
583
|
* @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.
|
|
584
|
-
* @param {'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>.
|
|
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
|
-
* @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
586
|
+
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
587
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 500 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
|
|
|
@@ -610,14 +610,14 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
610
610
|
if (term !== undefined) {
|
|
611
611
|
localVarQueryParameter['term'] = term;
|
|
612
612
|
}
|
|
613
|
-
if (fields
|
|
614
|
-
localVarQueryParameter['fields'] = fields;
|
|
613
|
+
if (fields) {
|
|
614
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
615
615
|
}
|
|
616
616
|
if (exact_match !== undefined) {
|
|
617
617
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
618
618
|
}
|
|
619
|
-
if (include_fields
|
|
620
|
-
localVarQueryParameter['include_fields'] = include_fields;
|
|
619
|
+
if (include_fields) {
|
|
620
|
+
localVarQueryParameter['include_fields'] = Array.from(include_fields).join(COLLECTION_FORMATS.csv);
|
|
621
621
|
}
|
|
622
622
|
if (limit !== undefined) {
|
|
623
623
|
localVarQueryParameter['limit'] = limit;
|
|
@@ -1010,9 +1010,9 @@ export const ProductsApiFp = function (configuration) {
|
|
|
1010
1010
|
* 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.
|
|
1011
1011
|
* @summary Search products
|
|
1012
1012
|
* @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.
|
|
1013
|
-
* @param {'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>.
|
|
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
|
-
* @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1015
|
+
* @param {Set<'product.price'>} [include_fields] Supports including optional fields in the results which are not provided by default
|
|
1016
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 500 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
|
|
|
@@ -106,7 +106,7 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
106
106
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
107
107
|
* @summary Search projects
|
|
108
108
|
* @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.
|
|
109
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
109
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
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
|
|
@@ -115,7 +115,7 @@ export declare const ProjectsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
115
115
|
|
|
116
116
|
* @throws {RequiredError}
|
|
117
117
|
*/
|
|
118
|
-
searchProjects: (term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
118
|
+
searchProjects: (term: string, fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>, exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string) => Promise<RequestArgs>;
|
|
119
119
|
/**
|
|
120
120
|
* Updates the properties of a project.
|
|
121
121
|
* @summary Update a project
|
|
@@ -212,7 +212,7 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
212
212
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
213
213
|
* @summary Search projects
|
|
214
214
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
|
215
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
215
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
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
|
|
@@ -221,7 +221,7 @@ export declare const ProjectsApiFp: (configuration?: Configuration) => {
|
|
|
221
221
|
|
|
222
222
|
* @throws {RequiredError}
|
|
223
223
|
*/
|
|
224
|
-
searchProjects(term: string, fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
224
|
+
searchProjects(term: string, fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>, exact_match?: boolean, person_id?: number, organization_id?: number, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectSearchResponse>>;
|
|
225
225
|
/**
|
|
226
226
|
* Updates the properties of a project.
|
|
227
227
|
* @summary Update a project
|
|
@@ -514,10 +514,10 @@ export interface ProjectsApiSearchProjectsRequest {
|
|
|
514
514
|
readonly term: string;
|
|
515
515
|
/**
|
|
516
516
|
* 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>.
|
|
517
|
-
* @type {'custom_fields' | 'notes' | 'title' | 'description'}
|
|
517
|
+
* @type {Set<'custom_fields' | 'notes' | 'title' | 'description'>}
|
|
518
518
|
* @memberof ProjectsApiSearchProjects
|
|
519
519
|
*/
|
|
520
|
-
readonly fields?: 'custom_fields' | 'notes' | 'title' | 'description'
|
|
520
|
+
readonly fields?: Set<'custom_fields' | 'notes' | 'title' | 'description'>;
|
|
521
521
|
/**
|
|
522
522
|
* When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
|
523
523
|
* @type {boolean}
|
|
@@ -25,7 +25,7 @@ import globalAxios from 'axios';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import { BASE_PATH, BaseAPI } from '../base';
|
|
28
|
+
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
29
29
|
/**
|
|
30
30
|
* ProjectsApi - axios parameter creator
|
|
31
31
|
* @export
|
|
@@ -361,7 +361,7 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
361
361
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
362
362
|
* @summary Search projects
|
|
363
363
|
* @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.
|
|
364
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
364
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
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
|
|
@@ -391,8 +391,8 @@ export const ProjectsApiAxiosParamCreator = function (configuration) {
|
|
|
391
391
|
if (term !== undefined) {
|
|
392
392
|
localVarQueryParameter['term'] = term;
|
|
393
393
|
}
|
|
394
|
-
if (fields
|
|
395
|
-
localVarQueryParameter['fields'] = fields;
|
|
394
|
+
if (fields) {
|
|
395
|
+
localVarQueryParameter['fields'] = Array.from(fields).join(COLLECTION_FORMATS.csv);
|
|
396
396
|
}
|
|
397
397
|
if (exact_match !== undefined) {
|
|
398
398
|
localVarQueryParameter['exact_match'] = exact_match;
|
|
@@ -584,7 +584,7 @@ export const ProjectsApiFp = function (configuration) {
|
|
|
584
584
|
* Searches all projects by title, description, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found projects can be filtered by person ID or organization ID.
|
|
585
585
|
* @summary Search projects
|
|
586
586
|
* @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.
|
|
587
|
-
* @param {'custom_fields' | 'notes' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
587
|
+
* @param {Set<'custom_fields' | 'notes' | 'title' | 'description'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
|
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
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Pipedrive API v2
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { GetProductFields200ResponseDataInner } from './get-product-fields200-response-data-inner';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface AddProductField200Response
|
|
17
|
+
*/
|
|
18
|
+
export interface AddProductField200Response {
|
|
19
|
+
/**
|
|
20
|
+
* Whether the request was successful
|
|
21
|
+
* @type {boolean}
|
|
22
|
+
*/
|
|
23
|
+
'success'?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {GetProductFields200ResponseDataInner}
|
|
27
|
+
*/
|
|
28
|
+
'data'?: GetProductFields200ResponseDataInner;
|
|
29
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Pipedrive API v2
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -93,5 +93,7 @@ export declare const GetActivityFields200ResponseDataInnerFieldTypeConst: {
|
|
|
93
93
|
readonly billing_frequency: "billing_frequency";
|
|
94
94
|
readonly projects_board: "projects_board";
|
|
95
95
|
readonly projects_phase: "projects_phase";
|
|
96
|
+
readonly participants: "participants";
|
|
97
|
+
readonly attendees: "attendees";
|
|
96
98
|
};
|
|
97
99
|
export type GetActivityFields200ResponseDataInnerFieldTypeConst = typeof GetActivityFields200ResponseDataInnerFieldTypeConst[keyof typeof GetActivityFields200ResponseDataInnerFieldTypeConst];
|
|
@@ -44,5 +44,7 @@ export const GetActivityFields200ResponseDataInnerFieldTypeConst = {
|
|
|
44
44
|
price_list: 'price_list',
|
|
45
45
|
billing_frequency: 'billing_frequency',
|
|
46
46
|
projects_board: 'projects_board',
|
|
47
|
-
projects_phase: 'projects_phase'
|
|
47
|
+
projects_phase: 'projects_phase',
|
|
48
|
+
participants: 'participants',
|
|
49
|
+
attendees: 'attendees'
|
|
48
50
|
};
|