Merge pull request #103 from erincdustin/6.0.0

6.0.0

CHANGELOG.md

@@ -5,6 +5,10 @@ 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).
 
+# [6.0.0] - 2024-03-05
+- Bring SDK up to date with API [v1.0.324](https://ordercloud.io/release-notes/v1.0.324) 
+- This version includes a breaking change where forgotten passwords and forgotten usernames have been consolidated under ForgottenCredentials
+
 # [5.3.0] - 2024-02-08
 - Bring SDK up to date with API [v1.0.320](https://ordercloud.io/release-notes/v1.0.320) which adds IsOnSale to line items as well as a new error config endpoint
 - Adds a new method for retrieving an identity token used by the Discover 2 proxy. More details in our [product sync documentation](https://ordercloud.io/knowledge-base/productsync)

codegen/templates/models/MessageSenderForgottenUsernamePayload.ts

@@ -0,0 +1,9 @@
+import { MessageSenderPayload } from './MessageSenderPayload'
+
+export type MessageSenderForgottenUsernamePayload<
+  TConfigData = any
+> = MessageSenderPayload<TConfigData, MessageSenderForgottenUsernameEventBody>
+
+export interface MessageSenderForgottenUsernameEventBody {
+  Username?: string
+}

codegen/templates/models/MessageSenderPayloads.ts

@@ -1,4 +1,5 @@
 import { MessageSenderForgottenPasswordPayload } from './MessageSenderForgottenPasswordPayload'
+import { MessageSenderForgottenUsernamePayload } from './MessageSenderForgottenUsernamePayload'
 import { MessageType } from './MessageType'
 import { MessageSenderNewUserInvitationPayload } from './MessageSenderNewUserInvitationPayload'
 import { MessageSenderOrderApprovedPayload } from './MessageSenderOrderApprovedPayload'
@@ -28,6 +29,7 @@ export type MessageSenderPayloads<
 interface PayloadMap {
   'NewUserInvitation': MessageSenderNewUserInvitationPayload
   'ForgottenPassword': MessageSenderForgottenPasswordPayload
+  'ForgottenUsername': MessageSenderForgottenUsernamePayload
   'OrderSubmitted': MessageSenderOrderSubmittedPayload
   'OrderSubmittedForApproval': MessageSenderOrderSubmittedForApprovalPayload
   'OrderApproved': MessageSenderOrderApprovedPayload

docs/classes/Resources.Cart.html

@@ -1011,7 +1011,7 @@ <h3 class="tsd-anchor-link"><span>Validate</span><a href="#Validate" aria-label=
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="Validate.Validate-1">Validate<span class="tsd-signature-symbol">(</span>requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#Validate.Validate-1" 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></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Validate a cart validate. 
+<div class="tsd-comment tsd-typography"><p>Validate the cart in it&#39;s current state. 
 Check out the <a href="https://ordercloud.io/api-reference/orders-and-fulfillment/cart/validate%7Capi">docs</a> for more info</p>
 </div>
 <div class="tsd-parameters">

docs/classes/Resources.Me.html

@@ -1087,7 +1087,7 @@ <h3 class="tsd-anchor-link"><span>List<wbr/>Buyer<wbr/>Sellers</span><a href="#L
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="ListBuyerSellers.ListBuyerSellers-1">List<wbr/>Buyer<wbr/>Sellers<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TBuyerSupplier</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>listOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>filters<span class="tsd-signature-symbol">?: </span><a href="../types/Filters.html" class="tsd-signature-type" data-tsd-kind="Type alias">Filters</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>page<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>search<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>searchOn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">&quot;ID&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Name&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>sortBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">&quot;ID&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Name&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;!ID&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;!Name&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Resources.RequiredObjectDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredObjectDeep</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ListPage.html" class="tsd-signature-type" data-tsd-kind="Interface">ListPage</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TBuyerSupplier</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#ListBuyerSellers.ListBuyerSellers-1" 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></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Get a list of buyer sellers visible to this user. Organizations you can place orders directly to.
+<div class="tsd-comment tsd-typography"><p>Get a list of sellers this user can purchase from. Organizations you can place orders directly to.
 Check out the <a href="https://ordercloud.io/api-reference/me-and-my-stuff/me/list-buyer-sellers%7Capi">docs</a> for more info</p>
 </div>
 <section class="tsd-panel tsd-type-parameters">
@@ -2434,7 +2434,7 @@ <h3 class="tsd-anchor-link"><span>Register</span><a href="#Register" aria-label=
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="Register.Register-1">Register<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TAccessTokenBasic</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>meUser<span class="tsd-signature-symbol">: </span><a href="../interfaces/MeUser.html" class="tsd-signature-type" data-tsd-kind="Interface">MeUser</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span>, listOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>anonUserToken<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RequiredDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredDeep</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TAccessTokenBasic</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#Register.Register-1" 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></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Register a register. 
+<div class="tsd-comment tsd-typography"><p>Register a User. 
 Check out the <a href="https://ordercloud.io/api-reference/me-and-my-stuff/me/register%7Capi">docs</a> for more info</p>
 </div>
 <section class="tsd-panel tsd-type-parameters">

docs/classes/Resources.OrderReturns.html

@@ -492,7 +492,7 @@ <h3 class="tsd-anchor-link"><span>Submit</span><a href="#Submit" aria-label="Per
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="Submit.Submit-1">Submit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TOrderReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>returnID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RequiredDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredDeep</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TOrderReturn</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#Submit.Submit-1" 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></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Submit an order return submit. 
+<div class="tsd-comment tsd-typography"><p>Submit an order return. 
 Check out the <a href="https://ordercloud.io/api-reference/orders-and-fulfillment/order-returns/submit%7Capi">docs</a> for more info</p>
 </div>
 <section class="tsd-panel tsd-type-parameters">

docs/classes/Resources.Orders.html

@@ -1048,7 +1048,7 @@ <h3 class="tsd-anchor-link"><span>Submit</span><a href="#Submit" aria-label="Per
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="Submit.Submit-1">Submit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TOrder</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>direction<span class="tsd-signature-symbol">: </span><a href="../types/OrderDirection.html" class="tsd-signature-type" data-tsd-kind="Type alias">OrderDirection</a>, orderID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RequiredDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredDeep</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TOrder</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#Submit.Submit-1" 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></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Submit an order submit. 
+<div class="tsd-comment tsd-typography"><p>Submit an order. 
 Check out the <a href="https://ordercloud.io/api-reference/orders-and-fulfillment/orders/submit%7Capi">docs</a> for more info</p>
 </div>
 <section class="tsd-panel tsd-type-parameters">

docs/classes/Resources.Products.html

@@ -165,7 +165,7 @@ <h3 class="tsd-anchor-link"><span>Generate<wbr/>Variants</span><a href="#Generat
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
 <li class="tsd-signature tsd-anchor-link" id="GenerateVariants.GenerateVariants-1">Generate<wbr/>Variants<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProduct</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>productID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>overwriteExisting<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RequiredDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredDeep</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProduct</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#GenerateVariants.GenerateVariants-1" 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></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Generate a variants. 
+<div class="tsd-comment tsd-typography"><p>Generate variants. 
 Check out the <a href="https://ordercloud.io/api-reference/product-catalogs/products/generate-variants%7Capi">docs</a> for more info</p>
 </div>
 <section class="tsd-panel tsd-type-parameters">

docs/index.html

@@ -250,7 +250,7 @@ <h3 class="tsd-index-heading">Variables</h3>
 <a href="variables/CreditCards.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Credit<wbr/>Cards</span></a>
 <a href="variables/DeliveryConfigurations.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Delivery<wbr/>Configurations</span></a>
 <a href="variables/ErrorConfigs.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Error<wbr/>Configs</span></a>
-<a href="variables/ForgottenPassword.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Forgotten<wbr/>Password</span></a>
+<a href="variables/ForgottenCredentials.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Forgotten<wbr/>Credentials</span></a>
 <a href="variables/ImpersonationConfigs.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Impersonation<wbr/>Configs</span></a>
 <a href="variables/Incrementors.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Incrementors</span></a>
 <a href="variables/IntegrationEvents.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Integration<wbr/>Events</span></a>