Skip to content

12.0.0 #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erincdustin merged 3 commits into from
Mar 10, 2026
Merged

12.0.0 #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
238dd23
⏩ regen to API 1.0.437
erincdustin Mar 10, 2026
8a173bf
✏️ update changelog and migration guide
erincdustin Mar 10, 2026
7b4ae68
🔖 12.0.0
erincdustin Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

# [12.0.0] - 2026-03-10
- Bring SDK up to date with API v1.0.437. Includes a breaking change to Message Senders - see migration guide for more details.

# [11.1.5] - 2026-03-02
- Bring SDK up to date with API v1.0.436

Expand Down
36 changes: 36 additions & 0 deletions MIGRATION_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,42 @@

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

## version 11.x.x to version 12.x.x
* 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.

> Note: All existing Message Senders were migrated automatically

Before:
```typescript
const messageSender: MessageSender = {
Name: 'My Sender',
MessageTypes: ['OrderSubmitted'],
URL: 'https://my-endpoint.com',
SharedKey: 'my-secret-key',
}
```

After:
```typescript
// First, create a DeliveryConfig with the equivalent configuration
const deliveryConfig = await DeliveryConfigurations.Create({
Name: 'My Delivery Config',
DeliveryTargets: {
MessageSender: {
Endpoint: 'https://my-endpoint.com',
Secret: 'my-secret-key',
}
}
})

// Then reference it on the MessageSender
const messageSender: MessageSender = {
Name: 'My Sender',
MessageTypes: ['OrderSubmitted'],
DeliveryConfigID: deliveryConfig.ID,
}
```

## version 10.x.x to version 11.x.x
* The return type for the `Cart.ListEligiblePromotions` and `Orders.ListEligiblePromotions` methods have been updated from `OrderPromotion` to `EligiblePromotion`

Expand Down
2 changes: 1 addition & 1 deletion docs/assets/search.js
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/classes/Resources.MessageSenders.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h3 class="tsd-index-heading">Interfaces</h3>
<a href="interfaces/ListPageWithFacets.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>List<wbr/>Page<wbr/>With<wbr/>Facets</span></a>
<a href="interfaces/Locale.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Locale</span></a>
<a href="interfaces/LocaleAssignment.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Locale<wbr/>Assignment</span></a>
<a href="interfaces/MandrillConfig.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Mandrill<wbr/>Config</span></a>
<a href="interfaces/MailchimpConfig.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Mailchimp<wbr/>Config</span></a>
<a href="interfaces/MeBuyer.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Me<wbr/>Buyer</span></a>
<a href="interfaces/MeSeller.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Me<wbr/>Seller</span></a>
<a href="interfaces/MeSupplier.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Me<wbr/>Supplier</span></a>
Expand Down
10 changes: 5 additions & 5 deletions docs/interfaces/DeliveryTargets.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h3 class="tsd-index-heading">Properties</h3>
<a href="DeliveryTargets.html#EventHub" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Event<wbr/>Hub?</span></a>
<a href="DeliveryTargets.html#Http" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Http?</span></a>
<a href="DeliveryTargets.html#Kafka" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Kafka?</span></a>
<a href="DeliveryTargets.html#Mandrill" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Mandrill?</span></a>
<a href="DeliveryTargets.html#Mailchimp" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Mailchimp?</span></a>
<a href="DeliveryTargets.html#MessageSender" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Message<wbr/>Sender?</span></a>
<a href="DeliveryTargets.html#SearchIngestion" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Search<wbr/>Ingestion?</span></a>
<a href="DeliveryTargets.html#SendEvent" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Send<wbr/>Event?</span></a>
Expand Down Expand Up @@ -83,9 +83,9 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
<div class="tsd-signature">Kafka<span class="tsd-signature-symbol">?:</span> <a href="KafkaConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">KafkaConfig</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/DeliveryTargets.ts#L15">models/DeliveryTargets.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Mandrill" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Mandrill</span><a href="#Mandrill" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Mandrill<span class="tsd-signature-symbol">?:</span> <a href="MandrillConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">MandrillConfig</a></div><aside class="tsd-sources">
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Mailchimp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Mailchimp</span><a href="#Mailchimp" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Mailchimp<span class="tsd-signature-symbol">?:</span> <a href="MailchimpConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">MailchimpConfig</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/DeliveryTargets.ts#L24">models/DeliveryTargets.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="MessageSender" class="tsd-anchor"></a>
Expand Down Expand Up @@ -136,7 +136,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#EventHub" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Event<wbr/>Hub?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#Http" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Http?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#Kafka" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Kafka?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#Mandrill" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Mandrill?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#Mailchimp" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Mailchimp?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#MessageSender" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Message<wbr/>Sender?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#SearchIngestion" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Search<wbr/>Ingestion?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DeliveryTargets.html#SendEvent" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Send<wbr/>Event?</a></li></ul></li></ul></nav></div></div>
Expand Down
Loading