commerce-sdk-isomorphic 4.0.0-nightly-20251013080807 → 4.0.0-nightly-20251015080804

package/lib/shopperLogin.d.ts

@@ -228,7 +228,9 @@ type authorizeCustomerQueryParameters = {
 type authorizeCustomerPathParameters = {
     organizationId: string;
 };
-type authorizePasswordlessCustomerQueryParameters = {};
+type authorizePasswordlessCustomerQueryParameters = {
+    register_customer?: string;
+};
 type authorizePasswordlessCustomerPathParameters = {
     organizationId: string;
 };
@@ -239,6 +241,10 @@ type authorizePasswordlessCustomerBodyType = {
     usid?: string;
     channel_id: string;
     callback_uri?: string;
+    last_name?: string;
+    email?: string;
+    first_name?: string;
+    phone_number?: string;
 };
 type getAccessTokenQueryParameters = {};
 type getAccessTokenPathParameters = {
@@ -506,9 +512,14 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
             "user_id",
             "mode",
             "channel_id",
+            "register_customer",
             "locale",
             "usid",
-            "callback_uri"
+            "callback_uri",
+            "last_name",
+            "email",
+            "first_name",
+            "phone_number"
         ];
         readonly authorizePasswordlessCustomerRequired: readonly [
             "organizationId",
@@ -922,6 +933,10 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
      * @param options - An object containing the options for this method.
      * @param options.parameters - An object containing the parameters for this method.
      * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.register_customer - When set to `true`, creates a new customer profile in B2C Commerce if one doesn't already exist. Requires `last_name` and `email` body parameters unless `user_id` is an email address. Optionally accepts `first_name` and `phone_number` body parameters.
+     If the customer profile doesn't exist, it is created when the TOTP is validated via the `passwordless/token` endpoint.
+     
+     When set to `false` (or omitted), no customer profile is created in B2C Commerce.
      * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
      * @param options.body - The data to send as the request body.
      * @param options.body.user_id - User ID for logging in.
@@ -930,12 +945,17 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
      * @param options.body.usid - The shopper\'s unique identifier, if known. If not provided, a new USID is generated.
      * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
      * @param options.body.callback_uri - The callback URI. Required when the mode is `callback`. The `callback_uri` property will be validated against the callback URIs that have been registered with the SLAS client. The callback URI _must_ be a `POST` endpoint because the token will be included in the body.  Wildcards are not allowed in the callback_uri because this is a security risk that can expose the token. This is not considered an OAuth2 callback_url.
+     * @param options.body.last_name - The user\'s last name. Required when `register_customer` is `true`.  The `last_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+     * @param options.body.email - The user\'s email address. Required when `register_customer` is `true` and `user_id` is not an email address.  The `email` parameter is not used when `register_customer` parameter is not added or is `false`.
+     * @param options.body.first_name - The user\'s first name. Optional when `register_customer` is `true`.  The `first_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+     * @param options.body.phone_number - The user\'s phone number. Optional when `register_customer` is `true`.  The `phone_number` parameter is not used when `register_customer` parameter is not added or is `false`.
      *
      * @returns A promise of type string.
      */
     authorizePasswordlessCustomer(options?: RequireParametersUnlessAllAreOptional<{
         parameters?: CompositeParameters<{
             organizationId: string;
+            register_customer?: string;
         } & QueryParameters, ConfigParameters>;
         headers?: {
             [key: string]: string;
@@ -948,6 +968,10 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
      * @param options - An object containing the options for this method.
      * @param options.parameters - An object containing the parameters for this method.
      * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.register_customer - When set to `true`, creates a new customer profile in B2C Commerce if one doesn't already exist. Requires `last_name` and `email` body parameters unless `user_id` is an email address. Optionally accepts `first_name` and `phone_number` body parameters.
+     If the customer profile doesn't exist, it is created when the TOTP is validated via the `passwordless/token` endpoint.
+     
+     When set to `false` (or omitted), no customer profile is created in B2C Commerce.
      * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
      * @param options.body - The data to send as the request body.
      * @param options.body.user_id - User ID for logging in.
@@ -956,6 +980,10 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
      * @param options.body.usid - The shopper\'s unique identifier, if known. If not provided, a new USID is generated.
      * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
      * @param options.body.callback_uri - The callback URI. Required when the mode is `callback`. The `callback_uri` property will be validated against the callback URIs that have been registered with the SLAS client. The callback URI _must_ be a `POST` endpoint because the token will be included in the body.  Wildcards are not allowed in the callback_uri because this is a security risk that can expose the token. This is not considered an OAuth2 callback_url.
+     * @param options.body.last_name - The user\'s last name. Required when `register_customer` is `true`.  The `last_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+     * @param options.body.email - The user\'s email address. Required when `register_customer` is `true` and `user_id` is not an email address.  The `email` parameter is not used when `register_customer` parameter is not added or is `false`.
+     * @param options.body.first_name - The user\'s first name. Optional when `register_customer` is `true`.  The `first_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+     * @param options.body.phone_number - The user\'s phone number. Optional when `register_customer` is `true`.  The `phone_number` parameter is not used when `register_customer` parameter is not added or is `false`.
      * @param rawResponse - Set to true to return entire Response object instead of DTO.
      *
      * @returns A promise of type Response if rawResponse is true, a promise of type string otherwise.
@@ -963,6 +991,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
     authorizePasswordlessCustomer<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
         parameters?: CompositeParameters<{
             organizationId: string;
+            register_customer?: string;
         } & QueryParameters, ConfigParameters>;
         headers?: {
             [key: string]: string;
@@ -2073,7 +2102,9 @@ declare namespace ShopperLoginApiTypes {
     type authorizeCustomerPathParameters = {
         organizationId: string;
     };
-    type authorizePasswordlessCustomerQueryParameters = {};
+    type authorizePasswordlessCustomerQueryParameters = {
+        register_customer?: string;
+    };
     type authorizePasswordlessCustomerPathParameters = {
         organizationId: string;
     };
@@ -2084,6 +2115,10 @@ declare namespace ShopperLoginApiTypes {
         usid?: string;
         channel_id: string;
         callback_uri?: string;
+        last_name?: string;
+        email?: string;
+        first_name?: string;
+        phone_number?: string;
     };
     type getAccessTokenQueryParameters = {};
     type getAccessTokenPathParameters = {
@@ -2351,9 +2386,14 @@ declare namespace ShopperLoginApiTypes {
                 "user_id",
                 "mode",
                 "channel_id",
+                "register_customer",
                 "locale",
                 "usid",
-                "callback_uri"
+                "callback_uri",
+                "last_name",
+                "email",
+                "first_name",
+                "phone_number"
             ];
             readonly authorizePasswordlessCustomerRequired: readonly [
                 "organizationId",
@@ -2767,6 +2807,10 @@ declare namespace ShopperLoginApiTypes {
          * @param options - An object containing the options for this method.
          * @param options.parameters - An object containing the parameters for this method.
          * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.register_customer - When set to `true`, creates a new customer profile in B2C Commerce if one doesn't already exist. Requires `last_name` and `email` body parameters unless `user_id` is an email address. Optionally accepts `first_name` and `phone_number` body parameters.
+         If the customer profile doesn't exist, it is created when the TOTP is validated via the `passwordless/token` endpoint.
+         
+         When set to `false` (or omitted), no customer profile is created in B2C Commerce.
          * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
          * @param options.body - The data to send as the request body.
          * @param options.body.user_id - User ID for logging in.
@@ -2775,12 +2819,17 @@ declare namespace ShopperLoginApiTypes {
          * @param options.body.usid - The shopper\'s unique identifier, if known. If not provided, a new USID is generated.
          * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
          * @param options.body.callback_uri - The callback URI. Required when the mode is `callback`. The `callback_uri` property will be validated against the callback URIs that have been registered with the SLAS client. The callback URI _must_ be a `POST` endpoint because the token will be included in the body.  Wildcards are not allowed in the callback_uri because this is a security risk that can expose the token. This is not considered an OAuth2 callback_url.
+         * @param options.body.last_name - The user\'s last name. Required when `register_customer` is `true`.  The `last_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+         * @param options.body.email - The user\'s email address. Required when `register_customer` is `true` and `user_id` is not an email address.  The `email` parameter is not used when `register_customer` parameter is not added or is `false`.
+         * @param options.body.first_name - The user\'s first name. Optional when `register_customer` is `true`.  The `first_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+         * @param options.body.phone_number - The user\'s phone number. Optional when `register_customer` is `true`.  The `phone_number` parameter is not used when `register_customer` parameter is not added or is `false`.
          *
          * @returns A promise of type string.
          */
         authorizePasswordlessCustomer(options?: RequireParametersUnlessAllAreOptional<{
             parameters?: CompositeParameters<{
                 organizationId: string;
+                register_customer?: string;
             } & QueryParameters, ConfigParameters>;
             headers?: {
                 [key: string]: string;
@@ -2793,6 +2842,10 @@ declare namespace ShopperLoginApiTypes {
          * @param options - An object containing the options for this method.
          * @param options.parameters - An object containing the parameters for this method.
          * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.register_customer - When set to `true`, creates a new customer profile in B2C Commerce if one doesn't already exist. Requires `last_name` and `email` body parameters unless `user_id` is an email address. Optionally accepts `first_name` and `phone_number` body parameters.
+         If the customer profile doesn't exist, it is created when the TOTP is validated via the `passwordless/token` endpoint.
+         
+         When set to `false` (or omitted), no customer profile is created in B2C Commerce.
          * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
          * @param options.body - The data to send as the request body.
          * @param options.body.user_id - User ID for logging in.
@@ -2801,6 +2854,10 @@ declare namespace ShopperLoginApiTypes {
          * @param options.body.usid - The shopper\'s unique identifier, if known. If not provided, a new USID is generated.
          * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
          * @param options.body.callback_uri - The callback URI. Required when the mode is `callback`. The `callback_uri` property will be validated against the callback URIs that have been registered with the SLAS client. The callback URI _must_ be a `POST` endpoint because the token will be included in the body.  Wildcards are not allowed in the callback_uri because this is a security risk that can expose the token. This is not considered an OAuth2 callback_url.
+         * @param options.body.last_name - The user\'s last name. Required when `register_customer` is `true`.  The `last_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+         * @param options.body.email - The user\'s email address. Required when `register_customer` is `true` and `user_id` is not an email address.  The `email` parameter is not used when `register_customer` parameter is not added or is `false`.
+         * @param options.body.first_name - The user\'s first name. Optional when `register_customer` is `true`.  The `first_name` parameter is not used when `register_customer` parameter is not added or is `false`.
+         * @param options.body.phone_number - The user\'s phone number. Optional when `register_customer` is `true`.  The `phone_number` parameter is not used when `register_customer` parameter is not added or is `false`.
          * @param rawResponse - Set to true to return entire Response object instead of DTO.
          *
          * @returns A promise of type Response if rawResponse is true, a promise of type string otherwise.
@@ -2808,6 +2865,7 @@ declare namespace ShopperLoginApiTypes {
         authorizePasswordlessCustomer<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
             parameters?: CompositeParameters<{
                 organizationId: string;
+                register_customer?: string;
             } & QueryParameters, ConfigParameters>;
             headers?: {
                 [key: string]: string;