pipedrive 36.0.1 → 36.1.0

package/dist/versions/v1/api/goals-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 { AddGoalRequest } from '../models';
 import { BasicGoalRequest } from '../models';
 import { DeleteGoalResponse } from '../models';
@@ -92,6 +92,14 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     addGoal(AddGoalRequest?: AddGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertGoalResponse>>;
+    /**
+     * Same as `addGoal`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Add a new goal
+     * @param {AddGoalRequest} [AddGoalRequest]
+
+     * @throws {RequiredError}
+     */
+    addGoalWithHttpInfo(AddGoalRequest?: AddGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertGoalResponse>>>;
     /**
      * Marks a goal as deleted.
      * @summary Delete existing goal
@@ -100,6 +108,14 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteGoal(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteGoalResponse>>;
+    /**
+     * Same as `deleteGoal`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Delete existing goal
+     * @param {string} id The ID of the goal
+
+     * @throws {RequiredError}
+     */
+    deleteGoalWithHttpInfo(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteGoalResponse>>>;
     /**
      * Gets the progress of a goal for the specified period.
      * @summary Get result of a goal
@@ -110,6 +126,16 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGoalResult(id: string, period_start: string, period_end: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetGoalResultResponse>>;
+    /**
+     * Same as `getGoalResult`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get result of a goal
+     * @param {string} id The ID of the goal that the results are looked for
+     * @param {string} period_start The start date of the period for which to find the goal\&#39;s progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date.
+     * @param {string} period_end The end date of the period for which to find the goal\&#39;s progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date.
+
+     * @throws {RequiredError}
+     */
+    getGoalResultWithHttpInfo(id: string, period_start: string, period_end: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetGoalResultResponse>>>;
     /**
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
      * @summary Find goals
@@ -130,6 +156,26 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGoals(type_name?: 'deals_won' | 'deals_progressed' | 'activities_completed' | 'activities_added' | 'deals_started', title?: string, is_active?: boolean, assignee_id?: number, assignee_type?: 'person' | 'company' | 'team', expected_outcome_target?: number, expected_outcome_tracking_metric?: 'quantity' | 'sum', expected_outcome_currency_id?: number, type_params_pipeline_id?: Array<number>, type_params_stage_id?: number, type_params_activity_type_id?: Array<number>, period_start?: string, period_end?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetGoalsResponse>>;
+    /**
+     * Same as `getGoals`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Find goals
+     * @param {'deals_won' | 'deals_progressed' | 'activities_completed' | 'activities_added' | 'deals_started'} [type_name] The type of the goal. If provided, everyone\&#39;s goals will be returned.
+     * @param {string} [title] The title of the goal
+     * @param {boolean} [is_active] Whether the goal is active or not
+     * @param {number} [assignee_id] The ID of the user who\&#39;s goal to fetch. When omitted, only your goals will be returned.
+     * @param {'person' | 'company' | 'team'} [assignee_type] The type of the goal\&#39;s assignee. If provided, everyone\&#39;s goals will be returned.
+     * @param {number} [expected_outcome_target] The numeric value of the outcome. If provided, everyone\&#39;s goals will be returned.
+     * @param {'quantity' | 'sum'} [expected_outcome_tracking_metric] The tracking metric of the expected outcome of the goal. If provided, everyone\&#39;s goals will be returned.
+     * @param {number} [expected_outcome_currency_id] The numeric ID of the goal\&#39;s currency. Only applicable to goals with &#x60;expected_outcome.tracking_metric&#x60; with value &#x60;sum&#x60;. If provided, everyone\&#39;s goals will be returned.
+     * @param {Array<number>} [type_params_pipeline_id] An array of pipeline IDs or &#x60;null&#x60; for all pipelines. If provided, everyone\&#39;s goals will be returned.
+     * @param {number} [type_params_stage_id] The ID of the stage. Applicable to only &#x60;deals_progressed&#x60; type of goals. If provided, everyone\&#39;s goals will be returned.
+     * @param {Array<number>} [type_params_activity_type_id] An array of IDs or &#x60;null&#x60; for all activity types. Only applicable for &#x60;activities_completed&#x60; and/or &#x60;activities_added&#x60; types of goals. If provided, everyone\&#39;s goals will be returned.
+     * @param {string} [period_start] The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When &#x60;period.start&#x60; is provided, &#x60;period.end&#x60; must be provided too.
+     * @param {string} [period_end] The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
+
+     * @throws {RequiredError}
+     */
+    getGoalsWithHttpInfo(type_name?: 'deals_won' | 'deals_progressed' | 'activities_completed' | 'activities_added' | 'deals_started', title?: string, is_active?: boolean, assignee_id?: number, assignee_type?: 'person' | 'company' | 'team', expected_outcome_target?: number, expected_outcome_tracking_metric?: 'quantity' | 'sum', expected_outcome_currency_id?: number, type_params_pipeline_id?: Array<number>, type_params_stage_id?: number, type_params_activity_type_id?: Array<number>, period_start?: string, period_end?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetGoalsResponse>>>;
     /**
      * Updates an existing goal.
      * @summary Update existing goal
@@ -139,6 +185,15 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateGoal(id: string, BasicGoalRequest?: BasicGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertGoalResponse>>;
+    /**
+     * Same as `updateGoal`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Update existing goal
+     * @param {string} id The ID of the goal
+     * @param {BasicGoalRequest} [BasicGoalRequest]
+
+     * @throws {RequiredError}
+     */
+    updateGoalWithHttpInfo(id: string, BasicGoalRequest?: BasicGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertGoalResponse>>>;
 };
 /**
  * GoalsApi - factory interface
@@ -153,6 +208,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     addGoal(requestParameters?: GoalsApiAddGoalRequest): Promise<UpsertGoalResponse>;
+    addGoalWithHttpInfo(requestParameters?: GoalsApiAddGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
     /**
      * Marks a goal as deleted.
      * @summary Delete existing goal
@@ -161,6 +217,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     deleteGoal(requestParameters: GoalsApiDeleteGoalRequest): Promise<DeleteGoalResponse>;
+    deleteGoalWithHttpInfo(requestParameters: GoalsApiDeleteGoalRequest): Promise<ApiResponse<DeleteGoalResponse>>;
     /**
      * Gets the progress of a goal for the specified period.
      * @summary Get result of a goal
@@ -169,6 +226,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getGoalResult(requestParameters: GoalsApiGetGoalResultRequest): Promise<GetGoalResultResponse>;
+    getGoalResultWithHttpInfo(requestParameters: GoalsApiGetGoalResultRequest): Promise<ApiResponse<GetGoalResultResponse>>;
     /**
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
      * @summary Find goals
@@ -177,6 +235,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     getGoals(requestParameters?: GoalsApiGetGoalsRequest): Promise<GetGoalsResponse>;
+    getGoalsWithHttpInfo(requestParameters?: GoalsApiGetGoalsRequest): Promise<ApiResponse<GetGoalsResponse>>;
     /**
      * Updates an existing goal.
      * @summary Update existing goal
@@ -185,6 +244,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     updateGoal(requestParameters: GoalsApiUpdateGoalRequest): Promise<UpsertGoalResponse>;
+    updateGoalWithHttpInfo(requestParameters: GoalsApiUpdateGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
 };
 /**
  * Request parameters for addGoal operation in GoalsApi.
@@ -357,6 +417,15 @@ export declare class GoalsApi extends BaseAPI {
      * @memberof GoalsApi
      */
     addGoal(requestParameters?: GoalsApiAddGoalRequest): Promise<UpsertGoalResponse>;
+    /**
+     * Same as `addGoal`, 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 {GoalsApiAddGoalRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    addGoalWithHttpInfo(requestParameters?: GoalsApiAddGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
     /**
      * Marks a goal as deleted.
      * @summary Delete existing goal
@@ -366,6 +435,15 @@ export declare class GoalsApi extends BaseAPI {
      * @memberof GoalsApi
      */
     deleteGoal(requestParameters: GoalsApiDeleteGoalRequest): Promise<DeleteGoalResponse>;
+    /**
+     * Same as `deleteGoal`, 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 {GoalsApiDeleteGoalRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    deleteGoalWithHttpInfo(requestParameters: GoalsApiDeleteGoalRequest): Promise<ApiResponse<DeleteGoalResponse>>;
     /**
      * Gets the progress of a goal for the specified period.
      * @summary Get result of a goal
@@ -375,6 +453,15 @@ export declare class GoalsApi extends BaseAPI {
      * @memberof GoalsApi
      */
     getGoalResult(requestParameters: GoalsApiGetGoalResultRequest): Promise<GetGoalResultResponse>;
+    /**
+     * Same as `getGoalResult`, 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 {GoalsApiGetGoalResultRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    getGoalResultWithHttpInfo(requestParameters: GoalsApiGetGoalResultRequest): Promise<ApiResponse<GetGoalResultResponse>>;
     /**
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
      * @summary Find goals
@@ -384,6 +471,15 @@ export declare class GoalsApi extends BaseAPI {
      * @memberof GoalsApi
      */
     getGoals(requestParameters?: GoalsApiGetGoalsRequest): Promise<GetGoalsResponse>;
+    /**
+     * Same as `getGoals`, 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 {GoalsApiGetGoalsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    getGoalsWithHttpInfo(requestParameters?: GoalsApiGetGoalsRequest): Promise<ApiResponse<GetGoalsResponse>>;
     /**
      * Updates an existing goal.
      * @summary Update existing goal
@@ -393,4 +489,13 @@ export declare class GoalsApi extends BaseAPI {
      * @memberof GoalsApi
      */
     updateGoal(requestParameters: GoalsApiUpdateGoalRequest): Promise<UpsertGoalResponse>;
+    /**
+     * Same as `updateGoal`, 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 {GoalsApiUpdateGoalRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    updateGoalWithHttpInfo(requestParameters: GoalsApiUpdateGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
 }

package/dist/versions/v1/api/goals-api.js

@@ -301,6 +301,19 @@ const GoalsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addGoal`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add a new goal
+         * @param {AddGoalRequest} [AddGoalRequest]
+
+         * @throws {RequiredError}
+         */
+        addGoalWithHttpInfo(AddGoalRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addGoal(AddGoalRequest);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Marks a goal as deleted.
          * @summary Delete existing goal
@@ -314,6 +327,19 @@ const GoalsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteGoal`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete existing goal
+         * @param {string} id The ID of the goal
+
+         * @throws {RequiredError}
+         */
+        deleteGoalWithHttpInfo(id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteGoal(id);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Gets the progress of a goal for the specified period.
          * @summary Get result of a goal
@@ -329,6 +355,21 @@ const GoalsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getGoalResult`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get result of a goal
+         * @param {string} id The ID of the goal that the results are looked for
+         * @param {string} period_start The start date of the period for which to find the goal\'s progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date.
+         * @param {string} period_end The end date of the period for which to find the goal\'s progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date.
+
+         * @throws {RequiredError}
+         */
+        getGoalResultWithHttpInfo(id, period_start, period_end) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getGoalResult(id, period_start, period_end);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
          * @summary Find goals
@@ -354,6 +395,31 @@ const GoalsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getGoals`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Find goals
+         * @param {'deals_won' | 'deals_progressed' | 'activities_completed' | 'activities_added' | 'deals_started'} [type_name] The type of the goal. If provided, everyone\&#39;s goals will be returned.
+         * @param {string} [title] The title of the goal
+         * @param {boolean} [is_active] Whether the goal is active or not
+         * @param {number} [assignee_id] The ID of the user who\&#39;s goal to fetch. When omitted, only your goals will be returned.
+         * @param {'person' | 'company' | 'team'} [assignee_type] The type of the goal\&#39;s assignee. If provided, everyone\&#39;s goals will be returned.
+         * @param {number} [expected_outcome_target] The numeric value of the outcome. If provided, everyone\&#39;s goals will be returned.
+         * @param {'quantity' | 'sum'} [expected_outcome_tracking_metric] The tracking metric of the expected outcome of the goal. If provided, everyone\&#39;s goals will be returned.
+         * @param {number} [expected_outcome_currency_id] The numeric ID of the goal\&#39;s currency. Only applicable to goals with &#x60;expected_outcome.tracking_metric&#x60; with value &#x60;sum&#x60;. If provided, everyone\&#39;s goals will be returned.
+         * @param {Array<number>} [type_params_pipeline_id] An array of pipeline IDs or &#x60;null&#x60; for all pipelines. If provided, everyone\&#39;s goals will be returned.
+         * @param {number} [type_params_stage_id] The ID of the stage. Applicable to only &#x60;deals_progressed&#x60; type of goals. If provided, everyone\&#39;s goals will be returned.
+         * @param {Array<number>} [type_params_activity_type_id] An array of IDs or &#x60;null&#x60; for all activity types. Only applicable for &#x60;activities_completed&#x60; and/or &#x60;activities_added&#x60; types of goals. If provided, everyone\&#39;s goals will be returned.
+         * @param {string} [period_start] The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When &#x60;period.start&#x60; is provided, &#x60;period.end&#x60; must be provided too.
+         * @param {string} [period_end] The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
+
+         * @throws {RequiredError}
+         */
+        getGoalsWithHttpInfo(type_name, title, is_active, assignee_id, assignee_type, expected_outcome_target, expected_outcome_tracking_metric, expected_outcome_currency_id, type_params_pipeline_id, type_params_stage_id, type_params_activity_type_id, period_start, period_end) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getGoals(type_name, title, is_active, assignee_id, assignee_type, expected_outcome_target, expected_outcome_tracking_metric, expected_outcome_currency_id, type_params_pipeline_id, type_params_stage_id, type_params_activity_type_id, period_start, period_end);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates an existing goal.
          * @summary Update existing goal
@@ -368,6 +434,20 @@ const GoalsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateGoal`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update existing goal
+         * @param {string} id The ID of the goal
+         * @param {BasicGoalRequest} [BasicGoalRequest]
+
+         * @throws {RequiredError}
+         */
+        updateGoalWithHttpInfo(id, BasicGoalRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateGoal(id, BasicGoalRequest);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 exports.GoalsApiFp = GoalsApiFp;
@@ -388,6 +468,9 @@ const GoalsApiFactory = function (configuration, basePath, axios) {
         addGoal(requestParameters = {}) {
             return localVarFp.addGoal(requestParameters.AddGoalRequest).then((request) => request(axios, basePath));
         },
+        addGoalWithHttpInfo(requestParameters = {}) {
+            return localVarFp.addGoalWithHttpInfo(requestParameters.AddGoalRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Marks a goal as deleted.
          * @summary Delete existing goal
@@ -398,6 +481,9 @@ const GoalsApiFactory = function (configuration, basePath, axios) {
         deleteGoal(requestParameters) {
             return localVarFp.deleteGoal(requestParameters.id).then((request) => request(axios, basePath));
         },
+        deleteGoalWithHttpInfo(requestParameters) {
+            return localVarFp.deleteGoalWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
+        },
         /**
          * Gets the progress of a goal for the specified period.
          * @summary Get result of a goal
@@ -408,6 +494,9 @@ const GoalsApiFactory = function (configuration, basePath, axios) {
         getGoalResult(requestParameters) {
             return localVarFp.getGoalResult(requestParameters.id, requestParameters.period_start, requestParameters.period_end).then((request) => request(axios, basePath));
         },
+        getGoalResultWithHttpInfo(requestParameters) {
+            return localVarFp.getGoalResultWithHttpInfo(requestParameters.id, requestParameters.period_start, requestParameters.period_end).then((request) => request(axios, basePath));
+        },
         /**
          * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
          * @summary Find goals
@@ -418,6 +507,9 @@ const GoalsApiFactory = function (configuration, basePath, axios) {
         getGoals(requestParameters = {}) {
             return localVarFp.getGoals(requestParameters.type_name, requestParameters.title, requestParameters.is_active, requestParameters.assignee_id, requestParameters.assignee_type, requestParameters.expected_outcome_target, requestParameters.expected_outcome_tracking_metric, requestParameters.expected_outcome_currency_id, requestParameters.type_params_pipeline_id, requestParameters.type_params_stage_id, requestParameters.type_params_activity_type_id, requestParameters.period_start, requestParameters.period_end).then((request) => request(axios, basePath));
         },
+        getGoalsWithHttpInfo(requestParameters = {}) {
+            return localVarFp.getGoalsWithHttpInfo(requestParameters.type_name, requestParameters.title, requestParameters.is_active, requestParameters.assignee_id, requestParameters.assignee_type, requestParameters.expected_outcome_target, requestParameters.expected_outcome_tracking_metric, requestParameters.expected_outcome_currency_id, requestParameters.type_params_pipeline_id, requestParameters.type_params_stage_id, requestParameters.type_params_activity_type_id, requestParameters.period_start, requestParameters.period_end).then((request) => request(axios, basePath));
+        },
         /**
          * Updates an existing goal.
          * @summary Update existing goal
@@ -428,6 +520,9 @@ const GoalsApiFactory = function (configuration, basePath, axios) {
         updateGoal(requestParameters) {
             return localVarFp.updateGoal(requestParameters.id, requestParameters.BasicGoalRequest).then((request) => request(axios, basePath));
         },
+        updateGoalWithHttpInfo(requestParameters) {
+            return localVarFp.updateGoalWithHttpInfo(requestParameters.id, requestParameters.BasicGoalRequest).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.GoalsApiFactory = GoalsApiFactory;
@@ -449,6 +544,17 @@ class GoalsApi extends base_1.BaseAPI {
     addGoal(requestParameters = {}) {
         return (0, exports.GoalsApiFp)(this.configuration).addGoal(requestParameters.AddGoalRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addGoal`, 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 {GoalsApiAddGoalRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    addGoalWithHttpInfo(requestParameters = {}) {
+        return (0, exports.GoalsApiFp)(this.configuration).addGoalWithHttpInfo(requestParameters.AddGoalRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Marks a goal as deleted.
      * @summary Delete existing goal
@@ -460,6 +566,17 @@ class GoalsApi extends base_1.BaseAPI {
     deleteGoal(requestParameters) {
         return (0, exports.GoalsApiFp)(this.configuration).deleteGoal(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteGoal`, 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 {GoalsApiDeleteGoalRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    deleteGoalWithHttpInfo(requestParameters) {
+        return (0, exports.GoalsApiFp)(this.configuration).deleteGoalWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Gets the progress of a goal for the specified period.
      * @summary Get result of a goal
@@ -471,6 +588,17 @@ class GoalsApi extends base_1.BaseAPI {
     getGoalResult(requestParameters) {
         return (0, exports.GoalsApiFp)(this.configuration).getGoalResult(requestParameters.id, requestParameters.period_start, requestParameters.period_end).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getGoalResult`, 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 {GoalsApiGetGoalResultRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    getGoalResultWithHttpInfo(requestParameters) {
+        return (0, exports.GoalsApiFp)(this.configuration).getGoalResultWithHttpInfo(requestParameters.id, requestParameters.period_start, requestParameters.period_end).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.
      * @summary Find goals
@@ -482,6 +610,17 @@ class GoalsApi extends base_1.BaseAPI {
     getGoals(requestParameters = {}) {
         return (0, exports.GoalsApiFp)(this.configuration).getGoals(requestParameters.type_name, requestParameters.title, requestParameters.is_active, requestParameters.assignee_id, requestParameters.assignee_type, requestParameters.expected_outcome_target, requestParameters.expected_outcome_tracking_metric, requestParameters.expected_outcome_currency_id, requestParameters.type_params_pipeline_id, requestParameters.type_params_stage_id, requestParameters.type_params_activity_type_id, requestParameters.period_start, requestParameters.period_end).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getGoals`, 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 {GoalsApiGetGoalsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    getGoalsWithHttpInfo(requestParameters = {}) {
+        return (0, exports.GoalsApiFp)(this.configuration).getGoalsWithHttpInfo(requestParameters.type_name, requestParameters.title, requestParameters.is_active, requestParameters.assignee_id, requestParameters.assignee_type, requestParameters.expected_outcome_target, requestParameters.expected_outcome_tracking_metric, requestParameters.expected_outcome_currency_id, requestParameters.type_params_pipeline_id, requestParameters.type_params_stage_id, requestParameters.type_params_activity_type_id, requestParameters.period_start, requestParameters.period_end).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates an existing goal.
      * @summary Update existing goal
@@ -493,5 +632,16 @@ class GoalsApi extends base_1.BaseAPI {
     updateGoal(requestParameters) {
         return (0, exports.GoalsApiFp)(this.configuration).updateGoal(requestParameters.id, requestParameters.BasicGoalRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateGoal`, 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 {GoalsApiUpdateGoalRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof GoalsApi
+     */
+    updateGoalWithHttpInfo(requestParameters) {
+        return (0, exports.GoalsApiFp)(this.configuration).updateGoalWithHttpInfo(requestParameters.id, requestParameters.BasicGoalRequest).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.GoalsApi = GoalsApi;

package/dist/versions/v1/api/lead-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 { GetFieldsResponse } from '../models';
 /**
  * LeadFieldsApi - axios parameter creator
@@ -42,6 +42,15 @@ export declare const LeadFieldsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getLeadFields(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetFieldsResponse>>;
+    /**
+     * Same as `getLeadFields`, but resolves with the response body together with the HTTP status and headers.
+     * @summary Get all lead fields
+     * @param {number} [start] Pagination start
+     * @param {number} [limit] Items shown per page
+
+     * @throws {RequiredError}
+     */
+    getLeadFieldsWithHttpInfo(start?: number, limit?: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetFieldsResponse>>>;
 };
 /**
  * LeadFieldsApi - factory interface
@@ -56,6 +65,7 @@ export declare const LeadFieldsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
+    getLeadFieldsWithHttpInfo(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<ApiResponse<GetFieldsResponse>>;
 };
 /**
  * Request parameters for getLeadFields operation in LeadFieldsApi.
@@ -92,4 +102,13 @@ export declare class LeadFieldsApi extends BaseAPI {
      * @memberof LeadFieldsApi
      */
     getLeadFields(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<GetFieldsResponse>;
+    /**
+     * Same as `getLeadFields`, 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 {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadFieldsApi
+     */
+    getLeadFieldsWithHttpInfo(requestParameters?: LeadFieldsApiGetLeadFieldsRequest): Promise<ApiResponse<GetFieldsResponse>>;
 }

package/dist/versions/v1/api/lead-fields-api.js

@@ -100,6 +100,20 @@ const LeadFieldsApiFp = function (configuration) {
                 return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getLeadFields`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all lead fields
+         * @param {number} [start] Pagination start
+         * @param {number} [limit] Items shown per page
+
+         * @throws {RequiredError}
+         */
+        getLeadFieldsWithHttpInfo(start, limit) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getLeadFields(start, limit);
+                return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 exports.LeadFieldsApiFp = LeadFieldsApiFp;
@@ -120,6 +134,9 @@ const LeadFieldsApiFactory = function (configuration, basePath, axios) {
         getLeadFields(requestParameters = {}) {
             return localVarFp.getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
         },
+        getLeadFieldsWithHttpInfo(requestParameters = {}) {
+            return localVarFp.getLeadFieldsWithHttpInfo(requestParameters.start, requestParameters.limit).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.LeadFieldsApiFactory = LeadFieldsApiFactory;
@@ -141,5 +158,16 @@ class LeadFieldsApi extends base_1.BaseAPI {
     getLeadFields(requestParameters = {}) {
         return (0, exports.LeadFieldsApiFp)(this.configuration).getLeadFields(requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getLeadFields`, 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 {LeadFieldsApiGetLeadFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof LeadFieldsApi
+     */
+    getLeadFieldsWithHttpInfo(requestParameters = {}) {
+        return (0, exports.LeadFieldsApiFp)(this.configuration).getLeadFieldsWithHttpInfo(requestParameters.start, requestParameters.limit).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.LeadFieldsApi = LeadFieldsApi;