pipedrive 24.2.0 → 25.0.0

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

@@ -65,6 +65,43 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Adds a user as a follower to the organization.
+         * @summary Add a follower to an organization
+         * @param {number} id The ID of the organization
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addOrganizationFollower: (id, AddDealFollowerRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('addOrganizationFollower', 'id', id);
+            const localVarPath = `/organizations/{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 organization as deleted. After 30 days, the organization will be permanently deleted.
          * @summary Delete a organization
@@ -99,6 +136,44 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Deletes a user follower from the organization.
+         * @summary Delete a follower from an organization
+         * @param {number} id The ID of the organization
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deleteOrganizationFollower: (id, follower_id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deleteOrganizationFollower', 'id', id);
+            // verify required parameter 'follower_id' is not null or undefined
+            assertParamExists('deleteOrganizationFollower', 'follower_id', follower_id);
+            const localVarPath = `/organizations/{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 organization.
          * @summary Get details of a organization
@@ -141,6 +216,90 @@ export const OrganizationsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Lists users who are following the organization.
+         * @summary List followers of an organization
+         * @param {number} id The ID of the organization
+         * @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}
+         */
+        getOrganizationFollowers: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getOrganizationFollowers', 'id', id);
+            const localVarPath = `/organizations/{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 organization.
+         * @summary List followers changelog of an organization
+         * @param {number} id The ID of the organization
+         * @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}
+         */
+        getOrganizationFollowersChangelog: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getOrganizationFollowersChangelog', 'id', id);
+            const localVarPath = `/organizations/{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 organizations.
          * @summary Get all organizations
@@ -326,6 +485,20 @@ export const OrganizationsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Adds a user as a follower to the organization.
+         * @summary Add a follower to an organization
+         * @param {number} id The ID of the organization
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addOrganizationFollower(id, AddDealFollowerRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addOrganizationFollower(id, AddDealFollowerRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
          * @summary Delete a organization
@@ -339,6 +512,20 @@ export const OrganizationsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Deletes a user follower from the organization.
+         * @summary Delete a follower from an organization
+         * @param {number} id The ID of the organization
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deleteOrganizationFollower(id, follower_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteOrganizationFollower(id, follower_id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns the details of a specific organization.
          * @summary Get details of a organization
@@ -354,6 +541,36 @@ export const OrganizationsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Lists users who are following the organization.
+         * @summary List followers of an organization
+         * @param {number} id The ID of the organization
+         * @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}
+         */
+        getOrganizationFollowers(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationFollowers(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Lists changelogs about users have followed the organization.
+         * @summary List followers changelog of an organization
+         * @param {number} id The ID of the organization
+         * @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}
+         */
+        getOrganizationFollowersChangelog(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOrganizationFollowersChangelog(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Returns data about all organizations.
          * @summary Get all organizations
@@ -427,6 +644,16 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
         addOrganization(requestParameters = {}) {
             return localVarFp.addOrganization(requestParameters.AddOrganizationRequest).then((request) => request(axios, basePath));
         },
+        /**
+         * Adds a user as a follower to the organization.
+         * @summary Add a follower to an organization
+         * @param {OrganizationsApiAddOrganizationFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addOrganizationFollower(requestParameters) {
+            return localVarFp.addOrganizationFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
          * @summary Delete a organization
@@ -437,6 +664,16 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
         deleteOrganization(requestParameters) {
             return localVarFp.deleteOrganization(requestParameters.id).then((request) => request(axios, basePath));
         },
+        /**
+         * Deletes a user follower from the organization.
+         * @summary Delete a follower from an organization
+         * @param {OrganizationsApiDeleteOrganizationFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteOrganizationFollower(requestParameters) {
+            return localVarFp.deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
+        },
         /**
          * Returns the details of a specific organization.
          * @summary Get details of a organization
@@ -447,6 +684,26 @@ export const OrganizationsApiFactory = function (configuration, basePath, axios)
         getOrganization(requestParameters) {
             return localVarFp.getOrganization(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists users who are following the organization.
+         * @summary List followers of an organization
+         * @param {OrganizationsApiGetOrganizationFollowersRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getOrganizationFollowers(requestParameters) {
+            return localVarFp.getOrganizationFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists changelogs about users have followed the organization.
+         * @summary List followers changelog of an organization
+         * @param {OrganizationsApiGetOrganizationFollowersChangelogRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getOrganizationFollowersChangelog(requestParameters) {
+            return localVarFp.getOrganizationFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Returns data about all organizations.
          * @summary Get all organizations
@@ -497,6 +754,17 @@ export class OrganizationsApi extends BaseAPI {
     addOrganization(requestParameters = {}) {
         return OrganizationsApiFp(this.configuration).addOrganization(requestParameters.AddOrganizationRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Adds a user as a follower to the organization.
+     * @summary Add a follower to an organization
+     * @param {OrganizationsApiAddOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    addOrganizationFollower(requestParameters) {
+        return OrganizationsApiFp(this.configuration).addOrganizationFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Marks a organization as deleted. After 30 days, the organization will be permanently deleted.
      * @summary Delete a organization
@@ -508,6 +776,17 @@ export class OrganizationsApi extends BaseAPI {
     deleteOrganization(requestParameters) {
         return OrganizationsApiFp(this.configuration).deleteOrganization(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deletes a user follower from the organization.
+     * @summary Delete a follower from an organization
+     * @param {OrganizationsApiDeleteOrganizationFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    deleteOrganizationFollower(requestParameters) {
+        return OrganizationsApiFp(this.configuration).deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns the details of a specific organization.
      * @summary Get details of a organization
@@ -519,6 +798,28 @@ export class OrganizationsApi extends BaseAPI {
     getOrganization(requestParameters) {
         return OrganizationsApiFp(this.configuration).getOrganization(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Lists users who are following the organization.
+     * @summary List followers of an organization
+     * @param {OrganizationsApiGetOrganizationFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationFollowers(requestParameters) {
+        return OrganizationsApiFp(this.configuration).getOrganizationFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists changelogs about users have followed the organization.
+     * @summary List followers changelog of an organization
+     * @param {OrganizationsApiGetOrganizationFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof OrganizationsApi
+     */
+    getOrganizationFollowersChangelog(requestParameters) {
+        return OrganizationsApiFp(this.configuration).getOrganizationFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns data about all organizations.
      * @summary Get all organizations