pipedrive 36.0.0 → 36.1.0

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

@@ -359,6 +359,19 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addDealField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Create one deal field
+         * @param {AddDealFieldRequest} AddDealFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addDealFieldWithHttpInfo(AddDealFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealField(AddDealFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
          * @summary Add deal field options in bulk
@@ -373,6 +386,20 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addDealFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addDealFieldOptionsWithHttpInfo(field_code, AddDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealFieldOptions(field_code, AddDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one deal field
@@ -386,6 +413,19 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteDealField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete one deal field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deleteDealFieldWithHttpInfo(field_code) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealField(field_code);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
          * @summary Delete deal field options in bulk
@@ -400,6 +440,20 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteDealFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deleteDealFieldOptionsWithHttpInfo(field_code, DeleteDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealFieldOptions(field_code, DeleteDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about a specific deal field.
          * @summary Get one deal field
@@ -414,6 +468,20 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getDealField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get one deal field
+         * @param {string} field_code The unique code identifying the field
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+         * @throws {RequiredError}
+         */
+        getDealFieldWithHttpInfo(field_code, include_fields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealField(field_code, include_fields);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about all deal fields in the company.
          * @summary Get all deal fields
@@ -429,6 +497,21 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getDealFields`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all deal fields
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @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 {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getDealFieldsWithHttpInfo(include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFields(include_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
          * @summary Update one deal field
@@ -443,6 +526,20 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateDealField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update one deal field
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdateDealFieldRequest} UpdateDealFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updateDealFieldWithHttpInfo(field_code, UpdateDealFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateDealField(field_code, UpdateDealFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
          * @summary Update deal field options in bulk
@@ -457,6 +554,20 @@ export const DealFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateDealFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update deal field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updateDealFieldOptionsWithHttpInfo(field_code, UpdateDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateDealFieldOptions(field_code, UpdateDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 /**
@@ -476,6 +587,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         addDealField(requestParameters) {
             return localVarFp.addDealField(requestParameters.AddDealFieldRequest).then((request) => request(axios, basePath));
         },
+        addDealFieldWithHttpInfo(requestParameters) {
+            return localVarFp.addDealFieldWithHttpInfo(requestParameters.AddDealFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
          * @summary Add deal field options in bulk
@@ -486,6 +600,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         addDealFieldOptions(requestParameters) {
             return localVarFp.addDealFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        addDealFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.addDealFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one deal field
@@ -496,6 +613,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         deleteDealField(requestParameters) {
             return localVarFp.deleteDealField(requestParameters.field_code).then((request) => request(axios, basePath));
         },
+        deleteDealFieldWithHttpInfo(requestParameters) {
+            return localVarFp.deleteDealFieldWithHttpInfo(requestParameters.field_code).then((request) => request(axios, basePath));
+        },
         /**
          * Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
          * @summary Delete deal field options in bulk
@@ -506,6 +626,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         deleteDealFieldOptions(requestParameters) {
             return localVarFp.deleteDealFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        deleteDealFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.deleteDealFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about a specific deal field.
          * @summary Get one deal field
@@ -516,6 +639,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         getDealField(requestParameters) {
             return localVarFp.getDealField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
         },
+        getDealFieldWithHttpInfo(requestParameters) {
+            return localVarFp.getDealFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about all deal fields in the company.
          * @summary Get all deal fields
@@ -526,6 +652,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         getDealFields(requestParameters = {}) {
             return localVarFp.getDealFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
+        getDealFieldsWithHttpInfo(requestParameters = {}) {
+            return localVarFp.getDealFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
          * @summary Update one deal field
@@ -536,6 +665,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         updateDealField(requestParameters) {
             return localVarFp.updateDealField(requestParameters.field_code, requestParameters.UpdateDealFieldRequest).then((request) => request(axios, basePath));
         },
+        updateDealFieldWithHttpInfo(requestParameters) {
+            return localVarFp.updateDealFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
          * @summary Update deal field options in bulk
@@ -546,6 +678,9 @@ export const DealFieldsApiFactory = function (configuration, basePath, axios) {
         updateDealFieldOptions(requestParameters) {
             return localVarFp.updateDealFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        updateDealFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.updateDealFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -566,6 +701,17 @@ export class DealFieldsApi extends BaseAPI {
     addDealField(requestParameters) {
         return DealFieldsApiFp(this.configuration).addDealField(requestParameters.AddDealFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addDealField`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiAddDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    addDealFieldWithHttpInfo(requestParameters) {
+        return DealFieldsApiFp(this.configuration).addDealFieldWithHttpInfo(requestParameters.AddDealFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds new options to a deal custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
      * @summary Add deal field options in bulk
@@ -577,6 +723,17 @@ export class DealFieldsApi extends BaseAPI {
     addDealFieldOptions(requestParameters) {
         return DealFieldsApiFp(this.configuration).addDealFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addDealFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiAddDealFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    addDealFieldOptionsWithHttpInfo(requestParameters) {
+        return DealFieldsApiFp(this.configuration).addDealFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Marks a custom field as deleted.
      * @summary Delete one deal field
@@ -588,6 +745,17 @@ export class DealFieldsApi extends BaseAPI {
     deleteDealField(requestParameters) {
         return DealFieldsApiFp(this.configuration).deleteDealField(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteDealField`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiDeleteDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    deleteDealFieldWithHttpInfo(requestParameters) {
+        return DealFieldsApiFp(this.configuration).deleteDealFieldWithHttpInfo(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Removes existing options from a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
      * @summary Delete deal field options in bulk
@@ -599,6 +767,17 @@ export class DealFieldsApi extends BaseAPI {
     deleteDealFieldOptions(requestParameters) {
         return DealFieldsApiFp(this.configuration).deleteDealFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteDealFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiDeleteDealFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    deleteDealFieldOptionsWithHttpInfo(requestParameters) {
+        return DealFieldsApiFp(this.configuration).deleteDealFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about a specific deal field.
      * @summary Get one deal field
@@ -610,6 +789,17 @@ export class DealFieldsApi extends BaseAPI {
     getDealField(requestParameters) {
         return DealFieldsApiFp(this.configuration).getDealField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getDealField`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiGetDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    getDealFieldWithHttpInfo(requestParameters) {
+        return DealFieldsApiFp(this.configuration).getDealFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about all deal fields in the company.
      * @summary Get all deal fields
@@ -621,6 +811,17 @@ export class DealFieldsApi extends BaseAPI {
     getDealFields(requestParameters = {}) {
         return DealFieldsApiFp(this.configuration).getDealFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getDealFields`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiGetDealFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    getDealFieldsWithHttpInfo(requestParameters = {}) {
+        return DealFieldsApiFp(this.configuration).getDealFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates a deal custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
      * @summary Update one deal field
@@ -632,6 +833,17 @@ export class DealFieldsApi extends BaseAPI {
     updateDealField(requestParameters) {
         return DealFieldsApiFp(this.configuration).updateDealField(requestParameters.field_code, requestParameters.UpdateDealFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateDealField`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiUpdateDealFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    updateDealFieldWithHttpInfo(requestParameters) {
+        return DealFieldsApiFp(this.configuration).updateDealFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates existing options for a deal custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
      * @summary Update deal field options in bulk
@@ -643,4 +855,15 @@ export class DealFieldsApi extends BaseAPI {
     updateDealFieldOptions(requestParameters) {
         return DealFieldsApiFp(this.configuration).updateDealFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateDealFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealFieldsApiUpdateDealFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealFieldsApi
+     */
+    updateDealFieldOptionsWithHttpInfo(requestParameters) {
+        return DealFieldsApiFp(this.configuration).updateDealFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
 }

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

@@ -11,7 +11,7 @@
  */
 import type { Configuration } from '../configuration';
 import type { AxiosInstance } from 'axios';
-import { RequestArgs, BaseAPI } from '../base';
+import { RequestArgs, BaseAPI, ApiResponse } from '../base';
 import { AddAInstallmentResponse } from '../models';
 import { AddInstallmentRequestBody } from '../models';
 import { DeleteInstallmentResponse } from '../models';
@@ -78,6 +78,15 @@ export declare const DealInstallmentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteInstallment(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteInstallmentResponse>>;
+    /**
+     * Same as `deleteInstallment`, but resolves with the response body together with the HTTP status and headers.
+     * @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}
+     */
+    deleteInstallmentWithHttpInfo(id: number, installment_id: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<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
@@ -90,6 +99,18 @@ export declare const DealInstallmentsApiFp: (configuration?: Configuration) => {
      * @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>>;
+    /**
+     * Same as `getInstallments`, but resolves with the response body together with the HTTP status and headers.
+     * @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}
+     */
+    getInstallmentsWithHttpInfo(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<ApiResponse<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
@@ -99,6 +120,15 @@ export declare const DealInstallmentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postInstallment(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddAInstallmentResponse>>;
+    /**
+     * Same as `postInstallment`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add an installment to a deal
+     * @param {number} id The ID of the deal
+     * @param {AddInstallmentRequestBody} [AddInstallmentRequestBody]
+
+     * @throws {RequiredError}
+     */
+    postInstallmentWithHttpInfo(id: number, AddInstallmentRequestBody?: AddInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddAInstallmentResponse>>>;
     /**
      * Edits an installment added to a deal.  Only available in Growth and above plans.
      * @summary Update an installment added to a deal
@@ -109,6 +139,16 @@ export declare const DealInstallmentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateInstallment(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateInstallmentResponse>>;
+    /**
+     * Same as `updateInstallment`, but resolves with the response body together with the HTTP status and headers.
+     * @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}
+     */
+    updateInstallmentWithHttpInfo(id: number, installment_id: number, UpdateInstallmentRequestBody?: UpdateInstallmentRequestBody): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpdateInstallmentResponse>>>;
 };
 /**
  * DealInstallmentsApi - factory interface
@@ -123,6 +163,7 @@ export declare const DealInstallmentsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     deleteInstallment(requestParameters: DealInstallmentsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    deleteInstallmentWithHttpInfo(requestParameters: DealInstallmentsApiDeleteInstallmentRequest): Promise<ApiResponse<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
@@ -131,6 +172,7 @@ export declare const DealInstallmentsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     getInstallments(requestParameters: DealInstallmentsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
+    getInstallmentsWithHttpInfo(requestParameters: DealInstallmentsApiGetInstallmentsRequest): Promise<ApiResponse<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
@@ -139,6 +181,7 @@ export declare const DealInstallmentsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     postInstallment(requestParameters: DealInstallmentsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
+    postInstallmentWithHttpInfo(requestParameters: DealInstallmentsApiPostInstallmentRequest): Promise<ApiResponse<AddAInstallmentResponse>>;
     /**
      * Edits an installment added to a deal.  Only available in Growth and above plans.
      * @summary Update an installment added to a deal
@@ -147,6 +190,7 @@ export declare const DealInstallmentsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     updateInstallment(requestParameters: DealInstallmentsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
+    updateInstallmentWithHttpInfo(requestParameters: DealInstallmentsApiUpdateInstallmentRequest): Promise<ApiResponse<UpdateInstallmentResponse>>;
 };
 /**
  * Request parameters for deleteInstallment operation in DealInstallmentsApi.
@@ -264,6 +308,15 @@ export declare class DealInstallmentsApi extends BaseAPI {
      * @memberof DealInstallmentsApi
      */
     deleteInstallment(requestParameters: DealInstallmentsApiDeleteInstallmentRequest): Promise<DeleteInstallmentResponse>;
+    /**
+     * Same as `deleteInstallment`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealInstallmentsApiDeleteInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    deleteInstallmentWithHttpInfo(requestParameters: DealInstallmentsApiDeleteInstallmentRequest): Promise<ApiResponse<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
@@ -273,6 +326,15 @@ export declare class DealInstallmentsApi extends BaseAPI {
      * @memberof DealInstallmentsApi
      */
     getInstallments(requestParameters: DealInstallmentsApiGetInstallmentsRequest): Promise<GetInstallmentsResponse>;
+    /**
+     * Same as `getInstallments`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealInstallmentsApiGetInstallmentsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    getInstallmentsWithHttpInfo(requestParameters: DealInstallmentsApiGetInstallmentsRequest): Promise<ApiResponse<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
@@ -282,6 +344,15 @@ export declare class DealInstallmentsApi extends BaseAPI {
      * @memberof DealInstallmentsApi
      */
     postInstallment(requestParameters: DealInstallmentsApiPostInstallmentRequest): Promise<AddAInstallmentResponse>;
+    /**
+     * Same as `postInstallment`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealInstallmentsApiPostInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    postInstallmentWithHttpInfo(requestParameters: DealInstallmentsApiPostInstallmentRequest): Promise<ApiResponse<AddAInstallmentResponse>>;
     /**
      * Edits an installment added to a deal.  Only available in Growth and above plans.
      * @summary Update an installment added to a deal
@@ -291,4 +362,13 @@ export declare class DealInstallmentsApi extends BaseAPI {
      * @memberof DealInstallmentsApi
      */
     updateInstallment(requestParameters: DealInstallmentsApiUpdateInstallmentRequest): Promise<UpdateInstallmentResponse>;
+    /**
+     * Same as `updateInstallment`, but resolves with the response body together with the HTTP status and headers.
+     * Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
+     * @param {DealInstallmentsApiUpdateInstallmentRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealInstallmentsApi
+     */
+    updateInstallmentWithHttpInfo(requestParameters: DealInstallmentsApiUpdateInstallmentRequest): Promise<ApiResponse<UpdateInstallmentResponse>>;
 }