You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MIGRATION_GUIDE.md
+36Lines changed: 36 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,42 @@
2
2
3
3
The objective of this guide is to document the breaking changes and updates required to migrate from one major version to the next.
4
4
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
* The return type for the `Cart.ListEligiblePromotions` and `Orders.ListEligiblePromotions` methods have been updated from `OrderPromotion` to `EligiblePromotion`
<li>Defined in <ahref="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/DeliveryTargets.ts#L15">models/DeliveryTargets.ts:15</a></li></ul></aside></section>
<li>Defined in <ahref="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/DeliveryTargets.ts#L24">models/DeliveryTargets.ts:24</a></li></ul></aside></section>
0 commit comments