pipedrive 24.2.0 → 25.0.0

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

@@ -65,6 +65,43 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Adds a user as a follower to the deal.
+         * @summary Add a follower to a deal
+         * @param {number} id The ID of the deal
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addDealFollower: (id, AddDealFollowerRequest) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('addDealFollower', 'id', id);
+            const localVarPath = `/deals/{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", ["deals: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,
+            };
+        }),
         /**
          * Adds a product to a deal, creating a new item called a deal-product.
          * @summary Add a product to a deal
@@ -174,6 +211,44 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Deletes a user follower from the deal.
+         * @summary Delete a follower from a deal
+         * @param {number} id The ID of the deal
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deleteDealFollower: (id, follower_id) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('deleteDealFollower', 'id', id);
+            // verify required parameter 'follower_id' is not null or undefined
+            assertParamExists('deleteDealFollower', 'follower_id', follower_id);
+            const localVarPath = `/deals/{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", ["deals: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,
+            };
+        }),
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -326,6 +401,90 @@ export const DealsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Lists users who are following the deal.
+         * @summary List followers of a deal
+         * @param {number} id The ID of the deal
+         * @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}
+         */
+        getDealFollowers: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getDealFollowers', 'id', id);
+            const localVarPath = `/deals/{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", ["deals:read", "deals: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 deal.
+         * @summary List followers changelog of a deal
+         * @param {number} id The ID of the deal
+         * @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}
+         */
+        getDealFollowersChangelog: (id, limit, cursor) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getDealFollowersChangelog', 'id', id);
+            const localVarPath = `/deals/{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", ["deals:read", "deals: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 products attached to a deal.
          * @summary List products attached to a deal
@@ -898,6 +1057,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Adds a user as a follower to the deal.
+         * @summary Add a follower to a deal
+         * @param {number} id The ID of the deal
+         * @param {AddDealFollowerRequest} [AddDealFollowerRequest]
+
+         * @throws {RequiredError}
+         */
+        addDealFollower(id, AddDealFollowerRequest) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.addDealFollower(id, AddDealFollowerRequest);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Adds a product to a deal, creating a new item called a deal-product.
          * @summary Add a product to a deal
@@ -939,6 +1112,20 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Deletes a user follower from the deal.
+         * @summary Delete a follower from a deal
+         * @param {number} id The ID of the deal
+         * @param {number} follower_id The ID of the following user
+
+         * @throws {RequiredError}
+         */
+        deleteDealFollower(id, follower_id) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteDealFollower(id, follower_id);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -995,6 +1182,36 @@ export const DealsApiFp = function (configuration) {
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
+        /**
+         * Lists users who are following the deal.
+         * @summary List followers of a deal
+         * @param {number} id The ID of the deal
+         * @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}
+         */
+        getDealFollowers(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFollowers(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Lists changelogs about users have followed the deal.
+         * @summary List followers changelog of a deal
+         * @param {number} id The ID of the deal
+         * @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}
+         */
+        getDealFollowersChangelog(id, limit, cursor) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDealFollowersChangelog(id, limit, cursor);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
         /**
          * Lists products attached to a deal.
          * @summary List products attached to a deal
@@ -1201,6 +1418,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         addDeal(requestParameters = {}) {
             return localVarFp.addDeal(requestParameters.AddDealRequest).then((request) => request(axios, basePath));
         },
+        /**
+         * Adds a user as a follower to the deal.
+         * @summary Add a follower to a deal
+         * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        addDealFollower(requestParameters) {
+            return localVarFp.addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(axios, basePath));
+        },
         /**
          * Adds a product to a deal, creating a new item called a deal-product.
          * @summary Add a product to a deal
@@ -1231,6 +1458,16 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         deleteDeal(requestParameters) {
             return localVarFp.deleteDeal(requestParameters.id).then((request) => request(axios, basePath));
         },
+        /**
+         * Deletes a user follower from the deal.
+         * @summary Delete a follower from a deal
+         * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        deleteDealFollower(requestParameters) {
+            return localVarFp.deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(axios, basePath));
+        },
         /**
          * Deletes a product attachment from a deal, using the `product_attachment_id`.
          * @summary Delete an attached product from a deal
@@ -1271,6 +1508,26 @@ export const DealsApiFactory = function (configuration, basePath, axios) {
         getDeal(requestParameters) {
             return localVarFp.getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists users who are following the deal.
+         * @summary List followers of a deal
+         * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getDealFollowers(requestParameters) {
+            return localVarFp.getDealFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
+        /**
+         * Lists changelogs about users have followed the deal.
+         * @summary List followers changelog of a deal
+         * @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
+
+         * @throws {RequiredError}
+         */
+        getDealFollowersChangelog(requestParameters) {
+            return localVarFp.getDealFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(axios, basePath));
+        },
         /**
          * Lists products attached to a deal.
          * @summary List products attached to a deal
@@ -1401,6 +1658,17 @@ export class DealsApi extends BaseAPI {
     addDeal(requestParameters = {}) {
         return DealsApiFp(this.configuration).addDeal(requestParameters.AddDealRequest).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Adds a user as a follower to the deal.
+     * @summary Add a follower to a deal
+     * @param {DealsApiAddDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    addDealFollower(requestParameters) {
+        return DealsApiFp(this.configuration).addDealFollower(requestParameters.id, requestParameters.AddDealFollowerRequest).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds a product to a deal, creating a new item called a deal-product.
      * @summary Add a product to a deal
@@ -1434,6 +1702,17 @@ export class DealsApi extends BaseAPI {
     deleteDeal(requestParameters) {
         return DealsApiFp(this.configuration).deleteDeal(requestParameters.id).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deletes a user follower from the deal.
+     * @summary Delete a follower from a deal
+     * @param {DealsApiDeleteDealFollowerRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    deleteDealFollower(requestParameters) {
+        return DealsApiFp(this.configuration).deleteDealFollower(requestParameters.id, requestParameters.follower_id).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Deletes a product attachment from a deal, using the `product_attachment_id`.
      * @summary Delete an attached product from a deal
@@ -1478,6 +1757,28 @@ export class DealsApi extends BaseAPI {
     getDeal(requestParameters) {
         return DealsApiFp(this.configuration).getDeal(requestParameters.id, requestParameters.include_fields, requestParameters.custom_fields).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Lists users who are following the deal.
+     * @summary List followers of a deal
+     * @param {DealsApiGetDealFollowersRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealFollowers(requestParameters) {
+        return DealsApiFp(this.configuration).getDealFollowers(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Lists changelogs about users have followed the deal.
+     * @summary List followers changelog of a deal
+     * @param {DealsApiGetDealFollowersChangelogRequest} requestParameters Request parameters.
+
+     * @throws {RequiredError}
+     * @memberof DealsApi
+     */
+    getDealFollowersChangelog(requestParameters) {
+        return DealsApiFp(this.configuration).getDealFollowersChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Lists products attached to a deal.
      * @summary List products attached to a deal