@wix/ecom 1.0.727 → 1.0.729

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

@@ -1,3 +1,352 @@
+interface GiftCardProviderEntity {
+    /** Dummy id for docs generation. */
+    _id?: string | null;
+}
+interface GetBalanceRequest {
+    /** Gift card code. */
+    code?: string;
+    /**
+     * App instance ID of the Gift Card provider.
+     * @deprecated App instance ID of the Gift Card provider.
+     * @targetRemovalDate 2025-07-01
+     */
+    appInstanceId?: string;
+    /** The physical location ID. */
+    locationId?: string | null;
+}
+interface GetBalanceResponse {
+    /** Current balance. */
+    balance?: number;
+    /** Currency code. */
+    currencyCode?: string;
+    /** Used for integration and tracking across different platforms. */
+    externalId?: string | null;
+}
+interface RedeemRequest {
+    /** Gift card code. */
+    code?: string;
+    /**
+     * App instance ID of the Gift Card provider.
+     * @deprecated App instance ID of the Gift Card provider.
+     * @targetRemovalDate 2025-07-01
+     */
+    appInstanceId?: string;
+    /** Amount to redeem from the gift card. */
+    amount?: number;
+    /** Order ID the gift card transaction is applied to. */
+    orderId?: string;
+    /** Currency code. */
+    currencyCode?: string;
+    /** Physical location ID. */
+    locationId?: string | null;
+}
+interface RedeemResponse {
+    /** Remaining balance on the Gift Card after the redemption. */
+    remainingBalance?: number;
+    /** Currency code. */
+    currencyCode?: string;
+    /** Transaction ID. */
+    transactionId?: string;
+}
+interface VoidRequest {
+    /**
+     * App instance ID of the Gift Card provider.
+     * @deprecated App instance ID of the Gift Card provider.
+     * @targetRemovalDate 2025-07-01
+     */
+    appInstanceId?: string;
+    /** Transaction ID to void. */
+    transactionId?: string;
+    /** Physical location ID. */
+    locationId?: string | null;
+}
+interface VoidResponse {
+    /** Remaining balance on the Gift Card after voiding the transaction. */
+    remainingBalance?: number;
+    /** Currency code. */
+    currencyCode?: string;
+}
+interface GiftCardProviderConfig {
+    /** Base URI of the SPI implementation. */
+    deploymentUri?: 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$6 {
+    /** 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$6;
+    /** 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$6 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface IdentificationData$6 extends IdentificationDataIdOneOf$6 {
+    /** 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$6;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$6 {
+    /** 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;
+}
+
+/**
+ * Gift card not found
+ */
+declare class GiftCardNotFoundWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Gift card is disabled
+ */
+declare class GiftCardDisabledWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Gift card was expired
+ */
+declare class GiftCardExpiredWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Insufficient funds for redeem
+ */
+declare class InsufficientFundsWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Gift card already redeemed for the given order
+ */
+declare class AlreadyRedeemedWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+/**
+ * Currency code not supported
+ */
+declare class CurrencyNotSupportedWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @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 already voided
+ */
+declare class AlreadyVoidedWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<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;
+	}
+}
+
+interface GetBalanceEnvelope {
+    request: GetBalanceRequest;
+    metadata: Context$6;
+}
+interface RedeemEnvelope {
+    request: RedeemRequest;
+    metadata: Context$6;
+}
+interface _voidEnvelope {
+    request: VoidRequest;
+    metadata: Context$6;
+}
+declare const provideHandlers$d: ServicePluginDefinition<{
+    /**
+     *
+     * This method retrieves gift card data from your app.
+     * Wix calls this method when a customer applies a gift card as a payment method at checkout. */
+    getBalance(payload: GetBalanceEnvelope): GetBalanceResponse | Promise<GetBalanceResponse>;
+    /**
+     *
+     * This method requests that a transaction be created by your app.
+     * Wix calls this method when a customer completes a purchase that includes a gift card as a payment method at checkout. */
+    redeem(payload: RedeemEnvelope): RedeemResponse | Promise<RedeemResponse>;
+    /**
+     *
+     * This method requests that a gift card transaction be voided by your app.
+     * Wix calls this method when a purchase fails after gift card redemption. */
+    _void(payload: _voidEnvelope): VoidResponse | Promise<VoidResponse>;
+}>;
+
+declare function createServicePluginModule$6<T extends ServicePluginDefinition<any>>(servicePluginDefinition: T): BuildServicePluginDefinition<T> & T;
+
+type _publicProvideHandlersType$6 = typeof provideHandlers$d;
+declare const provideHandlers$c: ReturnType<typeof createServicePluginModule$6<_publicProvideHandlersType>>;
+
+type context$6_AlreadyRedeemedWixError = AlreadyRedeemedWixError;
+declare const context$6_AlreadyRedeemedWixError: typeof AlreadyRedeemedWixError;
+type context$6_AlreadyVoidedWixError = AlreadyVoidedWixError;
+declare const context$6_AlreadyVoidedWixError: typeof AlreadyVoidedWixError;
+type context$6_CurrencyNotSupportedWixError = CurrencyNotSupportedWixError;
+declare const context$6_CurrencyNotSupportedWixError: typeof CurrencyNotSupportedWixError;
+type context$6_GetBalanceRequest = GetBalanceRequest;
+type context$6_GetBalanceResponse = GetBalanceResponse;
+type context$6_GiftCardDisabledWixError = GiftCardDisabledWixError;
+declare const context$6_GiftCardDisabledWixError: typeof GiftCardDisabledWixError;
+type context$6_GiftCardExpiredWixError = GiftCardExpiredWixError;
+declare const context$6_GiftCardExpiredWixError: typeof GiftCardExpiredWixError;
+type context$6_GiftCardNotFoundWixError = GiftCardNotFoundWixError;
+declare const context$6_GiftCardNotFoundWixError: typeof GiftCardNotFoundWixError;
+type context$6_GiftCardProviderConfig = GiftCardProviderConfig;
+type context$6_GiftCardProviderEntity = GiftCardProviderEntity;
+type context$6_InsufficientFundsWixError = InsufficientFundsWixError;
+declare const context$6_InsufficientFundsWixError: typeof InsufficientFundsWixError;
+type context$6_RedeemRequest = RedeemRequest;
+type context$6_RedeemResponse = RedeemResponse;
+type context$6_TransactionNotFoundWixError = TransactionNotFoundWixError;
+declare const context$6_TransactionNotFoundWixError: typeof TransactionNotFoundWixError;
+type context$6_VoidRequest = VoidRequest;
+type context$6_VoidResponse = VoidResponse;
+declare namespace context$6 {
+  export { context$6_AlreadyRedeemedWixError as AlreadyRedeemedWixError, context$6_AlreadyVoidedWixError as AlreadyVoidedWixError, type Context$6 as Context, context$6_CurrencyNotSupportedWixError as CurrencyNotSupportedWixError, type context$6_GetBalanceRequest as GetBalanceRequest, type context$6_GetBalanceResponse as GetBalanceResponse, context$6_GiftCardDisabledWixError as GiftCardDisabledWixError, context$6_GiftCardExpiredWixError as GiftCardExpiredWixError, context$6_GiftCardNotFoundWixError as GiftCardNotFoundWixError, type context$6_GiftCardProviderConfig as GiftCardProviderConfig, type context$6_GiftCardProviderEntity as GiftCardProviderEntity, type IdentificationData$6 as IdentificationData, type IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf, IdentityType$6 as IdentityType, context$6_InsufficientFundsWixError as InsufficientFundsWixError, type context$6_RedeemRequest as RedeemRequest, type context$6_RedeemResponse as RedeemResponse, context$6_TransactionNotFoundWixError as TransactionNotFoundWixError, type context$6_VoidRequest as VoidRequest, type context$6_VoidResponse as VoidResponse, type _publicProvideHandlersType$6 as _publicProvideHandlersType, provideHandlers$c as provideHandlers, provideHandlers$d as publicProvideHandlers };
+}
+
 interface GetShippingRatesRequest {
     /** The line items to be shipped. */
     lineItems?: ProductItem[];
@@ -522,35 +871,6 @@ declare class GenericShippingRatesWixError extends Error {
     static readonly __type = "wix_spi_error";
 }
 
-type ServicePluginMethodInput = {
-    request: any;
-    metadata: any;
-};
-type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata = {
-    name: string;
-    primaryHttpMappingPath: string;
-    transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
-        toREST: (...args: unknown[]) => unknown;
-    };
-};
-type ServicePluginDefinition<Contract extends ServicePluginContract> = {
-    __type: 'service-plugin-definition';
-    componentType: string;
-    methods: ServicePluginMethodMetadata[];
-    __contract: Contract;
-};
-declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
-type BuildServicePluginDefinition<T extends ServicePluginDefinition<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;
-	}
-}
-
 interface GetShippingRatesEnvelope {
     request: GetShippingRatesRequest;
     metadata: Context$5;
@@ -636,7 +956,7 @@ interface LineItem$3 {
      * Max: `100000`
      */
     quantity?: number | null;
-    /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. */
+    /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
     catalogReference?: CatalogReference$4;
     /** Item name. */
     productName?: string | null;
@@ -1049,7 +1369,7 @@ interface LineItem$2 {
     quantity?: number | null;
     /**
      * Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info.
-     * This field is empty in the case of a custom line item.
+     * This field may be empty in the case of a custom line item.
      */
     catalogReference?: CatalogReference$3;
     /** Price of a single item. */
@@ -1205,6 +1525,8 @@ interface GetEligibleDiscountsRequest {
     purchaseFlowId?: string | null;
     /** Number of coupons is limited to 1 due to limitations in Checkout. */
     couponCodes?: string[];
+    /** Buyer email */
+    buyerEmail?: string | null;
 }
 interface LineItem$1 {
     /** Line item ID. */
@@ -1593,7 +1915,7 @@ interface OrderLineItem {
     productName?: ProductName$1;
     /**
      * References to the line item's origin catalog.
-     * This field is empty in the case of a custom line item.
+     * This field may be empty in the case of a custom line item.
      */
     catalogReference?: CatalogReference$1;
     /** Line item quantity. */
@@ -3070,11 +3392,6 @@ interface ValidationInfo {
     customFields?: CustomFields;
     /** Applied discounts. */
     appliedDiscounts?: AppliedDiscount[];
-    /**
-     * Used for integration and tracking across different platforms.
-     * Contains external system IDs (e.g., app ID, external ID) to link the purchase flow with other systems.
-     */
-    externalReference?: ExternalReference;
 }
 interface BuyerDetails {
     /** Buyer's email address. */
@@ -3497,9 +3814,15 @@ interface DiscountRuleName {
     translated?: string | null;
 }
 interface ExternalReference {
-    /** ID of the app that associated with the purchase flow. */
+    /**
+     * ID of the app associated with the purchase flow.
+     * For example, the Wix Pay Links app ID.
+     */
     appId?: string;
-    /** Reference to an external system ID, used to link the purchase flow to a specific ID in another system */
+    /**
+     * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
+     * For example, a Wix Pay Link ID.
+     */
     resourceId?: string | null;
 }
 interface ExtendedFields {
@@ -3574,7 +3897,7 @@ interface ValidationsSPIConfig {
     validateInCart?: boolean;
     /**
      * Required. Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
-     * For example, to call the Get Eligible Triggers endpoint at `https://my-validations.com/v1/get-violations`, the base URI you provide here is `https://my-validations.com`.
+     * For example, to call the Get Validation Violations endpoint at `https://my-validations.com/v1/get-violations`, the base URI you provide here is `https://my-validations.com`.
      */
     deploymentUri?: string;
 }
@@ -3736,4 +4059,4 @@ declare namespace context {
   export { type context_Address as Address, type context_AddressLocation as AddressLocation, type context_AddressWithContact as AddressWithContact, type context_AppliedDiscount as AppliedDiscount, type context_AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOf, type context_BuyerDetails as BuyerDetails, type context_CatalogReference as CatalogReference, context_CheckoutStage as CheckoutStage, type context_Context as Context, type context_Coupon as Coupon, type context_CustomField as CustomField, type context_CustomFields as CustomFields, type context_Description as Description, type context_DiscountRule as DiscountRule, type context_DiscountRuleName as DiscountRuleName, context_DiscountType as DiscountType, type context_ExtendedFields as ExtendedFields, type context_ExternalReference as ExternalReference, type context_FullAddressContactDetails as FullAddressContactDetails, type context_GetValidationViolationsRequest as GetValidationViolationsRequest, type context_GetValidationViolationsResponse as GetValidationViolationsResponse, type context_GiftCard as GiftCard, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_ItemTaxFullDetails as ItemTaxFullDetails, type context_ItemType as ItemType, context_ItemTypeItemType as ItemTypeItemType, type context_ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOf, context_JurisdictionType as JurisdictionType, type context_LineItem as LineItem, type context_LineItemPricesData as LineItemPricesData, type context_MerchantDiscount as MerchantDiscount, type context_MultiCurrencyPrice as MultiCurrencyPrice, context_NameInLineItem as NameInLineItem, context_NameInOther as NameInOther, type context_Other as Other, type context_PhysicalProperties as PhysicalProperties, type context_PriceSummary as PriceSummary, type context_ProductName as ProductName, type context_SelectedCarrierServiceOption as SelectedCarrierServiceOption, type context_SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPrices, context_Severity as Severity, type context_ShippingInfo as ShippingInfo, context_Source as Source, type context_SourceInfo as SourceInfo, type context_Stage as Stage, type context_StageStagesOneOf as StageStagesOneOf, type context_StreetAddress as StreetAddress, context_SubscriptionFrequency as SubscriptionFrequency, type context_SubscriptionOptionInfo as SubscriptionOptionInfo, type context_SubscriptionSettings as SubscriptionSettings, type context_Target as Target, type context_TargetLineItem as TargetLineItem, type context_TargetTargetTypeOneOf as TargetTargetTypeOneOf, type context_TaxBreakdown as TaxBreakdown, type context_Title as Title, type context_ValidationInfo as ValidationInfo, type context_ValidationsSPIConfig as ValidationsSPIConfig, type context_VatId as VatId, context_VatType as VatType, type context_Violation as Violation, context_WeightUnit as WeightUnit, type context__publicProvideHandlersType as _publicProvideHandlersType, context_provideHandlers as provideHandlers, provideHandlers$1 as publicProvideHandlers };
 }
 
-export { context$4 as additionalFees, context$3 as customTriggers, context$2 as discounts, context$1 as paymentSettings, context$5 as shippingRates, context as validations };
+export { context$4 as additionalFees, context$3 as customTriggers, context$2 as discounts, context$6 as giftVouchersProvider, context$1 as paymentSettings, context$5 as shippingRates, context as validations };