@rechargeapps/storefront-client 0.6.2 → 0.7.1

package/dist/index.d.ts

@@ -346,12 +346,6 @@ interface ApplyDiscountRequest {
     /** ID of the Discount you want to apply to a Charge. */
     discount_id?: number;
 }
-interface RefundChargeRequest {
-    /** Amount of money that will be refunded. It can be fully or partially refunded. */
-    amount: string;
-    /** If this parameter has value true, the Charge will be totally refunded. */
-    full_refund?: boolean;
-}
 declare type ChargeSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
 interface ChargeListParams extends ListParams<ChargeSortBy> {
     /** Filter Charges by Address. */
@@ -523,37 +517,42 @@ interface AddressListParams extends ListParams<AddressSortBy> {
     created_at_max?: IsoDateString;
 }
 
-/** Returns all addresses from the store, or addresses for the user given in the parameter. */
-declare function listAddresses(query?: AddressListParams): Promise<AddressListResponse>;
+interface Session {
+    apiToken: string;
+    customerId: string;
+}
+
+/** Returns all addresses from the store, or addresses for the customer given in the parameter. */
+declare function listAddresses(session: Session, query?: AddressListParams): Promise<AddressListResponse>;
 /** Retrieves address for customer based on specified address id. */
-declare function getAddress(id: number): Promise<Address>;
+declare function getAddress(session: Session, id: string | number): Promise<Address>;
 /** Create a new address for a customer. */
-declare function createAddress(request: CreateAddressRequest): Promise<Address>;
+declare function createAddress(session: Session, createRequest: CreateAddressRequest): Promise<Address>;
 /** Updates an existing address to match the specified parameters. */
-declare function updateAddress(id: number, request: UpdateAddressRequest): Promise<Address>;
+declare function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest): Promise<Address>;
 /** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */
-declare function deleteAddress(id: number): Promise<void>;
+declare function deleteAddress(session: Session, id: string | number): Promise<void>;
 /**
  * Merges up to 10 source addresses into 1 target address.
  */
-declare function mergeAddresses(request: MergeAddressesRequest): Promise<Address>;
+declare function mergeAddresses(session: Session, mergeRequest: MergeAddressesRequest): Promise<Address>;
 /**
  * Skip a Charge in the future for one or multiple Subscriptions associated with the Address.
  */
-declare function skipFutureCharge(id: number, request: SkipFutureChargeAddressRequest): Promise<Charge>;
+declare function skipFutureCharge(session: Session, id: string | number, skipRequest: SkipFutureChargeAddressRequest): Promise<Charge>;
 
-declare const login: () => Promise<boolean>;
-declare const logout: () => void;
+declare function loginShopifyAppProxy(): Promise<Session | null>;
+declare function loginShopifyApi(customerAccessToken: string, storefrontAccessToken: string): Promise<Session | null>;
 
-declare function getCharge(id: number | string): Promise<Charge>;
+declare function getCharge(session: Session, id: number | string): Promise<Charge>;
 /** Lists charges */
-declare function listCharges(query?: ChargeListParams): Promise<ChargeListResponse>;
+declare function listCharges(session: Session, query?: ChargeListParams): Promise<ChargeListResponse>;
 /**
  * You cannot add a Discount to an existing queued Charge if the Charge or the associated Address already has one.
  * You can provide either discount_id or discount_code. If both parameters are passed, the value for discount_id will take precedence.
  * If a Charge has a Discount and it gets updated, or a regeneration occurs, the Discount will be lost. Regeneration is a process that refreshes the Charge JSON with new data in the case of the Subscription or Address being updated.
  */
-declare function applyDiscount(id: number | string, request: ApplyDiscountRequest): Promise<Charge>;
+declare function applyDiscount(session: Session, id: number | string, applyRequest: ApplyDiscountRequest): Promise<Charge>;
 /**
  * Remove a Discount from a Charge without destroying the Discount.
  * In most cases the Discount should be removed from the Address. When the Discount is removed from the Address, the Discount is also removed from any future Charges.
@@ -561,16 +560,11 @@ declare function applyDiscount(id: number | string, request: ApplyDiscountReques
  * When removing your Discount, it is preferable to pass the address_id so that the Discount stays removed if the Charge is regenerated. Only pass charge_id in edge cases in which there are two or more Charges on a parent Address and you only want to remove the Discount from one Charge.
  * If you pass both parameters, it will remove the Discount from the Address.
  */
-declare function removeDiscount(id: number | string): Promise<Charge>;
-declare function skipCharge(id: number | string): Promise<Charge>;
-declare function unskipCharge(id: number | string): Promise<Charge>;
-declare function refundCharge(id: number | string, request: RefundChargeRequest): Promise<Charge>;
+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(id: number | string): Promise<Charge>;
-/**
- * If you are leveraging the authorize/capture workflow with Recharge, the charge/{id}/capture_payment endpoint is how to capture the funds of a previously authorized Charge.
- */
-declare function captureCharge(id: number | string): Promise<Charge>;
+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>;
@@ -959,21 +953,74 @@ interface StorefrontOptions {
     storeIdentifier: string;
     /** This is only for internal use. Sets the environment where data is fetched from. */
     environment: StorefrontEnvironment;
-    /** currently only for internal use */
-    apiKey?: string;
 }
 
-declare const getProduct: (externalProductId: string | number) => Promise<CDNProduct>;
-declare const getStoreSettings: () => Promise<CDNStoreSettings>;
-declare const getWidgetSettings: () => Promise<CDNWidgetSettings>;
-declare const getProductsAndSettings: () => Promise<CDNProductsAndSettings>;
-declare const getProducts: () => Promise<CDNProductKeyObject[]>;
-declare const getProductAndSettings: (externalProductId: string | number) => Promise<CDNProductAndSettings>;
-declare const getBundleSettings: (externalProductId: string | number) => Promise<CDNBundleSettings | null | undefined>;
-declare const resetCache: () => void;
+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 {
+    id: string;
+    store_id: number;
+    customer_id: number;
+    membership_program_id: number;
+    purchase_item_id: number | null;
+    status: MembershipStatus;
+    created_at: IsoDateString;
+    deleted_at: IsoDateString | null;
+    expires_at: IsoDateString | null;
+    subscription_cancelled_at: IsoDateString | null;
+    image?: string;
+}
+interface MembershipListResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    memberships: Membership[];
+}
+declare type MembershipsSortBy = 'id-asc' | 'id-desc';
+declare type membershipIncludes = 'customer' | 'subscriptions';
+declare type MembershipIncludes = `${membershipIncludes}` | `${membershipIncludes},${membershipIncludes}`;
+interface MembershipListParams extends ListParams<MembershipsSortBy> {
+    include?: MembershipIncludes;
+    customer_id?: number;
+    customer_name?: string;
+    customer_email?: string;
+    membership_program_ids?: string;
+    status?: MembershipStatus;
+    created_at_min?: IsoDateString;
+    created_at_max?: IsoDateString;
+    expires_at_min?: IsoDateString;
+    expires_at_max?: IsoDateString;
+    include_cancelled?: boolean;
+    include_deleted?: boolean;
+}
+interface ActivateMembershipRequest {
+    expires_at: string | null;
+}
+interface CancelMembershipRequest {
+    cancel_immediately: boolean;
+    cancellation_reason: string;
+    cancellation_reason_comments: string;
+    expires_at: IsoDateString;
+}
 
-declare const getBundleId: (bundle: Bundle) => Promise<string>;
-declare const 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>;
 
 interface Onetime {
     /** Unique numeric identifier for the Onetime purchase. */
@@ -1031,14 +1078,14 @@ 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 const getOnetime: (id: string | number) => Promise<Onetime>;
-declare const listOnetimes: (query?: OnetimeListParams) => Promise<OnetimesResponse>;
-declare const createOnetime: (data: CreateOnetimeRequest) => Promise<Onetime>;
-declare const updateOnetime: (id: string | number, data: UpdateOnetimeRequest) => Promise<Onetime>;
-declare const deleteOnetime: (id: string | number) => Promise<void>;
+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 const getOrder: (id: string | number) => Promise<Order>;
-declare const listOrders: (query?: OrderListParams) => Promise<OrdersResponse>;
+declare function getOrder(session: Session, id: string | number): Promise<Order>;
+declare function listOrders(session: Session, query?: OrderListParams): Promise<OrdersResponse>;
 
 interface Subscription {
     /** Unique numeric identifier for the subscription. */
@@ -1148,41 +1195,41 @@ interface CancelSubscriptionRequest {
     send_email?: boolean;
 }
 
-declare const getSubscription: (id: string | number) => Promise<Subscription>;
-declare const listSubscriptions: (query?: SubscriptionListParams) => Promise<SubscriptionsResponse>;
+declare function getSubscription(session: Session, id: string | number): Promise<Subscription>;
+declare function listSubscriptions(session: Session, query?: SubscriptionListParams): Promise<SubscriptionsResponse>;
 /**
  * When creating a subscription via API, order_interval_frequency and charge_interval_frequency values do not necessarily
  * need to match the values set in the respective Plans. The product, however, does need to have at least one Plan in order
  * to be added to a subscription.
  */
-declare const createSubscription: (data: CreateSubscriptionRequest) => Promise<Subscription>;
+declare function createSubscription(session: Session, createRequest: CreateSubscriptionRequest): Promise<Subscription>;
 /**
  * Updating parameters like frequency, charge_interval_frequency, order_interval_frequency, order_interval_unit will cause our algorithm to automatically recalculate the next charge date (next_charge_scheduled_at).
  * WARNING: This update will remove skipped and manually changed charges.
  * If you want to change the next charge date (next_charge_scheduled_at) we recommend you to update these parameters first.
  * When updating order_interval_unit OR order_interval_frequency OR charge_interval_frequency all three parameters are required.
  */
-declare const updateSubscription: (id: string | number, data: UpdateSubscriptionRequest, query?: UpdateSubscriptionParams) => Promise<Subscription>;
+declare function updateSubscription(session: Session, id: string | number, updateRequest: UpdateSubscriptionRequest, query?: UpdateSubscriptionParams): Promise<Subscription>;
 /**
  * If there are two active subscriptions with the same address_id, and you update their
  * next_charge_date parameters to match, their charges will get merged into a new charge
  * with a new id
  */
-declare const updateSubscriptionChargeDate: (id: string | number, date: IsoDateString) => Promise<Subscription>;
-declare const updateSubscriptionAddress: (id: string | number, address_id: string | number) => Promise<Subscription>;
+declare function updateSubscriptionChargeDate(session: Session, id: string | number, date: IsoDateString): Promise<Subscription>;
+declare function updateSubscriptionAddress(session: Session, id: string | number, address_id: string | number): Promise<Subscription>;
 /**
  * An involuntary subscription cancelled due to max retries reached will trigger the
  * charge/max_retries_reached webhook. If this leads to the subscription being cancelled,
  * the subscription/cancelled webhook will trigger.
  */
-declare const cancelSubscription: (id: string | number, data: CancelSubscriptionRequest) => Promise<Subscription>;
+declare function cancelSubscription(session: Session, id: string | number, cancelRequest: CancelSubscriptionRequest): Promise<Subscription>;
 /**
  * When activating subscription, following attributes will be set to null: cancelled_at, cancellation_reason
  * and cancellation_reason_comments.
  */
-declare const activateSubscription: (id: string | number) => Promise<Subscription>;
+declare function activateSubscription(session: Session, id: string | number): Promise<Subscription>;
 
-interface User {
+interface Customer {
     /** Unique numeric identifier for the Customer. */
     id: number;
     /** An object containing analytics data associated with the customer. */
@@ -1213,8 +1260,8 @@ interface User {
     updated_at: IsoDateString;
 }
 declare type OptionalUpdateProps = 'email' | 'first_name' | 'last_name' | 'external_customer_id';
-declare type UpdateUserRequest = Partial<Pick<User, OptionalUpdateProps>>;
-interface UserDeliveryScheduleParams {
+declare type UpdateCustomerRequest = Partial<Pick<Customer, OptionalUpdateProps>>;
+interface CustomerDeliveryScheduleParams {
     delivery_count_future?: number;
     future_internal?: number;
     date_max?: IsoDateString;
@@ -1224,11 +1271,11 @@ interface Delivery {
     orders: Order[];
 }
 
-declare const getUser: () => Promise<User>;
-declare const updateUser: (data: UpdateUserRequest) => Promise<User>;
-declare const getDeliverySchedule: (query?: UserDeliveryScheduleParams) => Promise<Delivery[]>;
+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' | 'apiKey'>;
+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>;
@@ -1237,4 +1284,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, activateSubscription, api, applyDiscount, cancelSubscription, captureCharge, createAddress, createOnetime, createSubscription, deleteAddress, deleteOnetime, getAddress, getBundleId, getBundleSettings, getCharge, getDeliverySchedule, getOnetime, getOrder, getProduct, getProductAndSettings, getProducts, getProductsAndSettings, getStoreSettings, getSubscription, getUser, getWidgetSettings, initRecharge, listAddresses, listCharges, listOnetimes, listOrders, listSubscriptions, login, logout, mergeAddresses, processCharge, refundCharge, removeDiscount, resetCache, skipCharge, skipFutureCharge, unskipCharge, updateAddress, updateOnetime, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateUser, 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, 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 };