export interface OnboardingAvailability { /** * ID of this entity * @readonly */ id?: string; /** Information about CBD specific flow. Will have DECLINED status if user is not in United States */ cbdFlow?: CbdFlow; /** Information about all restricted goods user might sell. */ restrictedGoodsFlow?: RestrictedGoodsFlow; /** Information about services Wix Partner sells. */ partnerFlow?: PartnerFlow; /** * True, only if Wix Payments available to user due to the way account was created. False otherwise. * @readonly */ wixPaymentsAvailable?: boolean; } export interface CbdFlow { /** * Current status of CBD flow. * DECLINED - User does not sell CBD (or at least we do not know about it). Any payment service provider can be connected. * POSSIBLE - User possibly sells CBD and we should ask for confirmation. User still can connect Wix Payments. * CONFIRMED - User confirmed to sell CBD and now we should ask to complete attestation form. Only CBD providers can be connected. User can't connect Wix Payments. */ status?: Status; /** Information about completion of attestation form. Include date of signing. */ attestationInfo?: AttestationInfo; } export declare enum Status { UNDEFINED = "UNDEFINED", DECLINED = "DECLINED", POSSIBLE = "POSSIBLE", CONFIRMED = "CONFIRMED" } export interface AttestationInfo { /** * Date of signing attestation form (only if status is CONFIRMED) * @readonly */ attestationFormSignedDate?: Date | null; /** True, if attestation form was signed. False otherwise. */ formSigned?: boolean | null; } export interface RestrictedGoodsFlow { /** * Current status of Restricted Goods flow. * DECLINED - User confirmed that they don't sell any restricted goods. User may connect Wix Payments. * CONFIRMED - User confirmed that they do sell restricted goods. User can't connect Wix Payments. */ status?: RestrictedGoodsFlowStatus; /** Contains detailed list of which restricted categories user sell. */ categories?: RestrictedGoodsCategory[]; } export declare enum RestrictedGoodsFlowStatus { UNDEFINED = "UNDEFINED", DECLINED = "DECLINED", CONFIRMED = "CONFIRMED" } export declare enum RestrictedGoodsCategory { UNDEFINED = "UNDEFINED", TOBACCO_ALCOHOL = "TOBACCO_ALCOHOL", FIREARMS_WEAPONS = "FIREARMS_WEAPONS", ADULT = "ADULT", MEDICAL = "MEDICAL", FINANCIAL = "FINANCIAL", TRAVEL_AGENCIES = "TRAVEL_AGENCIES", GAMBLING_LOTTERIES_SKILL_GAMES = "GAMBLING_LOTTERIES_SKILL_GAMES", BINARY_OPTIONS_CRYPTOCURRENCIES = "BINARY_OPTIONS_CRYPTOCURRENCIES", MARKETPLACES = "MARKETPLACES", OTHER = "OTHER", CBD = "CBD", TOBACCO_E_CIGARETTES = "TOBACCO_E_CIGARETTES", ALCOHOL = "ALCOHOL", NUTRACEUTICALS = "NUTRACEUTICALS", MISLEADING_MARKETING = "MISLEADING_MARKETING", INTELLECTUAL_PROPERTY = "INTELLECTUAL_PROPERTY" } export interface PartnerFlow { /** * Current status of Partner flow. * DECLINED - User sells only approved services and may connect Wix Payments. * CONFIRMED - User sells not approved services and can't connect Wix Payments. */ status?: PartnerFlowStatus; } export declare enum PartnerFlowStatus { UNDEFINED = "UNDEFINED", DECLINED = "DECLINED", CONFIRMED = "CONFIRMED" } export interface GetOnboardingAvailabilityRequest { } export interface GetOnboardingAvailabilityResponse { /** Current state of onboarding availability for the merchant. */ onboardingAvailability?: OnboardingAvailability; } export interface UpdateCbdFlowRequest { /** New state of CBD flow for merchant. */ cbdFlow?: CbdFlow; } export interface UpdateCbdFlowResponse { /** Current state of onboarding availability for the merchant. */ onboardingAvailability?: OnboardingAvailability; } export interface UpdateRestrictedGoodsFlowRequest { /** New state of restricted goods flow for merchant. */ restrictedGoods?: RestrictedGoodsFlow; } export interface UpdateRestrictedGoodsFlowResponse { /** Current state of onboarding availability for the merchant. */ onboardingAvailability?: OnboardingAvailability; } export interface UpdatePartnerFlowRequest { /** New state of partner flow for merchant. */ partnerFlow?: PartnerFlow; } export interface UpdatePartnerFlowResponse { /** Current state of onboarding availability for the merchant. */ onboardingAvailability?: OnboardingAvailability; } 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 CbdFlowNonNullableFields { status: Status; } interface RestrictedGoodsFlowNonNullableFields { status: RestrictedGoodsFlowStatus; categories: RestrictedGoodsCategory[]; } interface PartnerFlowNonNullableFields { status: PartnerFlowStatus; } interface OnboardingAvailabilityNonNullableFields { id: string; cbdFlow?: CbdFlowNonNullableFields; restrictedGoodsFlow?: RestrictedGoodsFlowNonNullableFields; partnerFlow?: PartnerFlowNonNullableFields; wixPaymentsAvailable: boolean; } export interface GetOnboardingAvailabilityResponseNonNullableFields { onboardingAvailability?: OnboardingAvailabilityNonNullableFields; } export interface UpdateCbdFlowResponseNonNullableFields { onboardingAvailability?: OnboardingAvailabilityNonNullableFields; } export interface UpdateRestrictedGoodsFlowResponseNonNullableFields { onboardingAvailability?: OnboardingAvailabilityNonNullableFields; } export interface UpdatePartnerFlowResponseNonNullableFields { onboardingAvailability?: OnboardingAvailabilityNonNullableFields; } export {};