@wix/stores 1.0.26 → 1.0.28

package/build/es/src/stores-v1-subscription-option.public.js

@@ -0,0 +1,63 @@
+import { createSubscriptionOption as universalCreateSubscriptionOption, updateSubscriptionOption as universalUpdateSubscriptionOption, deleteSubscriptionOption as universalDeleteSubscriptionOption, bulkCreateSubscriptionOptions as universalBulkCreateSubscriptionOptions, bulkUpdateSubscriptionOptions as universalBulkUpdateSubscriptionOptions, bulkDeleteSubscriptionOptions as universalBulkDeleteSubscriptionOptions, assignSubscriptionOptionsToProduct as universalAssignSubscriptionOptionsToProduct, allowOneTimePurchases as universalAllowOneTimePurchases, getSubscriptionOption as universalGetSubscriptionOption, getSubscriptionOptionsForProduct as universalGetSubscriptionOptionsForProduct, getProductIdsForSubscriptionOption as universalGetProductIdsForSubscriptionOption, getOneTimePurchasesStatus as universalGetOneTimePurchasesStatus, } from './stores-v1-subscription-option.universal';
+export function createSubscriptionOption(httpClient) {
+    return (subscriptionOption) => universalCreateSubscriptionOption(subscriptionOption, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateSubscriptionOption(httpClient) {
+    return (_id, subscriptionOption) => universalUpdateSubscriptionOption(_id, subscriptionOption, 
+    // @ts-ignore
+    { httpClient });
+}
+export function deleteSubscriptionOption(httpClient) {
+    return (_id) => universalDeleteSubscriptionOption(_id, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkCreateSubscriptionOptions(httpClient) {
+    return (subscriptionOptions) => universalBulkCreateSubscriptionOptions(subscriptionOptions, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkUpdateSubscriptionOptions(httpClient) {
+    return (subscriptionOptions) => universalBulkUpdateSubscriptionOptions(subscriptionOptions, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkDeleteSubscriptionOptions(httpClient) {
+    return (ids) => universalBulkDeleteSubscriptionOptions(ids, 
+    // @ts-ignore
+    { httpClient });
+}
+export function assignSubscriptionOptionsToProduct(httpClient) {
+    return (productId, options) => universalAssignSubscriptionOptionsToProduct(productId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function allowOneTimePurchases(httpClient) {
+    return (productId, allowed) => universalAllowOneTimePurchases(productId, allowed, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getSubscriptionOption(httpClient) {
+    return (_id) => universalGetSubscriptionOption(_id, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getSubscriptionOptionsForProduct(httpClient) {
+    return (productId, options) => universalGetSubscriptionOptionsForProduct(productId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getProductIdsForSubscriptionOption(httpClient) {
+    return (_id, options) => universalGetProductIdsForSubscriptionOption(_id, options, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getOneTimePurchasesStatus(httpClient) {
+    return (productId) => universalGetOneTimePurchasesStatus(productId, 
+    // @ts-ignore
+    { httpClient });
+}
+export { SubscriptionFrequency, DiscountType, } from './stores-v1-subscription-option.universal';
+//# sourceMappingURL=stores-v1-subscription-option.public.js.map

package/build/es/src/stores-v1-subscription-option.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-v1-subscription-option.public.js","sourceRoot":"","sources":["../../../src/stores-v1-subscription-option.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,wBAAwB,IAAI,iCAAiC,EAC7D,wBAAwB,IAAI,iCAAiC,EAC7D,wBAAwB,IAAI,iCAAiC,EAC7D,6BAA6B,IAAI,sCAAsC,EACvE,6BAA6B,IAAI,sCAAsC,EACvE,6BAA6B,IAAI,sCAAsC,EACvE,kCAAkC,IAAI,2CAA2C,EACjF,qBAAqB,IAAI,8BAA8B,EACvD,qBAAqB,IAAI,8BAA8B,EACvD,gCAAgC,IAAI,yCAAyC,EAC7E,kCAAkC,IAAI,2CAA2C,EACjF,yBAAyB,IAAI,kCAAkC,GAMhE,MAAM,2CAA2C,CAAC;AAEnD,MAAM,UAAU,wBAAwB,CAAC,UAAsB;IAC7D,OAAO,CAAC,kBAAsC,EAAE,EAAE,CAChD,iCAAiC,CAC/B,kBAAkB;IAClB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,UAAsB;IAC7D,OAAO,CAAC,GAAkB,EAAE,kBAA4C,EAAE,EAAE,CAC1E,iCAAiC,CAC/B,GAAG,EACH,kBAAkB;IAClB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,UAAsB;IAC7D,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,iCAAiC,CAC/B,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,mBAAyC,EAAE,EAAE,CACnD,sCAAsC,CACpC,mBAAmB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,mBAAyC,EAAE,EAAE,CACnD,sCAAsC,CACpC,mBAAmB;IACnB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,UAAsB;IAClE,OAAO,CAAC,GAAa,EAAE,EAAE,CACvB,sCAAsC,CACpC,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,UAAsB;IACvE,OAAO,CACL,SAAiB,EACjB,OAAmD,EACnD,EAAE,CACF,2CAA2C,CACzC,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,CAAC,SAAiB,EAAE,OAAuB,EAAE,EAAE,CACpD,8BAA8B,CAC5B,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,8BAA8B,CAC5B,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,UAAsB;IACrE,OAAO,CACL,SAAiB,EACjB,OAAiD,EACjD,EAAE,CACF,yCAAyC,CACvC,SAAS,EACT,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,UAAsB;IACvE,OAAO,CAAC,GAAW,EAAE,OAAmD,EAAE,EAAE,CAC1E,2CAA2C,CACzC,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,UAAsB;IAC9D,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,kCAAkC,CAChC,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,qBAAqB,EACrB,YAAY,GACb,MAAM,2CAA2C,CAAC"}

package/build/es/src/stores-v1-subscription-option.types.d.ts

@@ -0,0 +1,296 @@
+export interface SubscriptionOption {
+    /** Subscription option ID (auto-generated upon subscription option creation). */
+    id?: string | null;
+    /** Subscription option title. */
+    title?: string | null;
+    /** Subscription option description (optional). */
+    description?: string | null;
+    /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */
+    subscriptionSettings?: SubscriptionSettings;
+    /**
+     * Discount info (optional).
+     * For example, a $20 discount would be `value: 20`, `type: AMOUNT`.
+     */
+    discount?: Discount;
+}
+export interface SubscriptionSettings {
+    /** Frequency of recurring payment. */
+    frequency?: SubscriptionFrequency;
+    /** Whether subscription is renewed automatically at the end of each period. */
+    autoRenewal?: boolean;
+    /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
+    billingCycles?: number | null;
+}
+/** Frequency unit of recurring payment */
+export declare enum SubscriptionFrequency {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+export interface Discount {
+    /** Discount type. */
+    type?: DiscountType;
+    /** Discount value. */
+    value?: number;
+}
+export declare enum DiscountType {
+    UNDEFINED = "UNDEFINED",
+    /** No discount */
+    AMOUNT = "AMOUNT",
+    PERCENT = "PERCENT"
+}
+export interface SubscriptionOptionCreated {
+    /** Newly created subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+export interface SubscriptionOptionChanged {
+    /** Changed subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+export interface SubscriptionOptionDeleted {
+    /** Deleted subscription option's ID. */
+    id?: string;
+}
+export interface SubscriptionOptionsAssignmentChangedForProduct {
+    /** Product ID. */
+    productId?: string;
+    /** Subscription options assigned to the product. */
+    assignedSubscriptionOptions?: SubscriptionOptionWithVisibility[];
+}
+export interface SubscriptionOptionWithVisibility {
+    /** Subscription option ID. */
+    id?: string;
+    /** Whether the subscription option is hidden for the product (the default is false). */
+    hidden?: boolean;
+}
+export interface OneTimePurchasesChanged {
+    /** Product ID. */
+    productId?: string;
+    /** Whether the product is available for one-time purchase. */
+    allowed?: boolean;
+}
+export interface CreateSubscriptionOptionRequest {
+    /** Subscription option info. */
+    subscriptionOption: SubscriptionOption;
+}
+export interface CreateSubscriptionOptionResponse {
+    /** Newly created subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+export interface UpdateSubscriptionOptionRequest {
+    /** Subscription option info. Only the passed parameters will be updated. */
+    subscriptionOption: SubscriptionOption;
+}
+export interface UpdateSubscriptionOptionResponse {
+    /** Updated subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+export interface DeleteSubscriptionOptionRequest {
+    /** ID of the subscription option to delete. */
+    id: string;
+}
+export interface DeleteSubscriptionOptionResponse {
+}
+export interface BulkCreateSubscriptionOptionsRequest {
+    /** Subscription options info. */
+    subscriptionOptions: SubscriptionOption[];
+}
+export interface BulkCreateSubscriptionOptionsResponse {
+    /** Newly created subscription options. */
+    subscriptionOptions?: SubscriptionOption[];
+}
+export interface BulkUpdateSubscriptionOptionsRequest {
+    /** Subscription options info. Only the passed parameters in each subscription option will be updated. */
+    subscriptionOptions: SubscriptionOption[];
+}
+export interface BulkUpdateSubscriptionOptionsResponse {
+    /** Updated subscription options. */
+    subscriptionOptions?: SubscriptionOption[];
+}
+export interface BulkDeleteSubscriptionOptionsRequest {
+    /** IDs of the subscription options to delete. */
+    ids: string[];
+}
+export interface BulkDeleteSubscriptionOptionsResponse {
+}
+export interface AssignSubscriptionOptionsToProductRequest {
+    /** Product ID. */
+    productId: string;
+    /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */
+    assignedSubscriptionOptions?: SubscriptionOptionInProduct[];
+}
+export interface SubscriptionOptionInProduct {
+    /** Subscription option ID. */
+    id?: string;
+    /** Whether the subscription option is hidden for the product (the default is false). */
+    hidden?: boolean;
+    /**
+     * Subscription option title.
+     * @readonly
+     */
+    title?: string | null;
+    /**
+     * Subscription option description (optional).
+     * @readonly
+     */
+    description?: string | null;
+    /**
+     * Subscription payment settings. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
+     * @readonly
+     */
+    subscriptionSettings?: SubscriptionSettings;
+    /**
+     * Discount info (optional).
+     * @readonly
+     */
+    discount?: Discount;
+}
+export interface AssignSubscriptionOptionsToProductResponse {
+}
+export interface AllowOneTimePurchasesRequest {
+    /** Product ID. */
+    productId: string;
+    /** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */
+    allowed: boolean | null;
+}
+export interface AllowOneTimePurchasesResponse {
+}
+export interface GetSubscriptionOptionRequest {
+    /** Subscription option ID. */
+    id: string;
+}
+export interface GetSubscriptionOptionResponse {
+    /** Subscription option. */
+    subscriptionOption?: SubscriptionOption;
+}
+export interface GetSubscriptionOptionsForProductRequest {
+    /** Product ID. */
+    productId: string;
+    /** Whether to include hidden subscription options in the results. */
+    includeHiddenSubscriptionOptions?: boolean;
+}
+export interface GetSubscriptionOptionsForProductResponse {
+    /** Subscription options. */
+    subscriptionOptions?: SubscriptionOptionInProduct[];
+}
+export interface ListSubscriptionOptionsRequest {
+    /** Subscription option IDs. */
+    ids?: string[];
+}
+export interface ListSubscriptionOptionsResponse {
+    /** Subscription options. */
+    subscriptionOptions?: SubscriptionOption[];
+}
+export interface CalculatePricesRequest {
+    /** original price to which subscription options discount will be applied */
+    price?: number;
+    /** ids of subscription options which will be applied to original price */
+    ids?: string[];
+}
+export interface CalculatePricesResponse {
+    /** array of calculated prices */
+    prices?: SubscriptionOptionPrices[];
+    /** price to which subscription options discount applied */
+    originalPrice?: number;
+}
+export interface SubscriptionOptionPrices {
+    /** Subscription option id */
+    id?: string;
+    /** Price data calculated for subscription option */
+    priceData?: SubscriptionOptionPriceData;
+    /** Price data calculated for subscription option, converted to the currency requested in request header */
+    convertedPriceData?: SubscriptionOptionPriceData;
+}
+export interface SubscriptionOptionPriceData {
+    /** Subscription option price currency */
+    currency?: string;
+    /** Price calculated after subscription option discount applied */
+    discountedPrice?: number;
+    /** Price calculated after subscription option discount applied, formatted with the currency */
+    formattedDiscountedPrice?: string;
+}
+export interface BulkCalculatePricesRequest {
+    /**
+     * Original prices to which subscription options discount will be applied.
+     * Key is identifier unique per price that can be used to match calculated prices with original price
+     */
+    prices?: Record<string, number>;
+    /** ids of subscription options which will be applied to original price */
+    ids?: string[];
+}
+export interface BulkCalculatePricesResponse {
+    /**
+     * Key is identifier unique per price that can be used to match calculated prices with original price
+     * Value is response with calculated prices for each subscription option
+     */
+    calculatedPrices?: Record<string, CalculatePricesResponse>;
+}
+export interface BulkCalculatePricesRequestV2 {
+    /** Original prices to be calculated for each corresponding product id with related subscription plan ids */
+    items?: BulkCalculatePricesRequestItem[];
+}
+export interface BulkCalculatePricesRequestItem {
+    /** Calculation id (product id) */
+    id?: string;
+    /**
+     * Original prices to which subscription options discount will be applied.
+     * Key is identifier unique per price that can be used to match calculated prices with original price
+     */
+    prices?: Record<string, number>;
+    /** ids of subscription options which will be applied to original price. */
+    subscriptionOptionIds?: string[];
+}
+export interface BulkCalculatePricesResponseV2 {
+    /**
+     * Key is identifier unique per price that can be used to match calculated prices with original price
+     * Value is response with calculated prices for each subscription option for each product
+     */
+    calculatedPricesPerProduct?: BulkCalculatePricesResponseItem[];
+}
+export interface BulkCalculatePricesResponseItem {
+    /** Calculation id (product id) */
+    id?: string;
+    /**
+     * Key is identifier unique per price that can be used to match calculated prices with original price
+     * Value is response with calculated prices for each subscription option
+     */
+    calculatedPrices?: Record<string, CalculatePricesResponse>;
+}
+export interface GetProductIdsForSubscriptionOptionRequest {
+    /** Subscription option ID. */
+    id: string;
+    /** Whether to include hidden products in the returned results. */
+    includeHiddenProducts?: boolean;
+    /** Optional pagination parameters */
+    paging?: Paging;
+}
+export interface Paging {
+    /** Amount of items to load per page. */
+    limit?: number | null;
+    /** Number of items to skip in the display (relevant for all pages after the first). */
+    offset?: number | null;
+}
+export interface GetProductIdsForSubscriptionOptionResponse {
+    /** IDs of products associated with the specified subscription option. */
+    productIds?: string[];
+    /** Paging metadata. */
+    metadata?: PagingMetadata;
+    /** Number of total results. */
+    totalResults?: number;
+}
+export interface PagingMetadata {
+    /** Amount of items to load per page. */
+    items?: number;
+    /** Number of items to skip in the display (relevant for all pages after the first). */
+    offset?: number;
+}
+export interface GetOneTimePurchasesStatusRequest {
+    /** Product ID. */
+    productId: string;
+}
+export interface GetOneTimePurchasesStatusResponse {
+    /** Whether the specified product is available for one-time purchase */
+    allowed?: boolean;
+}

package/build/es/src/stores-v1-subscription-option.types.js

@@ -0,0 +1,17 @@
+/** Frequency unit of recurring payment */
+export var SubscriptionFrequency;
+(function (SubscriptionFrequency) {
+    SubscriptionFrequency["UNDEFINED"] = "UNDEFINED";
+    SubscriptionFrequency["DAY"] = "DAY";
+    SubscriptionFrequency["WEEK"] = "WEEK";
+    SubscriptionFrequency["MONTH"] = "MONTH";
+    SubscriptionFrequency["YEAR"] = "YEAR";
+})(SubscriptionFrequency || (SubscriptionFrequency = {}));
+export var DiscountType;
+(function (DiscountType) {
+    DiscountType["UNDEFINED"] = "UNDEFINED";
+    /** No discount */
+    DiscountType["AMOUNT"] = "AMOUNT";
+    DiscountType["PERCENT"] = "PERCENT";
+})(DiscountType || (DiscountType = {}));
+//# sourceMappingURL=stores-v1-subscription-option.types.js.map

package/build/es/src/stores-v1-subscription-option.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-v1-subscription-option.types.js","sourceRoot":"","sources":["../../../src/stores-v1-subscription-option.types.ts"],"names":[],"mappings":"AAyBA,0CAA0C;AAC1C,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,gDAAuB,CAAA;IACvB,oCAAW,CAAA;IACX,sCAAa,CAAA;IACb,wCAAe,CAAA;IACf,sCAAa,CAAA;AACf,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC;AASD,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,kBAAkB;IAClB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;AACrB,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB"}