pipedrive 36.0.0 → 36.1.0

package/dist/esm/versions/v2/api/person-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 { AddDealFieldOptions200Response } from '../models';
 import { AddDealFieldOptionsRequestInner } from '../models';
 import { AddPersonField200Response } from '../models';
@@ -111,6 +111,14 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addPersonField(AddPersonFieldRequest: AddPersonFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddPersonField200Response>>;
+    /**
+     * Same as `addPersonField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Create one person field
+     * @param {AddPersonFieldRequest} AddPersonFieldRequest
+
+     * @throws {RequiredError}
+     */
+    addPersonFieldWithHttpInfo(AddPersonFieldRequest: AddPersonFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddPersonField200Response>>>;
     /**
      * Adds new options to a person 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 person field options in bulk
@@ -120,6 +128,15 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addPersonFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `addPersonFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add person field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    addPersonFieldOptionsWithHttpInfo(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one person field
@@ -128,6 +145,14 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deletePersonField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonField200Response>>;
+    /**
+     * Same as `deletePersonField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete one person field
+     * @param {string} field_code The unique code identifying the field
+
+     * @throws {RequiredError}
+     */
+    deletePersonFieldWithHttpInfo(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeletePersonField200Response>>>;
     /**
      * Removes existing options from a person 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 person field options in bulk
@@ -137,6 +162,15 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deletePersonFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `deletePersonFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete person field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    deletePersonFieldOptionsWithHttpInfo(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Returns metadata about a specific person field.
      * @summary Get one person field
@@ -146,6 +180,15 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPersonField(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddPersonField200Response>>;
+    /**
+     * Same as `getPersonField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one person 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}
+     */
+    getPersonFieldWithHttpInfo(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddPersonField200Response>>>;
     /**
      * Returns metadata about all person fields in the company.
      * @summary Get all person fields
@@ -156,6 +199,16 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPersonFields(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetPersonFields200Response>>;
+    /**
+     * Same as `getPersonFields`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all person 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}
+     */
+    getPersonFieldsWithHttpInfo(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetPersonFields200Response>>>;
     /**
      * Updates a person 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 person field
@@ -165,6 +218,15 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updatePersonField(field_code: string, UpdatePersonFieldRequest: UpdatePersonFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddPersonField200Response>>;
+    /**
+     * Same as `updatePersonField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update one person field
+     * @param {string} field_code The unique code identifying the field
+     * @param {UpdatePersonFieldRequest} UpdatePersonFieldRequest
+
+     * @throws {RequiredError}
+     */
+    updatePersonFieldWithHttpInfo(field_code: string, UpdatePersonFieldRequest: UpdatePersonFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddPersonField200Response>>>;
     /**
      * Updates existing options for a person 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 person field options in bulk
@@ -174,6 +236,15 @@ export declare const PersonFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updatePersonFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `updatePersonFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update person field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    updatePersonFieldOptionsWithHttpInfo(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
 };
 /**
  * PersonFieldsApi - factory interface
@@ -188,6 +259,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     addPersonField(requestParameters: PersonFieldsApiAddPersonFieldRequest): Promise<AddPersonField200Response>;
+    addPersonFieldWithHttpInfo(requestParameters: PersonFieldsApiAddPersonFieldRequest): Promise<ApiResponse<AddPersonField200Response>>;
     /**
      * Adds new options to a person 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 person field options in bulk
@@ -196,6 +268,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     addPersonFieldOptions(requestParameters: PersonFieldsApiAddPersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    addPersonFieldOptionsWithHttpInfo(requestParameters: PersonFieldsApiAddPersonFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one person field
@@ -204,6 +277,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     deletePersonField(requestParameters: PersonFieldsApiDeletePersonFieldRequest): Promise<DeletePersonField200Response>;
+    deletePersonFieldWithHttpInfo(requestParameters: PersonFieldsApiDeletePersonFieldRequest): Promise<ApiResponse<DeletePersonField200Response>>;
     /**
      * Removes existing options from a person 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 person field options in bulk
@@ -212,6 +286,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     deletePersonFieldOptions(requestParameters: PersonFieldsApiDeletePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    deletePersonFieldOptionsWithHttpInfo(requestParameters: PersonFieldsApiDeletePersonFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific person field.
      * @summary Get one person field
@@ -220,6 +295,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     getPersonField(requestParameters: PersonFieldsApiGetPersonFieldRequest): Promise<AddPersonField200Response>;
+    getPersonFieldWithHttpInfo(requestParameters: PersonFieldsApiGetPersonFieldRequest): Promise<ApiResponse<AddPersonField200Response>>;
     /**
      * Returns metadata about all person fields in the company.
      * @summary Get all person fields
@@ -228,6 +304,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     getPersonFields(requestParameters?: PersonFieldsApiGetPersonFieldsRequest): Promise<GetPersonFields200Response>;
+    getPersonFieldsWithHttpInfo(requestParameters?: PersonFieldsApiGetPersonFieldsRequest): Promise<ApiResponse<GetPersonFields200Response>>;
     /**
      * Updates a person 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 person field
@@ -236,6 +313,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     updatePersonField(requestParameters: PersonFieldsApiUpdatePersonFieldRequest): Promise<AddPersonField200Response>;
+    updatePersonFieldWithHttpInfo(requestParameters: PersonFieldsApiUpdatePersonFieldRequest): Promise<ApiResponse<AddPersonField200Response>>;
     /**
      * Updates existing options for a person 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 person field options in bulk
@@ -244,6 +322,7 @@ export declare const PersonFieldsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     updatePersonFieldOptions(requestParameters: PersonFieldsApiUpdatePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    updatePersonFieldOptionsWithHttpInfo(requestParameters: PersonFieldsApiUpdatePersonFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 };
 /**
  * Request parameters for addPersonField operation in PersonFieldsApi.
@@ -407,6 +486,15 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     addPersonField(requestParameters: PersonFieldsApiAddPersonFieldRequest): Promise<AddPersonField200Response>;
+    /**
+     * Same as `addPersonField`, 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 {PersonFieldsApiAddPersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    addPersonFieldWithHttpInfo(requestParameters: PersonFieldsApiAddPersonFieldRequest): Promise<ApiResponse<AddPersonField200Response>>;
     /**
      * Adds new options to a person 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 person field options in bulk
@@ -416,6 +504,15 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     addPersonFieldOptions(requestParameters: PersonFieldsApiAddPersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `addPersonFieldOptions`, 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 {PersonFieldsApiAddPersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    addPersonFieldOptionsWithHttpInfo(requestParameters: PersonFieldsApiAddPersonFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one person field
@@ -425,6 +522,15 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     deletePersonField(requestParameters: PersonFieldsApiDeletePersonFieldRequest): Promise<DeletePersonField200Response>;
+    /**
+     * Same as `deletePersonField`, 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 {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    deletePersonFieldWithHttpInfo(requestParameters: PersonFieldsApiDeletePersonFieldRequest): Promise<ApiResponse<DeletePersonField200Response>>;
     /**
      * Removes existing options from a person 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 person field options in bulk
@@ -434,6 +540,15 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     deletePersonFieldOptions(requestParameters: PersonFieldsApiDeletePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `deletePersonFieldOptions`, 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 {PersonFieldsApiDeletePersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    deletePersonFieldOptionsWithHttpInfo(requestParameters: PersonFieldsApiDeletePersonFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific person field.
      * @summary Get one person field
@@ -443,6 +558,15 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     getPersonField(requestParameters: PersonFieldsApiGetPersonFieldRequest): Promise<AddPersonField200Response>;
+    /**
+     * Same as `getPersonField`, 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 {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    getPersonFieldWithHttpInfo(requestParameters: PersonFieldsApiGetPersonFieldRequest): Promise<ApiResponse<AddPersonField200Response>>;
     /**
      * Returns metadata about all person fields in the company.
      * @summary Get all person fields
@@ -452,6 +576,15 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     getPersonFields(requestParameters?: PersonFieldsApiGetPersonFieldsRequest): Promise<GetPersonFields200Response>;
+    /**
+     * Same as `getPersonFields`, 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 {PersonFieldsApiGetPersonFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    getPersonFieldsWithHttpInfo(requestParameters?: PersonFieldsApiGetPersonFieldsRequest): Promise<ApiResponse<GetPersonFields200Response>>;
     /**
      * Updates a person 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 person field
@@ -461,6 +594,15 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     updatePersonField(requestParameters: PersonFieldsApiUpdatePersonFieldRequest): Promise<AddPersonField200Response>;
+    /**
+     * Same as `updatePersonField`, 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 {PersonFieldsApiUpdatePersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    updatePersonFieldWithHttpInfo(requestParameters: PersonFieldsApiUpdatePersonFieldRequest): Promise<ApiResponse<AddPersonField200Response>>;
     /**
      * Updates existing options for a person 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 person field options in bulk
@@ -470,4 +612,13 @@ export declare class PersonFieldsApi extends BaseAPI {
      * @memberof PersonFieldsApi
      */
     updatePersonFieldOptions(requestParameters: PersonFieldsApiUpdatePersonFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `updatePersonFieldOptions`, 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 {PersonFieldsApiUpdatePersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    updatePersonFieldOptionsWithHttpInfo(requestParameters: PersonFieldsApiUpdatePersonFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 }