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
@@ -145,6 +145,43 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
145
145
|
options: localVarRequestOptions,
|
146
146
|
};
|
147
147
|
}),
|
148
|
+
/**
|
149
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
150
|
+
* @summary Add multiple products to a deal
|
151
|
+
* @param {number} id The ID of the deal
|
152
|
+
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
153
|
+
|
154
|
+
* @throws {RequiredError}
|
155
|
+
*/
|
156
|
+
addManyDealProducts: (id, CreateManyDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
|
157
|
+
// verify required parameter 'id' is not null or undefined
|
158
|
+
(0, common_1.assertParamExists)('addManyDealProducts', 'id', id);
|
159
|
+
const localVarPath = `/deals/{id}/products/bulk`
|
160
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
161
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
162
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
163
|
+
let baseOptions;
|
164
|
+
if (configuration) {
|
165
|
+
baseOptions = configuration.baseOptions;
|
166
|
+
}
|
167
|
+
const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
|
168
|
+
const localVarHeaderParameter = {};
|
169
|
+
const localVarQueryParameter = {};
|
170
|
+
// authentication api_key required
|
171
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
172
|
+
// authentication oauth2 required
|
173
|
+
// oauth required
|
174
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
175
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
176
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
177
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
178
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
179
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(CreateManyDealProductRequest, localVarRequestOptions, configuration);
|
180
|
+
return {
|
181
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
182
|
+
options: localVarRequestOptions,
|
183
|
+
};
|
184
|
+
}),
|
148
185
|
/**
|
149
186
|
* 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.
|
150
187
|
* @summary Convert a deal to a lead (BETA)
|
@@ -183,7 +220,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
183
220
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
184
221
|
* @summary Delete a discount from a deal
|
185
222
|
* @param {number} id The ID of the deal
|
186
|
-
* @param {
|
223
|
+
* @param {string} discount_id The ID of the discount
|
187
224
|
|
188
225
|
* @throws {RequiredError}
|
189
226
|
*/
|
@@ -365,6 +402,44 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
365
402
|
options: localVarRequestOptions,
|
366
403
|
};
|
367
404
|
}),
|
405
|
+
/**
|
406
|
+
* 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.
|
407
|
+
* @summary Delete many products from a deal
|
408
|
+
* @param {number} id The ID of the deal
|
409
|
+
* @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.
|
410
|
+
|
411
|
+
* @throws {RequiredError}
|
412
|
+
*/
|
413
|
+
deleteManyDealProducts: (id, ids) => __awaiter(this, void 0, void 0, function* () {
|
414
|
+
// verify required parameter 'id' is not null or undefined
|
415
|
+
(0, common_1.assertParamExists)('deleteManyDealProducts', 'id', id);
|
416
|
+
const localVarPath = `/deals/{id}/products`
|
417
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
418
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
419
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
420
|
+
let baseOptions;
|
421
|
+
if (configuration) {
|
422
|
+
baseOptions = configuration.baseOptions;
|
423
|
+
}
|
424
|
+
const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
|
425
|
+
const localVarHeaderParameter = {};
|
426
|
+
const localVarQueryParameter = {};
|
427
|
+
// authentication api_key required
|
428
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-token", configuration);
|
429
|
+
// authentication oauth2 required
|
430
|
+
// oauth required
|
431
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
|
432
|
+
if (ids !== undefined) {
|
433
|
+
localVarQueryParameter['ids'] = ids;
|
434
|
+
}
|
435
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
436
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
437
|
+
localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
|
438
|
+
return {
|
439
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
440
|
+
options: localVarRequestOptions,
|
441
|
+
};
|
442
|
+
}),
|
368
443
|
/**
|
369
444
|
* Lists discounts attached to a deal.
|
370
445
|
* @summary List discounts added to a deal
|
@@ -1051,7 +1126,7 @@ const DealsApiAxiosParamCreator = function (configuration) {
|
|
1051
1126
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
1052
1127
|
* @summary Update a discount added to a deal
|
1053
1128
|
* @param {number} id The ID of the deal
|
1054
|
-
* @param {
|
1129
|
+
* @param {string} discount_id The ID of the discount
|
1055
1130
|
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
1056
1131
|
|
1057
1132
|
* @throws {RequiredError}
|
@@ -1258,6 +1333,20 @@ const DealsApiFp = function (configuration) {
|
|
1258
1333
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
1259
1334
|
});
|
1260
1335
|
},
|
1336
|
+
/**
|
1337
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
1338
|
+
* @summary Add multiple products to a deal
|
1339
|
+
* @param {number} id The ID of the deal
|
1340
|
+
* @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
|
1341
|
+
|
1342
|
+
* @throws {RequiredError}
|
1343
|
+
*/
|
1344
|
+
addManyDealProducts(id, CreateManyDealProductRequest) {
|
1345
|
+
return __awaiter(this, void 0, void 0, function* () {
|
1346
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addManyDealProducts(id, CreateManyDealProductRequest);
|
1347
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
1348
|
+
});
|
1349
|
+
},
|
1261
1350
|
/**
|
1262
1351
|
* 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.
|
1263
1352
|
* @summary Convert a deal to a lead (BETA)
|
@@ -1275,7 +1364,7 @@ const DealsApiFp = function (configuration) {
|
|
1275
1364
|
* Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
|
1276
1365
|
* @summary Delete a discount from a deal
|
1277
1366
|
* @param {number} id The ID of the deal
|
1278
|
-
* @param {
|
1367
|
+
* @param {string} discount_id The ID of the discount
|
1279
1368
|
|
1280
1369
|
* @throws {RequiredError}
|
1281
1370
|
*/
|
@@ -1340,6 +1429,20 @@ const DealsApiFp = function (configuration) {
|
|
1340
1429
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
1341
1430
|
});
|
1342
1431
|
},
|
1432
|
+
/**
|
1433
|
+
* 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.
|
1434
|
+
* @summary Delete many products from a deal
|
1435
|
+
* @param {number} id The ID of the deal
|
1436
|
+
* @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.
|
1437
|
+
|
1438
|
+
* @throws {RequiredError}
|
1439
|
+
*/
|
1440
|
+
deleteManyDealProducts(id, ids) {
|
1441
|
+
return __awaiter(this, void 0, void 0, function* () {
|
1442
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteManyDealProducts(id, ids);
|
1443
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
1444
|
+
});
|
1445
|
+
},
|
1343
1446
|
/**
|
1344
1447
|
* Lists discounts attached to a deal.
|
1345
1448
|
* @summary List discounts added to a deal
|
@@ -1572,7 +1675,7 @@ const DealsApiFp = function (configuration) {
|
|
1572
1675
|
* Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
|
1573
1676
|
* @summary Update a discount added to a deal
|
1574
1677
|
* @param {number} id The ID of the deal
|
1575
|
-
* @param {
|
1678
|
+
* @param {string} discount_id The ID of the discount
|
1576
1679
|
* @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
|
1577
1680
|
|
1578
1681
|
* @throws {RequiredError}
|
@@ -1667,6 +1770,16 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1667
1770
|
addDealProduct(requestParameters) {
|
1668
1771
|
return localVarFp.addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(axios, basePath));
|
1669
1772
|
},
|
1773
|
+
/**
|
1774
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
1775
|
+
* @summary Add multiple products to a deal
|
1776
|
+
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
1777
|
+
|
1778
|
+
* @throws {RequiredError}
|
1779
|
+
*/
|
1780
|
+
addManyDealProducts(requestParameters) {
|
1781
|
+
return localVarFp.addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(axios, basePath));
|
1782
|
+
},
|
1670
1783
|
/**
|
1671
1784
|
* 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.
|
1672
1785
|
* @summary Convert a deal to a lead (BETA)
|
@@ -1727,6 +1840,16 @@ const DealsApiFactory = function (configuration, basePath, axios) {
|
|
1727
1840
|
deleteInstallment(requestParameters) {
|
1728
1841
|
return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(axios, basePath));
|
1729
1842
|
},
|
1843
|
+
/**
|
1844
|
+
* 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.
|
1845
|
+
* @summary Delete many products from a deal
|
1846
|
+
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
1847
|
+
|
1848
|
+
* @throws {RequiredError}
|
1849
|
+
*/
|
1850
|
+
deleteManyDealProducts(requestParameters) {
|
1851
|
+
return localVarFp.deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(axios, basePath));
|
1852
|
+
},
|
1730
1853
|
/**
|
1731
1854
|
* Lists discounts attached to a deal.
|
1732
1855
|
* @summary List discounts added to a deal
|
@@ -1940,6 +2063,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
1940
2063
|
addDealProduct(requestParameters) {
|
1941
2064
|
return (0, exports.DealsApiFp)(this.configuration).addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(this.axios, this.basePath));
|
1942
2065
|
}
|
2066
|
+
/**
|
2067
|
+
* Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
|
2068
|
+
* @summary Add multiple products to a deal
|
2069
|
+
* @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
|
2070
|
+
|
2071
|
+
* @throws {RequiredError}
|
2072
|
+
* @memberof DealsApi
|
2073
|
+
*/
|
2074
|
+
addManyDealProducts(requestParameters) {
|
2075
|
+
return (0, exports.DealsApiFp)(this.configuration).addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(this.axios, this.basePath));
|
2076
|
+
}
|
1943
2077
|
/**
|
1944
2078
|
* 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.
|
1945
2079
|
* @summary Convert a deal to a lead (BETA)
|
@@ -2006,6 +2140,17 @@ class DealsApi extends base_1.BaseAPI {
|
|
2006
2140
|
deleteInstallment(requestParameters) {
|
2007
2141
|
return (0, exports.DealsApiFp)(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_id).then((request) => request(this.axios, this.basePath));
|
2008
2142
|
}
|
2143
|
+
/**
|
2144
|
+
* 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.
|
2145
|
+
* @summary Delete many products from a deal
|
2146
|
+
* @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
|
2147
|
+
|
2148
|
+
* @throws {RequiredError}
|
2149
|
+
* @memberof DealsApi
|
2150
|
+
*/
|
2151
|
+
deleteManyDealProducts(requestParameters) {
|
2152
|
+
return (0, exports.DealsApiFp)(this.configuration).deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
2153
|
+
}
|
2009
2154
|
/**
|
2010
2155
|
* Lists discounts attached to a deal.
|
2011
2156
|
* @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}
|
@@ -43,7 +43,7 @@ const ItemSearchApiAxiosParamCreator = function (configuration) {
|
|
43
43
|
* @summary Perform a search from multiple item types
|
44
44
|
* @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.
|
45
45
|
* @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.
|
46
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
46
|
+
* @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>.
|
47
47
|
* @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
|
48
48
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
49
49
|
* @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.
|
@@ -177,7 +177,7 @@ const ItemSearchApiFp = function (configuration) {
|
|
177
177
|
* @summary Perform a search from multiple item types
|
178
178
|
* @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.
|
179
179
|
* @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.
|
180
|
-
* @param {'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | '
|
180
|
+
* @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>.
|
181
181
|
* @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
|
182
182
|
* @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
|
183
183
|
* @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,15 @@
|
|
1
|
+
"use strict";
|
2
|
+
/* tslint:disable */
|
3
|
+
/* eslint-disable */
|
4
|
+
/**
|
5
|
+
* Pipedrive API v2
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
7
|
+
*
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
9
|
+
*
|
10
|
+
*
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
12
|
+
* https://openapi-generator.tech
|
13
|
+
* Do not edit the class manually.
|
14
|
+
*/
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
@@ -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,15 @@
|
|
1
|
+
"use strict";
|
2
|
+
/* tslint:disable */
|
3
|
+
/* eslint-disable */
|
4
|
+
/**
|
5
|
+
* Pipedrive API v2
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
7
|
+
*
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
9
|
+
*
|
10
|
+
*
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
12
|
+
* https://openapi-generator.tech
|
13
|
+
* Do not edit the class manually.
|
14
|
+
*/
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
@@ -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,15 @@
|
|
1
|
+
"use strict";
|
2
|
+
/* tslint:disable */
|
3
|
+
/* eslint-disable */
|
4
|
+
/**
|
5
|
+
* Pipedrive API v2
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
7
|
+
*
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
9
|
+
*
|
10
|
+
*
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
12
|
+
* https://openapi-generator.tech
|
13
|
+
* Do not edit the class manually.
|
14
|
+
*/
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
@@ -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,15 @@
|
|
1
|
+
"use strict";
|
2
|
+
/* tslint:disable */
|
3
|
+
/* eslint-disable */
|
4
|
+
/**
|
5
|
+
* Pipedrive API v2
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
7
|
+
*
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
9
|
+
*
|
10
|
+
*
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
12
|
+
* https://openapi-generator.tech
|
13
|
+
* Do not edit the class manually.
|
14
|
+
*/
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
@@ -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,15 @@
|
|
1
|
+
"use strict";
|
2
|
+
/* tslint:disable */
|
3
|
+
/* eslint-disable */
|
4
|
+
/**
|
5
|
+
* Pipedrive API v2
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
7
|
+
*
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
9
|
+
*
|
10
|
+
*
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
12
|
+
* https://openapi-generator.tech
|
13
|
+
* Do not edit the class manually.
|
14
|
+
*/
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
@@ -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';
|