@wix/auto_sdk_redirects_redirects 1.0.1 → 1.0.2

package/build/cjs/src/headless-v1-redirect-session-redirects.types.d.ts

@@ -1,9 +1,13 @@
 /** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
 export interface RedirectSession {
-    /** ID of the redirect session created. */
+    /**
+     * ID of the redirect session created.
+     * @format GUID
+     */
     id?: string;
     /**
      * The full URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
+     * @maxLength 2048
      * @readonly
      */
     fullUrl?: string;
@@ -11,11 +15,13 @@ export interface RedirectSession {
     urlDetails?: URLDetails;
     /**
      * The session token to pass to the Wix page to maintain the visitor's identity.
+     * @maxLength 2048
      * @readonly
      */
     sessionToken?: string | null;
     /**
      * The short URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
+     * @maxLength 2048
      * @readonly
      */
     shortUrl?: string;
@@ -24,6 +30,7 @@ export interface URLDetails {
     /**
      * Endpoint of the url. This includes the base URL and the path to the endpoint, without query parameters.
      * For example: `https://mysite.com/_api/oauth2/authorize`.
+     * @maxLength 2048
      * @readonly
      */
     endpoint?: string;
@@ -86,6 +93,7 @@ export interface RedirectSessionBookingsCheckoutParams {
      * The timezone to use when presenting the selected slot to users, in [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`.
      *
      * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
+     * @maxLength 40
      */
     timezone?: string;
     slotAvailability?: SlotAvailability;
@@ -174,29 +182,39 @@ export interface Slot {
     /**
      * ID for the slot's corresponding event, when the event is either a single event
      * or a specific event generated from a recurring event.
+     * @minLength 36
+     * @maxLength 250
      */
     eventId?: string | null;
 }
 export interface SlotResource {
     /**
      * Resource ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
-    /** Resource name. Read only. */
+    /**
+     * Resource name. Read only.
+     * @maxLength 1200
+     */
     name?: string | null;
 }
 export interface Location {
     /**
      * Business location ID. Available only for locations that are business locations,
      * meaning the `location_type` is `"OWNER_BUSINESS"`.
+     * @format GUID
      */
     id?: string | null;
     /** Location name. */
     name?: string | null;
     /** The full address of this location. */
     formattedAddress?: string | null;
-    /** The full translated address of this location. */
+    /**
+     * The full translated address of this location.
+     * @maxLength 512
+     */
     formattedAddressTranslated?: string | null;
     /**
      * Location type.
@@ -232,8 +250,11 @@ export interface BookingPolicyViolations {
     bookOnlineDisabled?: boolean | null;
 }
 export interface NestedTimeSlot {
+    /** @format GUID */
     serviceId?: string;
+    /** @maxLength 30 */
     start?: string;
+    /** @maxLength 30 */
     end?: string;
     resource?: SlotResource;
     /** Schedule ID. */
@@ -243,24 +264,30 @@ export interface RedirectSessionEcomCheckoutParams {
     /**
      * - SDK: Use [Create Checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/create-checkout) or [Create Checkout From Current Cart](https://dev.wix.com/docs/sdk/backend-modules/ecom/current-cart/create-checkout-from-current-cart).
      * - REST: Use [Create Checkout From Cart](https://dev.wix.com/docs/rest/business-solutions/e-commerce/cart/create-checkout-from-cart).
+     * @format GUID
      */
     checkoutId?: string;
 }
 export interface RedirectSessionEventsCheckoutParams {
+    /** @format GUID */
     reservationId?: string;
+    /** @maxLength 150 */
     eventSlug?: string;
 }
 export interface RedirectSessionPaidPlansCheckoutParams {
+    /** @format GUID */
     planId?: string;
     /**
      * For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
      * In this case, a string is received by the external pricing plans page as a `checkoutData` query parameter. Pass this string back here when redirecting back to Wix for checkout.
+     * @maxLength 2048
      */
     checkoutData?: string | null;
 }
 export interface RedirectSessionLoginParams {
 }
 export interface RedirectSessionLogoutParams {
+    /** @format GUID */
     clientId?: string;
 }
 export interface RedirectSessionAuthParams {
@@ -273,16 +300,23 @@ export interface RedirectSessionAuthParams {
  * the authorization process.
  */
 export interface AuthorizeRequest {
-    /** ID of the Wix OAuth app requesting authorization. */
+    /**
+     * ID of the Wix OAuth app requesting authorization.
+     * @format GUID
+     */
     clientId?: string;
     /**
      * Desired authorization [grant type](https://auth0.com/docs/authenticate/protocols/oauth#grant-types).
      *
      * Supported values:
      * + `code`: The endpoint returns an authorization code that can be used to obtain an access token.
+     * @minLength 1
      */
     responseType?: string;
-    /** URI to redirect the browser to after authentication and authorization. The browser is redirected to this URI whether the authentication and authorization process is successful or not. */
+    /**
+     * URI to redirect the browser to after authentication and authorization. The browser is redirected to this URI whether the authentication and authorization process is successful or not.
+     * @minLength 1
+     */
     redirectUri?: string | null;
     /**
      * Desired scope of access. If this field is left empty, only an access token is granted.
@@ -294,6 +328,7 @@ export interface AuthorizeRequest {
      * request. If a value for this field is set in the request, it's added to the `redirectUri` when the browser
      * is redirected there.
      * Learn more about [using the state parameter](https://auth0.com/docs/secure/attack-protection/state-parameters).
+     * @minLength 1
      */
     state?: string;
     /**
@@ -323,7 +358,10 @@ export interface AuthorizeRequest {
     codeChallengeMethod?: string | null;
     /** Session token of the site visitor to authorize. */
     sessionToken?: string | null;
-    /** URL to redirect user to sign in */
+    /**
+     * URL to redirect user to sign in
+     * @format SECURE_WEB_URL
+     */
     signInUrl?: string | null;
 }
 /** Specifies the behavior of the authorization flow regarding site member authentication and consent. */
@@ -358,10 +396,14 @@ export declare enum MembersAccountSection {
     EVENTS = "EVENTS"
 }
 export interface RedirectSessionStoresProductParams {
+    /** @maxLength 150 */
     productSlug?: string;
 }
 export interface RedirectSessionBookingsBookParams {
-    /** For use when filtering the bookings page by a specific resource. */
+    /**
+     * For use when filtering the bookings page by a specific resource.
+     * @format GUID
+     */
     resourceId?: string;
 }
 export interface CallbackParams {
@@ -382,30 +424,35 @@ export interface CallbackParams {
      * If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
      *
      * Default: If you don't specify a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     * @maxLength 2048
      */
     thankYouPageUrl?: string | null;
     /**
      * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
      *
      * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `auth.authRequest.redirectUri`.
+     * @maxLength 2048
      */
     postFlowUrl?: string | null;
     /**
      * The URL for a custom login page implemented outside of Wix.
      *
      * Default: If you don't specify a URL, a Wix login page is used.
+     * @maxLength 2048
      */
     loginUrl?: string | null;
     /**
      * The URL for a custom bookings services page implemented outside of Wix.
      *
      * Default: If you don't specify a URL, a Wix bookings services page is used.
+     * @maxLength 2048
      */
     bookingsServiceListUrl?: string | null;
     /**
      * The URL for a custom eCommerce cart page implemented outside of Wix.
      *
      * Default: If you don't specify a URL, a Wix cart page is used.
+     * @maxLength 2048
      */
     cartPageUrl?: string | null;
     /**
@@ -415,6 +462,7 @@ export interface CallbackParams {
      * + `checkoutData`: Pass this string back in `paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
      *
      * Default: If you don't specify a URL, a Wix pricing plans page is used.
+     * @maxLength 2048
      */
     planListUrl?: string | null;
 }
@@ -438,9 +486,15 @@ export interface RedirectSessionPreferences {
     additionalQueryParameters?: Record<string, string>;
 }
 export interface CustomMemberPaths {
-    /** Path of the account page in the site's members area. Required if `useGenericWixPages` is `false` and the account page path has been changed in the Wix editor. */
+    /**
+     * Path of the account page in the site's members area. Required if `useGenericWixPages` is `false` and the account page path has been changed in the Wix editor.
+     * @format URL_SLUG
+     */
     accountPagePath?: string | null;
-    /** Path of the member profile page in the site's members area. Required if `useGenericWixPages` is `false` and the member profile page path has been changed in the Wix editor. */
+    /**
+     * Path of the member profile page in the site's members area. Required if `useGenericWixPages` is `false` and the member profile page path has been changed in the Wix editor.
+     * @format URL_SLUG
+     */
     profilePagePath?: string | null;
 }
 export interface CreateRedirectSessionResponse {
@@ -483,13 +537,19 @@ export interface CreateAnonymousRedirectSessionResponse {
     redirectSession?: RedirectSession;
 }
 export interface AttachPagesRequest {
-    /** App ID that we want to inherit pages for. */
+    /**
+     * App ID that we want to inherit pages for.
+     * @format GUID
+     */
     appDefId?: string;
 }
 export interface AttachPagesResponse {
     /** The status of the operation. */
     status?: AttachPagesResponseStatus;
-    /** A descriptive message about the operation */
+    /**
+     * A descriptive message about the operation
+     * @maxLength 2048
+     */
     message?: string;
     /** True if pages were attached, false otherwise */
     pagesAttached?: boolean;
@@ -507,11 +567,17 @@ export declare enum AttachPagesResponseStatus {
     ERROR = "ERROR"
 }
 export interface ValidateCallbackURLRequest {
-    /** An external URL to validate */
+    /**
+     * An external URL to validate
+     * @maxLength 2048
+     */
     callbackUrl?: string;
     /** Type of the callback URL. */
     callbackType?: CallbackType;
-    /** The oauth app id used in order to pull the allowed domains from, has to correspond to the same metasite as the site in context */
+    /**
+     * The oauth app id used in order to pull the allowed domains from, has to correspond to the same metasite as the site in context
+     * @format GUID
+     */
     clientId?: string;
 }
 export declare enum CallbackType {
@@ -529,7 +595,10 @@ export interface ValidateCallbackURLResponse {
     isValid?: boolean;
 }
 export interface SignInURLRequest {
-    /** The oauth app id used in order to pull the allowed domains from, has to correspond to the same metasite as the site in context */
+    /**
+     * The oauth app id used in order to pull the allowed domains from, has to correspond to the same metasite as the site in context
+     * @format GUID
+     */
     clientId?: string;
 }
 export interface SignInURLResponse {
@@ -623,9 +692,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -633,26 +708,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/headless-v1-redirect-session-redirects.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session-redirects.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session-redirects.types.ts"],"names":[],"mappings":";;;AA2NA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA4HD,yGAAyG;AACzG,IAAY,MASX;AATD,WAAY,MAAM;IAChB,uFAAuF;IACvF,yBAAe,CAAA;IACf;;;;OAIG;IACH,uBAAa,CAAA;AACf,CAAC,EATW,MAAM,sBAAN,MAAM,QASjB;AAWD,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,4CAA4C;IAC5C,sDAA6B,CAAA;IAC7B,2CAA2C;IAC3C,8CAAqB,CAAA;IACrB,yCAAyC;IACzC,0CAAiB,CAAA;IACjB,6CAA6C;IAC7C,wDAA+B,CAAA;IAC/B,sCAAsC;IACtC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,qCAArB,qBAAqB,QAWhC;AAyJD,IAAY,yBASX;AATD,WAAY,yBAAyB;IACnC,qBAAqB;IACrB,gDAAmB,CAAA;IACnB,wCAAwC;IACxC,gDAAmB,CAAA;IACnB,oEAAoE;IACpE,oDAAuB,CAAA;IACvB,oEAAoE;IACpE,4CAAe,CAAA;AACjB,CAAC,EATW,yBAAyB,yCAAzB,yBAAyB,QASpC;AAWD,IAAY,YASX;AATD,WAAY,YAAY;IACtB,qBAAqB;IACrB,mCAAmB,CAAA;IACnB,gDAAgD;IAChD,iCAAiB,CAAA;IACjB,gDAAgD;IAChD,qCAAqB,CAAA;IACrB,mDAAmD;IACnD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAwBD,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,qBAAqB;IACrB,6BAAmB,CAAA;IACnB,4CAA4C;IAC5C,6BAAmB,CAAA;IACnB,yBAAyB;IACzB,yBAAe,CAAA;AACjB,CAAC,EAPW,MAAM,sBAAN,MAAM,QAOjB;AAqHD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"headless-v1-redirect-session-redirects.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session-redirects.types.ts"],"names":[],"mappings":";;;AA6OA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAgJD,yGAAyG;AACzG,IAAY,MASX;AATD,WAAY,MAAM;IAChB,uFAAuF;IACvF,yBAAe,CAAA;IACf;;;;OAIG;IACH,uBAAa,CAAA;AACf,CAAC,EATW,MAAM,sBAAN,MAAM,QASjB;AAWD,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,4CAA4C;IAC5C,sDAA6B,CAAA;IAC7B,2CAA2C;IAC3C,8CAAqB,CAAA;IACrB,yCAAyC;IACzC,0CAAiB,CAAA;IACjB,6CAA6C;IAC7C,wDAA+B,CAAA;IAC/B,sCAAsC;IACtC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,qCAArB,qBAAqB,QAWhC;AA+KD,IAAY,yBASX;AATD,WAAY,yBAAyB;IACnC,qBAAqB;IACrB,gDAAmB,CAAA;IACnB,wCAAwC;IACxC,gDAAmB,CAAA;IACnB,oEAAoE;IACpE,oDAAuB,CAAA;IACvB,oEAAoE;IACpE,4CAAe,CAAA;AACjB,CAAC,EATW,yBAAyB,yCAAzB,yBAAyB,QASpC;AAiBD,IAAY,YASX;AATD,WAAY,YAAY;IACtB,qBAAqB;IACrB,mCAAmB,CAAA;IACnB,gDAAgD;IAChD,iCAAiB,CAAA;IACjB,gDAAgD;IAChD,qCAAqB,CAAA;IACrB,mDAAmD;IACnD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AA2BD,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,qBAAqB;IACrB,6BAAmB,CAAA;IACnB,4CAA4C;IAC5C,6BAAmB,CAAA;IACnB,yBAAyB;IACzB,yBAAe,CAAA;AACjB,CAAC,EAPW,MAAM,sBAAN,MAAM,QAOjB;AAmJD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}