@rechargeapps/storefront-client 0.8.1 → 0.10.0

package/dist/index.d.ts

@@ -335,6 +335,9 @@ interface Charge {
     /** The date time at which the Charge was most recently updated. */
     updated_at: IsoDateString;
 }
+interface ChargeResponse {
+    charge: Charge;
+}
 interface ChargeListResponse {
     next_cursor: null | string;
     previous_cursor: null | string;
@@ -503,6 +506,12 @@ interface Address {
     /** The date and time when the address was last updated. */
     updated_at: IsoDateString;
 }
+interface SkipFutureChargeAddressResponse {
+    charge: Charge;
+}
+interface AddressResponse {
+    address: Address;
+}
 interface AddressListResponse {
     next_cursor: null | string;
     previous_cursor: null | string;
@@ -519,7 +528,7 @@ interface AddressListParams extends ListParams<AddressSortBy> {
 
 interface Session {
     apiToken: string;
-    customerId: string;
+    customerId?: string;
 }
 
 /** Returns all addresses from the store, or addresses for the customer given in the parameter. */
@@ -541,7 +550,7 @@ declare function mergeAddresses(session: Session, mergeRequest: MergeAddressesRe
  */
 declare function skipFutureCharge(session: Session, id: string | number, skipRequest: SkipFutureChargeAddressRequest): Promise<Charge>;
 
-declare function loginShopifyAppProxy(): Promise<Session | null>;
+declare function loginShopifyAppProxy(): Promise<Session>;
 declare function loginShopifyApi(customerAccessToken: string, storefrontAccessToken: string): Promise<Session | null>;
 
 declare function getCharge(session: Session, id: number | string): Promise<Charge>;
@@ -563,8 +572,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>;
@@ -588,6 +595,11 @@ interface RequestOptionsHeaders {
 }
 declare type RequestOptions = GetRequestOptions & CRUDRequestOptions & RequestOptionsHeaders;
 
+interface LoginResponse {
+    api_token: string;
+    customer_id?: string;
+}
+
 interface BundleSelection {
     collectionId: string;
     externalProductId: string;
@@ -948,24 +960,56 @@ interface CDNBundleSettings {
     variants: CDNBundleVariant[];
 }
 
-declare type StorefrontEnvironment = 'stage' | 'prod';
-interface StorefrontOptions {
-    storeIdentifier: string;
-    /** This is only for internal use. Sets the environment where data is fetched from. */
-    environment: StorefrontEnvironment;
+interface Customer {
+    /** Unique numeric identifier for the Customer. */
+    id: number;
+    /** An object containing analytics data associated with the customer. */
+    analytics_data: AnalyticsData;
+    /** The date and time when the customer was created. */
+    created_at: IsoDateString;
+    /** The email address of the customer. */
+    email: string;
+    /** An object containing external ids for the customer record. */
+    external_customer_id: ExternalId;
+    /** Date when first charge was processed for the customer. */
+    first_charge_processed_at: IsoDateString;
+    /** The customer’s first name. */
+    first_name: string;
+    /** A boolean that indicates if the customer has a payment method that is in dunning (failed charge). */
+    has_payment_method_in_dunning: boolean;
+    /** Is the payment method valid or not. */
+    has_valid_payment_method: boolean;
+    /** The unique string identifier used in a customers portal link. */
+    hash: string;
+    /** The customer’s last name. */
+    last_name: string;
+    /** The number of active subscriptions on addresses associated with the customer. */
+    subscriptions_active_count: number;
+    /** The total number of subscriptions created on addresses associated with the customer. */
+    subscriptions_total_count: number;
+    /** The date and time when the customer was last updated. */
+    updated_at: IsoDateString;
+}
+declare type OptionalUpdateProps$2 = 'email' | 'first_name' | 'last_name' | 'external_customer_id';
+declare type UpdateCustomerRequest = Partial<Pick<Customer, OptionalUpdateProps$2>>;
+interface CustomerDeliveryScheduleParams {
+    delivery_count_future?: number;
+    future_internal?: number;
+    date_max?: IsoDateString;
+}
+interface Delivery {
+    date: IsoDateString;
+    orders: Order[];
+}
+interface CustomerDeliveryScheduleResponse {
+    customer: {
+        id: number;
+        email: string;
+        first_name: string;
+        last_name: string;
+    };
+    deliveries: Delivery[];
 }
-
-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 getBundleId(bundle: Bundle): Promise<string>;
-declare function validateBundle(bundle: Bundle): Promise<boolean>;
 
 declare type MembershipStatus = 'active' | 'inactive';
 interface Membership {
@@ -981,6 +1025,9 @@ interface Membership {
     subscription_cancelled_at: IsoDateString | null;
     image?: string;
 }
+interface MembershipResponse {
+    membership: Membership;
+}
 interface MembershipListResponse {
     next_cursor: null | string;
     previous_cursor: null | string;
@@ -1013,15 +1060,6 @@ interface CancelMembershipRequest {
     expires_at: IsoDateString;
 }
 
-/** Retrieves membership information for passed in id */
-declare function getMembership(session: Session, id: string | number): Promise<Membership>;
-/** Retrieves a list of memberships  */
-declare function listMemberships(session: Session, query?: MembershipListParams): Promise<MembershipListResponse>;
-/** Cancels a membership  */
-declare function cancelMembership(session: Session, id: string | number, cancelRequest: CancelMembershipRequest): Promise<Membership>;
-/** Activates a membership  */
-declare function activateMembership(session: Session, id: string | number, activateRequest: ActivateMembershipRequest): Promise<Membership>;
-
 interface Onetime {
     /** Unique numeric identifier for the Onetime purchase. */
     id: number;
@@ -1068,8 +1106,8 @@ interface CreateProps {
     add_to_next_charge?: boolean;
 }
 declare type CreateOnetimeRequest = SubType<Onetime, RequiredCreateProps$1, OptionalCreateProps$1> & CreateProps;
-declare type OptionalUpdateProps$2 = 'address_id' | 'next_charge_scheduled_at' | 'properties' | 'quantity' | 'external_variant_id' | 'sku';
-declare type UpdateOnetimeRequest = Partial<Pick<Onetime, OptionalUpdateProps$2>>;
+declare type OptionalUpdateProps$1 = 'address_id' | 'next_charge_scheduled_at' | 'properties' | 'quantity' | 'external_variant_id' | 'sku';
+declare type UpdateOnetimeRequest = Partial<Pick<Onetime, OptionalUpdateProps$1>>;
 interface OnetimesResponse {
     next_cursor: null | string;
     previous_cursor: null | string;
@@ -1078,14 +1116,85 @@ interface OnetimesResponse {
 declare type OnetimesSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
 declare type OnetimeListParams = ListParams<OnetimesSortBy>;
 
-declare function getOnetime(session: Session, id: string | number): Promise<Onetime>;
-declare function listOnetimes(session: Session, query?: OnetimeListParams): Promise<OnetimesResponse>;
-declare function createOnetime(session: Session, createRequest: CreateOnetimeRequest): Promise<Onetime>;
-declare function updateOnetime(session: Session, id: string | number, updateRequest: UpdateOnetimeRequest): Promise<Onetime>;
-declare function deleteOnetime(session: Session, id: string | number): Promise<void>;
+/** @internal */
+declare type StorefrontEnvironment = 'stage' | 'prod';
+/** @internal */
+interface StorefrontOptions {
+    storeIdentifier: string;
+    /** Recharge storefront access token */
+    storefrontAccessToken?: string;
+    /** This is only for internal use. Sets the environment where data is fetched from. */
+    environment: StorefrontEnvironment;
+}
+interface InitOptions {
+    storeIdentifier?: string;
+    /** Recharge storefront access token */
+    storefrontAccessToken?: string;
+}
 
-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;
+}
 
 interface Subscription {
     /** Unique numeric identifier for the subscription. */
@@ -1183,8 +1292,8 @@ interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
 declare type RequiredCreateProps = 'address_id' | 'charge_interval_frequency' | 'external_variant_id' | 'next_charge_scheduled_at' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity';
 declare type OptionalCreateProps = 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'external_product_id' | 'product_title' | 'properties' | 'status';
 declare type CreateSubscriptionRequest = SubType<Subscription, RequiredCreateProps, OptionalCreateProps>;
-declare type OptionalUpdateProps$1 = 'charge_interval_frequency' | 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity' | 'external_product_id' | 'external_variant_id' | 'properties' | 'sku' | 'sku_override';
-declare type UpdateSubscriptionRequest = Partial<Pick<Subscription, OptionalUpdateProps$1>>;
+declare type OptionalUpdateProps = 'charge_interval_frequency' | 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity' | 'external_product_id' | 'external_variant_id' | 'properties' | 'sku' | 'sku_override';
+declare type UpdateSubscriptionRequest = Partial<Pick<Subscription, OptionalUpdateProps>>;
 interface UpdateSubscriptionParams {
     /** Controls whether the QUEUED charges linked to the subscription should be regenerated upon subscription update. By default the flag is set to false which will delay charge regeneration 5 seconds. This enables running multiple calls to perform changes and receive responses much faster since the API won’t wait for a charge regeneration to complete. Setting this parameter to true will cause charge regeneration to complete before returning a response. */
     commit?: boolean;
@@ -1195,6 +1304,39 @@ interface CancelSubscriptionRequest {
     send_email?: boolean;
 }
 
+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>;
+
+/** Retrieves membership information for passed in id */
+declare function getMembership(session: Session, id: string | number): Promise<Membership>;
+/** Retrieves a list of memberships */
+declare function listMemberships(session: Session, query?: MembershipListParams): Promise<MembershipListResponse>;
+/** Cancels a membership */
+declare function cancelMembership(session: Session, id: string | number, cancelRequest: CancelMembershipRequest): Promise<Membership>;
+/** Activates a membership */
+declare function activateMembership(session: Session, id: string | number, activateRequest: ActivateMembershipRequest): Promise<Membership>;
+
+declare function getOnetime(session: Session, id: string | number): Promise<Onetime>;
+declare function listOnetimes(session: Session, query?: OnetimeListParams): Promise<OnetimesResponse>;
+declare function createOnetime(session: Session, createRequest: CreateOnetimeRequest): Promise<Onetime>;
+declare function updateOnetime(session: Session, id: string | number, updateRequest: UpdateOnetimeRequest): Promise<Onetime>;
+declare function deleteOnetime(session: Session, id: string | number): Promise<void>;
+
+declare function getOrder(session: Session, id: string | number): Promise<Order>;
+declare function listOrders(session: Session, query?: OrderListParams): Promise<OrdersResponse>;
+
+declare function getPlan(session: Session, id: string | number): Promise<Plan>;
+declare function listPlans(session: Session, query?: PlanListParams): Promise<PlansResponse>;
+
 declare function getSubscription(session: Session, id: string | number): Promise<Subscription>;
 declare function listSubscriptions(session: Session, query?: SubscriptionListParams): Promise<SubscriptionsResponse>;
 /**
@@ -1229,53 +1371,10 @@ declare function cancelSubscription(session: Session, id: string | number, cance
  */
 declare function activateSubscription(session: Session, id: string | number): Promise<Subscription>;
 
-interface Customer {
-    /** Unique numeric identifier for the Customer. */
-    id: number;
-    /** An object containing analytics data associated with the customer. */
-    analytics_data: AnalyticsData;
-    /** The date and time when the customer was created. */
-    created_at: IsoDateString;
-    /** The email address of the customer. */
-    email: string;
-    /** An object containing external ids for the customer record. */
-    external_customer_id: ExternalId;
-    /** Date when first charge was processed for the customer. */
-    first_charge_processed_at: IsoDateString;
-    /** The customer’s first name. */
-    first_name: string;
-    /** A boolean that indicates if the customer has a payment method that is in dunning (failed charge). */
-    has_payment_method_in_dunning: boolean;
-    /** Is the payment method valid or not. */
-    has_valid_payment_method: boolean;
-    /** The unique string identifier used in a customers portal link. */
-    hash: string;
-    /** The customer’s last name. */
-    last_name: string;
-    /** The number of active subscriptions on addresses associated with the customer. */
-    subscriptions_active_count: number;
-    /** The total number of subscriptions created on addresses associated with the customer. */
-    subscriptions_total_count: number;
-    /** The date and time when the customer was last updated. */
-    updated_at: IsoDateString;
-}
-declare type OptionalUpdateProps = 'email' | 'first_name' | 'last_name' | 'external_customer_id';
-declare type UpdateCustomerRequest = Partial<Pick<Customer, OptionalUpdateProps>>;
-interface CustomerDeliveryScheduleParams {
-    delivery_count_future?: number;
-    future_internal?: number;
-    date_max?: IsoDateString;
-}
-interface Delivery {
-    date: IsoDateString;
-    orders: Order[];
-}
-
 declare function getCustomer(session: Session): Promise<Customer>;
 declare function updateCustomer(session: Session, updateRequest: UpdateCustomerRequest): Promise<Customer>;
 declare function getDeliverySchedule(session: Session, query?: CustomerDeliveryScheduleParams): Promise<Delivery[]>;
 
-declare type InitOptions = Omit<Partial<StorefrontOptions>, 'environment'>;
 declare const api: {
     get<T>(url: string, requestOptions?: GetRequestOptions): Promise<T>;
     post<T_1>(url: string, requestOptions?: CRUDRequestOptions): Promise<T_1>;
@@ -1284,4 +1383,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 { ActivateMembershipRequest, Address, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, ApplyDiscountRequest, AssociatedAddress, 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, CancelMembershipRequest, CancelSubscriptionRequest, ChannelSettings, Charge, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, Delivery, Discount, ExternalId, ExternalTransactionId, FirstOption, GetRequestOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipListParams, MembershipListResponse, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Method, Onetime, OnetimeListParams, OnetimesResponse, OnetimesSortBy, Order, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProductImage, Property, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionListParams, SubscriptionPreferences, SubscriptionSortBy, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateCustomerRequest, UpdateOnetimeRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, 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 };