Skip to content

Commit 8a173bf

Browse files
committed
✏️ update changelog and migration guide
1 parent 238dd23 commit 8a173bf

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
# [12.0.0] - 2026-03-10
9+
- Bring SDK up to date with API v1.0.437. Includes a breaking change to Message Senders - see migration guide for more details.
10+
811
# [11.1.5] - 2026-03-02
912
- Bring SDK up to date with API v1.0.436
1013

MIGRATION_GUIDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,42 @@
22

33
The objective of this guide is to document the breaking changes and updates required to migrate from one major version to the next.
44

5+
## version 11.x.x to version 12.x.x
6+
* The `URL` and `SharedKey` properties have been removed from the `MessageSender` model, and `DeliveryConfigID` is now required. Configuration must be provided via a `DeliveryConfig` (managed through the new `DeliveryConfigurations` service) using either a `MailchimpConfig` or `MessageSenderConfig` delivery target. See the [updated Message Senders KB article](https://ordercloud.io/knowledge-base/message-senders#configuration-options) for more details.
7+
8+
> Note: All existing Message Senders were migrated automatically
9+
10+
Before:
11+
```typescript
12+
const messageSender: MessageSender = {
13+
Name: 'My Sender',
14+
MessageTypes: ['OrderSubmitted'],
15+
URL: 'https://my-endpoint.com',
16+
SharedKey: 'my-secret-key',
17+
}
18+
```
19+
20+
After:
21+
```typescript
22+
// First, create a DeliveryConfig with the equivalent configuration
23+
const deliveryConfig = await DeliveryConfigurations.Create({
24+
Name: 'My Delivery Config',
25+
DeliveryTargets: {
26+
MessageSender: {
27+
Endpoint: 'https://my-endpoint.com',
28+
Secret: 'my-secret-key',
29+
}
30+
}
31+
})
32+
33+
// Then reference it on the MessageSender
34+
const messageSender: MessageSender = {
35+
Name: 'My Sender',
36+
MessageTypes: ['OrderSubmitted'],
37+
DeliveryConfigID: deliveryConfig.ID,
38+
}
39+
```
40+
541
## version 10.x.x to version 11.x.x
642
* The return type for the `Cart.ListEligiblePromotions` and `Orders.ListEligiblePromotions` methods have been updated from `OrderPromotion` to `EligiblePromotion`
743

0 commit comments

Comments
 (0)