@wix/auto_sdk_ecom_memberships-host 0.0.0-stage → 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,75 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { LineItem, ListEligibleMembershipsOptions, ListEligibleMembershipsResponse, ListEligibleMembershipsApplicationErrors, ChargeMembershipOptions, ChargeMembershipResponse, ChargeMembershipApplicationErrors, GetMembershipVoidabilityOptions, GetMembershipVoidabilityResponse, GetMembershipVoidabilityApplicationErrors, VoidMembershipChargeOptions, VoidMembershipChargeApplicationErrors, ListExistingMembershipsOptions, ListExistingMembershipsResponse, ListExistingMembershipsApplicationErrors, ListPurchasablePlansOptions, ListPurchasablePlansResponse } from './index.typings.js';
+export { AccountInfo, AppMembershipIds, BalanceType, BalanceTypeWithLiterals, Benefit, BenefitQuotaOneOf, CatalogReference, ChargeMembershipRequest, CoveredLineItem, Ended, EnhanceAndValidateSelectionApplicationErrors, EnhanceAndValidateSelectionOptions, EnhanceAndValidateSelectionRequest, EnhanceAndValidateSelectionResponse, ExistingMembership, ExistingMembershipSelection, FutureMembershipInput, GetMembershipVoidabilityRequest, HostExistingMembership, IdentificationData, IdentificationDataIdOneOf, InvalidMembership, LimitedQuota, LimitedQuotaType, LimitedQuotaTypeWithLiterals, LineItemCoverage, LineItemNotFoundInfo, ListEligibleMembershipsRequest, ListExistingMembershipsRequest, ListMembershipsByIdsApplicationErrors, ListMembershipsByIdsOptions, ListMembershipsByIdsRequest, ListMembershipsByIdsResponse, ListPurchasablePlansRequest, Membership, MembershipCannotBeChargedError, MembershipCannotBeChargedErrorErrorDataOneOf, MembershipCannotBeChargedType, MembershipCannotBeChargedTypeWithLiterals, MembershipCannotBeUsedForLineItemInfo, MembershipCannotBeUsedForLineItemsInfo, MembershipErrorType, MembershipErrorTypeWithLiterals, MembershipInvalidSelectionError, MembershipInvalidSelectionErrorErrorDataOneOf, MembershipInvalidSelectionErrors, MembershipName, MembershipPaymentCredits, MembershipReadyToBeCharged, MembershipReadyToBeChargedOptions, MembershipReadyToBeChargedRequest, MembershipReadyToBeChargedResponse, MessageEnvelope, NotStartedYet, OutOfCredits, PurchasablePlan, QuotaType, QuotaTypeWithLiterals, SelectedMembership, SelectedMemberships, ServiceProperties, V1Membership, ValidatedExistingMemberships, ValidatedPurchasablePlans, VoidMembershipChargeRequest, VoidMembershipChargeResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function listEligibleMemberships$1(httpClient: HttpClient): ListEligibleMembershipsSignature;
+interface ListEligibleMembershipsSignature {
+    /**
+     * Deprecated. Use [List Existing Memberships](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships/list-existing-memberships) to list the memberships a member already owns, and [List Purchasable Plans](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships/list-purchasable-plans) to list the plans a member or visitor could purchase.
+     * @param - The line items for which we want to check if there is a relevant membership
+     * @deprecated
+     */
+    (lineItems: NonNullablePaths<LineItem, `catalogReference` | `catalogReference.appId`, 1>[], options?: NonNullablePaths<ListEligibleMembershipsOptions, `selectedMemberships.memberships.${number}._id` | `selectedMemberships.memberships.${number}.appId` | `selectedMemberships.memberships.${number}.lineItemIds`, 3>): Promise<NonNullablePaths<ListEligibleMembershipsResponse, `eligibleMemberships` | `eligibleMemberships.${number}._id` | `eligibleMemberships.${number}.appId` | `eligibleMemberships.${number}.name.original` | `eligibleMemberships.${number}.credits.total` | `eligibleMemberships.${number}.credits.remaining` | `invalidMemberships` | `invalidMemberships.${number}.membership._id` | `invalidMemberships.${number}.membership.appId` | `invalidMemberships.${number}.membership.name.original` | `invalidMemberships.${number}.membership.credits.total` | `invalidMemberships.${number}.membership.credits.remaining` | `invalidMemberships.${number}.reason` | `selectedMemberships` | `selectedMemberships.${number}._id` | `selectedMemberships.${number}.appId`, 4> & {
+        __applicationErrorsType?: ListEligibleMembershipsApplicationErrors;
+    }>;
+}
+declare function chargeMembership$1(httpClient: HttpClient): ChargeMembershipSignature;
+interface ChargeMembershipSignature {
+    /**
+     * Called upon usage of a membership
+     * One example of an implementation, would be to redeem a punch card
+     * @param - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
+     * but a user which is using the membership on behalf of the a member
+     */
+    (memberId: string, options?: NonNullablePaths<ChargeMembershipOptions, `appId` | `catalogReference` | `catalogReference.appId` | `idempotencyKey`, 1>): Promise<NonNullablePaths<ChargeMembershipResponse, `transactionId`, 0> & {
+        __applicationErrorsType?: ChargeMembershipApplicationErrors;
+    }>;
+}
+declare function getMembershipVoidability$1(httpClient: HttpClient): GetMembershipVoidabilitySignature;
+interface GetMembershipVoidabilitySignature {
+    /**
+     * Errors: transaction not found
+     * Should return whether a specific membership usage can be voided
+     * @param - The transaction id that was returned from the use call
+     */
+    (transactionId: string, options: NonNullablePaths<GetMembershipVoidabilityOptions, `appId`, 0>): Promise<NonNullablePaths<GetMembershipVoidabilityResponse, `voidable`, 0> & {
+        __applicationErrorsType?: GetMembershipVoidabilityApplicationErrors;
+    }>;
+}
+declare function voidMembershipCharge$1(httpClient: HttpClient): VoidMembershipChargeSignature;
+interface VoidMembershipChargeSignature {
+    /**
+     * Should void a specific membership usage
+     * @param - The transaction id that was returned from the redeem call
+     */
+    (transactionId: string, options: NonNullablePaths<VoidMembershipChargeOptions, `appId`, 0>): Promise<void & {
+        __applicationErrorsType?: VoidMembershipChargeApplicationErrors;
+    }>;
+}
+declare function listExistingMemberships$1(httpClient: HttpClient): ListExistingMembershipsSignature;
+interface ListExistingMembershipsSignature {
+    /**
+     * Lists memberships the member already owns that are applicable to the given line items.
+     * @param - The line items for which to list memberships the member already owns.
+     */
+    (lineItems: NonNullablePaths<LineItem, `catalogReference` | `catalogReference.appId`, 1>[], options?: ListExistingMembershipsOptions): Promise<NonNullablePaths<ListExistingMembershipsResponse, `memberships` | `memberships.${number}.membership._id` | `memberships.${number}.membership.appId` | `memberships.${number}.membership.name.original` | `memberships.${number}.membership.credits.total` | `memberships.${number}.membership.credits.remaining`, 4> & {
+        __applicationErrorsType?: ListExistingMembershipsApplicationErrors;
+    }>;
+}
+declare function listPurchasablePlans$1(httpClient: HttpClient): ListPurchasablePlansSignature;
+interface ListPurchasablePlansSignature {
+    /**
+     * Lists plans the member could purchase that would cover the given line items.
+     * @param - The line items for which to list plans the member could purchase.
+     */
+    (lineItems: NonNullablePaths<LineItem, `catalogReference` | `catalogReference.appId`, 1>[], options?: ListPurchasablePlansOptions): Promise<NonNullablePaths<ListPurchasablePlansResponse, `purchasablePlans` | `purchasablePlans.${number}.catalogReference.catalogItemId` | `purchasablePlans.${number}.catalogReference.appId` | `purchasablePlans.${number}.name.original` | `purchasablePlans.${number}.price` | `coverages` | `coverages.${number}.benefitId` | `coverages.${number}.lineItemId` | `coverages.${number}.redemptionCost`, 3>>;
+}
+
+declare const listEligibleMemberships: MaybeContext<BuildRESTFunction<typeof listEligibleMemberships$1> & typeof listEligibleMemberships$1>;
+declare const chargeMembership: MaybeContext<BuildRESTFunction<typeof chargeMembership$1> & typeof chargeMembership$1>;
+declare const getMembershipVoidability: MaybeContext<BuildRESTFunction<typeof getMembershipVoidability$1> & typeof getMembershipVoidability$1>;
+declare const voidMembershipCharge: MaybeContext<BuildRESTFunction<typeof voidMembershipCharge$1> & typeof voidMembershipCharge$1>;
+declare const listExistingMemberships: MaybeContext<BuildRESTFunction<typeof listExistingMemberships$1> & typeof listExistingMemberships$1>;
+declare const listPurchasablePlans: MaybeContext<BuildRESTFunction<typeof listPurchasablePlans$1> & typeof listPurchasablePlans$1>;
+
+export { ChargeMembershipApplicationErrors, ChargeMembershipOptions, ChargeMembershipResponse, GetMembershipVoidabilityApplicationErrors, GetMembershipVoidabilityOptions, GetMembershipVoidabilityResponse, LineItem, ListEligibleMembershipsApplicationErrors, ListEligibleMembershipsOptions, ListEligibleMembershipsResponse, ListExistingMembershipsApplicationErrors, ListExistingMembershipsOptions, ListExistingMembershipsResponse, ListPurchasablePlansOptions, ListPurchasablePlansResponse, VoidMembershipChargeApplicationErrors, VoidMembershipChargeOptions, chargeMembership, getMembershipVoidability, listEligibleMemberships, listExistingMemberships, listPurchasablePlans, voidMembershipCharge };