@rechargeapps/storefront-client 0.8.0 → 0.9.0

package/dist/index.d.ts

@@ -563,8 +563,6 @@ declare function applyDiscount(session: Session, id: number | string, applyReque
 declare function removeDiscount(session: Session, id: number | string): Promise<Charge>;
 declare function skipCharge(session: Session, id: number | string): Promise<Charge>;
 declare function unskipCharge(session: Session, id: number | string): Promise<Charge>;
-/** The charge processing route can be used to process Charges that are in a queued or error status. */
-declare function processCharge(session: Session, id: number | string): Promise<Charge>;
 
 declare type Method = 'get' | 'post' | 'put' | 'delete';
 declare type Request = <T>(method: Method, url: string, options?: RequestOptions) => Promise<T>;
@@ -955,14 +953,14 @@ interface StorefrontOptions {
     environment: StorefrontEnvironment;
 }
 
-declare function getProduct(externalProductId: string | number): Promise<CDNProduct>;
-declare function getStoreSettings(): Promise<CDNStoreSettings>;
-declare function getWidgetSettings(): Promise<CDNWidgetSettings>;
-declare function getProductsAndSettings(): Promise<CDNProductsAndSettings>;
-declare function getProducts(): Promise<CDNProductKeyObject[]>;
-declare function getProductAndSettings(externalProductId: string | number): Promise<CDNProductAndSettings>;
-declare function getBundleSettings(externalProductId: string | number): Promise<CDNBundleSettings | null | undefined>;
-declare function resetCache(): Promise<void>;
+declare function getCDNProduct(externalProductId: string | number): Promise<CDNProduct>;
+declare function getCDNStoreSettings(): Promise<CDNStoreSettings>;
+declare function getCDNWidgetSettings(): Promise<CDNWidgetSettings>;
+declare function getCDNProductsAndSettings(): Promise<CDNProductsAndSettings>;
+declare function getCDNProducts(): Promise<CDNProductKeyObject[]>;
+declare function getCDNProductAndSettings(externalProductId: string | number): Promise<CDNProductAndSettings>;
+declare function getCDNBundleSettings(externalProductId: string | number): Promise<CDNBundleSettings | null | undefined>;
+declare function resetCDNCache(): Promise<void>;
 
 declare function getBundleId(bundle: Bundle): Promise<string>;
 declare function validateBundle(bundle: Bundle): Promise<boolean>;
@@ -1087,6 +1085,73 @@ declare function deleteOnetime(session: Session, id: string | number): Promise<v
 declare function getOrder(session: Session, id: string | number): Promise<Order>;
 declare function listOrders(session: Session, query?: OrderListParams): Promise<OrdersResponse>;
 
+interface ChannelSettings {
+    api: {
+        display: boolean;
+    };
+    checkout_page: {
+        display: boolean;
+    };
+    customer_portal: {
+        display: boolean;
+    };
+    merchant_portal: {
+        display: boolean;
+    };
+}
+interface SubscriptionPreferences {
+    charge_interval_frequency: number;
+    cutoff_day_of_month: null | number;
+    cutoff_day_of_week: null | number;
+    expire_after_specific_number_of_charges: null | number;
+    interval_unit: 'day' | 'week' | 'month';
+    order_day_of_month: number;
+    order_day_of_week: null | number;
+    order_interval_frequency: number;
+}
+declare type PlanType = 'subscription' | 'prepaid' | 'onetime';
+interface Plan {
+    /** Unique numeric identifier for the Plan. */
+    id: number;
+    /** An object containing the availability of the plan through various supported channels. */
+    channel_settings: ChannelSettings;
+    /** The time the plan was created. */
+    created_at: IsoDateString;
+    /** If deleted, the time the plan was deleted. */
+    deleted_at: IsoDateString;
+    /** The discount amount applied to the product price when purchased through this Plan. All Plans for a product must have the same discount amount. */
+    discount_amount: string;
+    /** Used in combination with discount amount to determine the discount applied on a product price when purchased through this Plan. */
+    discount_type: 'percentage';
+    /** An object containing the product id as it appears in external platforms. */
+    external_product_id: ExternalId;
+    /** The number indicating the order which the plan will be in a list of related plans. */
+    sort_order: number;
+    /** An object containing the various subscription preferences associated with this plan. */
+    subscription_preferences: SubscriptionPreferences;
+    /** The title of the plan. All Plans for a product must have the same title. */
+    title: string;
+    /** The type of the plan. Products with a prepaid plan cannot have plans of other types. */
+    type: PlanType;
+    /** The time the plan was last updated. */
+    updated_at: IsoDateString;
+}
+interface PlansResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    plans: Plan[];
+}
+declare type PlanSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
+interface PlanListParams extends ListParams<PlanSortBy> {
+    external_product_id?: string;
+    updated_at_max?: IsoDateString;
+    updated_at_min?: IsoDateString;
+    type?: PlanType;
+}
+
+declare function getPlan(session: Session, id: string | number): Promise<Plan>;
+declare function listPlans(session: Session, query?: PlanListParams): Promise<PlansResponse>;
+
 interface Subscription {
     /** Unique numeric identifier for the subscription. */
     id: number;
@@ -1284,4 +1349,4 @@ declare const api: {
 };
 declare function initRecharge(opt?: InitOptions): void;
 
-export { Bundle, BundleSelection, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, FirstOption, GetRequestOptions, InitOptions, IntervalUnit, Method, PriceAdjustmentsType, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, Translations, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscount, cancelMembership, cancelSubscription, createAddress, createOnetime, createSubscription, deleteAddress, deleteOnetime, getAddress, getBundleId, getBundleSettings, getCharge, getCustomer, getDeliverySchedule, getMembership, getOnetime, getOrder, getProduct, getProductAndSettings, getProducts, getProductsAndSettings, getStoreSettings, getSubscription, getWidgetSettings, initRecharge, listAddresses, listCharges, listMemberships, listOnetimes, listOrders, listSubscriptions, loginShopifyApi, loginShopifyAppProxy, mergeAddresses, processCharge, removeDiscount, resetCache, skipCharge, skipFutureCharge, unskipCharge, updateAddress, updateCustomer, updateOnetime, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, validateBundle };
+export { Bundle, BundleSelection, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, FirstOption, GetRequestOptions, InitOptions, IntervalUnit, Method, PriceAdjustmentsType, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, Translations, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscount, cancelMembership, cancelSubscription, createAddress, createOnetime, createSubscription, deleteAddress, deleteOnetime, getAddress, getBundleId, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getDeliverySchedule, getMembership, getOnetime, getOrder, getPlan, getSubscription, initRecharge, listAddresses, listCharges, listMemberships, listOnetimes, listOrders, listPlans, listSubscriptions, loginShopifyApi, loginShopifyAppProxy, mergeAddresses, removeDiscount, resetCDNCache, skipCharge, skipFutureCharge, unskipCharge, updateAddress, updateCustomer, updateOnetime, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, validateBundle };