pipedrive 36.0.0 → 36.1.0

package/dist/esm/versions/v2/api/organization-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 { AddOrganizationField200Response } from '../models';
@@ -111,6 +111,14 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     addOrganizationField(AddOrganizationFieldRequest: AddOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
+    /**
+     * Same as `addOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Create one organization field
+     * @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest
+
+     * @throws {RequiredError}
+     */
+    addOrganizationFieldWithHttpInfo(AddOrganizationFieldRequest: AddOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddOrganizationField200Response>>>;
     /**
      * Adds new options to an organization 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 organization field options in bulk
@@ -120,6 +128,15 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     addOrganizationFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `addOrganizationFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add organization field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    addOrganizationFieldOptionsWithHttpInfo(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one organization field
@@ -128,6 +145,14 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     deleteOrganizationField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonField200Response>>;
+    /**
+     * Same as `deleteOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete one organization field
+     * @param {string} field_code The unique code identifying the field
+
+     * @throws {RequiredError}
+     */
+    deleteOrganizationFieldWithHttpInfo(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeletePersonField200Response>>>;
     /**
      * Removes existing options from an organization 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 organization field options in bulk
@@ -137,6 +162,15 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     deleteOrganizationFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `deleteOrganizationFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete organization field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    deleteOrganizationFieldOptionsWithHttpInfo(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Returns metadata about a specific organization field.
      * @summary Get one organization field
@@ -146,6 +180,15 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     getOrganizationField(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
+    /**
+     * Same as `getOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one organization 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}
+     */
+    getOrganizationFieldWithHttpInfo(field_code: string, include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddOrganizationField200Response>>>;
     /**
      * Returns metadata about all organization fields in the company.
      * @summary Get all organization fields
@@ -156,6 +199,16 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     getOrganizationFields(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetOrganizationFields200Response>>;
+    /**
+     * Same as `getOrganizationFields`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all organization 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}
+     */
+    getOrganizationFieldsWithHttpInfo(include_fields?: Set<'ui_visibility' | 'important_fields' | 'required_fields'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetOrganizationFields200Response>>>;
     /**
      * Updates an organization 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 organization field
@@ -165,6 +218,15 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     updateOrganizationField(field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddOrganizationField200Response>>;
+    /**
+     * Same as `updateOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update one organization field
+     * @param {string} field_code The unique code identifying the field
+     * @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest
+
+     * @throws {RequiredError}
+     */
+    updateOrganizationFieldWithHttpInfo(field_code: string, UpdateOrganizationFieldRequest: UpdateOrganizationFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddOrganizationField200Response>>>;
     /**
      * Updates existing options for an organization 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 organization field options in bulk
@@ -174,6 +236,15 @@ export declare const OrganizationFieldsApiFp: (configuration?: Configuration) =>
      * @throws {RequiredError}
      */
     updateOrganizationFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `updateOrganizationFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update organization field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    updateOrganizationFieldOptionsWithHttpInfo(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
 };
 /**
  * OrganizationFieldsApi - factory interface
@@ -188,6 +259,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
+    addOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<ApiResponse<AddOrganizationField200Response>>;
     /**
      * Adds new options to an organization 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 organization field options in bulk
@@ -196,6 +268,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    addOrganizationFieldOptionsWithHttpInfo(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one organization field
@@ -204,6 +277,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<DeletePersonField200Response>;
+    deleteOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<ApiResponse<DeletePersonField200Response>>;
     /**
      * Removes existing options from an organization 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 organization field options in bulk
@@ -212,6 +286,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    deleteOrganizationFieldOptionsWithHttpInfo(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific organization field.
      * @summary Get one organization field
@@ -220,6 +295,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
+    getOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<ApiResponse<AddOrganizationField200Response>>;
     /**
      * Returns metadata about all organization fields in the company.
      * @summary Get all organization fields
@@ -228,6 +304,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getOrganizationFields(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<GetOrganizationFields200Response>;
+    getOrganizationFieldsWithHttpInfo(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<ApiResponse<GetOrganizationFields200Response>>;
     /**
      * Updates an organization 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 organization field
@@ -236,6 +313,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
+    updateOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<ApiResponse<AddOrganizationField200Response>>;
     /**
      * Updates existing options for an organization 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 organization field options in bulk
@@ -244,6 +322,7 @@ export declare const OrganizationFieldsApiFactory: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    updateOrganizationFieldOptionsWithHttpInfo(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 };
 /**
  * Request parameters for addOrganizationField operation in OrganizationFieldsApi.
@@ -407,6 +486,15 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     addOrganizationField(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
+    /**
+     * Same as `addOrganizationField`, 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 {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    addOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiAddOrganizationFieldRequest): Promise<ApiResponse<AddOrganizationField200Response>>;
     /**
      * Adds new options to an organization 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 organization field options in bulk
@@ -416,6 +504,15 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     addOrganizationFieldOptions(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `addOrganizationFieldOptions`, 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 {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    addOrganizationFieldOptionsWithHttpInfo(requestParameters: OrganizationFieldsApiAddOrganizationFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one organization field
@@ -425,6 +522,15 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     deleteOrganizationField(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<DeletePersonField200Response>;
+    /**
+     * Same as `deleteOrganizationField`, 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 {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    deleteOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldRequest): Promise<ApiResponse<DeletePersonField200Response>>;
     /**
      * Removes existing options from an organization 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 organization field options in bulk
@@ -434,6 +540,15 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     deleteOrganizationFieldOptions(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `deleteOrganizationFieldOptions`, 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 {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    deleteOrganizationFieldOptionsWithHttpInfo(requestParameters: OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific organization field.
      * @summary Get one organization field
@@ -443,6 +558,15 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     getOrganizationField(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
+    /**
+     * Same as `getOrganizationField`, 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 {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    getOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiGetOrganizationFieldRequest): Promise<ApiResponse<AddOrganizationField200Response>>;
     /**
      * Returns metadata about all organization fields in the company.
      * @summary Get all organization fields
@@ -452,6 +576,15 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     getOrganizationFields(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<GetOrganizationFields200Response>;
+    /**
+     * Same as `getOrganizationFields`, 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 {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    getOrganizationFieldsWithHttpInfo(requestParameters?: OrganizationFieldsApiGetOrganizationFieldsRequest): Promise<ApiResponse<GetOrganizationFields200Response>>;
     /**
      * Updates an organization 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 organization field
@@ -461,6 +594,15 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     updateOrganizationField(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<AddOrganizationField200Response>;
+    /**
+     * Same as `updateOrganizationField`, 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 {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    updateOrganizationFieldWithHttpInfo(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldRequest): Promise<ApiResponse<AddOrganizationField200Response>>;
     /**
      * Updates existing options for an organization 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 organization field options in bulk
@@ -470,4 +612,13 @@ export declare class OrganizationFieldsApi extends BaseAPI {
      * @memberof OrganizationFieldsApi
      */
     updateOrganizationFieldOptions(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `updateOrganizationFieldOptions`, 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 {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    updateOrganizationFieldOptionsWithHttpInfo(requestParameters: OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 }