pipedrive 36.0.1 → 36.1.0

package/dist/versions/v2/api/item-search-api.d.ts

@@ -11,7 +11,7 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
+import { RequestArgs, BaseAPI, ApiResponse } from '../base';
 import { GetItemSearchFieldResponse } from '../models';
 import { GetItemSearchResponse } from '../models';
 /**
@@ -68,6 +68,21 @@ export declare const ItemSearchApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     searchItem(term: string, item_types?: Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>, fields?: Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>, search_for_related_items?: boolean, exact_match?: boolean, include_fields?: Set<'deal.cc_email' | 'person.picture' | 'product.price'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchResponse>>;
+    /**
+     * Same as `searchItem`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Perform a search from multiple item types
+     * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
+     * @param {Set<'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.
+     * @param {Set<'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:&lt;br&gt; &lt;table&gt; &lt;tr&gt;&lt;th&gt;&lt;b&gt;Item type&lt;/b&gt;&lt;/th&gt;&lt;th&gt;&lt;b&gt;Field&lt;/b&gt;&lt;/th&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Deal&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Person&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;email&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;, &#x60;phone&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Organization&lt;/td&gt;&lt;td&gt;&#x60;address&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Product&lt;/td&gt;&lt;td&gt;&#x60;code&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Lead&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;File&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Mail attachment&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Project&lt;/td&gt;&lt;td&gt; &#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;, &#x60;description&#x60; &lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;br&gt; Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
+     * @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
+     * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
+     * @param {Set<'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.
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+     * @throws {RequiredError}
+     */
+    searchItemWithHttpInfo(term: string, item_types?: Set<'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project'>, fields?: Set<'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'phone' | 'title' | 'description'>, search_for_related_items?: boolean, exact_match?: boolean, include_fields?: Set<'deal.cc_email' | 'person.picture' | 'product.price'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetItemSearchResponse>>>;
     /**
      * 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).
      * @summary Perform a search using a specific field from an item type
@@ -81,6 +96,19 @@ export declare const ItemSearchApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     searchItemByField(term: string, entity_type: 'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project', field: string, match?: 'exact' | 'beginning' | 'middle', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetItemSearchFieldResponse>>;
+    /**
+     * Same as `searchItemByField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Perform a search using a specific field from an item type
+     * @param {string} term The search term to look for. Minimum 2 characters (or 1 if &#x60;match&#x60; is &#x60;exact&#x60;). Please note that the search term has to be URL encoded.
+     * @param {'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project'} entity_type The type of the field to perform the search from
+     * @param {string} field The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields\&#39; API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
+     * @param {'exact' | 'beginning' | 'middle'} [match] The type of match used against the term. The search &lt;b&gt;is&lt;/b&gt; case sensitive.&lt;br/&gt;&lt;br/&gt; E.g. in case of searching for a value &#x60;monkey&#x60;, &lt;ul&gt; &lt;li&gt;with &#x60;exact&#x60; match, you will only find it if term is &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;beginning&#x60; match, you will only find it if the term matches the beginning or the whole string, e.g. &#x60;monk&#x60; and &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;middle&#x60; match, you will find the it if the term matches any substring of the value, e.g. &#x60;onk&#x60; and &#x60;ke&#x60;&lt;/li&gt; &lt;/ul&gt;.
+     * @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.
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+     * @throws {RequiredError}
+     */
+    searchItemByFieldWithHttpInfo(term: string, entity_type: 'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project', field: string, match?: 'exact' | 'beginning' | 'middle', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetItemSearchFieldResponse>>>;
 };
 /**
  * ItemSearchApi - factory interface
@@ -95,6 +123,7 @@ export declare const ItemSearchApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     searchItem(requestParameters: ItemSearchApiSearchItemRequest): Promise<GetItemSearchResponse>;
+    searchItemWithHttpInfo(requestParameters: ItemSearchApiSearchItemRequest): Promise<ApiResponse<GetItemSearchResponse>>;
     /**
      * 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).
      * @summary Perform a search using a specific field from an item type
@@ -103,6 +132,7 @@ export declare const ItemSearchApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     searchItemByField(requestParameters: ItemSearchApiSearchItemByFieldRequest): Promise<GetItemSearchFieldResponse>;
+    searchItemByFieldWithHttpInfo(requestParameters: ItemSearchApiSearchItemByFieldRequest): Promise<ApiResponse<GetItemSearchFieldResponse>>;
 };
 /**
  * Request parameters for searchItem operation in ItemSearchApi.
@@ -218,6 +248,15 @@ export declare class ItemSearchApi extends BaseAPI {
      * @memberof ItemSearchApi
      */
     searchItem(requestParameters: ItemSearchApiSearchItemRequest): Promise<GetItemSearchResponse>;
+    /**
+     * Same as `searchItem`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ItemSearchApi
+     */
+    searchItemWithHttpInfo(requestParameters: ItemSearchApiSearchItemRequest): Promise<ApiResponse<GetItemSearchResponse>>;
     /**
      * 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).
      * @summary Perform a search using a specific field from an item type
@@ -227,4 +266,13 @@ export declare class ItemSearchApi extends BaseAPI {
      * @memberof ItemSearchApi
      */
     searchItemByField(requestParameters: ItemSearchApiSearchItemByFieldRequest): Promise<GetItemSearchFieldResponse>;
+    /**
+     * Same as `searchItemByField`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ItemSearchApi
+     */
+    searchItemByFieldWithHttpInfo(requestParameters: ItemSearchApiSearchItemByFieldRequest): Promise<ApiResponse<GetItemSearchFieldResponse>>;
 }

package/dist/versions/v2/api/item-search-api.js

@@ -192,6 +192,26 @@ const ItemSearchApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `searchItem`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Perform a search from multiple item types
+         * @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.
+         * @param {Set<'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.
+         * @param {Set<'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:&lt;br&gt; &lt;table&gt; &lt;tr&gt;&lt;th&gt;&lt;b&gt;Item type&lt;/b&gt;&lt;/th&gt;&lt;th&gt;&lt;b&gt;Field&lt;/b&gt;&lt;/th&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Deal&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Person&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;email&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;, &#x60;phone&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Organization&lt;/td&gt;&lt;td&gt;&#x60;address&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;, &#x60;notes&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Product&lt;/td&gt;&lt;td&gt;&#x60;code&#x60;, &#x60;custom_fields&#x60;, &#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Lead&lt;/td&gt;&lt;td&gt;&#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;File&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Mail attachment&lt;/td&gt;&lt;td&gt;&#x60;name&#x60;&lt;/td&gt;&lt;/tr&gt; &lt;tr&gt;&lt;td&gt;Project&lt;/td&gt;&lt;td&gt; &#x60;custom_fields&#x60;, &#x60;notes&#x60;, &#x60;title&#x60;, &#x60;description&#x60; &lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;br&gt; Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
+         * @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
+         * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
+         * @param {Set<'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.
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        searchItemWithHttpInfo(term, item_types, fields, search_for_related_items, exact_match, include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.searchItem(term, item_types, fields, search_for_related_items, exact_match, include_fields, limit, cursor);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
         /**
          * 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).
          * @summary Perform a search using a specific field from an item type
@@ -210,6 +230,24 @@ const ItemSearchApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `searchItemByField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Perform a search using a specific field from an item type
+         * @param {string} term The search term to look for. Minimum 2 characters (or 1 if &#x60;match&#x60; is &#x60;exact&#x60;). Please note that the search term has to be URL encoded.
+         * @param {'deal' | 'lead' | 'person' | 'organization' | 'product' | 'project'} entity_type The type of the field to perform the search from
+         * @param {string} field The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields\&#39; API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: &#x60;address&#x60;, &#x60;varchar&#x60;, &#x60;text&#x60;, &#x60;varchar_auto&#x60;, &#x60;double&#x60;, &#x60;monetary&#x60; and &#x60;phone&#x60;. Read more about searching by custom fields &lt;a href&#x3D;\&quot;https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\&quot; target&#x3D;\&quot;_blank\&quot; rel&#x3D;\&quot;noopener noreferrer\&quot;&gt;here&lt;/a&gt;.
+         * @param {'exact' | 'beginning' | 'middle'} [match] The type of match used against the term. The search &lt;b&gt;is&lt;/b&gt; case sensitive.&lt;br/&gt;&lt;br/&gt; E.g. in case of searching for a value &#x60;monkey&#x60;, &lt;ul&gt; &lt;li&gt;with &#x60;exact&#x60; match, you will only find it if term is &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;beginning&#x60; match, you will only find it if the term matches the beginning or the whole string, e.g. &#x60;monk&#x60; and &#x60;monkey&#x60;&lt;/li&gt; &lt;li&gt;with &#x60;middle&#x60; match, you will find the it if the term matches any substring of the value, e.g. &#x60;onk&#x60; and &#x60;ke&#x60;&lt;/li&gt; &lt;/ul&gt;.
+         * @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.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        searchItemByFieldWithHttpInfo(term, entity_type, field, match, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.searchItemByField(term, entity_type, field, match, limit, cursor);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 exports.ItemSearchApiFp = ItemSearchApiFp;
@@ -230,6 +268,9 @@ const ItemSearchApiFactory = function (configuration, basePath, axios) {
         searchItem(requestParameters) {
             return localVarFp.searchItem(requestParameters.term, requestParameters.item_types, requestParameters.fields, requestParameters.search_for_related_items, requestParameters.exact_match, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
+        searchItemWithHttpInfo(requestParameters) {
+            return localVarFp.searchItemWithHttpInfo(requestParameters.term, requestParameters.item_types, requestParameters.fields, requestParameters.search_for_related_items, requestParameters.exact_match, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * 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).
          * @summary Perform a search using a specific field from an item type
@@ -240,6 +281,9 @@ const ItemSearchApiFactory = function (configuration, basePath, axios) {
         searchItemByField(requestParameters) {
             return localVarFp.searchItemByField(requestParameters.term, requestParameters.entity_type, requestParameters.field, requestParameters.match, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
+        searchItemByFieldWithHttpInfo(requestParameters) {
+            return localVarFp.searchItemByFieldWithHttpInfo(requestParameters.term, requestParameters.entity_type, requestParameters.field, requestParameters.match, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.ItemSearchApiFactory = ItemSearchApiFactory;
@@ -261,6 +305,17 @@ class ItemSearchApi extends base_1.BaseAPI {
     searchItem(requestParameters) {
         return (0, exports.ItemSearchApiFp)(this.configuration).searchItem(requestParameters.term, requestParameters.item_types, requestParameters.fields, requestParameters.search_for_related_items, requestParameters.exact_match, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `searchItem`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ItemSearchApi
+     */
+    searchItemWithHttpInfo(requestParameters) {
+        return (0, exports.ItemSearchApiFp)(this.configuration).searchItemWithHttpInfo(requestParameters.term, requestParameters.item_types, requestParameters.fields, requestParameters.search_for_related_items, requestParameters.exact_match, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * 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).
      * @summary Perform a search using a specific field from an item type
@@ -272,5 +327,16 @@ class ItemSearchApi extends base_1.BaseAPI {
     searchItemByField(requestParameters) {
         return (0, exports.ItemSearchApiFp)(this.configuration).searchItemByField(requestParameters.term, requestParameters.entity_type, requestParameters.field, requestParameters.match, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `searchItemByField`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ItemSearchApi
+     */
+    searchItemByFieldWithHttpInfo(requestParameters) {
+        return (0, exports.ItemSearchApiFp)(this.configuration).searchItemByFieldWithHttpInfo(requestParameters.term, requestParameters.entity_type, requestParameters.field, requestParameters.match, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.ItemSearchApi = ItemSearchApi;

package/dist/versions/v2/api/leads-api.d.ts

@@ -11,7 +11,7 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
+import { RequestArgs, BaseAPI, ApiResponse } from '../base';
 import { AddConvertLeadToDealResponse } from '../models';
 import { ConvertLeadToDealRequest } from '../models';
 import { GetConvertResponse1 } from '../models';
@@ -69,6 +69,15 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     convertLeadToDeal(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddConvertLeadToDealResponse>>;
+    /**
+     * Same as `convertLeadToDeal`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Convert a lead to a deal
+     * @param {string} id The ID of the lead to convert
+     * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
+
+     * @throws {RequiredError}
+     */
+    convertLeadToDealWithHttpInfo(id: string, ConvertLeadToDealRequest?: ConvertLeadToDealRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddConvertLeadToDealResponse>>>;
     /**
      * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Lead conversion status
@@ -78,6 +87,15 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getLeadConversionStatus(id: string, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetConvertResponse1>>;
+    /**
+     * Same as `getLeadConversionStatus`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get Lead conversion status
+     * @param {string} id The ID of a lead
+     * @param {string} conversion_id The ID of the conversion
+
+     * @throws {RequiredError}
+     */
+    getLeadConversionStatusWithHttpInfo(id: string, conversion_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetConvertResponse1>>>;
     /**
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -93,6 +111,21 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     searchLeads(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetLeadSearchResponse>>;
+    /**
+     * Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Search leads
+     * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
+     * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
+     * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
+     * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
+     * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
+     * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
+     * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
+     * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+     * @throws {RequiredError}
+     */
+    searchLeadsWithHttpInfo(term: string, fields?: Set<'custom_fields' | 'notes' | 'title'>, exact_match?: boolean, person_id?: number, organization_id?: number, include_fields?: Set<'lead.was_seen'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetLeadSearchResponse>>>;
 };
 /**
  * LeadsApi - factory interface
@@ -107,6 +140,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
+    convertLeadToDealWithHttpInfo(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<ApiResponse<AddConvertLeadToDealResponse>>;
     /**
      * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Lead conversion status
@@ -115,6 +149,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getLeadConversionStatus(requestParameters: LeadsApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
+    getLeadConversionStatusWithHttpInfo(requestParameters: LeadsApiGetLeadConversionStatusRequest): Promise<ApiResponse<GetConvertResponse1>>;
     /**
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -123,6 +158,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     searchLeads(requestParameters: LeadsApiSearchLeadsRequest): Promise<GetLeadSearchResponse>;
+    searchLeadsWithHttpInfo(requestParameters: LeadsApiSearchLeadsRequest): Promise<ApiResponse<GetLeadSearchResponse>>;
 };
 /**
  * Request parameters for convertLeadToDeal operation in LeadsApi.
@@ -233,6 +269,15 @@ export declare class LeadsApi extends BaseAPI {
      * @memberof LeadsApi
      */
     convertLeadToDeal(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<AddConvertLeadToDealResponse>;
+    /**
+     * Same as `convertLeadToDeal`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    convertLeadToDealWithHttpInfo(requestParameters: LeadsApiConvertLeadToDealRequest): Promise<ApiResponse<AddConvertLeadToDealResponse>>;
     /**
      * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Lead conversion status
@@ -242,6 +287,15 @@ export declare class LeadsApi extends BaseAPI {
      * @memberof LeadsApi
      */
     getLeadConversionStatus(requestParameters: LeadsApiGetLeadConversionStatusRequest): Promise<GetConvertResponse1>;
+    /**
+     * Same as `getLeadConversionStatus`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    getLeadConversionStatusWithHttpInfo(requestParameters: LeadsApiGetLeadConversionStatusRequest): Promise<ApiResponse<GetConvertResponse1>>;
     /**
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -251,4 +305,13 @@ export declare class LeadsApi extends BaseAPI {
      * @memberof LeadsApi
      */
     searchLeads(requestParameters: LeadsApiSearchLeadsRequest): Promise<GetLeadSearchResponse>;
+    /**
+     * Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {LeadsApiSearchLeadsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    searchLeadsWithHttpInfo(requestParameters: LeadsApiSearchLeadsRequest): Promise<ApiResponse<GetLeadSearchResponse>>;
 }

package/dist/versions/v2/api/leads-api.js

@@ -201,6 +201,20 @@ const LeadsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `convertLeadToDeal`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Convert a lead to a deal
+         * @param {string} id The ID of the lead to convert
+         * @param {ConvertLeadToDealRequest} [ConvertLeadToDealRequest]
+
+         * @throws {RequiredError}
+         */
+        convertLeadToDealWithHttpInfo(id, ConvertLeadToDealRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.convertLeadToDeal(id, ConvertLeadToDealRequest);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
          * @summary Get Lead conversion status
@@ -215,6 +229,20 @@ const LeadsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getLeadConversionStatus`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get Lead conversion status
+         * @param {string} id The ID of a lead
+         * @param {string} conversion_id The ID of the conversion
+
+         * @throws {RequiredError}
+         */
+        getLeadConversionStatusWithHttpInfo(id, conversion_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadConversionStatus(id, conversion_id);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
          * @summary Search leads
@@ -235,6 +263,26 @@ const LeadsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Search leads
+         * @param {string} term The search term to look for. Minimum 2 characters (or 1 if using &#x60;exact_match&#x60;). Please note that the search term has to be URL encoded.
+         * @param {Set<'custom_fields' | 'notes' | 'title'>} [fields] A comma-separated string array. The fields to perform the search from. Defaults to all of them.
+         * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is &lt;b&gt;not&lt;/b&gt; case sensitive.
+         * @param {number} [person_id] Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
+         * @param {number} [organization_id] Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
+         * @param {Set<'lead.was_seen'>} [include_fields] Supports including optional fields in the results which are not provided by default
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        searchLeadsWithHttpInfo(term, fields, exact_match, person_id, organization_id, include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.searchLeads(term, fields, exact_match, person_id, organization_id, include_fields, limit, cursor);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 exports.LeadsApiFp = LeadsApiFp;
@@ -255,6 +303,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
         convertLeadToDeal(requestParameters) {
             return localVarFp.convertLeadToDeal(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(axios, basePath));
         },
+        convertLeadToDealWithHttpInfo(requestParameters) {
+            return localVarFp.convertLeadToDealWithHttpInfo(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
          * @summary Get Lead conversion status
@@ -265,6 +316,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
         getLeadConversionStatus(requestParameters) {
             return localVarFp.getLeadConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(axios, basePath));
         },
+        getLeadConversionStatusWithHttpInfo(requestParameters) {
+            return localVarFp.getLeadConversionStatusWithHttpInfo(requestParameters.id, requestParameters.conversion_id).then((request) => request(axios, basePath));
+        },
         /**
          * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
          * @summary Search leads
@@ -275,6 +329,9 @@ const LeadsApiFactory = function (configuration, basePath, axios) {
         searchLeads(requestParameters) {
             return localVarFp.searchLeads(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
+        searchLeadsWithHttpInfo(requestParameters) {
+            return localVarFp.searchLeadsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.LeadsApiFactory = LeadsApiFactory;
@@ -296,6 +353,17 @@ class LeadsApi extends base_1.BaseAPI {
     convertLeadToDeal(requestParameters) {
         return (0, exports.LeadsApiFp)(this.configuration).convertLeadToDeal(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `convertLeadToDeal`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {LeadsApiConvertLeadToDealRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    convertLeadToDealWithHttpInfo(requestParameters) {
+        return (0, exports.LeadsApiFp)(this.configuration).convertLeadToDealWithHttpInfo(requestParameters.id, requestParameters.ConvertLeadToDealRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.
      * @summary Get Lead conversion status
@@ -307,6 +375,17 @@ class LeadsApi extends base_1.BaseAPI {
     getLeadConversionStatus(requestParameters) {
         return (0, exports.LeadsApiFp)(this.configuration).getLeadConversionStatus(requestParameters.id, requestParameters.conversion_id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getLeadConversionStatus`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {LeadsApiGetLeadConversionStatusRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    getLeadConversionStatusWithHttpInfo(requestParameters) {
+        return (0, exports.LeadsApiFp)(this.configuration).getLeadConversionStatusWithHttpInfo(requestParameters.id, requestParameters.conversion_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Searches all leads by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found leads can be filtered by the person ID and the organization ID.
      * @summary Search leads
@@ -318,5 +397,16 @@ class LeadsApi extends base_1.BaseAPI {
     searchLeads(requestParameters) {
         return (0, exports.LeadsApiFp)(this.configuration).searchLeads(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `searchLeads`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {LeadsApiSearchLeadsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    searchLeadsWithHttpInfo(requestParameters) {
+        return (0, exports.LeadsApiFp)(this.configuration).searchLeadsWithHttpInfo(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.person_id, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.LeadsApi = LeadsApi;