@wix/payments 1.0.5 → 1.0.7

package/type-bundles/index.bundle.d.ts

@@ -1,3 +1,422 @@
+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;
+}
+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$1;
+    /** Information about completion of attestation form. Include date of signing. */
+    attestationInfo?: AttestationInfo;
+}
+declare enum Status$1 {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    POSSIBLE = "POSSIBLE",
+    CONFIRMED = "CONFIRMED"
+}
+interface AttestationInfo {
+    /**
+     * Date of signing attestation form (only if status is CONFIRMED)
+     * @readonly
+     */
+    attestationFormSignedDate?: Date;
+    /** True, if attestation form was signed. False otherwise. */
+    formSigned?: boolean | null;
+}
+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[];
+}
+declare enum RestrictedGoodsFlowStatus {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    CONFIRMED = "CONFIRMED"
+}
+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"
+}
+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;
+}
+declare enum PartnerFlowStatus {
+    UNDEFINED = "UNDEFINED",
+    DECLINED = "DECLINED",
+    CONFIRMED = "CONFIRMED"
+}
+interface GetOnboardingAvailabilityRequest {
+}
+interface GetOnboardingAvailabilityResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface UpdateCbdFlowRequest {
+    /** New state of CBD flow for merchant. */
+    cbdFlow?: CbdFlow;
+}
+interface UpdateCbdFlowResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface UpdateRestrictedGoodsFlowRequest {
+    /** New state of restricted goods flow for merchant. */
+    restrictedGoods?: RestrictedGoodsFlow;
+}
+interface UpdateRestrictedGoodsFlowResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface UpdatePartnerFlowRequest {
+    /** New state of partner flow for merchant. */
+    partnerFlow?: PartnerFlow;
+}
+interface UpdatePartnerFlowResponse {
+    /** Current state of onboarding availability for the merchant. */
+    onboardingAvailability?: OnboardingAvailability;
+}
+interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
+    createdEvent?: EntityCreatedEvent$1;
+    updatedEvent?: EntityUpdatedEvent$1;
+    deletedEvent?: EntityDeletedEvent$1;
+    actionEvent?: ActionEvent$1;
+    /**
+     * 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;
+    /**
+     * 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 */
+interface DomainEventBodyOneOf$1 {
+    createdEvent?: EntityCreatedEvent$1;
+    updatedEvent?: EntityUpdatedEvent$1;
+    deletedEvent?: EntityDeletedEvent$1;
+    actionEvent?: ActionEvent$1;
+}
+interface EntityCreatedEvent$1 {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date;
+}
+interface EntityUpdatedEvent$1 {
+    /**
+     * 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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent$1 {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+interface ActionEvent$1 {
+    body?: string;
+}
+interface MessageEnvelope$1 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$1;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
+    /** 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$1;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$1 {
+    /** 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;
+}
+declare enum WebhookIdentityType$1 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CbdFlowNonNullableFields {
+    status: Status$1;
+}
+interface RestrictedGoodsFlowNonNullableFields {
+    status: RestrictedGoodsFlowStatus;
+    categories: RestrictedGoodsCategory[];
+}
+interface PartnerFlowNonNullableFields {
+    status: PartnerFlowStatus;
+}
+interface OnboardingAvailabilityNonNullableFields {
+    _id: string;
+    cbdFlow?: CbdFlowNonNullableFields;
+    restrictedGoodsFlow?: RestrictedGoodsFlowNonNullableFields;
+    partnerFlow?: PartnerFlowNonNullableFields;
+    wixPaymentsAvailable: boolean;
+}
+interface GetOnboardingAvailabilityResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+interface UpdateCbdFlowResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+interface UpdateRestrictedGoodsFlowResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+interface UpdatePartnerFlowResponseNonNullableFields {
+    onboardingAvailability?: OnboardingAvailabilityNonNullableFields;
+}
+interface BaseEventMetadata$1 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$1;
+}
+interface EventMetadata$1 extends BaseEventMetadata$1 {
+    /**
+     * 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;
+    /**
+     * 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;
+}
+interface OnboardingAvailabilityCreatedEnvelope {
+    entity: OnboardingAvailability;
+    metadata: EventMetadata$1;
+}
+interface OnboardingAvailabilityUpdatedEnvelope {
+    entity: OnboardingAvailability;
+    metadata: EventMetadata$1;
+}
+interface UpdateCbdFlowOptions {
+    /** New state of CBD flow for merchant. */
+    cbdFlow?: CbdFlow;
+}
+interface UpdateRestrictedGoodsFlowOptions {
+    /** New state of restricted goods flow for merchant. */
+    restrictedGoods?: RestrictedGoodsFlow;
+}
+interface UpdatePartnerFlowOptions {
+    /** New state of partner flow for merchant. */
+    partnerFlow?: PartnerFlow;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const getOnboardingAvailability: ReturnType<typeof createRESTModule$1<typeof publicGetOnboardingAvailability>>;
+declare const updateCbdFlow: ReturnType<typeof createRESTModule$1<typeof publicUpdateCbdFlow>>;
+declare const updateRestrictedGoodsFlow: ReturnType<typeof createRESTModule$1<typeof publicUpdateRestrictedGoodsFlow>>;
+declare const updatePartnerFlow: ReturnType<typeof createRESTModule$1<typeof publicUpdatePartnerFlow>>;
+declare const onOnboardingAvailabilityCreated: ReturnType<typeof createEventModule$1<typeof publicOnOnboardingAvailabilityCreated>>;
+declare const onOnboardingAvailabilityUpdated: ReturnType<typeof createEventModule$1<typeof publicOnOnboardingAvailabilityUpdated>>;
+
+type index_d$1_AttestationInfo = AttestationInfo;
+type index_d$1_CbdFlow = CbdFlow;
+type index_d$1_GetOnboardingAvailabilityRequest = GetOnboardingAvailabilityRequest;
+type index_d$1_GetOnboardingAvailabilityResponse = GetOnboardingAvailabilityResponse;
+type index_d$1_GetOnboardingAvailabilityResponseNonNullableFields = GetOnboardingAvailabilityResponseNonNullableFields;
+type index_d$1_OnboardingAvailability = OnboardingAvailability;
+type index_d$1_OnboardingAvailabilityCreatedEnvelope = OnboardingAvailabilityCreatedEnvelope;
+type index_d$1_OnboardingAvailabilityUpdatedEnvelope = OnboardingAvailabilityUpdatedEnvelope;
+type index_d$1_PartnerFlow = PartnerFlow;
+type index_d$1_PartnerFlowStatus = PartnerFlowStatus;
+declare const index_d$1_PartnerFlowStatus: typeof PartnerFlowStatus;
+type index_d$1_RestoreInfo = RestoreInfo;
+type index_d$1_RestrictedGoodsCategory = RestrictedGoodsCategory;
+declare const index_d$1_RestrictedGoodsCategory: typeof RestrictedGoodsCategory;
+type index_d$1_RestrictedGoodsFlow = RestrictedGoodsFlow;
+type index_d$1_RestrictedGoodsFlowStatus = RestrictedGoodsFlowStatus;
+declare const index_d$1_RestrictedGoodsFlowStatus: typeof RestrictedGoodsFlowStatus;
+type index_d$1_UpdateCbdFlowOptions = UpdateCbdFlowOptions;
+type index_d$1_UpdateCbdFlowRequest = UpdateCbdFlowRequest;
+type index_d$1_UpdateCbdFlowResponse = UpdateCbdFlowResponse;
+type index_d$1_UpdateCbdFlowResponseNonNullableFields = UpdateCbdFlowResponseNonNullableFields;
+type index_d$1_UpdatePartnerFlowOptions = UpdatePartnerFlowOptions;
+type index_d$1_UpdatePartnerFlowRequest = UpdatePartnerFlowRequest;
+type index_d$1_UpdatePartnerFlowResponse = UpdatePartnerFlowResponse;
+type index_d$1_UpdatePartnerFlowResponseNonNullableFields = UpdatePartnerFlowResponseNonNullableFields;
+type index_d$1_UpdateRestrictedGoodsFlowOptions = UpdateRestrictedGoodsFlowOptions;
+type index_d$1_UpdateRestrictedGoodsFlowRequest = UpdateRestrictedGoodsFlowRequest;
+type index_d$1_UpdateRestrictedGoodsFlowResponse = UpdateRestrictedGoodsFlowResponse;
+type index_d$1_UpdateRestrictedGoodsFlowResponseNonNullableFields = UpdateRestrictedGoodsFlowResponseNonNullableFields;
+declare const index_d$1_getOnboardingAvailability: typeof getOnboardingAvailability;
+declare const index_d$1_onOnboardingAvailabilityCreated: typeof onOnboardingAvailabilityCreated;
+declare const index_d$1_onOnboardingAvailabilityUpdated: typeof onOnboardingAvailabilityUpdated;
+declare const index_d$1_updateCbdFlow: typeof updateCbdFlow;
+declare const index_d$1_updatePartnerFlow: typeof updatePartnerFlow;
+declare const index_d$1_updateRestrictedGoodsFlow: typeof updateRestrictedGoodsFlow;
+declare namespace index_d$1 {
+  export { type ActionEvent$1 as ActionEvent, type index_d$1_AttestationInfo as AttestationInfo, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$1_CbdFlow as CbdFlow, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$1_GetOnboardingAvailabilityRequest as GetOnboardingAvailabilityRequest, type index_d$1_GetOnboardingAvailabilityResponse as GetOnboardingAvailabilityResponse, type index_d$1_GetOnboardingAvailabilityResponseNonNullableFields as GetOnboardingAvailabilityResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type index_d$1_OnboardingAvailability as OnboardingAvailability, type index_d$1_OnboardingAvailabilityCreatedEnvelope as OnboardingAvailabilityCreatedEnvelope, type index_d$1_OnboardingAvailabilityUpdatedEnvelope as OnboardingAvailabilityUpdatedEnvelope, type index_d$1_PartnerFlow as PartnerFlow, index_d$1_PartnerFlowStatus as PartnerFlowStatus, type index_d$1_RestoreInfo as RestoreInfo, index_d$1_RestrictedGoodsCategory as RestrictedGoodsCategory, type index_d$1_RestrictedGoodsFlow as RestrictedGoodsFlow, index_d$1_RestrictedGoodsFlowStatus as RestrictedGoodsFlowStatus, Status$1 as Status, type index_d$1_UpdateCbdFlowOptions as UpdateCbdFlowOptions, type index_d$1_UpdateCbdFlowRequest as UpdateCbdFlowRequest, type index_d$1_UpdateCbdFlowResponse as UpdateCbdFlowResponse, type index_d$1_UpdateCbdFlowResponseNonNullableFields as UpdateCbdFlowResponseNonNullableFields, type index_d$1_UpdatePartnerFlowOptions as UpdatePartnerFlowOptions, type index_d$1_UpdatePartnerFlowRequest as UpdatePartnerFlowRequest, type index_d$1_UpdatePartnerFlowResponse as UpdatePartnerFlowResponse, type index_d$1_UpdatePartnerFlowResponseNonNullableFields as UpdatePartnerFlowResponseNonNullableFields, type index_d$1_UpdateRestrictedGoodsFlowOptions as UpdateRestrictedGoodsFlowOptions, type index_d$1_UpdateRestrictedGoodsFlowRequest as UpdateRestrictedGoodsFlowRequest, type index_d$1_UpdateRestrictedGoodsFlowResponse as UpdateRestrictedGoodsFlowResponse, type index_d$1_UpdateRestrictedGoodsFlowResponseNonNullableFields as UpdateRestrictedGoodsFlowResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, index_d$1_getOnboardingAvailability as getOnboardingAvailability, index_d$1_onOnboardingAvailabilityCreated as onOnboardingAvailabilityCreated, index_d$1_onOnboardingAvailabilityUpdated as onOnboardingAvailabilityUpdated, index_d$1_updateCbdFlow as updateCbdFlow, index_d$1_updatePartnerFlow as updatePartnerFlow, index_d$1_updateRestrictedGoodsFlow as updateRestrictedGoodsFlow };
+}
+
 /**
  * A refund a record of an attempt of
  * returning funds for a charge from a merchant to a customer to who has made a purchase.
@@ -612,56 +1031,17 @@ interface UpdateExtendedFieldsOptions {
     namespaceData: Record<string, any> | null;
 }
 
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
-}
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
 
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
-}
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
 
-declare const __metadata: {
-    PACKAGE_NAME: string;
-};
-declare function createRefund(httpClient: HttpClient): (refund: Refund, options?: CreateRefundOptions) => Promise<Refund & RefundNonNullableFields>;
-declare function getRefund(httpClient: HttpClient): (refundId: string) => Promise<Refund & RefundNonNullableFields>;
-declare function queryRefunds(httpClient: HttpClient): () => RefundsQueryBuilder;
-declare function updateExtendedFields(httpClient: HttpClient): (_id: string, namespace: string, options: UpdateExtendedFieldsOptions) => Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
-declare function getRefundability(httpClient: HttpClient): (chargeId: string) => Promise<GetRefundabilityResponse & GetRefundabilityResponseNonNullableFields>;
-declare const onRefundCreated: EventDefinition<RefundCreatedEnvelope, "wix.payments.refunds.v1.refund_created">;
-declare const onRefundUpdated: EventDefinition<RefundUpdatedEnvelope, "wix.payments.refunds.v1.refund_updated">;
+declare const createRefund: ReturnType<typeof createRESTModule<typeof publicCreateRefund>>;
+declare const getRefund: ReturnType<typeof createRESTModule<typeof publicGetRefund>>;
+declare const queryRefunds: ReturnType<typeof createRESTModule<typeof publicQueryRefunds>>;
+declare const updateExtendedFields: ReturnType<typeof createRESTModule<typeof publicUpdateExtendedFields>>;
+declare const getRefundability: ReturnType<typeof createRESTModule<typeof publicGetRefundability>>;
+declare const onRefundCreated: ReturnType<typeof createEventModule<typeof publicOnRefundCreated>>;
+declare const onRefundUpdated: ReturnType<typeof createEventModule<typeof publicOnRefundUpdated>>;
 
 type index_d_ActionEvent = ActionEvent;
 type index_d_BaseEventMetadata = BaseEventMetadata;
@@ -721,7 +1101,6 @@ type index_d_UpdateExtendedFieldsResponse = UpdateExtendedFieldsResponse;
 type index_d_UpdateExtendedFieldsResponseNonNullableFields = UpdateExtendedFieldsResponseNonNullableFields;
 type index_d_WebhookIdentityType = WebhookIdentityType;
 declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
-declare const index_d___metadata: typeof __metadata;
 declare const index_d_createRefund: typeof createRefund;
 declare const index_d_getRefund: typeof getRefund;
 declare const index_d_getRefundability: typeof getRefundability;
@@ -730,7 +1109,7 @@ declare const index_d_onRefundUpdated: typeof onRefundUpdated;
 declare const index_d_queryRefunds: typeof queryRefunds;
 declare const index_d_updateExtendedFields: typeof updateExtendedFields;
 declare namespace index_d {
-  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CreateRefundOptions as CreateRefundOptions, type index_d_CreateRefundRequest as CreateRefundRequest, type index_d_CreateRefundResponse as CreateRefundResponse, type index_d_CreateRefundResponseNonNullableFields as CreateRefundResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_ExtendedFields as ExtendedFields, type index_d_GetRefundRequest as GetRefundRequest, type index_d_GetRefundResponse as GetRefundResponse, type index_d_GetRefundResponseNonNullableFields as GetRefundResponseNonNullableFields, type index_d_GetRefundabilityRequest as GetRefundabilityRequest, type index_d_GetRefundabilityResponse as GetRefundabilityResponse, type index_d_GetRefundabilityResponseNonNullableFields as GetRefundabilityResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_Initiator as Initiator, type index_d_MessageEnvelope as MessageEnvelope, type index_d_QueryRefundsRequest as QueryRefundsRequest, type index_d_QueryRefundsResponse as QueryRefundsResponse, type index_d_QueryRefundsResponseNonNullableFields as QueryRefundsResponseNonNullableFields, type index_d_Refund as Refund, type index_d_RefundCreatedEnvelope as RefundCreatedEnvelope, type index_d_RefundNonNullableFields as RefundNonNullableFields, type index_d_RefundOptions as RefundOptions, type index_d_RefundUpdatedEnvelope as RefundUpdatedEnvelope, type index_d_Refundability as Refundability, type index_d_RefundabilityDetailsOneOf as RefundabilityDetailsOneOf, type index_d_RefundsQueryBuilder as RefundsQueryBuilder, type index_d_RefundsQueryResult as RefundsQueryResult, type index_d_Rejection as Rejection, index_d_RejectionReason as RejectionReason, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_Status as Status, type index_d_StatusInfo as StatusInfo, type index_d_SyncRefundRequest as SyncRefundRequest, type index_d_SyncRefundResponse as SyncRefundResponse, type index_d_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions, type index_d_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest, type index_d_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse, type index_d_UpdateExtendedFieldsResponseNonNullableFields as UpdateExtendedFieldsResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_createRefund as createRefund, index_d_getRefund as getRefund, index_d_getRefundability as getRefundability, index_d_onRefundCreated as onRefundCreated, index_d_onRefundUpdated as onRefundUpdated, index_d_queryRefunds as queryRefunds, index_d_updateExtendedFields as updateExtendedFields };
+  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CreateRefundOptions as CreateRefundOptions, type index_d_CreateRefundRequest as CreateRefundRequest, type index_d_CreateRefundResponse as CreateRefundResponse, type index_d_CreateRefundResponseNonNullableFields as CreateRefundResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_ExtendedFields as ExtendedFields, type index_d_GetRefundRequest as GetRefundRequest, type index_d_GetRefundResponse as GetRefundResponse, type index_d_GetRefundResponseNonNullableFields as GetRefundResponseNonNullableFields, type index_d_GetRefundabilityRequest as GetRefundabilityRequest, type index_d_GetRefundabilityResponse as GetRefundabilityResponse, type index_d_GetRefundabilityResponseNonNullableFields as GetRefundabilityResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_Initiator as Initiator, type index_d_MessageEnvelope as MessageEnvelope, type index_d_QueryRefundsRequest as QueryRefundsRequest, type index_d_QueryRefundsResponse as QueryRefundsResponse, type index_d_QueryRefundsResponseNonNullableFields as QueryRefundsResponseNonNullableFields, type index_d_Refund as Refund, type index_d_RefundCreatedEnvelope as RefundCreatedEnvelope, type index_d_RefundNonNullableFields as RefundNonNullableFields, type index_d_RefundOptions as RefundOptions, type index_d_RefundUpdatedEnvelope as RefundUpdatedEnvelope, type index_d_Refundability as Refundability, type index_d_RefundabilityDetailsOneOf as RefundabilityDetailsOneOf, type index_d_RefundsQueryBuilder as RefundsQueryBuilder, type index_d_RefundsQueryResult as RefundsQueryResult, type index_d_Rejection as Rejection, index_d_RejectionReason as RejectionReason, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_Status as Status, type index_d_StatusInfo as StatusInfo, type index_d_SyncRefundRequest as SyncRefundRequest, type index_d_SyncRefundResponse as SyncRefundResponse, type index_d_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions, type index_d_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest, type index_d_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse, type index_d_UpdateExtendedFieldsResponseNonNullableFields as UpdateExtendedFieldsResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, index_d_createRefund as createRefund, index_d_getRefund as getRefund, index_d_getRefundability as getRefundability, index_d_onRefundCreated as onRefundCreated, index_d_onRefundUpdated as onRefundUpdated, index_d_queryRefunds as queryRefunds, index_d_updateExtendedFields as updateExtendedFields };
 }
 
-export { index_d as refunds };
+export { index_d$1 as onboardingAvailability, index_d as refunds };