pipedrive 36.0.0 → 36.1.0

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

@@ -359,6 +359,19 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addPersonField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Create one person field
+         * @param {AddPersonFieldRequest} AddPersonFieldRequest
+
+         * @throws {RequiredError}
+         */
+        addPersonFieldWithHttpInfo(AddPersonFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addPersonField(AddPersonFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Adds new options to a person 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 person field options in bulk
@@ -373,6 +386,20 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `addPersonFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Add person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<AddDealFieldOptionsRequestInner>} AddDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        addPersonFieldOptionsWithHttpInfo(field_code, AddDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addPersonFieldOptions(field_code, AddDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one person field
@@ -386,6 +413,19 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deletePersonField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete one person field
+         * @param {string} field_code The unique code identifying the field
+
+         * @throws {RequiredError}
+         */
+        deletePersonFieldWithHttpInfo(field_code) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersonField(field_code);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Removes existing options from a person 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 person field options in bulk
@@ -400,6 +440,20 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `deletePersonFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Delete person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<DeleteDealFieldOptionsRequestInner>} DeleteDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        deletePersonFieldOptionsWithHttpInfo(field_code, DeleteDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersonFieldOptions(field_code, DeleteDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about a specific person field.
          * @summary Get one person field
@@ -414,6 +468,20 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getPersonField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get one person 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}
+         */
+        getPersonFieldWithHttpInfo(field_code, include_fields) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonField(field_code, include_fields);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Returns metadata about all person fields in the company.
          * @summary Get all person fields
@@ -429,6 +497,21 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `getPersonFields`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Get all person 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}
+         */
+        getPersonFieldsWithHttpInfo(include_fields, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFields(include_fields, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates a person 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 person field
@@ -443,6 +526,20 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updatePersonField`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update one person field
+         * @param {string} field_code The unique code identifying the field
+         * @param {UpdatePersonFieldRequest} UpdatePersonFieldRequest
+
+         * @throws {RequiredError}
+         */
+        updatePersonFieldWithHttpInfo(field_code, UpdatePersonFieldRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePersonField(field_code, UpdatePersonFieldRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
         /**
          * Updates existing options for a person 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 person field options in bulk
@@ -457,6 +554,20 @@ export const PersonFieldsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Same as `updatePersonFieldOptions`, but resolves with the response body together with the HTTP status and headers.
+         * @summary Update person field options in bulk
+         * @param {string} field_code The unique code identifying the field
+         * @param {Array<UpdateDealFieldOptionsRequestInner>} UpdateDealFieldOptionsRequestInner
+
+         * @throws {RequiredError}
+         */
+        updatePersonFieldOptionsWithHttpInfo(field_code, UpdateDealFieldOptionsRequestInner) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePersonFieldOptions(field_code, UpdateDealFieldOptionsRequestInner);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration, true);
+            });
+        },
     };
 };
 /**
@@ -476,6 +587,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         addPersonField(requestParameters) {
             return localVarFp.addPersonField(requestParameters.AddPersonFieldRequest).then((request) => request(axios, basePath));
         },
+        addPersonFieldWithHttpInfo(requestParameters) {
+            return localVarFp.addPersonFieldWithHttpInfo(requestParameters.AddPersonFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Adds new options to a person 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 person field options in bulk
@@ -486,6 +600,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         addPersonFieldOptions(requestParameters) {
             return localVarFp.addPersonFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        addPersonFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.addPersonFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Marks a custom field as deleted.
          * @summary Delete one person field
@@ -496,6 +613,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         deletePersonField(requestParameters) {
             return localVarFp.deletePersonField(requestParameters.field_code).then((request) => request(axios, basePath));
         },
+        deletePersonFieldWithHttpInfo(requestParameters) {
+            return localVarFp.deletePersonFieldWithHttpInfo(requestParameters.field_code).then((request) => request(axios, basePath));
+        },
         /**
          * Removes existing options from a person 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 person field options in bulk
@@ -506,6 +626,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         deletePersonFieldOptions(requestParameters) {
             return localVarFp.deletePersonFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        deletePersonFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.deletePersonFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about a specific person field.
          * @summary Get one person field
@@ -516,6 +639,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         getPersonField(requestParameters) {
             return localVarFp.getPersonField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
         },
+        getPersonFieldWithHttpInfo(requestParameters) {
+            return localVarFp.getPersonFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(axios, basePath));
+        },
         /**
          * Returns metadata about all person fields in the company.
          * @summary Get all person fields
@@ -526,6 +652,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         getPersonFields(requestParameters = {}) {
             return localVarFp.getPersonFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
+        getPersonFieldsWithHttpInfo(requestParameters = {}) {
+            return localVarFp.getPersonFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Updates a person 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 person field
@@ -536,6 +665,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         updatePersonField(requestParameters) {
             return localVarFp.updatePersonField(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest).then((request) => request(axios, basePath));
         },
+        updatePersonFieldWithHttpInfo(requestParameters) {
+            return localVarFp.updatePersonFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Updates existing options for a person 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 person field options in bulk
@@ -546,6 +678,9 @@ export const PersonFieldsApiFactory = function (configuration, basePath, axios)
         updatePersonFieldOptions(requestParameters) {
             return localVarFp.updatePersonFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
         },
+        updatePersonFieldOptionsWithHttpInfo(requestParameters) {
+            return localVarFp.updatePersonFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -566,6 +701,17 @@ export class PersonFieldsApi extends BaseAPI {
     addPersonField(requestParameters) {
         return PersonFieldsApiFp(this.configuration).addPersonField(requestParameters.AddPersonFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addPersonField`, 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 {PersonFieldsApiAddPersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    addPersonFieldWithHttpInfo(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).addPersonFieldWithHttpInfo(requestParameters.AddPersonFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds new options to a person 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 person field options in bulk
@@ -577,6 +723,17 @@ export class PersonFieldsApi extends BaseAPI {
     addPersonFieldOptions(requestParameters) {
         return PersonFieldsApiFp(this.configuration).addPersonFieldOptions(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `addPersonFieldOptions`, 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 {PersonFieldsApiAddPersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    addPersonFieldOptionsWithHttpInfo(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).addPersonFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.AddDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Marks a custom field as deleted.
      * @summary Delete one person field
@@ -588,6 +745,17 @@ export class PersonFieldsApi extends BaseAPI {
     deletePersonField(requestParameters) {
         return PersonFieldsApiFp(this.configuration).deletePersonField(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deletePersonField`, 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 {PersonFieldsApiDeletePersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    deletePersonFieldWithHttpInfo(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).deletePersonFieldWithHttpInfo(requestParameters.field_code).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Removes existing options from a person 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 person field options in bulk
@@ -599,6 +767,17 @@ export class PersonFieldsApi extends BaseAPI {
     deletePersonFieldOptions(requestParameters) {
         return PersonFieldsApiFp(this.configuration).deletePersonFieldOptions(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `deletePersonFieldOptions`, 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 {PersonFieldsApiDeletePersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    deletePersonFieldOptionsWithHttpInfo(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).deletePersonFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.DeleteDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about a specific person field.
      * @summary Get one person field
@@ -610,6 +789,17 @@ export class PersonFieldsApi extends BaseAPI {
     getPersonField(requestParameters) {
         return PersonFieldsApiFp(this.configuration).getPersonField(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getPersonField`, 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 {PersonFieldsApiGetPersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    getPersonFieldWithHttpInfo(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).getPersonFieldWithHttpInfo(requestParameters.field_code, requestParameters.include_fields).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns metadata about all person fields in the company.
      * @summary Get all person fields
@@ -621,6 +811,17 @@ export class PersonFieldsApi extends BaseAPI {
     getPersonFields(requestParameters = {}) {
         return PersonFieldsApiFp(this.configuration).getPersonFields(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `getPersonFields`, 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 {PersonFieldsApiGetPersonFieldsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    getPersonFieldsWithHttpInfo(requestParameters = {}) {
+        return PersonFieldsApiFp(this.configuration).getPersonFieldsWithHttpInfo(requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates a person 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 person field
@@ -632,6 +833,17 @@ export class PersonFieldsApi extends BaseAPI {
     updatePersonField(requestParameters) {
         return PersonFieldsApiFp(this.configuration).updatePersonField(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updatePersonField`, 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 {PersonFieldsApiUpdatePersonFieldRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    updatePersonFieldWithHttpInfo(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).updatePersonFieldWithHttpInfo(requestParameters.field_code, requestParameters.UpdatePersonFieldRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Updates existing options for a person 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 person field options in bulk
@@ -643,4 +855,15 @@ export class PersonFieldsApi extends BaseAPI {
     updatePersonFieldOptions(requestParameters) {
         return PersonFieldsApiFp(this.configuration).updatePersonFieldOptions(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Same as `updatePersonFieldOptions`, 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 {PersonFieldsApiUpdatePersonFieldOptionsRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonFieldsApi
+     */
+    updatePersonFieldOptionsWithHttpInfo(requestParameters) {
+        return PersonFieldsApiFp(this.configuration).updatePersonFieldOptionsWithHttpInfo(requestParameters.field_code, requestParameters.UpdateDealFieldOptionsRequestInner).then((request) => request(this.axios, this.basePath));
+    }
 }