@wix/auto_sdk_ecom_memberships 1.0.0 → 1.0.2

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

@@ -1,10 +1,15 @@
 export interface ListEligibleMembershipsRequest {
-    /** The line items for which to list eligible memberships. */
+    /**
+     * The line items for which to list eligible memberships.
+     * @minSize 1
+     * @maxSize 300
+     */
     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.
+     * @format GUID
      */
     memberId: string;
     /**
@@ -16,7 +21,11 @@ export interface ListEligibleMembershipsRequest {
     selectedMemberships?: SelectedMemberships;
 }
 export interface LineItem {
-    /** Line item ID. */
+    /**
+     * Line item ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     _id?: string;
     /** Catalog and item reference info. */
     catalogReference?: CatalogReference;
@@ -28,12 +37,18 @@ export interface LineItem {
      * 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.
+     * @minLength 1
+     * @maxLength 36
      */
     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. */
+    /**
+     * ID of the item within the catalog it belongs to.
+     * @minLength 1
+     * @maxLength 36
+     */
     catalogItemId?: string;
     /**
      * ID of the app providing the catalog.
@@ -44,12 +59,13 @@ export interface CatalogReference {
      * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
      * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
      * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     * @minLength 1
      */
     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).
+     * For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
      */
     options?: Record<string, any> | null;
 }
@@ -59,33 +75,69 @@ export interface ServiceProperties {
      * 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. */
+    /**
+     * 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.
+     * @min 1
+     * @max 10000
+     */
     numberOfParticipants?: number | null;
 }
 export interface SelectedMemberships {
-    /** Selected memberships. */
+    /**
+     * Selected memberships.
+     * @maxSize 300
+     */
     memberships?: SelectedMembership[];
 }
 export interface SelectedMembership {
-    /** Membership ID. */
+    /**
+     * Membership ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     _id?: string;
-    /** IDs of the line items this membership applies to. */
+    /**
+     * IDs of the line items this membership applies to.
+     * @minSize 1
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     */
     lineItemIds?: string[];
 }
 export interface ListEligibleMembershipsResponse {
-    /** List of memberships that are eligible for the given member and line items. */
+    /**
+     * List of memberships that are eligible for the given member and line items.
+     * @maxSize 300
+     */
     eligibleMemberships?: Membership[];
-    /** List of memberships owned by the member, but cannot be used due to the reason provided. */
+    /**
+     * List of memberships owned by the member, but cannot be used due to the reason provided.
+     * @maxSize 300
+     */
     invalidMemberships?: InvalidMembership[];
-    /** List of selected memberships and which line items they apply to. */
+    /**
+     * List of selected memberships and which line items they apply to.
+     * @maxSize 300
+     */
     selectedMemberships?: SelectedMembership[];
 }
 export interface Membership {
-    /** Membership ID. */
+    /**
+     * Membership ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     _id?: string;
     /** Membership name. */
     name?: MembershipName;
-    /** Line item IDs this membership applies to. */
+    /**
+     * Line item IDs this membership applies to.
+     * @minSize 1
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     */
     lineItemIds?: string[];
     /** Total and remaining membership credits. */
     credits?: MembershipPaymentCredits;
@@ -95,13 +147,22 @@ export interface Membership {
     additionalData?: Record<string, any> | null;
 }
 export interface MembershipName {
-    /** Membership name. */
+    /**
+     * Membership name.
+     * @maxLength 100
+     */
     original?: string;
-    /** Translated membership name. Defaults to `original` when not provided. */
+    /**
+     * Translated membership name. Defaults to `original` when not provided.
+     * @maxLength 100
+     */
     translated?: string | null;
 }
 export interface MembershipPaymentCredits {
-    /** Membership's total amount of credits. */
+    /**
+     * Membership's total amount of credits.
+     * @min 1
+     */
     total?: number;
     /** Membership's remaining amount of credits. */
     remaining?: number;
@@ -109,11 +170,18 @@ export interface MembershipPaymentCredits {
 export interface InvalidMembership {
     /** The membership that is invalid and cannot be used. */
     membership?: Membership;
-    /** Reason why this membership is invalid. */
+    /**
+     * Reason why this membership is invalid.
+     * @minLength 1
+     * @maxLength 200
+     */
     reason?: string;
 }
 export interface MembershipInvalidSelectionErrors {
-    /** Error details for invalid memberships. */
+    /**
+     * Error details for invalid memberships.
+     * @maxSize 300
+     */
     membershipInvalidSelectionErrors?: MembershipInvalidSelectionError[];
 }
 export interface MembershipInvalidSelectionError extends MembershipInvalidSelectionErrorErrorDataOneOf {
@@ -121,9 +189,15 @@ export interface MembershipInvalidSelectionError extends MembershipInvalidSelect
     lineItemNotFoundInfo?: LineItemNotFoundInfo;
     /** Error details for line items that cannot be used with this membership. */
     membershipCannotBeUsedForLineItemsInfo?: MembershipCannotBeUsedForLineItemsInfo;
-    /** Reason why this membership selection is invalid. */
+    /**
+     * Reason why this membership selection is invalid.
+     * @maxLength 1000
+     */
     membershipSelectionInvalidReason?: string | null;
-    /** Membership ID. */
+    /**
+     * Membership ID.
+     * @format GUID
+     */
     membershipId?: string;
     /** Error type. */
     errorType?: MembershipErrorType;
@@ -134,7 +208,10 @@ export interface MembershipInvalidSelectionErrorErrorDataOneOf {
     lineItemNotFoundInfo?: LineItemNotFoundInfo;
     /** Error details for line items that cannot be used with this membership. */
     membershipCannotBeUsedForLineItemsInfo?: MembershipCannotBeUsedForLineItemsInfo;
-    /** Reason why this membership selection is invalid. */
+    /**
+     * Reason why this membership selection is invalid.
+     * @maxLength 1000
+     */
     membershipSelectionInvalidReason?: string | null;
 }
 export declare enum MembershipErrorType {
@@ -149,17 +226,32 @@ export declare enum MembershipErrorType {
     MEMBERSHIP_SELECTION_INVALID = "MEMBERSHIP_SELECTION_INVALID"
 }
 export interface LineItemNotFoundInfo {
-    /** Line item IDs that were missing. */
+    /**
+     * Line item IDs that were missing.
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     */
     lineItemIds?: string[];
 }
 export interface MembershipCannotBeUsedForLineItemsInfo {
-    /** Line items that cannot be used with this membership, and the reason why. */
+    /**
+     * Line items that cannot be used with this membership, and the reason why.
+     * @maxSize 300
+     */
     lineItems?: MembershipCannotBeUsedForLineItemInfo[];
 }
 export interface MembershipCannotBeUsedForLineItemInfo {
-    /** Line item ID. */
+    /**
+     * Line item ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     lineItemId?: string;
-    /** Reason why this line item cannot be used with this membership. */
+    /**
+     * Reason why this line item cannot be used with this membership.
+     * @maxLength 1000
+     */
     reason?: string;
 }
 export interface ChargeMembershipRequest {
@@ -167,13 +259,20 @@ 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.
+     * @format GUID
      */
     memberId: string;
-    /** Membership ID, as returned from the List Eligible Memberships call. */
+    /**
+     * Membership ID, as returned from the List Eligible Memberships call.
+     * @minLength 1
+     * @maxLength 100
+     */
     membershipId: string;
     /**
      * Idempotency key to avoid duplicate charge.
      * The value will usually would be the same as `membershipId` + `orderId` + `rootCatalogItemId`.
+     * @minLength 1
+     * @maxLength 200
      */
     idempotencyKey: string;
     /**
@@ -190,6 +289,8 @@ export interface ChargeMembershipRequest {
      * 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.
+     * @minLength 1
+     * @maxLength 36
      */
     rootCatalogItemId?: string | null;
     /** Additional data about this charge. */
@@ -200,6 +301,8 @@ export interface ChargeMembershipResponse {
      * The transaction ID for this charge.
      *
      * Use this ID to void the charge.
+     * @minLength 1
+     * @maxLength 100
      */
     transactionId?: string;
 }
@@ -247,21 +350,37 @@ export interface Ended {
     endDate?: Date | null;
 }
 export interface MembershipAlreadyChargedError {
-    /** ID of the transaction that was already used for membership charge. */
+    /**
+     * ID of the transaction that was already used for membership charge.
+     * @minLength 1
+     * @maxLength 100
+     */
     transactionId?: string;
 }
 export interface GetMembershipVoidabilityRequest {
-    /** Transaction ID to check if it can be voided. */
+    /**
+     * Transaction ID to check if it can be voided.
+     * @minLength 1
+     * @maxLength 100
+     */
     transactionId: string;
 }
 export interface GetMembershipVoidabilityResponse {
     /** Whether the membership charge can be voided. */
     voidable?: boolean;
-    /** Reason why the membership charge cannot be voided. */
+    /**
+     * Reason why the membership charge cannot be voided.
+     * @minLength 1
+     * @maxLength 200
+     */
     reason?: string | null;
 }
 export interface VoidMembershipChargeRequest {
-    /** Transaction ID to void. */
+    /**
+     * Transaction ID to void.
+     * @minLength 1
+     * @maxLength 100
+     */
     transactionId: string;
 }
 export interface VoidMembershipChargeResponse {
@@ -270,9 +389,15 @@ 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/.
+     * @format WEB_URL
      */
     deploymentUri?: string;
-    /** The app IDs of the catalogs your app supports. */
+    /**
+     * The app IDs of the catalogs your app supports.
+     * @minSize 1
+     * @maxSize 300
+     * @format GUID
+     */
     catalogAppDefIds?: string[];
 }
 /**
@@ -291,13 +416,19 @@ export interface MembershipsSPIConfig {
 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. */
+    /**
+     * [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+     * @format CURRENCY
+     */
     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. */
+    /**
+     * The service provider app's instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
 }
 export declare enum IdentityType {
@@ -308,25 +439,49 @@ export declare enum IdentityType {
     APP = "APP"
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: IdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }

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

@@ -1 +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"}
+{"version":3,"file":"service-plugins-types.js","sourceRoot":"","sources":["../../../src/service-plugins-types.ts"],"names":[],"mappings":";;;AAuOA,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;AA8GD,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;AA2GD,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"}