Skip to content

Build 308 - version-minor #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pipedrive-github-actions-bot wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Build 308 - version-minor #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Changed
- Removed beta labels from v2 lead/deal conversion endpoints:
- `GET /api/v2/leads/{id}/convert/status/{conversion_id}`
- `POST /api/v2/leads/{id}/convert`
- `GET /api/v2/deals/{id}/convert/status/{conversion_id}`
- `POST /api/v2/deals/{id}/convert`
- Removed beta labels from v2 deal installments endpoints:
- `GET /api/v2/deals/installments`
- `POST /api/v2/deals/{id}/installments`
- `PATCH /api/v2/deals/{id}/installments/{installment_id}`
- `DELETE /api/v2/deals/{id}/installments/{installment_id}`
- Removed beta labels from v2 product images endpoints:
- `GET /api/v2/products/{id}/images`
- `POST /api/v2/products/{id}/images`
- `PUT /api/v2/products/{id}/images`
- `DELETE /api/v2/products/{id}/images`
### Removed
- Removed deprecated bulk delete endpoints:
- `DELETE /v1/activities`
Expand Down
8 changes: 4 additions & 4 deletions docs/versions/v2/Api/DealsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Method | HTTP request | Description
[**addDealFollower()**](DealsApi.md#addDealFollower) | **POST** /deals/{id}/followers | Add a follower to a deal
[**addDealProduct()**](DealsApi.md#addDealProduct) | **POST** /deals/{id}/products | Add a product to a deal
[**addManyDealProducts()**](DealsApi.md#addManyDealProducts) | **POST** /deals/{id}/products/bulk | Add multiple products to a deal
[**convertDealToLead()**](DealsApi.md#convertDealToLead) | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA)
[**convertDealToLead()**](DealsApi.md#convertDealToLead) | **POST** /deals/{id}/convert/lead | Convert a deal to a lead
[**deleteAdditionalDiscount()**](DealsApi.md#deleteAdditionalDiscount) | **DELETE** /deals/{id}/discounts/{discount_id} | Delete a discount from a deal
[**deleteDeal()**](DealsApi.md#deleteDeal) | **DELETE** /deals/{id} | Delete a deal
[**deleteDealFollower()**](DealsApi.md#deleteDealFollower) | **DELETE** /deals/{id}/followers/{follower_id} | Delete a follower from a deal
Expand All @@ -18,7 +18,7 @@ Method | HTTP request | Description
[**getAdditionalDiscounts()**](DealsApi.md#getAdditionalDiscounts) | **GET** /deals/{id}/discounts | List discounts added to a deal
[**getArchivedDeals()**](DealsApi.md#getArchivedDeals) | **GET** /deals/archived | Get all archived deals
[**getDeal()**](DealsApi.md#getDeal) | **GET** /deals/{id} | Get details of a deal
[**getDealConversionStatus()**](DealsApi.md#getDealConversionStatus) | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status (BETA)
[**getDealConversionStatus()**](DealsApi.md#getDealConversionStatus) | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status
[**getDealFollowers()**](DealsApi.md#getDealFollowers) | **GET** /deals/{id}/followers | List followers of a deal
[**getDealFollowersChangelog()**](DealsApi.md#getDealFollowersChangelog) | **GET** /deals/{id}/followers/changelog | List followers changelog of a deal
[**getDealProducts()**](DealsApi.md#getDealProducts) | **GET** /deals/{id}/products | List products attached to a deal
Expand Down Expand Up @@ -306,7 +306,7 @@ Name | Type | Description | Notes
convertDealToLead($id): \Pipedrive\versions\v2\Model\AddConvertDealToLeadResponse
```

Convert a deal to a lead (BETA)
Convert a deal to a lead

Initiates a conversion of a deal to a lead. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. There are exceptions for entities like invoices or history that are not transferred and remain linked to the original deal. If the conversion is successful, the deal is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealConversionStatus\">/api/v2/deals/{deal_id}/convert/status/{conversion_id}</a> endpoint.

Expand Down Expand Up @@ -1000,7 +1000,7 @@ Name | Type | Description | Notes
getDealConversionStatus($id, $conversion_id)
```

Get Deal conversion status (BETA)
Get Deal conversion status

Returns information about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Lead ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.

Expand Down
8 changes: 4 additions & 4 deletions docs/versions/v2/Api/LeadsApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ All URIs are relative to https://api.pipedrive.com/api/v2.

Method | HTTP request | Description
------------- | ------------- | -------------
[**convertLeadToDeal()**](LeadsApi.md#convertLeadToDeal) | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA)
[**getLeadConversionStatus()**](LeadsApi.md#getLeadConversionStatus) | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA)
[**convertLeadToDeal()**](LeadsApi.md#convertLeadToDeal) | **POST** /leads/{id}/convert/deal | Convert a lead to a deal
[**getLeadConversionStatus()**](LeadsApi.md#getLeadConversionStatus) | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status
[**searchLeads()**](LeadsApi.md#searchLeads) | **GET** /leads/search | Search leads


Expand All @@ -15,7 +15,7 @@ Method | HTTP request | Description
convertLeadToDeal($id, $inline_object): \Pipedrive\versions\v2\Model\AddConvertLeadToDealResponse
```

Convert a lead to a deal (BETA)
Convert a lead to a deal

Initiates a conversion of a lead to a deal. The return value is an ID of a job that was assigned to perform the conversion. Related entities (notes, files, emails, activities, ...) are transferred during the process to the target entity. If the conversion is successful, the lead is marked as deleted. To retrieve the created entity ID and the result of the conversion, call the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadConversionStatus\">/api/v2/leads/{lead_id}/convert/status/{conversion_id}</a> endpoint.

Expand Down Expand Up @@ -82,7 +82,7 @@ Name | Type | Description | Notes
getLeadConversionStatus($id, $conversion_id)
```

Get Lead conversion status (BETA)
Get Lead conversion status

Returns data about the conversion. Status is always present and its value (not_started, running, completed, failed, rejected) represents the current state of the conversion. Deal ID is only present if the conversion was successfully finished. This data is only temporary and removed after a few days.

Expand Down
20 changes: 4 additions & 16 deletions docs/versions/v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,18 +272,6 @@ Class | Method | HTTP request | Description
*ActivitiesApi* | [**updateActivity**](Api/ActivitiesApi.md#updateactivity) | **PATCH** /activities/{id} | Update an activity
*ActivityFieldsApi* | [**getActivityField**](Api/ActivityFieldsApi.md#getactivityfield) | **GET** /activityFields/{field_code} | Get one activity field
*ActivityFieldsApi* | [**getActivityFields**](Api/ActivityFieldsApi.md#getactivityfields) | **GET** /activityFields | Get all activity fields
*BetaApi* | [**convertDealToLead**](Api/BetaApi.md#convertdealtolead) | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA)
*BetaApi* | [**convertLeadToDeal**](Api/BetaApi.md#convertleadtodeal) | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA)
*BetaApi* | [**deleteInstallment**](Api/BetaApi.md#deleteinstallment) | **DELETE** /deals/{id}/installments/{installment_id} | Delete an installment from a deal
*BetaApi* | [**deleteProductImage**](Api/BetaApi.md#deleteproductimage) | **DELETE** /products/{id}/images | Delete an image of a product
*BetaApi* | [**getDealConversionStatus**](Api/BetaApi.md#getdealconversionstatus) | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status (BETA)
*BetaApi* | [**getInstallments**](Api/BetaApi.md#getinstallments) | **GET** /deals/installments | List installments added to a list of deals
*BetaApi* | [**getLeadConversionStatus**](Api/BetaApi.md#getleadconversionstatus) | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA)
*BetaApi* | [**getProductImage**](Api/BetaApi.md#getproductimage) | **GET** /products/{id}/images | Get image of a product
*BetaApi* | [**postInstallment**](Api/BetaApi.md#postinstallment) | **POST** /deals/{id}/installments | Add an installment to a deal
*BetaApi* | [**updateInstallment**](Api/BetaApi.md#updateinstallment) | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal
*BetaApi* | [**updateProductImage**](Api/BetaApi.md#updateproductimage) | **PUT** /products/{id}/images | Update an image for a product
*BetaApi* | [**uploadProductImage**](Api/BetaApi.md#uploadproductimage) | **POST** /products/{id}/images | Upload an image for a product
*DealFieldsApi* | [**addDealField**](Api/DealFieldsApi.md#adddealfield) | **POST** /dealFields | Create one deal field
*DealFieldsApi* | [**addDealFieldOptions**](Api/DealFieldsApi.md#adddealfieldoptions) | **POST** /dealFields/{field_code}/options | Add deal field options in bulk
*DealFieldsApi* | [**deleteDealField**](Api/DealFieldsApi.md#deletedealfield) | **DELETE** /dealFields/{field_code} | Delete one deal field
Expand All @@ -296,7 +284,7 @@ Class | Method | HTTP request | Description
*DealsApi* | [**addDealFollower**](Api/DealsApi.md#adddealfollower) | **POST** /deals/{id}/followers | Add a follower to a deal
*DealsApi* | [**addDealProduct**](Api/DealsApi.md#adddealproduct) | **POST** /deals/{id}/products | Add a product to a deal
*DealsApi* | [**addManyDealProducts**](Api/DealsApi.md#addmanydealproducts) | **POST** /deals/{id}/products/bulk | Add multiple products to a deal
*DealsApi* | [**convertDealToLead**](Api/DealsApi.md#convertdealtolead) | **POST** /deals/{id}/convert/lead | Convert a deal to a lead (BETA)
*DealsApi* | [**convertDealToLead**](Api/DealsApi.md#convertdealtolead) | **POST** /deals/{id}/convert/lead | Convert a deal to a lead
*DealsApi* | [**deleteAdditionalDiscount**](Api/DealsApi.md#deleteadditionaldiscount) | **DELETE** /deals/{id}/discounts/{discount_id} | Delete a discount from a deal
*DealsApi* | [**deleteDeal**](Api/DealsApi.md#deletedeal) | **DELETE** /deals/{id} | Delete a deal
*DealsApi* | [**deleteDealFollower**](Api/DealsApi.md#deletedealfollower) | **DELETE** /deals/{id}/followers/{follower_id} | Delete a follower from a deal
Expand All @@ -306,7 +294,7 @@ Class | Method | HTTP request | Description
*DealsApi* | [**getAdditionalDiscounts**](Api/DealsApi.md#getadditionaldiscounts) | **GET** /deals/{id}/discounts | List discounts added to a deal
*DealsApi* | [**getArchivedDeals**](Api/DealsApi.md#getarchiveddeals) | **GET** /deals/archived | Get all archived deals
*DealsApi* | [**getDeal**](Api/DealsApi.md#getdeal) | **GET** /deals/{id} | Get details of a deal
*DealsApi* | [**getDealConversionStatus**](Api/DealsApi.md#getdealconversionstatus) | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status (BETA)
*DealsApi* | [**getDealConversionStatus**](Api/DealsApi.md#getdealconversionstatus) | **GET** /deals/{id}/convert/status/{conversion_id} | Get Deal conversion status
*DealsApi* | [**getDealFollowers**](Api/DealsApi.md#getdealfollowers) | **GET** /deals/{id}/followers | List followers of a deal
*DealsApi* | [**getDealFollowersChangelog**](Api/DealsApi.md#getdealfollowerschangelog) | **GET** /deals/{id}/followers/changelog | List followers changelog of a deal
*DealsApi* | [**getDealProducts**](Api/DealsApi.md#getdealproducts) | **GET** /deals/{id}/products | List products attached to a deal
Expand All @@ -322,8 +310,8 @@ Class | Method | HTTP request | Description
*DealsApi* | [**updateInstallment**](Api/DealsApi.md#updateinstallment) | **PATCH** /deals/{id}/installments/{installment_id} | Update an installment added to a deal
*ItemSearchApi* | [**searchItem**](Api/ItemSearchApi.md#searchitem) | **GET** /itemSearch | Perform a search from multiple item types
*ItemSearchApi* | [**searchItemByField**](Api/ItemSearchApi.md#searchitembyfield) | **GET** /itemSearch/field | Perform a search using a specific field from an item type
*LeadsApi* | [**convertLeadToDeal**](Api/LeadsApi.md#convertleadtodeal) | **POST** /leads/{id}/convert/deal | Convert a lead to a deal (BETA)
*LeadsApi* | [**getLeadConversionStatus**](Api/LeadsApi.md#getleadconversionstatus) | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status (BETA)
*LeadsApi* | [**convertLeadToDeal**](Api/LeadsApi.md#convertleadtodeal) | **POST** /leads/{id}/convert/deal | Convert a lead to a deal
*LeadsApi* | [**getLeadConversionStatus**](Api/LeadsApi.md#getleadconversionstatus) | **GET** /leads/{id}/convert/status/{conversion_id} | Get Lead conversion status
*LeadsApi* | [**searchLeads**](Api/LeadsApi.md#searchleads) | **GET** /leads/search | Search leads
*OrganizationFieldsApi* | [**addOrganizationField**](Api/OrganizationFieldsApi.md#addorganizationfield) | **POST** /organizationFields | Create one organization field
*OrganizationFieldsApi* | [**addOrganizationFieldOptions**](Api/OrganizationFieldsApi.md#addorganizationfieldoptions) | **POST** /organizationFields/{field_code}/options | Add organization field options in bulk
Expand Down
4 changes: 2 additions & 2 deletions lib/versions/v1/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,11 @@ class Configuration
*/
protected string $host = 'https://api.pipedrive.com/v1';
/**
* User agent of the HTTP request, set to "Pipedrive-SDK-PHP-15.x" by default
* User agent of the HTTP request, set to "Pipedrive-SDK-PHP-14.x" by default
*
* @var string
*/
protected string $userAgent = 'Pipedrive-SDK-PHP-15.x';
protected string $userAgent = 'Pipedrive-SDK-PHP-14.x';

/**
* Debug switch (default set to false)
Expand Down
16 changes: 8 additions & 8 deletions lib/versions/v2/Api/DealsApi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1333,7 +1333,7 @@ public function addManyDealProductsRequest($id, $create_many_deal_product_reques
/**
* Operation convertDealToLead
*
* Convert a deal to a lead (BETA)
* Convert a deal to a lead
*
* @param int $id The ID of the deal to convert (required)
*
Expand All @@ -1350,7 +1350,7 @@ public function convertDealToLead($id)
/**
* Operation convertDealToLeadWithHttpInfo
*
* Convert a deal to a lead (BETA)
* Convert a deal to a lead
*
* @param int $id The ID of the deal to convert (required)
*
Expand Down Expand Up @@ -1472,7 +1472,7 @@ public function convertDealToLeadWithHttpInfo($id)
/**
* Operation convertDealToLeadAsync
*
* Convert a deal to a lead (BETA)
* Convert a deal to a lead
*
* @param int $id The ID of the deal to convert (required)
*
Expand All @@ -1492,7 +1492,7 @@ function ($response) {
/**
* Operation convertDealToLeadAsyncWithHttpInfo
*
* Convert a deal to a lead (BETA)
* Convert a deal to a lead
*
* @param int $id The ID of the deal to convert (required)
*
Expand Down Expand Up @@ -4621,7 +4621,7 @@ public function getDealRequest($id, $include_fields = null, $custom_fields = nul
/**
* Operation getDealConversionStatus
*
* Get Deal conversion status (BETA)
* Get Deal conversion status
*
* @param int $id The ID of a deal (required)
* @param string $conversion_id The ID of the conversion (required)
Expand All @@ -4638,7 +4638,7 @@ public function getDealConversionStatus($id, $conversion_id)
/**
* Operation getDealConversionStatusWithHttpInfo
*
* Get Deal conversion status (BETA)
* Get Deal conversion status
*
* @param int $id The ID of a deal (required)
* @param string $conversion_id The ID of the conversion (required)
Expand Down Expand Up @@ -4700,7 +4700,7 @@ public function getDealConversionStatusWithHttpInfo($id, $conversion_id)
/**
* Operation getDealConversionStatusAsync
*
* Get Deal conversion status (BETA)
* Get Deal conversion status
*
* @param int $id The ID of a deal (required)
* @param string $conversion_id The ID of the conversion (required)
Expand All @@ -4721,7 +4721,7 @@ function ($response) {
/**
* Operation getDealConversionStatusAsyncWithHttpInfo
*
* Get Deal conversion status (BETA)
* Get Deal conversion status
*
* @param int $id The ID of a deal (required)
* @param string $conversion_id The ID of the conversion (required)
Expand Down
16 changes: 8 additions & 8 deletions lib/versions/v2/Api/LeadsApi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ public function getConfig(): Configuration
/**
* Operation convertLeadToDeal
*
* Convert a lead to a deal (BETA)
* Convert a lead to a deal
*
* @param string $id The ID of the lead to convert (required)
* @param \Pipedrive\versions\v2\Model\InlineObject|null $inline_object inline_object (optional)
Expand All @@ -143,7 +143,7 @@ public function convertLeadToDeal($id, $inline_object = null)
/**
* Operation convertLeadToDealWithHttpInfo
*
* Convert a lead to a deal (BETA)
* Convert a lead to a deal
*
* @param string $id The ID of the lead to convert (required)
* @param \Pipedrive\versions\v2\Model\InlineObject|null $inline_object (optional)
Expand Down Expand Up @@ -266,7 +266,7 @@ public function convertLeadToDealWithHttpInfo($id, $inline_object = null)
/**
* Operation convertLeadToDealAsync
*
* Convert a lead to a deal (BETA)
* Convert a lead to a deal
*
* @param string $id The ID of the lead to convert (required)
* @param \Pipedrive\versions\v2\Model\InlineObject|null $inline_object (optional)
Expand All @@ -287,7 +287,7 @@ function ($response) {
/**
* Operation convertLeadToDealAsyncWithHttpInfo
*
* Convert a lead to a deal (BETA)
* Convert a lead to a deal
*
* @param string $id The ID of the lead to convert (required)
* @param \Pipedrive\versions\v2\Model\InlineObject|null $inline_object (optional)
Expand Down Expand Up @@ -453,7 +453,7 @@ public function convertLeadToDealRequest($id, $inline_object = null): Request
/**
* Operation getLeadConversionStatus
*
* Get Lead conversion status (BETA)
* Get Lead conversion status
*
* @param string $id The ID of a lead (required)
* @param string $conversion_id The ID of the conversion (required)
Expand All @@ -470,7 +470,7 @@ public function getLeadConversionStatus($id, $conversion_id)
/**
* Operation getLeadConversionStatusWithHttpInfo
*
* Get Lead conversion status (BETA)
* Get Lead conversion status
*
* @param string $id The ID of a lead (required)
* @param string $conversion_id The ID of the conversion (required)
Expand Down Expand Up @@ -532,7 +532,7 @@ public function getLeadConversionStatusWithHttpInfo($id, $conversion_id)
/**
* Operation getLeadConversionStatusAsync
*
* Get Lead conversion status (BETA)
* Get Lead conversion status
*
* @param string $id The ID of a lead (required)
* @param string $conversion_id The ID of the conversion (required)
Expand All @@ -553,7 +553,7 @@ function ($response) {
/**
* Operation getLeadConversionStatusAsyncWithHttpInfo
*
* Get Lead conversion status (BETA)
* Get Lead conversion status
*
* @param string $id The ID of a lead (required)
* @param string $conversion_id The ID of the conversion (required)
Expand Down
4 changes: 2 additions & 2 deletions lib/versions/v2/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,11 @@ class Configuration
*/
protected string $host = 'https://api.pipedrive.com/api/v2';
/**
* User agent of the HTTP request, set to "Pipedrive-SDK-PHP-15.x" by default
* User agent of the HTTP request, set to "Pipedrive-SDK-PHP-14.x" by default
*
* @var string
*/
protected string $userAgent = 'Pipedrive-SDK-PHP-15.x';
protected string $userAgent = 'Pipedrive-SDK-PHP-14.x';

/**
* Debug switch (default set to false)
Expand Down