@wix/ecom 1.0.782 → 1.0.784

package/type-bundles/service-plugins.bundle.d.ts

@@ -86,26 +86,26 @@ interface GiftCardProviderConfig {
  * }
  * ```
  */
-interface Context$7 {
+interface Context$8 {
     /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
     requestId?: string | null;
     /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
     currency?: string | null;
     /** An object that describes the identity that triggered this request. */
-    identity?: IdentificationData$7;
+    identity?: IdentificationData$8;
     /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
     languages?: string[];
     /** The service provider app's instance ID. */
     instanceId?: string | null;
 }
-declare enum IdentityType$7 {
+declare enum IdentityType$8 {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {
+interface IdentificationData$8 extends IdentificationDataIdOneOf$8 {
     /** 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. */
@@ -115,10 +115,10 @@ interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {
     /** ID of an app. */
     appId?: string;
     /** @readonly */
-    identityType?: IdentityType$7;
+    identityType?: IdentityType$8;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf$7 {
+interface IdentificationDataIdOneOf$8 {
     /** 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. */
@@ -129,26 +129,26 @@ interface IdentificationDataIdOneOf$7 {
     appId?: string;
 }
 
-type ServicePluginMethodInput$8 = {
+type ServicePluginMethodInput$9 = {
     request: any;
     metadata: any;
 };
-type ServicePluginContract$8 = Record<string, (payload: ServicePluginMethodInput$8) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata$8 = {
+type ServicePluginContract$9 = Record<string, (payload: ServicePluginMethodInput$9) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata$9 = {
     name: string;
     primaryHttpMappingPath: string;
     transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput$8;
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput$9;
         toREST: (...args: unknown[]) => unknown;
     };
 };
-type ServicePluginDefinition$8<Contract extends ServicePluginContract$8> = {
+type ServicePluginDefinition$9<Contract extends ServicePluginContract$9> = {
     __type: 'service-plugin-definition';
     componentType: string;
-    methods: ServicePluginMethodMetadata$8[];
+    methods: ServicePluginMethodMetadata$9[];
     __contract: Contract;
 };
-declare function ServicePluginDefinition$8<Contract extends ServicePluginContract$8>(componentType: string, methods: ServicePluginMethodMetadata$8[]): ServicePluginDefinition$8<Contract>;
+declare function ServicePluginDefinition$9<Contract extends ServicePluginContract$9>(componentType: string, methods: ServicePluginMethodMetadata$9[]): ServicePluginDefinition$9<Contract>;
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -164,17 +164,17 @@ declare global {
 
 interface GetBalanceEnvelope {
     request: GetBalanceRequest;
-    metadata: Context$7;
+    metadata: Context$8;
 }
 interface RedeemEnvelope {
     request: RedeemRequest;
-    metadata: Context$7;
+    metadata: Context$8;
 }
 interface _voidEnvelope {
     request: VoidRequest;
-    metadata: Context$7;
+    metadata: Context$8;
 }
-declare const provideHandlers$f: ServicePluginDefinition$8<{
+declare const provideHandlers$h: ServicePluginDefinition$9<{
     /**
      *
      * This method retrieves gift card data from your app.
@@ -192,27 +192,27 @@ declare const provideHandlers$f: ServicePluginDefinition$8<{
     _void(payload: _voidEnvelope): VoidResponse | Promise<VoidResponse>;
 }>;
 
-type ServicePluginMethodInput$7 = {
+type ServicePluginMethodInput$8 = {
     request: any;
     metadata: any;
 };
-type ServicePluginContract$7 = Record<string, (payload: ServicePluginMethodInput$7) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata$7 = {
+type ServicePluginContract$8 = Record<string, (payload: ServicePluginMethodInput$8) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata$8 = {
     name: string;
     primaryHttpMappingPath: string;
     transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput$7;
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput$8;
         toREST: (...args: unknown[]) => unknown;
     };
 };
-type ServicePluginDefinition$7<Contract extends ServicePluginContract$7> = {
+type ServicePluginDefinition$8<Contract extends ServicePluginContract$8> = {
     __type: 'service-plugin-definition';
     componentType: string;
-    methods: ServicePluginMethodMetadata$7[];
+    methods: ServicePluginMethodMetadata$8[];
     __contract: Contract;
 };
-declare function ServicePluginDefinition$7<Contract extends ServicePluginContract$7>(componentType: string, methods: ServicePluginMethodMetadata$7[]): ServicePluginDefinition$7<Contract>;
-type BuildServicePluginDefinition$7<T extends ServicePluginDefinition$7<any>> = (implementation: T['__contract']) => void;
+declare function ServicePluginDefinition$8<Contract extends ServicePluginContract$8>(componentType: string, methods: ServicePluginMethodMetadata$8[]): ServicePluginDefinition$8<Contract>;
+type BuildServicePluginDefinition$8<T extends ServicePluginDefinition$8<any>> = (implementation: T['__contract']) => void;
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -221,10 +221,10 @@ declare global {
 	}
 }
 
-declare function createServicePluginModule$7<T extends ServicePluginDefinition$7<any>>(servicePluginDefinition: T): BuildServicePluginDefinition$7<T> & T;
+declare function createServicePluginModule$8<T extends ServicePluginDefinition$8<any>>(servicePluginDefinition: T): BuildServicePluginDefinition$8<T> & T;
 
-type _publicProvideHandlersType$7 = typeof provideHandlers$f;
-declare const provideHandlers$e: ReturnType<typeof createServicePluginModule$7<_publicProvideHandlersType>>;
+type _publicProvideHandlersType$8 = typeof provideHandlers$h;
+declare const provideHandlers$g: ReturnType<typeof createServicePluginModule$8<_publicProvideHandlersType>>;
 
 /**
  * Gift card not found
@@ -325,7 +325,7 @@ declare class CurrencyNotSupportedWixError extends Error {
 /**
  * Transaction not found.
  */
-declare class TransactionNotFoundWixError extends Error {
+declare class TransactionNotFoundWixError$1 extends Error {
     /** @hidden */
     httpCode: number;
     /** @hidden */
@@ -355,32 +355,599 @@ declare class AlreadyVoidedWixError extends Error {
     static readonly __type = "wix_spi_error";
 }
 
-type index_d$7_AlreadyRedeemedWixError = AlreadyRedeemedWixError;
-declare const index_d$7_AlreadyRedeemedWixError: typeof AlreadyRedeemedWixError;
-type index_d$7_AlreadyVoidedWixError = AlreadyVoidedWixError;
-declare const index_d$7_AlreadyVoidedWixError: typeof AlreadyVoidedWixError;
-type index_d$7_CurrencyNotSupportedWixError = CurrencyNotSupportedWixError;
-declare const index_d$7_CurrencyNotSupportedWixError: typeof CurrencyNotSupportedWixError;
-type index_d$7_GetBalanceRequest = GetBalanceRequest;
-type index_d$7_GetBalanceResponse = GetBalanceResponse;
-type index_d$7_GiftCardDisabledWixError = GiftCardDisabledWixError;
-declare const index_d$7_GiftCardDisabledWixError: typeof GiftCardDisabledWixError;
-type index_d$7_GiftCardExpiredWixError = GiftCardExpiredWixError;
-declare const index_d$7_GiftCardExpiredWixError: typeof GiftCardExpiredWixError;
-type index_d$7_GiftCardNotFoundWixError = GiftCardNotFoundWixError;
-declare const index_d$7_GiftCardNotFoundWixError: typeof GiftCardNotFoundWixError;
-type index_d$7_GiftCardProviderConfig = GiftCardProviderConfig;
-type index_d$7_GiftCardProviderEntity = GiftCardProviderEntity;
-type index_d$7_InsufficientFundsWixError = InsufficientFundsWixError;
-declare const index_d$7_InsufficientFundsWixError: typeof InsufficientFundsWixError;
-type index_d$7_RedeemRequest = RedeemRequest;
-type index_d$7_RedeemResponse = RedeemResponse;
+type index_d$8_AlreadyRedeemedWixError = AlreadyRedeemedWixError;
+declare const index_d$8_AlreadyRedeemedWixError: typeof AlreadyRedeemedWixError;
+type index_d$8_AlreadyVoidedWixError = AlreadyVoidedWixError;
+declare const index_d$8_AlreadyVoidedWixError: typeof AlreadyVoidedWixError;
+type index_d$8_CurrencyNotSupportedWixError = CurrencyNotSupportedWixError;
+declare const index_d$8_CurrencyNotSupportedWixError: typeof CurrencyNotSupportedWixError;
+type index_d$8_GetBalanceRequest = GetBalanceRequest;
+type index_d$8_GetBalanceResponse = GetBalanceResponse;
+type index_d$8_GiftCardDisabledWixError = GiftCardDisabledWixError;
+declare const index_d$8_GiftCardDisabledWixError: typeof GiftCardDisabledWixError;
+type index_d$8_GiftCardExpiredWixError = GiftCardExpiredWixError;
+declare const index_d$8_GiftCardExpiredWixError: typeof GiftCardExpiredWixError;
+type index_d$8_GiftCardNotFoundWixError = GiftCardNotFoundWixError;
+declare const index_d$8_GiftCardNotFoundWixError: typeof GiftCardNotFoundWixError;
+type index_d$8_GiftCardProviderConfig = GiftCardProviderConfig;
+type index_d$8_GiftCardProviderEntity = GiftCardProviderEntity;
+type index_d$8_InsufficientFundsWixError = InsufficientFundsWixError;
+declare const index_d$8_InsufficientFundsWixError: typeof InsufficientFundsWixError;
+type index_d$8_RedeemRequest = RedeemRequest;
+type index_d$8_RedeemResponse = RedeemResponse;
+type index_d$8_VoidRequest = VoidRequest;
+type index_d$8_VoidResponse = VoidResponse;
+declare namespace index_d$8 {
+  export { index_d$8_AlreadyRedeemedWixError as AlreadyRedeemedWixError, index_d$8_AlreadyVoidedWixError as AlreadyVoidedWixError, type Context$8 as Context, index_d$8_CurrencyNotSupportedWixError as CurrencyNotSupportedWixError, type index_d$8_GetBalanceRequest as GetBalanceRequest, type index_d$8_GetBalanceResponse as GetBalanceResponse, index_d$8_GiftCardDisabledWixError as GiftCardDisabledWixError, index_d$8_GiftCardExpiredWixError as GiftCardExpiredWixError, index_d$8_GiftCardNotFoundWixError as GiftCardNotFoundWixError, type index_d$8_GiftCardProviderConfig as GiftCardProviderConfig, type index_d$8_GiftCardProviderEntity as GiftCardProviderEntity, type IdentificationData$8 as IdentificationData, type IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf, IdentityType$8 as IdentityType, index_d$8_InsufficientFundsWixError as InsufficientFundsWixError, type index_d$8_RedeemRequest as RedeemRequest, type index_d$8_RedeemResponse as RedeemResponse, TransactionNotFoundWixError$1 as TransactionNotFoundWixError, type index_d$8_VoidRequest as VoidRequest, type index_d$8_VoidResponse as VoidResponse, type _publicProvideHandlersType$8 as _publicProvideHandlersType, provideHandlers$g as provideHandlers, provideHandlers$h as publicProvideHandlers };
+}
+
+interface ListEligibleMembershipsRequest {
+    /** The line items for which to list eligible memberships. */
+    lineItems: LineItem$5[];
+    /**
+     * Member ID.
+     *
+     * Do not retrieve this from the request context. In some cases the caller is not a member, but a user who is using the membership on behalf of a member.
+     */
+    memberId: string;
+    /**
+     * The selected payment memberships and which line items they apply to.
+     *
+     * When not provided, your implementation is expected to return the default selection.
+     * When provided, your implementation is expected to validate and return it.
+     */
+    selectedMemberships?: SelectedMemberships$1;
+}
+interface LineItem$5 {
+    /** Line item ID. */
+    _id?: string;
+    /** Catalog and item reference info. */
+    catalogReference?: CatalogReference$7;
+    /** Properties of the service. When relevant, contains information such as date and number of participants. */
+    serviceProperties?: ServiceProperties$1;
+    /**
+     * Root catalog item ID.
+     *
+     * The value will usually be the same as `catalogReference.catalogItemId`.
+     * In cases when these are not the same, this field will return the actual ID of the item in the catalog.
+     * For example, for Wix bookings, the value of `catalogReference.catalogItemId` is the booking ID, but `rootCatalogItemId` is set to the service ID.
+     */
+    rootCatalogItemId?: string | null;
+}
+/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
+interface CatalogReference$7 {
+    /** ID of the item within the catalog it belongs to. */
+    catalogItemId?: string;
+    /**
+     * ID of the app providing the catalog.
+     *
+     * You can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).
+     *
+     * For items from Wix catalogs, the following values always apply:
+     * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
+     * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
+     * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     */
+    appId?: string;
+    /**
+     * Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
+     *
+     * For products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration).
+     */
+    options?: Record<string, any> | null;
+}
+interface ServiceProperties$1 {
+    /**
+     * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * For example, the start time of a class.
+     */
+    scheduledDate?: Date;
+    /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
+    numberOfParticipants?: number | null;
+}
+interface SelectedMemberships$1 {
+    /** Selected memberships. */
+    memberships?: SelectedMembership$1[];
+}
+interface SelectedMembership$1 {
+    /** Membership ID. */
+    _id?: string;
+    /** IDs of the line items this membership applies to. */
+    lineItemIds?: string[];
+}
+interface ListEligibleMembershipsResponse {
+    /** List of memberships that are eligible for the given member and line items. */
+    eligibleMemberships?: Membership$1[];
+    /** List of memberships owned by the member, but cannot be used due to the reason provided. */
+    invalidMemberships?: InvalidMembership$1[];
+    /** List of selected memberships and which line items they apply to. */
+    selectedMemberships?: SelectedMembership$1[];
+}
+interface Membership$1 {
+    /** Membership ID. */
+    _id?: string;
+    /** Membership name. */
+    name?: MembershipName$1;
+    /** Line item IDs this membership applies to. */
+    lineItemIds?: string[];
+    /** Total and remaining membership credits. */
+    credits?: MembershipPaymentCredits$1;
+    /** Membership expiration date. */
+    expirationDate?: Date;
+    /** Additional data about this membership. */
+    additionalData?: Record<string, any> | null;
+}
+interface MembershipName$1 {
+    /** Membership name. */
+    original?: string;
+    /** Translated membership name. Defaults to `original` when not provided. */
+    translated?: string | null;
+}
+interface MembershipPaymentCredits$1 {
+    /** Membership's total amount of credits. */
+    total?: number;
+    /** Membership's remaining amount of credits. */
+    remaining?: number;
+}
+interface InvalidMembership$1 {
+    /** The membership that is invalid and cannot be used. */
+    membership?: Membership$1;
+    /** Reason why this membership is invalid. */
+    reason?: string;
+}
+interface MembershipInvalidSelectionErrors {
+    /** Error details for invalid memberships. */
+    membershipInvalidSelectionErrors?: MembershipInvalidSelectionError[];
+}
+interface MembershipInvalidSelectionError extends MembershipInvalidSelectionErrorErrorDataOneOf {
+    /** Line item IDs that were missing. */
+    lineItemNotFoundInfo?: LineItemNotFoundInfo;
+    /** Error details for line items that cannot be used with this membership. */
+    membershipCannotBeUsedForLineItemsInfo?: MembershipCannotBeUsedForLineItemsInfo;
+    /** Reason why this membership selection is invalid. */
+    membershipSelectionInvalidReason?: string | null;
+    /** Membership ID. */
+    membershipId?: string;
+    /**
+     * Error type.
+     *
+     * + MEMBERSHIP_NOT_FOUND: Membership not found.
+     * + LINE_ITEM_NOT_FOUND: The selection points to a line item ID that wasn't provided.
+     * + MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS: The membership cannot be used for the specific line items provided.
+     * + MEMBERSHIP_SELECTION_INVALID: The membership can be used for each individual line item, but combining all of them is invalid.
+     */
+    errorType?: MembershipErrorType;
+}
+/** @oneof */
+interface MembershipInvalidSelectionErrorErrorDataOneOf {
+    /** Line item IDs that were missing. */
+    lineItemNotFoundInfo?: LineItemNotFoundInfo;
+    /** Error details for line items that cannot be used with this membership. */
+    membershipCannotBeUsedForLineItemsInfo?: MembershipCannotBeUsedForLineItemsInfo;
+    /** Reason why this membership selection is invalid. */
+    membershipSelectionInvalidReason?: string | null;
+}
+declare enum MembershipErrorType {
+    UNKNOWN = "UNKNOWN",
+    MEMBERSHIP_NOT_FOUND = "MEMBERSHIP_NOT_FOUND",
+    /** which line item ids */
+    LINE_ITEM_NOT_FOUND = "LINE_ITEM_NOT_FOUND",
+    /** which ids and why */
+    MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS = "MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS",
+    /** reason */
+    MEMBERSHIP_SELECTION_INVALID = "MEMBERSHIP_SELECTION_INVALID"
+}
+interface LineItemNotFoundInfo {
+    /** Line item IDs that were missing. */
+    lineItemIds?: string[];
+}
+interface MembershipCannotBeUsedForLineItemsInfo {
+    /** Line items that cannot be used with this membership, and the reason why. */
+    lineItems?: MembershipCannotBeUsedForLineItemInfo[];
+}
+interface MembershipCannotBeUsedForLineItemInfo {
+    /** Line item ID. */
+    lineItemId?: string;
+    /** Reason why this line item cannot be used with this membership. */
+    reason?: string;
+}
+interface ChargeMembershipRequest {
+    /**
+     * Member ID.
+     *
+     * Do not retrieve this from the request context. In some cases the caller is not a member, but a user who is using the membership on behalf of a member.
+     */
+    memberId: string;
+    /** Membership ID, as returned from the List Eligible Memberships call. */
+    membershipId: string;
+    /**
+     * Idempotency key to avoid duplicate charge.
+     * The value will usually would be the same as `membershipId` + `orderId` + `rootCatalogItemId`.
+     */
+    idempotencyKey: string;
+    /**
+     * Service properties.
+     *
+     * When relevant, this contains information such as date and number of participants.
+     */
+    serviceProperties?: ServiceProperties$1;
+    /** Catalog and item reference info. */
+    catalogReference: CatalogReference$7;
+    /**
+     * Root catalog item ID.
+     *
+     * The value will usually be the same as `catalogReference.catalogItemId`.
+     * In cases when these are not the same, this field will return the actual ID of the item in the catalog.
+     * For example, for Wix bookings, the value of `catalogReference.catalogItemId` is the booking ID, but `rootCatalogItemId` is set to the service ID.
+     */
+    rootCatalogItemId?: string | null;
+    /** Additional data about this charge. */
+    additionalData?: Record<string, any> | null;
+}
+interface ChargeMembershipResponse {
+    /**
+     * The transaction ID for this charge.
+     *
+     * Use this ID to void the charge.
+     */
+    transactionId?: string;
+}
+interface MembershipCannotBeChargedError extends MembershipCannotBeChargedErrorErrorDataOneOf {
+    /** Membership is out of credits. For example, 5 are required, but only 4 remain. */
+    outOfCredits?: OutOfCredits;
+    /** Membership has not become active yet. */
+    notStartedYet?: NotStartedYet;
+    /** Membership has expired or ended. */
+    ended?: Ended;
+    /** Error type. */
+    errorType?: MembershipCannotBeChargedType;
+}
+/** @oneof */
+interface MembershipCannotBeChargedErrorErrorDataOneOf {
+    /** Membership is out of credits. For example, 5 are required, but only 4 remain. */
+    outOfCredits?: OutOfCredits;
+    /** Membership has not become active yet. */
+    notStartedYet?: NotStartedYet;
+    /** Membership has expired or ended. */
+    ended?: Ended;
+}
+declare enum MembershipCannotBeChargedType {
+    OUT_OF_CREDITS = "OUT_OF_CREDITS",
+    NOT_STARTED_YET = "NOT_STARTED_YET",
+    ENDED = "ENDED",
+    NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS = "NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS"
+}
+interface OutOfCredits {
+    /** Required amount of credits. */
+    required?: number;
+    /** Remaining amount of credits. */
+    remaining?: number;
+}
+interface NotStartedYet {
+    /** Start date of the membership. */
+    membershipStartDate?: Date;
+}
+interface Ended {
+    /** End date of the membership. */
+    endDate?: Date;
+}
+interface MembershipAlreadyChargedError {
+    /** ID of the transaction that was already used for membership charge. */
+    transactionId?: string;
+}
+interface GetMembershipVoidabilityRequest {
+    /** Transaction ID to check if it can be voided. */
+    transactionId: string;
+}
+interface GetMembershipVoidabilityResponse {
+    /** Whether the membership charge can be voided. */
+    voidable?: boolean;
+    /** Reason why the membership charge cannot be voided. */
+    reason?: string | null;
+}
+interface VoidMembershipChargeRequest {
+    /** Transaction ID to void. */
+    transactionId: string;
+}
+interface VoidMembershipChargeResponse {
+}
+interface MembershipsSPIConfig {
+    /**
+     * The base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI.
+     * For example, to call the Charge Membership endpoint at https://my-memberships.com/v1/charge-membership, the base URI you provide here is https://my-memberships.com/.
+     */
+    deploymentUri?: string;
+    /** The app IDs of the catalogs your app supports. */
+    catalogAppDefIds?: string[];
+}
+/**
+ * this message is not directly used by any service,
+ * it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+ * e.g. SPIs, event-handlers, etc..
+ * NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+ *
+ * Example:
+ * ```typescript
+ * export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+ * ...
+ * }
+ * ```
+ */
+interface Context$7 {
+    /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
+    requestId?: string | null;
+    /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */
+    currency?: string | null;
+    /** An object that describes the identity that triggered this request. */
+    identity?: IdentificationData$7;
+    /** A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. */
+    languages?: string[];
+    /** The service provider app's instance ID. */
+    instanceId?: string | null;
+}
+declare enum IdentityType$7 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData$7 extends IdentificationDataIdOneOf$7 {
+    /** 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?: IdentityType$7;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$7 {
+    /** 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;
+}
+
+interface ListEligibleMembershipsEnvelope {
+    request: ListEligibleMembershipsRequest;
+    metadata: Context$7;
+}
+interface ChargeMembershipEnvelope {
+    request: ChargeMembershipRequest;
+    metadata: Context$7;
+}
+interface GetMembershipVoidabilityEnvelope {
+    request: GetMembershipVoidabilityRequest;
+    metadata: Context$7;
+}
+interface VoidMembershipChargeEnvelope {
+    request: VoidMembershipChargeRequest;
+    metadata: Context$7;
+}
+declare const provideHandlers$f: ServicePluginDefinition$9<{
+    /**
+     *
+     * This method retrieves eligible memberships from your app. */
+    listEligibleMemberships(payload: ListEligibleMembershipsEnvelope): ListEligibleMembershipsResponse | Promise<ListEligibleMembershipsResponse>;
+    /**
+     *
+     * This method requests that a membership be charged by your app. */
+    chargeMembership(payload: ChargeMembershipEnvelope): ChargeMembershipResponse | Promise<ChargeMembershipResponse>;
+    /**
+     *
+     * This method retrieves from your app whether a membership can be voided. */
+    getMembershipVoidability(payload: GetMembershipVoidabilityEnvelope): GetMembershipVoidabilityResponse | Promise<GetMembershipVoidabilityResponse>;
+    /**
+     *
+     * This method requests that a membership charge be voided by your app. */
+    voidMembershipCharge(payload: VoidMembershipChargeEnvelope): VoidMembershipChargeResponse | Promise<VoidMembershipChargeResponse>;
+}>;
+
+type ServicePluginMethodInput$7 = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract$7 = Record<string, (payload: ServicePluginMethodInput$7) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata$7 = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput$7;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition$7<Contract extends ServicePluginContract$7> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata$7[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition$7<Contract extends ServicePluginContract$7>(componentType: string, methods: ServicePluginMethodMetadata$7[]): ServicePluginDefinition$7<Contract>;
+type BuildServicePluginDefinition$7<T extends ServicePluginDefinition$7<any>> = (implementation: T['__contract']) => 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 createServicePluginModule$7<T extends ServicePluginDefinition$7<any>>(servicePluginDefinition: T): BuildServicePluginDefinition$7<T> & T;
+
+type _publicProvideHandlersType$7 = typeof provideHandlers$f;
+declare const provideHandlers$e: ReturnType<typeof createServicePluginModule$7<_publicProvideHandlersType>>;
+
+/**
+ * The provided membership selection is invalid
+ */
+declare class InvalidSelectionWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    /** @hidden */
+    errorSchemaName: string;
+    data: MembershipInvalidSelectionErrors;
+    constructor(data: MembershipInvalidSelectionErrors);
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * The membership was found, but does not apply for the provided item
+ */
+declare class MembershipDoesNotApplyToItemWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * The membership was found, applied to the provided item but cannot be charged. For example because a limited membership doesn't have enough credits
+ */
+declare class MembershipCannotBeUsedWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    /** @hidden */
+    errorSchemaName: string;
+    data: MembershipCannotBeChargedError;
+    constructor(data: MembershipCannotBeChargedError);
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * This charge was already done, per the idempotency key of membershipId + orderId + rootCatalogItemId
+ */
+declare class MembershipAlreadyChargedWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    /** @hidden */
+    errorSchemaName: string;
+    data: MembershipAlreadyChargedError;
+    constructor(data: MembershipAlreadyChargedError);
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Transaction not found
+ */
+declare class TransactionNotFoundWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Transaction exists but cannot be voided
+ */
+declare class TransactionCannotBeVoidedWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Transaction was already voided
+ */
+declare class TransactionAlreadyVoidedWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+
+type index_d$7_ChargeMembershipRequest = ChargeMembershipRequest;
+type index_d$7_ChargeMembershipResponse = ChargeMembershipResponse;
+type index_d$7_Ended = Ended;
+type index_d$7_GetMembershipVoidabilityRequest = GetMembershipVoidabilityRequest;
+type index_d$7_GetMembershipVoidabilityResponse = GetMembershipVoidabilityResponse;
+type index_d$7_InvalidSelectionWixError = InvalidSelectionWixError;
+declare const index_d$7_InvalidSelectionWixError: typeof InvalidSelectionWixError;
+type index_d$7_LineItemNotFoundInfo = LineItemNotFoundInfo;
+type index_d$7_ListEligibleMembershipsRequest = ListEligibleMembershipsRequest;
+type index_d$7_ListEligibleMembershipsResponse = ListEligibleMembershipsResponse;
+type index_d$7_MembershipAlreadyChargedError = MembershipAlreadyChargedError;
+type index_d$7_MembershipAlreadyChargedWixError = MembershipAlreadyChargedWixError;
+declare const index_d$7_MembershipAlreadyChargedWixError: typeof MembershipAlreadyChargedWixError;
+type index_d$7_MembershipCannotBeChargedError = MembershipCannotBeChargedError;
+type index_d$7_MembershipCannotBeChargedErrorErrorDataOneOf = MembershipCannotBeChargedErrorErrorDataOneOf;
+type index_d$7_MembershipCannotBeChargedType = MembershipCannotBeChargedType;
+declare const index_d$7_MembershipCannotBeChargedType: typeof MembershipCannotBeChargedType;
+type index_d$7_MembershipCannotBeUsedForLineItemInfo = MembershipCannotBeUsedForLineItemInfo;
+type index_d$7_MembershipCannotBeUsedForLineItemsInfo = MembershipCannotBeUsedForLineItemsInfo;
+type index_d$7_MembershipCannotBeUsedWixError = MembershipCannotBeUsedWixError;
+declare const index_d$7_MembershipCannotBeUsedWixError: typeof MembershipCannotBeUsedWixError;
+type index_d$7_MembershipDoesNotApplyToItemWixError = MembershipDoesNotApplyToItemWixError;
+declare const index_d$7_MembershipDoesNotApplyToItemWixError: typeof MembershipDoesNotApplyToItemWixError;
+type index_d$7_MembershipErrorType = MembershipErrorType;
+declare const index_d$7_MembershipErrorType: typeof MembershipErrorType;
+type index_d$7_MembershipInvalidSelectionError = MembershipInvalidSelectionError;
+type index_d$7_MembershipInvalidSelectionErrorErrorDataOneOf = MembershipInvalidSelectionErrorErrorDataOneOf;
+type index_d$7_MembershipInvalidSelectionErrors = MembershipInvalidSelectionErrors;
+type index_d$7_MembershipsSPIConfig = MembershipsSPIConfig;
+type index_d$7_NotStartedYet = NotStartedYet;
+type index_d$7_OutOfCredits = OutOfCredits;
+type index_d$7_TransactionAlreadyVoidedWixError = TransactionAlreadyVoidedWixError;
+declare const index_d$7_TransactionAlreadyVoidedWixError: typeof TransactionAlreadyVoidedWixError;
+type index_d$7_TransactionCannotBeVoidedWixError = TransactionCannotBeVoidedWixError;
+declare const index_d$7_TransactionCannotBeVoidedWixError: typeof TransactionCannotBeVoidedWixError;
 type index_d$7_TransactionNotFoundWixError = TransactionNotFoundWixError;
 declare const index_d$7_TransactionNotFoundWixError: typeof TransactionNotFoundWixError;
-type index_d$7_VoidRequest = VoidRequest;
-type index_d$7_VoidResponse = VoidResponse;
+type index_d$7_VoidMembershipChargeRequest = VoidMembershipChargeRequest;
+type index_d$7_VoidMembershipChargeResponse = VoidMembershipChargeResponse;
 declare namespace index_d$7 {
-  export { index_d$7_AlreadyRedeemedWixError as AlreadyRedeemedWixError, index_d$7_AlreadyVoidedWixError as AlreadyVoidedWixError, type Context$7 as Context, index_d$7_CurrencyNotSupportedWixError as CurrencyNotSupportedWixError, type index_d$7_GetBalanceRequest as GetBalanceRequest, type index_d$7_GetBalanceResponse as GetBalanceResponse, index_d$7_GiftCardDisabledWixError as GiftCardDisabledWixError, index_d$7_GiftCardExpiredWixError as GiftCardExpiredWixError, index_d$7_GiftCardNotFoundWixError as GiftCardNotFoundWixError, type index_d$7_GiftCardProviderConfig as GiftCardProviderConfig, type index_d$7_GiftCardProviderEntity as GiftCardProviderEntity, type IdentificationData$7 as IdentificationData, type IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf, IdentityType$7 as IdentityType, index_d$7_InsufficientFundsWixError as InsufficientFundsWixError, type index_d$7_RedeemRequest as RedeemRequest, type index_d$7_RedeemResponse as RedeemResponse, index_d$7_TransactionNotFoundWixError as TransactionNotFoundWixError, type index_d$7_VoidRequest as VoidRequest, type index_d$7_VoidResponse as VoidResponse, type _publicProvideHandlersType$7 as _publicProvideHandlersType, provideHandlers$e as provideHandlers, provideHandlers$f as publicProvideHandlers };
+  export { type CatalogReference$7 as CatalogReference, type index_d$7_ChargeMembershipRequest as ChargeMembershipRequest, type index_d$7_ChargeMembershipResponse as ChargeMembershipResponse, type Context$7 as Context, type index_d$7_Ended as Ended, type index_d$7_GetMembershipVoidabilityRequest as GetMembershipVoidabilityRequest, type index_d$7_GetMembershipVoidabilityResponse as GetMembershipVoidabilityResponse, type IdentificationData$7 as IdentificationData, type IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf, IdentityType$7 as IdentityType, type InvalidMembership$1 as InvalidMembership, index_d$7_InvalidSelectionWixError as InvalidSelectionWixError, type LineItem$5 as LineItem, type index_d$7_LineItemNotFoundInfo as LineItemNotFoundInfo, type index_d$7_ListEligibleMembershipsRequest as ListEligibleMembershipsRequest, type index_d$7_ListEligibleMembershipsResponse as ListEligibleMembershipsResponse, type Membership$1 as Membership, type index_d$7_MembershipAlreadyChargedError as MembershipAlreadyChargedError, index_d$7_MembershipAlreadyChargedWixError as MembershipAlreadyChargedWixError, type index_d$7_MembershipCannotBeChargedError as MembershipCannotBeChargedError, type index_d$7_MembershipCannotBeChargedErrorErrorDataOneOf as MembershipCannotBeChargedErrorErrorDataOneOf, index_d$7_MembershipCannotBeChargedType as MembershipCannotBeChargedType, type index_d$7_MembershipCannotBeUsedForLineItemInfo as MembershipCannotBeUsedForLineItemInfo, type index_d$7_MembershipCannotBeUsedForLineItemsInfo as MembershipCannotBeUsedForLineItemsInfo, index_d$7_MembershipCannotBeUsedWixError as MembershipCannotBeUsedWixError, index_d$7_MembershipDoesNotApplyToItemWixError as MembershipDoesNotApplyToItemWixError, index_d$7_MembershipErrorType as MembershipErrorType, type index_d$7_MembershipInvalidSelectionError as MembershipInvalidSelectionError, type index_d$7_MembershipInvalidSelectionErrorErrorDataOneOf as MembershipInvalidSelectionErrorErrorDataOneOf, type index_d$7_MembershipInvalidSelectionErrors as MembershipInvalidSelectionErrors, type MembershipName$1 as MembershipName, type MembershipPaymentCredits$1 as MembershipPaymentCredits, type index_d$7_MembershipsSPIConfig as MembershipsSPIConfig, type index_d$7_NotStartedYet as NotStartedYet, type index_d$7_OutOfCredits as OutOfCredits, type SelectedMembership$1 as SelectedMembership, type SelectedMemberships$1 as SelectedMemberships, type ServiceProperties$1 as ServiceProperties, index_d$7_TransactionAlreadyVoidedWixError as TransactionAlreadyVoidedWixError, index_d$7_TransactionCannotBeVoidedWixError as TransactionCannotBeVoidedWixError, index_d$7_TransactionNotFoundWixError as TransactionNotFoundWixError, type index_d$7_VoidMembershipChargeRequest as VoidMembershipChargeRequest, type index_d$7_VoidMembershipChargeResponse as VoidMembershipChargeResponse, type _publicProvideHandlersType$7 as _publicProvideHandlersType, provideHandlers$e as provideHandlers, provideHandlers$f as publicProvideHandlers };
 }
 
 /** additional information can be passed via aspects, for example GEO */
@@ -523,7 +1090,7 @@ interface GetRecommendationsEnvelope {
     request: GetRecommendationsRequest;
     metadata: Context$6;
 }
-declare const provideHandlers$d: ServicePluginDefinition$8<{
+declare const provideHandlers$d: ServicePluginDefinition$9<{
     /**
      *
      * Returns lists of items recommended by each requested algorithm.
@@ -1063,7 +1630,7 @@ interface GetShippingRatesEnvelope {
     request: GetShippingRatesRequest;
     metadata: Context$5;
 }
-declare const provideHandlers$b: ServicePluginDefinition$8<{
+declare const provideHandlers$b: ServicePluginDefinition$9<{
     /**
      *
      * This method retrieves applicable shipping rates for a delivery from your app.
@@ -1623,7 +2190,7 @@ interface CalculateAdditionalFeesEnvelope {
     request: CalculateAdditionalFeesRequest;
     metadata: Context$4;
 }
-declare const provideHandlers$9: ServicePluginDefinition$8<{
+declare const provideHandlers$9: ServicePluginDefinition$9<{
     /**
      *
      * This method retrieves additional fees calculated by your app.
@@ -1825,7 +2392,7 @@ interface GetEligibleTriggersEnvelope {
     request: GetEligibleTriggersRequest;
     metadata: Context$3;
 }
-declare const provideHandlers$7: ServicePluginDefinition$8<{
+declare const provideHandlers$7: ServicePluginDefinition$9<{
     /**
      *
      * Lists all custom triggers provided by your service plugin integration.
@@ -2094,7 +2661,7 @@ interface GetEligibleDiscountsEnvelope {
     request: GetEligibleDiscountsRequest;
     metadata: Context$2;
 }
-declare const provideHandlers$5: ServicePluginDefinition$8<{
+declare const provideHandlers$5: ServicePluginDefinition$9<{
     /**
      *
      * Wix calls this method when certain actions are performed on the cart or checkout.
@@ -5013,7 +5580,7 @@ interface GetPaymentSettingsForCheckoutEnvelope {
     request: GetPaymentSettingsForCheckoutRequest;
     metadata: Context$1;
 }
-declare const provideHandlers$3: ServicePluginDefinition$8<{
+declare const provideHandlers$3: ServicePluginDefinition$9<{
     /**
      *
      * This method retrieves payment settings from your app.
@@ -5902,7 +6469,7 @@ interface GetValidationViolationsEnvelope {
     request: GetValidationViolationsRequest;
     metadata: Context;
 }
-declare const provideHandlers$1: ServicePluginDefinition$8<{
+declare const provideHandlers$1: ServicePluginDefinition$9<{
     /**
      *
      * This method retrieves validation violations from your app.
@@ -6031,4 +6598,4 @@ declare namespace index_d {
   export { type index_d_Address as Address, type index_d_AddressLocation as AddressLocation, type index_d_AddressWithContact as AddressWithContact, type index_d_AppliedDiscount as AppliedDiscount, type index_d_AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOf, type index_d_BuyerDetails as BuyerDetails, type index_d_CatalogReference as CatalogReference, index_d_CheckoutStage as CheckoutStage, type index_d_Context as Context, type index_d_Coupon as Coupon, type index_d_CustomField as CustomField, type index_d_CustomFields as CustomFields, type index_d_Description as Description, type index_d_DiscountRule as DiscountRule, type index_d_DiscountRuleName as DiscountRuleName, index_d_DiscountType as DiscountType, type index_d_ExtendedFields as ExtendedFields, type index_d_ExternalReference as ExternalReference, type index_d_FullAddressContactDetails as FullAddressContactDetails, type index_d_GetValidationViolationsRequest as GetValidationViolationsRequest, type index_d_GetValidationViolationsResponse as GetValidationViolationsResponse, type index_d_GiftCard as GiftCard, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, index_d_IdentityType as IdentityType, type index_d_ItemTaxFullDetails as ItemTaxFullDetails, type index_d_ItemType as ItemType, index_d_ItemTypeItemType as ItemTypeItemType, type index_d_ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOf, index_d_JurisdictionType as JurisdictionType, type index_d_LineItem as LineItem, type index_d_LineItemPricesData as LineItemPricesData, type index_d_MerchantDiscount as MerchantDiscount, type index_d_MultiCurrencyPrice as MultiCurrencyPrice, index_d_NameInLineItem as NameInLineItem, index_d_NameInOther as NameInOther, type index_d_Other as Other, type index_d_PhysicalProperties as PhysicalProperties, type index_d_PriceSummary as PriceSummary, type index_d_ProductName as ProductName, type index_d_SelectedCarrierServiceOption as SelectedCarrierServiceOption, type index_d_SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPrices, index_d_Severity as Severity, type index_d_ShippingInfo as ShippingInfo, index_d_Source as Source, type index_d_SourceInfo as SourceInfo, type index_d_Stage as Stage, type index_d_StageStagesOneOf as StageStagesOneOf, type index_d_StreetAddress as StreetAddress, index_d_SubscriptionFrequency as SubscriptionFrequency, type index_d_SubscriptionOptionInfo as SubscriptionOptionInfo, type index_d_SubscriptionSettings as SubscriptionSettings, type index_d_Target as Target, type index_d_TargetLineItem as TargetLineItem, type index_d_TargetTargetTypeOneOf as TargetTargetTypeOneOf, type index_d_TaxBreakdown as TaxBreakdown, type index_d_Title as Title, type index_d_ValidationInfo as ValidationInfo, type index_d_ValidationsSPIConfig as ValidationsSPIConfig, type index_d_VatId as VatId, index_d_VatType as VatType, type index_d_Violation as Violation, index_d_WeightUnit as WeightUnit, type index_d__publicProvideHandlersType as _publicProvideHandlersType, index_d_provideHandlers as provideHandlers, provideHandlers$1 as publicProvideHandlers };
 }
 
-export { index_d$4 as additionalFees, index_d$3 as customTriggers, index_d$2 as discounts, index_d$7 as giftVouchersProvider, index_d$1 as paymentSettings, index_d$6 as recommendationsProvider, index_d$5 as shippingRates, index_d as validations };
+export { index_d$4 as additionalFees, index_d$3 as customTriggers, index_d$2 as discounts, index_d$8 as giftVouchersProvider, index_d$7 as memberships, index_d$1 as paymentSettings, index_d$6 as recommendationsProvider, index_d$5 as shippingRates, index_d as validations };