Skip to content

Latest commit

 

History

History
125 lines (81 loc) · 7.87 KB

UPGRADING.md

File metadata and controls

125 lines (81 loc) · 7.87 KB
Raw

Upgrading

All breaking changes will be documented in this file to assist with upgrading.

v1.2.0

Upgrading to this version introduces 2 changes that may require action

  1. \Paddle\SDK\Entities\Shared\TransactionPaymentAttempt field paymentMethodId was string only, but has been aligned with the API to be string or null.

  2. \Paddle\SDK\Resources\PricingPreviews\Operations field items has been aligned with the API and can no longer be empty.

v1.0.0

Upgrading to this version introduces 4 changes that may require action

  1. Migrated away from native enums to reduce the risk of breaking changes

If your implementation utilises any of the Enums defined in the Paddle SDK you will have to update their usage.

For example: Status::Active => Status::Active() $status === Status::Active => $status->equals(Status::Active())

  1. Made entities consistent with array<Entity> usage where Collections were used instead

There was some inconsistent typing for Entities that had properties consisting of a collection of another Entity. These fields shouldn't impact usage of those properties but if you relied on any of the following types you will face breakages.

  • \Paddle\SDK\Entities\NotificationSetting field subscribedEvents was EventTypeCollection and is now array<EventType>
  • \Paddle\SDK\Entities\Product field prices was PriceCollection and is now array<Price>
  1. Subscription item price re-uses the Price entity

The \Paddle\SDK\Entities\Subscription\SubscriptionItem price field type has changed to the main entity \Paddle\SDK\Entities\Price.

Any previous type hints for \Paddle\SDK\Entities\Subscription\SubscriptionPrice should be updated accordingly.

  1. Dropped @internal on most entities to prevent IDE warnings, utilising private constructors instead

In the last major update we made change we introduced @internal doc blocks for entities which were hydrated from API responses.

We noticed these started to highlight properties using constructor property promotion being highlighted as internal which wasn't the intention.

We've dropped the @internal doc block and been stricter with private constructors. If you had relied on instantiating these entities directly you may face breakages. This was not intentionally part of the public API for the package and thus has been restricted moving forward.

v0.3.0

This version introduces several breaking changes.

  • Renamed classes to align with naming conventions

AdjustmentsAdjustmentCollection => AdjustmentCollection TotalAdjustments => AdjustmentTotals StatusAdjustment => AdjustmentStatus StatusTransaction => TransactionStatus StatusPaymentAttempt => PaymentAttemptStatus

Any usages of the previous class names should be refactored accordingly to avoid a class not found error.

  • Refactored out duplicate entities where both <Entity> and <Entity>WithIncludes existed

Any typing on the following classes should be updated accordingly:

\Paddle\SDK\Entities\CustomerWithIncludes => \Paddle\SDK\Entities\Customer \Paddle\SDK\Entities\PriceWithIncludes => \Paddle\SDK\Entities\Price \Paddle\SDK\Entities\ProductWithIncludes => \Paddle\SDK\Entities\Product \Paddle\SDK\Entities\SubscriptionWithIncludes => \Paddle\SDK\Entities\Subscription \Paddle\SDK\Entities\TransactionWithIncludes => \Paddle\SDK\Entities\Transaction \Paddle\SDK\Entities\TransactionWithIncludes => \Paddle\SDK\Entities\Transaction \Paddle\SDK\Entities\Collections\CustomerIncludesCollection => \Paddle\SDK\Entities\Collections\CustomerCollection \Paddle\SDK\Entities\Collections\PriceWithIncludesCollection => \Paddle\SDK\Entities\Collections\PriceCollection \Paddle\SDK\Entities\Collections\ProductWithIncludesCollection => \Paddle\SDK\Entities\Collections\ProductCollection \Paddle\SDK\Entities\Collections\SubscriptionWithIncludesCollection => \Paddle\SDK\Entities\Collections\SubscriptionCollection \Paddle\SDK\Entities\Collections\TransactionWithIncludesCollection => \Paddle\SDK\Entities\Collections\TransactionCollection

  • Report entity objects were renamed for better consistency with the SDK and prevent confusion.

Any typing on the following classes should be updated accordingly:

\Paddle\SDK\Entities\Report\ReportFilters => \Paddle\SDK\Entities\Report\ReportFilter \Paddle\SDK\Entities\Report\ReportName => \Paddle\SDK\Entities\Report\ReportFilterName \Paddle\SDK\Entities\Report\ReportOperator => \Paddle\SDK\Entities\Report\ReportFilterOperator

  • Adjustment and Subscription Preview Adjustment objects were refactored for consistency

Any typing of the following classes should be updated accordingly:

\Paddle\SDK\Entities\Adjustment\AdjustmentItemTotals => \Paddle\SDK\Entities\Adjustment\AdjustmentItem \Paddle\SDK\Entities\Adjustment\AdjustmentProration => \Paddle\SDK\Entities\Shared\AdjustmentProration \Paddle\SDK\Entities\Adjustment\AdjustmentTimePeriod => \Paddle\SDK\Entities\Shared\AdjustmentTimePeriod \Paddle\SDK\Entities\Adjustment\AdjustmentType => \Paddle\SDK\Entities\Shared\AdjustmentType \Paddle\SDK\Entities\Subscription\SubscriptionProration => \Paddle\SDK\Entities\Shared\AdjustmentProration \Paddle\SDK\Entities\Transaction\TransactionAdjustment => Paddle\SDK\Entities\Adjustment

  • Conflicting request object AdjustmentItem has moved into the Operations namespace

The type has changed when creating an Adjustment using the CreateAdjustment operation. To create an Adjustment you must now use the \Paddle\SDK\Resources\Adjustments\Operations\Create\AdjustmentItem instance for items.

  • Core entities (classes implementing Entity) are marked @internal and constructors are protected

Any direct usage of these classes is not supported functionality by the SDK and has been removed to reduce the surface area for breaking changes.

v0.2.0

This version includes a breaking change to the naming of operations. Prior to this version operations were commonly named <type>Operation, e.g. CreateOperation which posed problems when using more than one resource such as when creating a product and price. The new naming convention includes the resource to prevent the need of aliasing in these circumstances. e.g. CreatePrice and CreateProduct.

To upgrade to 0.2.0 from any earlier version you will need to refactor your use of operations to use the new names. These follow a common pattern that can be seen below:

Paddle\SDK\Resources\Prices\Operations\CreateOperation => Paddle\SDK\Resources\Prices\Operations\CreatePrice Paddle\SDK\Resources\Prices\Operations\UpdateOperation => Paddle\SDK\Resources\Prices\Operations\UpdatePrice Paddle\SDK\Resources\Prices\Operations\ListOperation => Paddle\SDK\Resources\Prices\Operations\ListPrices

There are also some operations that are unique, these are detailed below:

Paddle\SDK\Resources\PricingPreviews\Operations\PreviewPricesOperation => Paddle\SDK\Resources\PricingPreviews\Operations\PreviewPrice \Paddle\SDK\Resources\Transactions\Operations\PreviewOperation => \Paddle\SDK\Resources\Transactions\Operations\PreviewTransaction \Paddle\SDK\Resources\Subscriptions\Operations\CancelOperation => \Paddle\SDK\Resources\Subscriptions\Operations\CancelSubscription \Paddle\SDK\Resources\Subscriptions\Operations\CreateOneTimeChargeOperation => \Paddle\SDK\Resources\Subscriptions\Operations\CreateOneTimeCharge \Paddle\SDK\Resources\Subscriptions\Operations\PauseOperation => \Paddle\SDK\Resources\Subscriptions\Operations\PauseSubscription \Paddle\SDK\Resources\Subscriptions\Operations\PreviewOneTimeChargeOperation => \Paddle\SDK\Resources\Subscriptions\Operations\PreviewOneTimeCharge \Paddle\SDK\Resources\Subscriptions\Operations\PreviewUpdateOperation => \Paddle\SDK\Resources\Subscriptions\Operations\PreviewUpdateSubscription \Paddle\SDK\Resources\Subscriptions\Operations\ResumeOperation => \Paddle\SDK\Resources\Subscriptions\Operations\ResumeSubscription