diff --git a/CHANGELOG.md b/CHANGELOG.md index ec17c685..cd91e44b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,64 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### Changed +- Deprecated `GET /v1/activities` in favor of `GET /api/v2/activities` +- Deprecated `GET /v1/activities/collection` in favor of `GET /api/v2/activities` +- Deprecated `GET /v1/activities/{id}` in favor of `GET /api/v2/activities/{id}` +- Deprecated `POST /v1/activities` in favor of `POST /api/v2/activities` +- Deprecated `PUT /v1/activities/{id}` in favor of `PATCH /api/v2/activities/{id}` +- Deprecated `DELETE /v1/activities/{id}` in favor of `DELETE /api/v2/activities/{id}` +- Deprecated `DELETE /v1/activities` in favor of `DELETE /api/v2/activities/{id}` +- Deprecated `GET /v1/deals` in favor of `GET /api/v2/deals` +- Deprecated `GET /v1/deals/collection` in favor of `GET /api/v2/deals` +- Deprecated `GET /v1/deals/{id}` in favor of `GET /api/v2/deals/{id}` +- Deprecated `GET /v1/deals/search` in favor of `GET /api/v2/deals/search` +- Deprecated `POST /v1/deals` in favor of `POST /api/v2/deals` +- Deprecated `PUT /v1/deals/{id}` in favor of `PATCH /api/v2/deals` +- Deprecated `DELETE /v1/deals/{id}` in favor of `DELETE /api/v2/deals/{id}` +- Deprecated `DELETE /v1/deals` in favor of `DELETE /api/v2/deals/{id}` +- Deprecated `GET /v1/deals/{id}/activities` in favor of `GET /api/v2/activities?deal_id={id}` +- Deprecated `GET /v1/deals/{id}/persons` in favor of `GET /api/v2/persons?deal_id={id}` +- Deprecated `GET /v1/persons` in favor of `GET /api/v2/persons` +- Deprecated `GET /v1/persons/collection` in favor of `GET /api/v2/persons` +- Deprecated `GET /v1/persons/{id}` in favor of `GET /api/v2/persons/{id}` +- Deprecated `GET /v1/persons/search` in favor of `GET /api/v2/persons/search` +- Deprecated `POST /v1/persons` in favor of `POST /api/v2/persons` +- Deprecated `PUT /v1/persons/{id}` in favor of `PATCH /api/v2/persons/{id}` +- Deprecated `DELETE /v1/persons/{id}` in favor of `DELETE /api/v2/persons/{id}` +- Deprecated `DELETE /v1/persons` in favor of `DELETE /api/v2/persons/{id}` +- Deprecated `GET /v1/persons/{id}/deals` in favor of `GET /api/v2/deals?person_id={id}` +- Deprecated `GET /v1/persons/{id}/activities` in favor of `GET /api/v2/activities?person_id={id}` +- Deprecated `GET /v1/organizations` in favor of `GET /api/v2/organizations` +- Deprecated `GET /v1/organizations/collection` in favor of `GET /api/v2/organizations` +- Deprecated `GET /v1/organizations/{id}` in favor of `GET /api/v2/organizations/{id}` +- Deprecated `GET /v1/organizations/search` in favor of `GET /api/v2/organizations/search` +- Deprecated `POST /v1/organizations` in favor of `POST /api/v2/organizations` +- Deprecated `PUT /v1/organizations/{id}` in favor of `PATCH /api/v2/organizations/{id}` +- Deprecated `DELETE /v1/organizations/{id}` in favor of `DELETE /api/v2/organizations/{id}` +- Deprecated `DELETE /v1/organizations` in favor of `DELETE /api/v2/organizations/{id}` +- Deprecated `GET /v1/organizations/{id}/deals` in favor of `GET /api/v2/deals?org_id={id}` +- Deprecated `GET /v1/organizations/{id}/activities` in favor of `GET /api/v2/activities?org_id={id}` +- Deprecated `GET /v1/organizations/{id}/persons` in favor of `GET /api/v2/persons?org_id={id}` +- Deprecated `GET /v1/products` in favor of `GET /api/v2/products` +- Deprecated `GET /v1/products/{id}` in favor of `GET /api/v2/products/{id}` +- Deprecated `GET /v1/products/search` in favor of `GET /api/v2/products/search` +- Deprecated `POST /v1/products` in favor of `POST /api/v2/products` +- Deprecated `PUT /v1/products/{id}` in favor of `PATCH /api/v2/products/{id}` +- Deprecated `DELETE /v1/products/{id}` in favor of `DELETE /api/v2/products/{id}` +- Deprecated `GET /v1/pipelines` in favor of `GET /api/v2/pipelines` +- Deprecated `GET /v1/pipelines/{id}` in favor of `GET /api/v2/pipelines/{id}` +- Deprecated `POST /v1/pipelines` in favor of `POST /api/v2/pipelines` +- Deprecated `PUT /v1/pipelines/{id}` in favor of `PATCH /api/v2/pipelines/{id}` +- Deprecated `DELETE /v1/pipelines/{id}` in favor of `DELETE /api/v2/pipelines/{id}` +- Deprecated `GET /v1/stages` in favor of `GET /api/v2/stages` +- Deprecated `GET /v1/stages/{id}` in favor of `GET /api/v2/stages/{id}` +- Deprecated `POST /v1/stages` in favor of `POST /api/v2/stages` +- Deprecated `PUT /v1/stages/{id}` in favor of `PATCH /api/v2/stages/{id}` +- Deprecated `DELETE /v1/stages/{id}` in favor of `DELETE /api/v2/stages/{id}` +- Deprecated `DELETE /v1/stages` in favor of `DELETE /api/v2/stages/{id}` +- Deprecated `GET /v1/itemSearch` in favor of `GET /api/v2/itemSearch` +- Deprecated `GET /v1/itemSearch/field` in favor of `GET /api/v2/itemSearch/field` ## [25.0.0] - 2025-03-31 ### Changed diff --git a/docs/v1.md b/docs/v1.md index de9d3bdb..cfae50cf 100644 --- a/docs/v1.md +++ b/docs/v1.md @@ -8,7 +8,7 @@ ActivitiesApi | addActivity | **POST** /activities | Add an activity ActivitiesApi | deleteActivities | **DELETE** /activities | Delete multiple activities in bulk ActivitiesApi | deleteActivity | **DELETE** /activities/{id} | Delete an activity ActivitiesApi | getActivities | **GET** /activities | Get all activities assigned to a particular user -ActivitiesApi | getActivitiesCollection | **GET** /activities/collection | Get all activities (BETA) +ActivitiesApi | getActivitiesCollection | **GET** /activities/collection | Get all activities collection ActivitiesApi | getActivity | **GET** /activities/{id} | Get details of an activity ActivitiesApi | updateActivity | **PUT** /activities/{id} | Update an activity ActivityFieldsApi | getActivityFields | **GET** /activityFields | Get all activity fields @@ -57,7 +57,7 @@ DealsApi | getDealProducts | **GET** /deals/{id}/products | List products attach DealsApi | getDealUpdates | **GET** /deals/{id}/flow | List updates about a deal DealsApi | getDealUsers | **GET** /deals/{id}/permittedUsers | List permitted users DealsApi | getDeals | **GET** /deals | Get all deals -DealsApi | getDealsCollection | **GET** /deals/collection | Get all deals (BETA) +DealsApi | getDealsCollection | **GET** /deals/collection | Get all deals collection DealsApi | getDealsSummary | **GET** /deals/summary | Get deals summary DealsApi | getDealsTimeline | **GET** /deals/timeline | Get deals timeline DealsApi | mergeDeals | **PUT** /deals/{id}/merge | Merge two deals @@ -152,7 +152,7 @@ OrganizationsApi | getOrganizationPersons | **GET** /organizations/{id}/persons OrganizationsApi | getOrganizationUpdates | **GET** /organizations/{id}/flow | List updates about an organization OrganizationsApi | getOrganizationUsers | **GET** /organizations/{id}/permittedUsers | List permitted users OrganizationsApi | getOrganizations | **GET** /organizations | Get all organizations -OrganizationsApi | getOrganizationsCollection | **GET** /organizations/collection | Get all organizations (BETA) +OrganizationsApi | getOrganizationsCollection | **GET** /organizations/collection | Get all organizations collection OrganizationsApi | mergeOrganizations | **PUT** /organizations/{id}/merge | Merge two organizations OrganizationsApi | searchOrganization | **GET** /organizations/search | Search organizations OrganizationsApi | updateOrganization | **PUT** /organizations/{id} | Update an organization @@ -183,7 +183,7 @@ PersonsApi | getPersonProducts | **GET** /persons/{id}/products | List products PersonsApi | getPersonUpdates | **GET** /persons/{id}/flow | List updates about a person PersonsApi | getPersonUsers | **GET** /persons/{id}/permittedUsers | List permitted users PersonsApi | getPersons | **GET** /persons | Get all persons -PersonsApi | getPersonsCollection | **GET** /persons/collection | Get all persons (BETA) +PersonsApi | getPersonsCollection | **GET** /persons/collection | Get all persons collection PersonsApi | mergePersons | **PUT** /persons/{id}/merge | Merge two persons PersonsApi | searchPersons | **GET** /persons/search | Search persons PersonsApi | updatePerson | **PUT** /persons/{id} | Update a person diff --git a/src/versions/v1/api/activities-api.ts b/src/versions/v1/api/activities-api.ts index 2c9bf4d4..e9edc1d5 100644 --- a/src/versions/v1/api/activities-api.ts +++ b/src/versions/v1/api/activities-api.ts @@ -51,7 +51,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur * 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 adding an activity.

***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: async (AddActivityRequest?: AddActivityRequest, ): Promise => { @@ -89,10 +89,10 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * 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.
This endpoint has been deprecated. Please use DELETE /api/v2/activities/{id} instead. * @summary Delete multiple activities in bulk * @param {string} ids The comma-separated IDs of activities that will be deleted - + * @deprecated * @throws {RequiredError} */ deleteActivities: async (ids: string, ): Promise => { @@ -136,7 +136,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur * 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: async (id: number, ): Promise => { @@ -184,7 +184,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur * @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 = Not done, 1 = Done. If omitted returns both done and not done activities. - + * @deprecated * @throws {RequiredError} */ getActivities: async (user_id?: number, filter_id?: number, type?: string, limit?: number, start?: number, start_date?: string, end_date?: string, done?: 0 | 1, ): Promise => { @@ -255,8 +255,8 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur }; }, /** - * Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @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 here.
This endpoint has been deprecated. Please use GET /api/v2/activities 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 `update_time` field. @@ -264,7 +264,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur * @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. `false` = Not done, `true` = 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 `key_string` parameter of ActivityTypes. - + * @deprecated * @throws {RequiredError} */ getActivitiesCollection: async (cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, done?: boolean, type?: string, ): Promise => { @@ -330,7 +330,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur * 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: async (id: number, ): Promise => { @@ -372,7 +372,7 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur * @summary Update an activity * @param {number} id The ID of the activity * @param {UpdateActivityRequest} [UpdateActivityRequest] - + * @deprecated * @throws {RequiredError} */ updateActivity: async (id: number, UpdateActivityRequest?: UpdateActivityRequest, ): Promise => { @@ -427,7 +427,7 @@ export const ActivitiesApiFp = function(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 adding an activity.

***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} */ async addActivity(AddActivityRequest?: AddActivityRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -435,10 +435,10 @@ export const ActivitiesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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.
This endpoint has been deprecated. Please use DELETE /api/v2/activities/{id} instead. * @summary Delete multiple activities in bulk * @param {string} ids The comma-separated IDs of activities that will be deleted - + * @deprecated * @throws {RequiredError} */ async deleteActivities(ids: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -449,7 +449,7 @@ export const ActivitiesApiFp = function(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} */ async deleteActivity(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -467,7 +467,7 @@ export const ActivitiesApiFp = function(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 = Not done, 1 = Done. If omitted returns both done and not done activities. - + * @deprecated * @throws {RequiredError} */ async 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> { @@ -475,8 +475,8 @@ export const ActivitiesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @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 here.
This endpoint has been deprecated. Please use GET /api/v2/activities 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 `update_time` field. @@ -484,7 +484,7 @@ export const ActivitiesApiFp = function(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. `false` = Not done, `true` = 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 `key_string` parameter of ActivityTypes. - + * @deprecated * @throws {RequiredError} */ async getActivitiesCollection(cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, done?: boolean, type?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -495,7 +495,7 @@ export const ActivitiesApiFp = function(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} */ async getActivity(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -507,7 +507,7 @@ export const ActivitiesApiFp = function(configuration?: Configuration) { * @summary Update an activity * @param {number} id The ID of the activity * @param {UpdateActivityRequest} [UpdateActivityRequest] - + * @deprecated * @throws {RequiredError} */ async updateActivity(id: number, UpdateActivityRequest?: UpdateActivityRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -528,17 +528,17 @@ export const ActivitiesApiFactory = function (configuration?: Configuration, bas * 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 adding an activity.

***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 { 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.
This endpoint has been deprecated. Please use DELETE /api/v2/activities/{id} instead. * @summary Delete multiple activities in bulk * @param {ActivitiesApiDeleteActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteActivities(requestParameters: ActivitiesApiDeleteActivitiesRequest, ): Promise { @@ -548,7 +548,7 @@ export const ActivitiesApiFactory = function (configuration?: Configuration, bas * 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 { @@ -558,17 +558,17 @@ export const ActivitiesApiFactory = function (configuration?: Configuration, bas * 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 { 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 pagination. 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 here. - * @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 here.
This endpoint has been deprecated. Please use GET /api/v2/activities instead. + * @summary Get all activities collection * @param {ActivitiesApiGetActivitiesCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getActivitiesCollection(requestParameters: ActivitiesApiGetActivitiesCollectionRequest = {}, ): Promise { @@ -578,7 +578,7 @@ export const ActivitiesApiFactory = function (configuration?: Configuration, bas * 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 { @@ -588,7 +588,7 @@ export const ActivitiesApiFactory = function (configuration?: Configuration, bas * 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).

***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 { @@ -804,7 +804,7 @@ export 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 adding an activity.

***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 */ @@ -813,10 +813,10 @@ export class ActivitiesApi extends BaseAPI { } /** - * 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.
This endpoint has been deprecated. Please use DELETE /api/v2/activities/{id} instead. * @summary Delete multiple activities in bulk * @param {ActivitiesApiDeleteActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ActivitiesApi */ @@ -828,7 +828,7 @@ export 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 */ @@ -840,7 +840,7 @@ export 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 */ @@ -849,10 +849,10 @@ export class ActivitiesApi extends BaseAPI { } /** - * Returns all activities. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @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 here.
This endpoint has been deprecated. Please use GET /api/v2/activities instead. + * @summary Get all activities collection * @param {ActivitiesApiGetActivitiesCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ActivitiesApi */ @@ -864,7 +864,7 @@ export 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 */ @@ -876,7 +876,7 @@ export 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).

***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 */ diff --git a/src/versions/v1/api/deals-api.ts b/src/versions/v1/api/deals-api.ts index 05e04849..6687c4e3 100644 --- a/src/versions/v1/api/deals-api.ts +++ b/src/versions/v1/api/deals-api.ts @@ -105,7 +105,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for adding a deal. * @summary Add a deal * @param {AddDealRequest} [AddDealRequest] - + * @deprecated * @throws {RequiredError} */ addDeal: async (AddDealRequest?: AddDealRequest, ): Promise => { @@ -237,7 +237,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @summary Add a product to a deal * @param {number} id The ID of the deal * @param {AddDealProductRequest} [AddDealProductRequest] - + * @deprecated * @throws {RequiredError} */ addDealProduct: async (id: number, AddDealProductRequest?: AddDealProductRequest, ): Promise => { @@ -281,7 +281,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * Marks a deal as deleted. After 30 days, the deal will be permanently deleted. * @summary Delete a deal * @param {number} id The ID of the deal - + * @deprecated * @throws {RequiredError} */ deleteDeal: async (id: number, ): Promise => { @@ -413,7 +413,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @summary Delete an attached product from a deal * @param {number} id The ID of the deal * @param {number} product_attachment_id The product attachment ID - + * @deprecated * @throws {RequiredError} */ deleteDealProduct: async (id: number, product_attachment_id: number, ): Promise => { @@ -454,10 +454,10 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. + * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/deals/{id} instead. * @summary Delete multiple deals in bulk * @param {string} ids The comma-separated IDs that will be deleted - + * @deprecated * @throws {RequiredError} */ deleteDeals: async (ids: string, ): Promise => { @@ -542,7 +542,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for getting details of a deal. * @summary Get details of a deal * @param {number} id The ID of the deal - + * @deprecated * @throws {RequiredError} */ getDeal: async (id: number, ): Promise => { @@ -580,14 +580,14 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Lists activities associated with a deal. + * Lists activities associated with a deal.
This endpoint has been deprecated. Please use GET /api/v2/activities?deal_id={id} instead. * @summary List activities associated with a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities. * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result - + * @deprecated * @throws {RequiredError} */ getDealActivities: async (id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string, ): Promise => { @@ -942,12 +942,12 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?deal_id={id} instead. * @summary List all persons associated with a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ getDealPersons: async (id: number, start?: number, limit?: number, ): Promise => { @@ -999,7 +999,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default) - + * @deprecated * @throws {RequiredError} */ getDealProducts: async (id: number, start?: number, limit?: number, include_product_data?: 0 | 1, ): Promise => { @@ -1161,7 +1161,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied. - + * @deprecated * @throws {RequiredError} */ getDeals: async (user_id?: number, filter_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1, ): Promise => { @@ -1228,8 +1228,8 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all deals (BETA) + * Returns all deals. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/deals instead. + * @summary Get all deals 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 `update_time` field. @@ -1237,7 +1237,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {number} [user_id] If supplied, only deals matching the given user will be returned * @param {number} [stage_id] If supplied, only deals within the given stage will be returned * @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. - + * @deprecated * @throws {RequiredError} */ getDealsCollection: async (cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', ): Promise => { @@ -1510,7 +1510,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ searchDeals: async (term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', start?: number, limit?: number, ): Promise => { @@ -1587,7 +1587,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @summary Update a deal * @param {number} id The ID of the deal * @param {UpdateDealRequest} [UpdateDealRequest] - + * @deprecated * @throws {RequiredError} */ updateDeal: async (id: number, UpdateDealRequest?: UpdateDealRequest, ): Promise => { @@ -1633,7 +1633,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration * @param {number} id The ID of the deal * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal) * @param {UpdateDealProductRequest} [UpdateDealProductRequest] - + * @deprecated * @throws {RequiredError} */ updateDealProduct: async (id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest, ): Promise => { @@ -1691,7 +1691,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for adding a deal. * @summary Add a deal * @param {AddDealRequest} [AddDealRequest] - + * @deprecated * @throws {RequiredError} */ async addDeal(AddDealRequest?: AddDealRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1727,7 +1727,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @summary Add a product to a deal * @param {number} id The ID of the deal * @param {AddDealProductRequest} [AddDealProductRequest] - + * @deprecated * @throws {RequiredError} */ async addDealProduct(id: number, AddDealProductRequest?: AddDealProductRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1738,7 +1738,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * Marks a deal as deleted. After 30 days, the deal will be permanently deleted. * @summary Delete a deal * @param {number} id The ID of the deal - + * @deprecated * @throws {RequiredError} */ async deleteDeal(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1774,7 +1774,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @summary Delete an attached product from a deal * @param {number} id The ID of the deal * @param {number} product_attachment_id The product attachment ID - + * @deprecated * @throws {RequiredError} */ async deleteDealProduct(id: number, product_attachment_id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1782,10 +1782,10 @@ export const DealsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. + * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/deals/{id} instead. * @summary Delete multiple deals in bulk * @param {string} ids The comma-separated IDs that will be deleted - + * @deprecated * @throws {RequiredError} */ async deleteDeals(ids: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1807,7 +1807,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for getting details of a deal. * @summary Get details of a deal * @param {number} id The ID of the deal - + * @deprecated * @throws {RequiredError} */ async getDeal(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1815,14 +1815,14 @@ export const DealsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists activities associated with a deal. + * Lists activities associated with a deal.
This endpoint has been deprecated. Please use GET /api/v2/activities?deal_id={id} instead. * @summary List activities associated with a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities. * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result - + * @deprecated * @throws {RequiredError} */ async getDealActivities(id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1907,12 +1907,12 @@ export const DealsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?deal_id={id} instead. * @summary List all persons associated with a deal * @param {number} id The ID of the deal * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async getDealPersons(id: number, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1926,7 +1926,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [include_product_data] Whether to fetch product data along with each attached product (1) or not (0, default) - + * @deprecated * @throws {RequiredError} */ async getDealProducts(id: number, start?: number, limit?: number, include_product_data?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1970,7 +1970,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @param {0 | 1} [owned_by_you] When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied. - + * @deprecated * @throws {RequiredError} */ async getDeals(user_id?: number, filter_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', start?: number, limit?: number, sort?: string, owned_by_you?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1978,8 +1978,8 @@ export const DealsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all deals (BETA) + * Returns all deals. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/deals instead. + * @summary Get all deals 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 `update_time` field. @@ -1987,7 +1987,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {number} [user_id] If supplied, only deals matching the given user will be returned * @param {number} [stage_id] If supplied, only deals within the given stage will be returned * @param {'open' | 'won' | 'lost' | 'deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. - + * @deprecated * @throws {RequiredError} */ async getDealsCollection(cursor?: string, limit?: number, since?: string, until?: string, user_id?: number, stage_id?: number, status?: 'open' | 'won' | 'lost' | 'deleted', ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -2052,7 +2052,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {'deal.cc_email'} [include_fields] Supports including optional fields in the results which are not provided by default * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async searchDeals(term: string, fields?: 'custom_fields' | 'notes' | 'title', exact_match?: boolean, person_id?: number, organization_id?: number, status?: 'open' | 'won' | 'lost', include_fields?: 'deal.cc_email', start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -2064,7 +2064,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @summary Update a deal * @param {number} id The ID of the deal * @param {UpdateDealRequest} [UpdateDealRequest] - + * @deprecated * @throws {RequiredError} */ async updateDeal(id: number, UpdateDealRequest?: UpdateDealRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -2077,7 +2077,7 @@ export const DealsApiFp = function(configuration?: Configuration) { * @param {number} id The ID of the deal * @param {number} product_attachment_id The ID of the deal-product (the ID of the product attached to the deal) * @param {UpdateDealProductRequest} [UpdateDealProductRequest] - + * @deprecated * @throws {RequiredError} */ async updateDealProduct(id: number, product_attachment_id: number, UpdateDealProductRequest?: UpdateDealProductRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -2098,7 +2098,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for adding a deal. * @summary Add a deal * @param {DealsApiAddDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ addDeal(requestParameters: DealsApiAddDealRequest = {}, ): Promise { @@ -2128,7 +2128,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Adds a product to a deal, creating a new item called a deal-product. * @summary Add a product to a deal * @param {DealsApiAddDealProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ addDealProduct(requestParameters: DealsApiAddDealProductRequest, ): Promise { @@ -2138,7 +2138,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Marks a deal as deleted. After 30 days, the deal will be permanently deleted. * @summary Delete a deal * @param {DealsApiDeleteDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteDeal(requestParameters: DealsApiDeleteDealRequest, ): Promise { @@ -2168,17 +2168,17 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Deletes a product attachment from a deal, using the `product_attachment_id` Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled * @summary Delete an attached product from a deal * @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteDealProduct(requestParameters: DealsApiDeleteDealProductRequest, ): Promise { return localVarFp.deleteDealProduct(requestParameters.id, requestParameters.product_attachment_id, ).then((request) => request(axios, basePath)); }, /** - * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. + * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/deals/{id} instead. * @summary Delete multiple deals in bulk * @param {DealsApiDeleteDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteDeals(requestParameters: DealsApiDeleteDealsRequest, ): Promise { @@ -2198,17 +2198,17 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for getting details of a deal. * @summary Get details of a deal * @param {DealsApiGetDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getDeal(requestParameters: DealsApiGetDealRequest, ): Promise { return localVarFp.getDeal(requestParameters.id, ).then((request) => request(axios, basePath)); }, /** - * Lists activities associated with a deal. + * Lists activities associated with a deal.
This endpoint has been deprecated. Please use GET /api/v2/activities?deal_id={id} instead. * @summary List activities associated with a deal * @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getDealActivities(requestParameters: DealsApiGetDealActivitiesRequest, ): Promise { @@ -2275,10 +2275,10 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath return localVarFp.getDealParticipantsChangelog(requestParameters.id, requestParameters.limit, requestParameters.cursor, ).then((request) => request(axios, basePath)); }, /** - * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?deal_id={id} instead. * @summary List all persons associated with a deal * @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getDealPersons(requestParameters: DealsApiGetDealPersonsRequest, ): Promise { @@ -2288,7 +2288,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Lists products attached to a deal. * @summary List products attached to a deal * @param {DealsApiGetDealProductsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getDealProducts(requestParameters: DealsApiGetDealProductsRequest, ): Promise { @@ -2318,17 +2318,17 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Returns all deals. For more information, see the tutorial for getting all deals. * @summary Get all deals * @param {DealsApiGetDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getDeals(requestParameters: DealsApiGetDealsRequest = {}, ): Promise { return localVarFp.getDeals(requestParameters.user_id, requestParameters.filter_id, requestParameters.stage_id, requestParameters.status, requestParameters.start, requestParameters.limit, requestParameters.sort, requestParameters.owned_by_you, ).then((request) => request(axios, basePath)); }, /** - * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all deals (BETA) + * Returns all deals. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/deals instead. + * @summary Get all deals collection * @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getDealsCollection(requestParameters: DealsApiGetDealsCollectionRequest = {}, ): Promise { @@ -2368,7 +2368,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID. * @summary Search deals * @param {DealsApiSearchDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ searchDeals(requestParameters: DealsApiSearchDealsRequest, ): Promise { @@ -2378,7 +2378,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Updates the properties of a deal. For more information, see the tutorial for updating a deal. * @summary Update a deal * @param {DealsApiUpdateDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ updateDeal(requestParameters: DealsApiUpdateDealRequest, ): Promise { @@ -2388,7 +2388,7 @@ export const DealsApiFactory = function (configuration?: Configuration, basePath * Updates the details of the product that has been attached to a deal. * @summary Update the product attached to a deal * @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ updateDealProduct(requestParameters: DealsApiUpdateDealProductRequest, ): Promise { @@ -3297,7 +3297,7 @@ export class DealsApi extends BaseAPI { * Adds a new deal. All deals created through the Pipedrive API will have a `origin` set to `API`. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for adding a deal. * @summary Add a deal * @param {DealsApiAddDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3333,7 +3333,7 @@ export class DealsApi extends BaseAPI { * Adds a product to a deal, creating a new item called a deal-product. * @summary Add a product to a deal * @param {DealsApiAddDealProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3345,7 +3345,7 @@ export class DealsApi extends BaseAPI { * Marks a deal as deleted. After 30 days, the deal will be permanently deleted. * @summary Delete a deal * @param {DealsApiDeleteDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3381,7 +3381,7 @@ export class DealsApi extends BaseAPI { * Deletes a product attachment from a deal, using the `product_attachment_id` Not possible to delete the attached product if the deal has installments associated and the product is the last one enabled * @summary Delete an attached product from a deal * @param {DealsApiDeleteDealProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3390,10 +3390,10 @@ export class DealsApi extends BaseAPI { } /** - * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted. + * Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/deals/{id} instead. * @summary Delete multiple deals in bulk * @param {DealsApiDeleteDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3417,7 +3417,7 @@ export class DealsApi extends BaseAPI { * Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for getting details of a deal. * @summary Get details of a deal * @param {DealsApiGetDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3426,10 +3426,10 @@ export class DealsApi extends BaseAPI { } /** - * Lists activities associated with a deal. + * Lists activities associated with a deal.
This endpoint has been deprecated. Please use GET /api/v2/activities?deal_id={id} instead. * @summary List activities associated with a deal * @param {DealsApiGetDealActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3510,10 +3510,10 @@ export class DealsApi extends BaseAPI { } /** - * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?deal_id={id} instead. * @summary List all persons associated with a deal * @param {DealsApiGetDealPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3525,7 +3525,7 @@ export class DealsApi extends BaseAPI { * Lists products attached to a deal. * @summary List products attached to a deal * @param {DealsApiGetDealProductsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3561,7 +3561,7 @@ export class DealsApi extends BaseAPI { * Returns all deals. For more information, see the tutorial for getting all deals. * @summary Get all deals * @param {DealsApiGetDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3570,10 +3570,10 @@ export class DealsApi extends BaseAPI { } /** - * Returns all deals. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all deals (BETA) + * Returns all deals. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/deals instead. + * @summary Get all deals collection * @param {DealsApiGetDealsCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3621,7 +3621,7 @@ export class DealsApi extends BaseAPI { * Searches all deals by title, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found deals can be filtered by the person ID and the organization ID. * @summary Search deals * @param {DealsApiSearchDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3633,7 +3633,7 @@ export class DealsApi extends BaseAPI { * Updates the properties of a deal. For more information, see the tutorial for updating a deal. * @summary Update a deal * @param {DealsApiUpdateDealRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ @@ -3645,7 +3645,7 @@ export class DealsApi extends BaseAPI { * Updates the details of the product that has been attached to a deal. * @summary Update the product attached to a deal * @param {DealsApiUpdateDealProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof DealsApi */ diff --git a/src/versions/v1/api/item-search-api.ts b/src/versions/v1/api/item-search-api.ts index 74fd1595..540b188c 100644 --- a/src/versions/v1/api/item-search-api.ts +++ b/src/versions/v1/api/item-search-api.ts @@ -42,7 +42,7 @@ export const ItemSearchApiAxiosParamCreator = function (configuration?: Configur * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default. * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ searchItem: async (term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', start?: number, limit?: number, ): Promise => { @@ -120,7 +120,7 @@ export const ItemSearchApiAxiosParamCreator = function (configuration?: Configur * @param {boolean} [return_item_ids] Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned. * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ searchItemByField: async (term: string, field_type: 'dealField' | 'leadField' | 'personField' | 'organizationField' | 'productField' | 'projectField', field_key: string, exact_match?: boolean, return_item_ids?: boolean, start?: number, limit?: number, ): Promise => { @@ -210,7 +210,7 @@ export const ItemSearchApiFp = function(configuration?: Configuration) { * @param {'deal.cc_email' | 'person.picture' | 'product.price'} [include_fields] A comma-separated string array. Supports including optional fields in the results which are not provided by default. * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async searchItem(term: string, item_types?: 'deal' | 'person' | 'organization' | 'product' | 'lead' | 'file' | 'mail_attachment' | 'project', fields?: 'address' | 'code' | 'custom_fields' | 'email' | 'name' | 'notes' | 'organization_name' | 'person_name' | 'phone' | 'title' | 'description', search_for_related_items?: boolean, exact_match?: boolean, include_fields?: 'deal.cc_email' | 'person.picture' | 'product.price', start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -227,7 +227,7 @@ export const ItemSearchApiFp = function(configuration?: Configuration) { * @param {boolean} [return_item_ids] Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned. * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async searchItemByField(term: string, field_type: 'dealField' | 'leadField' | 'personField' | 'organizationField' | 'productField' | 'projectField', field_key: string, exact_match?: boolean, return_item_ids?: boolean, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -248,7 +248,7 @@ export const ItemSearchApiFactory = function (configuration?: Configuration, bas * Performs a search from your choice of item types and fields. * @summary Perform a search from multiple item types * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ searchItem(requestParameters: ItemSearchApiSearchItemRequest, ): Promise { @@ -258,7 +258,7 @@ export const ItemSearchApiFactory = function (configuration?: Configuration, bas * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products). * @summary Perform a search using a specific field from an item type * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ searchItemByField(requestParameters: ItemSearchApiSearchItemByFieldRequest, ): Promise { @@ -397,7 +397,7 @@ export class ItemSearchApi extends BaseAPI { * Performs a search from your choice of item types and fields. * @summary Perform a search from multiple item types * @param {ItemSearchApiSearchItemRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ItemSearchApi */ @@ -409,7 +409,7 @@ export class ItemSearchApi extends BaseAPI { * Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products). * @summary Perform a search using a specific field from an item type * @param {ItemSearchApiSearchItemByFieldRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ItemSearchApi */ diff --git a/src/versions/v1/api/organizations-api.ts b/src/versions/v1/api/organizations-api.ts index 71d4c73b..94f5f589 100644 --- a/src/versions/v1/api/organizations-api.ts +++ b/src/versions/v1/api/organizations-api.ts @@ -81,7 +81,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi * Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for adding an organization. * @summary Add an organization * @param {AddOrganizationRequest} [AddOrganizationRequest] - + * @deprecated * @throws {RequiredError} */ addOrganization: async (AddOrganizationRequest?: AddOrganizationRequest, ): Promise => { @@ -167,7 +167,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi * Marks an organization as deleted. After 30 days, the organization will be permanently deleted. * @summary Delete an organization * @param {number} id The ID of the organization - + * @deprecated * @throws {RequiredError} */ deleteOrganization: async (id: number, ): Promise => { @@ -250,10 +250,10 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. + * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/organizations/{id} instead. * @summary Delete multiple organizations in bulk * @param {string} ids The comma-separated IDs that will be deleted - + * @deprecated * @throws {RequiredError} */ deleteOrganizations: async (ids: string, ): Promise => { @@ -297,7 +297,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi * Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields. * @summary Get details of an organization * @param {number} id The ID of the organization - + * @deprecated * @throws {RequiredError} */ getOrganization: async (id: number, ): Promise => { @@ -335,14 +335,14 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Lists activities associated with an organization. + * Lists activities associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/activities?org_id={id} instead. * @summary List activities associated with an organization * @param {number} id The ID of the organization * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities. * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result - + * @deprecated * @throws {RequiredError} */ getOrganizationActivities: async (id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string, ): Promise => { @@ -447,7 +447,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Lists deals associated with an organization. + * Lists deals associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/deals?org_id={id} instead. * @summary List deals associated with an organization * @param {number} id The ID of the organization * @param {number} [start] Pagination start @@ -455,7 +455,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi * @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @param {0 | 1} [only_primary_association] If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization. - + * @deprecated * @throws {RequiredError} */ getOrganizationDeals: async (id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string, only_primary_association?: 0 | 1, ): Promise => { @@ -661,12 +661,12 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?org_id={id} instead. * @summary List persons of an organization * @param {number} id The ID of the organization * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ getOrganizationPersons: async (id: number, start?: number, limit?: number, ): Promise => { @@ -822,7 +822,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). - + * @deprecated * @throws {RequiredError} */ getOrganizations: async (user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string, ): Promise => { @@ -881,15 +881,15 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi }; }, /** - * Returns all organizations. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all organizations (BETA) + * Returns all organizations. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/organizations instead. + * @summary Get all organizations 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 `update_time` field. * @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field. * @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned * @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) - + * @deprecated * @throws {RequiredError} */ getOrganizationsCollection: async (cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string, ): Promise => { @@ -1000,7 +1000,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ searchOrganization: async (term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, start?: number, limit?: number, ): Promise => { @@ -1061,7 +1061,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi * @summary Update an organization * @param {number} id The ID of the organization * @param {UpdateOrganizationRequest} [UpdateOrganizationRequest] - + * @deprecated * @throws {RequiredError} */ updateOrganization: async (id: number, UpdateOrganizationRequest?: UpdateOrganizationRequest, ): Promise => { @@ -1116,7 +1116,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { * Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for adding an organization. * @summary Add an organization * @param {AddOrganizationRequest} [AddOrganizationRequest] - + * @deprecated * @throws {RequiredError} */ async addOrganization(AddOrganizationRequest?: AddOrganizationRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1139,7 +1139,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { * Marks an organization as deleted. After 30 days, the organization will be permanently deleted. * @summary Delete an organization * @param {number} id The ID of the organization - + * @deprecated * @throws {RequiredError} */ async deleteOrganization(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1159,10 +1159,10 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. + * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/organizations/{id} instead. * @summary Delete multiple organizations in bulk * @param {string} ids The comma-separated IDs that will be deleted - + * @deprecated * @throws {RequiredError} */ async deleteOrganizations(ids: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1173,7 +1173,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { * Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields. * @summary Get details of an organization * @param {number} id The ID of the organization - + * @deprecated * @throws {RequiredError} */ async getOrganization(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1181,14 +1181,14 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists activities associated with an organization. + * Lists activities associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/activities?org_id={id} instead. * @summary List activities associated with an organization * @param {number} id The ID of the organization * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities. * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result - + * @deprecated * @throws {RequiredError} */ async getOrganizationActivities(id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1209,7 +1209,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists deals associated with an organization. + * Lists deals associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/deals?org_id={id} instead. * @summary List deals associated with an organization * @param {number} id The ID of the organization * @param {number} [start] Pagination start @@ -1217,7 +1217,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { * @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). * @param {0 | 1} [only_primary_association] If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization. - + * @deprecated * @throws {RequiredError} */ async getOrganizationDeals(id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string, only_primary_association?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1263,12 +1263,12 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?org_id={id} instead. * @summary List persons of an organization * @param {number} id The ID of the organization * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async getOrganizationPersons(id: number, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1310,7 +1310,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). - + * @deprecated * @throws {RequiredError} */ async getOrganizations(user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1318,15 +1318,15 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns all organizations. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all organizations (BETA) + * Returns all organizations. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/organizations instead. + * @summary Get all organizations 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 `update_time` field. * @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field. * @param {number} [owner_id] If supplied, only organizations owned by the given user will be returned * @param {string} [first_char] If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive) - + * @deprecated * @throws {RequiredError} */ async getOrganizationsCollection(cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1353,7 +1353,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { * @param {boolean} [exact_match] When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async searchOrganization(term: string, fields?: 'address' | 'custom_fields' | 'notes' | 'name', exact_match?: boolean, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1365,7 +1365,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) { * @summary Update an organization * @param {number} id The ID of the organization * @param {UpdateOrganizationRequest} [UpdateOrganizationRequest] - + * @deprecated * @throws {RequiredError} */ async updateOrganization(id: number, UpdateOrganizationRequest?: UpdateOrganizationRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1386,7 +1386,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, * Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for adding an organization. * @summary Add an organization * @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ addOrganization(requestParameters: OrganizationsApiAddOrganizationRequest = {}, ): Promise { @@ -1406,7 +1406,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, * Marks an organization as deleted. After 30 days, the organization will be permanently deleted. * @summary Delete an organization * @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteOrganization(requestParameters: OrganizationsApiDeleteOrganizationRequest, ): Promise { @@ -1423,10 +1423,10 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, return localVarFp.deleteOrganizationFollower(requestParameters.id, requestParameters.follower_id, ).then((request) => request(axios, basePath)); }, /** - * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. + * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/organizations/{id} instead. * @summary Delete multiple organizations in bulk * @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteOrganizations(requestParameters: OrganizationsApiDeleteOrganizationsRequest, ): Promise { @@ -1436,17 +1436,17 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, * Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields. * @summary Get details of an organization * @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getOrganization(requestParameters: OrganizationsApiGetOrganizationRequest, ): Promise { return localVarFp.getOrganization(requestParameters.id, ).then((request) => request(axios, basePath)); }, /** - * Lists activities associated with an organization. + * Lists activities associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/activities?org_id={id} instead. * @summary List activities associated with an organization * @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getOrganizationActivities(requestParameters: OrganizationsApiGetOrganizationActivitiesRequest, ): Promise { @@ -1463,10 +1463,10 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, return localVarFp.getOrganizationChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit, ).then((request) => request(axios, basePath)); }, /** - * Lists deals associated with an organization. + * Lists deals associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/deals?org_id={id} instead. * @summary List deals associated with an organization * @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getOrganizationDeals(requestParameters: OrganizationsApiGetOrganizationDealsRequest, ): Promise { @@ -1503,10 +1503,10 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, return localVarFp.getOrganizationMailMessages(requestParameters.id, requestParameters.start, requestParameters.limit, ).then((request) => request(axios, basePath)); }, /** - * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?org_id={id} instead. * @summary List persons of an organization * @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getOrganizationPersons(requestParameters: OrganizationsApiGetOrganizationPersonsRequest, ): Promise { @@ -1536,17 +1536,17 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, * Returns all organizations. * @summary Get all organizations * @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getOrganizations(requestParameters: OrganizationsApiGetOrganizationsRequest = {}, ): Promise { return localVarFp.getOrganizations(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort, ).then((request) => request(axios, basePath)); }, /** - * Returns all organizations. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all organizations (BETA) + * Returns all organizations. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/organizations instead. + * @summary Get all organizations collection * @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getOrganizationsCollection(requestParameters: OrganizationsApiGetOrganizationsCollectionRequest = {}, ): Promise { @@ -1566,7 +1566,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, * Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. * @summary Search organizations * @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ searchOrganization(requestParameters: OrganizationsApiSearchOrganizationRequest, ): Promise { @@ -1576,7 +1576,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration, * Updates the properties of an organization. * @summary Update an organization * @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ updateOrganization(requestParameters: OrganizationsApiUpdateOrganizationRequest, ): Promise { @@ -2156,7 +2156,7 @@ export class OrganizationsApi extends BaseAPI { * Adds a new organization. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the organizationFields and look for `key` values. For more information, see the tutorial for adding an organization. * @summary Add an organization * @param {OrganizationsApiAddOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2180,7 +2180,7 @@ export class OrganizationsApi extends BaseAPI { * Marks an organization as deleted. After 30 days, the organization will be permanently deleted. * @summary Delete an organization * @param {OrganizationsApiDeleteOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2201,10 +2201,10 @@ export class OrganizationsApi extends BaseAPI { } /** - * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted. + * Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/organizations/{id} instead. * @summary Delete multiple organizations in bulk * @param {OrganizationsApiDeleteOrganizationsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2216,7 +2216,7 @@ export class OrganizationsApi extends BaseAPI { * Returns the details of an organization. Note that this also returns some additional fields which are not present when asking for all organizations. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of organizationFields. * @summary Get details of an organization * @param {OrganizationsApiGetOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2225,10 +2225,10 @@ export class OrganizationsApi extends BaseAPI { } /** - * Lists activities associated with an organization. + * Lists activities associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/activities?org_id={id} instead. * @summary List activities associated with an organization * @param {OrganizationsApiGetOrganizationActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2249,10 +2249,10 @@ export class OrganizationsApi extends BaseAPI { } /** - * Lists deals associated with an organization. + * Lists deals associated with an organization.
This endpoint has been deprecated. Please use GET /api/v2/deals?org_id={id} instead. * @summary List deals associated with an organization * @param {OrganizationsApiGetOrganizationDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2297,10 +2297,10 @@ export class OrganizationsApi extends BaseAPI { } /** - * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. + * Lists persons associated with an organization.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
This endpoint has been deprecated. Please use GET /api/v2/persons?org_id={id} instead. * @summary List persons of an organization * @param {OrganizationsApiGetOrganizationPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2336,7 +2336,7 @@ export class OrganizationsApi extends BaseAPI { * Returns all organizations. * @summary Get all organizations * @param {OrganizationsApiGetOrganizationsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2345,10 +2345,10 @@ export class OrganizationsApi extends BaseAPI { } /** - * Returns all organizations. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all organizations (BETA) + * Returns all organizations. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/organizations instead. + * @summary Get all organizations collection * @param {OrganizationsApiGetOrganizationsCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2372,7 +2372,7 @@ export class OrganizationsApi extends BaseAPI { * Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. * @summary Search organizations * @param {OrganizationsApiSearchOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ @@ -2384,7 +2384,7 @@ export class OrganizationsApi extends BaseAPI { * Updates the properties of an organization. * @summary Update an organization * @param {OrganizationsApiUpdateOrganizationRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof OrganizationsApi */ diff --git a/src/versions/v1/api/persons-api.ts b/src/versions/v1/api/persons-api.ts index 4308afaf..98bef363 100644 --- a/src/versions/v1/api/persons-api.ts +++ b/src/versions/v1/api/persons-api.ts @@ -81,7 +81,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field. * @summary Add a person * @param {AddPersonRequest} [AddPersonRequest] - + * @deprecated * @throws {RequiredError} */ addPerson: async (AddPersonRequest?: AddPersonRequest, ): Promise => { @@ -239,7 +239,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati * Marks a person as deleted. After 30 days, the person will be permanently deleted. * @summary Delete a person * @param {number} id The ID of the person - + * @deprecated * @throws {RequiredError} */ deletePerson: async (id: number, ): Promise => { @@ -363,10 +363,10 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. + * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/persons/{id} instead. * @summary Delete multiple persons in bulk * @param {string} ids The comma-separated IDs that will be deleted - + * @deprecated * @throws {RequiredError} */ deletePersons: async (ids: string, ): Promise => { @@ -410,7 +410,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary Get details of a person * @param {number} id The ID of the person - + * @deprecated * @throws {RequiredError} */ getPerson: async (id: number, ): Promise => { @@ -448,14 +448,14 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Lists activities associated with a person. + * Lists activities associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/activities?person_id={id} instead. * @summary List activities associated with a person * @param {number} id The ID of the person * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities. * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result - + * @deprecated * @throws {RequiredError} */ getPersonActivities: async (id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string, ): Promise => { @@ -560,14 +560,14 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Lists deals associated with a person. + * Lists deals associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/deals?person_id={id} instead. * @summary List deals associated with a person * @param {number} id The ID of the person * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). - + * @deprecated * @throws {RequiredError} */ getPersonDeals: async (id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string, ): Promise => { @@ -930,7 +930,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). - + * @deprecated * @throws {RequiredError} */ getPersons: async (user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string, ): Promise => { @@ -989,15 +989,15 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all persons (BETA) + * Returns all persons. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/persons instead. + * @summary Get all persons 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 `update_time` field. * @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field. * @param {number} [owner_id] If supplied, only persons owned by the given user will be returned * @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) - + * @deprecated * @throws {RequiredError} */ getPersonsCollection: async (cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string, ): Promise => { @@ -1110,7 +1110,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ searchPersons: async (term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', start?: number, limit?: number, ): Promise => { @@ -1234,7 +1234,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field. * @summary Add a person * @param {AddPersonRequest} [AddPersonRequest] - + * @deprecated * @throws {RequiredError} */ async addPerson(AddPersonRequest?: AddPersonRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1273,7 +1273,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { * Marks a person as deleted. After 30 days, the person will be permanently deleted. * @summary Delete a person * @param {number} id The ID of the person - + * @deprecated * @throws {RequiredError} */ async deletePerson(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1304,10 +1304,10 @@ export const PersonsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. + * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/persons/{id} instead. * @summary Delete multiple persons in bulk * @param {string} ids The comma-separated IDs that will be deleted - + * @deprecated * @throws {RequiredError} */ async deletePersons(ids: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1318,7 +1318,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary Get details of a person * @param {number} id The ID of the person - + * @deprecated * @throws {RequiredError} */ async getPerson(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1326,14 +1326,14 @@ export const PersonsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists activities associated with a person. + * Lists activities associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/activities?person_id={id} instead. * @summary List activities associated with a person * @param {number} id The ID of the person * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {0 | 1} [done] Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities. * @param {string} [exclude] A comma-separated string of activity IDs to exclude from result - + * @deprecated * @throws {RequiredError} */ async getPersonActivities(id: number, start?: number, limit?: number, done?: 0 | 1, exclude?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1354,14 +1354,14 @@ export const PersonsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists deals associated with a person. + * Lists deals associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/deals?person_id={id} instead. * @summary List deals associated with a person * @param {number} id The ID of the person * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted'} [status] Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). - + * @deprecated * @throws {RequiredError} */ async getPersonDeals(id: number, start?: number, limit?: number, status?: 'open' | 'won' | 'lost' | 'deleted' | 'all_not_deleted', sort?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1454,7 +1454,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page * @param {string} [sort] The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). - + * @deprecated * @throws {RequiredError} */ async getPersons(user_id?: number, filter_id?: number, first_char?: string, start?: number, limit?: number, sort?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1462,15 +1462,15 @@ export const PersonsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all persons (BETA) + * Returns all persons. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/persons instead. + * @summary Get all persons 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 `update_time` field. * @param {string} [until] The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field. * @param {number} [owner_id] If supplied, only persons owned by the given user will be returned * @param {string} [first_char] If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive) - + * @deprecated * @throws {RequiredError} */ async getPersonsCollection(cursor?: string, limit?: number, since?: string, until?: string, owner_id?: number, first_char?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1499,7 +1499,7 @@ export const PersonsApiFp = function(configuration?: Configuration) { * @param {'person.picture'} [include_fields] Supports including optional fields in the results which are not provided by default * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async searchPersons(term: string, fields?: 'custom_fields' | 'email' | 'notes' | 'phone' | 'name', exact_match?: boolean, organization_id?: number, include_fields?: 'person.picture', start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -1532,7 +1532,7 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field. * @summary Add a person * @param {PersonsApiAddPersonRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ addPerson(requestParameters: PersonsApiAddPersonRequest = {}, ): Promise { @@ -1562,7 +1562,7 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa * Marks a person as deleted. After 30 days, the person will be permanently deleted. * @summary Delete a person * @param {PersonsApiDeletePersonRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deletePerson(requestParameters: PersonsApiDeletePersonRequest, ): Promise { @@ -1589,10 +1589,10 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa return localVarFp.deletePersonPicture(requestParameters.id, ).then((request) => request(axios, basePath)); }, /** - * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. + * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/persons/{id} instead. * @summary Delete multiple persons in bulk * @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deletePersons(requestParameters: PersonsApiDeletePersonsRequest, ): Promise { @@ -1602,17 +1602,17 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary Get details of a person * @param {PersonsApiGetPersonRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getPerson(requestParameters: PersonsApiGetPersonRequest, ): Promise { return localVarFp.getPerson(requestParameters.id, ).then((request) => request(axios, basePath)); }, /** - * Lists activities associated with a person. + * Lists activities associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/activities?person_id={id} instead. * @summary List activities associated with a person * @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getPersonActivities(requestParameters: PersonsApiGetPersonActivitiesRequest, ): Promise { @@ -1629,10 +1629,10 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa return localVarFp.getPersonChangelog(requestParameters.id, requestParameters.cursor, requestParameters.limit, ).then((request) => request(axios, basePath)); }, /** - * Lists deals associated with a person. + * Lists deals associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/deals?person_id={id} instead. * @summary List deals associated with a person * @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getPersonDeals(requestParameters: PersonsApiGetPersonDealsRequest, ): Promise { @@ -1702,17 +1702,17 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa * Returns all persons. * @summary Get all persons * @param {PersonsApiGetPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getPersons(requestParameters: PersonsApiGetPersonsRequest = {}, ): Promise { return localVarFp.getPersons(requestParameters.user_id, requestParameters.filter_id, requestParameters.first_char, requestParameters.start, requestParameters.limit, requestParameters.sort, ).then((request) => request(axios, basePath)); }, /** - * Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all persons (BETA) + * Returns all persons. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/persons instead. + * @summary Get all persons collection * @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getPersonsCollection(requestParameters: PersonsApiGetPersonsCollectionRequest = {}, ): Promise { @@ -1732,7 +1732,7 @@ export const PersonsApiFactory = function (configuration?: Configuration, basePa * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID. * @summary Search persons * @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ searchPersons(requestParameters: PersonsApiSearchPersonsRequest, ): Promise { @@ -2392,7 +2392,7 @@ export class PersonsApi extends BaseAPI { * Adds a new person. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the personFields and look for `key` values.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `data.marketing_status` field. * @summary Add a person * @param {PersonsApiAddPersonRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2428,7 +2428,7 @@ export class PersonsApi extends BaseAPI { * Marks a person as deleted. After 30 days, the person will be permanently deleted. * @summary Delete a person * @param {PersonsApiDeletePersonRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2461,10 +2461,10 @@ export class PersonsApi extends BaseAPI { } /** - * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted. + * Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/persons/{id} instead. * @summary Delete multiple persons in bulk * @param {PersonsApiDeletePersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2476,7 +2476,7 @@ export class PersonsApi extends BaseAPI { * Returns the details of a person. Note that this also returns some additional fields which are not present when asking for all persons. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of personFields.
If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field. * @summary Get details of a person * @param {PersonsApiGetPersonRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2485,10 +2485,10 @@ export class PersonsApi extends BaseAPI { } /** - * Lists activities associated with a person. + * Lists activities associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/activities?person_id={id} instead. * @summary List activities associated with a person * @param {PersonsApiGetPersonActivitiesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2509,10 +2509,10 @@ export class PersonsApi extends BaseAPI { } /** - * Lists deals associated with a person. + * Lists deals associated with a person.
This endpoint has been deprecated. Please use GET /api/v2/deals?person_id={id} instead. * @summary List deals associated with a person * @param {PersonsApiGetPersonDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2596,7 +2596,7 @@ export class PersonsApi extends BaseAPI { * Returns all persons. * @summary Get all persons * @param {PersonsApiGetPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2605,10 +2605,10 @@ export class PersonsApi extends BaseAPI { } /** - * Returns all persons. This is a cursor-paginated endpoint that is currently in BETA. For more information, please refer to our documentation on pagination. 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 here. - * @summary Get all persons (BETA) + * Returns all persons. 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 here.
This endpoint has been deprecated. Please use GET /api/v2/persons instead. + * @summary Get all persons collection * @param {PersonsApiGetPersonsCollectionRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ @@ -2632,7 +2632,7 @@ export class PersonsApi extends BaseAPI { * Searches all persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found persons can be filtered by organization ID. * @summary Search persons * @param {PersonsApiSearchPersonsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PersonsApi */ diff --git a/src/versions/v1/api/pipelines-api.ts b/src/versions/v1/api/pipelines-api.ts index cc537827..9f7ca076 100644 --- a/src/versions/v1/api/pipelines-api.ts +++ b/src/versions/v1/api/pipelines-api.ts @@ -51,7 +51,7 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura * Adds a new pipeline. * @summary Add a new pipeline * @param {PipelineRequest} [PipelineRequest] - + * @deprecated * @throws {RequiredError} */ addPipeline: async (PipelineRequest?: PipelineRequest, ): Promise => { @@ -92,7 +92,7 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura * Marks a pipeline as deleted. * @summary Delete a pipeline * @param {number} id The ID of the pipeline - + * @deprecated * @throws {RequiredError} */ deletePipeline: async (id: number, ): Promise => { @@ -134,7 +134,7 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura * @summary Get one pipeline * @param {number} id The ID of the pipeline * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. - + * @deprecated * @throws {RequiredError} */ getPipeline: async (id: number, totals_convert_currency?: string, ): Promise => { @@ -240,7 +240,7 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura }; }, /** - * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {number} id The ID of the pipeline * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned @@ -251,7 +251,7 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura * @param {number} [limit] Items shown per page * @param {0 | 1} [get_summary] Whether to include a summary of the pipeline in the `additional_data` or not * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled. - + * @deprecated * @throws {RequiredError} */ getPipelineDeals: async (id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, stage_id?: number, start?: number, limit?: number, get_summary?: 0 | 1, totals_convert_currency?: string, ): Promise => { @@ -387,7 +387,7 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura /** * Returns data about all pipelines. * @summary Get all pipelines - + * @deprecated * @throws {RequiredError} */ getPipelines: async (): Promise => { @@ -426,7 +426,7 @@ export const PipelinesApiAxiosParamCreator = function (configuration?: Configura * @summary Update a pipeline * @param {number} id The ID of the pipeline * @param {PipelineRequest1} [PipelineRequest1] - + * @deprecated * @throws {RequiredError} */ updatePipeline: async (id: number, PipelineRequest1?: PipelineRequest1, ): Promise => { @@ -481,7 +481,7 @@ export const PipelinesApiFp = function(configuration?: Configuration) { * Adds a new pipeline. * @summary Add a new pipeline * @param {PipelineRequest} [PipelineRequest] - + * @deprecated * @throws {RequiredError} */ async addPipeline(PipelineRequest?: PipelineRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -492,7 +492,7 @@ export const PipelinesApiFp = function(configuration?: Configuration) { * Marks a pipeline as deleted. * @summary Delete a pipeline * @param {number} id The ID of the pipeline - + * @deprecated * @throws {RequiredError} */ async deletePipeline(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -504,7 +504,7 @@ export const PipelinesApiFp = function(configuration?: Configuration) { * @summary Get one pipeline * @param {number} id The ID of the pipeline * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. - + * @deprecated * @throws {RequiredError} */ async getPipeline(id: number, totals_convert_currency?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -526,7 +526,7 @@ export const PipelinesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {number} id The ID of the pipeline * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned @@ -537,7 +537,7 @@ export const PipelinesApiFp = function(configuration?: Configuration) { * @param {number} [limit] Items shown per page * @param {0 | 1} [get_summary] Whether to include a summary of the pipeline in the `additional_data` or not * @param {string} [totals_convert_currency] The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled. - + * @deprecated * @throws {RequiredError} */ async getPipelineDeals(id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, stage_id?: number, start?: number, limit?: number, get_summary?: 0 | 1, totals_convert_currency?: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -561,7 +561,7 @@ export const PipelinesApiFp = function(configuration?: Configuration) { /** * Returns data about all pipelines. * @summary Get all pipelines - + * @deprecated * @throws {RequiredError} */ async getPipelines(): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -573,7 +573,7 @@ export const PipelinesApiFp = function(configuration?: Configuration) { * @summary Update a pipeline * @param {number} id The ID of the pipeline * @param {PipelineRequest1} [PipelineRequest1] - + * @deprecated * @throws {RequiredError} */ async updatePipeline(id: number, PipelineRequest1?: PipelineRequest1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -594,7 +594,7 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base * Adds a new pipeline. * @summary Add a new pipeline * @param {PipelinesApiAddPipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ addPipeline(requestParameters: PipelinesApiAddPipelineRequest = {}, ): Promise { @@ -604,7 +604,7 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base * Marks a pipeline as deleted. * @summary Delete a pipeline * @param {PipelinesApiDeletePipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deletePipeline(requestParameters: PipelinesApiDeletePipelineRequest, ): Promise { @@ -614,7 +614,7 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages. * @summary Get one pipeline * @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getPipeline(requestParameters: PipelinesApiGetPipelineRequest, ): Promise { @@ -631,10 +631,10 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base return localVarFp.getPipelineConversionStatistics(requestParameters.id, requestParameters.start_date, requestParameters.end_date, requestParameters.user_id, ).then((request) => request(axios, basePath)); }, /** - * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {PipelinesApiGetPipelineDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getPipelineDeals(requestParameters: PipelinesApiGetPipelineDealsRequest, ): Promise { @@ -653,7 +653,7 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base /** * Returns data about all pipelines. * @summary Get all pipelines - + * @deprecated * @throws {RequiredError} */ getPipelines(): Promise { @@ -663,7 +663,7 @@ export const PipelinesApiFactory = function (configuration?: Configuration, base * Updates the properties of a pipeline. * @summary Update a pipeline * @param {PipelinesApiUpdatePipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ updatePipeline(requestParameters: PipelinesApiUpdatePipelineRequest, ): Promise { @@ -893,7 +893,7 @@ export class PipelinesApi extends BaseAPI { * Adds a new pipeline. * @summary Add a new pipeline * @param {PipelinesApiAddPipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PipelinesApi */ @@ -905,7 +905,7 @@ export class PipelinesApi extends BaseAPI { * Marks a pipeline as deleted. * @summary Delete a pipeline * @param {PipelinesApiDeletePipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PipelinesApi */ @@ -917,7 +917,7 @@ export class PipelinesApi extends BaseAPI { * Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages. * @summary Get one pipeline * @param {PipelinesApiGetPipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PipelinesApi */ @@ -938,10 +938,10 @@ export class PipelinesApi extends BaseAPI { } /** - * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific pipeline across all its stages. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?pipeline_id={id} instead. * @summary Get deals in a pipeline * @param {PipelinesApiGetPipelineDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PipelinesApi */ @@ -964,7 +964,7 @@ export class PipelinesApi extends BaseAPI { /** * Returns data about all pipelines. * @summary Get all pipelines - + * @deprecated * @throws {RequiredError} * @memberof PipelinesApi */ @@ -976,7 +976,7 @@ export class PipelinesApi extends BaseAPI { * Updates the properties of a pipeline. * @summary Update a pipeline * @param {PipelinesApiUpdatePipelineRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof PipelinesApi */ diff --git a/src/versions/v1/api/products-api.ts b/src/versions/v1/api/products-api.ts index b35b8133..817173e4 100644 --- a/src/versions/v1/api/products-api.ts +++ b/src/versions/v1/api/products-api.ts @@ -59,7 +59,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat * Adds a new product to the Products inventory. For more information, see the tutorial for adding a product. * @summary Add a product * @param {AddProductRequest} [AddProductRequest] - + * @deprecated * @throws {RequiredError} */ addProduct: async (AddProductRequest?: AddProductRequest, ): Promise => { @@ -145,7 +145,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat * Marks a product as deleted. After 30 days, the product will be permanently deleted. * @summary Delete a product * @param {number} id The ID of the product - + * @deprecated * @throws {RequiredError} */ deleteProduct: async (id: number, ): Promise => { @@ -231,7 +231,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat * Returns data about a specific product. * @summary Get one product * @param {number} id The ID of the product - + * @deprecated * @throws {RequiredError} */ getProduct: async (id: number, ): Promise => { @@ -482,7 +482,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat * @param {boolean} [get_summary] If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ getProducts: async (user_id?: number, filter_id?: number, ids?: Array, first_char?: string, get_summary?: boolean, start?: number, limit?: number, ): Promise => { @@ -553,7 +553,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ searchProducts: async (term: string, fields?: 'code' | 'custom_fields' | 'name', exact_match?: boolean, include_fields?: 'product.price', start?: number, limit?: number, ): Promise => { @@ -618,7 +618,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat * @summary Update a product * @param {number} id The ID of the product * @param {UpdateProductRequest} [UpdateProductRequest] - + * @deprecated * @throws {RequiredError} */ updateProduct: async (id: number, UpdateProductRequest?: UpdateProductRequest, ): Promise => { @@ -673,7 +673,7 @@ export const ProductsApiFp = function(configuration?: Configuration) { * Adds a new product to the Products inventory. For more information, see the tutorial for adding a product. * @summary Add a product * @param {AddProductRequest} [AddProductRequest] - + * @deprecated * @throws {RequiredError} */ async addProduct(AddProductRequest?: AddProductRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -696,7 +696,7 @@ export const ProductsApiFp = function(configuration?: Configuration) { * Marks a product as deleted. After 30 days, the product will be permanently deleted. * @summary Delete a product * @param {number} id The ID of the product - + * @deprecated * @throws {RequiredError} */ async deleteProduct(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -719,7 +719,7 @@ export const ProductsApiFp = function(configuration?: Configuration) { * Returns data about a specific product. * @summary Get one product * @param {number} id The ID of the product - + * @deprecated * @throws {RequiredError} */ async getProduct(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -788,7 +788,7 @@ export const ProductsApiFp = function(configuration?: Configuration) { * @param {boolean} [get_summary] If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async getProducts(user_id?: number, filter_id?: number, ids?: Array, first_char?: string, get_summary?: boolean, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -804,7 +804,7 @@ export const ProductsApiFp = function(configuration?: Configuration) { * @param {'product.price'} [include_fields] Supports including optional fields in the results which are not provided by default * @param {number} [start] Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter. * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async searchProducts(term: string, fields?: 'code' | 'custom_fields' | 'name', exact_match?: boolean, include_fields?: 'product.price', start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -816,7 +816,7 @@ export const ProductsApiFp = function(configuration?: Configuration) { * @summary Update a product * @param {number} id The ID of the product * @param {UpdateProductRequest} [UpdateProductRequest] - + * @deprecated * @throws {RequiredError} */ async updateProduct(id: number, UpdateProductRequest?: UpdateProductRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -837,7 +837,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP * Adds a new product to the Products inventory. For more information, see the tutorial for adding a product. * @summary Add a product * @param {ProductsApiAddProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ addProduct(requestParameters: ProductsApiAddProductRequest = {}, ): Promise { @@ -857,7 +857,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP * Marks a product as deleted. After 30 days, the product will be permanently deleted. * @summary Delete a product * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteProduct(requestParameters: ProductsApiDeleteProductRequest, ): Promise { @@ -877,7 +877,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP * Returns data about a specific product. * @summary Get one product * @param {ProductsApiGetProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getProduct(requestParameters: ProductsApiGetProductRequest, ): Promise { @@ -927,7 +927,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP * Returns data about all products. * @summary Get all products * @param {ProductsApiGetProductsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getProducts(requestParameters: ProductsApiGetProductsRequest = {}, ): Promise { @@ -937,7 +937,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. * @summary Search products * @param {ProductsApiSearchProductsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ searchProducts(requestParameters: ProductsApiSearchProductsRequest, ): Promise { @@ -947,7 +947,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP * Updates product data. * @summary Update a product * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ updateProduct(requestParameters: ProductsApiUpdateProductRequest, ): Promise { @@ -1289,7 +1289,7 @@ export class ProductsApi extends BaseAPI { * Adds a new product to the Products inventory. For more information, see the tutorial for adding a product. * @summary Add a product * @param {ProductsApiAddProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ProductsApi */ @@ -1313,7 +1313,7 @@ export class ProductsApi extends BaseAPI { * Marks a product as deleted. After 30 days, the product will be permanently deleted. * @summary Delete a product * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ProductsApi */ @@ -1337,7 +1337,7 @@ export class ProductsApi extends BaseAPI { * Returns data about a specific product. * @summary Get one product * @param {ProductsApiGetProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ProductsApi */ @@ -1397,7 +1397,7 @@ export class ProductsApi extends BaseAPI { * Returns data about all products. * @summary Get all products * @param {ProductsApiGetProductsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ProductsApi */ @@ -1409,7 +1409,7 @@ export class ProductsApi extends BaseAPI { * Searches all products by name, code and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. * @summary Search products * @param {ProductsApiSearchProductsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ProductsApi */ @@ -1421,7 +1421,7 @@ export class ProductsApi extends BaseAPI { * Updates product data. * @summary Update a product * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof ProductsApi */ diff --git a/src/versions/v1/api/stages-api.ts b/src/versions/v1/api/stages-api.ts index 25db90b8..55779214 100644 --- a/src/versions/v1/api/stages-api.ts +++ b/src/versions/v1/api/stages-api.ts @@ -47,7 +47,7 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio * Adds a new stage, returns the ID upon success. * @summary Add a new stage * @param {AddStageRequest} [AddStageRequest] - + * @deprecated * @throws {RequiredError} */ addStage: async (AddStageRequest?: AddStageRequest, ): Promise => { @@ -88,7 +88,7 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio * Marks a stage as deleted. * @summary Delete a stage * @param {number} id The ID of the stage - + * @deprecated * @throws {RequiredError} */ deleteStage: async (id: number, ): Promise => { @@ -126,10 +126,10 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * Marks multiple stages as deleted. + * Marks multiple stages as deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/stages/{id} instead. * @summary Delete multiple stages in bulk * @param {string} ids The comma-separated stage IDs to delete - + * @deprecated * @throws {RequiredError} */ deleteStages: async (ids: string, ): Promise => { @@ -174,7 +174,7 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio * @summary Get one stage * @param {number} id The ID of the stage * @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user - + * @deprecated * @throws {RequiredError} */ getStage: async (id: number, everyone?: 0 | 1, ): Promise => { @@ -216,7 +216,7 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio }; }, /** - * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?stage_id={id} instead. * @summary Get deals in a stage * @param {number} id The ID of the stage * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned @@ -224,7 +224,7 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio * @param {0 | 1} [everyone] If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ getStageDeals: async (id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, start?: number, limit?: number, ): Promise => { @@ -287,7 +287,7 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio * @param {number} [pipeline_id] The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ getStages: async (pipeline_id?: number, start?: number, limit?: number, ): Promise => { @@ -338,7 +338,7 @@ export const StagesApiAxiosParamCreator = function (configuration?: Configuratio * @summary Update stage details * @param {number} id The ID of the stage * @param {UpdateStageRequest} [UpdateStageRequest] - + * @deprecated * @throws {RequiredError} */ updateStage: async (id: number, UpdateStageRequest?: UpdateStageRequest, ): Promise => { @@ -393,7 +393,7 @@ export const StagesApiFp = function(configuration?: Configuration) { * Adds a new stage, returns the ID upon success. * @summary Add a new stage * @param {AddStageRequest} [AddStageRequest] - + * @deprecated * @throws {RequiredError} */ async addStage(AddStageRequest?: AddStageRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -404,7 +404,7 @@ export const StagesApiFp = function(configuration?: Configuration) { * Marks a stage as deleted. * @summary Delete a stage * @param {number} id The ID of the stage - + * @deprecated * @throws {RequiredError} */ async deleteStage(id: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -412,10 +412,10 @@ export const StagesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Marks multiple stages as deleted. + * Marks multiple stages as deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/stages/{id} instead. * @summary Delete multiple stages in bulk * @param {string} ids The comma-separated stage IDs to delete - + * @deprecated * @throws {RequiredError} */ async deleteStages(ids: string, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -427,7 +427,7 @@ export const StagesApiFp = function(configuration?: Configuration) { * @summary Get one stage * @param {number} id The ID of the stage * @param {0 | 1} [everyone] If `everyone=1` is provided, deals summary will return deals owned by every user - + * @deprecated * @throws {RequiredError} */ async getStage(id: number, everyone?: 0 | 1, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -435,7 +435,7 @@ export const StagesApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?stage_id={id} instead. * @summary Get deals in a stage * @param {number} id The ID of the stage * @param {number} [filter_id] If supplied, only deals matching the given filter will be returned @@ -443,7 +443,7 @@ export const StagesApiFp = function(configuration?: Configuration) { * @param {0 | 1} [everyone] If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async getStageDeals(id: number, filter_id?: number, user_id?: number, everyone?: 0 | 1, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -456,7 +456,7 @@ export const StagesApiFp = function(configuration?: Configuration) { * @param {number} [pipeline_id] The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. * @param {number} [start] Pagination start * @param {number} [limit] Items shown per page - + * @deprecated * @throws {RequiredError} */ async getStages(pipeline_id?: number, start?: number, limit?: number, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -468,7 +468,7 @@ export const StagesApiFp = function(configuration?: Configuration) { * @summary Update stage details * @param {number} id The ID of the stage * @param {UpdateStageRequest} [UpdateStageRequest] - + * @deprecated * @throws {RequiredError} */ async updateStage(id: number, UpdateStageRequest?: UpdateStageRequest, ): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { @@ -489,7 +489,7 @@ export const StagesApiFactory = function (configuration?: Configuration, basePat * Adds a new stage, returns the ID upon success. * @summary Add a new stage * @param {StagesApiAddStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ addStage(requestParameters: StagesApiAddStageRequest = {}, ): Promise { @@ -499,17 +499,17 @@ export const StagesApiFactory = function (configuration?: Configuration, basePat * Marks a stage as deleted. * @summary Delete a stage * @param {StagesApiDeleteStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteStage(requestParameters: StagesApiDeleteStageRequest, ): Promise { return localVarFp.deleteStage(requestParameters.id, ).then((request) => request(axios, basePath)); }, /** - * Marks multiple stages as deleted. + * Marks multiple stages as deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/stages/{id} instead. * @summary Delete multiple stages in bulk * @param {StagesApiDeleteStagesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ deleteStages(requestParameters: StagesApiDeleteStagesRequest, ): Promise { @@ -519,17 +519,17 @@ export const StagesApiFactory = function (configuration?: Configuration, basePat * Returns data about a specific stage. * @summary Get one stage * @param {StagesApiGetStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getStage(requestParameters: StagesApiGetStageRequest, ): Promise { return localVarFp.getStage(requestParameters.id, requestParameters.everyone, ).then((request) => request(axios, basePath)); }, /** - * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?stage_id={id} instead. * @summary Get deals in a stage * @param {StagesApiGetStageDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getStageDeals(requestParameters: StagesApiGetStageDealsRequest, ): Promise { @@ -539,7 +539,7 @@ export const StagesApiFactory = function (configuration?: Configuration, basePat * Returns data about all stages. * @summary Get all stages * @param {StagesApiGetStagesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ getStages(requestParameters: StagesApiGetStagesRequest = {}, ): Promise { @@ -549,7 +549,7 @@ export const StagesApiFactory = function (configuration?: Configuration, basePat * Updates the properties of a stage. * @summary Update stage details * @param {StagesApiUpdateStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} */ updateStage(requestParameters: StagesApiUpdateStageRequest, ): Promise { @@ -730,7 +730,7 @@ export class StagesApi extends BaseAPI { * Adds a new stage, returns the ID upon success. * @summary Add a new stage * @param {StagesApiAddStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof StagesApi */ @@ -742,7 +742,7 @@ export class StagesApi extends BaseAPI { * Marks a stage as deleted. * @summary Delete a stage * @param {StagesApiDeleteStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof StagesApi */ @@ -751,10 +751,10 @@ export class StagesApi extends BaseAPI { } /** - * Marks multiple stages as deleted. + * Marks multiple stages as deleted.
This endpoint has been deprecated. Please use DELETE /api/v2/stages/{id} instead. * @summary Delete multiple stages in bulk * @param {StagesApiDeleteStagesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof StagesApi */ @@ -766,7 +766,7 @@ export class StagesApi extends BaseAPI { * Returns data about a specific stage. * @summary Get one stage * @param {StagesApiGetStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof StagesApi */ @@ -775,10 +775,10 @@ export class StagesApi extends BaseAPI { } /** - * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned. + * Lists deals in a specific stage. If no parameters are provided open deals owned by the authorized user will be returned.
This endpoint has been deprecated. Please use GET /api/v2/deals?stage_id={id} instead. * @summary Get deals in a stage * @param {StagesApiGetStageDealsRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof StagesApi */ @@ -790,7 +790,7 @@ export class StagesApi extends BaseAPI { * Returns data about all stages. * @summary Get all stages * @param {StagesApiGetStagesRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof StagesApi */ @@ -802,7 +802,7 @@ export class StagesApi extends BaseAPI { * Updates the properties of a stage. * @summary Update stage details * @param {StagesApiUpdateStageRequest} requestParameters Request parameters. - + * @deprecated * @throws {RequiredError} * @memberof StagesApi */ diff --git a/src/versions/v2/api/products-api.ts b/src/versions/v2/api/products-api.ts index 6077e715..97c2a0ba 100644 --- a/src/versions/v2/api/products-api.ts +++ b/src/versions/v2/api/products-api.ts @@ -131,7 +131,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat // authentication oauth2 required // oauth required - await setOAuthToObject(localVarHeaderParameter, "oauth2", [], configuration) + await setOAuthToObject(localVarHeaderParameter, "oauth2", ["products:full"], configuration)