pipedrive 25.0.0 → 26.0.0

package/dist/versions/v1/api/activities-api.js

@@ -42,7 +42,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * Adds a new activity. Includes `more_activities_scheduled_in_context` property in response\'s `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-activity\" target=\"_blank\" rel=\"noopener noreferrer\">adding an activity</a>. <br /> <br /> ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***
          * @summary Add an activity
          * @param {AddActivityRequest} [AddActivityRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         addActivity: (AddActivityRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -72,10 +72,10 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
+         * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#deleteActivity\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/activities/{id}</a> instead.
          * @summary Delete multiple activities in bulk
          * @param {string} ids The comma-separated IDs of activities that will be deleted
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteActivities: (ids) => __awaiter(this, void 0, void 0, function* () {
@@ -111,7 +111,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
          * @summary Delete an activity
          * @param {number} id The ID of the activity
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteActivity: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -152,7 +152,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * @param {string} [start_date] Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.
          * @param {string} [end_date] Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.
          * @param {0 | 1} [done] Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted returns both done and not done activities.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivities: (user_id, filter_id, type, limit, start, start_date, end_date, done) => __awaiter(this, void 0, void 0, function* () {
@@ -208,8 +208,8 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-         * @summary Get all activities (BETA)
+         * Returns all activities. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities</a> instead.
+         * @summary Get all activities collection
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
          * @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} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the &#x60;update_time&#x60; field.
@@ -217,7 +217,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * @param {number} [user_id] The ID of the user whose activities will be fetched. If omitted, all activities are returned.
          * @param {boolean} [done] Whether the activity is done or not. &#x60;false&#x60; &#x3D; Not done, &#x60;true&#x60; &#x3D; Done. If omitted, returns both done and not done activities.
          * @param {string} [type] The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the &#x60;key_string&#x60; parameter of ActivityTypes.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivitiesCollection: (cursor, limit, since, until, user_id, done, type) => __awaiter(this, void 0, void 0, function* () {
@@ -269,7 +269,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * Returns the details of a specific activity.
          * @summary Get details of an activity
          * @param {number} id The ID of the activity
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivity: (id) => __awaiter(this, void 0, void 0, function* () {
@@ -304,7 +304,7 @@ const ActivitiesApiAxiosParamCreator = function (configuration) {
          * @summary Update an activity
          * @param {number} id The ID of the activity
          * @param {UpdateActivityRequest} [UpdateActivityRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         updateActivity: (id, UpdateActivityRequest) => __awaiter(this, void 0, void 0, function* () {
@@ -350,7 +350,7 @@ const ActivitiesApiFp = function (configuration) {
          * Adds a new activity. Includes `more_activities_scheduled_in_context` property in response\'s `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-activity\" target=\"_blank\" rel=\"noopener noreferrer\">adding an activity</a>. <br /> <br /> ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***
          * @summary Add an activity
          * @param {AddActivityRequest} [AddActivityRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         addActivity(AddActivityRequest) {
@@ -360,10 +360,10 @@ const ActivitiesApiFp = function (configuration) {
             });
         },
         /**
-         * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
+         * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#deleteActivity\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/activities/{id}</a> instead.
          * @summary Delete multiple activities in bulk
          * @param {string} ids The comma-separated IDs of activities that will be deleted
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteActivities(ids) {
@@ -376,7 +376,7 @@ const ActivitiesApiFp = function (configuration) {
          * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
          * @summary Delete an activity
          * @param {number} id The ID of the activity
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteActivity(id) {
@@ -396,7 +396,7 @@ const ActivitiesApiFp = function (configuration) {
          * @param {string} [start_date] Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.
          * @param {string} [end_date] Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.
          * @param {0 | 1} [done] Whether the activity is done or not. 0 &#x3D; Not done, 1 &#x3D; Done. If omitted returns both done and not done activities.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivities(user_id, filter_id, type, limit, start, start_date, end_date, done) {
@@ -406,8 +406,8 @@ const ActivitiesApiFp = function (configuration) {
             });
         },
         /**
-         * Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-         * @summary Get all activities (BETA)
+         * Returns all activities. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities</a> instead.
+         * @summary Get all activities collection
          * @param {string} [cursor] For pagination, the marker (an opaque string value) representing the first item on the next page
          * @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} [since] The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the &#x60;update_time&#x60; field.
@@ -415,7 +415,7 @@ const ActivitiesApiFp = function (configuration) {
          * @param {number} [user_id] The ID of the user whose activities will be fetched. If omitted, all activities are returned.
          * @param {boolean} [done] Whether the activity is done or not. &#x60;false&#x60; &#x3D; Not done, &#x60;true&#x60; &#x3D; Done. If omitted, returns both done and not done activities.
          * @param {string} [type] The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the &#x60;key_string&#x60; parameter of ActivityTypes.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivitiesCollection(cursor, limit, since, until, user_id, done, type) {
@@ -428,7 +428,7 @@ const ActivitiesApiFp = function (configuration) {
          * Returns the details of a specific activity.
          * @summary Get details of an activity
          * @param {number} id The ID of the activity
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivity(id) {
@@ -442,7 +442,7 @@ const ActivitiesApiFp = function (configuration) {
          * @summary Update an activity
          * @param {number} id The ID of the activity
          * @param {UpdateActivityRequest} [UpdateActivityRequest]
-
+         * @deprecated
          * @throws {RequiredError}
          */
         updateActivity(id, UpdateActivityRequest) {
@@ -465,17 +465,17 @@ const ActivitiesApiFactory = function (configuration, basePath, axios) {
          * Adds a new activity. Includes `more_activities_scheduled_in_context` property in response\'s `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-activity\" target=\"_blank\" rel=\"noopener noreferrer\">adding an activity</a>. <br /> <br /> ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***
          * @summary Add an activity
          * @param {ActivitiesApiAddActivityRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         addActivity(requestParameters = {}) {
             return localVarFp.addActivity(requestParameters.AddActivityRequest).then((request) => request(axios, basePath));
         },
         /**
-         * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
+         * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#deleteActivity\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/activities/{id}</a> instead.
          * @summary Delete multiple activities in bulk
          * @param {ActivitiesApiDeleteActivitiesRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteActivities(requestParameters) {
@@ -485,7 +485,7 @@ const ActivitiesApiFactory = function (configuration, basePath, axios) {
          * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
          * @summary Delete an activity
          * @param {ActivitiesApiDeleteActivityRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         deleteActivity(requestParameters) {
@@ -495,17 +495,17 @@ const ActivitiesApiFactory = function (configuration, basePath, axios) {
          * Returns all activities assigned to a particular user.
          * @summary Get all activities assigned to a particular user
          * @param {ActivitiesApiGetActivitiesRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivities(requestParameters = {}) {
             return localVarFp.getActivities(requestParameters.user_id, requestParameters.filter_id, requestParameters.type, requestParameters.limit, requestParameters.start, requestParameters.start_date, requestParameters.end_date, requestParameters.done).then((request) => request(axios, basePath));
         },
         /**
-         * Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-         * @summary Get all activities (BETA)
+         * Returns all activities. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities</a> instead.
+         * @summary Get all activities collection
          * @param {ActivitiesApiGetActivitiesCollectionRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivitiesCollection(requestParameters = {}) {
@@ -515,7 +515,7 @@ const ActivitiesApiFactory = function (configuration, basePath, axios) {
          * Returns the details of a specific activity.
          * @summary Get details of an activity
          * @param {ActivitiesApiGetActivityRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         getActivity(requestParameters) {
@@ -525,7 +525,7 @@ const ActivitiesApiFactory = function (configuration, basePath, axios) {
          * Updates an activity. Includes `more_activities_scheduled_in_context` property in response\'s `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). <br /> <br /> ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***
          * @summary Update an activity
          * @param {ActivitiesApiUpdateActivityRequest} requestParameters Request parameters.
-
+         * @deprecated
          * @throws {RequiredError}
          */
         updateActivity(requestParameters) {
@@ -545,7 +545,7 @@ class ActivitiesApi extends base_1.BaseAPI {
      * Adds a new activity. Includes `more_activities_scheduled_in_context` property in response\'s `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). For more information, see the tutorial for <a href=\"https://pipedrive.readme.io/docs/adding-an-activity\" target=\"_blank\" rel=\"noopener noreferrer\">adding an activity</a>. <br /> <br /> ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***
      * @summary Add an activity
      * @param {ActivitiesApiAddActivityRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */
@@ -553,10 +553,10 @@ class ActivitiesApi extends base_1.BaseAPI {
         return (0, exports.ActivitiesApiFp)(this.configuration).addActivity(requestParameters.AddActivityRequest).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
+     * Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#deleteActivity\" target=\"_blank\" rel=\"noopener noreferrer\">DELETE /api/v2/activities/{id}</a> instead.
      * @summary Delete multiple activities in bulk
      * @param {ActivitiesApiDeleteActivitiesRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */
@@ -567,7 +567,7 @@ class ActivitiesApi extends base_1.BaseAPI {
      * Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
      * @summary Delete an activity
      * @param {ActivitiesApiDeleteActivityRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */
@@ -578,7 +578,7 @@ class ActivitiesApi extends base_1.BaseAPI {
      * Returns all activities assigned to a particular user.
      * @summary Get all activities assigned to a particular user
      * @param {ActivitiesApiGetActivitiesRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */
@@ -586,10 +586,10 @@ class ActivitiesApi extends base_1.BaseAPI {
         return (0, exports.ActivitiesApiFp)(this.configuration).getActivities(requestParameters.user_id, requestParameters.filter_id, requestParameters.type, requestParameters.limit, requestParameters.start, requestParameters.start_date, requestParameters.end_date, requestParameters.done).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"_blank\" rel=\"noopener noreferrer\">pagination</a>. Please note that only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.
-     * @summary Get all activities (BETA)
+     * Returns all activities. Please note that only global admins (those with global permissions) can access this endpoint. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. <br>This endpoint has been deprecated. Please use <a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_blank\" rel=\"noopener noreferrer\">GET /api/v2/activities</a> instead.
+     * @summary Get all activities collection
      * @param {ActivitiesApiGetActivitiesCollectionRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */
@@ -600,7 +600,7 @@ class ActivitiesApi extends base_1.BaseAPI {
      * Returns the details of a specific activity.
      * @summary Get details of an activity
      * @param {ActivitiesApiGetActivityRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */
@@ -611,7 +611,7 @@ class ActivitiesApi extends base_1.BaseAPI {
      * Updates an activity. Includes `more_activities_scheduled_in_context` property in response\'s `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). <br /> <br /> ***Starting from 30.09.2024, activity attendees will receive updates only if the activity owner has an active calendar sync***
      * @summary Update an activity
      * @param {ActivitiesApiUpdateActivityRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */