pipedrive 36.0.0 → 36.1.0

package/dist/esm/versions/v2/api/product-fields-api.js

@@ -359,6 +359,19 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addProductField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Create one product field
+         * @param {AddProductFieldRequest} AddProductFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addProductFieldWithHttpInfo(AddProductFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addProductField(AddProductFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
          * @summary Add product field options in bulk
@@ -373,6 +386,20 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addProductFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add product field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addProductFieldOptionsWithHttpInfo(field_code, AddDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addProductFieldOptions(field_code, AddDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one product field
@@ -386,6 +413,19 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteProductField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete one product field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deleteProductFieldWithHttpInfo(field_code) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteProductField(field_code);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
          * @summary Delete product field options in bulk
@@ -400,6 +440,20 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteProductFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete product field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deleteProductFieldOptionsWithHttpInfo(field_code, DeleteDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteProductFieldOptions(field_code, DeleteDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about a specific product field.
          * @summary Get one product field
@@ -414,6 +468,20 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getProductField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get one product field
+         * @param {string} field_code The unique code identifying the field
+         * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+         * @throws {RequiredError}
+         */
+        getProductFieldWithHttpInfo(field_code, include_fields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductField(field_code, include_fields);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about all product fields in the company.
          * @summary Get all product fields
@@ -429,6 +497,21 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getProductFields`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all product fields
+         * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @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}
+         */
+        getProductFieldsWithHttpInfo(include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductFields(include_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
          * @summary Update one product field
@@ -443,6 +526,20 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateProductField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update one product field
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdateProductFieldRequest} UpdateProductFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updateProductFieldWithHttpInfo(field_code, UpdateProductFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProductField(field_code, UpdateProductFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
          * @summary Update product field options in bulk
@@ -457,6 +554,20 @@ export const ProductFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateProductFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update product field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updateProductFieldOptionsWithHttpInfo(field_code, UpdateDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateProductFieldOptions(field_code, UpdateDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 /**
@@ -476,6 +587,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         addProductField(requestParameters) {
             return localVarFp.addProductField(requestParameters.AddProductFieldRequest).then((request) => request(axios, basePath));
         },
+        addProductFieldWithHttpInfo(requestParameters) {
+            return localVarFp.addProductFieldWithHttpInfo(requestParameters.AddProductFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
          * @summary Add product field options in bulk
@@ -486,6 +600,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         addProductFieldOptions(requestParameters) {
             return localVarFp.addProductFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        addProductFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.addProductFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one product field
@@ -496,6 +613,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         deleteProductField(requestParameters) {
             return localVarFp.deleteProductField(requestParameters.field_code).then((request) => request(axios, basePath));
         },
+        deleteProductFieldWithHttpInfo(requestParameters) {
+            return localVarFp.deleteProductFieldWithHttpInfo(requestParameters.field_code).then((request) => request(axios, basePath));
+        },
         /**
          * Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
          * @summary Delete product field options in bulk
@@ -506,6 +626,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         deleteProductFieldOptions(requestParameters) {
             return localVarFp.deleteProductFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        deleteProductFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.deleteProductFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about a specific product field.
          * @summary Get one product field
@@ -516,6 +639,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         getProductField(requestParameters) {
             return localVarFp.getProductField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
         },
+        getProductFieldWithHttpInfo(requestParameters) {
+            return localVarFp.getProductFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about all product fields in the company.
          * @summary Get all product fields
@@ -526,6 +652,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         getProductFields(requestParameters = {}) {
             return localVarFp.getProductFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
+        getProductFieldsWithHttpInfo(requestParameters = {}) {
+            return localVarFp.getProductFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
          * @summary Update one product field
@@ -536,6 +665,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         updateProductField(requestParameters) {
             return localVarFp.updateProductField(requestParameters.field_code, requestParameters.UpdateProductFieldRequest).then((request) => request(axios, basePath));
         },
+        updateProductFieldWithHttpInfo(requestParameters) {
+            return localVarFp.updateProductFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdateProductFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
          * @summary Update product field options in bulk
@@ -546,6 +678,9 @@ export const ProductFieldsApiFactory = function (configuration, basePath, axios)
         updateProductFieldOptions(requestParameters) {
             return localVarFp.updateProductFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        updateProductFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.updateProductFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -566,6 +701,17 @@ export class ProductFieldsApi extends BaseAPI {
     addProductField(requestParameters) {
         return ProductFieldsApiFp(this.configuration).addProductField(requestParameters.AddProductFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addProductField`, 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 {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    addProductFieldWithHttpInfo(requestParameters) {
+        return ProductFieldsApiFp(this.configuration).addProductFieldWithHttpInfo(requestParameters.AddProductFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds new options to a product custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
      * @summary Add product field options in bulk
@@ -577,6 +723,17 @@ export class ProductFieldsApi extends BaseAPI {
     addProductFieldOptions(requestParameters) {
         return ProductFieldsApiFp(this.configuration).addProductFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addProductFieldOptions`, 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 {ProductFieldsApiAddProductFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    addProductFieldOptionsWithHttpInfo(requestParameters) {
+        return ProductFieldsApiFp(this.configuration).addProductFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Marks a custom field as deleted.
      * @summary Delete one product field
@@ -588,6 +745,17 @@ export class ProductFieldsApi extends BaseAPI {
     deleteProductField(requestParameters) {
         return ProductFieldsApiFp(this.configuration).deleteProductField(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteProductField`, 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 {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    deleteProductFieldWithHttpInfo(requestParameters) {
+        return ProductFieldsApiFp(this.configuration).deleteProductFieldWithHttpInfo(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Removes existing options from a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
      * @summary Delete product field options in bulk
@@ -599,6 +767,17 @@ export class ProductFieldsApi extends BaseAPI {
     deleteProductFieldOptions(requestParameters) {
         return ProductFieldsApiFp(this.configuration).deleteProductFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteProductFieldOptions`, 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 {ProductFieldsApiDeleteProductFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    deleteProductFieldOptionsWithHttpInfo(requestParameters) {
+        return ProductFieldsApiFp(this.configuration).deleteProductFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about a specific product field.
      * @summary Get one product field
@@ -610,6 +789,17 @@ export class ProductFieldsApi extends BaseAPI {
     getProductField(requestParameters) {
         return ProductFieldsApiFp(this.configuration).getProductField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getProductField`, 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 {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    getProductFieldWithHttpInfo(requestParameters) {
+        return ProductFieldsApiFp(this.configuration).getProductFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about all product fields in the company.
      * @summary Get all product fields
@@ -621,6 +811,17 @@ export class ProductFieldsApi extends BaseAPI {
     getProductFields(requestParameters = {}) {
         return ProductFieldsApiFp(this.configuration).getProductFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getProductFields`, 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 {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    getProductFieldsWithHttpInfo(requestParameters = {}) {
+        return ProductFieldsApiFp(this.configuration).getProductFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates a product custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
      * @summary Update one product field
@@ -632,6 +833,17 @@ export class ProductFieldsApi extends BaseAPI {
     updateProductField(requestParameters) {
         return ProductFieldsApiFp(this.configuration).updateProductField(requestParameters.field_code, requestParameters.UpdateProductFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateProductField`, 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 {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    updateProductFieldWithHttpInfo(requestParameters) {
+        return ProductFieldsApiFp(this.configuration).updateProductFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdateProductFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates existing options for a product custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
      * @summary Update product field options in bulk
@@ -643,4 +855,15 @@ export class ProductFieldsApi extends BaseAPI {
     updateProductFieldOptions(requestParameters) {
         return ProductFieldsApiFp(this.configuration).updateProductFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateProductFieldOptions`, 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 {ProductFieldsApiUpdateProductFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    updateProductFieldOptionsWithHttpInfo(requestParameters) {
+        return ProductFieldsApiFp(this.configuration).updateProductFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
 }