Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,25 @@ 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
- Updated `item_price` field data type in products from integer -> number for products and deal products
### Fixed
- Added missing `partnership` value for user access apps list

### Added
- Notice informing the users of the upcoming Subscriptions API deprecation:
- `GET /v1/subscriptions/{id}`
- `GET /v1/subscriptions/find/{dealId}`
- `GET /v1/subscriptions/{id}/payments`
- `POST /v1/subscriptions/recurring`
- `POST /v1/subscriptions/installment`
- `PUT /v1/subscriptions/recurring/{id}`
- `PUT /v1/subscriptions/installment/{id}`
- `PUT /v1/subscriptions/recurring/{id}/cancel`
- `DELETE /v1/subscriptions/{id}`

### Changed
- Updated Webhooks endpoints to v2, including available event_action and event_object properties

## [24.2.0] - 2025-03-12
### Added
Expand Down
52 changes: 17 additions & 35 deletions docs/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,53 +9,22 @@ ActivitiesApi | deleteActivity | **DELETE** /activities/{id} | Delete an activit
ActivitiesApi | getActivities | **GET** /activities | Get all activities
ActivitiesApi | getActivity | **GET** /activities/{id} | Get details of an activity
ActivitiesApi | updateActivity | **PATCH** /activities/{id} | Update an activity
BetaApi | addActivity | **POST** /activities | Add a new activity
BetaApi | addDeal | **POST** /deals | Add a new deal
BetaApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal
BetaApi | addOrganization | **POST** /organizations | Add a new organization
BetaApi | addPerson | **POST** /persons | Add a new person
BetaApi | deleteActivity | **DELETE** /activities/{id} | Delete an activity
BetaApi | deleteAdditionalDiscount | **DELETE** /deals/{id}/discounts/{discount_id} | Delete a discount from a deal
BetaApi | deleteDeal | **DELETE** /deals/{id} | Delete a deal
BetaApi | deleteDealProduct | **DELETE** /deals/{id}/products/{product_attachment_id} | Delete an attached product from a deal
BetaApi | deleteInstallment | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal
BetaApi | deleteOrganization | **DELETE** /organizations/{id} | Delete a organization
BetaApi | deletePerson | **DELETE** /persons/{id} | Delete a person
BetaApi | getActivities | **GET** /activities | Get all activities
BetaApi | getActivity | **GET** /activities/{id} | Get details of an activity
BetaApi | getAdditionalDiscounts | **GET** /deals/{id}/discounts | List discounts added to a deal
BetaApi | getDeal | **GET** /deals/{id} | Get details of a deal
BetaApi | getDealProducts | **GET** /deals/{id}/products | List products attached to a deal
BetaApi | getDeals | **GET** /deals | Get all deals
BetaApi | getDealsProducts | **GET** /deals/products | Get deal products of several deals
BetaApi | getInstallments | **GET** /deals/installments | List installments added to a list of deals
BetaApi | getOrganization | **GET** /organizations/{id} | Get details of a organization
BetaApi | getOrganizations | **GET** /organizations | Get all organizations
BetaApi | getPerson | **GET** /persons/{id} | Get details of a person
BetaApi | getPersons | **GET** /persons | Get all persons
BetaApi | postAdditionalDiscount | **POST** /deals/{id}/discounts | Add a discount to a deal
BetaApi | postInstallment | **POST** /deals/{id}/installments | Add an installment to a deal
BetaApi | searchDeals | **GET** /deals/search | Search deals
BetaApi | searchItem | **GET** /itemSearch | Perform a search from multiple item types
BetaApi | searchItemByField | **GET** /itemSearch/field | Perform a search using a specific field from an item type
BetaApi | searchLeads | **GET** /leads/search | Search leads
BetaApi | searchOrganization | **GET** /organizations/search | Search organizations
BetaApi | searchPersons | **GET** /persons/search | Search persons
BetaApi | updateActivity | **PATCH** /activities/{id} | Update an activity
BetaApi | updateAdditionalDiscount | **PATCH** /deals/{id}/discounts/{discount_id} | Update a discount added to a deal
BetaApi | updateDeal | **PATCH** /deals/{id} | Update a deal
BetaApi | updateDealProduct | **PATCH** /deals/{id}/products/{product_attachment_id} | Update the product attached to a deal
BetaApi | updateInstallment | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal
BetaApi | updateOrganization | **PATCH** /organizations/{id} | Update a organization
BetaApi | updatePerson | **PATCH** /persons/{id} | Update a person
DealsApi | addDeal | **POST** /deals | Add a new deal
DealsApi | addDealFollower | **POST** /deals/{id}/followers | Add a follower to a deal
DealsApi | addDealProduct | **POST** /deals/{id}/products | Add a product to a deal
DealsApi | deleteAdditionalDiscount | **DELETE** /deals/{id}/discounts/{discount_id} | Delete a discount from a deal
DealsApi | deleteDeal | **DELETE** /deals/{id} | Delete a deal
DealsApi | deleteDealFollower | **DELETE** /deals/{id}/followers/{follower_id} | Delete a follower from a deal
DealsApi | deleteDealProduct | **DELETE** /deals/{id}/products/{product_attachment_id} | Delete an attached product from a deal
DealsApi | deleteInstallment | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal
DealsApi | getAdditionalDiscounts | **GET** /deals/{id}/discounts | List discounts added to a deal
DealsApi | getDeal | **GET** /deals/{id} | Get details of a deal
DealsApi | getDealFollowers | **GET** /deals/{id}/followers | List followers of a deal
DealsApi | getDealFollowersChangelog | **GET** /deals/{id}/followers/changelog | List followers changelog of a deal
DealsApi | getDealProducts | **GET** /deals/{id}/products | List products attached to a deal
DealsApi | getDeals | **GET** /deals | Get all deals
DealsApi | getDealsProducts | **GET** /deals/products | Get deal products of several deals
Expand All @@ -71,14 +40,22 @@ ItemSearchApi | searchItem | **GET** /itemSearch | Perform a search from multipl
ItemSearchApi | searchItemByField | **GET** /itemSearch/field | Perform a search using a specific field from an item type
LeadsApi | searchLeads | **GET** /leads/search | Search leads
OrganizationsApi | addOrganization | **POST** /organizations | Add a new organization
OrganizationsApi | addOrganizationFollower | **POST** /organizations/{id}/followers | Add a follower to an organization
OrganizationsApi | deleteOrganization | **DELETE** /organizations/{id} | Delete a organization
OrganizationsApi | deleteOrganizationFollower | **DELETE** /organizations/{id}/followers/{follower_id} | Delete a follower from an organization
OrganizationsApi | getOrganization | **GET** /organizations/{id} | Get details of a organization
OrganizationsApi | getOrganizationFollowers | **GET** /organizations/{id}/followers | List followers of an organization
OrganizationsApi | getOrganizationFollowersChangelog | **GET** /organizations/{id}/followers/changelog | List followers changelog of an organization
OrganizationsApi | getOrganizations | **GET** /organizations | Get all organizations
OrganizationsApi | searchOrganization | **GET** /organizations/search | Search organizations
OrganizationsApi | updateOrganization | **PATCH** /organizations/{id} | Update a organization
PersonsApi | addPerson | **POST** /persons | Add a new person
PersonsApi | addPersonFollower | **POST** /persons/{id}/followers | Add a follower to a person
PersonsApi | deletePerson | **DELETE** /persons/{id} | Delete a person
PersonsApi | deletePersonFollower | **DELETE** /persons/{id}/followers/{follower_id} | Delete a follower from a person
PersonsApi | getPerson | **GET** /persons/{id} | Get details of a person
PersonsApi | getPersonFollowers | **GET** /persons/{id}/followers | List followers of a person
PersonsApi | getPersonFollowersChangelog | **GET** /persons/{id}/followers/changelog | List followers changelog of a person
PersonsApi | getPersons | **GET** /persons | Get all persons
PersonsApi | searchPersons | **GET** /persons/search | Search persons
PersonsApi | updatePerson | **PATCH** /persons/{id} | Update a person
Expand All @@ -88,10 +65,14 @@ PipelinesApi | getPipeline | **GET** /pipelines/{id} | Get one pipeline
PipelinesApi | getPipelines | **GET** /pipelines | Get all pipelines
PipelinesApi | updatePipeline | **PATCH** /pipelines/{id} | Update a pipeline
ProductsApi | addProduct | **POST** /products | Add a product
ProductsApi | addProductFollower | **POST** /products/{id}/followers | Add a follower to a product
ProductsApi | addProductVariation | **POST** /products/{id}/variations | Add a product variation
ProductsApi | deleteProduct | **DELETE** /products/{id} | Delete a product
ProductsApi | deleteProductFollower | **DELETE** /products/{id}/followers/{follower_id} | Delete a follower from a product
ProductsApi | deleteProductVariation | **DELETE** /products/{id}/variations/{product_variation_id} | Delete a product variation
ProductsApi | getProduct | **GET** /products/{id} | Get one product
ProductsApi | getProductFollowers | **GET** /products/{id}/followers | List followers of a product
ProductsApi | getProductFollowersChangelog | **GET** /products/{id}/followers/changelog | List followers changelog of a product
ProductsApi | getProductVariations | **GET** /products/{id}/variations | Get all product variations
ProductsApi | getProducts | **GET** /products | Get all products
ProductsApi | searchProducts | **GET** /products/search | Search products
Expand All @@ -102,6 +83,7 @@ StagesApi | deleteStage | **DELETE** /stages/{id} | Delete a stage
StagesApi | getStage | **GET** /stages/{id} | Get one stage
StagesApi | getStages | **GET** /stages | Get all stages
StagesApi | updateStage | **PATCH** /stages/{id} | Update stage details
UsersApi | getUserFollowers | **GET** /users/{id}/followers | List followers of a user

## Documentation for Authorization

Expand Down
6 changes: 3 additions & 3 deletions src/versions/v1/api/deals-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ export const DealsApiAxiosParamCreator = function (configuration?: Configuration
* Deletes a follower from a deal.
* @summary Delete a follower from a deal
* @param {number} id The ID of the deal
* @param {number} follower_id The ID of the follower
* @param {number} follower_id The ID of the relationship between the follower and the deal

* @throws {RequiredError}
*/
Expand Down Expand Up @@ -1749,7 +1749,7 @@ export const DealsApiFp = function(configuration?: Configuration) {
* Deletes a follower from a deal.
* @summary Delete a follower from a deal
* @param {number} id The ID of the deal
* @param {number} follower_id The ID of the follower
* @param {number} follower_id The ID of the relationship between the follower and the deal

* @throws {RequiredError}
*/
Expand Down Expand Up @@ -2502,7 +2502,7 @@ export interface DealsApiDeleteDealFollowerRequest {
readonly id: number

/**
* The ID of the follower
* The ID of the relationship between the follower and the deal
* @type {number}
* @memberof DealsApiDeleteDealFollower
*/
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v1/api/organizations-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
* Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers\">List followers of an organization</a> endpoint.
* @summary Delete a follower from an organization
* @param {number} id The ID of the organization
* @param {number} follower_id The ID of the follower
* @param {number} follower_id The ID of the relationship between the follower and the organization

* @throws {RequiredError}
*/
Expand Down Expand Up @@ -1150,7 +1150,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
* Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers\">List followers of an organization</a> endpoint.
* @summary Delete a follower from an organization
* @param {number} id The ID of the organization
* @param {number} follower_id The ID of the follower
* @param {number} follower_id The ID of the relationship between the follower and the organization

* @throws {RequiredError}
*/
Expand Down Expand Up @@ -1648,7 +1648,7 @@ export interface OrganizationsApiDeleteOrganizationFollowerRequest {
readonly id: number

/**
* The ID of the follower
* The ID of the relationship between the follower and the organization
* @type {number}
* @memberof OrganizationsApiDeleteOrganizationFollower
*/
Expand Down
6 changes: 3 additions & 3 deletions src/versions/v1/api/persons-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ export const PersonsApiAxiosParamCreator = function (configuration?: Configurati
* Deletes a follower from a person.
* @summary Delete a follower from a person
* @param {number} id The ID of the person
* @param {number} follower_id The ID of the follower
* @param {number} follower_id The ID of the relationship between the follower and the person

* @throws {RequiredError}
*/
Expand Down Expand Up @@ -1284,7 +1284,7 @@ export const PersonsApiFp = function(configuration?: Configuration) {
* Deletes a follower from a person.
* @summary Delete a follower from a person
* @param {number} id The ID of the person
* @param {number} follower_id The ID of the follower
* @param {number} follower_id The ID of the relationship between the follower and the person

* @throws {RequiredError}
*/
Expand Down Expand Up @@ -1863,7 +1863,7 @@ export interface PersonsApiDeletePersonFollowerRequest {
readonly id: number

/**
* The ID of the follower
* The ID of the relationship between the follower and the person
* @type {number}
* @memberof PersonsApiDeletePersonFollower
*/
Expand Down
Loading
Loading