pipedrive 30.0.0 → 30.2.0

package/dist/esm/versions/v2/api/deals-api.d.ts

@@ -22,11 +22,14 @@ import { AddDealProductResponse } from '../models';
 import { AddDealRequest } from '../models';
 import { AddFollowerResponse } from '../models';
 import { AddInstallmentRequestBody } from '../models';
+import { AddManyDealProductResponse } from '../models';
+import { CreateManyDealProductRequest } from '../models';
 import { DeleteAdditionalDiscountResponse } from '../models';
 import { DeleteDealProductResponse } from '../models';
 import { DeleteDealResponse } from '../models';
 import { DeleteFollowerResponse } from '../models';
 import { DeleteInstallmentResponse } from '../models';
+import { DeleteManyDealProductResponse } from '../models';
 import { GetAdditionalDiscountsResponse } from '../models';
 import { GetConvertResponse1 } from '../models';
 import { GetDealSearchResponse } from '../models';
@@ -73,6 +76,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     addDealProduct: (id: number, AddDealProductRequest?: AddDealProductRequest) => Promise<RequestArgs>;
+    /**
+     * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
+     * @summary Add multiple products to a deal
+     * @param {number} id The ID of the deal
+     * @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
+
+     * @throws {RequiredError}
+     */
+    addManyDealProducts: (id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest) => Promise<RequestArgs>;
     /**
      * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
      * @summary Convert a deal to a lead (BETA)
@@ -85,11 +97,11 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
      * @summary Delete a discount from a deal
      * @param {number} id The ID of the deal
-     * @param {number} discount_id The ID of the discount
+     * @param {string} discount_id The ID of the discount
 
      * @throws {RequiredError}
      */
-    deleteAdditionalDiscount: (id: number, discount_id: number) => Promise<RequestArgs>;
+    deleteAdditionalDiscount: (id: number, discount_id: string) => Promise<RequestArgs>;
     /**
      * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @summary Delete a deal
@@ -125,6 +137,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
+    /**
+     * 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
+     * @param {number} id The ID of the deal
+     * @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
+
+     * @throws {RequiredError}
+     */
+    deleteManyDealProducts: (id: number, ids?: string) => Promise<RequestArgs>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -201,12 +222,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+     * @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}
      */
-    getDealProducts: (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
+    getDealProducts: (id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
     /**
      * Returns data about all not archived deals.
      * @summary Get all deals
@@ -236,12 +257,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+     * @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}
      */
-    getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
+    getDealsProducts: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
     /**
      * Lists installments attached to a list of deals.  Only available in Growth and above plans.
      * @summary List installments added to a list of deals
@@ -292,12 +313,12 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
      * @summary Update a discount added to a deal
      * @param {number} id The ID of the deal
-     * @param {number} discount_id The ID of the discount
+     * @param {string} discount_id The ID of the discount
      * @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
 
      * @throws {RequiredError}
      */
-    updateAdditionalDiscount: (id: number, discount_id: number, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody) => Promise<RequestArgs>;
+    updateAdditionalDiscount: (id: number, discount_id: string, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody) => Promise<RequestArgs>;
     /**
      * Updates the properties of a deal.
      * @summary Update a deal
@@ -359,6 +380,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
+    /**
+     * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
+     * @summary Add multiple products to a deal
+     * @param {number} id The ID of the deal
+     * @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
+
+     * @throws {RequiredError}
+     */
+    addManyDealProducts(id: number, CreateManyDealProductRequest?: CreateManyDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddManyDealProductResponse>>;
     /**
      * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
      * @summary Convert a deal to a lead (BETA)
@@ -371,11 +401,11 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
      * @summary Delete a discount from a deal
      * @param {number} id The ID of the deal
-     * @param {number} discount_id The ID of the discount
+     * @param {string} discount_id The ID of the discount
 
      * @throws {RequiredError}
      */
-    deleteAdditionalDiscount(id: number, discount_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteAdditionalDiscountResponse>>;
+    deleteAdditionalDiscount(id: number, discount_id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteAdditionalDiscountResponse>>;
     /**
      * Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
      * @summary Delete a deal
@@ -411,6 +441,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
+    /**
+     * 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
+     * @param {number} id The ID of the deal
+     * @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
+
+     * @throws {RequiredError}
+     */
+    deleteManyDealProducts(id: number, ids?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteManyDealProductResponse>>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -487,12 +526,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+     * @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}
      */
-    getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
+    getDealProducts(id: number, cursor?: string, limit?: number, sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
     /**
      * Returns data about all not archived deals.
      * @summary Get all deals
@@ -522,12 +561,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+     * @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}
      */
-    getDealsProducts(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
+    getDealsProducts(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealsProductsResponse>>;
     /**
      * Lists installments attached to a list of deals.  Only available in Growth and above plans.
      * @summary List installments added to a list of deals
@@ -578,12 +617,12 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
      * @summary Update a discount added to a deal
      * @param {number} id The ID of the deal
-     * @param {number} discount_id The ID of the discount
+     * @param {string} discount_id The ID of the discount
      * @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
 
      * @throws {RequiredError}
      */
-    updateAdditionalDiscount(id: number, discount_id: number, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateAdditionalDiscountResponse>>;
+    updateAdditionalDiscount(id: number, discount_id: string, UpdateAdditionalDiscountRequestBody?: UpdateAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateAdditionalDiscountResponse>>;
     /**
      * Updates the properties of a deal.
      * @summary Update a deal
@@ -643,6 +682,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
+    /**
+     * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
+     * @summary Add multiple products to a deal
+     * @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
     /**
      * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
      * @summary Convert a deal to a lead (BETA)
@@ -691,6 +738,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * 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
+     * @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteManyDealProducts(requestParameters: DealsApiDeleteManyDealProductsRequest): Promise<DeleteManyDealProductResponse>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -879,6 +934,25 @@ export interface DealsApiAddDealProductRequest {
      */
     readonly AddDealProductRequest?: AddDealProductRequest;
 }
+/**
+ * Request parameters for addManyDealProducts operation in DealsApi.
+ * @export
+ * @interface DealsApiAddManyDealProductsRequest
+ */
+export interface DealsApiAddManyDealProductsRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiAddManyDealProducts
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {CreateManyDealProductRequest}
+     * @memberof DealsApiAddManyDealProducts
+     */
+    readonly CreateManyDealProductRequest?: CreateManyDealProductRequest;
+}
 /**
  * Request parameters for convertDealToLead operation in DealsApi.
  * @export
@@ -906,10 +980,10 @@ export interface DealsApiDeleteAdditionalDiscountRequest {
     readonly id: number;
     /**
      * The ID of the discount
-     * @type {number}
+     * @type {string}
      * @memberof DealsApiDeleteAdditionalDiscount
      */
-    readonly discount_id: number;
+    readonly discount_id: string;
 }
 /**
  * Request parameters for deleteDeal operation in DealsApi.
@@ -981,6 +1055,25 @@ export interface DealsApiDeleteInstallmentRequest {
      */
     readonly installment_id: number;
 }
+/**
+ * Request parameters for deleteManyDealProducts operation in DealsApi.
+ * @export
+ * @interface DealsApiDeleteManyDealProductsRequest
+ */
+export interface DealsApiDeleteManyDealProductsRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiDeleteManyDealProducts
+     */
+    readonly id: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof DealsApiDeleteManyDealProducts
+     */
+    readonly ids?: string;
+}
 /**
  * Request parameters for getAdditionalDiscounts operation in DealsApi.
  * @export
@@ -1216,11 +1309,11 @@ export interface DealsApiGetDealProductsRequest {
      */
     readonly limit?: number;
     /**
-     * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
-     * @type {'id' | 'add_time' | 'update_time'}
+     * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;, &#x60;order_nr&#x60;.
+     * @type {'id' | 'add_time' | 'update_time' | 'order_nr'}
      * @memberof DealsApiGetDealProducts
      */
-    readonly sort_by?: 'id' | 'add_time' | 'update_time';
+    readonly sort_by?: 'id' | 'add_time' | 'update_time' | 'order_nr';
     /**
      * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
      * @type {'asc' | 'desc'}
@@ -1356,11 +1449,11 @@ export interface DealsApiGetDealsProductsRequest {
      */
     readonly limit?: number;
     /**
-     * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
-     * @type {'id' | 'deal_id' | 'add_time' | 'update_time'}
+     * 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;.
+     * @type {'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr'}
      * @memberof DealsApiGetDealsProducts
      */
-    readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time';
+    readonly sort_by?: 'id' | 'deal_id' | 'add_time' | 'update_time' | 'order_nr';
     /**
      * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
      * @type {'asc' | 'desc'}
@@ -1518,10 +1611,10 @@ export interface DealsApiUpdateAdditionalDiscountRequest {
     readonly id: number;
     /**
      * The ID of the discount
-     * @type {number}
+     * @type {string}
      * @memberof DealsApiUpdateAdditionalDiscount
      */
-    readonly discount_id: number;
+    readonly discount_id: string;
     /**
      *
      * @type {UpdateAdditionalDiscountRequestBody}
@@ -1632,6 +1725,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     addDealProduct(requestParameters: DealsApiAddDealProductRequest): Promise<AddDealProductResponse>;
+    /**
+     * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
+     * @summary Add multiple products to a deal
+     * @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    addManyDealProducts(requestParameters: DealsApiAddManyDealProductsRequest): Promise<AddManyDealProductResponse>;
     /**
      * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
      * @summary Convert a deal to a lead (BETA)
@@ -1686,6 +1788,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * 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
+     * @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    deleteManyDealProducts(requestParameters: DealsApiDeleteManyDealProductsRequest): Promise<DeleteManyDealProductResponse>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal

package/dist/esm/versions/v2/api/deals-api.js

@@ -139,6 +139,43 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
+         * @summary Add multiple products to a deal
+         * @param {number} id The ID of the deal
+         * @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
+
+         * @throws {RequiredError}
+         */
+        addManyDealProducts: (id, CreateManyDealProductRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('addManyDealProducts', 'id', id);
+            const localVarPath = `/deals/{id}/products/bulk`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(CreateManyDealProductRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
          * @summary Convert a deal to a lead (BETA)
@@ -177,7 +214,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
          * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
          * @summary Delete a discount from a deal
          * @param {number} id The ID of the deal
-         * @param {number} discount_id The ID of the discount
+         * @param {string} discount_id The ID of the discount
 
          * @throws {RequiredError}
          */
@@ -359,6 +396,44 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * 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
+         * @param {number} id The ID of the deal
+         * @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
+
+         * @throws {RequiredError}
+         */
+        deleteManyDealProducts: (id, ids) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deleteManyDealProducts', 'id', id);
+            const localVarPath = `/deals/{id}/products`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarHeaderParameter, "x-api-token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full", "deals:full"], configuration);
+            if (ids !== undefined) {
+                localVarQueryParameter['ids'] = ids;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Lists discounts attached to a deal.
          * @summary List discounts added to a deal
@@ -657,7 +732,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
          * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+         * @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}
@@ -801,7 +876,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
          * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+         * @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}
@@ -1045,7 +1120,7 @@ export const DealsApiAxiosParamCreator = function (configuration) {
          * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
          * @summary Update a discount added to a deal
          * @param {number} id The ID of the deal
-         * @param {number} discount_id The ID of the discount
+         * @param {string} discount_id The ID of the discount
          * @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
 
          * @throws {RequiredError}
@@ -1251,6 +1326,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Adds multiple products to a deal in a single request. Maximum of 100 products allowed per request.
+         * @summary Add multiple products to a deal
+         * @param {number} id The ID of the deal
+         * @param {CreateManyDealProductRequest} [CreateManyDealProductRequest]
+
+         * @throws {RequiredError}
+         */
+        addManyDealProducts(id, CreateManyDealProductRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addManyDealProducts(id, CreateManyDealProductRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
          * @summary Convert a deal to a lead (BETA)
@@ -1268,7 +1357,7 @@ export const DealsApiFp = function (configuration) {
          * Removes a discount from a deal, changing the deal value if the deal has one-time products attached.
          * @summary Delete a discount from a deal
          * @param {number} id The ID of the deal
-         * @param {number} discount_id The ID of the discount
+         * @param {string} discount_id The ID of the discount
 
          * @throws {RequiredError}
          */
@@ -1333,6 +1422,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * 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
+         * @param {number} id The ID of the deal
+         * @param {string} [ids] Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
+
+         * @throws {RequiredError}
+         */
+        deleteManyDealProducts(id, ids) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteManyDealProducts(id, ids);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Lists discounts attached to a deal.
          * @summary List discounts added to a deal
@@ -1439,7 +1542,7 @@ export const DealsApiFp = function (configuration) {
          * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+         * @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}
@@ -1484,7 +1587,7 @@ export const DealsApiFp = function (configuration) {
          * @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'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;deal_id&#x60;, &#x60;add_time&#x60;, &#x60;update_time&#x60;.
+         * @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}
@@ -1565,7 +1668,7 @@ export const DealsApiFp = function (configuration) {
          * Edits a discount added to a deal, changing the deal value if the deal has one-time products attached.
          * @summary Update a discount added to a deal
          * @param {number} id The ID of the deal
-         * @param {number} discount_id The ID of the discount
+         * @param {string} discount_id The ID of the discount
          * @param {UpdateAdditionalDiscountRequestBody} [UpdateAdditionalDiscountRequestBody]
 
          * @throws {RequiredError}
@@ -1659,6 +1762,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         addDealProduct(requestParameters) {
             return localVarFp.addDealProduct(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
+         * @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addManyDealProducts(requestParameters) {
+            return localVarFp.addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
          * @summary Convert a deal to a lead (BETA)
@@ -1719,6 +1832,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         deleteInstallment(requestParameters) {
             return localVarFp.deleteInstallment(requestParameters.id, requestParameters.installment_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
+         * @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteManyDealProducts(requestParameters) {
+            return localVarFp.deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(axios, basePath));
+        },
         /**
          * Lists discounts attached to a deal.
          * @summary List discounts added to a deal
@@ -1931,6 +2054,17 @@ export class DealsApi extends BaseAPI {
     addDealProduct(requestParameters) {
         return DealsApiFp(this.configuration).addDealProduct(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
+     * @param {DealsApiAddManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    addManyDealProducts(requestParameters) {
+        return DealsApiFp(this.configuration).addManyDealProducts(requestParameters.id, requestParameters.CreateManyDealProductRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.
      * @summary Convert a deal to a lead (BETA)
@@ -1997,6 +2131,17 @@ export class DealsApi extends BaseAPI {
     deleteInstallment(requestParameters) {
         return DealsApiFp(this.configuration).deleteInstallment(requestParameters.id, requestParameters.installment_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
+     * @param {DealsApiDeleteManyDealProductsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    deleteManyDealProducts(requestParameters) {
+        return DealsApiFp(this.configuration).deleteManyDealProducts(requestParameters.id, requestParameters.ids).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal