@rechargeapps/storefront-client 1.17.3 → 1.18.0

package/dist/esm/api/subscription.js

@@ -1,5 +1,5 @@
 import partial from 'lodash.partial';
-import { rechargeApiRequest } from '../utils/request.js';
+import { rechargeApiRequest, getInternalSession } from '../utils/request.js';
 import { bulkSubscriptionCreateMapper, subscriptionMapperOldToNew, bulkSubscriptionUpdateMapper } from '../mappers/subscription.js';
 
 async function getSubscription(session, id, options) {
@@ -10,12 +10,17 @@ async function getSubscription(session, id, options) {
       id,
       query: { include: options?.include }
     },
-    session
+    getInternalSession(session, "getSubscription")
   );
   return subscription;
 }
 function listSubscriptions(session, query) {
-  return rechargeApiRequest("get", `/subscriptions`, { query }, session);
+  return rechargeApiRequest(
+    "get",
+    `/subscriptions`,
+    { query },
+    getInternalSession(session, "listSubscriptions")
+  );
 }
 async function createSubscription(session, createRequest, query) {
   const { subscription } = await rechargeApiRequest(
@@ -25,7 +30,7 @@ async function createSubscription(session, createRequest, query) {
       data: createRequest,
       query
     },
-    session
+    getInternalSession(session, "createSubscription")
   );
   return subscription;
 }
@@ -38,7 +43,7 @@ async function updateSubscription(session, id, updateRequest, query) {
       data: updateRequest,
       query
     },
-    session
+    getInternalSession(session, "updateSubscription")
   );
   return subscription;
 }
@@ -50,7 +55,7 @@ async function updateSubscriptionChargeDate(session, id, date, query) {
       data: { date },
       query
     },
-    session
+    getInternalSession(session, "updateSubscriptionChargeDate")
   );
   return subscription;
 }
@@ -61,7 +66,7 @@ async function updateSubscriptionAddress(session, id, address_id) {
     {
       data: { address_id }
     },
-    session
+    getInternalSession(session, "updateSubscriptionAddress")
   );
   return subscription;
 }
@@ -73,7 +78,7 @@ async function cancelSubscription(session, id, cancelRequest, query) {
       data: cancelRequest,
       query
     },
-    session
+    getInternalSession(session, "cancelSubscription")
   );
   return subscription;
 }
@@ -82,7 +87,7 @@ async function activateSubscription(session, id, query) {
     "post",
     `/subscriptions/${id}/activate`,
     { query },
-    session
+    getInternalSession(session, "activateSubscription")
   );
   return subscription;
 }
@@ -96,7 +101,7 @@ async function skipSubscriptionCharge(session, id, date) {
         subscription_id: `${id}`
       }
     },
-    session
+    getInternalSession(session, "skipSubscriptionCharge")
   );
   return charge;
 }
@@ -110,7 +115,7 @@ async function skipGiftSubscriptionCharge(session, subscriptionIds, recipientAdd
         recipient_address: recipientAddress
       }
     },
-    session
+    getInternalSession(session, "skipGiftSubscriptionCharge")
   );
   return onetimes;
 }
@@ -138,7 +143,7 @@ async function createSubscriptions(session, createRequestBulk) {
         "X-Recharge-Version": "2021-01"
       }
     },
-    session
+    getInternalSession(session, "createSubscriptions")
   );
   return subscriptions.map(subscriptionMapperOldToNew);
 }
@@ -162,7 +167,7 @@ async function updateSubscriptions(session, addressId, updateRequestBulk, query)
         "X-Recharge-Version": "2021-01"
       }
     },
-    session
+    getInternalSession(session, "updateSubscriptions")
   );
   return subscriptions.map(subscriptionMapperOldToNew);
 }

package/dist/esm/api/subscription.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscription.js","sources":["../../../src/api/subscription.ts"],"sourcesContent":["import partial from 'lodash.partial';\nimport { rechargeApiRequest } from '../utils/request';\nimport {\n  CancelSubscriptionRequest,\n  CreateSubscriptionRequest,\n  Subscription,\n  SubscriptionsResponse,\n  SubscriptionListParams,\n  UpdateSubscriptionRequest,\n  UpdateSubscriptionParams,\n  GetSubscriptionOptions,\n  BasicSubscriptionParams,\n  Subscription_2021_01,\n  UpdateSubscriptionsRequest,\n  UpdateSubscriptionsParams,\n} from '../types/subscription';\nimport { IsoDateString } from '../types/common';\nimport { Session } from '../types/session';\nimport { ChargeResponse, CreateRecipientAddress, Onetime } from '../types';\nimport {\n  bulkSubscriptionCreateMapper,\n  bulkSubscriptionUpdateMapper,\n  subscriptionMapperOldToNew,\n} from '../mappers/subscription';\n\nexport async function getSubscription(\n  session: Session,\n  id: string | number,\n  options?: GetSubscriptionOptions\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'get',\n    `/subscriptions`,\n    {\n      id,\n      query: { include: options?.include },\n    },\n    session\n  );\n  return subscription;\n}\n\nexport function listSubscriptions(session: Session, query?: SubscriptionListParams): Promise<SubscriptionsResponse> {\n  return rechargeApiRequest<SubscriptionsResponse>('get', `/subscriptions`, { query }, session);\n}\n\n/**\n * When creating a subscription via API, order_interval_frequency and charge_interval_frequency values do not necessarily\n * need to match the values set in the respective Plans. The product, however, does need to have at least one Plan in order\n * to be added to a subscription.\n */\nexport async function createSubscription(\n  session: Session,\n  createRequest: CreateSubscriptionRequest,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions`,\n    {\n      data: createRequest,\n      query,\n    },\n    session\n  );\n  return subscription;\n}\n\n/**\n * 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).\n * WARNING: This update will remove skipped and manually changed charges.\n * If you want to change the next charge date (next_charge_scheduled_at) we recommend you to update these parameters first.\n * When updating order_interval_unit OR order_interval_frequency OR charge_interval_frequency all three parameters are required.\n */\nexport async function updateSubscription(\n  session: Session,\n  id: string | number,\n  updateRequest: UpdateSubscriptionRequest,\n  query?: UpdateSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'put',\n    `/subscriptions`,\n    {\n      id,\n      data: updateRequest,\n      query,\n    },\n    session\n  );\n  return subscription;\n}\n\n/**\n * If there are two active subscriptions with the same address_id, and you update their\n * next_charge_date parameters to match, their charges will get merged into a new charge\n * with a new id\n */\nexport async function updateSubscriptionChargeDate(\n  session: Session,\n  id: string | number,\n  date: IsoDateString,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/set_next_charge_date`,\n    {\n      data: { date },\n      query,\n    },\n    session\n  );\n  return subscription;\n}\n\nexport async function updateSubscriptionAddress(\n  session: Session,\n  id: string | number,\n  address_id: string | number\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/change_address`,\n    {\n      data: { address_id },\n    },\n    session\n  );\n  return subscription;\n}\n\n/**\n * An involuntary subscription cancelled due to max retries reached will trigger the\n * charge/max_retries_reached webhook. If this leads to the subscription being cancelled,\n * the subscription/cancelled webhook will trigger.\n */\nexport async function cancelSubscription(\n  session: Session,\n  id: string | number,\n  cancelRequest: CancelSubscriptionRequest,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/cancel`,\n    {\n      data: cancelRequest,\n      query,\n    },\n    session\n  );\n  return subscription;\n}\n\n/**\n * When activating subscription, following attributes will be set to null: cancelled_at, cancellation_reason\n * and cancellation_reason_comments.\n */\nexport async function activateSubscription(\n  session: Session,\n  id: string | number,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/activate`,\n    { query },\n    session\n  );\n  return subscription;\n}\n\n/* Skip charge associated with a subscription. */\nexport async function skipSubscriptionCharge(session: Session, id: number | string, date: IsoDateString) {\n  const { charge } = await rechargeApiRequest<ChargeResponse>(\n    'post',\n    `/subscriptions/${id}/charges/skip`,\n    {\n      data: {\n        date,\n        subscription_id: `${id}`,\n      },\n    },\n    session\n  );\n  return charge;\n}\n\n/**\n * Gift a subscription to another person. This creates onetime products for the recipient and skips that subscription for the customer.\n * When the gifted onetime ships the recipient receives and email notification.\n */\nexport async function skipGiftSubscriptionCharge(\n  session: Session,\n  subscriptionIds: Array<number | string>,\n  recipientAddress: CreateRecipientAddress\n) {\n  const { onetimes } = await rechargeApiRequest<{ onetimes: Onetime[] }>(\n    'post',\n    '/purchase_items/skip_gift',\n    {\n      data: {\n        purchase_item_ids: subscriptionIds.map(Number),\n        recipient_address: recipientAddress,\n      },\n    },\n    session\n  );\n\n  return onetimes;\n}\n\n/**\n * Bulk create new subscriptions.\n * Must all be for the same address.\n * There is a limit of 20 subscriptions per request.\n */\nexport async function createSubscriptions(\n  session: Session,\n  createRequestBulk: CreateSubscriptionRequest[]\n): Promise<Subscription[]> {\n  // validate size\n  const length = createRequestBulk.length;\n  if (length < 1 || length > 21) {\n    throw new Error('Number of subscriptions must be between 1 and 20.');\n  }\n  // validate customerId\n  const { customerId } = session;\n  if (!customerId) {\n    throw new Error('No customerId in session.');\n  }\n  // validate addressId\n  const addressId = createRequestBulk[0].address_id;\n  if (!createRequestBulk.every(createRequest => createRequest.address_id === addressId)) {\n    throw new Error('All subscriptions must have the same address_id.');\n  }\n  const bulkSubscriptionMapperPartial = partial(bulkSubscriptionCreateMapper, customerId);\n  const requestData = createRequestBulk.map(bulkSubscriptionMapperPartial);\n  const { subscriptions } = await rechargeApiRequest<{ subscriptions: Subscription_2021_01[] }>(\n    'post',\n    `/addresses/${addressId}/subscriptions-bulk`,\n    {\n      data: { subscriptions: requestData },\n      headers: {\n        'X-Recharge-Version': '2021-01',\n      },\n    },\n    session\n  );\n  return subscriptions.map(subscriptionMapperOldToNew);\n}\n\n/**\n * Bulk create new subscriptions.\n * Must all be for the same address.\n * There is a limit of 20 subscriptions per request.\n * Same rules apply as a single subscription update\n */\nexport async function updateSubscriptions(\n  session: Session,\n  addressId: string | number,\n  updateRequestBulk: UpdateSubscriptionsRequest[],\n  query?: UpdateSubscriptionsParams\n): Promise<Subscription[]> {\n  // validate size\n  const length = updateRequestBulk.length;\n  if (length < 1 || length > 21) {\n    throw new Error('Number of subscriptions must be between 1 and 20.');\n  }\n  // validate customerId\n  const { customerId } = session;\n  if (!customerId) {\n    throw new Error('No customerId in session.');\n  }\n  const bulkSubscriptionMapperPartial = partial(bulkSubscriptionUpdateMapper, !!query?.force_update);\n  const requestData = updateRequestBulk.map(bulkSubscriptionMapperPartial);\n  const { subscriptions } = await rechargeApiRequest<{ subscriptions: Subscription_2021_01[] }>(\n    'put',\n    `/addresses/${addressId}/subscriptions-bulk`,\n    {\n      data: { subscriptions: requestData },\n      headers: {\n        'X-Recharge-Version': '2021-01',\n      },\n    },\n    session\n  );\n  return subscriptions.map(subscriptionMapperOldToNew);\n}\n"],"names":[],"mappings":";;;;AAyBsB,eAAA,eAAA,CACpB,OACA,EAAA,EAAA,EACA,OACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,KAAA;AAAA,IACA,CAAA,cAAA,CAAA;AAAA,IACA;AAAA,MACE,EAAA;AAAA,MACA,KAAO,EAAA,EAAE,OAAS,EAAA,OAAA,EAAS,OAAQ,EAAA;AAAA,KACrC;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAEgB,SAAA,iBAAA,CAAkB,SAAkB,KAAgE,EAAA;AAClH,EAAA,OAAO,mBAA0C,KAAO,EAAA,CAAA,cAAA,CAAA,EAAkB,EAAE,KAAA,IAAS,OAAO,CAAA,CAAA;AAC9F,CAAA;AAOsB,eAAA,kBAAA,CACpB,OACA,EAAA,aAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,CAAA,cAAA,CAAA;AAAA,IACA;AAAA,MACE,IAAM,EAAA,aAAA;AAAA,MACN,KAAA;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAQA,eAAsB,kBACpB,CAAA,OAAA,EACA,EACA,EAAA,aAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,KAAA;AAAA,IACA,CAAA,cAAA,CAAA;AAAA,IACA;AAAA,MACE,EAAA;AAAA,MACA,IAAM,EAAA,aAAA;AAAA,MACN,KAAA;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAOA,eAAsB,4BACpB,CAAA,OAAA,EACA,EACA,EAAA,IAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,qBAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAA,EAAM,EAAE,IAAK,EAAA;AAAA,MACb,KAAA;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAEsB,eAAA,yBAAA,CACpB,OACA,EAAA,EAAA,EACA,UACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,eAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAA,EAAM,EAAE,UAAW,EAAA;AAAA,KACrB;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAOA,eAAsB,kBACpB,CAAA,OAAA,EACA,EACA,EAAA,aAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,OAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAM,EAAA,aAAA;AAAA,MACN,KAAA;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAMsB,eAAA,oBAAA,CACpB,OACA,EAAA,EAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,SAAA,CAAA;AAAA,IACpB,EAAE,KAAM,EAAA;AAAA,IACR,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAGsB,eAAA,sBAAA,CAAuB,OAAkB,EAAA,EAAA,EAAqB,IAAqB,EAAA;AACvG,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,MAAM,kBAAA;AAAA,IACvB,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,aAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAM,EAAA;AAAA,QACJ,IAAA;AAAA,QACA,eAAA,EAAiB,GAAG,EAAE,CAAA,CAAA;AAAA,OACxB;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAMsB,eAAA,0BAAA,CACpB,OACA,EAAA,eAAA,EACA,gBACA,EAAA;AACA,EAAM,MAAA,EAAE,QAAS,EAAA,GAAI,MAAM,kBAAA;AAAA,IACzB,MAAA;AAAA,IACA,2BAAA;AAAA,IACA;AAAA,MACE,IAAM,EAAA;AAAA,QACJ,iBAAA,EAAmB,eAAgB,CAAA,GAAA,CAAI,MAAM,CAAA;AAAA,QAC7C,iBAAmB,EAAA,gBAAA;AAAA,OACrB;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AAEA,EAAO,OAAA,QAAA,CAAA;AACT,CAAA;AAOsB,eAAA,mBAAA,CACpB,SACA,iBACyB,EAAA;AAEzB,EAAA,MAAM,SAAS,iBAAkB,CAAA,MAAA,CAAA;AACjC,EAAI,IAAA,MAAA,GAAS,CAAK,IAAA,MAAA,GAAS,EAAI,EAAA;AAC7B,IAAM,MAAA,IAAI,MAAM,mDAAmD,CAAA,CAAA;AAAA,GACrE;AAEA,EAAM,MAAA,EAAE,YAAe,GAAA,OAAA,CAAA;AACvB,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAM,MAAA,IAAI,MAAM,2BAA2B,CAAA,CAAA;AAAA,GAC7C;AAEA,EAAM,MAAA,SAAA,GAAY,iBAAkB,CAAA,CAAC,CAAE,CAAA,UAAA,CAAA;AACvC,EAAA,IAAI,CAAC,iBAAkB,CAAA,KAAA,CAAM,mBAAiB,aAAc,CAAA,UAAA,KAAe,SAAS,CAAG,EAAA;AACrF,IAAM,MAAA,IAAI,MAAM,kDAAkD,CAAA,CAAA;AAAA,GACpE;AACA,EAAM,MAAA,6BAAA,GAAgC,OAAQ,CAAA,4BAAA,EAA8B,UAAU,CAAA,CAAA;AACtF,EAAM,MAAA,WAAA,GAAc,iBAAkB,CAAA,GAAA,CAAI,6BAA6B,CAAA,CAAA;AACvE,EAAM,MAAA,EAAE,aAAc,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC9B,MAAA;AAAA,IACA,cAAc,SAAS,CAAA,mBAAA,CAAA;AAAA,IACvB;AAAA,MACE,IAAA,EAAM,EAAE,aAAA,EAAe,WAAY,EAAA;AAAA,MACnC,OAAS,EAAA;AAAA,QACP,oBAAsB,EAAA,SAAA;AAAA,OACxB;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,aAAA,CAAc,IAAI,0BAA0B,CAAA,CAAA;AACrD,CAAA;AAQA,eAAsB,mBACpB,CAAA,OAAA,EACA,SACA,EAAA,iBAAA,EACA,KACyB,EAAA;AAEzB,EAAA,MAAM,SAAS,iBAAkB,CAAA,MAAA,CAAA;AACjC,EAAI,IAAA,MAAA,GAAS,CAAK,IAAA,MAAA,GAAS,EAAI,EAAA;AAC7B,IAAM,MAAA,IAAI,MAAM,mDAAmD,CAAA,CAAA;AAAA,GACrE;AAEA,EAAM,MAAA,EAAE,YAAe,GAAA,OAAA,CAAA;AACvB,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAM,MAAA,IAAI,MAAM,2BAA2B,CAAA,CAAA;AAAA,GAC7C;AACA,EAAA,MAAM,gCAAgC,OAAQ,CAAA,4BAAA,EAA8B,CAAC,CAAC,OAAO,YAAY,CAAA,CAAA;AACjG,EAAM,MAAA,WAAA,GAAc,iBAAkB,CAAA,GAAA,CAAI,6BAA6B,CAAA,CAAA;AACvE,EAAM,MAAA,EAAE,aAAc,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC9B,KAAA;AAAA,IACA,cAAc,SAAS,CAAA,mBAAA,CAAA;AAAA,IACvB;AAAA,MACE,IAAA,EAAM,EAAE,aAAA,EAAe,WAAY,EAAA;AAAA,MACnC,OAAS,EAAA;AAAA,QACP,oBAAsB,EAAA,SAAA;AAAA,OACxB;AAAA,KACF;AAAA,IACA,OAAA;AAAA,GACF,CAAA;AACA,EAAO,OAAA,aAAA,CAAc,IAAI,0BAA0B,CAAA,CAAA;AACrD;;;;"}
+{"version":3,"file":"subscription.js","sources":["../../../src/api/subscription.ts"],"sourcesContent":["import partial from 'lodash.partial';\nimport { getInternalSession, rechargeApiRequest } from '../utils/request';\nimport {\n  CancelSubscriptionRequest,\n  CreateSubscriptionRequest,\n  Subscription,\n  SubscriptionsResponse,\n  SubscriptionListParams,\n  UpdateSubscriptionRequest,\n  UpdateSubscriptionParams,\n  GetSubscriptionOptions,\n  BasicSubscriptionParams,\n  Subscription_2021_01,\n  UpdateSubscriptionsRequest,\n  UpdateSubscriptionsParams,\n  Session,\n  ChargeResponse,\n  CreateRecipientAddress,\n  Onetime,\n  IsoDateString,\n} from '../types';\nimport {\n  bulkSubscriptionCreateMapper,\n  bulkSubscriptionUpdateMapper,\n  subscriptionMapperOldToNew,\n} from '../mappers/subscription';\n\nexport async function getSubscription(\n  session: Session,\n  id: string | number,\n  options?: GetSubscriptionOptions\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'get',\n    `/subscriptions`,\n    {\n      id,\n      query: { include: options?.include },\n    },\n    getInternalSession(session, 'getSubscription')\n  );\n  return subscription;\n}\n\nexport function listSubscriptions(session: Session, query?: SubscriptionListParams): Promise<SubscriptionsResponse> {\n  return rechargeApiRequest<SubscriptionsResponse>(\n    'get',\n    `/subscriptions`,\n    { query },\n    getInternalSession(session, 'listSubscriptions')\n  );\n}\n\n/**\n * When creating a subscription via API, order_interval_frequency and charge_interval_frequency values do not necessarily\n * need to match the values set in the respective Plans. The product, however, does need to have at least one Plan in order\n * to be added to a subscription.\n */\nexport async function createSubscription(\n  session: Session,\n  createRequest: CreateSubscriptionRequest,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions`,\n    {\n      data: createRequest,\n      query,\n    },\n    getInternalSession(session, 'createSubscription')\n  );\n  return subscription;\n}\n\n/**\n * 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).\n * WARNING: This update will remove skipped and manually changed charges.\n * If you want to change the next charge date (next_charge_scheduled_at) we recommend you to update these parameters first.\n * When updating order_interval_unit OR order_interval_frequency OR charge_interval_frequency all three parameters are required.\n */\nexport async function updateSubscription(\n  session: Session,\n  id: string | number,\n  updateRequest: UpdateSubscriptionRequest,\n  query?: UpdateSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'put',\n    `/subscriptions`,\n    {\n      id,\n      data: updateRequest,\n      query,\n    },\n    getInternalSession(session, 'updateSubscription')\n  );\n  return subscription;\n}\n\n/**\n * If there are two active subscriptions with the same address_id, and you update their\n * next_charge_date parameters to match, their charges will get merged into a new charge\n * with a new id\n */\nexport async function updateSubscriptionChargeDate(\n  session: Session,\n  id: string | number,\n  date: IsoDateString,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/set_next_charge_date`,\n    {\n      data: { date },\n      query,\n    },\n    getInternalSession(session, 'updateSubscriptionChargeDate')\n  );\n  return subscription;\n}\n\nexport async function updateSubscriptionAddress(\n  session: Session,\n  id: string | number,\n  address_id: string | number\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/change_address`,\n    {\n      data: { address_id },\n    },\n    getInternalSession(session, 'updateSubscriptionAddress')\n  );\n  return subscription;\n}\n\n/**\n * An involuntary subscription cancelled due to max retries reached will trigger the\n * charge/max_retries_reached webhook. If this leads to the subscription being cancelled,\n * the subscription/cancelled webhook will trigger.\n */\nexport async function cancelSubscription(\n  session: Session,\n  id: string | number,\n  cancelRequest: CancelSubscriptionRequest,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/cancel`,\n    {\n      data: cancelRequest,\n      query,\n    },\n    getInternalSession(session, 'cancelSubscription')\n  );\n  return subscription;\n}\n\n/**\n * When activating subscription, following attributes will be set to null: cancelled_at, cancellation_reason\n * and cancellation_reason_comments.\n */\nexport async function activateSubscription(\n  session: Session,\n  id: string | number,\n  query?: BasicSubscriptionParams\n): Promise<Subscription> {\n  const { subscription } = await rechargeApiRequest<{ subscription: Subscription }>(\n    'post',\n    `/subscriptions/${id}/activate`,\n    { query },\n    getInternalSession(session, 'activateSubscription')\n  );\n  return subscription;\n}\n\n/* Skip charge associated with a subscription. */\nexport async function skipSubscriptionCharge(session: Session, id: number | string, date: IsoDateString) {\n  const { charge } = await rechargeApiRequest<ChargeResponse>(\n    'post',\n    `/subscriptions/${id}/charges/skip`,\n    {\n      data: {\n        date,\n        subscription_id: `${id}`,\n      },\n    },\n    getInternalSession(session, 'skipSubscriptionCharge')\n  );\n  return charge;\n}\n\n/**\n * Gift a subscription to another person. This creates onetime products for the recipient and skips that subscription for the customer.\n * When the gifted onetime ships the recipient receives and email notification.\n */\nexport async function skipGiftSubscriptionCharge(\n  session: Session,\n  subscriptionIds: Array<number | string>,\n  recipientAddress: CreateRecipientAddress\n) {\n  const { onetimes } = await rechargeApiRequest<{ onetimes: Onetime[] }>(\n    'post',\n    '/purchase_items/skip_gift',\n    {\n      data: {\n        purchase_item_ids: subscriptionIds.map(Number),\n        recipient_address: recipientAddress,\n      },\n    },\n    getInternalSession(session, 'skipGiftSubscriptionCharge')\n  );\n\n  return onetimes;\n}\n\n/**\n * Bulk create new subscriptions.\n * Must all be for the same address.\n * There is a limit of 20 subscriptions per request.\n */\nexport async function createSubscriptions(\n  session: Session,\n  createRequestBulk: CreateSubscriptionRequest[]\n): Promise<Subscription[]> {\n  // validate size\n  const length = createRequestBulk.length;\n  if (length < 1 || length > 21) {\n    throw new Error('Number of subscriptions must be between 1 and 20.');\n  }\n  // validate customerId\n  const { customerId } = session;\n  if (!customerId) {\n    throw new Error('No customerId in session.');\n  }\n  // validate addressId\n  const addressId = createRequestBulk[0].address_id;\n  if (!createRequestBulk.every(createRequest => createRequest.address_id === addressId)) {\n    throw new Error('All subscriptions must have the same address_id.');\n  }\n  const bulkSubscriptionMapperPartial = partial(bulkSubscriptionCreateMapper, customerId);\n  const requestData = createRequestBulk.map(bulkSubscriptionMapperPartial);\n  const { subscriptions } = await rechargeApiRequest<{ subscriptions: Subscription_2021_01[] }>(\n    'post',\n    `/addresses/${addressId}/subscriptions-bulk`,\n    {\n      data: { subscriptions: requestData },\n      headers: {\n        'X-Recharge-Version': '2021-01',\n      },\n    },\n    getInternalSession(session, 'createSubscriptions')\n  );\n  return subscriptions.map(subscriptionMapperOldToNew);\n}\n\n/**\n * Bulk create new subscriptions.\n * Must all be for the same address.\n * There is a limit of 20 subscriptions per request.\n * Same rules apply as a single subscription update\n */\nexport async function updateSubscriptions(\n  session: Session,\n  addressId: string | number,\n  updateRequestBulk: UpdateSubscriptionsRequest[],\n  query?: UpdateSubscriptionsParams\n): Promise<Subscription[]> {\n  // validate size\n  const length = updateRequestBulk.length;\n  if (length < 1 || length > 21) {\n    throw new Error('Number of subscriptions must be between 1 and 20.');\n  }\n  // validate customerId\n  const { customerId } = session;\n  if (!customerId) {\n    throw new Error('No customerId in session.');\n  }\n  const bulkSubscriptionMapperPartial = partial(bulkSubscriptionUpdateMapper, !!query?.force_update);\n  const requestData = updateRequestBulk.map(bulkSubscriptionMapperPartial);\n  const { subscriptions } = await rechargeApiRequest<{ subscriptions: Subscription_2021_01[] }>(\n    'put',\n    `/addresses/${addressId}/subscriptions-bulk`,\n    {\n      data: { subscriptions: requestData },\n      headers: {\n        'X-Recharge-Version': '2021-01',\n      },\n    },\n    getInternalSession(session, 'updateSubscriptions')\n  );\n  return subscriptions.map(subscriptionMapperOldToNew);\n}\n"],"names":[],"mappings":";;;;AA2BsB,eAAA,eAAA,CACpB,OACA,EAAA,EAAA,EACA,OACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,KAAA;AAAA,IACA,CAAA,cAAA,CAAA;AAAA,IACA;AAAA,MACE,EAAA;AAAA,MACA,KAAO,EAAA,EAAE,OAAS,EAAA,OAAA,EAAS,OAAQ,EAAA;AAAA,KACrC;AAAA,IACA,kBAAA,CAAmB,SAAS,iBAAiB,CAAA;AAAA,GAC/C,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAEgB,SAAA,iBAAA,CAAkB,SAAkB,KAAgE,EAAA;AAClH,EAAO,OAAA,kBAAA;AAAA,IACL,KAAA;AAAA,IACA,CAAA,cAAA,CAAA;AAAA,IACA,EAAE,KAAM,EAAA;AAAA,IACR,kBAAA,CAAmB,SAAS,mBAAmB,CAAA;AAAA,GACjD,CAAA;AACF,CAAA;AAOsB,eAAA,kBAAA,CACpB,OACA,EAAA,aAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,CAAA,cAAA,CAAA;AAAA,IACA;AAAA,MACE,IAAM,EAAA,aAAA;AAAA,MACN,KAAA;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,oBAAoB,CAAA;AAAA,GAClD,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAQA,eAAsB,kBACpB,CAAA,OAAA,EACA,EACA,EAAA,aAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,KAAA;AAAA,IACA,CAAA,cAAA,CAAA;AAAA,IACA;AAAA,MACE,EAAA;AAAA,MACA,IAAM,EAAA,aAAA;AAAA,MACN,KAAA;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,oBAAoB,CAAA;AAAA,GAClD,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAOA,eAAsB,4BACpB,CAAA,OAAA,EACA,EACA,EAAA,IAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,qBAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAA,EAAM,EAAE,IAAK,EAAA;AAAA,MACb,KAAA;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,8BAA8B,CAAA;AAAA,GAC5D,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAEsB,eAAA,yBAAA,CACpB,OACA,EAAA,EAAA,EACA,UACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,eAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAA,EAAM,EAAE,UAAW,EAAA;AAAA,KACrB;AAAA,IACA,kBAAA,CAAmB,SAAS,2BAA2B,CAAA;AAAA,GACzD,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAOA,eAAsB,kBACpB,CAAA,OAAA,EACA,EACA,EAAA,aAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,OAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAM,EAAA,aAAA;AAAA,MACN,KAAA;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,oBAAoB,CAAA;AAAA,GAClD,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAMsB,eAAA,oBAAA,CACpB,OACA,EAAA,EAAA,EACA,KACuB,EAAA;AACvB,EAAM,MAAA,EAAE,YAAa,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC7B,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,SAAA,CAAA;AAAA,IACpB,EAAE,KAAM,EAAA;AAAA,IACR,kBAAA,CAAmB,SAAS,sBAAsB,CAAA;AAAA,GACpD,CAAA;AACA,EAAO,OAAA,YAAA,CAAA;AACT,CAAA;AAGsB,eAAA,sBAAA,CAAuB,OAAkB,EAAA,EAAA,EAAqB,IAAqB,EAAA;AACvG,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,MAAM,kBAAA;AAAA,IACvB,MAAA;AAAA,IACA,kBAAkB,EAAE,CAAA,aAAA,CAAA;AAAA,IACpB;AAAA,MACE,IAAM,EAAA;AAAA,QACJ,IAAA;AAAA,QACA,eAAA,EAAiB,GAAG,EAAE,CAAA,CAAA;AAAA,OACxB;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,wBAAwB,CAAA;AAAA,GACtD,CAAA;AACA,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAMsB,eAAA,0BAAA,CACpB,OACA,EAAA,eAAA,EACA,gBACA,EAAA;AACA,EAAM,MAAA,EAAE,QAAS,EAAA,GAAI,MAAM,kBAAA;AAAA,IACzB,MAAA;AAAA,IACA,2BAAA;AAAA,IACA;AAAA,MACE,IAAM,EAAA;AAAA,QACJ,iBAAA,EAAmB,eAAgB,CAAA,GAAA,CAAI,MAAM,CAAA;AAAA,QAC7C,iBAAmB,EAAA,gBAAA;AAAA,OACrB;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,4BAA4B,CAAA;AAAA,GAC1D,CAAA;AAEA,EAAO,OAAA,QAAA,CAAA;AACT,CAAA;AAOsB,eAAA,mBAAA,CACpB,SACA,iBACyB,EAAA;AAEzB,EAAA,MAAM,SAAS,iBAAkB,CAAA,MAAA,CAAA;AACjC,EAAI,IAAA,MAAA,GAAS,CAAK,IAAA,MAAA,GAAS,EAAI,EAAA;AAC7B,IAAM,MAAA,IAAI,MAAM,mDAAmD,CAAA,CAAA;AAAA,GACrE;AAEA,EAAM,MAAA,EAAE,YAAe,GAAA,OAAA,CAAA;AACvB,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAM,MAAA,IAAI,MAAM,2BAA2B,CAAA,CAAA;AAAA,GAC7C;AAEA,EAAM,MAAA,SAAA,GAAY,iBAAkB,CAAA,CAAC,CAAE,CAAA,UAAA,CAAA;AACvC,EAAA,IAAI,CAAC,iBAAkB,CAAA,KAAA,CAAM,mBAAiB,aAAc,CAAA,UAAA,KAAe,SAAS,CAAG,EAAA;AACrF,IAAM,MAAA,IAAI,MAAM,kDAAkD,CAAA,CAAA;AAAA,GACpE;AACA,EAAM,MAAA,6BAAA,GAAgC,OAAQ,CAAA,4BAAA,EAA8B,UAAU,CAAA,CAAA;AACtF,EAAM,MAAA,WAAA,GAAc,iBAAkB,CAAA,GAAA,CAAI,6BAA6B,CAAA,CAAA;AACvE,EAAM,MAAA,EAAE,aAAc,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC9B,MAAA;AAAA,IACA,cAAc,SAAS,CAAA,mBAAA,CAAA;AAAA,IACvB;AAAA,MACE,IAAA,EAAM,EAAE,aAAA,EAAe,WAAY,EAAA;AAAA,MACnC,OAAS,EAAA;AAAA,QACP,oBAAsB,EAAA,SAAA;AAAA,OACxB;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,qBAAqB,CAAA;AAAA,GACnD,CAAA;AACA,EAAO,OAAA,aAAA,CAAc,IAAI,0BAA0B,CAAA,CAAA;AACrD,CAAA;AAQA,eAAsB,mBACpB,CAAA,OAAA,EACA,SACA,EAAA,iBAAA,EACA,KACyB,EAAA;AAEzB,EAAA,MAAM,SAAS,iBAAkB,CAAA,MAAA,CAAA;AACjC,EAAI,IAAA,MAAA,GAAS,CAAK,IAAA,MAAA,GAAS,EAAI,EAAA;AAC7B,IAAM,MAAA,IAAI,MAAM,mDAAmD,CAAA,CAAA;AAAA,GACrE;AAEA,EAAM,MAAA,EAAE,YAAe,GAAA,OAAA,CAAA;AACvB,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAM,MAAA,IAAI,MAAM,2BAA2B,CAAA,CAAA;AAAA,GAC7C;AACA,EAAA,MAAM,gCAAgC,OAAQ,CAAA,4BAAA,EAA8B,CAAC,CAAC,OAAO,YAAY,CAAA,CAAA;AACjG,EAAM,MAAA,WAAA,GAAc,iBAAkB,CAAA,GAAA,CAAI,6BAA6B,CAAA,CAAA;AACvE,EAAM,MAAA,EAAE,aAAc,EAAA,GAAI,MAAM,kBAAA;AAAA,IAC9B,KAAA;AAAA,IACA,cAAc,SAAS,CAAA,mBAAA,CAAA;AAAA,IACvB;AAAA,MACE,IAAA,EAAM,EAAE,aAAA,EAAe,WAAY,EAAA;AAAA,MACnC,OAAS,EAAA;AAAA,QACP,oBAAsB,EAAA,SAAA;AAAA,OACxB;AAAA,KACF;AAAA,IACA,kBAAA,CAAmB,SAAS,qBAAqB,CAAA;AAAA,GACnD,CAAA;AACA,EAAO,OAAA,aAAA,CAAc,IAAI,0BAA0B,CAAA,CAAA;AACrD;;;;"}

package/dist/esm/index.js

@@ -3,6 +3,7 @@ export { loginCustomerPortal, loginShopifyApi, loginShopifyAppProxy, loginWithSh
 export { createBundleSelection, deleteBundleSelection, getBundleId, getBundleSelection, getDynamicBundleItems, listBundleSelections, updateBundle, updateBundleSelection, validateBundle, validateDynamicBundle } from './api/bundle.js';
 export { getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, resetCDNCache } from './api/cdn.js';
 export { applyDiscountToCharge, getCharge, listCharges, processCharge, removeDiscountsFromCharge, skipCharge, unskipCharge } from './api/charge.js';
+export { getCollection, listCollectionProducts, listCollections } from './api/collection.js';
 export { getActiveChurnLandingPageURL, getCreditSummary, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getGiftRedemptionLandingPageURL, sendCustomerNotification, updateCustomer } from './api/customer.js';
 export { getGiftPurchase, listGiftPurchases } from './api/gift.js';
 export { activateMembership, cancelMembership, changeMembership, getMembership, listMemberships } from './api/membership.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;"}

package/dist/esm/utils/request.js

@@ -1,4 +1,5 @@
 import 'isomorphic-fetch';
+import { nanoid } from 'nanoid/non-secure';
 import stringify from 'qs/lib/stringify';
 import { getOptions } from './options.js';
 import { RECHARGE_CDN_URL, RECHARGE_API_URL, SHOPIFY_APP_PROXY_URL } from '../constants/api.js';
@@ -11,6 +12,13 @@ function stringifyQuery(str) {
     arrayFormat: "comma"
   });
 }
+function getInternalSession(session, fnName) {
+  return {
+    ...session,
+    internalFnCall: session.internalFnCall ?? fnName,
+    internalRequestId: session.internalRequestId ?? nanoid()
+  };
+}
 async function cdnRequest(method, url, requestOptions = {}) {
   const opts = getOptions();
   return request(method, `${RECHARGE_CDN_URL(opts.environment)}/store/${opts.storeIdentifier}${url}`, requestOptions);
@@ -22,6 +30,8 @@ async function rechargeApiRequest(method, url, { id, query, data, headers } = {}
   const reqHeaders = {
     "X-Recharge-Access-Token": token,
     "X-Recharge-Version": "2021-11",
+    "X-Recharge-Fn": session.internalFnCall,
+    "X-Request-Id": session.internalRequestId,
     ...headers ? headers : {}
   };
   const localQuery = {
@@ -96,5 +106,5 @@ async function request(method, url, { id, query, data, headers } = {}) {
   return result;
 }
 
-export { cdnRequest, rechargeApiRequest, request, shopifyAppProxyRequest };
+export { cdnRequest, getInternalSession, rechargeApiRequest, request, shopifyAppProxyRequest };
 //# sourceMappingURL=request.js.map

package/dist/esm/utils/request.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.js","sources":["../../../src/utils/request.ts"],"sourcesContent":["import 'isomorphic-fetch';\n\nimport stringify from 'qs/lib/stringify';\n\nimport { Method, RequestHeaders, RequestOptions } from '../types';\nimport { getOptions } from './options';\nimport { RECHARGE_API_URL, RECHARGE_CDN_URL, SHOPIFY_APP_PROXY_URL } from '../constants/api';\nimport { Session } from '../types/session';\nimport { RechargeRequestError } from './error';\n\nfunction stringifyQuery(str: unknown): string {\n  return stringify(str, {\n    encode: false,\n    indices: false,\n    arrayFormat: 'comma',\n  });\n}\n\nexport async function cdnRequest<T>(method: Method, url: string, requestOptions: RequestOptions = {}): Promise<T> {\n  const opts = getOptions();\n  return request(method, `${RECHARGE_CDN_URL(opts.environment)}/store/${opts.storeIdentifier}${url}`, requestOptions);\n}\n\nexport async function rechargeApiRequest<T>(\n  method: Method,\n  url: string,\n  { id, query, data, headers }: RequestOptions = {},\n  session: Session\n): Promise<T> {\n  const { environment, environmentUri, storeIdentifier, loginRetryFn } = getOptions();\n  const token = session.apiToken;\n  const rechargeBaseUrl = RECHARGE_API_URL(environment, environmentUri);\n  const reqHeaders: RequestHeaders = {\n    'X-Recharge-Access-Token': token,\n    'X-Recharge-Version': '2021-11',\n    ...(headers ? headers : {}),\n  };\n\n  const localQuery = {\n    shop_url: storeIdentifier,\n    ...(query as any),\n  };\n\n  try {\n    // await to catch any errors\n    return await request<T>(method, `${rechargeBaseUrl}${url}`, { id, query: localQuery, data, headers: reqHeaders });\n  } catch (error: unknown) {\n    if (loginRetryFn && error instanceof RechargeRequestError && error.status === 401) {\n      // call loginRetryFn and retry request on 401\n      return loginRetryFn().then(session => {\n        if (session) {\n          return request(method, `${rechargeBaseUrl}${url}`, {\n            id,\n            query: localQuery,\n            data,\n            headers: {\n              ...reqHeaders,\n              'X-Recharge-Access-Token': session.apiToken,\n            },\n          });\n        }\n        throw error;\n      });\n    }\n    throw error;\n  }\n}\n\nexport async function shopifyAppProxyRequest<T>(\n  method: Method,\n  url: string,\n  requestOptions: RequestOptions = {}\n): Promise<T> {\n  return request(method, `${SHOPIFY_APP_PROXY_URL}${url}`, requestOptions);\n}\n\nexport async function request<T>(\n  method: Method,\n  url: string,\n  { id, query, data, headers }: RequestOptions = {}\n): Promise<T> {\n  let reqUrl = url.trim();\n\n  if (id) {\n    reqUrl = [reqUrl, `${id}`.trim()].join('/');\n  }\n\n  if (query) {\n    let exQuery;\n    [reqUrl, exQuery] = reqUrl.split('?');\n    const fullQuery = [exQuery, stringifyQuery(query)].join('&').replace(/^&/, '');\n    reqUrl = `${reqUrl}${fullQuery ? `?${fullQuery}` : ''}`;\n  }\n\n  let reqBody;\n  if (data && method !== 'get') {\n    reqBody = JSON.stringify(data);\n  }\n\n  const reqHeaders: RequestHeaders = {\n    Accept: 'application/json',\n    'Content-Type': 'application/json',\n    'X-Recharge-App': 'storefront-client',\n    ...(headers ? headers : {}),\n  };\n\n  const response = await fetch(reqUrl, {\n    method,\n    headers: reqHeaders,\n    body: reqBody,\n  });\n\n  let result;\n  try {\n    result = await response.json();\n  } catch (e) {\n    // If we get here, it means we were a no content response.\n  }\n\n  if (!response.ok) {\n    if (result && result.error) {\n      throw new RechargeRequestError(result.error, response.status);\n    } else if (result && result.errors) {\n      throw new RechargeRequestError(JSON.stringify(result.errors), response.status);\n    } else {\n      throw new RechargeRequestError('A connection error occurred while making the request');\n    }\n  }\n\n  return result as T;\n}\n"],"names":["session"],"mappings":";;;;;;AAUA,SAAS,eAAe,GAAsB,EAAA;AAC5C,EAAA,OAAO,UAAU,GAAK,EAAA;AAAA,IACpB,MAAQ,EAAA,KAAA;AAAA,IACR,OAAS,EAAA,KAAA;AAAA,IACT,WAAa,EAAA,OAAA;AAAA,GACd,CAAA,CAAA;AACH,CAAA;AAEA,eAAsB,UAAc,CAAA,MAAA,EAAgB,GAAa,EAAA,cAAA,GAAiC,EAAgB,EAAA;AAChH,EAAA,MAAM,OAAO,UAAW,EAAA,CAAA;AACxB,EAAA,OAAO,OAAQ,CAAA,MAAA,EAAQ,CAAG,EAAA,gBAAA,CAAiB,IAAK,CAAA,WAAW,CAAC,CAAA,OAAA,EAAU,IAAK,CAAA,eAAe,CAAG,EAAA,GAAG,IAAI,cAAc,CAAA,CAAA;AACpH,CAAA;AAEsB,eAAA,kBAAA,CACpB,MACA,EAAA,GAAA,EACA,EAAE,EAAA,EAAI,KAAO,EAAA,IAAA,EAAM,OAAQ,EAAA,GAAoB,EAAC,EAChD,OACY,EAAA;AACZ,EAAA,MAAM,EAAE,WAAa,EAAA,cAAA,EAAgB,eAAiB,EAAA,YAAA,KAAiB,UAAW,EAAA,CAAA;AAClF,EAAA,MAAM,QAAQ,OAAQ,CAAA,QAAA,CAAA;AACtB,EAAM,MAAA,eAAA,GAAkB,gBAAiB,CAAA,WAAA,EAAa,cAAc,CAAA,CAAA;AACpE,EAAA,MAAM,UAA6B,GAAA;AAAA,IACjC,yBAA2B,EAAA,KAAA;AAAA,IAC3B,oBAAsB,EAAA,SAAA;AAAA,IACtB,GAAI,OAAU,GAAA,OAAA,GAAU,EAAC;AAAA,GAC3B,CAAA;AAEA,EAAA,MAAM,UAAa,GAAA;AAAA,IACjB,QAAU,EAAA,eAAA;AAAA,IACV,GAAI,KAAA;AAAA,GACN,CAAA;AAEA,EAAI,IAAA;AAEF,IAAA,OAAO,MAAM,OAAA,CAAW,MAAQ,EAAA,CAAA,EAAG,eAAe,CAAG,EAAA,GAAG,CAAI,CAAA,EAAA,EAAE,IAAI,KAAO,EAAA,UAAA,EAAY,IAAM,EAAA,OAAA,EAAS,YAAY,CAAA,CAAA;AAAA,WACzG,KAAgB,EAAA;AACvB,IAAA,IAAI,YAAgB,IAAA,KAAA,YAAiB,oBAAwB,IAAA,KAAA,CAAM,WAAW,GAAK,EAAA;AAEjF,MAAA,OAAO,YAAa,EAAA,CAAE,IAAK,CAAA,CAAAA,QAAW,KAAA;AACpC,QAAA,IAAIA,QAAS,EAAA;AACX,UAAA,OAAO,QAAQ,MAAQ,EAAA,CAAA,EAAG,eAAe,CAAA,EAAG,GAAG,CAAI,CAAA,EAAA;AAAA,YACjD,EAAA;AAAA,YACA,KAAO,EAAA,UAAA;AAAA,YACP,IAAA;AAAA,YACA,OAAS,EAAA;AAAA,cACP,GAAG,UAAA;AAAA,cACH,2BAA2BA,QAAQ,CAAA,QAAA;AAAA,aACrC;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AACA,QAAM,MAAA,KAAA,CAAA;AAAA,OACP,CAAA,CAAA;AAAA,KACH;AACA,IAAM,MAAA,KAAA,CAAA;AAAA,GACR;AACF,CAAA;AAEA,eAAsB,sBACpB,CAAA,MAAA,EACA,GACA,EAAA,cAAA,GAAiC,EACrB,EAAA;AACZ,EAAA,OAAO,QAAQ,MAAQ,EAAA,CAAA,EAAG,qBAAqB,CAAG,EAAA,GAAG,IAAI,cAAc,CAAA,CAAA;AACzE,CAAA;AAEsB,eAAA,OAAA,CACpB,MACA,EAAA,GAAA,EACA,EAAE,EAAA,EAAI,OAAO,IAAM,EAAA,OAAA,EAA4B,GAAA,EACnC,EAAA;AACZ,EAAI,IAAA,MAAA,GAAS,IAAI,IAAK,EAAA,CAAA;AAEtB,EAAA,IAAI,EAAI,EAAA;AACN,IAAS,MAAA,GAAA,CAAC,QAAQ,CAAG,EAAA,EAAE,GAAG,IAAK,EAAC,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,GAC5C;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAI,IAAA,OAAA,CAAA;AACJ,IAAA,CAAC,MAAQ,EAAA,OAAO,CAAI,GAAA,MAAA,CAAO,MAAM,GAAG,CAAA,CAAA;AACpC,IAAA,MAAM,SAAY,GAAA,CAAC,OAAS,EAAA,cAAA,CAAe,KAAK,CAAC,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,CAAE,OAAQ,CAAA,IAAA,EAAM,EAAE,CAAA,CAAA;AAC7E,IAAA,MAAA,GAAS,GAAG,MAAM,CAAA,EAAG,YAAY,CAAI,CAAA,EAAA,SAAS,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,GACvD;AAEA,EAAI,IAAA,OAAA,CAAA;AACJ,EAAI,IAAA,IAAA,IAAQ,WAAW,KAAO,EAAA;AAC5B,IAAU,OAAA,GAAA,IAAA,CAAK,UAAU,IAAI,CAAA,CAAA;AAAA,GAC/B;AAEA,EAAA,MAAM,UAA6B,GAAA;AAAA,IACjC,MAAQ,EAAA,kBAAA;AAAA,IACR,cAAgB,EAAA,kBAAA;AAAA,IAChB,gBAAkB,EAAA,mBAAA;AAAA,IAClB,GAAI,OAAU,GAAA,OAAA,GAAU,EAAC;AAAA,GAC3B,CAAA;AAEA,EAAM,MAAA,QAAA,GAAW,MAAM,KAAA,CAAM,MAAQ,EAAA;AAAA,IACnC,MAAA;AAAA,IACA,OAAS,EAAA,UAAA;AAAA,IACT,IAAM,EAAA,OAAA;AAAA,GACP,CAAA,CAAA;AAED,EAAI,IAAA,MAAA,CAAA;AACJ,EAAI,IAAA;AACF,IAAS,MAAA,GAAA,MAAM,SAAS,IAAK,EAAA,CAAA;AAAA,WACtB,CAAG,EAAA;AAAA,GAEZ;AAEA,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAI,IAAA,MAAA,IAAU,OAAO,KAAO,EAAA;AAC1B,MAAA,MAAM,IAAI,oBAAA,CAAqB,MAAO,CAAA,KAAA,EAAO,SAAS,MAAM,CAAA,CAAA;AAAA,KAC9D,MAAA,IAAW,MAAU,IAAA,MAAA,CAAO,MAAQ,EAAA;AAClC,MAAM,MAAA,IAAI,qBAAqB,IAAK,CAAA,SAAA,CAAU,OAAO,MAAM,CAAA,EAAG,SAAS,MAAM,CAAA,CAAA;AAAA,KACxE,MAAA;AACL,MAAM,MAAA,IAAI,qBAAqB,sDAAsD,CAAA,CAAA;AAAA,KACvF;AAAA,GACF;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}
+{"version":3,"file":"request.js","sources":["../../../src/utils/request.ts"],"sourcesContent":["import 'isomorphic-fetch';\n\nimport { nanoid } from 'nanoid/non-secure';\nimport stringify from 'qs/lib/stringify';\n\nimport { Method, RequestHeaders, RequestOptions, InternalSession, Session } from '../types';\nimport { getOptions } from './options';\nimport { RECHARGE_API_URL, RECHARGE_CDN_URL, SHOPIFY_APP_PROXY_URL } from '../constants/api';\nimport { RechargeRequestError } from './error';\n\nfunction stringifyQuery(str: unknown): string {\n  return stringify(str, {\n    encode: false,\n    indices: false,\n    arrayFormat: 'comma',\n  });\n}\n\n/** @internal */\nexport function getInternalSession(session: Session | InternalSession, fnName: string): InternalSession {\n  return {\n    ...session,\n    internalFnCall: (session as InternalSession).internalFnCall ?? fnName,\n    internalRequestId: (session as InternalSession).internalRequestId ?? nanoid(),\n  };\n}\n\nexport async function cdnRequest<T>(method: Method, url: string, requestOptions: RequestOptions = {}): Promise<T> {\n  const opts = getOptions();\n  return request(method, `${RECHARGE_CDN_URL(opts.environment)}/store/${opts.storeIdentifier}${url}`, requestOptions);\n}\n\nexport async function rechargeApiRequest<T>(\n  method: Method,\n  url: string,\n  { id, query, data, headers }: RequestOptions = {},\n  session: InternalSession\n): Promise<T> {\n  const { environment, environmentUri, storeIdentifier, loginRetryFn } = getOptions();\n  const token = session.apiToken;\n  const rechargeBaseUrl = RECHARGE_API_URL(environment, environmentUri);\n  const reqHeaders: RequestHeaders = {\n    'X-Recharge-Access-Token': token,\n    'X-Recharge-Version': '2021-11',\n    'X-Recharge-Fn': session.internalFnCall,\n    'X-Request-Id': session.internalRequestId,\n    ...(headers ? headers : {}),\n  };\n\n  const localQuery = {\n    shop_url: storeIdentifier,\n    ...(query as any),\n  };\n\n  try {\n    // await to catch any errors\n    return await request<T>(method, `${rechargeBaseUrl}${url}`, { id, query: localQuery, data, headers: reqHeaders });\n  } catch (error: unknown) {\n    if (loginRetryFn && error instanceof RechargeRequestError && error.status === 401) {\n      // call loginRetryFn and retry request on 401\n      return loginRetryFn().then(session => {\n        if (session) {\n          return request(method, `${rechargeBaseUrl}${url}`, {\n            id,\n            query: localQuery,\n            data,\n            headers: {\n              ...reqHeaders,\n              'X-Recharge-Access-Token': session.apiToken,\n            },\n          });\n        }\n        throw error;\n      });\n    }\n    throw error;\n  }\n}\n\nexport async function shopifyAppProxyRequest<T>(\n  method: Method,\n  url: string,\n  requestOptions: RequestOptions = {}\n): Promise<T> {\n  return request(method, `${SHOPIFY_APP_PROXY_URL}${url}`, requestOptions);\n}\n\nexport async function request<T>(\n  method: Method,\n  url: string,\n  { id, query, data, headers }: RequestOptions = {}\n): Promise<T> {\n  let reqUrl = url.trim();\n\n  if (id) {\n    reqUrl = [reqUrl, `${id}`.trim()].join('/');\n  }\n\n  if (query) {\n    let exQuery;\n    [reqUrl, exQuery] = reqUrl.split('?');\n    const fullQuery = [exQuery, stringifyQuery(query)].join('&').replace(/^&/, '');\n    reqUrl = `${reqUrl}${fullQuery ? `?${fullQuery}` : ''}`;\n  }\n\n  let reqBody;\n  if (data && method !== 'get') {\n    reqBody = JSON.stringify(data);\n  }\n\n  const reqHeaders: RequestHeaders = {\n    Accept: 'application/json',\n    'Content-Type': 'application/json',\n    'X-Recharge-App': 'storefront-client',\n    ...(headers ? headers : {}),\n  };\n\n  const response = await fetch(reqUrl, {\n    method,\n    headers: reqHeaders,\n    body: reqBody,\n  });\n\n  let result;\n  try {\n    result = await response.json();\n  } catch (e) {\n    // If we get here, it means we were a no content response.\n  }\n\n  if (!response.ok) {\n    if (result && result.error) {\n      throw new RechargeRequestError(result.error, response.status);\n    } else if (result && result.errors) {\n      throw new RechargeRequestError(JSON.stringify(result.errors), response.status);\n    } else {\n      throw new RechargeRequestError('A connection error occurred while making the request');\n    }\n  }\n\n  return result as T;\n}\n"],"names":["session"],"mappings":";;;;;;;AAUA,SAAS,eAAe,GAAsB,EAAA;AAC5C,EAAA,OAAO,UAAU,GAAK,EAAA;AAAA,IACpB,MAAQ,EAAA,KAAA;AAAA,IACR,OAAS,EAAA,KAAA;AAAA,IACT,WAAa,EAAA,OAAA;AAAA,GACd,CAAA,CAAA;AACH,CAAA;AAGgB,SAAA,kBAAA,CAAmB,SAAoC,MAAiC,EAAA;AACtG,EAAO,OAAA;AAAA,IACL,GAAG,OAAA;AAAA,IACH,cAAA,EAAiB,QAA4B,cAAkB,IAAA,MAAA;AAAA,IAC/D,iBAAA,EAAoB,OAA4B,CAAA,iBAAA,IAAqB,MAAO,EAAA;AAAA,GAC9E,CAAA;AACF,CAAA;AAEA,eAAsB,UAAc,CAAA,MAAA,EAAgB,GAAa,EAAA,cAAA,GAAiC,EAAgB,EAAA;AAChH,EAAA,MAAM,OAAO,UAAW,EAAA,CAAA;AACxB,EAAA,OAAO,OAAQ,CAAA,MAAA,EAAQ,CAAG,EAAA,gBAAA,CAAiB,IAAK,CAAA,WAAW,CAAC,CAAA,OAAA,EAAU,IAAK,CAAA,eAAe,CAAG,EAAA,GAAG,IAAI,cAAc,CAAA,CAAA;AACpH,CAAA;AAEsB,eAAA,kBAAA,CACpB,MACA,EAAA,GAAA,EACA,EAAE,EAAA,EAAI,KAAO,EAAA,IAAA,EAAM,OAAQ,EAAA,GAAoB,EAAC,EAChD,OACY,EAAA;AACZ,EAAA,MAAM,EAAE,WAAa,EAAA,cAAA,EAAgB,eAAiB,EAAA,YAAA,KAAiB,UAAW,EAAA,CAAA;AAClF,EAAA,MAAM,QAAQ,OAAQ,CAAA,QAAA,CAAA;AACtB,EAAM,MAAA,eAAA,GAAkB,gBAAiB,CAAA,WAAA,EAAa,cAAc,CAAA,CAAA;AACpE,EAAA,MAAM,UAA6B,GAAA;AAAA,IACjC,yBAA2B,EAAA,KAAA;AAAA,IAC3B,oBAAsB,EAAA,SAAA;AAAA,IACtB,iBAAiB,OAAQ,CAAA,cAAA;AAAA,IACzB,gBAAgB,OAAQ,CAAA,iBAAA;AAAA,IACxB,GAAI,OAAU,GAAA,OAAA,GAAU,EAAC;AAAA,GAC3B,CAAA;AAEA,EAAA,MAAM,UAAa,GAAA;AAAA,IACjB,QAAU,EAAA,eAAA;AAAA,IACV,GAAI,KAAA;AAAA,GACN,CAAA;AAEA,EAAI,IAAA;AAEF,IAAA,OAAO,MAAM,OAAA,CAAW,MAAQ,EAAA,CAAA,EAAG,eAAe,CAAG,EAAA,GAAG,CAAI,CAAA,EAAA,EAAE,IAAI,KAAO,EAAA,UAAA,EAAY,IAAM,EAAA,OAAA,EAAS,YAAY,CAAA,CAAA;AAAA,WACzG,KAAgB,EAAA;AACvB,IAAA,IAAI,YAAgB,IAAA,KAAA,YAAiB,oBAAwB,IAAA,KAAA,CAAM,WAAW,GAAK,EAAA;AAEjF,MAAA,OAAO,YAAa,EAAA,CAAE,IAAK,CAAA,CAAAA,QAAW,KAAA;AACpC,QAAA,IAAIA,QAAS,EAAA;AACX,UAAA,OAAO,QAAQ,MAAQ,EAAA,CAAA,EAAG,eAAe,CAAA,EAAG,GAAG,CAAI,CAAA,EAAA;AAAA,YACjD,EAAA;AAAA,YACA,KAAO,EAAA,UAAA;AAAA,YACP,IAAA;AAAA,YACA,OAAS,EAAA;AAAA,cACP,GAAG,UAAA;AAAA,cACH,2BAA2BA,QAAQ,CAAA,QAAA;AAAA,aACrC;AAAA,WACD,CAAA,CAAA;AAAA,SACH;AACA,QAAM,MAAA,KAAA,CAAA;AAAA,OACP,CAAA,CAAA;AAAA,KACH;AACA,IAAM,MAAA,KAAA,CAAA;AAAA,GACR;AACF,CAAA;AAEA,eAAsB,sBACpB,CAAA,MAAA,EACA,GACA,EAAA,cAAA,GAAiC,EACrB,EAAA;AACZ,EAAA,OAAO,QAAQ,MAAQ,EAAA,CAAA,EAAG,qBAAqB,CAAG,EAAA,GAAG,IAAI,cAAc,CAAA,CAAA;AACzE,CAAA;AAEsB,eAAA,OAAA,CACpB,MACA,EAAA,GAAA,EACA,EAAE,EAAA,EAAI,OAAO,IAAM,EAAA,OAAA,EAA4B,GAAA,EACnC,EAAA;AACZ,EAAI,IAAA,MAAA,GAAS,IAAI,IAAK,EAAA,CAAA;AAEtB,EAAA,IAAI,EAAI,EAAA;AACN,IAAS,MAAA,GAAA,CAAC,QAAQ,CAAG,EAAA,EAAE,GAAG,IAAK,EAAC,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,GAC5C;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAI,IAAA,OAAA,CAAA;AACJ,IAAA,CAAC,MAAQ,EAAA,OAAO,CAAI,GAAA,MAAA,CAAO,MAAM,GAAG,CAAA,CAAA;AACpC,IAAA,MAAM,SAAY,GAAA,CAAC,OAAS,EAAA,cAAA,CAAe,KAAK,CAAC,CAAE,CAAA,IAAA,CAAK,GAAG,CAAA,CAAE,OAAQ,CAAA,IAAA,EAAM,EAAE,CAAA,CAAA;AAC7E,IAAA,MAAA,GAAS,GAAG,MAAM,CAAA,EAAG,YAAY,CAAI,CAAA,EAAA,SAAS,KAAK,EAAE,CAAA,CAAA,CAAA;AAAA,GACvD;AAEA,EAAI,IAAA,OAAA,CAAA;AACJ,EAAI,IAAA,IAAA,IAAQ,WAAW,KAAO,EAAA;AAC5B,IAAU,OAAA,GAAA,IAAA,CAAK,UAAU,IAAI,CAAA,CAAA;AAAA,GAC/B;AAEA,EAAA,MAAM,UAA6B,GAAA;AAAA,IACjC,MAAQ,EAAA,kBAAA;AAAA,IACR,cAAgB,EAAA,kBAAA;AAAA,IAChB,gBAAkB,EAAA,mBAAA;AAAA,IAClB,GAAI,OAAU,GAAA,OAAA,GAAU,EAAC;AAAA,GAC3B,CAAA;AAEA,EAAM,MAAA,QAAA,GAAW,MAAM,KAAA,CAAM,MAAQ,EAAA;AAAA,IACnC,MAAA;AAAA,IACA,OAAS,EAAA,UAAA;AAAA,IACT,IAAM,EAAA,OAAA;AAAA,GACP,CAAA,CAAA;AAED,EAAI,IAAA,MAAA,CAAA;AACJ,EAAI,IAAA;AACF,IAAS,MAAA,GAAA,MAAM,SAAS,IAAK,EAAA,CAAA;AAAA,WACtB,CAAG,EAAA;AAAA,GAEZ;AAEA,EAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,IAAI,IAAA,MAAA,IAAU,OAAO,KAAO,EAAA;AAC1B,MAAA,MAAM,IAAI,oBAAA,CAAqB,MAAO,CAAA,KAAA,EAAO,SAAS,MAAM,CAAA,CAAA;AAAA,KAC9D,MAAA,IAAW,MAAU,IAAA,MAAA,CAAO,MAAQ,EAAA;AAClC,MAAM,MAAA,IAAI,qBAAqB,IAAK,CAAA,SAAA,CAAU,OAAO,MAAM,CAAA,EAAG,SAAS,MAAM,CAAA,CAAA;AAAA,KACxE,MAAA;AACL,MAAM,MAAA,IAAI,qBAAqB,sDAAsD,CAAA,CAAA;AAAA,KACvF;AAAA,GACF;AAEA,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}

package/dist/index.d.ts

@@ -1407,37 +1407,23 @@ interface AddressListParams extends ListParams<AddressSortBy> {
     include?: AddressIncludes[];
 }
 
-interface Session {
-    /** API token */
-    apiToken: string;
-    /** Customer ID attached to the session */
-    customerId?: string;
-    /** Message related to fetching the session */
-    message?: string;
+type Method = 'get' | 'post' | 'put' | 'delete';
+type Request = <T>(method: Method, url: string, options?: RequestOptions) => Promise<T>;
+interface GetRequestOptions {
+    id?: string | number;
+    query?: unknown;
+}
+interface CRUDRequestOptions {
+    id?: string | number;
+    data?: unknown;
+    query?: unknown;
+}
+/** We only support headers with an object syntax */
+type RequestHeaders = Record<string, string>;
+interface RequestOptions extends GetRequestOptions, CRUDRequestOptions {
+    fnName?: string;
+    headers?: RequestHeaders;
 }
-
-/** 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(session: Session, id: string | number, options?: GetAddressOptions): Promise<Address>;
-/** Create a new address for a customer. */
-declare function createAddress(session: Session, createRequest: CreateAddressRequest): Promise<Address>;
-/** Updates an existing address to match the specified parameters. */
-declare function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest): Promise<Address>;
-/** Apply discount code to an address.  Addresses are currently limited to a single discount. */
-declare function applyDiscountToAddress(session: Session, id: string | number, discountCode: string): Promise<Address>;
-/** Removes all discounts from an address. */
-declare function removeDiscountsFromAddress(session: Session, id: string | number): Promise<Address>;
-/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */
-declare function deleteAddress(session: Session, id: string | number): Promise<void>;
-/**
- * Merges up to 10 source addresses into 1 target 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(session: Session, id: string | number, skipRequest: SkipFutureChargeAddressRequest): Promise<Charge>;
 
 interface LoginResponse {
     api_token: string;
@@ -1458,34 +1444,6 @@ interface PasswordlessValidateResponse {
     errors?: string;
 }
 
-declare function loginShopifyAppProxy(): Promise<Session>;
-/** @deprecated Use `loginWithShopifyStorefront` instead */
-declare function loginShopifyApi(shopifyStorefrontToken: string, shopifyCustomerAccessToken?: string): Promise<Session | null>;
-declare function loginWithShopifyStorefront(shopifyStorefrontToken: string, shopifyCustomerAccessToken?: string): Promise<Session | null>;
-declare function loginWithShopifyCustomerAccount(shopifyCustomerAccessToken?: string): Promise<Session | null>;
-declare function sendPasswordlessCode(email: string, options?: PasswordlessOptions): Promise<string>;
-declare function sendPasswordlessCodeAppProxy(email: string, options?: PasswordlessOptions): Promise<string>;
-declare function validatePasswordlessCode(email: string, session_token: string, code: string): Promise<Session>;
-declare function validatePasswordlessCodeAppProxy(email: string, session_token: string, code: string): Promise<Session>;
-declare function loginCustomerPortal(): Promise<Session>;
-
-type Method = 'get' | 'post' | 'put' | 'delete';
-type Request = <T>(method: Method, url: string, options?: RequestOptions) => Promise<T>;
-interface GetRequestOptions {
-    id?: string | number;
-    query?: unknown;
-}
-interface CRUDRequestOptions {
-    id?: string | number;
-    data?: unknown;
-    query?: unknown;
-}
-/** We only support headers with an object syntax */
-type RequestHeaders = Record<string, string>;
-interface RequestOptions extends GetRequestOptions, CRUDRequestOptions {
-    headers?: RequestHeaders;
-}
-
 type ProductInclude = 'collections';
 type ProductSource = 'all' | 'in_recharge' | 'not_in_recharge';
 type PublishStatus = 'published' | 'unpublished' | 'any';
@@ -2096,6 +2054,37 @@ interface CDNBundleSettings extends Omit<BundleProduct, 'created_at' | 'custom_p
     variants: CDNBundleVariant[];
 }
 
+type CollectionsSortBy = 'id-desc' | 'id-asc' | 'created_at-asc' | 'created_at-desc' | 'title-asc' | 'title-desc';
+type CollectionTypes = 'automatic' | 'manual';
+interface Collection {
+    /** Unique numeric identifier for the Collection. */
+    id: number;
+    /** The title of the Collection. A short descriptive definition of the Collection. */
+    title: string;
+    /** The Collection description. Used to store a detailed explanation of the Collection content and its purpose. */
+    description: string;
+    sort_order: CollectionsSortBy | 'manual';
+    /** The type of the Collection. manual stands for Collections which were manually created ie. when the products where explicitly selected to be part of the Collection. */
+    type: CollectionTypes;
+    /** Sort order of products within the collection */
+    manual_sort_order: string[];
+    /** The date and time when the Collection was created. */
+    created_at: IsoDateString;
+    /** The date and time when the Collection was last updated. */
+    updated_at: IsoDateString;
+}
+interface CollectionsResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    collections: Collection[];
+}
+interface CollectionListParams extends ListParams<CollectionsSortBy> {
+    /** Filter by collection type. */
+    type?: CollectionTypes;
+    /** Filter by title. */
+    title?: string;
+}
+
 /** A gift given to a customer. */
 interface GiftPurchase {
     /** Unique numeric identifier for the Gift. */
@@ -2254,21 +2243,6 @@ interface MembershipBenefit {
     updated_at: IsoDateString;
 }
 
-/** @internal */
-type CollectionsSortBy = 'id-desc' | 'id-asc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-desc' | 'updated_at-asc' | 'title-asc' | 'title-desc';
-/** @internal */
-type CollectionTypes = 'automatic' | 'manual';
-/** @internal */
-interface Collection {
-    id: number;
-    title: string;
-    description: string;
-    sort_order: CollectionsSortBy;
-    type: CollectionTypes;
-    created_at: IsoDateString;
-    updated_at: IsoDateString;
-}
-
 /** @internal */
 interface ExternalAttributeSchema {
     order_tag: string;
@@ -2406,6 +2380,20 @@ interface OnetimeListParams extends ListParams<OnetimesSortBy> {
     updated_at_min?: IsoDateString;
 }
 
+interface Session {
+    /** API token */
+    apiToken: string;
+    /** Customer ID attached to the session */
+    customerId?: string;
+    /** Message related to fetching the session */
+    message?: string;
+}
+/** @internal */
+interface InternalSession extends Session {
+    internalFnCall: string;
+    internalRequestId: string;
+}
+
 /** @internal */
 type StorefrontEnvironment = 'stage' | 'prod' | 'prestage' | 'preprod';
 /** @internal */
@@ -2481,6 +2469,40 @@ interface ShippingCountry {
     provinces: ShippingProvince[];
 }
 
+/** 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(session: Session, id: string | number, options?: GetAddressOptions): Promise<Address>;
+/** Create a new address for a customer. */
+declare function createAddress(session: Session, createRequest: CreateAddressRequest): Promise<Address>;
+/** Updates an existing address to match the specified parameters. */
+declare function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest): Promise<Address>;
+/** Apply discount code to an address.  Addresses are currently limited to a single discount. */
+declare function applyDiscountToAddress(session: Session, id: string | number, discountCode: string): Promise<Address>;
+/** Removes all discounts from an address. */
+declare function removeDiscountsFromAddress(session: Session, id: string | number): Promise<Address>;
+/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */
+declare function deleteAddress(session: Session, id: string | number): Promise<void>;
+/**
+ * Merges up to 10 source addresses into 1 target 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(session: Session, id: string | number, skipRequest: SkipFutureChargeAddressRequest): Promise<Charge>;
+
+declare function loginShopifyAppProxy(): Promise<Session>;
+/** @deprecated Use `loginWithShopifyStorefront` instead */
+declare function loginShopifyApi(shopifyStorefrontToken: string, shopifyCustomerAccessToken?: string): Promise<Session | null>;
+declare function loginWithShopifyStorefront(shopifyStorefrontToken: string, shopifyCustomerAccessToken?: string): Promise<Session | null>;
+declare function loginWithShopifyCustomerAccount(shopifyCustomerAccessToken?: string): Promise<Session | null>;
+declare function sendPasswordlessCode(email: string, options?: PasswordlessOptions): Promise<string>;
+declare function sendPasswordlessCodeAppProxy(email: string, options?: PasswordlessOptions): Promise<string>;
+declare function validatePasswordlessCode(email: string, session_token: string, code: string): Promise<Session>;
+declare function validatePasswordlessCodeAppProxy(email: string, session_token: string, code: string): Promise<Session>;
+declare function loginCustomerPortal(): Promise<Session>;
+
 declare function getBundleId(bundle: BundleAppProxy): Promise<string>;
 declare function getDynamicBundleItems(bundle: BundleAppProxy, shopifyProductHandle: string): DynamicBundleItemAppProxy[];
 declare function validateBundle(bundle: BundleAppProxy): Promise<true | string>;
@@ -2527,6 +2549,15 @@ declare function skipCharge(session: Session, id: number | string, purchaseItemI
 declare function unskipCharge(session: Session, id: number | string, purchaseItemIds: (string | number)[], query?: SkipChargeParams): Promise<Charge>;
 declare function processCharge(session: Session, id: number | string): Promise<Charge>;
 
+type ProductListResponse<T extends ProductSearchParams_2020_12 | ProductSearchParams_2022_06> = T extends ProductSearchParams_2020_12 ? {
+    products: Product_2020_12[];
+} : {
+    products: Product_2022_06[];
+};
+declare function getCollection(session: Session, id: string | number): Promise<Collection>;
+declare function listCollections(session: Session, query?: CollectionListParams): Promise<CollectionsResponse>;
+declare function listCollectionProducts<T extends ProductSearchParams_2020_12 | ProductSearchParams_2022_06>(session: Session, id: string | number, query: T): Promise<ProductListResponse<T>>;
+
 declare function getCustomer(session: Session, options?: GetCustomerOptions): Promise<Customer>;
 declare function updateCustomer(session: Session, updateRequest: UpdateCustomerRequest): Promise<Customer>;
 declare function getDeliverySchedule(session: Session, query?: CustomerDeliveryScheduleParams): Promise<Delivery[]>;
@@ -2659,4 +2690,4 @@ declare const api: {
 };
 declare function initRecharge(opt?: InitOptions): void;
 
-export { type ActivateMembershipRequest, type AddToCartCallbackSettings, type AddonSettings, type Address, type AddressIncludes, type AddressListParams, type AddressListResponse, type AddressResponse, type AddressSortBy, type AnalyticsData, type AssociatedAddress, type BasicSubscriptionParams, type BooleanLike, type BooleanNumbers, type BooleanString, type BooleanStringNumbers, type BundleAppProxy, type BundlePriceRule, type BundleProduct, type BundleProductLayoutSettings, type BundlePurchaseItem, type BundlePurchaseItemParams, type BundleSelection, type BundleSelectionAppProxy, type BundleSelectionItem, type BundleSelectionItemRequiredCreateProps, type BundleSelectionListParams, type BundleSelectionsResponse, type BundleSelectionsSortBy, type BundleTemplateSettings, type BundleTemplateType, type BundleTranslations, type BundleVariant, type BundleVariantOptionSource, type BundleVariantRange, type BundleVariantSelectionDefault, type CDNBaseWidgetSettings, type CDNBundleSettings, type CDNBundleVariant, type CDNBundleVariantOptionSource, type CDNPlan, type CDNProduct, type CDNProductAndSettings, type CDNProductKeyObject, type CDNProductQuery_2020_12, type CDNProductQuery_2022_06, type CDNProductRaw, type CDNProductResource, type CDNProductResponseType, type CDNProductType, type CDNProductVariant_2022_06, type CDNProduct_2022_06, type CDNProductsAndSettings, type CDNProductsAndSettingsResource, type CDNStoreSettings, type CDNSubscriptionOption, type CDNVariant, type CDNVersion, type CDNWidgetSettings, type CDNWidgetSettingsRaw, type CDNWidgetSettingsResource, type CRUDRequestOptions, type CancelMembershipRequest, type CancelSubscriptionRequest, type ChangeMembershipRequest, type ChannelSettings, type Charge, type ChargeIncludes, type ChargeListParams, type ChargeListResponse, type ChargeResponse, type ChargeSortBy, type ChargeStatus, type ColorString, type CreateAddressRequest, type CreateBundleSelectionRequest, type CreateMetafieldRequest, type CreateOnetimeRequest, type CreatePaymentMethodRequest, type CreateRecipientAddress, type CreateSubscriptionRequest, type CreditAccount, type CreditAccountType, type CreditSummaryIncludes, type CrossSellsSettings, type Customer, type CustomerCreditSummary, type CustomerDeliveryScheduleParams, type CustomerDeliveryScheduleResponse, type CustomerIncludes, type CustomerNotification, type CustomerNotificationOptions, type CustomerNotificationTemplate, type CustomerNotificationType, type CustomerPortalAccessResponse, type Delivery, type DeliveryLineItem, type DeliveryOrder, type DeliveryPaymentMethod, type Discount, type DiscountType, type DynamicBundleItemAppProxy, type DynamicBundlePropertiesAppProxy, type ExternalAttributeSchema, type ExternalId, type ExternalTransactionId, type FirstOption, type GetAddressOptions, type GetChargeOptions, type GetCreditSummaryOptions, type GetCustomerOptions, type GetMembershipProgramOptions, type GetPaymentMethodOptions, type GetRequestOptions, type GetSubscriptionOptions, type GiftPurchase, type GiftPurchasesParams, type GiftPurchasesResponse, type HTMLString, type InitOptions, type IntervalUnit, type IsoDateString, type LineItem, type ListParams, type LoginResponse, type Membership, type MembershipBenefit, type MembershipIncludes, type MembershipListParams, type MembershipListResponse, type MembershipProgram, type MembershipProgramIncludes, type MembershipProgramListParams, type MembershipProgramListResponse, type MembershipProgramResponse, type MembershipProgramSortBy, type MembershipProgramStatus, type MembershipResponse, type MembershipStatus, type MembershipsSortBy, type MergeAddressesRequest, type Metafield, type MetafieldOptionalCreateProps, type MetafieldOwnerResource, type MetafieldRequiredCreateProps, type Method, type Modifier, type MultiStepSettings, type OnePageSettings, type Onetime, type OnetimeListParams, type OnetimeOptionalCreateProps, type OnetimeRequiredCreateProps, type OnetimesResponse, type OnetimesSortBy, type Order, type OrderIncludes, type OrderListParams, type OrderSortBy, type OrderStatus, type OrderType, type OrdersResponse, type PasswordlessCodeResponse, type PasswordlessOptions, type PasswordlessValidateResponse, type PaymentDetails, type PaymentMethod, type PaymentMethodIncludes, type PaymentMethodListParams, type PaymentMethodOptionalCreateProps, type PaymentMethodRequiredCreateProps, type PaymentMethodSortBy, type PaymentMethodStatus, type PaymentMethodsResponse, type PaymentType, type Plan, type PlanListParams, type PlanSortBy, type PlanType, type PlansResponse, type ProcessorName, type ProductImage, type ProductInclude, type ProductOption, type ProductSearchParams_2020_12, type ProductSearchParams_2022_06, type ProductSearchResponse_2020_12, type ProductSearchResponse_2022_06, type ProductSearchType, type ProductSource, type ProductValueOption, type ProductVariant_2020_12, type ProductVariant_2022_06, type Product_2020_12, type Product_2022_06, type Property, type PublishStatus, type Request, type RequestHeaders, type RequestOptions, type SellingPlan, type SellingPlanGroup, type Session, type ShippingCountriesOptions, type ShippingCountriesResponse, type ShippingCountry, type ShippingLine, type ShippingProvince, type ShopifyUpdatePaymentInfoOptions, type SkipChargeParams, type SkipFutureChargeAddressRequest, type SkipFutureChargeAddressResponse, type SortBy, type SortField, type SortKeys, type StepSettings, type StepSettingsCommon, type StepSettingsTypes, type StorefrontEnvironment, type StorefrontOptions, type StorefrontPurchaseOption, type SubType, type Subscription, type SubscriptionIncludes, type SubscriptionListParams, type SubscriptionOption, type SubscriptionOptionalCreateProps, type SubscriptionPreferences, type SubscriptionRequiredCreateProps, type SubscriptionSortBy, type SubscriptionStatus, type Subscription_2021_01, type SubscriptionsResponse, type TaxLine, type Translations, type UpdateAddressRequest, type UpdateBundlePurchaseItem, type UpdateBundleSelectionRequest, type UpdateCustomerRequest, type UpdateMetafieldRequest, type UpdateOnetimeRequest, type UpdatePaymentMethodRequest, type UpdateSubscriptionParams, type UpdateSubscriptionRequest, type UpdateSubscriptionsParams, type UpdateSubscriptionsRequest, type VariantSelector, type VariantSelectorStepSetting, type WidgetIconColor, type WidgetTemplateType, type WidgetVisibility, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, changeMembership, createAddress, createBundleSelection, createMetafield, createOnetime, createPaymentMethod, createSubscription, createSubscriptions, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, getActiveChurnLandingPageURL, getAddress, getBundleId, getBundleSelection, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCreditSummary, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getGiftPurchase, getGiftRedemptionLandingPageURL, getMembership, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getShippingCountries, getSubscription, initRecharge, type intervalUnit, listAddresses, listBundleSelections, listCharges, listGiftPurchases, listMembershipPrograms, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginCustomerPortal, loginShopifyApi, loginShopifyAppProxy, loginWithShopifyCustomerAccount, loginWithShopifyStorefront, type membershipIncludes, mergeAddresses, processCharge, productSearch, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendCustomerNotification, sendPasswordlessCode, sendPasswordlessCodeAppProxy, skipCharge, skipFutureCharge, skipGiftSubscriptionCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundle, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateSubscriptions, validateBundle, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };
+export { type ActivateMembershipRequest, type AddToCartCallbackSettings, type AddonSettings, type Address, type AddressIncludes, type AddressListParams, type AddressListResponse, type AddressResponse, type AddressSortBy, type AnalyticsData, type AssociatedAddress, type BasicSubscriptionParams, type BooleanLike, type BooleanNumbers, type BooleanString, type BooleanStringNumbers, type BundleAppProxy, type BundlePriceRule, type BundleProduct, type BundleProductLayoutSettings, type BundlePurchaseItem, type BundlePurchaseItemParams, type BundleSelection, type BundleSelectionAppProxy, type BundleSelectionItem, type BundleSelectionItemRequiredCreateProps, type BundleSelectionListParams, type BundleSelectionsResponse, type BundleSelectionsSortBy, type BundleTemplateSettings, type BundleTemplateType, type BundleTranslations, type BundleVariant, type BundleVariantOptionSource, type BundleVariantRange, type BundleVariantSelectionDefault, type CDNBaseWidgetSettings, type CDNBundleSettings, type CDNBundleVariant, type CDNBundleVariantOptionSource, type CDNPlan, type CDNProduct, type CDNProductAndSettings, type CDNProductKeyObject, type CDNProductQuery_2020_12, type CDNProductQuery_2022_06, type CDNProductRaw, type CDNProductResource, type CDNProductResponseType, type CDNProductType, type CDNProductVariant_2022_06, type CDNProduct_2022_06, type CDNProductsAndSettings, type CDNProductsAndSettingsResource, type CDNStoreSettings, type CDNSubscriptionOption, type CDNVariant, type CDNVersion, type CDNWidgetSettings, type CDNWidgetSettingsRaw, type CDNWidgetSettingsResource, type CRUDRequestOptions, type CancelMembershipRequest, type CancelSubscriptionRequest, type ChangeMembershipRequest, type ChannelSettings, type Charge, type ChargeIncludes, type ChargeListParams, type ChargeListResponse, type ChargeResponse, type ChargeSortBy, type ChargeStatus, type Collection, type CollectionListParams, type CollectionTypes, type CollectionsResponse, type CollectionsSortBy, type ColorString, type CreateAddressRequest, type CreateBundleSelectionRequest, type CreateMetafieldRequest, type CreateOnetimeRequest, type CreatePaymentMethodRequest, type CreateRecipientAddress, type CreateSubscriptionRequest, type CreditAccount, type CreditAccountType, type CreditSummaryIncludes, type CrossSellsSettings, type Customer, type CustomerCreditSummary, type CustomerDeliveryScheduleParams, type CustomerDeliveryScheduleResponse, type CustomerIncludes, type CustomerNotification, type CustomerNotificationOptions, type CustomerNotificationTemplate, type CustomerNotificationType, type CustomerPortalAccessResponse, type Delivery, type DeliveryLineItem, type DeliveryOrder, type DeliveryPaymentMethod, type Discount, type DiscountType, type DynamicBundleItemAppProxy, type DynamicBundlePropertiesAppProxy, type ExternalAttributeSchema, type ExternalId, type ExternalTransactionId, type FirstOption, type GetAddressOptions, type GetChargeOptions, type GetCreditSummaryOptions, type GetCustomerOptions, type GetMembershipProgramOptions, type GetPaymentMethodOptions, type GetRequestOptions, type GetSubscriptionOptions, type GiftPurchase, type GiftPurchasesParams, type GiftPurchasesResponse, type HTMLString, type InitOptions, type InternalSession, type IntervalUnit, type IsoDateString, type LineItem, type ListParams, type LoginResponse, type Membership, type MembershipBenefit, type MembershipIncludes, type MembershipListParams, type MembershipListResponse, type MembershipProgram, type MembershipProgramIncludes, type MembershipProgramListParams, type MembershipProgramListResponse, type MembershipProgramResponse, type MembershipProgramSortBy, type MembershipProgramStatus, type MembershipResponse, type MembershipStatus, type MembershipsSortBy, type MergeAddressesRequest, type Metafield, type MetafieldOptionalCreateProps, type MetafieldOwnerResource, type MetafieldRequiredCreateProps, type Method, type Modifier, type MultiStepSettings, type OnePageSettings, type Onetime, type OnetimeListParams, type OnetimeOptionalCreateProps, type OnetimeRequiredCreateProps, type OnetimesResponse, type OnetimesSortBy, type Order, type OrderIncludes, type OrderListParams, type OrderSortBy, type OrderStatus, type OrderType, type OrdersResponse, type PasswordlessCodeResponse, type PasswordlessOptions, type PasswordlessValidateResponse, type PaymentDetails, type PaymentMethod, type PaymentMethodIncludes, type PaymentMethodListParams, type PaymentMethodOptionalCreateProps, type PaymentMethodRequiredCreateProps, type PaymentMethodSortBy, type PaymentMethodStatus, type PaymentMethodsResponse, type PaymentType, type Plan, type PlanListParams, type PlanSortBy, type PlanType, type PlansResponse, type ProcessorName, type ProductImage, type ProductInclude, type ProductListResponse, type ProductOption, type ProductSearchParams_2020_12, type ProductSearchParams_2022_06, type ProductSearchResponse_2020_12, type ProductSearchResponse_2022_06, type ProductSearchType, type ProductSource, type ProductValueOption, type ProductVariant_2020_12, type ProductVariant_2022_06, type Product_2020_12, type Product_2022_06, type Property, type PublishStatus, type Request, type RequestHeaders, type RequestOptions, type SellingPlan, type SellingPlanGroup, type Session, type ShippingCountriesOptions, type ShippingCountriesResponse, type ShippingCountry, type ShippingLine, type ShippingProvince, type ShopifyUpdatePaymentInfoOptions, type SkipChargeParams, type SkipFutureChargeAddressRequest, type SkipFutureChargeAddressResponse, type SortBy, type SortField, type SortKeys, type StepSettings, type StepSettingsCommon, type StepSettingsTypes, type StorefrontEnvironment, type StorefrontOptions, type StorefrontPurchaseOption, type SubType, type Subscription, type SubscriptionIncludes, type SubscriptionListParams, type SubscriptionOption, type SubscriptionOptionalCreateProps, type SubscriptionPreferences, type SubscriptionRequiredCreateProps, type SubscriptionSortBy, type SubscriptionStatus, type Subscription_2021_01, type SubscriptionsResponse, type TaxLine, type Translations, type UpdateAddressRequest, type UpdateBundlePurchaseItem, type UpdateBundleSelectionRequest, type UpdateCustomerRequest, type UpdateMetafieldRequest, type UpdateOnetimeRequest, type UpdatePaymentMethodRequest, type UpdateSubscriptionParams, type UpdateSubscriptionRequest, type UpdateSubscriptionsParams, type UpdateSubscriptionsRequest, type VariantSelector, type VariantSelectorStepSetting, type WidgetIconColor, type WidgetTemplateType, type WidgetVisibility, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, changeMembership, createAddress, createBundleSelection, createMetafield, createOnetime, createPaymentMethod, createSubscription, createSubscriptions, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, getActiveChurnLandingPageURL, getAddress, getBundleId, getBundleSelection, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCollection, getCreditSummary, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getGiftPurchase, getGiftRedemptionLandingPageURL, getMembership, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getShippingCountries, getSubscription, initRecharge, type intervalUnit, listAddresses, listBundleSelections, listCharges, listCollectionProducts, listCollections, listGiftPurchases, listMembershipPrograms, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginCustomerPortal, loginShopifyApi, loginShopifyAppProxy, loginWithShopifyCustomerAccount, loginWithShopifyStorefront, type membershipIncludes, mergeAddresses, processCharge, productSearch, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendCustomerNotification, sendPasswordlessCode, sendPasswordlessCodeAppProxy, skipCharge, skipFutureCharge, skipGiftSubscriptionCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundle, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateSubscriptions, validateBundle, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };