pipedrive 36.0.0 → 36.1.0

package/dist/versions/v2/api/product-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 { AddProductField200Response } from '../models';
@@ -111,6 +111,14 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addProductField(AddProductFieldRequest: AddProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
+    /**
+     * Same as `addProductField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Create one product field
+     * @param {AddProductFieldRequest} AddProductFieldRequest
+
+     * @throws {RequiredError}
+     */
+    addProductFieldWithHttpInfo(AddProductFieldRequest: AddProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddProductField200Response>>>;
     /**
      * Adds new options to a product 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 product field options in bulk
@@ -120,6 +128,15 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addProductFieldOptions(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `addProductFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add product field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    addProductFieldOptionsWithHttpInfo(field_code: string, AddDealFieldOptionsRequestInner: AddDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one product field
@@ -128,6 +145,14 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteProductField(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeletePersonField200Response>>;
+    /**
+     * Same as `deleteProductField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete one product field
+     * @param {string} field_code The unique code identifying the field
+
+     * @throws {RequiredError}
+     */
+    deleteProductFieldWithHttpInfo(field_code: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeletePersonField200Response>>>;
     /**
      * Removes existing options from a product 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 product field options in bulk
@@ -137,6 +162,15 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteProductFieldOptions(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `deleteProductFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete product field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    deleteProductFieldOptionsWithHttpInfo(field_code: string, DeleteDealFieldOptionsRequestInner: DeleteDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
     /**
      * Returns metadata about a specific product field.
      * @summary Get one product field
@@ -146,6 +180,15 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getProductField(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
+    /**
+     * Same as `getProductField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get one product field
+     * @param {string} field_code The unique code identifying the field
+     * @param {Set<'ui_visibility'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+     * @throws {RequiredError}
+     */
+    getProductFieldWithHttpInfo(field_code: string, include_fields?: Set<'ui_visibility'>): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddProductField200Response>>>;
     /**
      * Returns metadata about all product fields in the company.
      * @summary Get all product fields
@@ -156,6 +199,16 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getProductFields(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetProductFields200Response>>;
+    /**
+     * Same as `getProductFields`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all product fields
+     * @param {Set<'ui_visibility'>} [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}
+     */
+    getProductFieldsWithHttpInfo(include_fields?: Set<'ui_visibility'>, limit?: number, cursor?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetProductFields200Response>>>;
     /**
      * Updates a product 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 product field
@@ -165,6 +218,15 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateProductField(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddProductField200Response>>;
+    /**
+     * Same as `updateProductField`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update one product field
+     * @param {string} field_code The unique code identifying the field
+     * @param {UpdateProductFieldRequest} UpdateProductFieldRequest
+
+     * @throws {RequiredError}
+     */
+    updateProductFieldWithHttpInfo(field_code: string, UpdateProductFieldRequest: UpdateProductFieldRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddProductField200Response>>>;
     /**
      * Updates existing options for a product 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 product field options in bulk
@@ -174,6 +236,15 @@ export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateProductFieldOptions(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddDealFieldOptions200Response>>;
+    /**
+     * Same as `updateProductFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update product field options in bulk
+     * @param {string} field_code The unique code identifying the field
+     * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+     * @throws {RequiredError}
+     */
+    updateProductFieldOptionsWithHttpInfo(field_code: string, UpdateDealFieldOptionsRequestInner: UpdateDealFieldOptionsRequestInner[]): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<AddDealFieldOptions200Response>>>;
 };
 /**
  * ProductFieldsApi - factory interface
@@ -188,6 +259,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<AddProductField200Response>;
+    addProductFieldWithHttpInfo(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<ApiResponse<AddProductField200Response>>;
     /**
      * Adds new options to a product 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 product field options in bulk
@@ -196,6 +268,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     addProductFieldOptions(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    addProductFieldOptionsWithHttpInfo(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one product field
@@ -204,6 +277,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest): Promise<DeletePersonField200Response>;
+    deleteProductFieldWithHttpInfo(requestParameters: ProductFieldsApiDeleteProductFieldRequest): Promise<ApiResponse<DeletePersonField200Response>>;
     /**
      * Removes existing options from a product 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 product field options in bulk
@@ -212,6 +286,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     deleteProductFieldOptions(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    deleteProductFieldOptionsWithHttpInfo(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific product field.
      * @summary Get one product field
@@ -220,6 +295,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<AddProductField200Response>;
+    getProductFieldWithHttpInfo(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<ApiResponse<AddProductField200Response>>;
     /**
      * Returns metadata about all product fields in the company.
      * @summary Get all product fields
@@ -228,6 +304,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetProductFields200Response>;
+    getProductFieldsWithHttpInfo(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<ApiResponse<GetProductFields200Response>>;
     /**
      * Updates a product 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 product field
@@ -236,6 +313,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<AddProductField200Response>;
+    updateProductFieldWithHttpInfo(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<ApiResponse<AddProductField200Response>>;
     /**
      * Updates existing options for a product 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 product field options in bulk
@@ -244,6 +322,7 @@ export declare const ProductFieldsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     updateProductFieldOptions(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    updateProductFieldOptionsWithHttpInfo(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 };
 /**
  * Request parameters for addProductField operation in ProductFieldsApi.
@@ -407,6 +486,15 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     addProductField(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<AddProductField200Response>;
+    /**
+     * Same as `addProductField`, 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 {ProductFieldsApiAddProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    addProductFieldWithHttpInfo(requestParameters: ProductFieldsApiAddProductFieldRequest): Promise<ApiResponse<AddProductField200Response>>;
     /**
      * Adds new options to a product 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 product field options in bulk
@@ -416,6 +504,15 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     addProductFieldOptions(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `addProductFieldOptions`, 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 {ProductFieldsApiAddProductFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    addProductFieldOptionsWithHttpInfo(requestParameters: ProductFieldsApiAddProductFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Marks a custom field as deleted.
      * @summary Delete one product field
@@ -425,6 +522,15 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest): Promise<DeletePersonField200Response>;
+    /**
+     * Same as `deleteProductField`, 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 {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    deleteProductFieldWithHttpInfo(requestParameters: ProductFieldsApiDeleteProductFieldRequest): Promise<ApiResponse<DeletePersonField200Response>>;
     /**
      * Removes existing options from a product 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 product field options in bulk
@@ -434,6 +540,15 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     deleteProductFieldOptions(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `deleteProductFieldOptions`, 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 {ProductFieldsApiDeleteProductFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    deleteProductFieldOptionsWithHttpInfo(requestParameters: ProductFieldsApiDeleteProductFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
     /**
      * Returns metadata about a specific product field.
      * @summary Get one product field
@@ -443,6 +558,15 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<AddProductField200Response>;
+    /**
+     * Same as `getProductField`, 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 {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    getProductFieldWithHttpInfo(requestParameters: ProductFieldsApiGetProductFieldRequest): Promise<ApiResponse<AddProductField200Response>>;
     /**
      * Returns metadata about all product fields in the company.
      * @summary Get all product fields
@@ -452,6 +576,15 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     getProductFields(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<GetProductFields200Response>;
+    /**
+     * Same as `getProductFields`, 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 {ProductFieldsApiGetProductFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    getProductFieldsWithHttpInfo(requestParameters?: ProductFieldsApiGetProductFieldsRequest): Promise<ApiResponse<GetProductFields200Response>>;
     /**
      * Updates a product 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 product field
@@ -461,6 +594,15 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<AddProductField200Response>;
+    /**
+     * Same as `updateProductField`, 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 {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    updateProductFieldWithHttpInfo(requestParameters: ProductFieldsApiUpdateProductFieldRequest): Promise<ApiResponse<AddProductField200Response>>;
     /**
      * Updates existing options for a product 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 product field options in bulk
@@ -470,4 +612,13 @@ export declare class ProductFieldsApi extends BaseAPI {
      * @memberof ProductFieldsApi
      */
     updateProductFieldOptions(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest): Promise<AddDealFieldOptions200Response>;
+    /**
+     * Same as `updateProductFieldOptions`, 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 {ProductFieldsApiUpdateProductFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    updateProductFieldOptionsWithHttpInfo(requestParameters: ProductFieldsApiUpdateProductFieldOptionsRequest): Promise<ApiResponse<AddDealFieldOptions200Response>>;
 }