pipedrive 31.2.1 → 32.2.0

package/dist/versions/v1/api/filters-api.d.ts

@@ -27,11 +27,12 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
     /**
      * Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
      * @summary Add a new filter
+     * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
      * @param {AddFilterRequest} [AddFilterRequest]
 
      * @throws {RequiredError}
      */
-    addFilter: (AddFilterRequest?: AddFilterRequest) => Promise<RequestArgs>;
+    addFilter: (include_field_code?: boolean, AddFilterRequest?: AddFilterRequest) => Promise<RequestArgs>;
     /**
      * Marks a filter as deleted.
      * @summary Delete a filter
@@ -52,10 +53,11 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
      * Returns data about a specific filter. Note that this also returns the condition lines of the filter.
      * @summary Get one filter
      * @param {number} id The ID of the filter
+     * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
 
      * @throws {RequiredError}
      */
-    getFilter: (id: number) => Promise<RequestArgs>;
+    getFilter: (id: number, include_field_code?: boolean) => Promise<RequestArgs>;
     /**
      * Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
      * @summary Get all filter helpers
@@ -75,11 +77,12 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
      * Updates an existing filter.
      * @summary Update filter
      * @param {number} id The ID of the filter
+     * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
      * @param {UpdateFilterRequest} [UpdateFilterRequest]
 
      * @throws {RequiredError}
      */
-    updateFilter: (id: number, UpdateFilterRequest?: UpdateFilterRequest) => Promise<RequestArgs>;
+    updateFilter: (id: number, include_field_code?: boolean, UpdateFilterRequest?: UpdateFilterRequest) => Promise<RequestArgs>;
 };
 /**
  * FiltersApi - functional programming interface
@@ -89,11 +92,12 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
     /**
      * Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
      * @summary Add a new filter
+     * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
      * @param {AddFilterRequest} [AddFilterRequest]
 
      * @throws {RequiredError}
      */
-    addFilter(AddFilterRequest?: AddFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
+    addFilter(include_field_code?: boolean, AddFilterRequest?: AddFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
     /**
      * Marks a filter as deleted.
      * @summary Delete a filter
@@ -114,10 +118,11 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
      * Returns data about a specific filter. Note that this also returns the condition lines of the filter.
      * @summary Get one filter
      * @param {number} id The ID of the filter
+     * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
 
      * @throws {RequiredError}
      */
-    getFilter(id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFiltersResponse1>>;
+    getFilter(id: number, include_field_code?: boolean): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFiltersResponse1>>;
     /**
      * Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
      * @summary Get all filter helpers
@@ -137,11 +142,12 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
      * Updates an existing filter.
      * @summary Update filter
      * @param {number} id The ID of the filter
+     * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
      * @param {UpdateFilterRequest} [UpdateFilterRequest]
 
      * @throws {RequiredError}
      */
-    updateFilter(id: number, UpdateFilterRequest?: UpdateFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
+    updateFilter(id: number, include_field_code?: boolean, UpdateFilterRequest?: UpdateFilterRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddFiltersResponse>>;
 };
 /**
  * FiltersApi - factory interface
@@ -210,6 +216,12 @@ export declare const FiltersApiFactory: (configuration?: Configuration, basePath
  * @interface FiltersApiAddFilterRequest
  */
 export interface FiltersApiAddFilterRequest {
+    /**
+     * If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
+     * @type {boolean}
+     * @memberof FiltersApiAddFilter
+     */
+    readonly include_field_code?: boolean;
     /**
      *
      * @type {AddFilterRequest}
@@ -255,6 +267,12 @@ export interface FiltersApiGetFilterRequest {
      * @memberof FiltersApiGetFilter
      */
     readonly id: number;
+    /**
+     * If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
+     * @type {boolean}
+     * @memberof FiltersApiGetFilter
+     */
+    readonly include_field_code?: boolean;
 }
 /**
  * Request parameters for getFilters operation in FiltersApi.
@@ -281,6 +299,12 @@ export interface FiltersApiUpdateFilterRequest {
      * @memberof FiltersApiUpdateFilter
      */
     readonly id: number;
+    /**
+     * If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
+     * @type {boolean}
+     * @memberof FiltersApiUpdateFilter
+     */
+    readonly include_field_code?: boolean;
     /**
      *
      * @type {UpdateFilterRequest}

package/dist/versions/v1/api/filters-api.js

@@ -41,11 +41,12 @@ const FiltersApiAxiosParamCreator = function (configuration) {
         /**
          * Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
          * @summary Add a new filter
+         * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
          * @param {AddFilterRequest} [AddFilterRequest]
 
          * @throws {RequiredError}
          */
-        addFilter: (AddFilterRequest) => __awaiter(this, void 0, void 0, function* () {
+        addFilter: (include_field_code, AddFilterRequest) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/filters`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -61,6 +62,9 @@ const FiltersApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:full", "activities:full", "contacts:full"], configuration);
+            if (include_field_code !== undefined) {
+                localVarQueryParameter['include_field_code'] = include_field_code;
+            }
             localVarHeaderParameter['Content-Type'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -145,10 +149,11 @@ const FiltersApiAxiosParamCreator = function (configuration) {
          * Returns data about a specific filter. Note that this also returns the condition lines of the filter.
          * @summary Get one filter
          * @param {number} id The ID of the filter
+         * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
 
          * @throws {RequiredError}
          */
-        getFilter: (id) => __awaiter(this, void 0, void 0, function* () {
+        getFilter: (id, include_field_code) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'id' is not null or undefined
             (0, common_1.assertParamExists)('getFilter', 'id', id);
             const localVarPath = `/filters/{id}`
@@ -167,6 +172,9 @@ const FiltersApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:read", "deals:full", "activities:read", "activities:full", "contacts:read", "contacts:full"], configuration);
+            if (include_field_code !== undefined) {
+                localVarQueryParameter['include_field_code'] = include_field_code;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
@@ -243,11 +251,12 @@ const FiltersApiAxiosParamCreator = function (configuration) {
          * Updates an existing filter.
          * @summary Update filter
          * @param {number} id The ID of the filter
+         * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
          * @param {UpdateFilterRequest} [UpdateFilterRequest]
 
          * @throws {RequiredError}
          */
-        updateFilter: (id, UpdateFilterRequest) => __awaiter(this, void 0, void 0, function* () {
+        updateFilter: (id, include_field_code, UpdateFilterRequest) => __awaiter(this, void 0, void 0, function* () {
             // verify required parameter 'id' is not null or undefined
             (0, common_1.assertParamExists)('updateFilter', 'id', id);
             const localVarPath = `/filters/{id}`
@@ -266,6 +275,9 @@ const FiltersApiAxiosParamCreator = function (configuration) {
             // authentication oauth2 required
             // oauth required
             yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2", ["deals:full", "activities:full", "contacts:full"], configuration);
+            if (include_field_code !== undefined) {
+                localVarQueryParameter['include_field_code'] = include_field_code;
+            }
             localVarHeaderParameter['Content-Type'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -289,13 +301,14 @@ const FiltersApiFp = function (configuration) {
         /**
          * Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with \'AND\', and only two second level condition groups are supported of which one must be glued with \'AND\' and the second with \'OR\'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
          * @summary Add a new filter
+         * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
          * @param {AddFilterRequest} [AddFilterRequest]
 
          * @throws {RequiredError}
          */
-        addFilter(AddFilterRequest) {
+        addFilter(include_field_code, AddFilterRequest) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.addFilter(AddFilterRequest);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addFilter(include_field_code, AddFilterRequest);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -329,12 +342,13 @@ const FiltersApiFp = function (configuration) {
          * Returns data about a specific filter. Note that this also returns the condition lines of the filter.
          * @summary Get one filter
          * @param {number} id The ID of the filter
+         * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
 
          * @throws {RequiredError}
          */
-        getFilter(id) {
+        getFilter(id, include_field_code) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getFilter(id);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getFilter(id, include_field_code);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -367,13 +381,14 @@ const FiltersApiFp = function (configuration) {
          * Updates an existing filter.
          * @summary Update filter
          * @param {number} id The ID of the filter
+         * @param {boolean} [include_field_code] If set to &#x60;true&#x60;, each condition in the response includes a &#x60;field_code&#x60; field identifying the field by its code name
          * @param {UpdateFilterRequest} [UpdateFilterRequest]
 
          * @throws {RequiredError}
          */
-        updateFilter(id, UpdateFilterRequest) {
+        updateFilter(id, include_field_code, UpdateFilterRequest) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFilter(id, UpdateFilterRequest);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFilter(id, include_field_code, UpdateFilterRequest);
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
@@ -395,7 +410,7 @@ const FiltersApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         addFilter(requestParameters = {}) {
-            return localVarFp.addFilter(requestParameters.AddFilterRequest).then((request) => request(axios, basePath));
+            return localVarFp.addFilter(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(axios, basePath));
         },
         /**
          * Marks a filter as deleted.
@@ -425,7 +440,7 @@ const FiltersApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getFilter(requestParameters) {
-            return localVarFp.getFilter(requestParameters.id).then((request) => request(axios, basePath));
+            return localVarFp.getFilter(requestParameters.id, requestParameters.include_field_code).then((request) => request(axios, basePath));
         },
         /**
          * Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
@@ -454,7 +469,7 @@ const FiltersApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         updateFilter(requestParameters) {
-            return localVarFp.updateFilter(requestParameters.id, requestParameters.UpdateFilterRequest).then((request) => request(axios, basePath));
+            return localVarFp.updateFilter(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(axios, basePath));
         },
     };
 };
@@ -475,7 +490,7 @@ class FiltersApi extends base_1.BaseAPI {
      * @memberof FiltersApi
      */
     addFilter(requestParameters = {}) {
-        return (0, exports.FiltersApiFp)(this.configuration).addFilter(requestParameters.AddFilterRequest).then((request) => request(this.axios, this.basePath));
+        return (0, exports.FiltersApiFp)(this.configuration).addFilter(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Marks a filter as deleted.
@@ -508,7 +523,7 @@ class FiltersApi extends base_1.BaseAPI {
      * @memberof FiltersApi
      */
     getFilter(requestParameters) {
-        return (0, exports.FiltersApiFp)(this.configuration).getFilter(requestParameters.id).then((request) => request(this.axios, this.basePath));
+        return (0, exports.FiltersApiFp)(this.configuration).getFilter(requestParameters.id, requestParameters.include_field_code).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
@@ -540,7 +555,7 @@ class FiltersApi extends base_1.BaseAPI {
      * @memberof FiltersApi
      */
     updateFilter(requestParameters) {
-        return (0, exports.FiltersApiFp)(this.configuration).updateFilter(requestParameters.id, requestParameters.UpdateFilterRequest).then((request) => request(this.axios, this.basePath));
+        return (0, exports.FiltersApiFp)(this.configuration).updateFilter(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.FiltersApi = FiltersApi;