Skip to content
Open
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ 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]
### Fixed
- Fixed incorrect type definitions for `label` fields in v2 Persons API request schema (`PersonRequestBody`). The `label` field for both `phones` and `emails` arrays was incorrectly typed as `boolean` instead of `string`, causing SDK type generation issues. Labels now correctly accept string values like 'work', 'home', 'mobile', and 'other'.
### Removed
- Removed deprecated bulk delete endpoints:
- `DELETE /v1/activities`
Expand Down
8 changes: 4 additions & 4 deletions docs/versions/v2/Api/DealsApi.md
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
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
4 changes: 2 additions & 2 deletions docs/versions/v2/Model/PersonRequestBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Name | Type | Description | Notes
**org_id** | **int** | The ID of the organization linked to the person | [optional]
**add_time** | **string** | The creation date and time of the person | [optional]
**update_time** | **string** | The last updated date and time of the person | [optional]
**emails** | [**\Pipedrive\versions\v2\Model\PersonRequestBodyEmails[]**](PersonRequestBodyEmails.md) | The emails of the person | [optional]
**phones** | [**\Pipedrive\versions\v2\Model\PersonRequestBodyPhones[]**](PersonRequestBodyPhones.md) | The phones of the person | [optional]
**emails** | [**\Pipedrive\versions\v2\Model\PersonItemEmails[]**](PersonItemEmails.md) | The emails of the person | [optional]
**phones** | [**\Pipedrive\versions\v2\Model\PersonItemPhones[]**](PersonItemPhones.md) | The phones of the person | [optional]
**visible_to** | **int** | The visibility of the person | [optional]
**label_ids** | **int[]** | The IDs of labels assigned to the person | [optional]
**marketing_status** | **string** | If the person does not have a valid email address, then the marketing status is **not set** and &#x60;no_consent&#x60; is returned for the &#x60;marketing_status&#x60; value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.&lt;table&gt;&lt;tr&gt;&lt;th&gt;Value&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;no_consent&#x60;&lt;/td&gt;&lt;td&gt;The customer has not given consent to receive any marketing communications&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;unsubscribed&#x60;&lt;/td&gt;&lt;td&gt;The customers have unsubscribed from ALL marketing communications&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;subscribed&#x60;&lt;/td&gt;&lt;td&gt;The customers are subscribed and are counted towards marketing caps&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&#x60;archived&#x60;&lt;/td&gt;&lt;td&gt;The customers with &#x60;subscribed&#x60; status can be moved to &#x60;archived&#x60; to save consent, but they are not paid for&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt; | [optional]
Expand Down
22 changes: 4 additions & 18 deletions docs/versions/v2/README.md
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 Expand Up @@ -579,8 +567,6 @@ Class | Method | HTTP request | Description
- [PersonPictureItemPictures](Model/PersonPictureItemPictures.md)
- [PersonPictureResponse](Model/PersonPictureResponse.md)
- [PersonRequestBody](Model/PersonRequestBody.md)
- [PersonRequestBodyEmails](Model/PersonRequestBodyEmails.md)
- [PersonRequestBodyPhones](Model/PersonRequestBodyPhones.md)
- [PersonSearchItem](Model/PersonSearchItem.md)
- [PersonSearchItemItem](Model/PersonSearchItemItem.md)
- [PersonSearchItemItemOrganization](Model/PersonSearchItemItemOrganization.md)
Expand Down
4 changes: 2 additions & 2 deletions lib/versions/v1/Configuration.php
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
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
Loading