@wix/auto_sdk_ecom_memberships 1.0.0

package/build/internal/cjs/src/service-plugins-types.d.ts

@@ -0,0 +1,332 @@
+export interface ListEligibleMembershipsRequest {
+    /** The line items for which to list eligible memberships. */
+    lineItems: LineItem[];
+    /**
+     * 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;
+}
+export interface LineItem {
+    /** Line item ID. */
+    _id?: string;
+    /** Catalog and item reference info. */
+    catalogReference?: CatalogReference;
+    /** Properties of the service. When relevant, contains information such as date and number of participants. */
+    serviceProperties?: ServiceProperties;
+    /**
+     * 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. */
+export interface CatalogReference {
+    /** 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 [app dashboard](https://dev.wix.com/dc3/my-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;
+}
+export 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.
+     */
+    scheduledDate?: Date | null;
+    /** 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;
+}
+export interface SelectedMemberships {
+    /** Selected memberships. */
+    memberships?: SelectedMembership[];
+}
+export interface SelectedMembership {
+    /** Membership ID. */
+    _id?: string;
+    /** IDs of the line items this membership applies to. */
+    lineItemIds?: string[];
+}
+export interface ListEligibleMembershipsResponse {
+    /** List of memberships that are eligible for the given member and line items. */
+    eligibleMemberships?: Membership[];
+    /** List of memberships owned by the member, but cannot be used due to the reason provided. */
+    invalidMemberships?: InvalidMembership[];
+    /** List of selected memberships and which line items they apply to. */
+    selectedMemberships?: SelectedMembership[];
+}
+export interface Membership {
+    /** Membership ID. */
+    _id?: string;
+    /** Membership name. */
+    name?: MembershipName;
+    /** Line item IDs this membership applies to. */
+    lineItemIds?: string[];
+    /** Total and remaining membership credits. */
+    credits?: MembershipPaymentCredits;
+    /** Membership expiration date. */
+    expirationDate?: Date | null;
+    /** Additional data about this membership. */
+    additionalData?: Record<string, any> | null;
+}
+export interface MembershipName {
+    /** Membership name. */
+    original?: string;
+    /** Translated membership name. Defaults to `original` when not provided. */
+    translated?: string | null;
+}
+export interface MembershipPaymentCredits {
+    /** Membership's total amount of credits. */
+    total?: number;
+    /** Membership's remaining amount of credits. */
+    remaining?: number;
+}
+export interface InvalidMembership {
+    /** The membership that is invalid and cannot be used. */
+    membership?: Membership;
+    /** Reason why this membership is invalid. */
+    reason?: string;
+}
+export interface MembershipInvalidSelectionErrors {
+    /** Error details for invalid memberships. */
+    membershipInvalidSelectionErrors?: MembershipInvalidSelectionError[];
+}
+export 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. */
+    errorType?: MembershipErrorType;
+}
+/** @oneof */
+export 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;
+}
+export declare enum MembershipErrorType {
+    UNKNOWN = "UNKNOWN",
+    /** Membership not found. */
+    MEMBERSHIP_NOT_FOUND = "MEMBERSHIP_NOT_FOUND",
+    /** The selection points to a line item ID that wasn't provided. */
+    LINE_ITEM_NOT_FOUND = "LINE_ITEM_NOT_FOUND",
+    /** The membership cannot be used for the specific line items provided. */
+    MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS = "MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS",
+    /** 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 {
+    /** Line item IDs that were missing. */
+    lineItemIds?: string[];
+}
+export interface MembershipCannotBeUsedForLineItemsInfo {
+    /** Line items that cannot be used with this membership, and the reason why. */
+    lineItems?: MembershipCannotBeUsedForLineItemInfo[];
+}
+export interface MembershipCannotBeUsedForLineItemInfo {
+    /** Line item ID. */
+    lineItemId?: string;
+    /** Reason why this line item cannot be used with this membership. */
+    reason?: string;
+}
+export 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;
+    /** Catalog and item reference info. */
+    catalogReference: CatalogReference;
+    /**
+     * 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;
+}
+export interface ChargeMembershipResponse {
+    /**
+     * The transaction ID for this charge.
+     *
+     * Use this ID to void the charge.
+     */
+    transactionId?: string;
+}
+export 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 */
+export 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;
+}
+export 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. */
+    NOT_STARTED_YET = "NOT_STARTED_YET",
+    /** Membership has expired or ended. */
+    ENDED = "ENDED",
+    /** Not applicable for multiple participants. */
+    NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS = "NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS"
+}
+export interface OutOfCredits {
+    /** Required amount of credits. */
+    required?: number;
+    /** Remaining amount of credits. */
+    remaining?: number;
+}
+export interface NotStartedYet {
+    /** Start date of the membership. */
+    membershipStartDate?: Date | null;
+}
+export interface Ended {
+    /** End date of the membership. */
+    endDate?: Date | null;
+}
+export interface MembershipAlreadyChargedError {
+    /** ID of the transaction that was already used for membership charge. */
+    transactionId?: string;
+}
+export interface GetMembershipVoidabilityRequest {
+    /** Transaction ID to check if it can be voided. */
+    transactionId: string;
+}
+export interface GetMembershipVoidabilityResponse {
+    /** Whether the membership charge can be voided. */
+    voidable?: boolean;
+    /** Reason why the membership charge cannot be voided. */
+    reason?: string | null;
+}
+export interface VoidMembershipChargeRequest {
+    /** Transaction ID to void. */
+    transactionId: string;
+}
+export interface VoidMembershipChargeResponse {
+}
+export 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) {
+ * ...
+ * }
+ * ```
+ */
+export 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;
+    /** [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;
+    /** 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;
+}
+export declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** 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;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** 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;
+}

package/build/internal/cjs/src/service-plugins-types.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdentityType = exports.MembershipCannotBeChargedType = exports.MembershipErrorType = void 0;
+var MembershipErrorType;
+(function (MembershipErrorType) {
+    MembershipErrorType["UNKNOWN"] = "UNKNOWN";
+    /** Membership not found. */
+    MembershipErrorType["MEMBERSHIP_NOT_FOUND"] = "MEMBERSHIP_NOT_FOUND";
+    /** The selection points to a line item ID that wasn't provided. */
+    MembershipErrorType["LINE_ITEM_NOT_FOUND"] = "LINE_ITEM_NOT_FOUND";
+    /** The membership cannot be used for the specific line items provided. */
+    MembershipErrorType["MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS"] = "MEMBERSHIP_CANNOT_BE_USED_FOR_LINE_ITEMS";
+    /** The membership can be used for each individual line item, but combining all of them is invalid. */
+    MembershipErrorType["MEMBERSHIP_SELECTION_INVALID"] = "MEMBERSHIP_SELECTION_INVALID";
+})(MembershipErrorType || (exports.MembershipErrorType = MembershipErrorType = {}));
+var MembershipCannotBeChargedType;
+(function (MembershipCannotBeChargedType) {
+    /** Membership is out of credits. For example, 5 are required, but only 4 remain. */
+    MembershipCannotBeChargedType["OUT_OF_CREDITS"] = "OUT_OF_CREDITS";
+    /** Membership has not become active yet. */
+    MembershipCannotBeChargedType["NOT_STARTED_YET"] = "NOT_STARTED_YET";
+    /** Membership has expired or ended. */
+    MembershipCannotBeChargedType["ENDED"] = "ENDED";
+    /** Not applicable for multiple participants. */
+    MembershipCannotBeChargedType["NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS"] = "NOT_APPLICABLE_FOR_MULTIPLE_PARTICIPANTS";
+})(MembershipCannotBeChargedType || (exports.MembershipCannotBeChargedType = MembershipCannotBeChargedType = {}));
+var IdentityType;
+(function (IdentityType) {
+    IdentityType["UNKNOWN"] = "UNKNOWN";
+    IdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    IdentityType["MEMBER"] = "MEMBER";
+    IdentityType["WIX_USER"] = "WIX_USER";
+    IdentityType["APP"] = "APP";
+})(IdentityType || (exports.IdentityType = IdentityType = {}));
+//# sourceMappingURL=service-plugins-types.js.map

package/build/internal/cjs/src/service-plugins-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../../src/service-plugins-types.ts"],"names":[],"mappings":";;;AA0JA,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,4BAA4B;IAC5B,oEAA6C,CAAA;IAC7C,mEAAmE;IACnE,kEAA2C,CAAA;IAC3C,0EAA0E;IAC1E,4GAAqF,CAAA;IACrF,sGAAsG;IACtG,oFAA6D,CAAA;AAC/D,CAAC,EAVW,mBAAmB,mCAAnB,mBAAmB,QAU9B;AAoFD,IAAY,6BASX;AATD,WAAY,6BAA6B;IACvC,oFAAoF;IACpF,kEAAiC,CAAA;IACjC,4CAA4C;IAC5C,oEAAmC,CAAA;IACnC,uCAAuC;IACvC,gDAAe,CAAA;IACf,gDAAgD;IAChD,sHAAqF,CAAA;AACvF,CAAC,EATW,6BAA6B,6CAA7B,6BAA6B,QASxC;AA+ED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}

package/build/internal/es/index.d.ts

@@ -0,0 +1,3 @@
+export * from './src/service-plugins-types';
+export * from './src/interfaces-ecom-v1-memberships-provider.context';
+export * from './src/service-plugins-error-classes';

package/build/internal/es/index.js

@@ -0,0 +1,4 @@
+export * from './src/service-plugins-types';
+export * from './src/interfaces-ecom-v1-memberships-provider.context';
+export * from './src/service-plugins-error-classes';
+//# sourceMappingURL=index.js.map

package/build/internal/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uDAAuD,CAAC;AACtE,cAAc,qCAAqC,CAAC"}

package/build/internal/es/index.typings.d.ts

@@ -0,0 +1,29 @@
+import { ListEligibleMembershipsResponse, ChargeMembershipResponse, GetMembershipVoidabilityResponse, VoidMembershipChargeResponse } from './src/service-plugins-types.js';
+import { ListEligibleMembershipsEnvelope, ChargeMembershipEnvelope, GetMembershipVoidabilityEnvelope, VoidMembershipChargeEnvelope } from './src/interfaces-ecom-v1-memberships-provider.public.js';
+export * from './src/service-plugins-error-classes';
+export * from './src/service-plugins-types';
+export { ListEligibleMembershipsEnvelope, ChargeMembershipEnvelope, GetMembershipVoidabilityEnvelope, VoidMembershipChargeEnvelope, };
+/**
+ * This method retrieves eligible memberships from your app.
+ * @throws InvalidSelectionWixError
+ */
+export declare function listEligibleMemberships(payload: ListEligibleMembershipsEnvelope): ListEligibleMembershipsResponse | Promise<ListEligibleMembershipsResponse>;
+/**
+ * This method requests that a membership be charged by your app.
+ * @throws MembershipDoesNotApplyToItemWixError
+ * @throws MembershipCannotBeUsedWixError
+ * @throws MembershipAlreadyChargedWixError
+ */
+export declare function chargeMembership(payload: ChargeMembershipEnvelope): ChargeMembershipResponse | Promise<ChargeMembershipResponse>;
+/**
+ * This method retrieves from your app whether a membership can be voided.
+ * @throws TransactionNotFoundWixError
+ */
+export declare function getMembershipVoidability(payload: GetMembershipVoidabilityEnvelope): GetMembershipVoidabilityResponse | Promise<GetMembershipVoidabilityResponse>;
+/**
+ * This method requests that a membership charge be voided by your app.
+ * @throws TransactionNotFoundWixError
+ * @throws TransactionCannotBeVoidedWixError
+ * @throws TransactionAlreadyVoidedWixError
+ */
+export declare function voidMembershipCharge(payload: VoidMembershipChargeEnvelope): VoidMembershipChargeResponse | Promise<VoidMembershipChargeResponse>;

package/build/internal/es/index.typings.js

@@ -0,0 +1,3 @@
+export * from './src/service-plugins-error-classes';
+export * from './src/service-plugins-types';
+//# sourceMappingURL=index.typings.js.map

package/build/internal/es/index.typings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.typings.js","sourceRoot":"","sources":["../../../index.typings.ts"],"names":[],"mappings":"AAaA,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC"}

package/build/internal/es/src/interfaces-ecom-v1-memberships-provider.context.d.ts

@@ -0,0 +1,5 @@
+import './interfaces-ecom-v1-memberships-provider.public.js';
+import { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';
+import { provideHandlers as publicProvideHandlers } from './interfaces-ecom-v1-memberships-provider.public.js';
+export { publicProvideHandlers };
+export declare const provideHandlers: ReturnType<typeof createServicePluginModule<typeof publicProvideHandlers>>;

package/build/internal/es/src/interfaces-ecom-v1-memberships-provider.context.js

@@ -0,0 +1,6 @@
+import './interfaces-ecom-v1-memberships-provider.public.js';
+import { createServicePluginModule } from '@wix/sdk-runtime/service-plugin-modules';
+import { provideHandlers as publicProvideHandlers } from './interfaces-ecom-v1-memberships-provider.public.js';
+export { publicProvideHandlers };
+export const provideHandlers = createServicePluginModule(publicProvideHandlers);
+//# sourceMappingURL=interfaces-ecom-v1-memberships-provider.context.js.map

package/build/internal/es/src/interfaces-ecom-v1-memberships-provider.context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces-ecom-v1-memberships-provider.context.js","sourceRoot":"","sources":["../../../../src/interfaces-ecom-v1-memberships-provider.context.ts"],"names":[],"mappings":"AAAA,OAAO,qDAAqD,CAAC;AAC7D,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACpF,OAAO,EAAE,eAAe,IAAI,qBAAqB,EAAE,MAAM,qDAAqD,CAAC;AAE/G,OAAO,EAAE,qBAAqB,EAAE,CAAC;AAEjC,MAAM,CAAC,MAAM,eAAe,GAExB,yBAAyB,CAAC,qBAAqB,CAAC,CAAC"}

package/build/internal/es/src/interfaces-ecom-v1-memberships-provider.public.d.ts

@@ -0,0 +1,36 @@
+import { ServicePluginDefinition } from '@wix/sdk-types';
+import { Context, ListEligibleMembershipsRequest, ListEligibleMembershipsResponse, ChargeMembershipRequest, ChargeMembershipResponse, GetMembershipVoidabilityRequest, GetMembershipVoidabilityResponse, VoidMembershipChargeRequest, VoidMembershipChargeResponse } from './service-plugins-types.js';
+export interface ListEligibleMembershipsEnvelope {
+    request: ListEligibleMembershipsRequest;
+    metadata: Context;
+}
+export interface ChargeMembershipEnvelope {
+    request: ChargeMembershipRequest;
+    metadata: Context;
+}
+export interface GetMembershipVoidabilityEnvelope {
+    request: GetMembershipVoidabilityRequest;
+    metadata: Context;
+}
+export interface VoidMembershipChargeEnvelope {
+    request: VoidMembershipChargeRequest;
+    metadata: Context;
+}
+export declare const provideHandlers: 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>;
+}>;

package/build/internal/es/src/interfaces-ecom-v1-memberships-provider.public.js

@@ -0,0 +1,84 @@
+import { ServicePluginDefinition } from '@wix/sdk-types';
+import { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+export const provideHandlers = ServicePluginDefinition('ECOM_MEMBERSHIPS', [
+    {
+        name: 'listEligibleMemberships',
+        primaryHttpMappingPath: '/v1/list-eligible-memberships',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = transformPaths(payload, [
+                    {
+                        transformFn: transformSDKTimestampToRESTTimestamp,
+                        paths: [
+                            { path: 'eligibleMemberships.expirationDate' },
+                            { path: 'invalidMemberships.membership.expirationDate' },
+                        ],
+                    },
+                ]);
+                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = transformPaths(payload, [
+                    {
+                        transformFn: transformRESTTimestampToSDKTimestamp,
+                        paths: [
+                            { path: 'request.lineItems.serviceProperties.scheduledDate' },
+                        ],
+                    },
+                ]);
+                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
+            },
+        },
+    },
+    {
+        name: 'chargeMembership',
+        primaryHttpMappingPath: '/v1/charge-membership',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = transformPaths(payload, [
+                    {
+                        transformFn: transformRESTTimestampToSDKTimestamp,
+                        paths: [{ path: 'request.serviceProperties.scheduledDate' }],
+                    },
+                ]);
+                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
+            },
+        },
+    },
+    {
+        name: 'getMembershipVoidability',
+        primaryHttpMappingPath: '/v1/get-voidability',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = payload;
+                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
+            },
+        },
+    },
+    {
+        name: 'voidMembershipCharge',
+        primaryHttpMappingPath: '/v1/void-membership-charge',
+        transformations: {
+            toREST: (payload) => {
+                const toRestResponse = payload;
+                return renameKeysFromSDKRequestToRESTRequest(toRestResponse);
+            },
+            fromREST: (payload) => {
+                const fromRestRequest = payload;
+                return renameKeysFromRESTResponseToSDKResponse(fromRestRequest);
+            },
+        },
+    },
+]);
+//# sourceMappingURL=interfaces-ecom-v1-memberships-provider.public.js.map

package/build/internal/es/src/interfaces-ecom-v1-memberships-provider.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces-ecom-v1-memberships-provider.public.js","sourceRoot":"","sources":["../../../../src/interfaces-ecom-v1-memberships-provider.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAYzD,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAsBjD,MAAM,CAAC,MAAM,eAAe,GAAG,uBAAuB,CA8BnD,kBAAkB,EAAE;IACrB;QACE,IAAI,EAAE,yBAAyB;QAC/B,sBAAsB,EAAE,+BAA+B;QACvD,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,EAAE;oBAC7C;wBACE,WAAW,EAAE,oCAAoC;wBACjD,KAAK,EAAE;4BACL,EAAE,IAAI,EAAE,oCAAoC,EAAE;4BAC9C,EAAE,IAAI,EAAE,8CAA8C,EAAE;yBACzD;qBACF;iBACF,CAAC,CAAC;gBAEH,OAAO,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,EAAE;oBAC9C;wBACE,WAAW,EAAE,oCAAoC;wBACjD,KAAK,EAAE;4BACL,EAAE,IAAI,EAAE,mDAAmD,EAAE;yBAC9D;qBACF;iBACF,CAAC,CAAC;gBAEH,OAAO,uCAAuC,CAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;IAED;QACE,IAAI,EAAE,kBAAkB;QACxB,sBAAsB,EAAE,uBAAuB;QAC/C,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,cAAc,CAAC,OAAO,EAAE;oBAC9C;wBACE,WAAW,EAAE,oCAAoC;wBACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,yCAAyC,EAAE,CAAC;qBAC7D;iBACF,CAAC,CAAC;gBAEH,OAAO,uCAAuC,CAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;IAED;QACE,IAAI,EAAE,0BAA0B;QAChC,sBAAsB,EAAE,qBAAqB;QAC7C,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,uCAAuC,CAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;IAED;QACE,IAAI,EAAE,sBAAsB;QAC5B,sBAAsB,EAAE,4BAA4B;QACpD,eAAe,EAAE;YACf,MAAM,EAAE,CAAC,OAAY,EAAE,EAAE;gBACvB,MAAM,cAAc,GAAG,OAAO,CAAC;gBAE/B,OAAO,qCAAqC,CAAC,cAAc,CAAC,CAAC;YAC/D,CAAC;YACD,QAAQ,EAAE,CAAC,OAAY,EAAE,EAAE;gBACzB,MAAM,eAAe,GAAG,OAAO,CAAC;gBAEhC,OAAO,uCAAuC,CAAC,eAAe,CAAC,CAAC;YAClE,CAAC;SACF;KACF;CACF,CAAC,CAAC"}