@wix/ecom 1.0.727 → 1.0.728

package/type-bundles/service-plugins.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;
+}
+
+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>>;
+
+/**
+ * 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 index_d$6_AlreadyRedeemedWixError = AlreadyRedeemedWixError;
+declare const index_d$6_AlreadyRedeemedWixError: typeof AlreadyRedeemedWixError;
+type index_d$6_AlreadyVoidedWixError = AlreadyVoidedWixError;
+declare const index_d$6_AlreadyVoidedWixError: typeof AlreadyVoidedWixError;
+type index_d$6_CurrencyNotSupportedWixError = CurrencyNotSupportedWixError;
+declare const index_d$6_CurrencyNotSupportedWixError: typeof CurrencyNotSupportedWixError;
+type index_d$6_GetBalanceRequest = GetBalanceRequest;
+type index_d$6_GetBalanceResponse = GetBalanceResponse;
+type index_d$6_GiftCardDisabledWixError = GiftCardDisabledWixError;
+declare const index_d$6_GiftCardDisabledWixError: typeof GiftCardDisabledWixError;
+type index_d$6_GiftCardExpiredWixError = GiftCardExpiredWixError;
+declare const index_d$6_GiftCardExpiredWixError: typeof GiftCardExpiredWixError;
+type index_d$6_GiftCardNotFoundWixError = GiftCardNotFoundWixError;
+declare const index_d$6_GiftCardNotFoundWixError: typeof GiftCardNotFoundWixError;
+type index_d$6_GiftCardProviderConfig = GiftCardProviderConfig;
+type index_d$6_GiftCardProviderEntity = GiftCardProviderEntity;
+type index_d$6_InsufficientFundsWixError = InsufficientFundsWixError;
+declare const index_d$6_InsufficientFundsWixError: typeof InsufficientFundsWixError;
+type index_d$6_RedeemRequest = RedeemRequest;
+type index_d$6_RedeemResponse = RedeemResponse;
+type index_d$6_TransactionNotFoundWixError = TransactionNotFoundWixError;
+declare const index_d$6_TransactionNotFoundWixError: typeof TransactionNotFoundWixError;
+type index_d$6_VoidRequest = VoidRequest;
+type index_d$6_VoidResponse = VoidResponse;
+declare namespace index_d$6 {
+  export { index_d$6_AlreadyRedeemedWixError as AlreadyRedeemedWixError, index_d$6_AlreadyVoidedWixError as AlreadyVoidedWixError, type Context$6 as Context, index_d$6_CurrencyNotSupportedWixError as CurrencyNotSupportedWixError, type index_d$6_GetBalanceRequest as GetBalanceRequest, type index_d$6_GetBalanceResponse as GetBalanceResponse, index_d$6_GiftCardDisabledWixError as GiftCardDisabledWixError, index_d$6_GiftCardExpiredWixError as GiftCardExpiredWixError, index_d$6_GiftCardNotFoundWixError as GiftCardNotFoundWixError, type index_d$6_GiftCardProviderConfig as GiftCardProviderConfig, type index_d$6_GiftCardProviderEntity as GiftCardProviderEntity, type IdentificationData$6 as IdentificationData, type IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf, IdentityType$6 as IdentityType, index_d$6_InsufficientFundsWixError as InsufficientFundsWixError, type index_d$6_RedeemRequest as RedeemRequest, type index_d$6_RedeemResponse as RedeemResponse, index_d$6_TransactionNotFoundWixError as TransactionNotFoundWixError, type index_d$6_VoidRequest as VoidRequest, type index_d$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[];
@@ -423,35 +772,6 @@ interface IdentificationDataIdOneOf$5 {
     appId?: string;
 }
 
-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. */
@@ -1593,7 +1913,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 +3390,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 +3812,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 +3895,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 +4057,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$1 as paymentSettings, 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$6 as giftVouchersProvider, index_d$1 as paymentSettings, index_d$5 as shippingRates, index_d as validations };