pipedrive 25.0.0 → 27.0.0

package/dist/esm/versions/v1/api/activities-api.d.ts

@@ -30,15 +30,15 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * 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?: AddActivityRequest) => Promise<RequestArgs>;
     /**
-     * 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: string) => Promise<RequestArgs>;
@@ -46,7 +46,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * 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: number) => Promise<RequestArgs>;
@@ -61,13 +61,13 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * @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?: number, filter_id?: number, type?: string, limit?: number, start?: number, start_date?: string, end_date?: string, done?: 0 | 1) => Promise<RequestArgs>;
     /**
-     * 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.
@@ -75,7 +75,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * @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?: string, limit?: number, since?: string, until?: string, user_id?: number, done?: boolean, type?: string) => Promise<RequestArgs>;
@@ -83,7 +83,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * 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: number) => Promise<RequestArgs>;
@@ -92,7 +92,7 @@ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configurat
      * @summary Update an activity
      * @param {number} id The ID of the activity
      * @param {UpdateActivityRequest} [UpdateActivityRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateActivity: (id: number, UpdateActivityRequest?: UpdateActivityRequest) => Promise<RequestArgs>;
@@ -106,15 +106,15 @@ export declare const ActivitiesApiFp: (configuration?: 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?: AddActivityRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AddActivityResponse>>;
     /**
-     * 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: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteActivitiesResponse>>;
@@ -122,7 +122,7 @@ export declare const ActivitiesApiFp: (configuration?: 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: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<DeleteActivityResponse>>;
@@ -137,13 +137,13 @@ export declare const ActivitiesApiFp: (configuration?: 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?: number, filter_id?: number, type?: string, limit?: number, start?: number, start_date?: string, end_date?: string, done?: 0 | 1): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesResponse>>;
     /**
-     * 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.
@@ -151,7 +151,7 @@ export declare const ActivitiesApiFp: (configuration?: 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?: string, limit?: number, since?: string, until?: string, user_id?: number, done?: boolean, type?: string): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivitiesCollectionResponse>>;
@@ -159,7 +159,7 @@ export declare const ActivitiesApiFp: (configuration?: 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: number): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<GetActivityResponse>>;
@@ -168,7 +168,7 @@ export declare const ActivitiesApiFp: (configuration?: Configuration) => {
      * @summary Update an activity
      * @param {number} id The ID of the activity
      * @param {UpdateActivityRequest} [UpdateActivityRequest]
-
+     * @deprecated
      * @throws {RequiredError}
      */
     updateActivity(id: number, UpdateActivityRequest?: UpdateActivityRequest): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<UpdateActivityResponse>>;
@@ -182,15 +182,15 @@ export declare const ActivitiesApiFactory: (configuration?: Configuration, baseP
      * 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?: ActivitiesApiAddActivityRequest): Promise<AddActivityResponse>;
     /**
-     * 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: ActivitiesApiDeleteActivitiesRequest): Promise<DeleteActivitiesResponse>;
@@ -198,7 +198,7 @@ export declare const ActivitiesApiFactory: (configuration?: Configuration, baseP
      * 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: ActivitiesApiDeleteActivityRequest): Promise<DeleteActivityResponse>;
@@ -206,15 +206,15 @@ export declare const ActivitiesApiFactory: (configuration?: Configuration, baseP
      * 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?: ActivitiesApiGetActivitiesRequest): Promise<GetActivitiesResponse>;
     /**
-     * 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?: ActivitiesApiGetActivitiesCollectionRequest): Promise<GetActivitiesCollectionResponse>;
@@ -222,7 +222,7 @@ export declare const ActivitiesApiFactory: (configuration?: Configuration, baseP
      * Returns the details of a specific activity.
      * @summary Get details of an activity
      * @param {ActivitiesApiGetActivityRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      */
     getActivity(requestParameters: ActivitiesApiGetActivityRequest): Promise<GetActivityResponse>;
@@ -230,7 +230,7 @@ export declare const ActivitiesApiFactory: (configuration?: Configuration, baseP
      * 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: ActivitiesApiUpdateActivityRequest): Promise<UpdateActivityResponse>;
@@ -421,16 +421,16 @@ export declare class ActivitiesApi extends 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
      */
     addActivity(requestParameters?: ActivitiesApiAddActivityRequest): Promise<AddActivityResponse>;
     /**
-     * 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
      */
@@ -439,7 +439,7 @@ export declare class ActivitiesApi extends 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
      */
@@ -448,16 +448,16 @@ export declare class ActivitiesApi extends 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
      */
     getActivities(requestParameters?: ActivitiesApiGetActivitiesRequest): Promise<GetActivitiesResponse>;
     /**
-     * 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
      */
@@ -466,7 +466,7 @@ export declare class ActivitiesApi extends BaseAPI {
      * Returns the details of a specific activity.
      * @summary Get details of an activity
      * @param {ActivitiesApiGetActivityRequest} requestParameters Request parameters.
-
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ActivitiesApi
      */
@@ -475,7 +475,7 @@ export declare class ActivitiesApi extends 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
      */