@rechargeapps/storefront-client 0.5.3 → 0.6.1

package/dist/index.d.ts

@@ -1,6 +1,3 @@
-declare const login: () => Promise<boolean>;
-declare const logout: () => void;
-
 /** HEXA, RGBA, HSLA */
 declare type ColorString = string;
 /** HTML String */
@@ -111,6 +108,17 @@ interface Discount {
     /** The type of the value of the Discount. */
     value_type: 'percentage' | 'fixed_amount';
 }
+interface AnalyticsData {
+    utm_params: {
+        utm_campaign: string;
+        utm_content: string;
+        utm_data_source: string;
+        utm_source: string;
+        utm_medium: string;
+        utm_term: string;
+        utm_timestamp: string;
+    }[];
+}
 declare type SubType<T, TRequired extends keyof T = keyof T, TOptional extends keyof T = keyof T> = Required<Pick<T, TRequired>> & Partial<Pick<T, TOptional>>;
 
 interface ShippingLine {
@@ -242,17 +250,6 @@ interface OrderListParams extends ListParams<OrderSortBy> {
     updated_at_min?: IsoDateString;
 }
 
-interface ChargeAnalyticsData {
-    utm_params: {
-        utm_campaign: string;
-        utm_content: string;
-        utm_data_source: string;
-        utm_source: string;
-        utm_medium: string;
-        utm_term: string;
-        utm_timestamp: string;
-    }[];
-}
 declare type ChargeStatus = 'success' | 'error' | 'queued' | 'skipped' | 'refunded' | 'partially_refunded' | 'pending_manual_payment' | 'pending';
 interface Charge {
     /** The unique numeric identifier for the Charge. */
@@ -260,7 +257,7 @@ interface Charge {
     /** The ID of the shipping Address tied to the Charge.*/
     address_id: number;
     /** An object containing analytics data associated with the Charge. */
-    analytics_data: ChargeAnalyticsData;
+    analytics_data: AnalyticsData;
     /** All the billing information related to the charge. */
     billing_address: AssociatedAddress;
     /** Details of the access method used by the purchaser. */
@@ -398,6 +395,156 @@ interface ChargeListParams extends ListParams<ChargeSortBy> {
     created_at_max?: IsoDateString;
 }
 
+interface CreateAddressRequest {
+    /** Unique numeric identifier for the customer associated with the address. */
+    customer_id: number;
+    /** The street associated with the Address. Minimum length is 1 character. */
+    address1: string;
+    /** Any additional information associated with the Address. */
+    address2?: string;
+    /** The city associated with the address. */
+    city: string;
+    /** The company associated with the address. */
+    company?: string;
+    /** 2-letter country code. */
+    country_code: string;
+    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
+    discounts?: {
+        id: number;
+    }[];
+    /** The customer’s first name associated with the address. */
+    first_name: string;
+    /** The customer’s last name associated with the address. */
+    last_name: string;
+    /** Replaces cart_attributes. Extra information that is added to the order. */
+    order_attributes?: Property[];
+    /** Notes to be added to all orders associated with the address. */
+    order_note?: string | null;
+    /** Payment method id for the Payment_method to be associated to this address. */
+    payment_method_id?: number;
+    /** The phone number associated with the address. Must be included in the request schema but can be an empty string. */
+    phone: string;
+    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
+    presentment_currency?: string | null;
+    /** The state or province associated with the address. */
+    province: string | null;
+    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
+    shipping_lines_override?: {
+        code: string;
+        price: string;
+        title: string;
+    }[] | null;
+    /** The zip or postal code associated with the address. */
+    zip: string;
+}
+declare type UpdateAddressRequest = Omit<Partial<CreateAddressRequest>, 'presentment_currency' | 'customer_id'>;
+interface MergeAddressesRequest {
+    /** Indicates whether source addresses should be deleted. */
+    delete_source_addresses?: boolean;
+    /** Specifies the next charge date of the associated subscriptions on the target address. */
+    next_charge_date?: string;
+    /** The address all of the subscriptions should be moved to. */
+    target_address: Address | {
+        id: number;
+    };
+    /** The list of addresses that the subscriptions should move from. */
+    source_addresses: (Address | {
+        id: number;
+    })[];
+}
+interface SkipFutureChargeAddressRequest {
+    /**
+     * The date in the future of the Charge to be skipped.
+     * This date must be within the delivery schedules of the Customer.
+     */
+    date: IsoDateString;
+    /** A list containing the Subscription IDs to be skipped. */
+    subscription_ids: string;
+}
+interface Address {
+    /** Unique numeric identifier for the Address. */
+    id: number;
+    /** The street associated with the Address. */
+    address1: string;
+    /** Any additional information associated with the Address. */
+    address2?: string;
+    /** The city associated with the address. */
+    city: string;
+    /** The company associated with the address. */
+    company: string;
+    /** 2-letter country code. */
+    country_code: string;
+    /** Unique numeric identifier for the customer associated with the address. */
+    customer_id: number;
+    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
+    discounts?: {
+        id: number;
+    }[];
+    /** The customer’s first name associated with the address. */
+    first_name: string;
+    /** The customer’s last name associated with the address. */
+    last_name: string;
+    /** Replaces cart_attributes. Extra information that is added to the order. */
+    order_attributes: Property[];
+    /** Notes to be added to all orders associated with the address. */
+    order_note: string | null;
+    /** Unique numeric identifier for the Payment Method associated to the Address. */
+    payment_method_id: number;
+    /** The phone number associated with the address. */
+    phone: string;
+    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
+    presentment_currency: string | null;
+    /** The state or province associated with the address. */
+    province: string | null;
+    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
+    shipping_lines_override: {
+        code: string;
+        price: string;
+        title: string;
+    }[] | null;
+    /** The zip or postal code associated with the address. */
+    zip?: string | null;
+    /** The date and time when the address was created. */
+    created_at: IsoDateString;
+    /** The date and time when the address was last updated. */
+    updated_at: IsoDateString;
+}
+interface AddressListResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    addresses: Address[];
+}
+declare type AddressSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
+interface AddressListParams extends ListParams<AddressSortBy> {
+    customer_id?: string;
+    discount_id?: string;
+    discount_code?: string;
+    created_at_min?: IsoDateString;
+    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>;
+/** Retrieves address for customer based on specified address id. */
+declare function getAddress(id: number): Promise<Address>;
+/** Create a new address for a customer. */
+declare function createAddress(request: CreateAddressRequest): Promise<Address>;
+/** Updates an existing address to match the specified parameters. */
+declare function updateAddress(id: number, request: UpdateAddressRequest): Promise<Address>;
+/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */
+declare function deleteAddress(id: number): Promise<void>;
+/**
+ * Merges up to 10 source addresses into 1 target address.
+ */
+declare function mergeAddresses(request: 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 const login: () => Promise<boolean>;
+declare const logout: () => void;
+
 declare function getCharge(id: number | string): Promise<Charge>;
 /** Lists charges */
 declare function listCharges(query?: ChargeListParams): Promise<ChargeListResponse>;
@@ -874,8 +1021,8 @@ interface CreateProps {
     add_to_next_charge?: boolean;
 }
 declare type CreateOnetimeRequest = SubType<Onetime, RequiredCreateProps$1, OptionalCreateProps$1> & CreateProps;
-declare type OptionalUpdateProps$1 = 'address_id' | 'next_charge_scheduled_at' | 'properties' | 'quantity' | 'external_variant_id' | 'sku';
-declare type UpdateOnetimeRequest = Partial<Pick<Onetime, OptionalUpdateProps$1>>;
+declare type OptionalUpdateProps$2 = 'address_id' | 'next_charge_scheduled_at' | 'properties' | 'quantity' | 'external_variant_id' | 'sku';
+declare type UpdateOnetimeRequest = Partial<Pick<Onetime, OptionalUpdateProps$2>>;
 interface OnetimesResponse {
     next_cursor: null | string;
     previous_cursor: null | string;
@@ -901,9 +1048,7 @@ interface Subscription {
     /** Unique numeric identifier for the customer the subscription is tied to. */
     customer_id: number;
     /** An object used to contain analytics data such as utm parameters. */
-    analytics_data: {
-        utm_params: Record<string, unknown>;
-    };
+    analytics_data: AnalyticsData;
     /** Reason provided for cancellation. */
     cancellation_reason: string | null;
     /** Additional comment for cancellation. */
@@ -991,8 +1136,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 = '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>>;
+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>>;
 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;
@@ -1037,6 +1182,52 @@ declare const cancelSubscription: (id: string | number, data: CancelSubscription
  */
 declare const activateSubscription: (id: string | number) => Promise<Subscription>;
 
+interface User {
+    /** 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 UpdateUserRequest = Partial<Pick<User, OptionalUpdateProps>>;
+interface UserDeliveryScheduleParams {
+    delivery_count_future?: number;
+    future_internal?: number;
+    date_max?: IsoDateString;
+}
+interface Delivery {
+    date: IsoDateString;
+    orders: Order[];
+}
+
+declare const getUser: () => Promise<User>;
+declare const updateUser: (data: UpdateUserRequest) => Promise<User>;
+declare const getDeliverySchedule: (query?: UserDeliveryScheduleParams) => Promise<Delivery[]>;
+
 declare type InitOptions = Omit<Partial<StorefrontOptions>, 'environment' | 'apiKey'>;
 declare const api: {
     get<T>(url: string, requestOptions?: GetRequestOptions): Promise<T>;
@@ -1046,4 +1237,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, createOnetime, createSubscription, deleteOnetime, getBundleId, getBundleSettings, getCharge, getOnetime, getOrder, getProduct, getProductAndSettings, getProducts, getProductsAndSettings, getStoreSettings, getSubscription, getWidgetSettings, initRecharge, listCharges, listOnetimes, listOrders, listSubscriptions, login, logout, processCharge, refundCharge, removeDiscount, resetCache, skipCharge, unskipCharge, 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, 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 };