pipedrive 36.0.1 → 36.1.0

package/dist/esm/versions/v2/api/deal-fields-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 { AddDealField200Response } from '../models';
 import { AddDealFieldOptions200Response } from '../models';
 import { AddDealFieldOptionsRequestInner } from '../models';
@@ -111,6 +111,14 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addDealField(AddDealFieldRequest: AddDealFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
+    /**
+     * 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: AddDealFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealField200Response>>>;
     /**
      * 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
@@ -120,6 +128,15 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addDealFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * 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: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one deal field
@@ -128,6 +145,14 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteDealField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteDealField200Response>>;
+    /**
+     * 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: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteDealField200Response>>>;
     /**
      * 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
@@ -137,6 +162,15 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteDealFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * 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: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Returns metadata about a specific deal field.
      * @summary Get one deal field
@@ -146,6 +180,15 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getDealField(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
+    /**
+     * 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: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealField200Response>>>;
     /**
      * Returns metadata about all deal fields in the company.
      * @summary Get all deal fields
@@ -156,6 +199,16 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getDealFields(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetDealFields200Response>>;
+    /**
+     * 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?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetDealFields200Response>>>;
     /**
      * 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
@@ -165,6 +218,15 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateDealField(field_code: string, UpdateDealFieldRequest: UpdateDealFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealField200Response>>;
+    /**
+     * 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: string, UpdateDealFieldRequest: UpdateDealFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealField200Response>>>;
     /**
      * 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
@@ -174,6 +236,15 @@ export declare const DealFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateDealFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * 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: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
 };
 /**
  * DealFieldsApi - factory interface
@@ -188,6 +259,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     addDealField(requestParameters: DealFieldsApiAddDealFieldRequest): Promise<AddDealField200Response>;
+    addDealFieldWithHttpInfo(requestParameters: DealFieldsApiAddDealFieldRequest): Promise<ApiResponse<AddDealField200Response>>;
     /**
      * 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
@@ -196,6 +268,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     addDealFieldOptions(requestParameters: DealFieldsApiAddDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    addDealFieldOptionsWithHttpInfo(requestParameters: DealFieldsApiAddDealFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one deal field
@@ -204,6 +277,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     deleteDealField(requestParameters: DealFieldsApiDeleteDealFieldRequest): Promise<DeleteDealField200Response>;
+    deleteDealFieldWithHttpInfo(requestParameters: DealFieldsApiDeleteDealFieldRequest): Promise<ApiResponse<DeleteDealField200Response>>;
     /**
      * 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
@@ -212,6 +286,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     deleteDealFieldOptions(requestParameters: DealFieldsApiDeleteDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    deleteDealFieldOptionsWithHttpInfo(requestParameters: DealFieldsApiDeleteDealFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific deal field.
      * @summary Get one deal field
@@ -220,6 +295,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getDealField(requestParameters: DealFieldsApiGetDealFieldRequest): Promise<AddDealField200Response>;
+    getDealFieldWithHttpInfo(requestParameters: DealFieldsApiGetDealFieldRequest): Promise<ApiResponse<AddDealField200Response>>;
     /**
      * Returns metadata about all deal fields in the company.
      * @summary Get all deal fields
@@ -228,6 +304,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getDealFields(requestParameters?: DealFieldsApiGetDealFieldsRequest): Promise<GetDealFields200Response>;
+    getDealFieldsWithHttpInfo(requestParameters?: DealFieldsApiGetDealFieldsRequest): Promise<ApiResponse<GetDealFields200Response>>;
     /**
      * 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
@@ -236,6 +313,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     updateDealField(requestParameters: DealFieldsApiUpdateDealFieldRequest): Promise<AddDealField200Response>;
+    updateDealFieldWithHttpInfo(requestParameters: DealFieldsApiUpdateDealFieldRequest): Promise<ApiResponse<AddDealField200Response>>;
     /**
      * 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
@@ -244,6 +322,7 @@ export declare const DealFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     updateDealFieldOptions(requestParameters: DealFieldsApiUpdateDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    updateDealFieldOptionsWithHttpInfo(requestParameters: DealFieldsApiUpdateDealFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 };
 /**
  * Request parameters for addDealField operation in DealFieldsApi.
@@ -407,6 +486,15 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     addDealField(requestParameters: DealFieldsApiAddDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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: DealFieldsApiAddDealFieldRequest): Promise<ApiResponse<AddDealField200Response>>;
     /**
      * 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
@@ -416,6 +504,15 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     addDealFieldOptions(requestParameters: DealFieldsApiAddDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * 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: DealFieldsApiAddDealFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one deal field
@@ -425,6 +522,15 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     deleteDealField(requestParameters: DealFieldsApiDeleteDealFieldRequest): Promise<DeleteDealField200Response>;
+    /**
+     * 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: DealFieldsApiDeleteDealFieldRequest): Promise<ApiResponse<DeleteDealField200Response>>;
     /**
      * 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
@@ -434,6 +540,15 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     deleteDealFieldOptions(requestParameters: DealFieldsApiDeleteDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * 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: DealFieldsApiDeleteDealFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific deal field.
      * @summary Get one deal field
@@ -443,6 +558,15 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     getDealField(requestParameters: DealFieldsApiGetDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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: DealFieldsApiGetDealFieldRequest): Promise<ApiResponse<AddDealField200Response>>;
     /**
      * Returns metadata about all deal fields in the company.
      * @summary Get all deal fields
@@ -452,6 +576,15 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     getDealFields(requestParameters?: DealFieldsApiGetDealFieldsRequest): Promise<GetDealFields200Response>;
+    /**
+     * 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?: DealFieldsApiGetDealFieldsRequest): Promise<ApiResponse<GetDealFields200Response>>;
     /**
      * 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
@@ -461,6 +594,15 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     updateDealField(requestParameters: DealFieldsApiUpdateDealFieldRequest): Promise<AddDealField200Response>;
+    /**
+     * 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: DealFieldsApiUpdateDealFieldRequest): Promise<ApiResponse<AddDealField200Response>>;
     /**
      * 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
@@ -470,4 +612,13 @@ export declare class DealFieldsApi extends BaseAPI {
      * @memberof DealFieldsApi
      */
     updateDealFieldOptions(requestParameters: DealFieldsApiUpdateDealFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * 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: DealFieldsApiUpdateDealFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 }