pipedrive 36.0.1 → 36.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/versions/v1/api/activity-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/activity-types-api.js +107 -0
- package/dist/esm/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/billing-api.js +25 -0
- package/dist/esm/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/call-logs-api.js +137 -0
- package/dist/esm/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/esm/versions/v1/api/channels-api.js +109 -0
- package/dist/esm/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/esm/versions/v1/api/currencies-api.js +27 -0
- package/dist/esm/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/esm/versions/v1/api/deals-api.js +569 -0
- package/dist/esm/versions/v1/api/files-api.d.ts +163 -1
- package/dist/esm/versions/v1/api/files-api.js +234 -0
- package/dist/esm/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/esm/versions/v1/api/filters-api.js +191 -0
- package/dist/esm/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/esm/versions/v1/api/goals-api.js +150 -0
- package/dist/esm/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/esm/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/esm/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/esm/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/esm/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/esm/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/esm/versions/v1/api/leads-api.js +237 -0
- package/dist/esm/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/esm/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/esm/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/esm/versions/v1/api/mailbox-api.js +170 -0
- package/dist/esm/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/meetings-api.js +54 -0
- package/dist/esm/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/note-fields-api.js +25 -0
- package/dist/esm/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/esm/versions/v1/api/notes-api.js +296 -0
- package/dist/esm/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/esm/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/esm/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/esm/versions/v1/api/organizations-api.js +258 -0
- package/dist/esm/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/esm/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/esm/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/person-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/esm/versions/v1/api/persons-api.js +370 -24
- package/dist/esm/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/esm/versions/v1/api/pipelines-api.js +95 -0
- package/dist/esm/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/esm/versions/v1/api/product-fields-api.js +164 -0
- package/dist/esm/versions/v1/api/products-api.d.ts +119 -1
- package/dist/esm/versions/v1/api/products-api.js +172 -0
- package/dist/esm/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/esm/versions/v1/api/project-boards-api.js +52 -0
- package/dist/esm/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/esm/versions/v1/api/project-phases-api.js +54 -0
- package/dist/esm/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v1/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/esm/versions/v1/api/projects-api.js +334 -0
- package/dist/esm/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/esm/versions/v1/api/recents-api.js +30 -0
- package/dist/esm/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/esm/versions/v1/api/roles-api.js +333 -0
- package/dist/esm/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/esm/versions/v1/api/stages-api.js +32 -0
- package/dist/esm/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/esm/versions/v1/api/tasks-api.js +141 -0
- package/dist/esm/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-connections-api.js +25 -0
- package/dist/esm/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/esm/versions/v1/api/user-settings-api.js +25 -0
- package/dist/esm/versions/v1/api/users-api.d.ts +181 -1
- package/dist/esm/versions/v1/api/users-api.js +270 -0
- package/dist/esm/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/esm/versions/v1/api/webhooks-api.js +79 -0
- package/dist/esm/versions/v1/base.d.ts +17 -0
- package/dist/esm/versions/v1/base.js +22 -0
- package/dist/esm/versions/v1/common.d.ts +1 -1
- package/dist/esm/versions/v1/common.js +7 -4
- package/dist/esm/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/esm/versions/v2/api/activities-api.js +151 -0
- package/dist/esm/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/esm/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/esm/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/esm/versions/v2/api/beta-api.js +666 -0
- package/dist/esm/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/esm/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/esm/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/esm/versions/v2/api/deal-products-api.js +203 -0
- package/dist/esm/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/esm/versions/v2/api/deals-api.js +516 -1
- package/dist/esm/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/esm/versions/v2/api/item-search-api.js +66 -0
- package/dist/esm/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/esm/versions/v2/api/leads-api.js +90 -0
- package/dist/esm/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/esm/versions/v2/api/organizations-api.js +297 -0
- package/dist/esm/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/person-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/esm/versions/v2/api/persons-api.js +328 -0
- package/dist/esm/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/esm/versions/v2/api/pipelines-api.js +139 -0
- package/dist/esm/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/esm/versions/v2/api/product-fields-api.js +223 -0
- package/dist/esm/versions/v2/api/products-api.d.ts +371 -1
- package/dist/esm/versions/v2/api/products-api.js +541 -0
- package/dist/esm/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/esm/versions/v2/api/project-boards-api.js +134 -0
- package/dist/esm/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/esm/versions/v2/api/project-fields-api.js +221 -0
- package/dist/esm/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/esm/versions/v2/api/project-phases-api.js +136 -0
- package/dist/esm/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/esm/versions/v2/api/project-templates-api.js +55 -0
- package/dist/esm/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/esm/versions/v2/api/projects-api.js +290 -0
- package/dist/esm/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/esm/versions/v2/api/stages-api.js +140 -0
- package/dist/esm/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/esm/versions/v2/api/tasks-api.js +142 -0
- package/dist/esm/versions/v2/api/users-api.d.ts +21 -1
- package/dist/esm/versions/v2/api/users-api.js +29 -0
- package/dist/esm/versions/v2/base.d.ts +17 -0
- package/dist/esm/versions/v2/base.js +22 -0
- package/dist/esm/versions/v2/common.d.ts +1 -1
- package/dist/esm/versions/v2/common.js +7 -4
- package/dist/versions/v1/api/activity-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/activity-fields-api.js +25 -0
- package/dist/versions/v1/api/activity-types-api.d.ts +72 -1
- package/dist/versions/v1/api/activity-types-api.js +107 -0
- package/dist/versions/v1/api/billing-api.d.ts +17 -1
- package/dist/versions/v1/api/billing-api.js +25 -0
- package/dist/versions/v1/api/call-logs-api.d.ts +93 -1
- package/dist/versions/v1/api/call-logs-api.js +137 -0
- package/dist/versions/v1/api/channels-api.d.ts +74 -1
- package/dist/versions/v1/api/channels-api.js +109 -0
- package/dist/versions/v1/api/currencies-api.d.ts +19 -1
- package/dist/versions/v1/api/currencies-api.js +27 -0
- package/dist/versions/v1/api/deal-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/deal-fields-api.js +164 -0
- package/dist/versions/v1/api/deals-api.d.ts +399 -1
- package/dist/versions/v1/api/deals-api.js +569 -0
- package/dist/versions/v1/api/files-api.d.ts +163 -1
- package/dist/versions/v1/api/files-api.js +234 -0
- package/dist/versions/v1/api/filters-api.d.ts +129 -1
- package/dist/versions/v1/api/filters-api.js +191 -0
- package/dist/versions/v1/api/goals-api.d.ts +106 -1
- package/dist/versions/v1/api/goals-api.js +150 -0
- package/dist/versions/v1/api/lead-fields-api.d.ts +20 -1
- package/dist/versions/v1/api/lead-fields-api.js +28 -0
- package/dist/versions/v1/api/lead-labels-api.d.ts +72 -1
- package/dist/versions/v1/api/lead-labels-api.js +107 -0
- package/dist/versions/v1/api/lead-sources-api.d.ts +17 -1
- package/dist/versions/v1/api/lead-sources-api.js +25 -0
- package/dist/versions/v1/api/leads-api.d.ts +166 -1
- package/dist/versions/v1/api/leads-api.js +237 -0
- package/dist/versions/v1/api/legacy-teams-api.d.ts +152 -1
- package/dist/versions/v1/api/legacy-teams-api.js +223 -0
- package/dist/versions/v1/api/mailbox-api.d.ts +117 -1
- package/dist/versions/v1/api/mailbox-api.js +170 -0
- package/dist/versions/v1/api/meetings-api.d.ts +37 -1
- package/dist/versions/v1/api/meetings-api.js +54 -0
- package/dist/versions/v1/api/note-fields-api.d.ts +17 -1
- package/dist/versions/v1/api/note-fields-api.js +25 -0
- package/dist/versions/v1/api/notes-api.d.ts +207 -1
- package/dist/versions/v1/api/notes-api.js +296 -0
- package/dist/versions/v1/api/organization-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/organization-fields-api.js +164 -0
- package/dist/versions/v1/api/organization-relationships-api.d.ts +93 -1
- package/dist/versions/v1/api/organization-relationships-api.js +137 -0
- package/dist/versions/v1/api/organizations-api.d.ts +178 -1
- package/dist/versions/v1/api/organizations-api.js +258 -0
- package/dist/versions/v1/api/permission-sets-api.d.ts +57 -1
- package/dist/versions/v1/api/permission-sets-api.js +83 -0
- package/dist/versions/v1/api/person-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/person-fields-api.js +164 -0
- package/dist/versions/v1/api/persons-api.d.ts +275 -37
- package/dist/versions/v1/api/persons-api.js +370 -24
- package/dist/versions/v1/api/pipelines-api.d.ts +69 -1
- package/dist/versions/v1/api/pipelines-api.js +95 -0
- package/dist/versions/v1/api/product-fields-api.d.ts +111 -1
- package/dist/versions/v1/api/product-fields-api.js +164 -0
- package/dist/versions/v1/api/products-api.d.ts +119 -1
- package/dist/versions/v1/api/products-api.js +172 -0
- package/dist/versions/v1/api/project-boards-api.d.ts +35 -1
- package/dist/versions/v1/api/project-boards-api.js +52 -0
- package/dist/versions/v1/api/project-phases-api.d.ts +37 -1
- package/dist/versions/v1/api/project-phases-api.js +54 -0
- package/dist/versions/v1/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v1/api/project-templates-api.js +55 -0
- package/dist/versions/v1/api/projects-api.d.ts +227 -1
- package/dist/versions/v1/api/projects-api.js +334 -0
- package/dist/versions/v1/api/recents-api.d.ts +22 -1
- package/dist/versions/v1/api/recents-api.js +30 -0
- package/dist/versions/v1/api/roles-api.d.ts +226 -1
- package/dist/versions/v1/api/roles-api.js +333 -0
- package/dist/versions/v1/api/stages-api.d.ts +24 -1
- package/dist/versions/v1/api/stages-api.js +32 -0
- package/dist/versions/v1/api/tasks-api.d.ts +97 -1
- package/dist/versions/v1/api/tasks-api.js +141 -0
- package/dist/versions/v1/api/user-connections-api.d.ts +17 -1
- package/dist/versions/v1/api/user-connections-api.js +25 -0
- package/dist/versions/v1/api/user-settings-api.d.ts +17 -1
- package/dist/versions/v1/api/user-settings-api.js +25 -0
- package/dist/versions/v1/api/users-api.d.ts +181 -1
- package/dist/versions/v1/api/users-api.js +270 -0
- package/dist/versions/v1/api/webhooks-api.d.ts +53 -1
- package/dist/versions/v1/api/webhooks-api.js +79 -0
- package/dist/versions/v1/base.d.ts +17 -0
- package/dist/versions/v1/base.js +24 -1
- package/dist/versions/v1/common.d.ts +1 -1
- package/dist/versions/v1/common.js +6 -3
- package/dist/versions/v2/api/activities-api.d.ts +107 -1
- package/dist/versions/v2/api/activities-api.js +151 -0
- package/dist/versions/v2/api/activity-fields-api.d.ts +40 -1
- package/dist/versions/v2/api/activity-fields-api.js +57 -0
- package/dist/versions/v2/api/beta-api.d.ts +451 -1
- package/dist/versions/v2/api/beta-api.js +666 -0
- package/dist/versions/v2/api/deal-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/deal-fields-api.js +223 -0
- package/dist/versions/v2/api/deal-installments-api.d.ts +81 -1
- package/dist/versions/v2/api/deal-installments-api.js +116 -0
- package/dist/versions/v2/api/deal-products-api.d.ts +141 -1
- package/dist/versions/v2/api/deal-products-api.js +203 -0
- package/dist/versions/v2/api/deals-api.d.ts +363 -1
- package/dist/versions/v2/api/deals-api.js +516 -1
- package/dist/versions/v2/api/item-search-api.d.ts +49 -1
- package/dist/versions/v2/api/item-search-api.js +66 -0
- package/dist/versions/v2/api/leads-api.d.ts +64 -1
- package/dist/versions/v2/api/leads-api.js +90 -0
- package/dist/versions/v2/api/organization-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/organization-fields-api.js +223 -0
- package/dist/versions/v2/api/organizations-api.d.ts +208 -1
- package/dist/versions/v2/api/organizations-api.js +297 -0
- package/dist/versions/v2/api/person-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/person-fields-api.js +223 -0
- package/dist/versions/v2/api/persons-api.d.ts +230 -1
- package/dist/versions/v2/api/persons-api.js +328 -0
- package/dist/versions/v2/api/pipelines-api.d.ts +95 -1
- package/dist/versions/v2/api/pipelines-api.js +139 -0
- package/dist/versions/v2/api/product-fields-api.d.ts +152 -1
- package/dist/versions/v2/api/product-fields-api.js +223 -0
- package/dist/versions/v2/api/products-api.d.ts +371 -1
- package/dist/versions/v2/api/products-api.js +541 -0
- package/dist/versions/v2/api/project-boards-api.d.ts +90 -1
- package/dist/versions/v2/api/project-boards-api.js +134 -0
- package/dist/versions/v2/api/project-fields-api.d.ts +150 -1
- package/dist/versions/v2/api/project-fields-api.js +221 -0
- package/dist/versions/v2/api/project-phases-api.d.ts +92 -1
- package/dist/versions/v2/api/project-phases-api.js +136 -0
- package/dist/versions/v2/api/project-templates-api.d.ts +38 -1
- package/dist/versions/v2/api/project-templates-api.js +55 -0
- package/dist/versions/v2/api/projects-api.d.ts +201 -1
- package/dist/versions/v2/api/projects-api.js +290 -0
- package/dist/versions/v2/api/stages-api.d.ts +96 -1
- package/dist/versions/v2/api/stages-api.js +140 -0
- package/dist/versions/v2/api/tasks-api.d.ts +98 -1
- package/dist/versions/v2/api/tasks-api.js +142 -0
- package/dist/versions/v2/api/users-api.d.ts +21 -1
- package/dist/versions/v2/api/users-api.js +29 -0
- package/dist/versions/v2/base.d.ts +17 -0
- package/dist/versions/v2/base.js +24 -1
- package/dist/versions/v2/common.d.ts +1 -1
- package/dist/versions/v2/common.js +6 -3
- package/package.json +1 -1
|
@@ -305,6 +305,20 @@ export const FiltersApiFp = function (configuration) {
|
|
|
305
305
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
306
306
|
});
|
|
307
307
|
},
|
|
308
|
+
/**
|
|
309
|
+
* Same as `addFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
310
|
+
* @summary Add a new filter
|
|
311
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
312
|
+
* @param {AddFilterRequest} [AddFilterRequest]
|
|
313
|
+
|
|
314
|
+
* @throws {RequiredError}
|
|
315
|
+
*/
|
|
316
|
+
addFilterWithHttpInfo(include_field_code, AddFilterRequest) {
|
|
317
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
318
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.addFilter(include_field_code, AddFilterRequest);
|
|
319
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
320
|
+
});
|
|
321
|
+
},
|
|
308
322
|
/**
|
|
309
323
|
* Marks a filter as deleted.
|
|
310
324
|
* @summary Delete a filter
|
|
@@ -318,6 +332,19 @@ export const FiltersApiFp = function (configuration) {
|
|
|
318
332
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
319
333
|
});
|
|
320
334
|
},
|
|
335
|
+
/**
|
|
336
|
+
* Same as `deleteFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
337
|
+
* @summary Delete a filter
|
|
338
|
+
* @param {number} id The ID of the filter
|
|
339
|
+
|
|
340
|
+
* @throws {RequiredError}
|
|
341
|
+
*/
|
|
342
|
+
deleteFilterWithHttpInfo(id) {
|
|
343
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
344
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFilter(id);
|
|
345
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
346
|
+
});
|
|
347
|
+
},
|
|
321
348
|
/**
|
|
322
349
|
* Marks multiple filters as deleted.
|
|
323
350
|
* @summary Delete multiple filters in bulk
|
|
@@ -331,6 +358,19 @@ export const FiltersApiFp = function (configuration) {
|
|
|
331
358
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
332
359
|
});
|
|
333
360
|
},
|
|
361
|
+
/**
|
|
362
|
+
* Same as `deleteFilters`, but resolves with the response body together with the HTTP status and headers.
|
|
363
|
+
* @summary Delete multiple filters in bulk
|
|
364
|
+
* @param {Set<number>} ids The comma-separated filter IDs to delete
|
|
365
|
+
|
|
366
|
+
* @throws {RequiredError}
|
|
367
|
+
*/
|
|
368
|
+
deleteFiltersWithHttpInfo(ids) {
|
|
369
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
370
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteFilters(ids);
|
|
371
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
372
|
+
});
|
|
373
|
+
},
|
|
334
374
|
/**
|
|
335
375
|
* Returns data about a specific filter. Note that this also returns the condition lines of the filter.
|
|
336
376
|
* @summary Get one filter
|
|
@@ -345,6 +385,20 @@ export const FiltersApiFp = function (configuration) {
|
|
|
345
385
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
346
386
|
});
|
|
347
387
|
},
|
|
388
|
+
/**
|
|
389
|
+
* Same as `getFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
390
|
+
* @summary Get one filter
|
|
391
|
+
* @param {number} id The ID of the filter
|
|
392
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
393
|
+
|
|
394
|
+
* @throws {RequiredError}
|
|
395
|
+
*/
|
|
396
|
+
getFilterWithHttpInfo(id, include_field_code) {
|
|
397
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
398
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFilter(id, include_field_code);
|
|
399
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
400
|
+
});
|
|
401
|
+
},
|
|
348
402
|
/**
|
|
349
403
|
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
350
404
|
* @summary Get all filter helpers
|
|
@@ -357,6 +411,18 @@ export const FiltersApiFp = function (configuration) {
|
|
|
357
411
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
358
412
|
});
|
|
359
413
|
},
|
|
414
|
+
/**
|
|
415
|
+
* Same as `getFilterHelpers`, but resolves with the response body together with the HTTP status and headers.
|
|
416
|
+
* @summary Get all filter helpers
|
|
417
|
+
|
|
418
|
+
* @throws {RequiredError}
|
|
419
|
+
*/
|
|
420
|
+
getFilterHelpersWithHttpInfo() {
|
|
421
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
422
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFilterHelpers();
|
|
423
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
424
|
+
});
|
|
425
|
+
},
|
|
360
426
|
/**
|
|
361
427
|
* Returns data about all filters.
|
|
362
428
|
* @summary Get all filters
|
|
@@ -370,6 +436,19 @@ export const FiltersApiFp = function (configuration) {
|
|
|
370
436
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
371
437
|
});
|
|
372
438
|
},
|
|
439
|
+
/**
|
|
440
|
+
* Same as `getFilters`, but resolves with the response body together with the HTTP status and headers.
|
|
441
|
+
* @summary Get all filters
|
|
442
|
+
* @param {'deals' | 'leads' | 'org' | 'people' | 'products' | 'activity' | 'projects'} [type] The types of filters to fetch
|
|
443
|
+
|
|
444
|
+
* @throws {RequiredError}
|
|
445
|
+
*/
|
|
446
|
+
getFiltersWithHttpInfo(type) {
|
|
447
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
448
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getFilters(type);
|
|
449
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
450
|
+
});
|
|
451
|
+
},
|
|
373
452
|
/**
|
|
374
453
|
* Updates an existing filter.
|
|
375
454
|
* @summary Update filter
|
|
@@ -385,6 +464,21 @@ export const FiltersApiFp = function (configuration) {
|
|
|
385
464
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
386
465
|
});
|
|
387
466
|
},
|
|
467
|
+
/**
|
|
468
|
+
* Same as `updateFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
469
|
+
* @summary Update filter
|
|
470
|
+
* @param {number} id The ID of the filter
|
|
471
|
+
* @param {boolean} [include_field_code] If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name
|
|
472
|
+
* @param {UpdateFilterRequest} [UpdateFilterRequest]
|
|
473
|
+
|
|
474
|
+
* @throws {RequiredError}
|
|
475
|
+
*/
|
|
476
|
+
updateFilterWithHttpInfo(id, include_field_code, UpdateFilterRequest) {
|
|
477
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
478
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateFilter(id, include_field_code, UpdateFilterRequest);
|
|
479
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
|
|
480
|
+
});
|
|
481
|
+
},
|
|
388
482
|
};
|
|
389
483
|
};
|
|
390
484
|
/**
|
|
@@ -404,6 +498,9 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
404
498
|
addFilter(requestParameters = {}) {
|
|
405
499
|
return localVarFp.addFilter(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(axios, basePath));
|
|
406
500
|
},
|
|
501
|
+
addFilterWithHttpInfo(requestParameters = {}) {
|
|
502
|
+
return localVarFp.addFilterWithHttpInfo(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(axios, basePath));
|
|
503
|
+
},
|
|
407
504
|
/**
|
|
408
505
|
* Marks a filter as deleted.
|
|
409
506
|
* @summary Delete a filter
|
|
@@ -414,6 +511,9 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
414
511
|
deleteFilter(requestParameters) {
|
|
415
512
|
return localVarFp.deleteFilter(requestParameters.id).then((request) => request(axios, basePath));
|
|
416
513
|
},
|
|
514
|
+
deleteFilterWithHttpInfo(requestParameters) {
|
|
515
|
+
return localVarFp.deleteFilterWithHttpInfo(requestParameters.id).then((request) => request(axios, basePath));
|
|
516
|
+
},
|
|
417
517
|
/**
|
|
418
518
|
* Marks multiple filters as deleted.
|
|
419
519
|
* @summary Delete multiple filters in bulk
|
|
@@ -424,6 +524,9 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
424
524
|
deleteFilters(requestParameters) {
|
|
425
525
|
return localVarFp.deleteFilters(requestParameters.ids).then((request) => request(axios, basePath));
|
|
426
526
|
},
|
|
527
|
+
deleteFiltersWithHttpInfo(requestParameters) {
|
|
528
|
+
return localVarFp.deleteFiltersWithHttpInfo(requestParameters.ids).then((request) => request(axios, basePath));
|
|
529
|
+
},
|
|
427
530
|
/**
|
|
428
531
|
* Returns data about a specific filter. Note that this also returns the condition lines of the filter.
|
|
429
532
|
* @summary Get one filter
|
|
@@ -434,6 +537,9 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
434
537
|
getFilter(requestParameters) {
|
|
435
538
|
return localVarFp.getFilter(requestParameters.id, requestParameters.include_field_code).then((request) => request(axios, basePath));
|
|
436
539
|
},
|
|
540
|
+
getFilterWithHttpInfo(requestParameters) {
|
|
541
|
+
return localVarFp.getFilterWithHttpInfo(requestParameters.id, requestParameters.include_field_code).then((request) => request(axios, basePath));
|
|
542
|
+
},
|
|
437
543
|
/**
|
|
438
544
|
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
439
545
|
* @summary Get all filter helpers
|
|
@@ -443,6 +549,9 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
443
549
|
getFilterHelpers() {
|
|
444
550
|
return localVarFp.getFilterHelpers().then((request) => request(axios, basePath));
|
|
445
551
|
},
|
|
552
|
+
getFilterHelpersWithHttpInfo() {
|
|
553
|
+
return localVarFp.getFilterHelpersWithHttpInfo().then((request) => request(axios, basePath));
|
|
554
|
+
},
|
|
446
555
|
/**
|
|
447
556
|
* Returns data about all filters.
|
|
448
557
|
* @summary Get all filters
|
|
@@ -453,6 +562,9 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
453
562
|
getFilters(requestParameters = {}) {
|
|
454
563
|
return localVarFp.getFilters(requestParameters.type).then((request) => request(axios, basePath));
|
|
455
564
|
},
|
|
565
|
+
getFiltersWithHttpInfo(requestParameters = {}) {
|
|
566
|
+
return localVarFp.getFiltersWithHttpInfo(requestParameters.type).then((request) => request(axios, basePath));
|
|
567
|
+
},
|
|
456
568
|
/**
|
|
457
569
|
* Updates an existing filter.
|
|
458
570
|
* @summary Update filter
|
|
@@ -463,6 +575,9 @@ export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
|
463
575
|
updateFilter(requestParameters) {
|
|
464
576
|
return localVarFp.updateFilter(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(axios, basePath));
|
|
465
577
|
},
|
|
578
|
+
updateFilterWithHttpInfo(requestParameters) {
|
|
579
|
+
return localVarFp.updateFilterWithHttpInfo(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(axios, basePath));
|
|
580
|
+
},
|
|
466
581
|
};
|
|
467
582
|
};
|
|
468
583
|
/**
|
|
@@ -483,6 +598,17 @@ export class FiltersApi extends BaseAPI {
|
|
|
483
598
|
addFilter(requestParameters = {}) {
|
|
484
599
|
return FiltersApiFp(this.configuration).addFilter(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
485
600
|
}
|
|
601
|
+
/**
|
|
602
|
+
* Same as `addFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
603
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
604
|
+
* @param {FiltersApiAddFilterRequest} requestParameters Request parameters.
|
|
605
|
+
|
|
606
|
+
* @throws {RequiredError}
|
|
607
|
+
* @memberof FiltersApi
|
|
608
|
+
*/
|
|
609
|
+
addFilterWithHttpInfo(requestParameters = {}) {
|
|
610
|
+
return FiltersApiFp(this.configuration).addFilterWithHttpInfo(requestParameters.include_field_code, requestParameters.AddFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
611
|
+
}
|
|
486
612
|
/**
|
|
487
613
|
* Marks a filter as deleted.
|
|
488
614
|
* @summary Delete a filter
|
|
@@ -494,6 +620,17 @@ export class FiltersApi extends BaseAPI {
|
|
|
494
620
|
deleteFilter(requestParameters) {
|
|
495
621
|
return FiltersApiFp(this.configuration).deleteFilter(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
496
622
|
}
|
|
623
|
+
/**
|
|
624
|
+
* Same as `deleteFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
625
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
626
|
+
* @param {FiltersApiDeleteFilterRequest} requestParameters Request parameters.
|
|
627
|
+
|
|
628
|
+
* @throws {RequiredError}
|
|
629
|
+
* @memberof FiltersApi
|
|
630
|
+
*/
|
|
631
|
+
deleteFilterWithHttpInfo(requestParameters) {
|
|
632
|
+
return FiltersApiFp(this.configuration).deleteFilterWithHttpInfo(requestParameters.id).then((request) => request(this.axios, this.basePath));
|
|
633
|
+
}
|
|
497
634
|
/**
|
|
498
635
|
* Marks multiple filters as deleted.
|
|
499
636
|
* @summary Delete multiple filters in bulk
|
|
@@ -505,6 +642,17 @@ export class FiltersApi extends BaseAPI {
|
|
|
505
642
|
deleteFilters(requestParameters) {
|
|
506
643
|
return FiltersApiFp(this.configuration).deleteFilters(requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
|
507
644
|
}
|
|
645
|
+
/**
|
|
646
|
+
* Same as `deleteFilters`, but resolves with the response body together with the HTTP status and headers.
|
|
647
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
648
|
+
* @param {FiltersApiDeleteFiltersRequest} requestParameters Request parameters.
|
|
649
|
+
|
|
650
|
+
* @throws {RequiredError}
|
|
651
|
+
* @memberof FiltersApi
|
|
652
|
+
*/
|
|
653
|
+
deleteFiltersWithHttpInfo(requestParameters) {
|
|
654
|
+
return FiltersApiFp(this.configuration).deleteFiltersWithHttpInfo(requestParameters.ids).then((request) => request(this.axios, this.basePath));
|
|
655
|
+
}
|
|
508
656
|
/**
|
|
509
657
|
* Returns data about a specific filter. Note that this also returns the condition lines of the filter.
|
|
510
658
|
* @summary Get one filter
|
|
@@ -516,6 +664,17 @@ export class FiltersApi extends BaseAPI {
|
|
|
516
664
|
getFilter(requestParameters) {
|
|
517
665
|
return FiltersApiFp(this.configuration).getFilter(requestParameters.id, requestParameters.include_field_code).then((request) => request(this.axios, this.basePath));
|
|
518
666
|
}
|
|
667
|
+
/**
|
|
668
|
+
* Same as `getFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
669
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
670
|
+
* @param {FiltersApiGetFilterRequest} requestParameters Request parameters.
|
|
671
|
+
|
|
672
|
+
* @throws {RequiredError}
|
|
673
|
+
* @memberof FiltersApi
|
|
674
|
+
*/
|
|
675
|
+
getFilterWithHttpInfo(requestParameters) {
|
|
676
|
+
return FiltersApiFp(this.configuration).getFilterWithHttpInfo(requestParameters.id, requestParameters.include_field_code).then((request) => request(this.axios, this.basePath));
|
|
677
|
+
}
|
|
519
678
|
/**
|
|
520
679
|
* Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href=\"/docs/api/v1/Filters#addFilter\">add</a> or <a href=\"/docs/api/v1/Filters#updateFilter\">update</a> filters. For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-a-filter\" target=\"_blank\" rel=\"noopener noreferrer\">adding a filter</a>.
|
|
521
680
|
* @summary Get all filter helpers
|
|
@@ -526,6 +685,16 @@ export class FiltersApi extends BaseAPI {
|
|
|
526
685
|
getFilterHelpers() {
|
|
527
686
|
return FiltersApiFp(this.configuration).getFilterHelpers().then((request) => request(this.axios, this.basePath));
|
|
528
687
|
}
|
|
688
|
+
/**
|
|
689
|
+
* Same as `getFilterHelpers`, but resolves with the response body together with the HTTP status and headers.
|
|
690
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
691
|
+
|
|
692
|
+
* @throws {RequiredError}
|
|
693
|
+
* @memberof FiltersApi
|
|
694
|
+
*/
|
|
695
|
+
getFilterHelpersWithHttpInfo() {
|
|
696
|
+
return FiltersApiFp(this.configuration).getFilterHelpersWithHttpInfo().then((request) => request(this.axios, this.basePath));
|
|
697
|
+
}
|
|
529
698
|
/**
|
|
530
699
|
* Returns data about all filters.
|
|
531
700
|
* @summary Get all filters
|
|
@@ -537,6 +706,17 @@ export class FiltersApi extends BaseAPI {
|
|
|
537
706
|
getFilters(requestParameters = {}) {
|
|
538
707
|
return FiltersApiFp(this.configuration).getFilters(requestParameters.type).then((request) => request(this.axios, this.basePath));
|
|
539
708
|
}
|
|
709
|
+
/**
|
|
710
|
+
* Same as `getFilters`, but resolves with the response body together with the HTTP status and headers.
|
|
711
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
712
|
+
* @param {FiltersApiGetFiltersRequest} requestParameters Request parameters.
|
|
713
|
+
|
|
714
|
+
* @throws {RequiredError}
|
|
715
|
+
* @memberof FiltersApi
|
|
716
|
+
*/
|
|
717
|
+
getFiltersWithHttpInfo(requestParameters = {}) {
|
|
718
|
+
return FiltersApiFp(this.configuration).getFiltersWithHttpInfo(requestParameters.type).then((request) => request(this.axios, this.basePath));
|
|
719
|
+
}
|
|
540
720
|
/**
|
|
541
721
|
* Updates an existing filter.
|
|
542
722
|
* @summary Update filter
|
|
@@ -548,4 +728,15 @@ export class FiltersApi extends BaseAPI {
|
|
|
548
728
|
updateFilter(requestParameters) {
|
|
549
729
|
return FiltersApiFp(this.configuration).updateFilter(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
550
730
|
}
|
|
731
|
+
/**
|
|
732
|
+
* Same as `updateFilter`, but resolves with the response body together with the HTTP status and headers.
|
|
733
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
734
|
+
* @param {FiltersApiUpdateFilterRequest} requestParameters Request parameters.
|
|
735
|
+
|
|
736
|
+
* @throws {RequiredError}
|
|
737
|
+
* @memberof FiltersApi
|
|
738
|
+
*/
|
|
739
|
+
updateFilterWithHttpInfo(requestParameters) {
|
|
740
|
+
return FiltersApiFp(this.configuration).updateFilterWithHttpInfo(requestParameters.id, requestParameters.include_field_code, requestParameters.UpdateFilterRequest).then((request) => request(this.axios, this.basePath));
|
|
741
|
+
}
|
|
551
742
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosInstance } from 'axios';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
14
|
+
import { RequestArgs, BaseAPI, ApiResponse } from '../base';
|
|
15
15
|
import { AddGoalRequest } from '../models';
|
|
16
16
|
import { BasicGoalRequest } from '../models';
|
|
17
17
|
import { DeleteGoalResponse } from '../models';
|
|
@@ -92,6 +92,14 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
|
|
|
92
92
|
* @throws {RequiredError}
|
|
93
93
|
*/
|
|
94
94
|
addGoal(AddGoalRequest?: AddGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertGoalResponse>>;
|
|
95
|
+
/**
|
|
96
|
+
* Same as `addGoal`, but resolves with the response body together with the HTTP status and headers.
|
|
97
|
+
* @summary Add a new goal
|
|
98
|
+
* @param {AddGoalRequest} [AddGoalRequest]
|
|
99
|
+
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
addGoalWithHttpInfo(AddGoalRequest?: AddGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertGoalResponse>>>;
|
|
95
103
|
/**
|
|
96
104
|
* Marks a goal as deleted.
|
|
97
105
|
* @summary Delete existing goal
|
|
@@ -100,6 +108,14 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
|
|
|
100
108
|
* @throws {RequiredError}
|
|
101
109
|
*/
|
|
102
110
|
deleteGoal(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteGoalResponse>>;
|
|
111
|
+
/**
|
|
112
|
+
* Same as `deleteGoal`, but resolves with the response body together with the HTTP status and headers.
|
|
113
|
+
* @summary Delete existing goal
|
|
114
|
+
* @param {string} id The ID of the goal
|
|
115
|
+
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
deleteGoalWithHttpInfo(id: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<DeleteGoalResponse>>>;
|
|
103
119
|
/**
|
|
104
120
|
* Gets the progress of a goal for the specified period.
|
|
105
121
|
* @summary Get result of a goal
|
|
@@ -110,6 +126,16 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
|
|
|
110
126
|
* @throws {RequiredError}
|
|
111
127
|
*/
|
|
112
128
|
getGoalResult(id: string, period_start: string, period_end: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetGoalResultResponse>>;
|
|
129
|
+
/**
|
|
130
|
+
* Same as `getGoalResult`, but resolves with the response body together with the HTTP status and headers.
|
|
131
|
+
* @summary Get result of a goal
|
|
132
|
+
* @param {string} id The ID of the goal that the results are looked for
|
|
133
|
+
* @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.
|
|
134
|
+
* @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.
|
|
135
|
+
|
|
136
|
+
* @throws {RequiredError}
|
|
137
|
+
*/
|
|
138
|
+
getGoalResultWithHttpInfo(id: string, period_start: string, period_end: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<GetGoalResultResponse>>>;
|
|
113
139
|
/**
|
|
114
140
|
* 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.
|
|
115
141
|
* @summary Find goals
|
|
@@ -130,6 +156,26 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
|
|
|
130
156
|
* @throws {RequiredError}
|
|
131
157
|
*/
|
|
132
158
|
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>>;
|
|
159
|
+
/**
|
|
160
|
+
* Same as `getGoals`, but resolves with the response body together with the HTTP status and headers.
|
|
161
|
+
* @summary Find goals
|
|
162
|
+
* @param {'deals_won' | 'deals_progressed' | 'activities_completed' | 'activities_added' | 'deals_started'} [type_name] The type of the goal. If provided, everyone\'s goals will be returned.
|
|
163
|
+
* @param {string} [title] The title of the goal
|
|
164
|
+
* @param {boolean} [is_active] Whether the goal is active or not
|
|
165
|
+
* @param {number} [assignee_id] The ID of the user who\'s goal to fetch. When omitted, only your goals will be returned.
|
|
166
|
+
* @param {'person' | 'company' | 'team'} [assignee_type] The type of the goal\'s assignee. If provided, everyone\'s goals will be returned.
|
|
167
|
+
* @param {number} [expected_outcome_target] The numeric value of the outcome. If provided, everyone\'s goals will be returned.
|
|
168
|
+
* @param {'quantity' | 'sum'} [expected_outcome_tracking_metric] The tracking metric of the expected outcome of the goal. If provided, everyone\'s goals will be returned.
|
|
169
|
+
* @param {number} [expected_outcome_currency_id] The numeric ID of the goal\'s currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone\'s goals will be returned.
|
|
170
|
+
* @param {Array<number>} [type_params_pipeline_id] An array of pipeline IDs or `null` for all pipelines. If provided, everyone\'s goals will be returned.
|
|
171
|
+
* @param {number} [type_params_stage_id] The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone\'s goals will be returned.
|
|
172
|
+
* @param {Array<number>} [type_params_activity_type_id] An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone\'s goals will be returned.
|
|
173
|
+
* @param {string} [period_start] The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
|
|
174
|
+
* @param {string} [period_end] The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
|
|
175
|
+
|
|
176
|
+
* @throws {RequiredError}
|
|
177
|
+
*/
|
|
178
|
+
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>>>;
|
|
133
179
|
/**
|
|
134
180
|
* Updates an existing goal.
|
|
135
181
|
* @summary Update existing goal
|
|
@@ -139,6 +185,15 @@ export declare const GoalsApiFp: (configuration?: Configuration) => {
|
|
|
139
185
|
* @throws {RequiredError}
|
|
140
186
|
*/
|
|
141
187
|
updateGoal(id: string, BasicGoalRequest?: BasicGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpsertGoalResponse>>;
|
|
188
|
+
/**
|
|
189
|
+
* Same as `updateGoal`, but resolves with the response body together with the HTTP status and headers.
|
|
190
|
+
* @summary Update existing goal
|
|
191
|
+
* @param {string} id The ID of the goal
|
|
192
|
+
* @param {BasicGoalRequest} [BasicGoalRequest]
|
|
193
|
+
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
updateGoalWithHttpInfo(id: string, BasicGoalRequest?: BasicGoalRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<ApiResponse<UpsertGoalResponse>>>;
|
|
142
197
|
};
|
|
143
198
|
/**
|
|
144
199
|
* GoalsApi - factory interface
|
|
@@ -153,6 +208,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
153
208
|
* @throws {RequiredError}
|
|
154
209
|
*/
|
|
155
210
|
addGoal(requestParameters?: GoalsApiAddGoalRequest): Promise<UpsertGoalResponse>;
|
|
211
|
+
addGoalWithHttpInfo(requestParameters?: GoalsApiAddGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
|
|
156
212
|
/**
|
|
157
213
|
* Marks a goal as deleted.
|
|
158
214
|
* @summary Delete existing goal
|
|
@@ -161,6 +217,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
161
217
|
* @throws {RequiredError}
|
|
162
218
|
*/
|
|
163
219
|
deleteGoal(requestParameters: GoalsApiDeleteGoalRequest): Promise<DeleteGoalResponse>;
|
|
220
|
+
deleteGoalWithHttpInfo(requestParameters: GoalsApiDeleteGoalRequest): Promise<ApiResponse<DeleteGoalResponse>>;
|
|
164
221
|
/**
|
|
165
222
|
* Gets the progress of a goal for the specified period.
|
|
166
223
|
* @summary Get result of a goal
|
|
@@ -169,6 +226,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
169
226
|
* @throws {RequiredError}
|
|
170
227
|
*/
|
|
171
228
|
getGoalResult(requestParameters: GoalsApiGetGoalResultRequest): Promise<GetGoalResultResponse>;
|
|
229
|
+
getGoalResultWithHttpInfo(requestParameters: GoalsApiGetGoalResultRequest): Promise<ApiResponse<GetGoalResultResponse>>;
|
|
172
230
|
/**
|
|
173
231
|
* 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.
|
|
174
232
|
* @summary Find goals
|
|
@@ -177,6 +235,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
177
235
|
* @throws {RequiredError}
|
|
178
236
|
*/
|
|
179
237
|
getGoals(requestParameters?: GoalsApiGetGoalsRequest): Promise<GetGoalsResponse>;
|
|
238
|
+
getGoalsWithHttpInfo(requestParameters?: GoalsApiGetGoalsRequest): Promise<ApiResponse<GetGoalsResponse>>;
|
|
180
239
|
/**
|
|
181
240
|
* Updates an existing goal.
|
|
182
241
|
* @summary Update existing goal
|
|
@@ -185,6 +244,7 @@ export declare const GoalsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
185
244
|
* @throws {RequiredError}
|
|
186
245
|
*/
|
|
187
246
|
updateGoal(requestParameters: GoalsApiUpdateGoalRequest): Promise<UpsertGoalResponse>;
|
|
247
|
+
updateGoalWithHttpInfo(requestParameters: GoalsApiUpdateGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
|
|
188
248
|
};
|
|
189
249
|
/**
|
|
190
250
|
* Request parameters for addGoal operation in GoalsApi.
|
|
@@ -357,6 +417,15 @@ export declare class GoalsApi extends BaseAPI {
|
|
|
357
417
|
* @memberof GoalsApi
|
|
358
418
|
*/
|
|
359
419
|
addGoal(requestParameters?: GoalsApiAddGoalRequest): Promise<UpsertGoalResponse>;
|
|
420
|
+
/**
|
|
421
|
+
* Same as `addGoal`, but resolves with the response body together with the HTTP status and headers.
|
|
422
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
423
|
+
* @param {GoalsApiAddGoalRequest} requestParameters Request parameters.
|
|
424
|
+
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
* @memberof GoalsApi
|
|
427
|
+
*/
|
|
428
|
+
addGoalWithHttpInfo(requestParameters?: GoalsApiAddGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
|
|
360
429
|
/**
|
|
361
430
|
* Marks a goal as deleted.
|
|
362
431
|
* @summary Delete existing goal
|
|
@@ -366,6 +435,15 @@ export declare class GoalsApi extends BaseAPI {
|
|
|
366
435
|
* @memberof GoalsApi
|
|
367
436
|
*/
|
|
368
437
|
deleteGoal(requestParameters: GoalsApiDeleteGoalRequest): Promise<DeleteGoalResponse>;
|
|
438
|
+
/**
|
|
439
|
+
* Same as `deleteGoal`, but resolves with the response body together with the HTTP status and headers.
|
|
440
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
441
|
+
* @param {GoalsApiDeleteGoalRequest} requestParameters Request parameters.
|
|
442
|
+
|
|
443
|
+
* @throws {RequiredError}
|
|
444
|
+
* @memberof GoalsApi
|
|
445
|
+
*/
|
|
446
|
+
deleteGoalWithHttpInfo(requestParameters: GoalsApiDeleteGoalRequest): Promise<ApiResponse<DeleteGoalResponse>>;
|
|
369
447
|
/**
|
|
370
448
|
* Gets the progress of a goal for the specified period.
|
|
371
449
|
* @summary Get result of a goal
|
|
@@ -375,6 +453,15 @@ export declare class GoalsApi extends BaseAPI {
|
|
|
375
453
|
* @memberof GoalsApi
|
|
376
454
|
*/
|
|
377
455
|
getGoalResult(requestParameters: GoalsApiGetGoalResultRequest): Promise<GetGoalResultResponse>;
|
|
456
|
+
/**
|
|
457
|
+
* Same as `getGoalResult`, but resolves with the response body together with the HTTP status and headers.
|
|
458
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
459
|
+
* @param {GoalsApiGetGoalResultRequest} requestParameters Request parameters.
|
|
460
|
+
|
|
461
|
+
* @throws {RequiredError}
|
|
462
|
+
* @memberof GoalsApi
|
|
463
|
+
*/
|
|
464
|
+
getGoalResultWithHttpInfo(requestParameters: GoalsApiGetGoalResultRequest): Promise<ApiResponse<GetGoalResultResponse>>;
|
|
378
465
|
/**
|
|
379
466
|
* 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.
|
|
380
467
|
* @summary Find goals
|
|
@@ -384,6 +471,15 @@ export declare class GoalsApi extends BaseAPI {
|
|
|
384
471
|
* @memberof GoalsApi
|
|
385
472
|
*/
|
|
386
473
|
getGoals(requestParameters?: GoalsApiGetGoalsRequest): Promise<GetGoalsResponse>;
|
|
474
|
+
/**
|
|
475
|
+
* Same as `getGoals`, but resolves with the response body together with the HTTP status and headers.
|
|
476
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
477
|
+
* @param {GoalsApiGetGoalsRequest} requestParameters Request parameters.
|
|
478
|
+
|
|
479
|
+
* @throws {RequiredError}
|
|
480
|
+
* @memberof GoalsApi
|
|
481
|
+
*/
|
|
482
|
+
getGoalsWithHttpInfo(requestParameters?: GoalsApiGetGoalsRequest): Promise<ApiResponse<GetGoalsResponse>>;
|
|
387
483
|
/**
|
|
388
484
|
* Updates an existing goal.
|
|
389
485
|
* @summary Update existing goal
|
|
@@ -393,4 +489,13 @@ export declare class GoalsApi extends BaseAPI {
|
|
|
393
489
|
* @memberof GoalsApi
|
|
394
490
|
*/
|
|
395
491
|
updateGoal(requestParameters: GoalsApiUpdateGoalRequest): Promise<UpsertGoalResponse>;
|
|
492
|
+
/**
|
|
493
|
+
* Same as `updateGoal`, but resolves with the response body together with the HTTP status and headers.
|
|
494
|
+
* Error rejections keep their usual shape and additionally carry `$response: { status, headers }`.
|
|
495
|
+
* @param {GoalsApiUpdateGoalRequest} requestParameters Request parameters.
|
|
496
|
+
|
|
497
|
+
* @throws {RequiredError}
|
|
498
|
+
* @memberof GoalsApi
|
|
499
|
+
*/
|
|
500
|
+
updateGoalWithHttpInfo(requestParameters: GoalsApiUpdateGoalRequest): Promise<ApiResponse<UpsertGoalResponse>>;
|
|
396
501
|
}
|