11.0.3

codegen/templates/models/MessageSenderOneTimePasswordPayload.ts

@@ -0,0 +1,11 @@
+import { MessageSenderPayload } from './MessageSenderPayload'
+
+export type MessageSenderOneTimePasswordPayload<
+  TConfigData = any
+> = MessageSenderPayload<TConfigData, MessageSenderOneTimePasswordEventBody>
+
+export interface MessageSenderOneTimePasswordEventBody {
+  Username?: string
+  ClientID?: string
+  OneTimePassword?: string
+}

codegen/templates/models/MessageSenderPayloads.ts

@@ -21,6 +21,7 @@ import { MessageSenderOrderReturnSubmittedForApprovalPayload } from './MessageSe
 import { MessageSenderSubscriptionReminderPayload } from './MessageSenderSubscriptionReminderPayload'
 import { MessageSenderProductCollectionInvitationAcceptedPayload } from './ProductCollectionInvitationAcceptedPayload'
 import { MessageSenderProductCollectionInvitationDeclinedPayload } from './ProductCollectionInvitationDeclinedPayload'
+import { MessageSenderOneTimePasswordPayload } from './MessageSenderOneTimePasswordPayload'
 
 export type MessageSenderPayloads<
   TMessageType extends MessageType
@@ -49,4 +50,5 @@ interface PayloadMap {
   'SubscriptionReminder': MessageSenderSubscriptionReminderPayload
   'ProductCollectionInvitationAccepted': MessageSenderProductCollectionInvitationAcceptedPayload
   'ProductCollectionInvitationDeclined': MessageSenderProductCollectionInvitationDeclinedPayload
+  'OneTimePassword': MessageSenderOneTimePasswordPayload
 }

docs/classes/Resources.ForgottenCredentials.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">ForgottenCredentials</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L9">api/ForgottenCredentials.ts:9</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L10">api/ForgottenCredentials.ts:10</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -36,6 +36,7 @@ <h3 class="tsd-index-heading">Methods</h3>
 <div class="tsd-index-list"><a href="Resources.ForgottenCredentials.html#As" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>As</span></a>
 <a href="Resources.ForgottenCredentials.html#ResetPasswordByVerificationCode" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>Reset<wbr/>Password<wbr/>By<wbr/>Verification<wbr/>Code</span></a>
 <a href="Resources.ForgottenCredentials.html#RetrieveUsername" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>Retrieve<wbr/>Username</span></a>
+<a href="Resources.ForgottenCredentials.html#SendOneTimePassword" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>Send<wbr/>One<wbr/>Time<wbr/>Password</span></a>
 <a href="Resources.ForgottenCredentials.html#SendVerificationCode" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>Send<wbr/>Verification<wbr/>Code</span></a>
 </div></section></div></details></section></section>
 <section class="tsd-panel-group tsd-member-group">
@@ -44,7 +45,7 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>impersonating</span><a href="#impersonating" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">impersonating<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L10">api/ForgottenCredentials.ts:10</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L11">api/ForgottenCredentials.ts:11</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="As" class="tsd-anchor"></a>
@@ -60,7 +61,7 @@ <h3>Example</h3><pre><code class="language-ts"><span class="hl-0">ForgottenCrede
 </div>
 <h4 class="tsd-returns-title">Returns <a href="Resources.ForgottenCredentials.html" class="tsd-signature-type" data-tsd-kind="Class">ForgottenCredentials</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L94">api/ForgottenCredentials.ts:94</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L117">api/ForgottenCredentials.ts:117</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="ResetPasswordByVerificationCode" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Reset<wbr/>Password<wbr/>By<wbr/>Verification<wbr/>Code</span><a href="#ResetPasswordByVerificationCode" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -84,7 +85,7 @@ <h5>passwordReset: <a href="../interfaces/PasswordReset.html" class="tsd-signatu
 <h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L53">api/ForgottenCredentials.ts:53</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L76">api/ForgottenCredentials.ts:76</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="RetrieveUsername" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Retrieve<wbr/>Username</span><a href="#RetrieveUsername" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -111,7 +112,27 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> email<span class="tsd-
 <h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L75">api/ForgottenCredentials.ts:75</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L98">api/ForgottenCredentials.ts:98</a></li></ul></aside></li></ul></section>
+<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="SendOneTimePassword" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><span>Send<wbr/>One<wbr/>Time<wbr/>Password</span><a href="#SendOneTimePassword" 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>
+<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
+<li class="tsd-signature tsd-anchor-link" id="SendOneTimePassword.SendOneTimePassword-1">Send<wbr/>One<wbr/>Time<wbr/>Password<span class="tsd-signature-symbol">(</span>oneTimePasswordRequest<span class="tsd-signature-symbol">: </span><a href="../interfaces/OneTimePasswordRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">OneTimePasswordRequest</a>, 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="#SendOneTimePassword.SendOneTimePassword-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>Send an one time password. 
+Check out the <a href="https://ordercloud.io/api-reference/authentication-and-authorization/forgotten-credentials/send-one-time-password%7Capi">docs</a> for more info</p>
+</div>
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>oneTimePasswordRequest: <a href="../interfaces/OneTimePasswordRequest.html" class="tsd-signature-type" data-tsd-kind="Interface">OneTimePasswordRequest</a></h5>
+<div class="tsd-comment tsd-typography"><p>Required fields: ClientID</p>
+</div></li>
+<li>
+<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
+<h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L33">api/ForgottenCredentials.ts:33</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="SendVerificationCode" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Send<wbr/>Verification<wbr/>Code</span><a href="#SendVerificationCode" 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>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -131,7 +152,7 @@ <h5>passwordResetRequest: <a href="../interfaces/PasswordResetRequest.html" clas
 <h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L31">api/ForgottenCredentials.ts:31</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ForgottenCredentials.ts#L54">api/ForgottenCredentials.ts:54</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -161,6 +182,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="Resources.ForgottenCredentials.html#As" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>As</a></li>
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="Resources.ForgottenCredentials.html#ResetPasswordByVerificationCode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>Reset<wbr/>Password<wbr/>By<wbr/>Verification<wbr/>Code</a></li>
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="Resources.ForgottenCredentials.html#RetrieveUsername" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>Retrieve<wbr/>Username</a></li>
+<li class="tsd-kind-method tsd-parent-kind-class"><a href="Resources.ForgottenCredentials.html#SendOneTimePassword" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>Send<wbr/>One<wbr/>Time<wbr/>Password</a></li>
 <li class="tsd-kind-method tsd-parent-kind-class"><a href="Resources.ForgottenCredentials.html#SendVerificationCode" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>Send<wbr/>Verification<wbr/>Code</a></li></ul></li></ul></nav></div></div>
 <div class="container tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>