pipedrive 36.0.1 → 36.1.0

package/dist/esm/versions/v2/api/deal-products-api.js

@@ -348,6 +348,20 @@ export const DealProductsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addDealProduct`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add a product to a deal
+         * @param {number} id The ID of the deal
+         * @param {AddDealProductRequest} [AddDealProductRequest]
+
+         * @throws {RequiredError}
+         */
+        addDealProductWithHttpInfo(id, AddDealProductRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealProduct(id, AddDealProductRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
          * @summary Add multiple products to a deal
@@ -362,6 +376,20 @@ export const DealProductsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addManyDealProducts`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add multiple products to a deal
+         * @param {number} id The ID of the deal
+         * @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
+
+         * @throws {RequiredError}
+         */
+        addManyDealProductsWithHttpInfo(id, CreateManyDealProductRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addManyDealProducts(id, CreateManyDealProductRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -376,6 +404,20 @@ export const DealProductsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteDealProduct`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete an attached product from a deal
+         * @param {number} id The ID of the deal
+         * @param {number} product_attachment_id The product attachment ID
+
+         * @throws {RequiredError}
+         */
+        deleteDealProductWithHttpInfo(id, product_attachment_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealProduct(id, product_attachment_id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
          * @summary Delete many products from a deal
@@ -390,6 +432,20 @@ export const DealProductsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteManyDealProducts`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete many products from a deal
+         * @param {number} id The ID of the deal
+         * @param {Set<number>} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
+
+         * @throws {RequiredError}
+         */
+        deleteManyDealProductsWithHttpInfo(id, ids) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteManyDealProducts(id, ids);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Lists products attached to a deal.
          * @summary List products attached to a deal
@@ -407,6 +463,23 @@ export const DealProductsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getDealProducts`, but resolves with the response body together with the HTTP status and headers.
+         * @summary List products attached to a deal
+         * @param {number} id The ID of the deal
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+         * @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 {'id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;, &#x60;order_nr&#x60;.
+         * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+
+         * @throws {RequiredError}
+         */
+        getDealProductsWithHttpInfo(id, cursor, limit, sort_by, sort_direction) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealProducts(id, cursor, limit, sort_by, sort_direction);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns data about products attached to deals
          * @summary Get deal products of several deals
@@ -424,6 +497,23 @@ export const DealProductsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getDealsProducts`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get deal products of several deals
+         * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+         * @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 {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;, &#x60;order_nr&#x60;.
+         * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+
+         * @throws {RequiredError}
+         */
+        getDealsProductsWithHttpInfo(deal_ids, cursor, limit, sort_by, sort_direction) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealsProducts(deal_ids, cursor, limit, sort_by, sort_direction);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates the details of the product that has been attached to a deal.
          * @summary Update the product attached to a deal
@@ -439,6 +529,21 @@ export const DealProductsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateDealProduct`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update the product attached to a deal
+         * @param {number} id The ID of the deal
+         * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal)
+         * @param {UpdateDealProductRequest} [UpdateDealProductRequest]
+
+         * @throws {RequiredError}
+         */
+        updateDealProductWithHttpInfo(id, product_attachment_id, UpdateDealProductRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateDealProduct(id, product_attachment_id, UpdateDealProductRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 /**
@@ -458,6 +563,9 @@ export const DealProductsApiFactory = function (configuration, basePath, axios)
         addDealProduct(requestParameters) {
             return localVarFp.addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(axios, basePath));
         },
+        addDealProductWithHttpInfo(requestParameters) {
+            return localVarFp.addDealProductWithHttpInfo(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
          * @summary Add multiple products to a deal
@@ -468,6 +576,9 @@ export const DealProductsApiFactory = function (configuration, basePath, axios)
         addManyDealProducts(requestParameters) {
             return localVarFp.addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(axios, basePath));
         },
+        addManyDealProductsWithHttpInfo(requestParameters) {
+            return localVarFp.addManyDealProductsWithHttpInfo(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -478,6 +589,9 @@ export const DealProductsApiFactory = function (configuration, basePath, axios)
         deleteDealProduct(requestParameters) {
             return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
         },
+        deleteDealProductWithHttpInfo(requestParameters) {
+            return localVarFp.deleteDealProductWithHttpInfo(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(axios, basePath));
+        },
         /**
          * Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
          * @summary Delete many products from a deal
@@ -488,6 +602,9 @@ export const DealProductsApiFactory = function (configuration, basePath, axios)
         deleteManyDealProducts(requestParameters) {
             return localVarFp.deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(axios, basePath));
         },
+        deleteManyDealProductsWithHttpInfo(requestParameters) {
+            return localVarFp.deleteManyDealProductsWithHttpInfo(requestParameters.id, requestParameters.ids).then((request) => request(axios, basePath));
+        },
         /**
          * Lists products attached to a deal.
          * @summary List products attached to a deal
@@ -498,6 +615,9 @@ export const DealProductsApiFactory = function (configuration, basePath, axios)
         getDealProducts(requestParameters) {
             return localVarFp.getDealProducts(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
         },
+        getDealProductsWithHttpInfo(requestParameters) {
+            return localVarFp.getDealProductsWithHttpInfo(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
+        },
         /**
          * Returns data about products attached to deals
          * @summary Get deal products of several deals
@@ -508,6 +628,9 @@ export const DealProductsApiFactory = function (configuration, basePath, axios)
         getDealsProducts(requestParameters) {
             return localVarFp.getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
         },
+        getDealsProductsWithHttpInfo(requestParameters) {
+            return localVarFp.getDealsProductsWithHttpInfo(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(axios, basePath));
+        },
         /**
          * Updates the details of the product that has been attached to a deal.
          * @summary Update the product attached to a deal
@@ -518,6 +641,9 @@ export const DealProductsApiFactory = function (configuration, basePath, axios)
         updateDealProduct(requestParameters) {
             return localVarFp.updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(axios, basePath));
         },
+        updateDealProductWithHttpInfo(requestParameters) {
+            return localVarFp.updateDealProductWithHttpInfo(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -538,6 +664,17 @@ export class DealProductsApi extends BaseAPI {
     addDealProduct(requestParameters) {
         return DealProductsApiFp(this.configuration).addDealProduct(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addDealProduct`, 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 {DealProductsApiAddDealProductRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealProductsApi
+     */
+    addDealProductWithHttpInfo(requestParameters) {
+        return DealProductsApiFp(this.configuration).addDealProductWithHttpInfo(requestParameters.id, requestParameters.AddDealProductRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
      * @summary Add multiple products to a deal
@@ -549,6 +686,17 @@ export class DealProductsApi extends BaseAPI {
     addManyDealProducts(requestParameters) {
         return DealProductsApiFp(this.configuration).addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addManyDealProducts`, 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 {DealProductsApiAddManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealProductsApi
+     */
+    addManyDealProductsWithHttpInfo(requestParameters) {
+        return DealProductsApiFp(this.configuration).addManyDealProductsWithHttpInfo(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -560,6 +708,17 @@ export class DealProductsApi extends BaseAPI {
     deleteDealProduct(requestParameters) {
         return DealProductsApiFp(this.configuration).deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteDealProduct`, 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 {DealProductsApiDeleteDealProductRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealProductsApi
+     */
+    deleteDealProductWithHttpInfo(requestParameters) {
+        return DealProductsApiFp(this.configuration).deleteDealProductWithHttpInfo(requestParameters.id, requestParameters.product_attachment_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Deletes multiple products from a deal. If no product IDs are specified, up to 100 products will be removed from the deal. A maximum of 100 product IDs can be provided per request.
      * @summary Delete many products from a deal
@@ -571,6 +730,17 @@ export class DealProductsApi extends BaseAPI {
     deleteManyDealProducts(requestParameters) {
         return DealProductsApiFp(this.configuration).deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteManyDealProducts`, 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 {DealProductsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealProductsApi
+     */
+    deleteManyDealProductsWithHttpInfo(requestParameters) {
+        return DealProductsApiFp(this.configuration).deleteManyDealProductsWithHttpInfo(requestParameters.id, requestParameters.ids).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal
@@ -582,6 +752,17 @@ export class DealProductsApi extends BaseAPI {
     getDealProducts(requestParameters) {
         return DealProductsApiFp(this.configuration).getDealProducts(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getDealProducts`, 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 {DealProductsApiGetDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealProductsApi
+     */
+    getDealProductsWithHttpInfo(requestParameters) {
+        return DealProductsApiFp(this.configuration).getDealProductsWithHttpInfo(requestParameters.id, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns data about products attached to deals
      * @summary Get deal products of several deals
@@ -593,6 +774,17 @@ export class DealProductsApi extends BaseAPI {
     getDealsProducts(requestParameters) {
         return DealProductsApiFp(this.configuration).getDealsProducts(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getDealsProducts`, 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 {DealProductsApiGetDealsProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealProductsApi
+     */
+    getDealsProductsWithHttpInfo(requestParameters) {
+        return DealProductsApiFp(this.configuration).getDealsProductsWithHttpInfo(requestParameters.deal_ids, requestParameters.cursor, requestParameters.limit, requestParameters.sort_by, requestParameters.sort_direction).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates the details of the product that has been attached to a deal.
      * @summary Update the product attached to a deal
@@ -604,4 +796,15 @@ export class DealProductsApi extends BaseAPI {
     updateDealProduct(requestParameters) {
         return DealProductsApiFp(this.configuration).updateDealProduct(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateDealProduct`, 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 {DealProductsApiUpdateDealProductRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealProductsApi
+     */
+    updateDealProductWithHttpInfo(requestParameters) {
+        return DealProductsApiFp(this.configuration).updateDealProductWithHttpInfo(requestParameters.id, requestParameters.product_attachment_id, requestParameters.UpdateDealProductRequest).then((request) => request(this.axios, this.basePath));
+    }
 }