pipedrive 24.1.1 → 24.2.0

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

@@ -12,22 +12,28 @@
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
+import { AddAInstallmentResponse } from '../models';
 import { AddAdditionalDiscountRequestBody } from '../models';
 import { AddAdditionalDiscountResponse } from '../models';
 import { AddDealProductRequest } from '../models';
 import { AddDealProductResponse } from '../models';
 import { AddDealRequest } from '../models';
+import { AddInstallmentRequestBody } from '../models';
 import { DeleteAdditionalDiscountResponse } from '../models';
 import { DeleteDealProductResponse } from '../models';
 import { DeleteDealResponse } from '../models';
+import { DeleteInstallmentResponse } from '../models';
 import { GetAdditionalDiscountsResponse } from '../models';
 import { GetDealSearchResponse } from '../models';
 import { GetDealsProductsResponse } from '../models';
 import { GetDealsResponse } from '../models';
+import { GetInstallmentsResponse } from '../models';
 import { UpdateAdditionalDiscountRequestBody } from '../models';
 import { UpdateAdditionalDiscountResponse } from '../models';
 import { UpdateDealProductRequest } from '../models';
 import { UpdateDealRequest } from '../models';
+import { UpdateInstallmentRequestBody } from '../models';
+import { UpdateInstallmentResponse } from '../models';
 import { UpsertDealResponse } from '../models';
 /**
  * DealsApi - axios parameter creator
@@ -77,6 +83,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteDealProduct: (id: number, product_attachment_id: number) => Promise<RequestArgs>;
+    /**
+     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * @summary Delete an installment from a deal
+     * @param {number} id The ID of the deal
+     * @param {number} installment_id The ID of the installment
+
+     * @throws {RequiredError}
+     */
+    deleteInstallment: (id: number, installment_id: number) => Promise<RequestArgs>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -142,6 +157,18 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @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>;
+    /**
+     * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+     * @summary List installments added to a list of deals
+     * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments 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' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
+     * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+
+     * @throws {RequiredError}
+     */
+    getInstallments: (deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc') => Promise<RequestArgs>;
     /**
      * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
      * @summary Add a discount to a deal
@@ -151,6 +178,15 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     postAdditionalDiscount: (id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody) => Promise<RequestArgs>;
+    /**
+     * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+     * @summary Add an installment to a deal
+     * @param {number} id The ID of the deal
+     * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
+
+     * @throws {RequiredError}
+     */
+    postInstallment: (id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody) => Promise<RequestArgs>;
     /**
      * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
      * @summary Search deals
@@ -196,6 +232,16 @@ export declare const DealsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     updateDealProduct: (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest) => Promise<RequestArgs>;
+    /**
+     * Edits an installment added to a deal.  Only available in Advanced and above plans.
+     * @summary Update an installment added to a deal
+     * @param {number} id The ID of the deal
+     * @param {number} installment_id The ID of the installment
+     * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
+
+     * @throws {RequiredError}
+     */
+    updateInstallment: (id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody) => Promise<RequestArgs>;
 };
 /**
  * DealsApi - functional programming interface
@@ -245,6 +291,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteDealProduct(id: number, product_attachment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealProductResponse>>;
+    /**
+     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * @summary Delete an installment from a deal
+     * @param {number} id The ID of the deal
+     * @param {number} installment_id The ID of the installment
+
+     * @throws {RequiredError}
+     */
+    deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -310,6 +365,18 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @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>>;
+    /**
+     * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+     * @summary List installments added to a list of deals
+     * @param {Array<number>} deal_ids An array of integers with the IDs of the deals for which the attached installments 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' | 'billing_date' | 'deal_id'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
+     * @param {'asc' | 'desc'} [sort_direction] The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+
+     * @throws {RequiredError}
+     */
+    getInstallments(deal_ids: Array<number>, cursor?: string, limit?: number, sort_by?: 'id' | 'billing_date' | 'deal_id', sort_direction?: 'asc' | 'desc'): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetInstallmentsResponse>>;
     /**
      * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
      * @summary Add a discount to a deal
@@ -319,6 +386,15 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postAdditionalDiscount(id: number, AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAdditionalDiscountResponse>>;
+    /**
+     * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+     * @summary Add an installment to a deal
+     * @param {number} id The ID of the deal
+     * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
+
+     * @throws {RequiredError}
+     */
+    postInstallment(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAInstallmentResponse>>;
     /**
      * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
      * @summary Search deals
@@ -364,6 +440,16 @@ export declare const DealsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealProductResponse>>;
+    /**
+     * Edits an installment added to a deal.  Only available in Advanced and above plans.
+     * @summary Update an installment added to a deal
+     * @param {number} id The ID of the deal
+     * @param {number} installment_id The ID of the installment
+     * @param {UpdateInstallmentRequestBody} [UpdateInstallmentRequestBody]
+
+     * @throws {RequiredError}
+     */
+    updateInstallment(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateInstallmentResponse>>;
 };
 /**
  * DealsApi - factory interface
@@ -410,6 +496,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
+    /**
+     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * @summary Delete an installment from a deal
+     * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -450,6 +544,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
+    /**
+     * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+     * @summary List installments added to a list of deals
+     * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getInstallments(requestParameters: DealsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
     /**
      * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
      * @summary Add a discount to a deal
@@ -458,6 +560,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
+    /**
+     * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+     * @summary Add an installment to a deal
+     * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    postInstallment(requestParameters: DealsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
     /**
      * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
      * @summary Search deals
@@ -490,6 +600,14 @@ export declare const DealsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
+    /**
+     * Edits an installment added to a deal.  Only available in Advanced and above plans.
+     * @summary Update an installment added to a deal
+     * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    updateInstallment(requestParameters: DealsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
 };
 /**
  * Request parameters for addDeal operation in DealsApi.
@@ -574,6 +692,25 @@ export interface DealsApiDeleteDealProductRequest {
      */
     readonly product_attachment_id: number;
 }
+/**
+ * Request parameters for deleteInstallment operation in DealsApi.
+ * @export
+ * @interface DealsApiDeleteInstallmentRequest
+ */
+export interface DealsApiDeleteInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiDeleteInstallment
+     */
+    readonly id: number;
+    /**
+     * The ID of the installment
+     * @type {number}
+     * @memberof DealsApiDeleteInstallment
+     */
+    readonly installment_id: number;
+}
 /**
  * Request parameters for getAdditionalDiscounts operation in DealsApi.
  * @export
@@ -789,6 +926,43 @@ export interface DealsApiGetDealsProductsRequest {
      */
     readonly sort_direction?: 'asc' | 'desc';
 }
+/**
+ * Request parameters for getInstallments operation in DealsApi.
+ * @export
+ * @interface DealsApiGetInstallmentsRequest
+ */
+export interface DealsApiGetInstallmentsRequest {
+    /**
+     * An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
+     * @type {Array<number>}
+     * @memberof DealsApiGetInstallments
+     */
+    readonly deal_ids: Array<number>;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealsApiGetInstallments
+     */
+    readonly cursor?: string;
+    /**
+     * 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.
+     * @type {number}
+     * @memberof DealsApiGetInstallments
+     */
+    readonly limit?: number;
+    /**
+     * The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;billing_date&#x60;, &#x60;deal_id&#x60;.
+     * @type {'id' | 'billing_date' | 'deal_id'}
+     * @memberof DealsApiGetInstallments
+     */
+    readonly sort_by?: 'id' | 'billing_date' | 'deal_id';
+    /**
+     * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+     * @type {'asc' | 'desc'}
+     * @memberof DealsApiGetInstallments
+     */
+    readonly sort_direction?: 'asc' | 'desc';
+}
 /**
  * Request parameters for postAdditionalDiscount operation in DealsApi.
  * @export
@@ -808,6 +982,25 @@ export interface DealsApiPostAdditionalDiscountRequest {
      */
     readonly AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody;
 }
+/**
+ * Request parameters for postInstallment operation in DealsApi.
+ * @export
+ * @interface DealsApiPostInstallmentRequest
+ */
+export interface DealsApiPostInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiPostInstallment
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddInstallmentRequestBody}
+     * @memberof DealsApiPostInstallment
+     */
+    readonly AddInstallmentRequestBody?: AddInstallmentRequestBody;
+}
 /**
  * Request parameters for searchDeals operation in DealsApi.
  * @export
@@ -938,6 +1131,31 @@ export interface DealsApiUpdateDealProductRequest {
      */
     readonly UpdateDealProductRequest?: UpdateDealProductRequest;
 }
+/**
+ * Request parameters for updateInstallment operation in DealsApi.
+ * @export
+ * @interface DealsApiUpdateInstallmentRequest
+ */
+export interface DealsApiUpdateInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealsApiUpdateInstallment
+     */
+    readonly id: number;
+    /**
+     * The ID of the installment
+     * @type {number}
+     * @memberof DealsApiUpdateInstallment
+     */
+    readonly installment_id: number;
+    /**
+     *
+     * @type {UpdateInstallmentRequestBody}
+     * @memberof DealsApiUpdateInstallment
+     */
+    readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
+}
 /**
  * DealsApi - object-oriented interface
  * @export
@@ -990,6 +1208,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
+    /**
+     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * @summary Delete an installment from a deal
+     * @param {DealsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    deleteInstallment(requestParameters: DealsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
     /**
      * Lists discounts attached to a deal.
      * @summary List discounts added to a deal
@@ -1035,6 +1262,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     getDealsProducts(requestParameters: DealsApiGetDealsProductsRequest): Promise<GetDealsProductsResponse>;
+    /**
+     * Lists installments attached to a list of deals.  Only available in Advanced and above plans.
+     * @summary List installments added to a list of deals
+     * @param {DealsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getInstallments(requestParameters: DealsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
     /**
      * Adds a discount to a deal changing, the deal value if the deal has one-time products attached.
      * @summary Add a discount to a deal
@@ -1044,6 +1280,15 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     postAdditionalDiscount(requestParameters: DealsApiPostAdditionalDiscountRequest): Promise<AddAdditionalDiscountResponse>;
+    /**
+     * Adds an installment to a deal.  An installment can only be added if the deal includes at least one one-time product.  If the deal contains at least one recurring product, adding installments is not allowed.  Only available in Advanced and above plans.
+     * @summary Add an installment to a deal
+     * @param {DealsApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    postInstallment(requestParameters: DealsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
     /**
      * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">/v1/itemSearch</a> with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID.
      * @summary Search deals
@@ -1080,4 +1325,13 @@ export declare class DealsApi extends BaseAPI {
      * @memberof DealsApi
      */
     updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest): Promise<AddDealProductResponse>;
+    /**
+     * Edits an installment added to a deal.  Only available in Advanced and above plans.
+     * @summary Update an installment added to a deal
+     * @param {DealsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    updateInstallment(requestParameters: DealsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
 }