Build 356 - version-minor

CHANGELOG.md

@@ -7,6 +7,15 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e
 For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19).
 
 ## [Unreleased]
+### Added
+- Every API method now has a `WithHttpInfo` variant (e.g. `getDealWithHttpInfo`) that resolves with `{ data, status, headers }`, so the HTTP status and response headers, such as rate limit headers, can be read. The existing methods are unchanged and still return only the response body.
+- When a `WithHttpInfo` call fails, the rejected error keeps its usual fields and also carries `$response: { status, headers }`, so headers on error responses (e.g. `Retry-After` on a 429) are available too.
+- Exported the `ApiResponse<T>` type for typing these results.
+Example usage, if you want to include it:
+```typescript
+const { data, status, headers } = await api.getDealWithHttpInfo({ id: 1 });
+console.log(headers['x-ratelimit-remaining']);
+```
 
 ## [36.0.1] - 2026-10-13
 ### Fixed

src/versions/v1/api/activity-fields-api.ts

@@ -20,7 +20,7 @@ import globalAxios from 'axios';
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
 // @ts-ignore
-import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, ApiResponse } from '../base';
 // @ts-ignore
 import { GetFieldsResponse } from '../models';
 /**
@@ -87,6 +87,16 @@ export const ActivityFieldsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getActivityFields();
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Same as `getActivityFields`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all activity fields
+
+         * @throws {RequiredError}
+         */
+        async getActivityFieldsWithHttpInfo(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFieldsResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getActivityFields();
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+        },
     }
 };
 
@@ -106,6 +116,9 @@ export const ActivityFieldsApiFactory = function (configuration?: Configuration,
         getActivityFields(): Promise<GetFieldsResponse> {
             return localVarFp.getActivityFields().then((request) => request(axios, basePath));
         },
+        getActivityFieldsWithHttpInfo(): Promise<ApiResponse<GetFieldsResponse>> {
+            return localVarFp.getActivityFieldsWithHttpInfo().then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -126,4 +139,15 @@ export class ActivityFieldsApi extends BaseAPI {
     public getActivityFields() {
         return ActivityFieldsApiFp(this.configuration).getActivityFields().then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Same as `getActivityFields`, 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 }`.
+
+     * @throws {RequiredError}
+     * @memberof ActivityFieldsApi
+     */
+    public getActivityFieldsWithHttpInfo() {
+        return ActivityFieldsApiFp(this.configuration).getActivityFieldsWithHttpInfo().then((request) => request(this.axios, this.basePath));
+    }
 }

src/versions/v1/api/activity-types-api.ts

@@ -20,7 +20,7 @@ import globalAxios from 'axios';
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
 // @ts-ignore
-import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, ApiResponse } from '../base';
 // @ts-ignore
 import { AddActivityTypeRequest } from '../models';
 // @ts-ignore
@@ -221,6 +221,17 @@ export const ActivityTypesApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.addActivityType(AddActivityTypeRequest, );
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Same as `addActivityType`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add new activity type
+         * @param {AddActivityTypeRequest} [AddActivityTypeRequest] 
+
+         * @throws {RequiredError}
+         */
+        async addActivityTypeWithHttpInfo(AddActivityTypeRequest?: AddActivityTypeRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertActivityTypeResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.addActivityType(AddActivityTypeRequest, );
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+        },
         /**
          * Marks an activity type as deleted.
          * @summary Delete an activity type
@@ -232,6 +243,17 @@ export const ActivityTypesApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActivityType(id, );
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Same as `deleteActivityType`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete an activity type
+         * @param {number} id The ID of the activity type
+
+         * @throws {RequiredError}
+         */
+        async deleteActivityTypeWithHttpInfo(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertActivityTypeResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActivityType(id, );
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+        },
         /**
          * Returns all activity types.
          * @summary Get all activity types
@@ -242,6 +264,16 @@ export const ActivityTypesApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getActivityTypes();
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Same as `getActivityTypes`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all activity types
+
+         * @throws {RequiredError}
+         */
+        async getActivityTypesWithHttpInfo(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetActivityTypesResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getActivityTypes();
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+        },
         /**
          * Updates an activity type.
          * @summary Update an activity type
@@ -254,6 +286,18 @@ export const ActivityTypesApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.updateActivityType(id, UpdateActivityTypeRequest, );
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Same as `updateActivityType`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update an activity type
+         * @param {number} id The ID of the activity type
+         * @param {UpdateActivityTypeRequest} [UpdateActivityTypeRequest] 
+
+         * @throws {RequiredError}
+         */
+        async updateActivityTypeWithHttpInfo(id: number, UpdateActivityTypeRequest?: UpdateActivityTypeRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertActivityTypeResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateActivityType(id, UpdateActivityTypeRequest, );
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+        },
     }
 };
 
@@ -274,6 +318,9 @@ export const ActivityTypesApiFactory = function (configuration?: Configuration,
         addActivityType(requestParameters: ActivityTypesApiAddActivityTypeRequest = {}, ): Promise<UpsertActivityTypeResponse> {
             return localVarFp.addActivityType(requestParameters.AddActivityTypeRequest, ).then((request) => request(axios, basePath));
         },
+        addActivityTypeWithHttpInfo(requestParameters: ActivityTypesApiAddActivityTypeRequest = {}, ): Promise<ApiResponse<UpsertActivityTypeResponse>> {
+            return localVarFp.addActivityTypeWithHttpInfo(requestParameters.AddActivityTypeRequest, ).then((request) => request(axios, basePath));
+        },
         /**
          * Marks an activity type as deleted.
          * @summary Delete an activity type
@@ -284,6 +331,9 @@ export const ActivityTypesApiFactory = function (configuration?: Configuration,
         deleteActivityType(requestParameters: ActivityTypesApiDeleteActivityTypeRequest, ): Promise<UpsertActivityTypeResponse> {
             return localVarFp.deleteActivityType(requestParameters.id, ).then((request) => request(axios, basePath));
         },
+        deleteActivityTypeWithHttpInfo(requestParameters: ActivityTypesApiDeleteActivityTypeRequest, ): Promise<ApiResponse<UpsertActivityTypeResponse>> {
+            return localVarFp.deleteActivityTypeWithHttpInfo(requestParameters.id, ).then((request) => request(axios, basePath));
+        },
         /**
          * Returns all activity types.
          * @summary Get all activity types
@@ -293,6 +343,9 @@ export const ActivityTypesApiFactory = function (configuration?: Configuration,
         getActivityTypes(): Promise<GetActivityTypesResponse> {
             return localVarFp.getActivityTypes().then((request) => request(axios, basePath));
         },
+        getActivityTypesWithHttpInfo(): Promise<ApiResponse<GetActivityTypesResponse>> {
+            return localVarFp.getActivityTypesWithHttpInfo().then((request) => request(axios, basePath));
+        },
         /**
          * Updates an activity type.
          * @summary Update an activity type
@@ -303,6 +356,9 @@ export const ActivityTypesApiFactory = function (configuration?: Configuration,
         updateActivityType(requestParameters: ActivityTypesApiUpdateActivityTypeRequest, ): Promise<UpsertActivityTypeResponse> {
             return localVarFp.updateActivityType(requestParameters.id, requestParameters.UpdateActivityTypeRequest, ).then((request) => request(axios, basePath));
         },
+        updateActivityTypeWithHttpInfo(requestParameters: ActivityTypesApiUpdateActivityTypeRequest, ): Promise<ApiResponse<UpsertActivityTypeResponse>> {
+            return localVarFp.updateActivityTypeWithHttpInfo(requestParameters.id, requestParameters.UpdateActivityTypeRequest, ).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -374,6 +430,18 @@ export class ActivityTypesApi extends BaseAPI {
         return ActivityTypesApiFp(this.configuration).addActivityType(requestParameters.AddActivityTypeRequest, ).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Same as `addActivityType`, 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 {ActivityTypesApiAddActivityTypeRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ActivityTypesApi
+     */
+    public addActivityTypeWithHttpInfo(requestParameters: ActivityTypesApiAddActivityTypeRequest = {}, ) {
+        return ActivityTypesApiFp(this.configuration).addActivityTypeWithHttpInfo(requestParameters.AddActivityTypeRequest, ).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Marks an activity type as deleted.
      * @summary Delete an activity type
@@ -386,6 +454,18 @@ export class ActivityTypesApi extends BaseAPI {
         return ActivityTypesApiFp(this.configuration).deleteActivityType(requestParameters.id, ).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Same as `deleteActivityType`, 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 {ActivityTypesApiDeleteActivityTypeRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ActivityTypesApi
+     */
+    public deleteActivityTypeWithHttpInfo(requestParameters: ActivityTypesApiDeleteActivityTypeRequest, ) {
+        return ActivityTypesApiFp(this.configuration).deleteActivityTypeWithHttpInfo(requestParameters.id, ).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Returns all activity types.
      * @summary Get all activity types
@@ -397,6 +477,17 @@ export class ActivityTypesApi extends BaseAPI {
         return ActivityTypesApiFp(this.configuration).getActivityTypes().then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Same as `getActivityTypes`, 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 }`.
+
+     * @throws {RequiredError}
+     * @memberof ActivityTypesApi
+     */
+    public getActivityTypesWithHttpInfo() {
+        return ActivityTypesApiFp(this.configuration).getActivityTypesWithHttpInfo().then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Updates an activity type.
      * @summary Update an activity type
@@ -408,4 +499,16 @@ export class ActivityTypesApi extends BaseAPI {
     public updateActivityType(requestParameters: ActivityTypesApiUpdateActivityTypeRequest, ) {
         return ActivityTypesApiFp(this.configuration).updateActivityType(requestParameters.id, requestParameters.UpdateActivityTypeRequest, ).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Same as `updateActivityType`, 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 {ActivityTypesApiUpdateActivityTypeRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof ActivityTypesApi
+     */
+    public updateActivityTypeWithHttpInfo(requestParameters: ActivityTypesApiUpdateActivityTypeRequest, ) {
+        return ActivityTypesApiFp(this.configuration).updateActivityTypeWithHttpInfo(requestParameters.id, requestParameters.UpdateActivityTypeRequest, ).then((request) => request(this.axios, this.basePath));
+    }
 }

src/versions/v1/api/billing-api.ts

@@ -20,7 +20,7 @@ import globalAxios from 'axios';
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
 // @ts-ignore
-import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, ApiResponse } from '../base';
 // @ts-ignore
 import { GetSubscriptionAddonsResponse } from '../models';
 /**
@@ -87,6 +87,16 @@ export const BillingApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getCompanyAddons();
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Same as `getCompanyAddons`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all add-ons for a single company
+
+         * @throws {RequiredError}
+         */
+        async getCompanyAddonsWithHttpInfo(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetSubscriptionAddonsResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCompanyAddons();
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+        },
     }
 };
 
@@ -106,6 +116,9 @@ export const BillingApiFactory = function (configuration?: Configuration, basePa
         getCompanyAddons(): Promise<GetSubscriptionAddonsResponse> {
             return localVarFp.getCompanyAddons().then((request) => request(axios, basePath));
         },
+        getCompanyAddonsWithHttpInfo(): Promise<ApiResponse<GetSubscriptionAddonsResponse>> {
+            return localVarFp.getCompanyAddonsWithHttpInfo().then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -126,4 +139,15 @@ export class BillingApi extends BaseAPI {
     public getCompanyAddons() {
         return BillingApiFp(this.configuration).getCompanyAddons().then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Same as `getCompanyAddons`, 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 }`.
+
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    public getCompanyAddonsWithHttpInfo() {
+        return BillingApiFp(this.configuration).getCompanyAddonsWithHttpInfo().then((request) => request(this.axios, this.basePath));
+    }
 }