export interface CheckoutSettings { /** Checkout policies. */ checkoutPolicies?: CheckoutPolicies; /** Settings that apply to checkout fields and the checkout process. */ checkoutFields?: CheckoutFields; /** Checkout brand settings. */ checkoutBrand?: CheckoutBrand; /** * Date and time the checkout settings were created. * @readonly */ createdDate?: Date | null; /** * Date and time the checkout settings were updated. * @readonly */ updatedDate?: Date | null; } export interface CheckoutPolicies { /** Terms and conditions. */ termsAndConditions?: TermsAndConditionsPolicy; /** Privacy policy. */ privacyPolicy?: PrivacyPolicy; /** Return policy. */ returnPolicy?: ReturnPolicy; /** Digital item policy. */ digitalItemPolicy?: DigitalItemPolicy; /** "Contact us" information. */ contactUs?: ContactUsPolicy; /** Custom policy. */ customPolicy?: CustomCheckoutPolicy; } export interface TermsAndConditionsPolicy { /** * Whether the terms & conditions policy is visible to the customer in the checkout page.

* * Default: `false` */ visible?: boolean | null; /** Terms and conditions policy content. */ content?: string | null; } export interface PrivacyPolicy { /** * Whether the privacy policy is visible to the customer in the checkout page.

* * Default: `false` */ visible?: boolean | null; /** Privacy policy content. */ content?: string | null; } export interface ReturnPolicy { /** * Whether the return policy is visible to the customer in the checkout page.

* * Default: `false` */ visible?: boolean | null; /** Return policy content. */ content?: string | null; } export interface DigitalItemPolicy { /** * Whether the digital item policy is visible to the customer in the checkout page.

* * Default: `false` */ visible?: boolean | null; /** Digital item policy content. */ content?: string | null; } export interface ContactUsPolicy { /** * Whether the contact us policy is visible to the customer in the checkout page.

* * Default: `false` */ visible?: boolean | null; /** Contact us policy content. */ content?: string | null; } export interface CustomCheckoutPolicy { /** * Whether the policy is visible to the customer in the checkout page.

* * Default: `false` */ visible?: boolean | null; /** Policy content. */ content?: string | null; /** Policy title. */ title?: string | null; } export interface CheckoutFields { /** * Subscription checkbox.

* * Defaults: * + `visible`: `false` * + `checkedByDefault`: `false` */ subscriptionCheckbox?: CheckboxField; /** * Policy agreement checkbox.

* * Defaults: * + `visible`: `true` * + `checkedByDefault`: `true` */ policyAgreementCheckbox?: CheckboxField; /** * Whether the ability to redeem a gift card is enabled.

* * Default: `false` */ giftCardRedeemEnabled?: boolean | null; /** * Whether to allow for MIT transactions.

* * Default: `false` */ mitEnabled?: boolean | null; /** * Whether to allow for Auth & Capture transactions.

* * Default: `false` */ delayCaptureEnabled?: boolean | null; /** * Whether to automatically capture the transaction before the authorization expires. * * Default: `true` * >**Note:** this setting is only relevant when `delay_capture_enabled: true`. */ captureBeforeExpiryEnabled?: boolean | null; } export 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 { /** Checkout header. */ header?: CheckoutHeader; } export interface CheckoutHeader { /** * Textual content to be included in the header (e.g. Business Name) * TODO: update maxLength validation once limitation is known */ text?: string | null; /** Specifications for when a logo is included in the header. */ logo?: Logo; /** * Alignment within the header. * * >**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left. */ alignment?: Alignment; /** * Whether to display the 'Checkout' label within the header. * Depending on the locale, the label may be translated. */ displayCheckoutLabel?: boolean | null; } export interface Logo { /** Size of the logo. */ size?: LogoSize; } export interface Image { /** WixMedia image ID. */ id?: string; /** Image URL. */ url?: string; /** * Original image height. * @readonly */ height?: number; /** * Original image width. * @readonly */ width?: number; /** Image alt text. */ altText?: string | null; /** * Image filename. * @readonly */ filename?: string | null; } export interface FocalPoint { /** X-coordinate of the focal point. */ x?: number; /** Y-coordinate of the focal point. */ y?: number; /** crop by height */ height?: number | null; /** crop by width */ width?: number | null; } export declare enum LogoSize { UNKNOWN_LOGO_SIZE = "UNKNOWN_LOGO_SIZE", SMALL = "SMALL", MEDIUM = "MEDIUM", LARGE = "LARGE" } export declare enum Alignment { UNKNOWN_ALIGNMENT = "UNKNOWN_ALIGNMENT", SIDE = "SIDE", CENTER = "CENTER" } export interface GetCheckoutSettingsRequest { } export interface GetCheckoutSettingsResponse { /** Checkout settings. */ checkoutSettings?: CheckoutSettings; } export interface UpdateCheckoutSettingsRequest { /** Checkout settings to update. */ checkoutSettings: CheckoutSettings; } export interface UpdateCheckoutSettingsResponse { /** The updated checkout settings. */ checkoutSettings?: CheckoutSettings; } export interface ListCheckoutSettingsRequest { } export interface ListCheckoutSettingsResponse { /** List of retrieved checkout settings. */ checkoutSettings?: CheckoutSettings[]; } export interface GiftCardProviderWasProvisioned { /** The gift card provider which was installed */ providerAppDefId?: string; providerInstanceId?: string; } export interface Empty { } export interface DeleteCheckoutSettingsRequest { } export interface DeleteCheckoutSettingsResponse { } export interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** * Unique event ID. * Allows clients to ignore duplicate webhooks. */ id?: string; /** * Assumes actions are also always typed to an entity_type * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction */ entityFqdn?: string; /** * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug) * This is although the created/updated/deleted notion is duplication of the oneof types * Example: created/updated/deleted/started/completed/email_opened */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number defining the order of updates to the underlying entity. * For example, given that some entity was updated at 16:00 and than again at 16:01, * it is guaranteed that the sequence number of the second update is strictly higher than the first. * As the consumer, you can use this value to ensure that you handle messages in the correct order. * To do so, you will need to persist this number on your end, and compare the sequence number from the * message against the one you have stored. Given that the stored number is higher, you should ignore the message. */ entityEventSequence?: string | null; } /** @oneof */ export interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } export interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } export interface RestoreInfo { deletedDate?: Date | null; } export 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. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; } export interface EntityDeletedEvent { /** Entity that was deleted */ deletedEntityAsJson?: string | null; } export interface ActionEvent { bodyAsJson?: string; } export interface MessageEnvelope { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; } export interface IdentificationData extends IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; /** @readonly */ identityType?: WebhookIdentityType; } /** @oneof */ export interface IdentificationDataIdOneOf { /** ID of a site visitor that has not logged in to the site. */ anonymousVisitorId?: string; /** ID of a site visitor that has logged in to the site. */ memberId?: string; /** ID of a Wix user (site owner, contributor, etc.). */ wixUserId?: string; /** ID of an app. */ appId?: string; } export declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } interface FocalPointNonNullableFields { x: number; y: number; } interface ImageNonNullableFields { id: string; url: string; height: number; width: number; focalPoint?: FocalPointNonNullableFields; } interface LogoNonNullableFields { image?: ImageNonNullableFields; 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 {};