pipedrive 36.0.0 → 36.1.0

package/dist/esm/versions/v2/api/organization-fields-api.js

@@ -359,6 +359,19 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Create one organization field
+         * @param {AddOrganizationFieldRequest} AddOrganizationFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addOrganizationFieldWithHttpInfo(AddOrganizationFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addOrganizationField(AddOrganizationFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
          * @summary Add organization field options in bulk
@@ -373,6 +386,20 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addOrganizationFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add organization field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addOrganizationFieldOptionsWithHttpInfo(field_code, AddDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addOrganizationFieldOptions(field_code, AddDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one organization field
@@ -386,6 +413,19 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete one organization field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deleteOrganizationFieldWithHttpInfo(field_code) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationField(field_code);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
          * @summary Delete organization field options in bulk
@@ -400,6 +440,20 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deleteOrganizationFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete organization field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deleteOrganizationFieldOptionsWithHttpInfo(field_code, DeleteDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationFieldOptions(field_code, DeleteDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about a specific organization field.
          * @summary Get one organization field
@@ -414,6 +468,20 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get one organization field
+         * @param {string} field_code The unique code identifying the field
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+
+         * @throws {RequiredError}
+         */
+        getOrganizationFieldWithHttpInfo(field_code, include_fields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationField(field_code, include_fields);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about all organization fields in the company.
          * @summary Get all organization fields
@@ -429,6 +497,21 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getOrganizationFields`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all organization fields
+         * @param {Set<'ui_visibility' | 'important_fields' | 'required_fields'>} [include_fields] Optional comma separated string array of additional data namespaces to include in response
+         * @param {number} [limit] For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
+         * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
+
+         * @throws {RequiredError}
+         */
+        getOrganizationFieldsWithHttpInfo(include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationFields(include_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
          * @summary Update one organization field
@@ -443,6 +526,20 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateOrganizationField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update one organization field
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdateOrganizationFieldRequest} UpdateOrganizationFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updateOrganizationFieldWithHttpInfo(field_code, UpdateOrganizationFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateOrganizationField(field_code, UpdateOrganizationFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
          * @summary Update organization field options in bulk
@@ -457,6 +554,20 @@ export const OrganizationFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updateOrganizationFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update organization field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updateOrganizationFieldOptionsWithHttpInfo(field_code, UpdateDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updateOrganizationFieldOptions(field_code, UpdateDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 /**
@@ -476,6 +587,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         addOrganizationField(requestParameters) {
             return localVarFp.addOrganizationField(requestParameters.AddOrganizationFieldRequest).then((request) => request(axios, basePath));
         },
+        addOrganizationFieldWithHttpInfo(requestParameters) {
+            return localVarFp.addOrganizationFieldWithHttpInfo(requestParameters.AddOrganizationFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
          * @summary Add organization field options in bulk
@@ -486,6 +600,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         addOrganizationFieldOptions(requestParameters) {
             return localVarFp.addOrganizationFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        addOrganizationFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.addOrganizationFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one organization field
@@ -496,6 +613,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         deleteOrganizationField(requestParameters) {
             return localVarFp.deleteOrganizationField(requestParameters.field_code).then((request) => request(axios, basePath));
         },
+        deleteOrganizationFieldWithHttpInfo(requestParameters) {
+            return localVarFp.deleteOrganizationFieldWithHttpInfo(requestParameters.field_code).then((request) => request(axios, basePath));
+        },
         /**
          * Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
          * @summary Delete organization field options in bulk
@@ -506,6 +626,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         deleteOrganizationFieldOptions(requestParameters) {
             return localVarFp.deleteOrganizationFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        deleteOrganizationFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.deleteOrganizationFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about a specific organization field.
          * @summary Get one organization field
@@ -516,6 +639,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         getOrganizationField(requestParameters) {
             return localVarFp.getOrganizationField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
         },
+        getOrganizationFieldWithHttpInfo(requestParameters) {
+            return localVarFp.getOrganizationFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about all organization fields in the company.
          * @summary Get all organization fields
@@ -526,6 +652,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         getOrganizationFields(requestParameters = {}) {
             return localVarFp.getOrganizationFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
+        getOrganizationFieldsWithHttpInfo(requestParameters = {}) {
+            return localVarFp.getOrganizationFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
          * @summary Update one organization field
@@ -536,6 +665,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         updateOrganizationField(requestParameters) {
             return localVarFp.updateOrganizationField(requestParameters.field_code, requestParameters.UpdateOrganizationFieldRequest).then((request) => request(axios, basePath));
         },
+        updateOrganizationFieldWithHttpInfo(requestParameters) {
+            return localVarFp.updateOrganizationFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdateOrganizationFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
          * @summary Update organization field options in bulk
@@ -546,6 +678,9 @@ export const OrganizationFieldsApiFactory = function (configuration, basePath, a
         updateOrganizationFieldOptions(requestParameters) {
             return localVarFp.updateOrganizationFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        updateOrganizationFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.updateOrganizationFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -566,6 +701,17 @@ export class OrganizationFieldsApi extends BaseAPI {
     addOrganizationField(requestParameters) {
         return OrganizationFieldsApiFp(this.configuration).addOrganizationField(requestParameters.AddOrganizationFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addOrganizationField`, 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 {OrganizationFieldsApiAddOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    addOrganizationFieldWithHttpInfo(requestParameters) {
+        return OrganizationFieldsApiFp(this.configuration).addOrganizationFieldWithHttpInfo(requestParameters.AddOrganizationFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds new options to an organization custom field that supports options (enum or set field types). This operation is atomic - all options are added or none are added. Returns only the newly added options.
      * @summary Add organization field options in bulk
@@ -577,6 +723,17 @@ export class OrganizationFieldsApi extends BaseAPI {
     addOrganizationFieldOptions(requestParameters) {
         return OrganizationFieldsApiFp(this.configuration).addOrganizationFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addOrganizationFieldOptions`, 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 {OrganizationFieldsApiAddOrganizationFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    addOrganizationFieldOptionsWithHttpInfo(requestParameters) {
+        return OrganizationFieldsApiFp(this.configuration).addOrganizationFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Marks a custom field as deleted.
      * @summary Delete one organization field
@@ -588,6 +745,17 @@ export class OrganizationFieldsApi extends BaseAPI {
     deleteOrganizationField(requestParameters) {
         return OrganizationFieldsApiFp(this.configuration).deleteOrganizationField(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteOrganizationField`, 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 {OrganizationFieldsApiDeleteOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    deleteOrganizationFieldWithHttpInfo(requestParameters) {
+        return OrganizationFieldsApiFp(this.configuration).deleteOrganizationFieldWithHttpInfo(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Removes existing options from an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the deleted options.
      * @summary Delete organization field options in bulk
@@ -599,6 +767,17 @@ export class OrganizationFieldsApi extends BaseAPI {
     deleteOrganizationFieldOptions(requestParameters) {
         return OrganizationFieldsApiFp(this.configuration).deleteOrganizationFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deleteOrganizationFieldOptions`, 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 {OrganizationFieldsApiDeleteOrganizationFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    deleteOrganizationFieldOptionsWithHttpInfo(requestParameters) {
+        return OrganizationFieldsApiFp(this.configuration).deleteOrganizationFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about a specific organization field.
      * @summary Get one organization field
@@ -610,6 +789,17 @@ export class OrganizationFieldsApi extends BaseAPI {
     getOrganizationField(requestParameters) {
         return OrganizationFieldsApiFp(this.configuration).getOrganizationField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getOrganizationField`, 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 {OrganizationFieldsApiGetOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    getOrganizationFieldWithHttpInfo(requestParameters) {
+        return OrganizationFieldsApiFp(this.configuration).getOrganizationFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about all organization fields in the company.
      * @summary Get all organization fields
@@ -621,6 +811,17 @@ export class OrganizationFieldsApi extends BaseAPI {
     getOrganizationFields(requestParameters = {}) {
         return OrganizationFieldsApiFp(this.configuration).getOrganizationFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getOrganizationFields`, 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 {OrganizationFieldsApiGetOrganizationFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    getOrganizationFieldsWithHttpInfo(requestParameters = {}) {
+        return OrganizationFieldsApiFp(this.configuration).getOrganizationFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates an organization custom field. The field_code and field_type cannot be changed. At least one field must be provided in the request body.
      * @summary Update one organization field
@@ -632,6 +833,17 @@ export class OrganizationFieldsApi extends BaseAPI {
     updateOrganizationField(requestParameters) {
         return OrganizationFieldsApiFp(this.configuration).updateOrganizationField(requestParameters.field_code, requestParameters.UpdateOrganizationFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateOrganizationField`, 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 {OrganizationFieldsApiUpdateOrganizationFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    updateOrganizationFieldWithHttpInfo(requestParameters) {
+        return OrganizationFieldsApiFp(this.configuration).updateOrganizationFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdateOrganizationFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates existing options for an organization custom field. This operation is atomic and fails if any of the specified option IDs do not exist. Returns only the updated options.
      * @summary Update organization field options in bulk
@@ -643,4 +855,15 @@ export class OrganizationFieldsApi extends BaseAPI {
     updateOrganizationFieldOptions(requestParameters) {
         return OrganizationFieldsApiFp(this.configuration).updateOrganizationFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updateOrganizationFieldOptions`, 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 {OrganizationFieldsApiUpdateOrganizationFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationFieldsApi
+     */
+    updateOrganizationFieldOptionsWithHttpInfo(requestParameters) {
+        return OrganizationFieldsApiFp(this.configuration).updateOrganizationFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
 }