pipedrive 36.0.1 → 36.1.0

package/dist/versions/v2/api/project-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 { AddProjectField200Response } from '../models';
@@ -109,6 +109,14 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addProjectField(AddProjectFieldRequest: AddProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProjectField200Response>>;
+    /**
+     * Same as `addProjectField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Create one project field
+     * @param {AddProjectFieldRequest} AddProjectFieldRequest
+
+     * @throws {RequiredError}
+     */
+    addProjectFieldWithHttpInfo(AddProjectFieldRequest: AddProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddProjectField200Response>>>;
     /**
      * Adds new options to a project 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 project field options in bulk
@@ -118,6 +126,15 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addProjectFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `addProjectFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add project field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    addProjectFieldOptionsWithHttpInfo(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one project field
@@ -126,6 +143,14 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteProjectField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteProjectField200Response>>;
+    /**
+     * Same as `deleteProjectField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete one project field
+     * @param {string} field_code The unique code identifying the field
+
+     * @throws {RequiredError}
+     */
+    deleteProjectFieldWithHttpInfo(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteProjectField200Response>>>;
     /**
      * Removes existing options from a project 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 project field options in bulk
@@ -135,6 +160,15 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteProjectFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `deleteProjectFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete project field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    deleteProjectFieldOptionsWithHttpInfo(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Returns metadata about a specific project field.
      * @summary Get one project field
@@ -143,6 +177,14 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getProjectField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProjectField200Response>>;
+    /**
+     * Same as `getProjectField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one project field
+     * @param {string} field_code The unique code identifying the field
+
+     * @throws {RequiredError}
+     */
+    getProjectFieldWithHttpInfo(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddProjectField200Response>>>;
     /**
      * Returns metadata about all project fields in the company.
      * @summary Get all project fields
@@ -152,6 +194,15 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getProjectFields(limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProjectFields200Response>>;
+    /**
+     * Same as `getProjectFields`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all project fields
+     * @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}
+     */
+    getProjectFieldsWithHttpInfo(limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetProjectFields200Response>>>;
     /**
      * Updates a project 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 project field
@@ -161,6 +212,15 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateProjectField(field_code: string, UpdateProjectFieldRequest: UpdateProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProjectField200Response>>;
+    /**
+     * Same as `updateProjectField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update one project field
+     * @param {string} field_code The unique code identifying the field
+     * @param {UpdateProjectFieldRequest} UpdateProjectFieldRequest
+
+     * @throws {RequiredError}
+     */
+    updateProjectFieldWithHttpInfo(field_code: string, UpdateProjectFieldRequest: UpdateProjectFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddProjectField200Response>>>;
     /**
      * Updates existing options for a project 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 project field options in bulk
@@ -170,6 +230,15 @@ export declare const ProjectFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateProjectFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `updateProjectFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update project field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    updateProjectFieldOptionsWithHttpInfo(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
 };
 /**
  * ProjectFieldsApi - factory interface
@@ -184,6 +253,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     addProjectField(requestParameters: ProjectFieldsApiAddProjectFieldRequest): Promise<AddProjectField200Response>;
+    addProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiAddProjectFieldRequest): Promise<ApiResponse<AddProjectField200Response>>;
     /**
      * Adds new options to a project 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 project field options in bulk
@@ -192,6 +262,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     addProjectFieldOptions(requestParameters: ProjectFieldsApiAddProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    addProjectFieldOptionsWithHttpInfo(requestParameters: ProjectFieldsApiAddProjectFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one project field
@@ -200,6 +271,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     deleteProjectField(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise<DeleteProjectField200Response>;
+    deleteProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise<ApiResponse<DeleteProjectField200Response>>;
     /**
      * Removes existing options from a project 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 project field options in bulk
@@ -208,6 +280,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     deleteProjectFieldOptions(requestParameters: ProjectFieldsApiDeleteProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    deleteProjectFieldOptionsWithHttpInfo(requestParameters: ProjectFieldsApiDeleteProjectFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific project field.
      * @summary Get one project field
@@ -216,6 +289,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getProjectField(requestParameters: ProjectFieldsApiGetProjectFieldRequest): Promise<AddProjectField200Response>;
+    getProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiGetProjectFieldRequest): Promise<ApiResponse<AddProjectField200Response>>;
     /**
      * Returns metadata about all project fields in the company.
      * @summary Get all project fields
@@ -224,6 +298,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getProjectFields(requestParameters?: ProjectFieldsApiGetProjectFieldsRequest): Promise<GetProjectFields200Response>;
+    getProjectFieldsWithHttpInfo(requestParameters?: ProjectFieldsApiGetProjectFieldsRequest): Promise<ApiResponse<GetProjectFields200Response>>;
     /**
      * Updates a project 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 project field
@@ -232,6 +307,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     updateProjectField(requestParameters: ProjectFieldsApiUpdateProjectFieldRequest): Promise<AddProjectField200Response>;
+    updateProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiUpdateProjectFieldRequest): Promise<ApiResponse<AddProjectField200Response>>;
     /**
      * Updates existing options for a project 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 project field options in bulk
@@ -240,6 +316,7 @@ export declare const ProjectFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     updateProjectFieldOptions(requestParameters: ProjectFieldsApiUpdateProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    updateProjectFieldOptionsWithHttpInfo(requestParameters: ProjectFieldsApiUpdateProjectFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 };
 /**
  * Request parameters for addProjectField operation in ProjectFieldsApi.
@@ -391,6 +468,15 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     addProjectField(requestParameters: ProjectFieldsApiAddProjectFieldRequest): Promise<AddProjectField200Response>;
+    /**
+     * Same as `addProjectField`, 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 {ProjectFieldsApiAddProjectFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    addProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiAddProjectFieldRequest): Promise<ApiResponse<AddProjectField200Response>>;
     /**
      * Adds new options to a project 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 project field options in bulk
@@ -400,6 +486,15 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     addProjectFieldOptions(requestParameters: ProjectFieldsApiAddProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `addProjectFieldOptions`, 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 {ProjectFieldsApiAddProjectFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    addProjectFieldOptionsWithHttpInfo(requestParameters: ProjectFieldsApiAddProjectFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one project field
@@ -409,6 +504,15 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     deleteProjectField(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise<DeleteProjectField200Response>;
+    /**
+     * Same as `deleteProjectField`, 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 {ProjectFieldsApiDeleteProjectFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    deleteProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiDeleteProjectFieldRequest): Promise<ApiResponse<DeleteProjectField200Response>>;
     /**
      * Removes existing options from a project 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 project field options in bulk
@@ -418,6 +522,15 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     deleteProjectFieldOptions(requestParameters: ProjectFieldsApiDeleteProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `deleteProjectFieldOptions`, 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 {ProjectFieldsApiDeleteProjectFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    deleteProjectFieldOptionsWithHttpInfo(requestParameters: ProjectFieldsApiDeleteProjectFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific project field.
      * @summary Get one project field
@@ -427,6 +540,15 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     getProjectField(requestParameters: ProjectFieldsApiGetProjectFieldRequest): Promise<AddProjectField200Response>;
+    /**
+     * Same as `getProjectField`, 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 {ProjectFieldsApiGetProjectFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    getProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiGetProjectFieldRequest): Promise<ApiResponse<AddProjectField200Response>>;
     /**
      * Returns metadata about all project fields in the company.
      * @summary Get all project fields
@@ -436,6 +558,15 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     getProjectFields(requestParameters?: ProjectFieldsApiGetProjectFieldsRequest): Promise<GetProjectFields200Response>;
+    /**
+     * Same as `getProjectFields`, 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 {ProjectFieldsApiGetProjectFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    getProjectFieldsWithHttpInfo(requestParameters?: ProjectFieldsApiGetProjectFieldsRequest): Promise<ApiResponse<GetProjectFields200Response>>;
     /**
      * Updates a project 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 project field
@@ -445,6 +576,15 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     updateProjectField(requestParameters: ProjectFieldsApiUpdateProjectFieldRequest): Promise<AddProjectField200Response>;
+    /**
+     * Same as `updateProjectField`, 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 {ProjectFieldsApiUpdateProjectFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    updateProjectFieldWithHttpInfo(requestParameters: ProjectFieldsApiUpdateProjectFieldRequest): Promise<ApiResponse<AddProjectField200Response>>;
     /**
      * Updates existing options for a project 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 project field options in bulk
@@ -454,4 +594,13 @@ export declare class ProjectFieldsApi extends BaseAPI {
      * @memberof ProjectFieldsApi
      */
     updateProjectFieldOptions(requestParameters: ProjectFieldsApiUpdateProjectFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `updateProjectFieldOptions`, 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 {ProjectFieldsApiUpdateProjectFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProjectFieldsApi
+     */
+    updateProjectFieldOptionsWithHttpInfo(requestParameters: ProjectFieldsApiUpdateProjectFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 }