pipedrive 24.1.0 → 24.2.0

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

@@ -12,18 +12,21 @@
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
+import { AddAInstallmentResponse } from '../models';
 import { AddActivityRequest } 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 { AddOrganizationRequest } from '../models';
 import { AddPersonRequest } from '../models';
 import { DeleteActivityResponse } from '../models';
 import { DeleteAdditionalDiscountResponse } from '../models';
 import { DeleteDealProductResponse } from '../models';
 import { DeleteDealResponse } from '../models';
+import { DeleteInstallmentResponse } from '../models';
 import { DeleteOrganizationResponse } from '../models';
 import { DeletePersonResponse } from '../models';
 import { GetActivitiesResponse } from '../models';
@@ -31,6 +34,7 @@ import { GetAdditionalDiscountsResponse } from '../models';
 import { GetDealSearchResponse } from '../models';
 import { GetDealsProductsResponse } from '../models';
 import { GetDealsResponse } from '../models';
+import { GetInstallmentsResponse } from '../models';
 import { GetItemSearchFieldResponse } from '../models';
 import { GetItemSearchResponse } from '../models';
 import { GetLeadSearchResponse } from '../models';
@@ -42,6 +46,8 @@ 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 { UpdateOrganizationRequest } from '../models';
 import { UpdatePersonRequest } from '../models';
 import { UpsertActivityResponse } from '../models';
@@ -128,6 +134,15 @@ export declare const BetaApiAxiosParamCreator: (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>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -150,6 +165,10 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
      * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
      * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
      * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
+     * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
+     * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
+     * @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
+     * @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
      * @param {string} [updated_since] If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
@@ -160,7 +179,7 @@ export declare const BetaApiAxiosParamCreator: (configuration?: Configuration) =
 
      * @throws {RequiredError}
      */
-    getActivities: (filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
+    getActivities: (filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string) => Promise<RequestArgs>;
     /**
      * Returns the details of a specific activity.
      * @summary Get details of an activity
@@ -235,6 +254,18 @@ export declare const BetaApiAxiosParamCreator: (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>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -301,6 +332,15 @@ export declare const BetaApiAxiosParamCreator: (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
@@ -424,6 +464,16 @@ export declare const BetaApiAxiosParamCreator: (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>;
     /**
      * Updates the properties of a organization.
      * @summary Update a organization
@@ -523,6 +573,15 @@ export declare const BetaApiFp: (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>>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -545,6 +604,10 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
      * @param {number} [filter_id] If supplied, only activities matching the specified filter are returned
      * @param {string} [ids] Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response.
      * @param {number} [owner_id] If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
+     * @param {number} [deal_id] If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
+     * @param {string} [lead_id] If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
+     * @param {number} [person_id] If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
+     * @param {number} [org_id] If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
      * @param {string} [updated_since] If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {string} [updated_until] If set, only activities with an &#x60;update_time&#x60; earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @param {'id' | 'update_time' | 'add_time'} [sort_by] The field to sort by. Supported fields: &#x60;id&#x60;, &#x60;update_time&#x60;, &#x60;add_time&#x60;.
@@ -555,7 +618,7 @@ export declare const BetaApiFp: (configuration?: Configuration) => {
 
      * @throws {RequiredError}
      */
-    getActivities(filter_id?: number, ids?: string, owner_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
+    getActivities(filter_id?: number, ids?: string, owner_id?: number, deal_id?: number, lead_id?: string, person_id?: number, org_id?: number, updated_since?: string, updated_until?: string, sort_by?: 'id' | 'update_time' | 'add_time', sort_direction?: 'asc' | 'desc', include_fields?: 'attendees', limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
     /**
      * Returns the details of a specific activity.
      * @summary Get details of an activity
@@ -630,6 +693,18 @@ export declare const BetaApiFp: (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>>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -696,6 +771,15 @@ export declare const BetaApiFp: (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
@@ -819,6 +903,16 @@ export declare const BetaApiFp: (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>>;
     /**
      * Updates the properties of a organization.
      * @summary Update a organization
@@ -915,6 +1009,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteDealProduct(requestParameters: BetaApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
+    /**
+     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * @summary Delete an installment from a deal
+     * @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -987,6 +1089,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getDealsProducts(requestParameters: BetaApiGetDealsProductsRequest): 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 {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -1027,6 +1137,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     postAdditionalDiscount(requestParameters: BetaApiPostAdditionalDiscountRequest): 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 {BetaApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    postInstallment(requestParameters: BetaApiPostInstallmentRequest): 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
@@ -1107,6 +1225,14 @@ export declare const BetaApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     updateDealProduct(requestParameters: BetaApiUpdateDealProductRequest): 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 {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
     /**
      * Updates the properties of a organization.
      * @summary Update a organization
@@ -1259,6 +1385,25 @@ export interface BetaApiDeleteDealProductRequest {
      */
     readonly product_attachment_id: number;
 }
+/**
+ * Request parameters for deleteInstallment operation in BetaApi.
+ * @export
+ * @interface BetaApiDeleteInstallmentRequest
+ */
+export interface BetaApiDeleteInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof BetaApiDeleteInstallment
+     */
+    readonly id: number;
+    /**
+     * The ID of the installment
+     * @type {number}
+     * @memberof BetaApiDeleteInstallment
+     */
+    readonly installment_id: number;
+}
 /**
  * Request parameters for deleteOrganization operation in BetaApi.
  * @export
@@ -1309,6 +1454,30 @@ export interface BetaApiGetActivitiesRequest {
      * @memberof BetaApiGetActivities
      */
     readonly owner_id?: number;
+    /**
+     * If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof BetaApiGetActivities
+     */
+    readonly deal_id?: number;
+    /**
+     * If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
+     * @type {string}
+     * @memberof BetaApiGetActivities
+     */
+    readonly lead_id?: string;
+    /**
+     * If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof BetaApiGetActivities
+     */
+    readonly person_id?: number;
+    /**
+     * If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
+     * @type {number}
+     * @memberof BetaApiGetActivities
+     */
+    readonly org_id?: number;
     /**
      * If set, only activities with an &#x60;update_time&#x60; later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
      * @type {string}
@@ -1586,6 +1755,43 @@ export interface BetaApiGetDealsProductsRequest {
      */
     readonly sort_direction?: 'asc' | 'desc';
 }
+/**
+ * Request parameters for getInstallments operation in BetaApi.
+ * @export
+ * @interface BetaApiGetInstallmentsRequest
+ */
+export interface BetaApiGetInstallmentsRequest {
+    /**
+     * 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 BetaApiGetInstallments
+     */
+    readonly deal_ids: Array<number>;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof BetaApiGetInstallments
+     */
+    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 BetaApiGetInstallments
+     */
+    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 BetaApiGetInstallments
+     */
+    readonly sort_by?: 'id' | 'billing_date' | 'deal_id';
+    /**
+     * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+     * @type {'asc' | 'desc'}
+     * @memberof BetaApiGetInstallments
+     */
+    readonly sort_direction?: 'asc' | 'desc';
+}
 /**
  * Request parameters for getOrganization operation in BetaApi.
  * @export
@@ -1807,6 +2013,25 @@ export interface BetaApiPostAdditionalDiscountRequest {
      */
     readonly AddAdditionalDiscountRequestBody?: AddAdditionalDiscountRequestBody;
 }
+/**
+ * Request parameters for postInstallment operation in BetaApi.
+ * @export
+ * @interface BetaApiPostInstallmentRequest
+ */
+export interface BetaApiPostInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof BetaApiPostInstallment
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddInstallmentRequestBody}
+     * @memberof BetaApiPostInstallment
+     */
+    readonly AddInstallmentRequestBody?: AddInstallmentRequestBody;
+}
 /**
  * Request parameters for searchDeals operation in BetaApi.
  * @export
@@ -2195,6 +2420,31 @@ export interface BetaApiUpdateDealProductRequest {
      */
     readonly UpdateDealProductRequest?: UpdateDealProductRequest;
 }
+/**
+ * Request parameters for updateInstallment operation in BetaApi.
+ * @export
+ * @interface BetaApiUpdateInstallmentRequest
+ */
+export interface BetaApiUpdateInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof BetaApiUpdateInstallment
+     */
+    readonly id: number;
+    /**
+     * The ID of the installment
+     * @type {number}
+     * @memberof BetaApiUpdateInstallment
+     */
+    readonly installment_id: number;
+    /**
+     *
+     * @type {UpdateInstallmentRequestBody}
+     * @memberof BetaApiUpdateInstallment
+     */
+    readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
+}
 /**
  * Request parameters for updateOrganization operation in BetaApi.
  * @export
@@ -2321,6 +2571,15 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     deleteDealProduct(requestParameters: BetaApiDeleteDealProductRequest): Promise<DeleteDealProductResponse>;
+    /**
+     * Removes an installment from a deal.  Only available in Advanced and above plans.
+     * @summary Delete an installment from a deal
+     * @param {BetaApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    deleteInstallment(requestParameters: BetaApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -2402,6 +2661,15 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     getDealsProducts(requestParameters: BetaApiGetDealsProductsRequest): 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 {BetaApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    getInstallments(requestParameters: BetaApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -2447,6 +2715,15 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     postAdditionalDiscount(requestParameters: BetaApiPostAdditionalDiscountRequest): 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 {BetaApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    postInstallment(requestParameters: BetaApiPostInstallmentRequest): 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
@@ -2537,6 +2814,15 @@ export declare class BetaApi extends BaseAPI {
      * @memberof BetaApi
      */
     updateDealProduct(requestParameters: BetaApiUpdateDealProductRequest): 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 {BetaApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof BetaApi
+     */
+    updateInstallment(requestParameters: BetaApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
     /**
      * Updates the properties of a organization.
      * @summary Update a organization