@wix/auto_sdk_ecom_checkout-settings 1.0.0 → 1.0.2

package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.universal.d.ts

@@ -32,7 +32,7 @@ export interface CheckoutPolicies {
 }
 export interface TermsAndConditionsPolicy {
     /**
-     * Whether the terms & conditions policy is visible to the customer in the checkout page. <br><br>
+     * Whether the terms and conditions policy is visible to the customer in the checkout page. <br><br>
      *
      * Default: `false`
      */
@@ -82,38 +82,43 @@ export interface ContactUsPolicy {
 }
 export interface CustomCheckoutPolicy {
     /**
-     * Whether the policy is visible to the customer on the checkout page.
-     * Default: `false`.
+     * Whether the custom policy is visible to the customer in the checkout page. <br><br>
+     *
+     * Default: `false`
      */
     visible?: boolean | null;
-    /** Policy content. */
+    /** Custom policy content. */
     content?: string | null;
-    /** Policy title. */
+    /** Custom policy title. */
     title?: string | null;
 }
 export interface CheckoutFields {
     /**
-     * Subscription checkbox.
-     * Default:
-     * - `visible`: `false`,
-     * - `checkedByDefault`: `false`
+     * Subscription checkbox. <br><br>
+     *
+     * Defaults:
+     * + `visible`: `false`
+     * + `checkedByDefault`: `false`
      */
     subscriptionCheckbox?: CheckboxField;
     /**
-     * Policy agreement checkbox.
-     * Default:
-     * - `visible`: `true`,
-     * - `checkedByDefault`: `true`
+     * Policy agreement checkbox. <br><br>
+     *
+     * Defaults:
+     * + `visible`: `true`
+     * + `checkedByDefault`: `true`
      */
     policyAgreementCheckbox?: CheckboxField;
     /**
-     * Whether the ability to redeem a gift card is enabled.
-     * Default: `false`.
+     * Whether the ability to redeem a gift card is enabled. <br><br>
+     *
+     * Default: `false`
      */
     giftCardRedeemEnabled?: boolean | null;
     /**
-     * Whether to allow for MIT transactions.
-     * Default: `false`.
+     * Whether to allow for MIT transactions. <br><br>
+     *
+     * Default: `false`
      */
     mitEnabled?: boolean | null;
     /**
@@ -144,6 +149,7 @@ export interface CheckoutHeader {
     /**
      * Textual content to be included in the header (e.g. Business Name)
      * TODO: update maxLength validation once limitation is known
+     * @maxLength 55
      */
     text?: string | null;
     /** Specifications for when a logo is included in the header. */
@@ -196,7 +202,7 @@ export interface UpdateCheckoutSettingsRequest {
     checkoutSettings: CheckoutSettings;
 }
 export interface UpdateCheckoutSettingsResponse {
-    /** The updated checkout settings. */
+    /** Updated checkout settings. */
     checkoutSettings?: CheckoutSettings;
 }
 export interface ListCheckoutSettingsRequest {
@@ -287,9 +293,15 @@ export interface ActionEvent {
     body?: 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;
@@ -297,26 +309,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 {
@@ -348,9 +384,15 @@ export interface UpdateCheckoutSettingsResponseNonNullableFields {
     checkoutSettings?: CheckoutSettingsNonNullableFields;
 }
 export interface BaseEventMetadata {
-    /** 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;
@@ -416,16 +458,12 @@ export interface CheckoutSettingsUpdatedEnvelope {
  * @permissionId ECOM.READ_CHECKOUT_SETTINGS
  * @webhook
  * @eventType wix.ecom.v1.checkout_settings_updated
- * @documentationMaturity preview
+ * @slug updated
  */
 export declare function onCheckoutSettingsUpdated(handler: (event: CheckoutSettingsUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Retrieves the sites' checkout settings.
- *
- *
- * The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.
+ * Retrieves the site's checkout settings.
  * @public
- * @documentationMaturity preview
  * @permissionId ECOM.READ_CHECKOUT_SETTINGS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
@@ -443,18 +481,13 @@ export declare function onCheckoutSettingsUpdated(handler: (event: CheckoutSetti
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns The requested checkout settings.
  * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.GetCheckoutSettings
  */
 export declare function getCheckoutSettings(): Promise<GetCheckoutSettingsResponse & GetCheckoutSettingsResponseNonNullableFields>;
 /**
- * Updates the sites' checkout settings.
- *
- *
- * The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.
+ * Updates the site's checkout settings.
  * @param checkoutSettings - Checkout settings to update.
  * @public
- * @documentationMaturity preview
  * @requiredField checkoutSettings
  * @permissionId ECOM.UPDATE_CHECKOUT_SETTINGS
  * @permissionScope Manage Stores - all permissions
@@ -466,7 +499,6 @@ export declare function getCheckoutSettings(): Promise<GetCheckoutSettingsRespon
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
  * @applicableIdentity APP
- * @returns The updated checkout settings.
  * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.UpdateCheckoutSettings
  */
 export declare function updateCheckoutSettings(checkoutSettings: CheckoutSettings): Promise<UpdateCheckoutSettingsResponse & UpdateCheckoutSettingsResponseNonNullableFields>;

package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.universal.js

@@ -26,12 +26,8 @@ export var WebhookIdentityType;
     WebhookIdentityType["APP"] = "APP";
 })(WebhookIdentityType || (WebhookIdentityType = {}));
 /**
- * Retrieves the sites' checkout settings.
- *
- *
- * The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.
+ * Retrieves the site's checkout settings.
  * @public
- * @documentationMaturity preview
  * @permissionId ECOM.READ_CHECKOUT_SETTINGS
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
@@ -49,7 +45,6 @@ export var WebhookIdentityType;
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
  * @applicableIdentity APP
  * @applicableIdentity VISITOR
- * @returns The requested checkout settings.
  * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.GetCheckoutSettings
  */
 export async function getCheckoutSettings() {
@@ -79,13 +74,9 @@ export async function getCheckoutSettings() {
     }
 }
 /**
- * Updates the sites' checkout settings.
- *
- *
- * The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.
+ * Updates the site's checkout settings.
  * @param checkoutSettings - Checkout settings to update.
  * @public
- * @documentationMaturity preview
  * @requiredField checkoutSettings
  * @permissionId ECOM.UPDATE_CHECKOUT_SETTINGS
  * @permissionScope Manage Stores - all permissions
@@ -97,7 +88,6 @@ export async function getCheckoutSettings() {
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
  * @applicableIdentity APP
- * @returns The updated checkout settings.
  * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.UpdateCheckoutSettings
  */
 export async function updateCheckoutSettings(checkoutSettings) {

package/build/internal/es/src/ecom-v1-checkout-settings-checkout-settings.universal.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecom-v1-checkout-settings-checkout-settings.universal.js","sourceRoot":"","sources":["../../../../src/ecom-v1-checkout-settings-checkout-settings.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,mCAAmC,MAAM,uDAAuD,CAAC;AAC7G,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAgMlF,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,mDAAuC,CAAA;IACvC,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,0BAAa,CAAA;IACb,8BAAiB,CAAA;AACnB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAuJD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AA2GD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IAGvC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,mCAAmC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,4BAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;aACtE;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,gBAAkC;IAKlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,cAAc,CAC5B,qCAAqC,CAAC;QACpC,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,EACF;QACE;YACE,WAAW,EAAE,4BAA4B;YACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;SACtE;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GACX,mCAAmC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,4BAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;aACtE;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
+{"version":3,"file":"ecom-v1-checkout-settings-checkout-settings.universal.js","sourceRoot":"","sources":["../../../../src/ecom-v1-checkout-settings-checkout-settings.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,mCAAmC,MAAM,uDAAuD,CAAC;AAC7G,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAsMlF,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,mDAAuC,CAAA;IACvC,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,2BAAe,CAAA;AACjB,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAED,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,0BAAa,CAAA;IACb,8BAAiB,CAAA;AACnB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAqLD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AAiHD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB;IAGvC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,mCAAmC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,4BAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;aACtE;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,gBAAkC;IAKlC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,cAAc,CAC5B,qCAAqC,CAAC;QACpC,gBAAgB,EAAE,gBAAgB;KACnC,CAAC,EACF;QACE;YACE,WAAW,EAAE,4BAA4B;YACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;SACtE;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GACX,mCAAmC,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAC5C,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,4BAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,kDAAkD,EAAE,CAAC;aACtE;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;YACtD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,kBAAkB,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_ecom_checkout-settings",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -48,5 +48,5 @@
       "fqdn": "wix.ecom.v1.checkout_settings"
     }
   },
-  "falconPackageHash": "4bdb78817992dc621baa9ddc87aae9855dfc33a388e5288171be0654"
+  "falconPackageHash": "927d166ffa191ba2df27fa20fc07c8633cb1f279e2297bd3a31056ee"
 }