docs(release): 1.0.0 (#42)

Author: mikeymike

CHANGELOG.md

@@ -8,6 +8,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 Check our main [developer changelog](https://developer.paddle.com/?utm_source=dx&utm_medium=paddle-php-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.
 
+## [1.0.0] - 2024-02-20
+
+### Changed
+
+- Migrated away from native enums to reduce the risk of breaking changes
+- Made entities consistent with `array<Entity>` usage where Collections were used instead
+- Notification classes are split from main API classes to allow for long term backwards compatability
+- Subscription item `price` re-uses the `Price` entity
+- Dropped `@internal` on most entities to prevent IDE warnings, utilising private constructors instead
+- Events now utilise their type specific classes
+
+### Added
+
+- Update resume subscription `effective_from` field to accept RFC 3339 datetime or `immediately`
+- Subscription notifications support newly added price object fields
+
 ## [0.3.0] - 2024-02-13
 
 ### Added

README.md

@@ -31,12 +31,6 @@ To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/01-ba
 require_once 'vendor/autoload.php';
 ```
 
-## Before you begin
-
-If you've used this SDK, we'd love to hear how you found it! Email us at [[email protected]](mailto:[email protected]) with any thoughts.
-
-While in early access, we may introduce breaking changes. Where we can, we'll tag breaking changes and communicate ahead of time.
-
 ## Usage
 
 To authenticate, you'll need an API key. You can create and manage API keys in **Paddle > Developer tools > Authentication**.

UPGRADING.md

@@ -2,6 +2,41 @@
 
 All breaking changes prior to v1 will be documented in this file to assist with upgrading. 
 
+## 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())`
+
+2. 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>`
+
+3. 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.
+
+4. 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. 
@@ -55,7 +90,7 @@ Any typing of the following classes should be updated accordingly:
 
 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`
+- 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.
 

src/Client.php

@@ -51,7 +51,7 @@
 
 class Client
 {
-    private const SDK_VERSION = '0.3.0';
+    private const SDK_VERSION = '1.0.0';
 
     public readonly LoggerInterface $logger;
     public readonly Options $options;