v6.7.0

What's Changed

Added

• Added documentation for new endpoints /deals/{id}/changelog, /persons/{id}/changelog and /organizations/{id}/changelog.
• Added is_deleted parameter for /v1/users/* responses.
• Added billing_frequency, billing_frequency_cycles and billing_start_date fields to
  • GET, POST and PUT /v1/deals/{id}/products endpoints
  • GET, POST and PATCH /v2/deals/{id}/products endpoints
  • GET /v2/deals/products endpoint
• Added billing_frequency, billing_frequency_cycles fields to
  • GET, POST and PUT /v1/products endpoints
  • GET /v1/products/{id} endpoint
  • GET, POST and PATCH /v2/products endpoints
  • GET /v2/products/{id} endpoints
• Added RawData trait to models to allow access to all response data objects
  • useful for getting access to custom fields that are not available in openapi generated SDK models

    $apiInstance = new DealsApi(...);
    $result = $apiInstance->getDeals(42);
    
    $rawData = $result->getRawData();
    

    See tests for examples.

Community updates 1

This release applies PRs open by the community, to fix and improve the SDK.

What's Changed

• Fixes Array to string conversion error for ProductField option attribute by @jr-k in #24
• Use ReturnTypeWillChange attribute for PHP8.1 comp by @poethrenoff in #60
• Ignore dev/testing files for distribution builds by @pH-7 in #66
• Add pipeline_id into deals summary API by @MgHtinLynn in #81

New Contributors

• @jr-k made their first contribution in #24
• @poethrenoff made their first contribution in #60
• @pH-7 made their first contribution in #66
• @MgHtinLynn made their first contribution in #81

Full Changelog: 4.0.5...4.0.10

Updated add/update deal product methods

• Added shortened aliased addAProductToADeal, and updateTheProductAttachedToADeal for the add/update deal product methods
• Added the required parameter productId to the updateTheProductAttachedToADeal method
• Updated README documentation for these methods

adding/updating activity should support busyFlag

adding/updating activity should support busyFlag optional attribute.

Get all person fields with pagination and small bug fix

• The method getAllPersonFields now supports optional pagination parameters.
• The class CamelCaseHelper was fixed to not break on non-iterable values, such as null.

Deals and Products with custom fields and a small fix

• The methods addAProduct and updateAProduct now return all Product fields in the response, including custom fields.
• From deals, getAllDeals and getDetailsOfADeal will return the raw response as it comes from the API itself, so custom fields are also included.
  • Notice that this is a breaking change, as certain 0/1 integer values coming from the API (eg.: has_pic) were cast to boolean before, but they won't be cast anymore.
• The getDealsTimeline method was fixed, now it returns an array of results as expected.

Person, Deal and Organization update methods accept all input keys (including custom fields)

Updated updateAPerson, updateADeal and updateAnOrganization methods to accept all input keys (including custom fields)

Support for call logs added

Call logs endpoints added to the SDK

Consistent casing of response keys

Every response now goes through CamelCaseHelper::keysToCamelCase() function because relying on only the model mapper caused inconsistencies (if the model contained a property that is defined just as an object, not a specific model then the keys of this object were not camel-cased).

Also, if json_encode() is run over the response then everything is now consistently snake_cased (as in the raw response)

Removal of deprecated search endpoints

The following endpoints are deprecated in the Pipedrive API and will stop working soon, so we are removing them from the SDK. This is a breaking change if you use one of the following:

/deals/find
Used in DealsController.findDealsByName()

/persons/find
Used in PersonsController.findPersonsByName()

/organizations/find
Used in OrganizationsController.findOrganizationsByName()

/products/find
Used in ProductsController.findProductsByName()

/searchResults and /searchResults/field
From SearchResultsController.getPerformASearch() and SearchResultsController. getPerformASearchUsingASpecificFieldValue() respectively, The SearchResultsController file is no longer available.