@wix/auto_sdk_ecom_checkout-settings 1.0.6 → 1.0.8

package/build/internal/{es/src/ecom-v1-checkout-settings-checkout-settings.universal.d.ts → ecom-v1-checkout-settings-checkout-settings.universal-DL30mjR_.d.ts}

@@ -1,4 +1,4 @@
-export interface CheckoutSettings {
+interface CheckoutSettings {
     /** Checkout policies. */
     checkoutPolicies?: CheckoutPolicies;
     /** Settings that apply to checkout fields and the checkout process. */
@@ -16,7 +16,7 @@ export interface CheckoutSettings {
      */
     _updatedDate?: Date | null;
 }
-export interface CheckoutPolicies {
+interface CheckoutPolicies {
     /** Terms and conditions. */
     termsAndConditions?: TermsAndConditionsPolicy;
     /** Privacy policy. */
@@ -30,7 +30,7 @@ export interface CheckoutPolicies {
     /** Custom policy. */
     customPolicy?: CustomCheckoutPolicy;
 }
-export interface TermsAndConditionsPolicy {
+interface TermsAndConditionsPolicy {
     /**
      * Whether the terms and conditions policy is visible to the customer in the checkout page. <br><br>
      *
@@ -40,7 +40,7 @@ export interface TermsAndConditionsPolicy {
     /** Terms and conditions policy content. */
     content?: string | null;
 }
-export interface PrivacyPolicy {
+interface PrivacyPolicy {
     /**
      * Whether the privacy policy is visible to the customer in the checkout page. <br><br>
      *
@@ -50,7 +50,7 @@ export interface PrivacyPolicy {
     /** Privacy policy content. */
     content?: string | null;
 }
-export interface ReturnPolicy {
+interface ReturnPolicy {
     /**
      * Whether the return policy is visible to the customer in the checkout page. <br><br>
      *
@@ -60,7 +60,7 @@ export interface ReturnPolicy {
     /** Return policy content. */
     content?: string | null;
 }
-export interface DigitalItemPolicy {
+interface DigitalItemPolicy {
     /**
      * Whether the digital item policy is visible to the customer in the checkout page. <br><br>
      *
@@ -70,7 +70,7 @@ export interface DigitalItemPolicy {
     /** Digital item policy content. */
     content?: string | null;
 }
-export interface ContactUsPolicy {
+interface ContactUsPolicy {
     /**
      * Whether the contact us policy is visible to the customer in the checkout page. <br><br>
      *
@@ -80,7 +80,7 @@ export interface ContactUsPolicy {
     /** Contact us policy content. */
     content?: string | null;
 }
-export interface CustomCheckoutPolicy {
+interface CustomCheckoutPolicy {
     /**
      * Whether the custom policy is visible to the customer in the checkout page. <br><br>
      *
@@ -92,7 +92,7 @@ export interface CustomCheckoutPolicy {
     /** Custom policy title. */
     title?: string | null;
 }
-export interface CheckoutFields {
+interface CheckoutFields {
     /**
      * Subscription checkbox. <br><br>
      *
@@ -135,17 +135,17 @@ export interface CheckoutFields {
      */
     captureBeforeExpiryEnabled?: boolean | null;
 }
-export interface CheckboxField {
+interface CheckboxField {
     /** Whether the checkbox is visible to the customer. */
     visible?: boolean | null;
     /** Whether the checkbox is checked by default. */
     checkedByDefault?: boolean | null;
 }
-export interface CheckoutBrand {
+interface CheckoutBrand {
     /** Checkout header. */
     header?: CheckoutHeader;
 }
-export interface CheckoutHeader {
+interface CheckoutHeader {
     /**
      * Textual content to be included in the header (e.g. Business Name)
      * TODO: update maxLength validation once limitation is known
@@ -166,11 +166,11 @@ export interface CheckoutHeader {
      */
     displayCheckoutLabel?: boolean | null;
 }
-export interface Logo {
+interface Logo {
     /** Size of the logo. */
     size?: LogoSize;
 }
-export interface FocalPoint {
+interface FocalPoint {
     /** X-coordinate of the focal point. */
     x?: number;
     /** Y-coordinate of the focal point. */
@@ -180,49 +180,49 @@ export interface FocalPoint {
     /** crop by width */
     width?: number | null;
 }
-export declare enum LogoSize {
+declare enum LogoSize {
     UNKNOWN_LOGO_SIZE = "UNKNOWN_LOGO_SIZE",
     SMALL = "SMALL",
     MEDIUM = "MEDIUM",
     LARGE = "LARGE"
 }
-export declare enum Alignment {
+declare enum Alignment {
     UNKNOWN_ALIGNMENT = "UNKNOWN_ALIGNMENT",
     SIDE = "SIDE",
     CENTER = "CENTER"
 }
-export interface GetCheckoutSettingsRequest {
+interface GetCheckoutSettingsRequest {
 }
-export interface GetCheckoutSettingsResponse {
+interface GetCheckoutSettingsResponse {
     /** Checkout settings. */
     checkoutSettings?: CheckoutSettings;
 }
-export interface UpdateCheckoutSettingsRequest {
+interface UpdateCheckoutSettingsRequest {
     /** Checkout settings to update. */
     checkoutSettings: CheckoutSettings;
 }
-export interface UpdateCheckoutSettingsResponse {
+interface UpdateCheckoutSettingsResponse {
     /** Updated checkout settings. */
     checkoutSettings?: CheckoutSettings;
 }
-export interface ListCheckoutSettingsRequest {
+interface ListCheckoutSettingsRequest {
 }
-export interface ListCheckoutSettingsResponse {
+interface ListCheckoutSettingsResponse {
     /** List of retrieved checkout settings. */
     checkoutSettings?: CheckoutSettings[];
 }
-export interface GiftCardProviderWasProvisioned {
+interface GiftCardProviderWasProvisioned {
     /** The gift card provider which was installed */
     providerAppDefId?: string;
     providerInstanceId?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface DeleteCheckoutSettingsRequest {
+interface DeleteCheckoutSettingsRequest {
 }
-export interface DeleteCheckoutSettingsResponse {
+interface DeleteCheckoutSettingsResponse {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -265,19 +265,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -285,14 +285,14 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -308,7 +308,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -333,7 +333,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -355,35 +355,14 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface LogoNonNullableFields {
-    /** @internal */
-    image: string;
-    size: LogoSize;
-}
-interface CheckoutHeaderNonNullableFields {
-    logo?: LogoNonNullableFields;
-    alignment: Alignment;
-}
-interface CheckoutBrandNonNullableFields {
-    header?: CheckoutHeaderNonNullableFields;
-}
-interface CheckoutSettingsNonNullableFields {
-    checkoutBrand?: CheckoutBrandNonNullableFields;
-}
-export interface GetCheckoutSettingsResponseNonNullableFields {
-    checkoutSettings?: CheckoutSettingsNonNullableFields;
-}
-export interface UpdateCheckoutSettingsResponseNonNullableFields {
-    checkoutSettings?: CheckoutSettingsNonNullableFields;
-}
-export interface BaseEventMetadata {
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -397,7 +376,7 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EventMetadata extends BaseEventMetadata {
+interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -435,77 +414,9 @@ export interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-export interface CheckoutSettingsUpdatedEnvelope {
+interface CheckoutSettingsUpdatedEnvelope {
     entity: CheckoutSettings;
     metadata: EventMetadata;
 }
-/**
- * Triggered when checkout settings are updated.
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
- * @permissionScope Read Stores - all read permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Picasso private app mega scope
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @permissionId ECOM.READ_CHECKOUT_SETTINGS
- * @webhook
- * @eventType wix.ecom.v1.checkout_settings_updated
- * @slug updated
- */
-export declare function onCheckoutSettingsUpdated(handler: (event: CheckoutSettingsUpdatedEnvelope) => void | Promise<void>): void;
-/**
- * Retrieves the site's checkout settings.
- * @public
- * @permissionId ECOM.READ_CHECKOUT_SETTINGS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Read eCommerce - all read permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
- * @permissionScope Read Stores - all read permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Picasso private app mega scope
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.GetCheckoutSettings
- */
-export declare function getCheckoutSettings(): Promise<GetCheckoutSettingsResponse & GetCheckoutSettingsResponseNonNullableFields>;
-/**
- * Updates the site's checkout settings.
- * @param checkoutSettings - Checkout settings to update.
- * @public
- * @requiredField checkoutSettings
- * @permissionId ECOM.UPDATE_CHECKOUT_SETTINGS
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionScope Manage eCommerce - all permissions
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
- * @permissionScope Picasso private app mega scope
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
- * @applicableIdentity APP
- * @fqn wix.ecom.checkout_settings.api.v1.CheckoutSettingsService.UpdateCheckoutSettings
- */
-export declare function updateCheckoutSettings(checkoutSettings: CheckoutSettings): Promise<UpdateCheckoutSettingsResponse & UpdateCheckoutSettingsResponseNonNullableFields>;
-export {};
+
+export { Alignment as A, type BaseEventMetadata as B, type CheckoutSettings as C, type DigitalItemPolicy as D, type Empty as E, type FocalPoint as F, type GetCheckoutSettingsResponse as G, type IdentificationData as I, LogoSize as L, type MessageEnvelope as M, type PrivacyPolicy as P, type ReturnPolicy as R, type TermsAndConditionsPolicy as T, type UpdateCheckoutSettingsResponse as U, WebhookIdentityType as W, type CheckoutPolicies as a, type ContactUsPolicy as b, type CustomCheckoutPolicy as c, type CheckoutFields as d, type CheckboxField as e, type CheckoutBrand as f, type CheckoutHeader as g, type Logo as h, type GetCheckoutSettingsRequest as i, type UpdateCheckoutSettingsRequest as j, type ListCheckoutSettingsRequest as k, type ListCheckoutSettingsResponse as l, type GiftCardProviderWasProvisioned as m, type DeleteCheckoutSettingsRequest as n, type DeleteCheckoutSettingsResponse as o, type DomainEvent as p, type DomainEventBodyOneOf as q, type EntityCreatedEvent as r, type RestoreInfo as s, type EntityUpdatedEvent as t, type EntityDeletedEvent as u, type ActionEvent as v, type IdentificationDataIdOneOf as w, type EventMetadata as x, type CheckoutSettingsUpdatedEnvelope as y };

package/build/internal/index.d.mts

@@ -0,0 +1,29 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { G as GetCheckoutSettingsResponse, C as CheckoutSettings, U as UpdateCheckoutSettingsResponse } from './ecom-v1-checkout-settings-checkout-settings.universal-DL30mjR_.mjs';
+export { v as ActionEvent, A as Alignment, B as BaseEventMetadata, e as CheckboxField, f as CheckoutBrand, d as CheckoutFields, g as CheckoutHeader, a as CheckoutPolicies, y as CheckoutSettingsUpdatedEnvelope, b as ContactUsPolicy, c as CustomCheckoutPolicy, n as DeleteCheckoutSettingsRequest, o as DeleteCheckoutSettingsResponse, D as DigitalItemPolicy, p as DomainEvent, q as DomainEventBodyOneOf, E as Empty, r as EntityCreatedEvent, u as EntityDeletedEvent, t as EntityUpdatedEvent, x as EventMetadata, F as FocalPoint, i as GetCheckoutSettingsRequest, m as GiftCardProviderWasProvisioned, I as IdentificationData, w as IdentificationDataIdOneOf, k as ListCheckoutSettingsRequest, l as ListCheckoutSettingsResponse, h as Logo, L as LogoSize, M as MessageEnvelope, P as PrivacyPolicy, s as RestoreInfo, R as ReturnPolicy, T as TermsAndConditionsPolicy, j as UpdateCheckoutSettingsRequest, W as WebhookIdentityType } from './ecom-v1-checkout-settings-checkout-settings.universal-DL30mjR_.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function getCheckoutSettings$1(httpClient: HttpClient): GetCheckoutSettingsSignature;
+interface GetCheckoutSettingsSignature {
+    /**
+     * Retrieves the site's checkout settings.
+     */
+    (): Promise<GetCheckoutSettingsResponse>;
+}
+declare function updateCheckoutSettings$1(httpClient: HttpClient): UpdateCheckoutSettingsSignature;
+interface UpdateCheckoutSettingsSignature {
+    /**
+     * Updates the site's checkout settings.
+     * @param - Checkout settings to update.
+     */
+    (checkoutSettings: CheckoutSettings): Promise<UpdateCheckoutSettingsResponse>;
+}
+
+declare const getCheckoutSettings: MaybeContext<BuildRESTFunction<typeof getCheckoutSettings$1> & typeof getCheckoutSettings$1>;
+declare const updateCheckoutSettings: MaybeContext<BuildRESTFunction<typeof updateCheckoutSettings$1> & typeof updateCheckoutSettings$1>;
+/**
+ * Triggered when checkout settings are updated.
+ */
+declare const onCheckoutSettingsUpdated: ReturnType<typeof createEventModule<typeof publicOnCheckoutSettingsUpdated>>;
+
+export { CheckoutSettings, GetCheckoutSettingsResponse, UpdateCheckoutSettingsResponse, getCheckoutSettings, onCheckoutSettingsUpdated, updateCheckoutSettings };

package/build/internal/index.d.ts

@@ -0,0 +1,29 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { G as GetCheckoutSettingsResponse, C as CheckoutSettings, U as UpdateCheckoutSettingsResponse } from './ecom-v1-checkout-settings-checkout-settings.universal-DL30mjR_.js';
+export { v as ActionEvent, A as Alignment, B as BaseEventMetadata, e as CheckboxField, f as CheckoutBrand, d as CheckoutFields, g as CheckoutHeader, a as CheckoutPolicies, y as CheckoutSettingsUpdatedEnvelope, b as ContactUsPolicy, c as CustomCheckoutPolicy, n as DeleteCheckoutSettingsRequest, o as DeleteCheckoutSettingsResponse, D as DigitalItemPolicy, p as DomainEvent, q as DomainEventBodyOneOf, E as Empty, r as EntityCreatedEvent, u as EntityDeletedEvent, t as EntityUpdatedEvent, x as EventMetadata, F as FocalPoint, i as GetCheckoutSettingsRequest, m as GiftCardProviderWasProvisioned, I as IdentificationData, w as IdentificationDataIdOneOf, k as ListCheckoutSettingsRequest, l as ListCheckoutSettingsResponse, h as Logo, L as LogoSize, M as MessageEnvelope, P as PrivacyPolicy, s as RestoreInfo, R as ReturnPolicy, T as TermsAndConditionsPolicy, j as UpdateCheckoutSettingsRequest, W as WebhookIdentityType } from './ecom-v1-checkout-settings-checkout-settings.universal-DL30mjR_.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function getCheckoutSettings$1(httpClient: HttpClient): GetCheckoutSettingsSignature;
+interface GetCheckoutSettingsSignature {
+    /**
+     * Retrieves the site's checkout settings.
+     */
+    (): Promise<GetCheckoutSettingsResponse>;
+}
+declare function updateCheckoutSettings$1(httpClient: HttpClient): UpdateCheckoutSettingsSignature;
+interface UpdateCheckoutSettingsSignature {
+    /**
+     * Updates the site's checkout settings.
+     * @param - Checkout settings to update.
+     */
+    (checkoutSettings: CheckoutSettings): Promise<UpdateCheckoutSettingsResponse>;
+}
+
+declare const getCheckoutSettings: MaybeContext<BuildRESTFunction<typeof getCheckoutSettings$1> & typeof getCheckoutSettings$1>;
+declare const updateCheckoutSettings: MaybeContext<BuildRESTFunction<typeof updateCheckoutSettings$1> & typeof updateCheckoutSettings$1>;
+/**
+ * Triggered when checkout settings are updated.
+ */
+declare const onCheckoutSettingsUpdated: ReturnType<typeof createEventModule<typeof publicOnCheckoutSettingsUpdated>>;
+
+export { CheckoutSettings, GetCheckoutSettingsResponse, UpdateCheckoutSettingsResponse, getCheckoutSettings, onCheckoutSettingsUpdated, updateCheckoutSettings };