pipedrive 24.2.0 → 26.0.0

package/dist/esm/versions/v2/api/persons-api.js

@@ -33,7 +33,7 @@ import { BASE_PATH, BaseAPI } from '../base';
 export const PersonsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Adds a new person.
+         * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
          * @summary Add a new person
          * @param {AddPersonRequest} [AddPersonRequest]
 
@@ -65,6 +65,43 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Adds a user as a follower to the person.
+         * @summary Add a follower to a person
+         * @param {number} id The ID of the person
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addPersonFollower: (id, AddDealFollowerRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('addPersonFollower', 'id', id);
+            const localVarPath = `/persons/{id}/followers`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            localVarRequestOptions.data = serializeDataIfNeeded(AddDealFollowerRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Marks a person as deleted. After 30 days, the person will be permanently deleted.
          * @summary Delete a person
@@ -99,6 +136,44 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Deletes a user follower from the person.
+         * @summary Delete a follower from a person
+         * @param {number} id The ID of the person
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deletePersonFollower: (id, follower_id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deletePersonFollower', 'id', id);
+            // verify required parameter 'follower_id' is not null or undefined
+            assertParamExists('deletePersonFollower', 'follower_id', follower_id);
+            const localVarPath = `/persons/{id}/followers/{follower_id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"follower_id"}}`, encodeURIComponent(String(follower_id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:full"], configuration);
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
          * @summary Get details of a person
@@ -141,6 +216,90 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Lists users who are following the person.
+         * @summary List followers of a person
+         * @param {number} id The ID of the person
+         * @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}
+         */
+        getPersonFollowers: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getPersonFollowers', 'id', id);
+            const localVarPath = `/persons/{id}/followers`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Lists changelogs about users have followed the person.
+         * @summary List followers changelog of a person
+         * @param {number} id The ID of the person
+         * @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}
+         */
+        getPersonFollowersChangelog: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getPersonFollowersChangelog', 'id', id);
+            const localVarPath = `/persons/{id}/followers/changelog`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, baseOptions);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication api_key required
+            yield setApiKeyToObject(localVarQueryParameter, "api_token", configuration);
+            // authentication oauth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "oauth2", ["contacts:read", "contacts:full"], configuration);
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
          * @summary Get all persons
@@ -280,7 +439,7 @@ export const PersonsApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Updates the properties of a person.
+         * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
          * @summary Update a person
          * @param {number} id The ID of the person
          * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -326,7 +485,7 @@ export const PersonsApiFp = function (configuration) {
     const localVarAxiosParamCreator = PersonsApiAxiosParamCreator(configuration);
     return {
         /**
-         * Adds a new person.
+         * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
          * @summary Add a new person
          * @param {AddPersonRequest} [AddPersonRequest]
 
@@ -338,6 +497,20 @@ export const PersonsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Adds a user as a follower to the person.
+         * @summary Add a follower to a person
+         * @param {number} id The ID of the person
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addPersonFollower(id, AddDealFollowerRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addPersonFollower(id, AddDealFollowerRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Marks a person as deleted. After 30 days, the person will be permanently deleted.
          * @summary Delete a person
@@ -351,6 +524,20 @@ export const PersonsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Deletes a user follower from the person.
+         * @summary Delete a follower from a person
+         * @param {number} id The ID of the person
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deletePersonFollower(id, follower_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePersonFollower(id, follower_id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
          * @summary Get details of a person
@@ -366,6 +553,36 @@ export const PersonsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Lists users who are following the person.
+         * @summary List followers of a person
+         * @param {number} id The ID of the person
+         * @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}
+         */
+        getPersonFollowers(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFollowers(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Lists changelogs about users have followed the person.
+         * @summary List followers changelog of a person
+         * @param {number} id The ID of the person
+         * @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}
+         */
+        getPersonFollowersChangelog(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPersonFollowersChangelog(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
          * @summary Get all persons
@@ -410,7 +627,7 @@ export const PersonsApiFp = function (configuration) {
             });
         },
         /**
-         * Updates the properties of a person.
+         * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
          * @summary Update a person
          * @param {number} id The ID of the person
          * @param {UpdatePersonRequest} [UpdatePersonRequest]
@@ -433,7 +650,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = PersonsApiFp(configuration);
     return {
         /**
-         * Adds a new person.
+         * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
          * @summary Add a new person
          * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
 
@@ -442,6 +659,16 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
         addPerson(requestParameters = {}) {
             return localVarFp.addPerson(requestParameters.AddPersonRequest).then((request) => request(axios, basePath));
         },
+        /**
+         * Adds a user as a follower to the person.
+         * @summary Add a follower to a person
+         * @param {PersonsApiAddPersonFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addPersonFollower(requestParameters) {
+            return localVarFp.addPersonFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Marks a person as deleted. After 30 days, the person will be permanently deleted.
          * @summary Delete a person
@@ -452,6 +679,16 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
         deletePerson(requestParameters) {
             return localVarFp.deletePerson(requestParameters.id).then((request) => request(axios, basePath));
         },
+        /**
+         * Deletes a user follower from the person.
+         * @summary Delete a follower from a person
+         * @param {PersonsApiDeletePersonFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deletePersonFollower(requestParameters) {
+            return localVarFp.deletePersonFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
+        },
         /**
          * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
          * @summary Get details of a person
@@ -462,6 +699,26 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
         getPerson(requestParameters) {
             return localVarFp.getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists users who are following the person.
+         * @summary List followers of a person
+         * @param {PersonsApiGetPersonFollowersRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getPersonFollowers(requestParameters) {
+            return localVarFp.getPersonFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists changelogs about users have followed the person.
+         * @summary List followers changelog of a person
+         * @param {PersonsApiGetPersonFollowersChangelogRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getPersonFollowersChangelog(requestParameters) {
+            return localVarFp.getPersonFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
          * @summary Get all persons
@@ -483,7 +740,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
         },
         /**
-         * Updates the properties of a person.
+         * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
          * @summary Update a person
          * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.
 
@@ -502,7 +759,7 @@ export const PersonsApiFactory = function (configuration, basePath, axios) {
  */
 export class PersonsApi extends BaseAPI {
     /**
-     * Adds a new person.
+     * Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Add a new person
      * @param {PersonsApiAddPersonRequest} requestParameters Request parameters.
 
@@ -512,6 +769,17 @@ export class PersonsApi extends BaseAPI {
     addPerson(requestParameters = {}) {
         return PersonsApiFp(this.configuration).addPerson(requestParameters.AddPersonRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Adds a user as a follower to the person.
+     * @summary Add a follower to a person
+     * @param {PersonsApiAddPersonFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    addPersonFollower(requestParameters) {
+        return PersonsApiFp(this.configuration).addPersonFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Marks a person as deleted. After 30 days, the person will be permanently deleted.
      * @summary Delete a person
@@ -523,6 +791,17 @@ export class PersonsApi extends BaseAPI {
     deletePerson(requestParameters) {
         return PersonsApiFp(this.configuration).deletePerson(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deletes a user follower from the person.
+     * @summary Delete a follower from a person
+     * @param {PersonsApiDeletePersonFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    deletePersonFollower(requestParameters) {
+        return PersonsApiFp(this.configuration).deletePersonFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns the details of a specific person. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get details of a person
@@ -534,6 +813,28 @@ export class PersonsApi extends BaseAPI {
     getPerson(requestParameters) {
         return PersonsApiFp(this.configuration).getPerson(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Lists users who are following the person.
+     * @summary List followers of a person
+     * @param {PersonsApiGetPersonFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    getPersonFollowers(requestParameters) {
+        return PersonsApiFp(this.configuration).getPersonFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists changelogs about users have followed the person.
+     * @summary List followers changelog of a person
+     * @param {PersonsApiGetPersonFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof PersonsApi
+     */
+    getPersonFollowersChangelog(requestParameters) {
+        return PersonsApiFp(this.configuration).getPersonFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns data about all persons. Fields `ims`, `postal_address`, `notes`, `birthday`, and `job_title` are only included if contact sync is enabled for the company.
      * @summary Get all persons
@@ -557,7 +858,7 @@ export class PersonsApi extends BaseAPI {
         return PersonsApiFp(this.configuration).searchPersons(requestParameters.term, requestParameters.fields, requestParameters.exact_match, requestParameters.organization_id, requestParameters.include_fields, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Updates the properties of a person.
+     * Updates the properties of a person. <br>If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field.
      * @summary Update a person
      * @param {PersonsApiUpdatePersonRequest} requestParameters Request parameters.