Skip to content

Commit

Permalink
docs(release): Add v3.0.0 changelog and upgrade entries
Browse files Browse the repository at this point in the history
  • Loading branch information
mikeymike committed Dec 20, 2024
1 parent 71c2a9e commit 9c0d307
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
23 changes: 22 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,30 @@ 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-go-sdk) for information about changes to the Paddle Billing platform, the Paddle API, and other developer tools.

## 3.0.0 - 2024-12-20

### Fixed

- Limited bytes that can be read via the webhook verification middleware
- Handle nullable `SubscriptionDiscountTimePeriod` property `StartsAt` making it a pointer

### Added

- Support for new API errors
- Vietnamese Dong (VND) currency support, see related [changelog](https://developer.paddle.com/changelog/2024/vietnamese-dong-vnd-supported-currency)
- Simpler creation of full adjustments and a new `AdjustmentType` property, see related [changelog](https://developer.paddle.com/changelog/2024/refund-credit-full-total)
- Support for controlling how Paddle bills when resuming subscriptions with `SubscriptionOnResume`, see related [chagnelog](https://developer.paddle.com/changelog/2024/resume-subscription-billing-period-options)
- Support for non catalog items on Transaction Previews with pointer ID properties

### Changed

- Removed write only property `items` from PricePreview entity
- Removed unused DiscountStatus values `expired` and `used`
- Corrected URL acronym casing for `SubscriptionManagementURLs`

## 2.1.3 - 2024-11-06

## Fixed
### Fixed

- Corrected internal package version number
- Added missing changelog updates
Expand Down
24 changes: 24 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@

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

## v3.0.0

This release contains 4 commits introducing breaking changes. To summarise:

1. Rename `DiscountNotification` `Type` property to `DiscountType` to reduce the risk of conflicting type names as `type` is a common property name within the API.

Any existing references to the `Type` property on `DiscountNotification` will need to be updated to reference the property `DiscountType`

2. Support for non catalog items on Transaction Previews with pointer ID properties

- Non catalog items when in a transaction preview can produce a nullable ID, to support these the type are updated to be a pointer ID where applicable.
- We've introduced `ProductPreview` and `TransactionPricePreview` types to support these changes without impacting the core `Product` and `Price` types.
- Any type references for these will have to be updated accordingly and access of the ID properties will need to be dereferenced.

3. Fix acronym casing for `SubscriptionManagementUrLs`

Any existing references to the type `SubscriptionManagementUrLs` will need to be updated to `SubscriptionManagementURLs`.

4. Support nullable discount `starts_at` for subscriptions

- It's possibly for Paddle to return `starts_at` as `null` for Subscription discounts. With this being the case our types have been updated to pointers.
- `SubscriptionDiscountTimePeriod` within `paddle` and `paddlenotification` packages are effected
- The property `StartsAt` is now a pointer and will now need to be dereferenced

## v2.0.0

This release brings 2 breaking changes and fixes that may require some changes in your code to upgrade.
Expand Down

0 comments on commit 9c0d307

Please sign in to comment.