@wix/auto_sdk_ecom_memberships 1.0.4 → 1.0.5

package/build/{internal/cjs/src/service-plugins-types.d.ts → index.d.ts}

@@ -1,4 +1,7 @@
-export interface ListEligibleMembershipsRequest {
+import { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';
+import { ServicePluginDefinition } from '@wix/sdk-types';
+
+interface ListEligibleMembershipsRequest {
     /**
      * The line items for which to list eligible memberships.
      * @minSize 1
@@ -20,7 +23,7 @@ export interface ListEligibleMembershipsRequest {
      */
     selectedMemberships?: SelectedMemberships;
 }
-export interface LineItem {
+interface LineItem {
     /**
      * Line item ID.
      * @minLength 1
@@ -43,7 +46,7 @@ export interface LineItem {
     rootCatalogItemId?: string | null;
 }
 /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
-export interface CatalogReference {
+interface CatalogReference {
     /**
      * ID of the item within the catalog it belongs to.
      * @minLength 1
@@ -69,7 +72,7 @@ export interface CatalogReference {
      */
     options?: Record<string, any> | null;
 }
-export interface ServiceProperties {
+interface ServiceProperties {
     /**
      * 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.
@@ -82,14 +85,14 @@ export interface ServiceProperties {
      */
     numberOfParticipants?: number | null;
 }
-export interface SelectedMemberships {
+interface SelectedMemberships {
     /**
      * Selected memberships.
      * @maxSize 300
      */
     memberships?: SelectedMembership[];
 }
-export interface SelectedMembership {
+interface SelectedMembership {
     /**
      * Membership ID.
      * @minLength 1
@@ -105,7 +108,7 @@ export interface SelectedMembership {
      */
     lineItemIds?: string[];
 }
-export interface ListEligibleMembershipsResponse {
+interface ListEligibleMembershipsResponse {
     /**
      * List of memberships that are eligible for the given member and line items.
      * @maxSize 300
@@ -122,7 +125,7 @@ export interface ListEligibleMembershipsResponse {
      */
     selectedMemberships?: SelectedMembership[];
 }
-export interface Membership {
+interface Membership {
     /**
      * Membership ID.
      * @minLength 1
@@ -146,7 +149,7 @@ export interface Membership {
     /** Additional data about this membership. */
     additionalData?: Record<string, any> | null;
 }
-export interface MembershipName {
+interface MembershipName {
     /**
      * Membership name.
      * @maxLength 100
@@ -158,7 +161,7 @@ export interface MembershipName {
      */
     translated?: string | null;
 }
-export interface MembershipPaymentCredits {
+interface MembershipPaymentCredits {
     /**
      * Membership's total amount of credits.
      * @min 1
@@ -167,7 +170,7 @@ export interface MembershipPaymentCredits {
     /** Membership's remaining amount of credits. */
     remaining?: number;
 }
-export interface InvalidMembership {
+interface InvalidMembership {
     /** The membership that is invalid and cannot be used. */
     membership?: Membership;
     /**
@@ -177,14 +180,14 @@ export interface InvalidMembership {
      */
     reason?: string;
 }
-export interface MembershipInvalidSelectionErrors {
+interface MembershipInvalidSelectionErrors {
     /**
      * Error details for invalid memberships.
      * @maxSize 300
      */
     membershipInvalidSelectionErrors?: MembershipInvalidSelectionError[];
 }
-export interface MembershipInvalidSelectionError extends MembershipInvalidSelectionErrorErrorDataOneOf {
+interface MembershipInvalidSelectionError extends MembershipInvalidSelectionErrorErrorDataOneOf {
     /** Line item IDs that were missing. */
     lineItemNotFoundInfo?: LineItemNotFoundInfo;
     /** Error details for line items that cannot be used with this membership. */
@@ -203,7 +206,7 @@ export interface MembershipInvalidSelectionError extends MembershipInvalidSelect
     errorType?: MembershipErrorType;
 }
 /** @oneof */
-export interface MembershipInvalidSelectionErrorErrorDataOneOf {
+interface MembershipInvalidSelectionErrorErrorDataOneOf {
     /** Line item IDs that were missing. */
     lineItemNotFoundInfo?: LineItemNotFoundInfo;
     /** Error details for line items that cannot be used with this membership. */
@@ -214,7 +217,7 @@ export interface MembershipInvalidSelectionErrorErrorDataOneOf {
      */
     membershipSelectionInvalidReason?: string | null;
 }
-export declare enum MembershipErrorType {
+declare enum MembershipErrorType {
     UNKNOWN = "UNKNOWN",
     /** Membership not found. */
     MEMBERSHIP_NOT_FOUND = "MEMBERSHIP_NOT_FOUND",
@@ -225,7 +228,7 @@ export declare enum MembershipErrorType {
     /** The membership can be used for each individual line item, but combining all of them is invalid. */
     MEMBERSHIP_SELECTION_INVALID = "MEMBERSHIP_SELECTION_INVALID"
 }
-export interface LineItemNotFoundInfo {
+interface LineItemNotFoundInfo {
     /**
      * Line item IDs that were missing.
      * @maxSize 300
@@ -234,14 +237,14 @@ export interface LineItemNotFoundInfo {
      */
     lineItemIds?: string[];
 }
-export interface MembershipCannotBeUsedForLineItemsInfo {
+interface MembershipCannotBeUsedForLineItemsInfo {
     /**
      * Line items that cannot be used with this membership, and the reason why.
      * @maxSize 300
      */
     lineItems?: MembershipCannotBeUsedForLineItemInfo[];
 }
-export interface MembershipCannotBeUsedForLineItemInfo {
+interface MembershipCannotBeUsedForLineItemInfo {
     /**
      * Line item ID.
      * @minLength 1
@@ -254,7 +257,7 @@ export interface MembershipCannotBeUsedForLineItemInfo {
      */
     reason?: string;
 }
-export interface ChargeMembershipRequest {
+interface ChargeMembershipRequest {
     /**
      * Member ID.
      *
@@ -296,7 +299,7 @@ export interface ChargeMembershipRequest {
     /** Additional data about this charge. */
     additionalData?: Record<string, any> | null;
 }
-export interface ChargeMembershipResponse {
+interface ChargeMembershipResponse {
     /**
      * The transaction ID for this charge.
      *
@@ -306,7 +309,7 @@ export interface ChargeMembershipResponse {
      */
     transactionId?: string;
 }
-export interface MembershipCannotBeChargedError extends MembershipCannotBeChargedErrorErrorDataOneOf {
+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. */
@@ -317,7 +320,7 @@ export interface MembershipCannotBeChargedError extends MembershipCannotBeCharge
     errorType?: MembershipCannotBeChargedType;
 }
 /** @oneof */
-export interface MembershipCannotBeChargedErrorErrorDataOneOf {
+interface MembershipCannotBeChargedErrorErrorDataOneOf {
     /** Membership is out of credits. For example, 5 are required, but only 4 remain. */
     outOfCredits?: OutOfCredits;
     /** Membership has not become active yet. */
@@ -325,7 +328,7 @@ export interface MembershipCannotBeChargedErrorErrorDataOneOf {
     /** Membership has expired or ended. */
     ended?: Ended;
 }
-export declare enum MembershipCannotBeChargedType {
+declare enum MembershipCannotBeChargedType {
     /** Membership is out of credits. For example, 5 are required, but only 4 remain. */
     OUT_OF_CREDITS = "OUT_OF_CREDITS",
     /** Membership has not become active yet. */
@@ -335,21 +338,21 @@ export declare enum MembershipCannotBeChargedType {
     /** Not applicable for multiple participants. */
     NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS = "NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS"
 }
-export interface OutOfCredits {
+interface OutOfCredits {
     /** Required amount of credits. */
     required?: number;
     /** Remaining amount of credits. */
     remaining?: number;
 }
-export interface NotStartedYet {
+interface NotStartedYet {
     /** Start date of the membership. */
     membershipStartDate?: Date | null;
 }
-export interface Ended {
+interface Ended {
     /** End date of the membership. */
     endDate?: Date | null;
 }
-export interface MembershipAlreadyChargedError {
+interface MembershipAlreadyChargedError {
     /**
      * ID of the transaction that was already used for membership charge.
      * @minLength 1
@@ -357,7 +360,7 @@ export interface MembershipAlreadyChargedError {
      */
     transactionId?: string;
 }
-export interface GetMembershipVoidabilityRequest {
+interface GetMembershipVoidabilityRequest {
     /**
      * Transaction ID to check if it can be voided.
      * @minLength 1
@@ -365,7 +368,7 @@ export interface GetMembershipVoidabilityRequest {
      */
     transactionId: string;
 }
-export interface GetMembershipVoidabilityResponse {
+interface GetMembershipVoidabilityResponse {
     /** Whether the membership charge can be voided. */
     voidable?: boolean;
     /**
@@ -375,7 +378,7 @@ export interface GetMembershipVoidabilityResponse {
      */
     reason?: string | null;
 }
-export interface VoidMembershipChargeRequest {
+interface VoidMembershipChargeRequest {
     /**
      * Transaction ID to void.
      * @minLength 1
@@ -383,9 +386,9 @@ export interface VoidMembershipChargeRequest {
      */
     transactionId: string;
 }
-export interface VoidMembershipChargeResponse {
+interface VoidMembershipChargeResponse {
 }
-export interface MembershipsSPIConfig {
+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/.
@@ -413,7 +416,7 @@ export interface MembershipsSPIConfig {
  * }
  * ```
  */
-export interface Context {
+interface Context {
     /** 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;
     /**
@@ -431,14 +434,14 @@ export interface Context {
      */
     instanceId?: string | null;
 }
-export declare enum IdentityType {
+declare enum IdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -463,7 +466,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: IdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -485,3 +488,192 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
+
+interface ListEligibleMembershipsEnvelope {
+    request: ListEligibleMembershipsRequest;
+    metadata: Context;
+}
+interface ChargeMembershipEnvelope {
+    request: ChargeMembershipRequest;
+    metadata: Context;
+}
+interface GetMembershipVoidabilityEnvelope {
+    request: GetMembershipVoidabilityRequest;
+    metadata: Context;
+}
+interface VoidMembershipChargeEnvelope {
+    request: VoidMembershipChargeRequest;
+    metadata: Context;
+}
+declare const provideHandlers$1: ServicePluginDefinition<{
+    /**
+     *
+     * 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>;
+}>;
+
+declare const provideHandlers: ReturnType<typeof createServicePluginModule<typeof publicProvideHandlers>>;
+
+/**
+ * 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;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    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;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    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;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    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;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    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;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    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;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    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;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+
+export { type CatalogReference, type ChargeMembershipRequest, type ChargeMembershipResponse, type Context, type Ended, type GetMembershipVoidabilityRequest, type GetMembershipVoidabilityResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type InvalidMembership, InvalidSelectionWixError, type LineItem, type LineItemNotFoundInfo, type ListEligibleMembershipsRequest, type ListEligibleMembershipsResponse, type Membership, type MembershipAlreadyChargedError, MembershipAlreadyChargedWixError, type MembershipCannotBeChargedError, type MembershipCannotBeChargedErrorErrorDataOneOf, MembershipCannotBeChargedType, type MembershipCannotBeUsedForLineItemInfo, type MembershipCannotBeUsedForLineItemsInfo, MembershipCannotBeUsedWixError, MembershipDoesNotApplyToItemWixError, MembershipErrorType, type MembershipInvalidSelectionError, type MembershipInvalidSelectionErrorErrorDataOneOf, type MembershipInvalidSelectionErrors, type MembershipName, type MembershipPaymentCredits, type MembershipsSPIConfig, type NotStartedYet, type OutOfCredits, type SelectedMembership, type SelectedMemberships, type ServiceProperties, TransactionAlreadyVoidedWixError, TransactionCannotBeVoidedWixError, TransactionNotFoundWixError, type VoidMembershipChargeRequest, type VoidMembershipChargeResponse, provideHandlers, provideHandlers$1 as publicProvideHandlers };