@rechargeapps/storefront-client 1.60.0 → 1.62.0

package/dist/cjs/api/auth.js

@@ -181,7 +181,7 @@ async function rechargeAdminRequest(method, url, { id, query, data, headers } =
     ...storefrontAccessToken ? { "X-Recharge-Storefront-Access-Token": storefrontAccessToken } : {},
     ...appName ? { "X-Recharge-Sdk-App-Name": appName } : {},
     ...appVersion ? { "X-Recharge-Sdk-App-Version": appVersion } : {},
-    "X-Recharge-Sdk-Version": "1.60.0",
+    "X-Recharge-Sdk-Version": "1.62.0",
     ...headers ? headers : {}
   };
   return request.request(method, `${rechargeBaseUrl}${url}`, { id, query, data, headers: reqHeaders });

package/dist/cjs/api/bundleData.js

@@ -14,7 +14,7 @@ async function loadBundleData(id, options) {
 async function loadFromOnlineStore(id, country_code) {
   const headers = {
     "X-Recharge-Sdk-Fn": "loadFromOnlineStore",
-    "X-Recharge-Sdk-Version": "1.60.0"
+    "X-Recharge-Sdk-Version": "1.62.0"
   };
   if (!country_code) {
     const data = await request.shopifyAppProxyRequest("get", `/bundle-data/${id}`, { headers });

package/dist/cjs/utils/request.js

@@ -49,7 +49,7 @@ async function rechargeApiRequest(method, url, { id, query, data, headers } = {}
     "X-Recharge-Sdk-Fn": session.internalFnCall,
     ...appName ? { "X-Recharge-Sdk-App-Name": appName } : {},
     ...appVersion ? { "X-Recharge-Sdk-App-Version": appVersion } : {},
-    "X-Recharge-Sdk-Version": "1.60.0",
+    "X-Recharge-Sdk-Version": "1.62.0",
     "X-Request-Id": session.internalRequestId,
     ...session.tmp_fn_identifier ? { "X-Recharge-Sdk-Fn-Identifier": session.tmp_fn_identifier } : {},
     ...headers ? headers : {}

package/dist/esm/api/auth.js

@@ -179,7 +179,7 @@ async function rechargeAdminRequest(method, url, { id, query, data, headers } =
     ...storefrontAccessToken ? { "X-Recharge-Storefront-Access-Token": storefrontAccessToken } : {},
     ...appName ? { "X-Recharge-Sdk-App-Name": appName } : {},
     ...appVersion ? { "X-Recharge-Sdk-App-Version": appVersion } : {},
-    "X-Recharge-Sdk-Version": "1.60.0",
+    "X-Recharge-Sdk-Version": "1.62.0",
     ...headers ? headers : {}
   };
   return request(method, `${rechargeBaseUrl}${url}`, { id, query, data, headers: reqHeaders });

package/dist/esm/api/bundleData.js

@@ -12,7 +12,7 @@ async function loadBundleData(id, options) {
 async function loadFromOnlineStore(id, country_code) {
   const headers = {
     "X-Recharge-Sdk-Fn": "loadFromOnlineStore",
-    "X-Recharge-Sdk-Version": "1.60.0"
+    "X-Recharge-Sdk-Version": "1.62.0"
   };
   if (!country_code) {
     const data = await shopifyAppProxyRequest("get", `/bundle-data/${id}`, { headers });

package/dist/esm/utils/request.js

@@ -47,7 +47,7 @@ async function rechargeApiRequest(method, url, { id, query, data, headers } = {}
     "X-Recharge-Sdk-Fn": session.internalFnCall,
     ...appName ? { "X-Recharge-Sdk-App-Name": appName } : {},
     ...appVersion ? { "X-Recharge-Sdk-App-Version": appVersion } : {},
-    "X-Recharge-Sdk-Version": "1.60.0",
+    "X-Recharge-Sdk-Version": "1.62.0",
     "X-Request-Id": session.internalRequestId,
     ...session.tmp_fn_identifier ? { "X-Recharge-Sdk-Fn-Identifier": session.tmp_fn_identifier } : {},
     ...headers ? headers : {}

package/dist/index.d.ts

@@ -272,6 +272,164 @@ interface CreateMetafieldRequest extends SubType<Metafield, MetafieldRequiredCre
 interface UpdateMetafieldRequest extends Partial<Pick<Metafield, 'description' | 'owner_id' | 'owner_resource' | 'value' | 'value_type'>> {
 }
 
+interface ShippingLine {
+    /** The code associated with the shipping_line of a Charge. */
+    code: string;
+    /** The price of the shipping_line. */
+    price: string;
+    /** The date and time when the shipping_line was retrieved. */
+    retrieved_at: IsoDateString | null;
+    /** The source of the shipping_line. */
+    source: string;
+    /** The status the shipping_line. */
+    status?: 'active' | 'pending' | 'queued';
+    /** The title of the shipping_line. */
+    title: string;
+    /** A boolean indicating if the shipping_line is taxable. */
+    taxable: boolean;
+    /** An array of tax lines associated with the shipping_line. */
+    tax_lines: TaxLine[];
+}
+type OrderStatus = 'success' | 'error' | 'queued' | 'cancelled' | 'pending_charge_status';
+type OrderType = 'checkout' | 'recurring';
+interface Order {
+    /** The unique numeric identifier for the order. */
+    id: number;
+    /** The id of the associated Address within Recharge. */
+    address_id: number;
+    /** The billing address at the time the order was created. See Addresses for detailed address information. */
+    billing_address: AssociatedAddress;
+    /** An object containing parameters of the Charge. */
+    charge: {
+        /** The id of the charge associated with this order. */
+        id: number;
+        /** An object containing external transaction ids associated with this charge, as they appear in external platforms. */
+        external_transaction_id: ExternalTransactionId;
+        /** The name of the payment processor used for this charge. */
+        payment_processor_name: string;
+        /** The status of the charge. */
+        status: ChargeStatus;
+    };
+    /** Details of the access method used by the purchase. */
+    client_details: {
+        /** The IP address of the buyer as detected in Checkout. */
+        browser_ip: string;
+        /** The user agent detected during Checkout. */
+        user_agent: string | null;
+    };
+    /** The date when the order was created. */
+    created_at: IsoDateString;
+    /** The currency of the payment used to create the order. */
+    currency: string;
+    /** Object that contains information about the Customer. */
+    customer: {
+        /** The ID of the associated customer record. */
+        id: number;
+        /** The user email. */
+        email: string;
+        /** An object containing customer information associated with this charge. */
+        external_customer_id: ExternalId;
+        /** The hash of the Customer associated with the Charge. */
+        hash: string;
+    };
+    /** An array of Discounts associated with the Order. */
+    discounts: Discount[];
+    /** The cart token as it appears in an external system. */
+    external_cart_token: string | null;
+    /** An object containing external order ids. */
+    external_order_id?: ExternalId;
+    /** An object containing the external order numbers. */
+    external_order_number: ExternalId;
+    /** A boolean representing if this Order is generated from a prepaid purchase. */
+    is_prepaid?: boolean;
+    /** A list of line_item objects. */
+    line_items: LineItem[];
+    /** Notes associated with the Order. */
+    note: string | null;
+    /** An array of name value pairs of note attributes on the Order. */
+    order_attributes: Property[];
+    /** The date time that the associated charge was processed at. */
+    processed_at: IsoDateString | null;
+    /** The date time of when the associated charge is/was scheduled to process. */
+    scheduled_at: IsoDateString;
+    /** The shipping address where the order will be shipped. See Addresses for detailed Address information. */
+    shipping_address: AssociatedAddress;
+    /** An array of shipping lines associated with the order. */
+    shipping_lines: ShippingLine[];
+    /** The status of creating the Order. */
+    status: OrderStatus;
+    /** The subtotal price (sum of all line items * their quantity) of the order less discounts. */
+    subtotal_price: string;
+    /** A comma separated list of tags on the Order. */
+    tags: string;
+    /** An array of tax lines that apply to the Order. */
+    tax_lines: TaxLine[];
+    /** A boolean indicator of the taxability of the Order. */
+    taxable: boolean;
+    /** The total discounted dollar value of the Order. */
+    total_discounts: string;
+    /** The total price of all line items of the Order. */
+    total_line_items_price: string;
+    /** The total amount due of the Order. */
+    total_price: string;
+    /** The total dollar amount of refunds associated with the Order. */
+    total_refunds: string;
+    /** The total tax due associated with the Order. */
+    total_tax: string;
+    /** The total weight of the order in grams. */
+    total_weight_grams: number;
+    /** An indicator of the order’s type. */
+    type: OrderType;
+    /** The date time at which the order was most recently updated. */
+    updated_at: IsoDateString;
+    /** Error information about the order if status is 'error' */
+    error: string | null;
+    /** Additional information as requested */
+    include?: {
+        customer?: Customer;
+        metafields?: Metafield[];
+    };
+}
+type OrderIncludes = 'customer' | 'metafields';
+interface OrdersResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    orders: Order[];
+}
+type OrderSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'processed_at-asc' | 'processed_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
+interface OrderListParams extends ListParams<OrderSortBy> {
+    /** Filter orders by address. */
+    address_id?: string | number;
+    /** Filter orders by charge. */
+    charge_id?: string | number;
+    /** Show orders created after the given date. */
+    created_at_min?: IsoDateString;
+    /** Show orders created before the given date. */
+    created_at_max?: IsoDateString;
+    /** Filter orders by external_order_id. */
+    external_order_id?: string | number;
+    /** Filter orders by id. */
+    ids?: (string | number)[];
+    /** Show orders scheduled before the given date. */
+    scheduled_at_max?: IsoDateString;
+    /** Show orders scheduled after the given date. */
+    scheduled_at_min?: IsoDateString;
+    /** Filter orders with/without external_order_id. */
+    has_external_order?: boolean;
+    /** Filter orders by status. */
+    status?: OrderStatus;
+    /** Filter orders by type. */
+    type?: OrderType;
+    /** Filter orders by subscription or onetime. */
+    purchase_item_id?: string | number;
+    /** Show orders updated before the given date. */
+    updated_at_max?: IsoDateString;
+    /** Show orders updated after the given date. */
+    updated_at_min?: IsoDateString;
+    /** Include related data options */
+    include?: OrderIncludes[];
+}
+
 interface PaymentDetails {
     /** Payment_method brand or company powering it. valid for CREDIT_CARD only. */
     brand?: string;
@@ -815,6 +973,14 @@ interface BundleData {
     };
 }
 
+interface CustomerEntitlement {
+    name: string;
+    id: number;
+    lookup_key: string;
+    expires_at?: IsoDateString;
+    description?: string;
+}
+
 type SubscriptionStatus = 'active' | 'cancelled' | 'expired' | 'onetime';
 interface SubscriptionBase {
     /** Unique numeric identifier for the subscription. */
@@ -847,6 +1013,8 @@ interface SubscriptionBase {
     external_variant_id: ExternalId;
     /** Retrieves true if there is queued charge. Otherwise, retrieves false. */
     has_queued_charges: boolean;
+    /** Value is set to true if it is a digital item. */
+    is_digital: boolean;
     /** Value is set to true if it is a prepaid item. */
     is_prepaid: boolean;
     /** Value is set to true if it is not a prepaid item */
@@ -904,6 +1072,7 @@ interface SubscriptionBase {
         metafields?: Metafield[];
         bundle_selections?: BundleSelection | null;
         bundle_product?: BundleProduct | null;
+        customer_entitlements?: CustomerEntitlement[] | null;
     };
 }
 interface RecurringSubscription extends SubscriptionBase {
@@ -1174,17 +1343,24 @@ interface DeliveryLineItem extends Omit<LineItem, 'external_inventory_policy' |
 }
 interface DeliveryPaymentMethod extends Omit<PaymentMethod, 'created_at' | 'customer_id' | 'default' | 'payment_type' | 'processor_customer_token' | 'processor_name' | 'processor_payment_method_token' | 'status_reason' | 'status' | 'updated_at'> {
     payment_details: PaymentDetails;
+    payment_type: PaymentType;
     billing_address: AssociatedAddress;
 }
 interface DeliveryOrder {
-    id: number | null;
     address_id: number;
     charge_id: number | null;
+    currency: string;
+    has_uncommitted_changes: boolean;
+    id: number | null;
     line_items: DeliveryLineItem[];
+    order_subtotal: string;
     payment_method: DeliveryPaymentMethod;
     shipping_address: AssociatedAddress;
-    order_subtotal: string;
-    currency: string;
+    shipping_lines: ShippingLine[];
+    total_discounts: string;
+    total_duties: string;
+    total_price: string;
+    total_tax: string;
 }
 interface Delivery {
     date: IsoDateString;
@@ -1215,162 +1391,6 @@ interface CustomerPortalAccessResponse {
     temp_token: string;
 }
 
-interface ShippingLine {
-    /** The code associated with the shipping_line of a Charge. */
-    code: string;
-    /** The price of the shipping_line. */
-    price: string;
-    /** The source of the shipping_line. */
-    source: string;
-    /** The status the shipping_line. */
-    status?: 'active' | 'pending' | 'queued';
-    /** The title of the shipping_line. */
-    title: string;
-    /** A boolean indicating if the shipping_line is taxable. */
-    taxable: boolean;
-    /** An array of tax lines associated with the shipping_line. */
-    tax_lines: TaxLine[];
-}
-type OrderStatus = 'success' | 'error' | 'queued' | 'cancelled' | 'pending_charge_status';
-type OrderType = 'checkout' | 'recurring';
-interface Order {
-    /** The unique numeric identifier for the order. */
-    id: number;
-    /** The id of the associated Address within Recharge. */
-    address_id: number;
-    /** The billing address at the time the order was created. See Addresses for detailed address information. */
-    billing_address: AssociatedAddress;
-    /** An object containing parameters of the Charge. */
-    charge: {
-        /** The id of the charge associated with this order. */
-        id: number;
-        /** An object containing external transaction ids associated with this charge, as they appear in external platforms. */
-        external_transaction_id: ExternalTransactionId;
-        /** The name of the payment processor used for this charge. */
-        payment_processor_name: string;
-        /** The status of the charge. */
-        status: ChargeStatus;
-    };
-    /** Details of the access method used by the purchase. */
-    client_details: {
-        /** The IP address of the buyer as detected in Checkout. */
-        browser_ip: string;
-        /** The user agent detected during Checkout. */
-        user_agent: string | null;
-    };
-    /** The date when the order was created. */
-    created_at: IsoDateString;
-    /** The currency of the payment used to create the order. */
-    currency: string;
-    /** Object that contains information about the Customer. */
-    customer: {
-        /** The ID of the associated customer record. */
-        id: number;
-        /** The user email. */
-        email: string;
-        /** An object containing customer information associated with this charge. */
-        external_customer_id: ExternalId;
-        /** The hash of the Customer associated with the Charge. */
-        hash: string;
-    };
-    /** An array of Discounts associated with the Order. */
-    discounts: Discount[];
-    /** The cart token as it appears in an external system. */
-    external_cart_token: string | null;
-    /** An object containing external order ids. */
-    external_order_id?: ExternalId;
-    /** An object containing the external order numbers. */
-    external_order_number: ExternalId;
-    /** A boolean representing if this Order is generated from a prepaid purchase. */
-    is_prepaid?: boolean;
-    /** A list of line_item objects. */
-    line_items: LineItem[];
-    /** Notes associated with the Order. */
-    note: string | null;
-    /** An array of name value pairs of note attributes on the Order. */
-    order_attributes: Property[];
-    /** The date time that the associated charge was processed at. */
-    processed_at: IsoDateString | null;
-    /** The date time of when the associated charge is/was scheduled to process. */
-    scheduled_at: IsoDateString;
-    /** The shipping address where the order will be shipped. See Addresses for detailed Address information. */
-    shipping_address: AssociatedAddress;
-    /** An array of shipping lines associated with the order. */
-    shipping_lines: ShippingLine[];
-    /** The status of creating the Order. */
-    status: OrderStatus;
-    /** The subtotal price (sum of all line items * their quantity) of the order less discounts. */
-    subtotal_price: string;
-    /** A comma separated list of tags on the Order. */
-    tags: string;
-    /** An array of tax lines that apply to the Order. */
-    tax_lines: TaxLine[];
-    /** A boolean indicator of the taxability of the Order. */
-    taxable: boolean;
-    /** The total discounted dollar value of the Order. */
-    total_discounts: string;
-    /** The total price of all line items of the Order. */
-    total_line_items_price: string;
-    /** The total amount due of the Order. */
-    total_price: string;
-    /** The total dollar amount of refunds associated with the Order. */
-    total_refunds: string;
-    /** The total tax due associated with the Order. */
-    total_tax: string;
-    /** The total weight of the order in grams. */
-    total_weight_grams: number;
-    /** An indicator of the order’s type. */
-    type: OrderType;
-    /** The date time at which the order was most recently updated. */
-    updated_at: IsoDateString;
-    /** Error information about the order if status is 'error' */
-    error: string | null;
-    /** Additional information as requested */
-    include?: {
-        customer?: Customer;
-        metafields?: Metafield[];
-    };
-}
-type OrderIncludes = 'customer' | 'metafields';
-interface OrdersResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    orders: Order[];
-}
-type OrderSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'processed_at-asc' | 'processed_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
-interface OrderListParams extends ListParams<OrderSortBy> {
-    /** Filter orders by address. */
-    address_id?: string | number;
-    /** Filter orders by charge. */
-    charge_id?: string | number;
-    /** Show orders created after the given date. */
-    created_at_min?: IsoDateString;
-    /** Show orders created before the given date. */
-    created_at_max?: IsoDateString;
-    /** Filter orders by external_order_id. */
-    external_order_id?: string | number;
-    /** Filter orders by id. */
-    ids?: (string | number)[];
-    /** Show orders scheduled before the given date. */
-    scheduled_at_max?: IsoDateString;
-    /** Show orders scheduled after the given date. */
-    scheduled_at_min?: IsoDateString;
-    /** Filter orders with/without external_order_id. */
-    has_external_order?: boolean;
-    /** Filter orders by status. */
-    status?: OrderStatus;
-    /** Filter orders by type. */
-    type?: OrderType;
-    /** Filter orders by subscription or onetime. */
-    purchase_item_id?: string | number;
-    /** Show orders updated before the given date. */
-    updated_at_max?: IsoDateString;
-    /** Show orders updated after the given date. */
-    updated_at_min?: IsoDateString;
-    /** Include related data options */
-    include?: OrderIncludes[];
-}
-
 type ChargeStatus = 'success' | 'error' | 'queued' | 'skipped' | 'refunded' | 'partially_refunded' | 'pending_manual_payment' | 'pending';
 interface Charge {
     /** The unique numeric identifier for the Charge. */