pipedrive 32.2.0 → 33.0.0

package/dist/versions/v2/api/deal-installments-api.d.ts

@@ -0,0 +1,294 @@
+/**
+ * Pipedrive API v2
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosInstance } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { AddAInstallmentResponse } from '../models';
+import { AddInstallmentRequestBody } from '../models';
+import { DeleteInstallmentResponse } from '../models';
+import { GetInstallmentsResponse } from '../models';
+import { UpdateInstallmentRequestBody } from '../models';
+import { UpdateInstallmentResponse } from '../models';
+/**
+ * DealInstallmentsApi - axios parameter creator
+ * @export
+ */
+export declare const DealInstallmentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Removes an installment from a deal.  Only available in Growth 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 installments attached to a list of deals.  Only available in Growth 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 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 Growth 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>;
+    /**
+     * Edits an installment added to a deal.  Only available in Growth 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>;
+};
+/**
+ * DealInstallmentsApi - functional programming interface
+ * @export
+ */
+export declare const DealInstallmentsApiFp: (configuration?: Configuration) => {
+    /**
+     * Removes an installment from a deal.  Only available in Growth 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 installments attached to a list of deals.  Only available in Growth 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 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 Growth 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>>;
+    /**
+     * Edits an installment added to a deal.  Only available in Growth 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>>;
+};
+/**
+ * DealInstallmentsApi - factory interface
+ * @export
+ */
+export declare const DealInstallmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Removes an installment from a deal.  Only available in Growth and above plans.
+     * @summary Delete an installment from a deal
+     * @param {DealInstallmentsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    deleteInstallment(requestParameters: DealInstallmentsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * Lists installments attached to a list of deals.  Only available in Growth and above plans.
+     * @summary List installments added to a list of deals
+     * @param {DealInstallmentsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    getInstallments(requestParameters: DealInstallmentsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
+    /**
+     * 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 Growth and above plans.
+     * @summary Add an installment to a deal
+     * @param {DealInstallmentsApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    postInstallment(requestParameters: DealInstallmentsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
+    /**
+     * Edits an installment added to a deal.  Only available in Growth and above plans.
+     * @summary Update an installment added to a deal
+     * @param {DealInstallmentsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     */
+    updateInstallment(requestParameters: DealInstallmentsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
+};
+/**
+ * Request parameters for deleteInstallment operation in DealInstallmentsApi.
+ * @export
+ * @interface DealInstallmentsApiDeleteInstallmentRequest
+ */
+export interface DealInstallmentsApiDeleteInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealInstallmentsApiDeleteInstallment
+     */
+    readonly id: number;
+    /**
+     * The ID of the installment
+     * @type {number}
+     * @memberof DealInstallmentsApiDeleteInstallment
+     */
+    readonly installment_id: number;
+}
+/**
+ * Request parameters for getInstallments operation in DealInstallmentsApi.
+ * @export
+ * @interface DealInstallmentsApiGetInstallmentsRequest
+ */
+export interface DealInstallmentsApiGetInstallmentsRequest {
+    /**
+     * 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 DealInstallmentsApiGetInstallments
+     */
+    readonly deal_ids: Array<number>;
+    /**
+     * For pagination, the marker (an opaque string value) representing the first item on the next page
+     * @type {string}
+     * @memberof DealInstallmentsApiGetInstallments
+     */
+    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 DealInstallmentsApiGetInstallments
+     */
+    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 DealInstallmentsApiGetInstallments
+     */
+    readonly sort_by?: 'id' | 'billing_date' | 'deal_id';
+    /**
+     * The sorting direction. Supported values: &#x60;asc&#x60;, &#x60;desc&#x60;.
+     * @type {'asc' | 'desc'}
+     * @memberof DealInstallmentsApiGetInstallments
+     */
+    readonly sort_direction?: 'asc' | 'desc';
+}
+/**
+ * Request parameters for postInstallment operation in DealInstallmentsApi.
+ * @export
+ * @interface DealInstallmentsApiPostInstallmentRequest
+ */
+export interface DealInstallmentsApiPostInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealInstallmentsApiPostInstallment
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {AddInstallmentRequestBody}
+     * @memberof DealInstallmentsApiPostInstallment
+     */
+    readonly AddInstallmentRequestBody?: AddInstallmentRequestBody;
+}
+/**
+ * Request parameters for updateInstallment operation in DealInstallmentsApi.
+ * @export
+ * @interface DealInstallmentsApiUpdateInstallmentRequest
+ */
+export interface DealInstallmentsApiUpdateInstallmentRequest {
+    /**
+     * The ID of the deal
+     * @type {number}
+     * @memberof DealInstallmentsApiUpdateInstallment
+     */
+    readonly id: number;
+    /**
+     * The ID of the installment
+     * @type {number}
+     * @memberof DealInstallmentsApiUpdateInstallment
+     */
+    readonly installment_id: number;
+    /**
+     *
+     * @type {UpdateInstallmentRequestBody}
+     * @memberof DealInstallmentsApiUpdateInstallment
+     */
+    readonly UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody;
+}
+/**
+ * DealInstallmentsApi - object-oriented interface
+ * @export
+ * @class DealInstallmentsApi
+ * @extends {BaseAPI}
+ */
+export declare class DealInstallmentsApi extends BaseAPI {
+    /**
+     * Removes an installment from a deal.  Only available in Growth and above plans.
+     * @summary Delete an installment from a deal
+     * @param {DealInstallmentsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    deleteInstallment(requestParameters: DealInstallmentsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * Lists installments attached to a list of deals.  Only available in Growth and above plans.
+     * @summary List installments added to a list of deals
+     * @param {DealInstallmentsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    getInstallments(requestParameters: DealInstallmentsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
+    /**
+     * 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 Growth and above plans.
+     * @summary Add an installment to a deal
+     * @param {DealInstallmentsApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    postInstallment(requestParameters: DealInstallmentsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
+    /**
+     * Edits an installment added to a deal.  Only available in Growth and above plans.
+     * @summary Update an installment added to a deal
+     * @param {DealInstallmentsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    updateInstallment(requestParameters: DealInstallmentsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
+}