pipedrive 29.2.5 → 30.1.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/item-search-api.d.ts +7 -7
- package/dist/esm/versions/v1/api/item-search-api.js +2 -2
- package/dist/esm/versions/v2/api/deals-api.d.ts +123 -12
- package/dist/esm/versions/v2/api/deals-api.js +149 -4
- package/dist/esm/versions/v2/api/item-search-api.d.ts +7 -7
- package/dist/esm/versions/v2/api/item-search-api.js +2 -2
- package/dist/esm/versions/v2/models/add-many-deal-product-response.d.ts +29 -0
- package/dist/esm/versions/v2/models/add-many-deal-product-response.js +14 -0
- package/dist/esm/versions/v2/models/create-many-deal-product-request.d.ts +24 -0
- package/dist/esm/versions/v2/models/create-many-deal-product-request.js +14 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-additional-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-additional-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-data.d.ts +23 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response-data.js +14 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response.d.ts +35 -0
- package/dist/esm/versions/v2/models/delete-many-deal-product-response.js +14 -0
- package/dist/esm/versions/v2/models/index.d.ts +5 -0
- package/dist/esm/versions/v2/models/index.js +5 -0
- package/dist/versions/v1/api/item-search-api.d.ts +7 -7
- package/dist/versions/v1/api/item-search-api.js +2 -2
- package/dist/versions/v2/api/deals-api.d.ts +123 -12
- package/dist/versions/v2/api/deals-api.js +149 -4
- package/dist/versions/v2/api/item-search-api.d.ts +7 -7
- package/dist/versions/v2/api/item-search-api.js +2 -2
- package/dist/versions/v2/models/add-many-deal-product-response.d.ts +29 -0
- package/dist/versions/v2/models/add-many-deal-product-response.js +15 -0
- package/dist/versions/v2/models/create-many-deal-product-request.d.ts +24 -0
- package/dist/versions/v2/models/create-many-deal-product-request.js +15 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-additional-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-additional-data.js +15 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-data.d.ts +23 -0
- package/dist/versions/v2/models/delete-many-deal-product-response-data.js +15 -0
- package/dist/versions/v2/models/delete-many-deal-product-response.d.ts +35 -0
- package/dist/versions/v2/models/delete-many-deal-product-response.js +15 -0
- package/dist/versions/v2/models/index.d.ts +5 -0
- package/dist/versions/v2/models/index.js +5 -0
- package/package.json +1 -1
@@ -139,6 +139,43 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
139
139
|
options: localVarRequestOptions,
|
140
140
|
};
|
141
141
|
}),
|
142
|
+
/**
|
143
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
144
|
+
* @summary Add multiple products to a deal
|
145
|
+
* @param {number} id The ID of the deal
|
146
|
+
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
147
|
+
|
148
|
+
* @throws {RequiredError}
|
149
|
+
*/
|
150
|
+
addManyDealProducts: (id, CreateManyDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
|
151
|
+
// verify required parameter 'id' is not null or undefined
|
152
|
+
assertParamExists('addManyDealProducts', 'id', id);
|
153
|
+
const localVarPath = `/deals/{id}/products/bulk`
|
154
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
155
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
156
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
157
|
+
let baseOptions;
|
158
|
+
if (configuration) {
|
159
|
+
baseOptions = configuration.baseOptions;
|
160
|
+
}
|
161
|
+
const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
|
162
|
+
const localVarHeaderParameter = {};
|
163
|
+
const localVarQueryParameter = {};
|
164
|
+
// authentication api_key required
|
165
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
166
|
+
// authentication oauth2 required
|
167
|
+
// oauth required
|
168
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
169
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
170
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
171
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
172
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
173
|
+
localVarRequestOptions.data = serializeDataIfNeeded(CreateManyDealProductRequest, localVarRequestOptions, configuration);
|
174
|
+
return {
|
175
|
+
url: toPathString(localVarUrlObj),
|
176
|
+
options: localVarRequestOptions,
|
177
|
+
};
|
178
|
+
}),
|
142
179
|
/**
|
143
180
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
144
181
|
* @summary Convert a deal to a lead (BETA)
|
@@ -177,7 +214,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
177
214
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
178
215
|
* @summary Delete a discount from a deal
|
179
216
|
* @param {number} id The ID of the deal
|
180
|
-
* @param {
|
217
|
+
* @param {string} discount_id The ID of the discount
|
181
218
|
|
182
219
|
* @throws {RequiredError}
|
183
220
|
*/
|
@@ -359,6 +396,44 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
359
396
|
options: localVarRequestOptions,
|
360
397
|
};
|
361
398
|
}),
|
399
|
+
/**
|
400
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
401
|
+
* @summary Delete many products from a deal
|
402
|
+
* @param {number} id The ID of the deal
|
403
|
+
* @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
404
|
+
|
405
|
+
* @throws {RequiredError}
|
406
|
+
*/
|
407
|
+
deleteManyDealProducts: (id, ids) => __awaiter(this, void 0, void 0, function* () {
|
408
|
+
// verify required parameter 'id' is not null or undefined
|
409
|
+
assertParamExists('deleteManyDealProducts', 'id', id);
|
410
|
+
const localVarPath = `/deals/{id}/products`
|
411
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
412
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
413
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
414
|
+
let baseOptions;
|
415
|
+
if (configuration) {
|
416
|
+
baseOptions = configuration.baseOptions;
|
417
|
+
}
|
418
|
+
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
419
|
+
const localVarHeaderParameter = {};
|
420
|
+
const localVarQueryParameter = {};
|
421
|
+
// authentication api_key required
|
422
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
|
423
|
+
// authentication oauth2 required
|
424
|
+
// oauth required
|
425
|
+
yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
426
|
+
if (ids !== undefined) {
|
427
|
+
localVarQueryParameter['ids'] = ids;
|
428
|
+
}
|
429
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
430
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
431
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
432
|
+
return {
|
433
|
+
url: toPathString(localVarUrlObj),
|
434
|
+
options: localVarRequestOptions,
|
435
|
+
};
|
436
|
+
}),
|
362
437
|
/**
|
363
438
|
* Lists discounts attached to a deal.
|
364
439
|
* @summary List discounts added to a deal
|
@@ -1045,7 +1120,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
|
|
1045
1120
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
1046
1121
|
* @summary Update a discount added to a deal
|
1047
1122
|
* @param {number} id The ID of the deal
|
1048
|
-
* @param {
|
1123
|
+
* @param {string} discount_id The ID of the discount
|
1049
1124
|
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
1050
1125
|
|
1051
1126
|
* @throws {RequiredError}
|
@@ -1251,6 +1326,20 @@ export const DealsApiFp = function (configuration) {
|
|
1251
1326
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1252
1327
|
});
|
1253
1328
|
},
|
1329
|
+
/**
|
1330
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
1331
|
+
* @summary Add multiple products to a deal
|
1332
|
+
* @param {number} id The ID of the deal
|
1333
|
+
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
1334
|
+
|
1335
|
+
* @throws {RequiredError}
|
1336
|
+
*/
|
1337
|
+
addManyDealProducts(id, CreateManyDealProductRequest) {
|
1338
|
+
return __awaiter(this, void 0, void 0, function* () {
|
1339
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addManyDealProducts(id, CreateManyDealProductRequest);
|
1340
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1341
|
+
});
|
1342
|
+
},
|
1254
1343
|
/**
|
1255
1344
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
1256
1345
|
* @summary Convert a deal to a lead (BETA)
|
@@ -1268,7 +1357,7 @@ export const DealsApiFp = function (configuration) {
|
|
1268
1357
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
1269
1358
|
* @summary Delete a discount from a deal
|
1270
1359
|
* @param {number} id The ID of the deal
|
1271
|
-
* @param {
|
1360
|
+
* @param {string} discount_id The ID of the discount
|
1272
1361
|
|
1273
1362
|
* @throws {RequiredError}
|
1274
1363
|
*/
|
@@ -1333,6 +1422,20 @@ export const DealsApiFp = function (configuration) {
|
|
1333
1422
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1334
1423
|
});
|
1335
1424
|
},
|
1425
|
+
/**
|
1426
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
1427
|
+
* @summary Delete many products from a deal
|
1428
|
+
* @param {number} id The ID of the deal
|
1429
|
+
* @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
|
1430
|
+
|
1431
|
+
* @throws {RequiredError}
|
1432
|
+
*/
|
1433
|
+
deleteManyDealProducts(id, ids) {
|
1434
|
+
return __awaiter(this, void 0, void 0, function* () {
|
1435
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteManyDealProducts(id, ids);
|
1436
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
1437
|
+
});
|
1438
|
+
},
|
1336
1439
|
/**
|
1337
1440
|
* Lists discounts attached to a deal.
|
1338
1441
|
* @summary List discounts added to a deal
|
@@ -1565,7 +1668,7 @@ export const DealsApiFp = function (configuration) {
|
|
1565
1668
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
1566
1669
|
* @summary Update a discount added to a deal
|
1567
1670
|
* @param {number} id The ID of the deal
|
1568
|
-
* @param {
|
1671
|
+
* @param {string} discount_id The ID of the discount
|
1569
1672
|
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
1570
1673
|
|
1571
1674
|
* @throws {RequiredError}
|
@@ -1659,6 +1762,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1659
1762
|
addDealProduct(requestParameters) {
|
1660
1763
|
return localVarFp.addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(axios, basePath));
|
1661
1764
|
},
|
1765
|
+
/**
|
1766
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
1767
|
+
* @summary Add multiple products to a deal
|
1768
|
+
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
1769
|
+
|
1770
|
+
* @throws {RequiredError}
|
1771
|
+
*/
|
1772
|
+
addManyDealProducts(requestParameters) {
|
1773
|
+
return localVarFp.addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(axios, basePath));
|
1774
|
+
},
|
1662
1775
|
/**
|
1663
1776
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
1664
1777
|
* @summary Convert a deal to a lead (BETA)
|
@@ -1719,6 +1832,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1719
1832
|
deleteInstallment(requestParameters) {
|
1720
1833
|
return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(axios, basePath));
|
1721
1834
|
},
|
1835
|
+
/**
|
1836
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
1837
|
+
* @summary Delete many products from a deal
|
1838
|
+
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
1839
|
+
|
1840
|
+
* @throws {RequiredError}
|
1841
|
+
*/
|
1842
|
+
deleteManyDealProducts(requestParameters) {
|
1843
|
+
return localVarFp.deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(axios, basePath));
|
1844
|
+
},
|
1722
1845
|
/**
|
1723
1846
|
* Lists discounts attached to a deal.
|
1724
1847
|
* @summary List discounts added to a deal
|
@@ -1931,6 +2054,17 @@ export class DealsApi extends BaseAPI {
|
|
1931
2054
|
addDealProduct(requestParameters) {
|
1932
2055
|
return DealsApiFp(this.configuration).addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(this.axios, this.basePath));
|
1933
2056
|
}
|
2057
|
+
/**
|
2058
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
2059
|
+
* @summary Add multiple products to a deal
|
2060
|
+
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
2061
|
+
|
2062
|
+
* @throws {RequiredError}
|
2063
|
+
* @memberof DealsApi
|
2064
|
+
*/
|
2065
|
+
addManyDealProducts(requestParameters) {
|
2066
|
+
return DealsApiFp(this.configuration).addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(this.axios, this.basePath));
|
2067
|
+
}
|
1934
2068
|
/**
|
1935
2069
|
* Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
|
1936
2070
|
* @summary Convert a deal to a lead (BETA)
|
@@ -1997,6 +2131,17 @@ export class DealsApi extends BaseAPI {
|
|
1997
2131
|
deleteInstallment(requestParameters) {
|
1998
2132
|
return DealsApiFp(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(this.axios, this.basePath));
|
1999
2133
|
}
|
2134
|
+
/**
|
2135
|
+
* Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
|
2136
|
+
* @summary Delete many products from a deal
|
2137
|
+
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
2138
|
+
|
2139
|
+
* @throws {RequiredError}
|
2140
|
+
* @memberof DealsApi
|
2141
|
+
*/
|
2142
|
+
deleteManyDealProducts(requestParameters) {
|
2143
|
+
return DealsApiFp(this.configuration).deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
2144
|
+
}
|
2000
2145
|
/**
|
2001
2146
|
* Lists discounts attached to a deal.
|
2002
2147
|
* @summary List discounts added to a deal
|
@@ -24,7 +24,7 @@ export declare const ItemSearchApiAxiosParamCreator: (configuration?: Configurat
|
|
24
24
|
* @summary Perform a search from multiple item types
|
25
25
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
26
26
|
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
27
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
27
|
+
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
28
28
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
29
29
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
30
30
|
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
@@ -33,7 +33,7 @@ export declare const ItemSearchApiAxiosParamCreator: (configuration?: Configurat
|
|
33
33
|
|
34
34
|
* @throws {RequiredError}
|
35
35
|
*/
|
36
|
-
searchItem: (term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
36
|
+
searchItem: (term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', limit?: number, cursor?: string) => Promise<RequestArgs>;
|
37
37
|
/**
|
38
38
|
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
|
39
39
|
* @summary Perform a search using a specific field from an item type
|
@@ -58,7 +58,7 @@ export declare const ItemSearchApiFp: (configuration?: Configuration) => {
|
|
58
58
|
* @summary Perform a search from multiple item types
|
59
59
|
* @param {string} term The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
|
60
60
|
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
61
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
61
|
+
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
62
62
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
63
63
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
64
64
|
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
@@ -67,7 +67,7 @@ export declare const ItemSearchApiFp: (configuration?: Configuration) => {
|
|
67
67
|
|
68
68
|
* @throws {RequiredError}
|
69
69
|
*/
|
70
|
-
searchItem(term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
70
|
+
searchItem(term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchResponse>>;
|
71
71
|
/**
|
72
72
|
* Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
|
73
73
|
* @summary Perform a search using a specific field from an item type
|
@@ -123,11 +123,11 @@ export interface ItemSearchApiSearchItemRequest {
|
|
123
123
|
*/
|
124
124
|
readonly item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project';
|
125
125
|
/**
|
126
|
-
* A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `
|
127
|
-
* @type {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
126
|
+
* A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
127
|
+
* @type {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'}
|
128
128
|
* @memberof ItemSearchApiSearchItem
|
129
129
|
*/
|
130
|
-
readonly fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
130
|
+
readonly fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description';
|
131
131
|
/**
|
132
132
|
* When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
133
133
|
* @type {boolean}
|
@@ -37,7 +37,7 @@ export const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
37
37
|
* @summary Perform a search from multiple item types
|
38
38
|
* @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.
|
39
39
|
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
40
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
40
|
+
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
41
41
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
42
42
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
43
43
|
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
@@ -170,7 +170,7 @@ export const ItemSearchApiFp = function (configuration) {
|
|
170
170
|
* @summary Perform a search from multiple item types
|
171
171
|
* @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.
|
172
172
|
* @param {'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'} [item_types] A comma-separated string array. The type of items to perform the search from. Defaults to all.
|
173
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
173
|
+
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
|
174
174
|
* @param {boolean} [search_for_related_items] When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
|
175
175
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
176
176
|
* @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default.
|
@@ -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 { GetDealsProductsResponseDataInner } from './get-deals-products-response-data-inner';
|
13
|
+
/**
|
14
|
+
*
|
15
|
+
* @export
|
16
|
+
* @interface AddManyDealProductResponse
|
17
|
+
*/
|
18
|
+
export interface AddManyDealProductResponse {
|
19
|
+
/**
|
20
|
+
* If the response is successful or not
|
21
|
+
* @type {boolean}
|
22
|
+
*/
|
23
|
+
'success'?: boolean;
|
24
|
+
/**
|
25
|
+
* Array of created deal products
|
26
|
+
* @type {Array<GetDealsProductsResponseDataInner>}
|
27
|
+
*/
|
28
|
+
'data'?: Array<GetDealsProductsResponseDataInner>;
|
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 {};
|
@@ -0,0 +1,24 @@
|
|
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 { AddDealProductRequest } from './add-deal-product-request';
|
13
|
+
/**
|
14
|
+
*
|
15
|
+
* @export
|
16
|
+
* @interface CreateManyDealProductRequest
|
17
|
+
*/
|
18
|
+
export interface CreateManyDealProductRequest {
|
19
|
+
/**
|
20
|
+
* Array of products to attach to the deal. See the single product endpoint (https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct) for the expected format of array items.
|
21
|
+
* @type {Array<AddDealProductRequest>}
|
22
|
+
*/
|
23
|
+
'data': Array<AddDealProductRequest>;
|
24
|
+
}
|
@@ -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 {};
|
@@ -0,0 +1,23 @@
|
|
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
|
+
/**
|
13
|
+
*
|
14
|
+
* @export
|
15
|
+
* @interface DeleteManyDealProductResponseAdditionalData
|
16
|
+
*/
|
17
|
+
export interface DeleteManyDealProductResponseAdditionalData {
|
18
|
+
/**
|
19
|
+
* Whether there are more products to delete (when the deal has more than 100 products)
|
20
|
+
* @type {boolean}
|
21
|
+
*/
|
22
|
+
'more_items_in_collection'?: boolean;
|
23
|
+
}
|
@@ -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 {};
|
@@ -0,0 +1,23 @@
|
|
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
|
+
/**
|
13
|
+
*
|
14
|
+
* @export
|
15
|
+
* @interface DeleteManyDealProductResponseData
|
16
|
+
*/
|
17
|
+
export interface DeleteManyDealProductResponseData {
|
18
|
+
/**
|
19
|
+
* Array of IDs of products that were deleted from the deal
|
20
|
+
* @type {Array<number>}
|
21
|
+
*/
|
22
|
+
'ids'?: Array<number>;
|
23
|
+
}
|
@@ -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 {};
|
@@ -0,0 +1,35 @@
|
|
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 { DeleteManyDealProductResponseAdditionalData } from './delete-many-deal-product-response-additional-data';
|
13
|
+
import { DeleteManyDealProductResponseData } from './delete-many-deal-product-response-data';
|
14
|
+
/**
|
15
|
+
*
|
16
|
+
* @export
|
17
|
+
* @interface DeleteManyDealProductResponse
|
18
|
+
*/
|
19
|
+
export interface DeleteManyDealProductResponse {
|
20
|
+
/**
|
21
|
+
* If the response is successful or not
|
22
|
+
* @type {boolean}
|
23
|
+
*/
|
24
|
+
'success'?: boolean;
|
25
|
+
/**
|
26
|
+
*
|
27
|
+
* @type {DeleteManyDealProductResponseData}
|
28
|
+
*/
|
29
|
+
'data'?: DeleteManyDealProductResponseData;
|
30
|
+
/**
|
31
|
+
*
|
32
|
+
* @type {DeleteManyDealProductResponseAdditionalData}
|
33
|
+
*/
|
34
|
+
'additional_data'?: DeleteManyDealProductResponseAdditionalData | null;
|
35
|
+
}
|
@@ -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 {};
|
@@ -17,6 +17,7 @@ export * from './add-deal-request';
|
|
17
17
|
export * from './add-follower-response';
|
18
18
|
export * from './add-follower-response-all-of';
|
19
19
|
export * from './add-installment-request-body';
|
20
|
+
export * from './add-many-deal-product-response';
|
20
21
|
export * from './add-organization-request';
|
21
22
|
export * from './add-person-request';
|
22
23
|
export * from './add-person-request-emails-inner';
|
@@ -32,6 +33,7 @@ export * from './base-product-all-of';
|
|
32
33
|
export * from './base-product-all-of1';
|
33
34
|
export * from './base-response';
|
34
35
|
export * from './convert-lead-to-deal-request';
|
36
|
+
export * from './create-many-deal-product-request';
|
35
37
|
export * from './deal-item';
|
36
38
|
export * from './deal-item1';
|
37
39
|
export * from './deal-product-request-body';
|
@@ -48,6 +50,9 @@ export * from './delete-follower-response';
|
|
48
50
|
export * from './delete-follower-response-data';
|
49
51
|
export * from './delete-installment-response';
|
50
52
|
export * from './delete-installment-response-data';
|
53
|
+
export * from './delete-many-deal-product-response';
|
54
|
+
export * from './delete-many-deal-product-response-additional-data';
|
55
|
+
export * from './delete-many-deal-product-response-data';
|
51
56
|
export * from './delete-organization-response';
|
52
57
|
export * from './delete-organization-response-data';
|
53
58
|
export * from './delete-person-response';
|