@shopify/shopify-api 9.0.2 → 9.2.0

package/lib/billing/types.d.ts

@@ -2,104 +2,289 @@ import { BillingInterval, BillingReplacementBehavior, RecurringBillingIntervals
 import { Session } from '../session/session';
 import { FeatureEnabled, FutureFlagOptions } from '../../future/flags';
 export interface BillingConfigPlan {
+    /**
+     * Amount to charge for this plan.
+     */
     amount: number;
+    /**
+     * Currency code for this plan.
+     */
     currencyCode: string;
 }
 export interface BillingConfigOneTimePlan extends BillingConfigPlan {
+    /**
+     * Interval for this plan.
+     *
+     * Must be set to `OneTime`.
+     */
     interval: BillingInterval.OneTime;
 }
 export interface BillingConfigSubscriptionPlan extends BillingConfigPlan {
+    /**
+     * Recurring interval for this plan.
+     *
+     * Must be either `Every30Days` or `Annual`.
+     */
     interval: Exclude<RecurringBillingIntervals, BillingInterval.Usage>;
+    /**
+     * How many trial days to give before charging for this plan.
+     */
     trialDays?: number;
+    /**
+     * The behavior to use when replacing an existing subscription with a new one.
+     */
     replacementBehavior?: BillingReplacementBehavior;
+    /**
+     * The discount to apply to this plan.
+     */
     discount?: BillingConfigSubscriptionPlanDiscount;
 }
 export interface BillingConfigSubscriptionPlanDiscountAmount {
+    /**
+     * The amount to discount.
+     *
+     * Cannot be set if `percentage` is set.
+     */
     amount: number;
+    /**
+     * The percentage to discount.
+     *
+     * Cannot be set if `amount` is set.
+     */
     percentage?: never;
 }
 export interface BillingConfigSubscriptionPlanDiscountPercentage {
+    /**
+     * The amount to discount.
+     *
+     * Cannot be set if `percentage` is set.
+     */
     amount?: never;
+    /**
+     * The percentage to discount.
+     *
+     * Cannot be set if `amount` is set.
+     */
     percentage: number;
 }
 export interface BillingConfigSubscriptionPlanDiscount {
+    /**
+     * The number of intervals to apply the discount for.
+     */
     durationLimitInIntervals?: number;
+    /**
+     * The discount to apply.
+     */
     value: BillingConfigSubscriptionPlanDiscountAmount | BillingConfigSubscriptionPlanDiscountPercentage;
 }
 export interface BillingConfigUsagePlan extends BillingConfigPlan {
+    /**
+     * Interval for this plan.
+     *
+     * Must be set to `Usage`.
+     */
     interval: BillingInterval.Usage;
+    /**
+     * Usage terms for this plan.
+     */
     usageTerms: string;
+    /**
+     * How many trial days to give before charging for this plan.
+     */
     trialDays?: number;
+    /**
+     * The behavior to use when replacing an existing subscription with a new one.
+     */
     replacementBehavior?: BillingReplacementBehavior;
 }
 export type BillingConfigLegacyItem = BillingConfigOneTimePlan | BillingConfigSubscriptionPlan | BillingConfigUsagePlan;
-export type BillingConfigItem<Future extends FutureFlagOptions = FutureFlagOptions> = FeatureEnabled<Future, 'unstable_lineItemBilling'> extends true ? BillingConfigOneTimePlan | BillingConfigSubscriptionLineItemPlan : BillingConfigLegacyItem;
-export type BillingConfig<Future extends FutureFlagOptions = FutureFlagOptions> = Record<string, BillingConfigItem<Future>>;
+export type BillingConfigItem<Future extends FutureFlagOptions = FutureFlagOptions> = FeatureEnabled<Future, 'v10_lineItemBilling'> extends true ? BillingConfigOneTimePlan | BillingConfigSubscriptionLineItemPlan : BillingConfigLegacyItem;
+/**
+ * Billing configuration options, indexed by an app-specific plan name.
+ */
+export interface BillingConfig<Future extends FutureFlagOptions = FutureFlagOptions> {
+    /**
+     * An individual billing plan.
+     */
+    [plan: string]: BillingConfigItem<Future>;
+}
 export type RequestConfigOverrides = Partial<BillingConfigOneTimePlan> | Partial<BillingConfigSubscriptionPlan> | Partial<BillingConfigUsagePlan>;
 export interface BillingConfigLineItem {
+    /**
+     * The amount to charge for this line item.
+     */
     amount: number;
+    /**
+     * The currency code for this line item.
+     */
     currencyCode: string;
 }
 export interface BillingConfigRecurringLineItem extends BillingConfigLineItem {
+    /**
+     * The recurring interval for this line item.
+     *
+     * Must be either `Every30Days` or `Annual`.
+     */
     interval: BillingInterval.Every30Days | BillingInterval.Annual;
+    /**
+     * An optional discount to apply for this line item.
+     */
     discount?: BillingConfigSubscriptionPlanDiscount;
 }
 export interface BillingConfigUsageLineItem extends BillingConfigLineItem {
+    /**
+     * The usage interval for this line item.
+     *
+     * Must be set to `Usage`.
+     */
     interval: BillingInterval.Usage;
+    /**
+     * Usage terms for this line item.
+     */
     terms: string;
 }
 export interface BillingConfigSubscriptionLineItemPlan {
+    /**
+     * The replacement behavior to use for this plan.
+     */
     replacementBehavior?: BillingReplacementBehavior;
+    /**
+     * How many trial days to give before charging for this plan.
+     */
     trialDays?: number;
+    /**
+     * The line items for this plan.
+     */
     lineItems: (BillingConfigRecurringLineItem | BillingConfigUsageLineItem)[];
 }
 export type RequestConfigLineItemOverrides = Partial<BillingConfigSubscriptionLineItemPlan>;
 export interface BillingCheckParams {
+    /**
+     * The session to use for this check.
+     */
     session: Session;
+    /**
+     * The plans to accept for this check.
+     */
     plans: string[] | string;
+    /**
+     * Whether to consider test purchases.
+     */
     isTest?: boolean;
+    /**
+     * Whether to return the full response object.
+     */
     returnObject?: boolean;
 }
 export interface BillingCheckResponseObject {
+    /**
+     * Whether the user has an active payment method.
+     */
     hasActivePayment: boolean;
+    /**
+     * The one-time purchases the shop has.
+     */
     oneTimePurchases: OneTimePurchase[];
+    /**
+     * The active subscriptions the shop has.
+     */
     appSubscriptions: AppSubscription[];
 }
 export type BillingCheckResponse<Params extends BillingCheckParams> = Params['returnObject'] extends true ? BillingCheckResponseObject : boolean;
 export type BillingRequestParams = {
+    /**
+     * The session to use for this request.
+     */
     session: Session;
+    /**
+     * The plan to request.
+     */
     plan: string;
+    /**
+     * Whether this is a test purchase.
+     */
     isTest?: boolean;
+    /**
+     * Override the return URL after the purchase is complete.
+     */
     returnUrl?: string;
+    /**
+     * Whether to return the full response object.
+     */
     returnObject?: boolean;
 } & RequestConfigOverrides;
 export interface BillingRequestResponseObject {
+    /**
+     * The confirmation URL for this request.
+     */
     confirmationUrl: string;
+    /**
+     * The one-time purchase created by this request.
+     */
     oneTimePurchase?: OneTimePurchase;
+    /**
+     * The app subscription created by this request.
+     */
     appSubscription?: AppSubscription;
 }
 export type BillingRequestResponse<Params extends BillingRequestParams> = Params['returnObject'] extends true ? BillingRequestResponseObject : string;
 export interface BillingCancelParams {
+    /**
+     * The session to use for this request.
+     */
     session: Session;
+    /**
+     * The subscription ID to cancel.
+     */
     subscriptionId: string;
+    /**
+     * Whether to prorate the cancellation.
+     */
     prorate?: boolean;
+    /**
+     * Whether to consider test purchases.
+     */
     isTest?: boolean;
 }
 export interface BillingSubscriptionParams {
+    /**
+     * The session to use for this request.
+     */
     session: Session;
 }
 export interface AppSubscription {
+    /**
+     * The ID of the app subscription.
+     */
     id: string;
+    /**
+     * The name of the purchased plan.
+     */
     name: string;
+    /**
+     * Whether this is a test subscription.
+     */
     test: boolean;
 }
 export interface ActiveSubscriptions {
     activeSubscriptions: AppSubscription[];
 }
 export interface OneTimePurchase {
+    /**
+     * The ID of the one-time purchase.
+     */
     id: string;
+    /**
+     * The name of the purchased plan.
+     */
     name: string;
+    /**
+     * Whether this is a test purchase.
+     */
     test: boolean;
+    /**
+     * The status of the one-time purchase.
+     */
     status: string;
 }
 interface OneTimePurchases {

package/lib/billing/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,0BAA0B,EAC1B,yBAAyB,EAC1B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAC,cAAc,EAAE,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAErE,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB;IACtE,QAAQ,EAAE,OAAO,CAAC,yBAAyB,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACpE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD,QAAQ,CAAC,EAAE,qCAAqC,CAAC;CAClD;AAED,MAAM,WAAW,2CAA2C;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB;AAED,MAAM,WAAW,+CAA+C;IAC9D,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qCAAqC;IACpD,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,KAAK,EACD,2CAA2C,GAC3C,+CAA+C,CAAC;CACrD;AAED,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB;IAC/D,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;CAClD;AAED,MAAM,MAAM,uBAAuB,GAC/B,wBAAwB,GACxB,6BAA6B,GAC7B,sBAAsB,CAAC;AAE3B,MAAM,MAAM,iBAAiB,CAC3B,MAAM,SAAS,iBAAiB,GAAG,iBAAiB,IAClD,cAAc,CAAC,MAAM,EAAE,0BAA0B,CAAC,SAAS,IAAI,GAC/D,wBAAwB,GAAG,qCAAqC,GAChE,uBAAuB,CAAC;AAE5B,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,iBAAiB,GAAG,iBAAiB,IAClD,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;AAE9C,MAAM,MAAM,sBAAsB,GAC9B,OAAO,CAAC,wBAAwB,CAAC,GACjC,OAAO,CAAC,6BAA6B,CAAC,GACtC,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAEpC,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E,QAAQ,EAAE,eAAe,CAAC,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/D,QAAQ,CAAC,EAAE,qCAAqC,CAAC;CAClD;AAED,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qCAAqC;IACpD,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,CAAC,8BAA8B,GAAG,0BAA0B,CAAC,EAAE,CAAC;CAC5E;AAED,MAAM,MAAM,8BAA8B,GACxC,OAAO,CAAC,qCAAqC,CAAC,CAAC;AAEjD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC,gBAAgB,EAAE,eAAe,EAAE,CAAC;CACrC;AAED,MAAM,MAAM,oBAAoB,CAAC,MAAM,SAAS,kBAAkB,IAChE,MAAM,CAAC,cAAc,CAAC,SAAS,IAAI,GAAG,0BAA0B,GAAG,OAAO,CAAC;AAE7E,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,sBAAsB,CAAC;AAE3B,MAAM,WAAW,4BAA4B;IAC3C,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,oBAAoB,IACpE,MAAM,CAAC,cAAc,CAAC,SAAS,IAAI,GAAG,4BAA4B,GAAG,MAAM,CAAC;AAE9E,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,EAAE,eAAe,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,gBAAgB;IACxB,gBAAgB,EAAE;QAChB,KAAK,EAAE;YACL,IAAI,EAAE,eAAe,CAAC;SACvB,EAAE,CAAC;QACJ,QAAQ,EAAE;YACR,SAAS,EAAE,MAAM,CAAC;YAClB,WAAW,EAAE,OAAO,CAAC;SACtB,CAAC;KACH,CAAC;CACH;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;AAE5E,MAAM,WAAW,uBAAuB;IACtC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,UAAU,qBAAqB;IAC7B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED,UAAU,wBAAwB;IAChC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED,MAAM,WAAW,wBAAwB;IACvC,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;CAC/C;AAED,MAAM,WAAW,qBAAqB;IACpC,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACrD;AAED,MAAM,MAAM,mBAAmB,GAC3B,qBAAqB,GACrB,wBAAwB,CAAC;AAE7B,MAAM,WAAW,oBAAoB;IACnC,sBAAsB,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC7B,qBAAqB,CAAC,EAAE;QACtB,eAAe,EAAE,eAAe,CAAC;QACjC,UAAU,EAAE,MAAM,EAAE,CAAC;KACtB,CAAC;CACH"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,0BAA0B,EAC1B,yBAAyB,EAC1B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAC,cAAc,EAAE,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AAErE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE;;;;OAIG;IACH,QAAQ,EAAE,eAAe,CAAC,OAAO,CAAC;CACnC;AAED,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB;IACtE;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC,yBAAyB,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACpE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,qCAAqC,CAAC;CAClD;AAED,MAAM,WAAW,2CAA2C;IAC1D;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB;AAED,MAAM,WAAW,+CAA+C;IAC9D;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;OAEG;IACH,KAAK,EACD,2CAA2C,GAC3C,+CAA+C,CAAC;CACrD;AAED,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB;IAC/D;;;;OAIG;IACH,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;CAClD;AAED,MAAM,MAAM,uBAAuB,GAC/B,wBAAwB,GACxB,6BAA6B,GAC7B,sBAAsB,CAAC;AAE3B,MAAM,MAAM,iBAAiB,CAC3B,MAAM,SAAS,iBAAiB,GAAG,iBAAiB,IAClD,cAAc,CAAC,MAAM,EAAE,qBAAqB,CAAC,SAAS,IAAI,GAC1D,wBAAwB,GAAG,qCAAqC,GAChE,uBAAuB,CAAC;AAI5B;;GAEG;AACH,MAAM,WAAW,aAAa,CAC5B,MAAM,SAAS,iBAAiB,GAAG,iBAAiB;IAEpD;;OAEG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;CAC3C;AAGD,MAAM,MAAM,sBAAsB,GAC9B,OAAO,CAAC,wBAAwB,CAAC,GACjC,OAAO,CAAC,6BAA6B,CAAC,GACtC,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAEpC,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E;;;;OAIG;IACH,QAAQ,EAAE,eAAe,CAAC,WAAW,GAAG,eAAe,CAAC,MAAM,CAAC;IAC/D;;OAEG;IACH,QAAQ,CAAC,EAAE,qCAAqC,CAAC;CAClD;AAED,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE;;;;OAIG;IACH,QAAQ,EAAE,eAAe,CAAC,KAAK,CAAC;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,CAAC,8BAA8B,GAAG,0BAA0B,CAAC,EAAE,CAAC;CAC5E;AAED,MAAM,MAAM,8BAA8B,GACxC,OAAO,CAAC,qCAAqC,CAAC,CAAC;AAEjD,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC;;OAEG;IACH,gBAAgB,EAAE,eAAe,EAAE,CAAC;CACrC;AAED,MAAM,MAAM,oBAAoB,CAAC,MAAM,SAAS,kBAAkB,IAChE,MAAM,CAAC,cAAc,CAAC,SAAS,IAAI,GAAG,0BAA0B,GAAG,OAAO,CAAC;AAE7E,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GAAG,sBAAsB,CAAC;AAE3B,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,oBAAoB,IACpE,MAAM,CAAC,cAAc,CAAC,SAAS,IAAI,GAAG,4BAA4B,GAAG,MAAM,CAAC;AAE9E,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,mBAAmB,EAAE,eAAe,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,gBAAgB;IACxB,gBAAgB,EAAE;QAChB,KAAK,EAAE;YACL,IAAI,EAAE,eAAe,CAAC;SACvB,EAAE,CAAC;QACJ,QAAQ,EAAE;YACR,SAAS,EAAE,MAAM,CAAC;YAClB,WAAW,EAAE,OAAO,CAAC;SACtB,CAAC;KACH,CAAC;CACH;AAED,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,GAAG,mBAAmB,CAAC;AAE5E,MAAM,WAAW,uBAAuB;IACtC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;CACjD;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,UAAU,qBAAqB;IAC7B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED,UAAU,wBAAwB;IAChC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;CAClC;AAED,MAAM,WAAW,wBAAwB;IACvC,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;CAC/C;AAED,MAAM,WAAW,qBAAqB;IACpC,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACrD;AAED,MAAM,MAAM,mBAAmB,GAC3B,qBAAqB,GACrB,wBAAwB,CAAC;AAE7B,MAAM,WAAW,oBAAoB;IACnC,sBAAsB,CAAC,EAAE,mBAAmB,CAAC;CAC9C;AAED,MAAM,WAAW,cAAc;IAC7B,qBAAqB,CAAC,EAAE;QACtB,eAAe,EAAE,eAAe,CAAC;QACjC,UAAU,EAAE,MAAM,EAAE,CAAC;KACtB,CAAC;CACH"}

package/lib/clients/common.d.ts

@@ -1,7 +1,7 @@
+/// <reference types="@cloudflare/workers-types" />
 import { LogContent } from '@shopify/admin-api-client';
 import { ConfigInterface } from '../base-types';
-import { AbstractFetchFunc } from '../../runtime';
 export declare function getUserAgent(config: ConfigInterface): string;
 export declare function clientLoggerFactory(config: ConfigInterface): (logContent: LogContent) => void;
-export declare function throwFailedRequest(body: any, response: Awaited<ReturnType<AbstractFetchFunc>>, atMaxRetries: boolean): never;
+export declare function throwFailedRequest(body: any, response: Response, atMaxRetries: boolean): never;
 //# sourceMappingURL=common.d.ts.map

package/lib/clients/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["common.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EACX,MAAM,2BAA2B,CAAC;AAKnC,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAE9C,OAAO,EACL,iBAAiB,EAIlB,MAAM,eAAe,CAAC;AAGvB,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM,CAO5D;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,eAAe,gBACrC,UAAU,UA4B/B;AAED,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,GAAG,EACT,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,EAChD,YAAY,EAAE,OAAO,GACpB,KAAK,CAyEP"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["common.ts"],"names":[],"mappings":";AAAA,OAAO,EAGL,UAAU,EACX,MAAM,2BAA2B,CAAC;AAKnC,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAS9C,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM,CAO5D;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,eAAe,gBACrC,UAAU,UA4B/B;AAED,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,GAAG,EACT,QAAQ,EAAE,QAAQ,EAClB,YAAY,EAAE,OAAO,GACpB,KAAK,CAyEP"}

package/lib/clients/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["common.ts"],"names":[],"mappings":";;;;AAKA,8CAA4C;AAE5C,gEAA0C;AAC1C,oCAAsC;AAEtC,wCAAuD;AACvD,2CAKuB;AACvB,sCAAiC;AAEjC,SAAgB,YAAY,CAAC,MAAuB;IAClD,IAAI,eAAe,GAAG,GAAG,oBAAY,KAAK,qCAA2B,MAAM,IAAA,+BAAqB,GAAE,EAAE,CAAC;IACrG,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,eAAe,GAAG,GAAG,MAAM,CAAC,eAAe,MAAM,eAAe,EAAE,CAAC;IACrE,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAPD,oCAOC;AAED,SAAgB,mBAAmB,CAAC,MAAuB;IACzD,OAAO,CAAC,UAAsB,EAAE,EAAE;QAChC,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YAC/B,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;gBACxB,KAAK,eAAe,CAAC,CAAC,CAAC;oBACrB,MAAM,WAAW,GAA+B,UAAU,CAAC,OAAO,CAAC;oBACnE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,KAAK,CAAC,oCAAoC,EAAE;wBACzD,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;wBACxD,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC;qBAC/C,CAAC,CAAC;oBACH,MAAM;gBACR,CAAC;gBACD,KAAK,YAAY,CAAC,CAAC,CAAC;oBAClB,MAAM,WAAW,GAA4B,UAAU,CAAC,OAAO,CAAC;oBAChE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,KAAK,CAAC,uBAAuB,EAAE;wBAC5C,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;wBACxD,YAAY,EAAE,WAAW,CAAC,YAAY;wBACtC,UAAU,EAAE,WAAW,CAAC,UAAU;wBAClC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;qBACnD,CAAC,CAAC;oBACH,MAAM;gBACR,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACR,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,KAAK,CAAC,uBAAuB,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClE,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AA7BD,kDA6BC;AAED,SAAgB,kBAAkB,CAChC,IAAS,EACT,QAAgD,EAChD,YAAqB;;IAErB,MAAM,eAAe,GAAG,IAAA,6BAAmB,EACzC,MAAM,CAAC,WAAW,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,mCAAI,EAAE,CAAC,CACrD,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,oBAAU,CAAC,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QACnE,MAAM,IAAI,aAAa,CAAC,iBAAiB,CAAC;YACxC,OAAO,EACL,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,aAAa,0CAAG,CAAC,EAAE,OAAO,mCAAI,0BAA0B;YACtE,QAAQ,EAAE,QAA+B;YACzC,OAAO,EAAE,eAAe;YACxB,IAAI,EAAE,IAA2B;SAClC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,UAAU,GAAG,IAAA,mBAAS,EAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IAC9D,IAAI,UAAU,EAAE,CAAC;QACf,aAAa,CAAC,IAAI,CAChB,qDAAqD,UAAU,EAAE,CAClE,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM;QACvC,CAAC,CAAC,MAAM,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QAClC,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC7B,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IAEvC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ,CAAC,MAAM,KAAK,oBAAU,CAAC,eAAe,CAAC,CAAC,CAAC;YACpD,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,aAAa,CAAC,mBAAmB,CACzC,2DAA2D,CAC5D,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,UAAU,GAAG,IAAA,mBAAS,EAAC,eAAe,EAAE,aAAa,CAAC,CAAC;gBAC7D,MAAM,IAAI,aAAa,CAAC,mBAAmB,CAAC;oBAC1C,OAAO,EAAE,kCAAkC,YAAY,EAAE;oBACzD,IAAI;oBACJ,UAAU;oBACV,IAAI;oBACJ,OAAO,EAAE,eAAe;oBACxB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;iBAC5D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,KAAK,QAAQ,CAAC,MAAM,IAAI,oBAAU,CAAC,mBAAmB;YACpD,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,aAAa,CAAC,mBAAmB,CACzC,2DAA2D,CAC5D,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,aAAa,CAAC,iBAAiB,CAAC;oBACxC,OAAO,EAAE,yBAAyB,YAAY,EAAE;oBAChD,IAAI;oBACJ,UAAU;oBACV,IAAI;oBACJ,OAAO,EAAE,eAAe;iBACzB,CAAC,CAAC;YACL,CAAC;QACH;YACE,MAAM,IAAI,aAAa,CAAC,iBAAiB,CAAC;gBACxC,OAAO,EAAE,+BAA+B,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,iBAAiB,YAAY,EAAE;gBAC7G,IAAI;gBACJ,UAAU;gBACV,IAAI;gBACJ,OAAO,EAAE,eAAe;aACzB,CAAC,CAAC;IACP,CAAC;AACH,CAAC;AA7ED,gDA6EC"}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["common.ts"],"names":[],"mappings":";;;;AAKA,8CAA4C;AAE5C,gEAA0C;AAC1C,oCAAsC;AAEtC,wCAAuD;AACvD,2CAIuB;AACvB,sCAAiC;AAEjC,SAAgB,YAAY,CAAC,MAAuB;IAClD,IAAI,eAAe,GAAG,GAAG,oBAAY,KAAK,qCAA2B,MAAM,IAAA,+BAAqB,GAAE,EAAE,CAAC;IACrG,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,eAAe,GAAG,GAAG,MAAM,CAAC,eAAe,MAAM,eAAe,EAAE,CAAC;IACrE,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAPD,oCAOC;AAED,SAAgB,mBAAmB,CAAC,MAAuB;IACzD,OAAO,CAAC,UAAsB,EAAE,EAAE;QAChC,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YAC/B,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;gBACxB,KAAK,eAAe,CAAC,CAAC,CAAC;oBACrB,MAAM,WAAW,GAA+B,UAAU,CAAC,OAAO,CAAC;oBACnE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,KAAK,CAAC,oCAAoC,EAAE;wBACzD,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;wBACxD,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC;qBAC/C,CAAC,CAAC;oBACH,MAAM;gBACR,CAAC;gBACD,KAAK,YAAY,CAAC,CAAC,CAAC;oBAClB,MAAM,WAAW,GAA4B,UAAU,CAAC,OAAO,CAAC;oBAChE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,KAAK,CAAC,uBAAuB,EAAE;wBAC5C,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;wBACxD,YAAY,EAAE,WAAW,CAAC,YAAY;wBACtC,UAAU,EAAE,WAAW,CAAC,UAAU;wBAClC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;qBACnD,CAAC,CAAC;oBACH,MAAM;gBACR,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACR,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,KAAK,CAAC,uBAAuB,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;oBAClE,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AA7BD,kDA6BC;AAED,SAAgB,kBAAkB,CAChC,IAAS,EACT,QAAkB,EAClB,YAAqB;;IAErB,MAAM,eAAe,GAAG,IAAA,6BAAmB,EACzC,MAAM,CAAC,WAAW,CAAC,MAAA,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,mCAAI,EAAE,CAAC,CACrD,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,oBAAU,CAAC,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QACnE,MAAM,IAAI,aAAa,CAAC,iBAAiB,CAAC;YACxC,OAAO,EACL,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,aAAa,0CAAG,CAAC,EAAE,OAAO,mCAAI,0BAA0B;YACtE,QAAQ,EAAE,QAA+B;YACzC,OAAO,EAAE,eAAe;YACxB,IAAI,EAAE,IAA2B;SAClC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,UAAU,GAAG,IAAA,mBAAS,EAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IAC9D,IAAI,UAAU,EAAE,CAAC;QACf,aAAa,CAAC,IAAI,CAChB,qDAAqD,UAAU,EAAE,CAClE,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM;QACvC,CAAC,CAAC,MAAM,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QAClC,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC7B,MAAM,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IAEvC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ,CAAC,MAAM,KAAK,oBAAU,CAAC,eAAe,CAAC,CAAC,CAAC;YACpD,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,aAAa,CAAC,mBAAmB,CACzC,2DAA2D,CAC5D,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,UAAU,GAAG,IAAA,mBAAS,EAAC,eAAe,EAAE,aAAa,CAAC,CAAC;gBAC7D,MAAM,IAAI,aAAa,CAAC,mBAAmB,CAAC;oBAC1C,OAAO,EAAE,kCAAkC,YAAY,EAAE;oBACzD,IAAI;oBACJ,UAAU;oBACV,IAAI;oBACJ,OAAO,EAAE,eAAe;oBACxB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;iBAC5D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,KAAK,QAAQ,CAAC,MAAM,IAAI,oBAAU,CAAC,mBAAmB;YACpD,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,aAAa,CAAC,mBAAmB,CACzC,2DAA2D,CAC5D,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,aAAa,CAAC,iBAAiB,CAAC;oBACxC,OAAO,EAAE,yBAAyB,YAAY,EAAE;oBAChD,IAAI;oBACJ,UAAU;oBACV,IAAI;oBACJ,OAAO,EAAE,eAAe;iBACzB,CAAC,CAAC;YACL,CAAC;QACH;YACE,MAAM,IAAI,aAAa,CAAC,iBAAiB,CAAC;gBACxC,OAAO,EAAE,+BAA+B,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,iBAAiB,YAAY,EAAE;gBAC7G,IAAI;gBACJ,UAAU;gBACV,IAAI;gBACJ,OAAO,EAAE,eAAe;aACzB,CAAC,CAAC;IACP,CAAC;AACH,CAAC;AA7ED,gDA6EC"}

package/lib/clients/types.d.ts

@@ -14,6 +14,9 @@ export interface ClientArgs {
     apiVersion?: ApiVersion;
     retries?: number;
 }
+/**
+ * Headers to be sent with the request.
+ */
 export type HeaderParams = Record<string, string | number | string[]>;
 export declare enum DataType {
     JSON = "application/json",
@@ -21,11 +24,29 @@ export declare enum DataType {
     URLEncoded = "application/x-www-form-urlencoded"
 }
 export interface GetRequestParams {
+    /**
+     * The path to the resource, relative to the API version root.
+     */
     path: string;
+    /**
+     * The type of data expected in the response.
+     */
     type?: DataType;
+    /**
+     * The request body.
+     */
     data?: Record<string, any> | string;
+    /**
+     * Query parameters to be sent with the request.
+     */
     query?: SearchParams;
+    /**
+     * Additional headers to be sent with the request.
+     */
     extraHeaders?: HeaderParams;
+    /**
+     * The maximum number of times the request can be made if it fails with a throttling or server error.
+     */
     tries?: number;
 }
 export type PostRequestParams = GetRequestParams & {
@@ -37,7 +58,13 @@ export type RequestParams = (GetRequestParams | PostRequestParams) & {
     method: Method;
 };
 export interface RequestReturn<T = unknown> {
+    /**
+     * The response body.
+     */
     body: T;
+    /**
+     * The response headers.
+     */
     headers: Headers;
 }
 export type GraphqlParams = Omit<PostRequestParams, 'path' | 'type'>;
@@ -46,10 +73,20 @@ export interface GraphqlClientParams {
     apiVersion?: ApiVersion;
 }
 export interface GraphqlQueryOptions<Operation extends keyof Operations, Operations extends AllOperations> {
+    /**
+     * The variables to include in the operation.
+     */
     variables?: ApiClientRequestOptions<Operation, Operations>['variables'];
+    /**
+     * Additional headers to be sent with the request.
+     */
     headers?: Record<string, string | number>;
+    /**
+     * The maximum number of times to retry the request if it fails with a throttling or server error.
+     */
     retries?: number;
 }
+export { GraphqlClient } from './admin/graphql/client';
 export interface ShopifyClients {
     Rest: typeof RestClient;
     Graphql: typeof GraphqlClient;

package/lib/clients/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,YAAY,EACb,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAC3C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAE/C,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AAEtC,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;AAGtE,oBAAY,QAAQ;IAClB,IAAI,qBAAqB;IACzB,OAAO,wBAAwB;IAC/B,UAAU,sCAAsC;CACjD;AAGD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;IACpC,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,GAAG;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC,IAAI,EAAE,CAAC,CAAC;IACR,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB,CAClC,SAAS,SAAS,MAAM,UAAU,EAClC,UAAU,SAAS,aAAa;IAEhC,SAAS,CAAC,EAAE,uBAAuB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,UAAU,CAAC;IACxB,OAAO,EAAE,OAAO,aAAa,CAAC;IAC9B,UAAU,EAAE,OAAO,gBAAgB,CAAC;IACpC,YAAY,EAAE,YAAY,CAAC;CAC5B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,uBAAuB,EACvB,YAAY,EACb,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAC3C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAC,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAC,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAE/C,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AAEtC,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;AAGtE,oBAAY,QAAQ;IAClB,IAAI,qBAAqB;IACzB,OAAO,wBAAwB;IAC/B,UAAU,sCAAsC;CACjD;AAGD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,iBAAiB,GAAG,gBAAgB,GAAG;IACjD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAEjD,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,GAAG;IACnE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,OAAO;IACxC;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC;IACR;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB,CAClC,SAAS,SAAS,MAAM,UAAU,EAClC,UAAU,SAAS,aAAa;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC;IACxE;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,OAAO,EAAC,aAAa,EAAC,MAAM,wBAAwB,CAAC;AAErD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,UAAU,CAAC;IACxB,OAAO,EAAE,OAAO,aAAa,CAAC;IAC9B,UAAU,EAAE,OAAO,gBAAgB,CAAC;IACpC,YAAY,EAAE,YAAY,CAAC;CAC5B"}

package/lib/clients/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataType = void 0;
+exports.GraphqlClient = exports.DataType = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./admin/types"), exports);
 tslib_1.__exportStar(require("./graphql_proxy/types"), exports);
@@ -11,4 +11,6 @@ var DataType;
     DataType["GraphQL"] = "application/graphql";
     DataType["URLEncoded"] = "application/x-www-form-urlencoded";
 })(DataType || (exports.DataType = DataType = {}));
+var client_1 = require("./admin/graphql/client");
+Object.defineProperty(exports, "GraphqlClient", { enumerable: true, get: function () { return client_1.GraphqlClient; } });
 //# sourceMappingURL=types.js.map

package/lib/clients/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":";;;;AAgBA,wDAA8B;AAC9B,gEAAsC;AAUtC,iEAAiE;AACjE,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2CAA+B,CAAA;IAC/B,4DAAgD,CAAA;AAClD,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":";;;;AAgBA,wDAA8B;AAC9B,gEAAsC;AAatC,iEAAiE;AACjE,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2CAA+B,CAAA;IAC/B,4DAAgD,CAAA;AAClD,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AA8ED,iDAAqD;AAA7C,uGAAA,aAAa,OAAA"}

package/lib/flow/index.d.ts

@@ -0,0 +1,6 @@
+import { ConfigInterface } from '../base-types';
+export declare function shopifyFlow(config: ConfigInterface): {
+    validate: ({ rawBody, ...adapterArgs }: import("./types").FlowValidateParams) => Promise<import("./types").FlowValidationInvalid | import("./types").FlowValidationValid>;
+};
+export type ShopifyFlow = ReturnType<typeof shopifyFlow>;
+//# sourceMappingURL=index.d.ts.map

package/lib/flow/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAI9C,wBAAgB,WAAW,CAAC,MAAM,EAAE,eAAe;;EAIlD;AAED,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC"}

package/lib/flow/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shopifyFlow = void 0;
+const validate_1 = require("./validate");
+function shopifyFlow(config) {
+    return {
+        validate: (0, validate_1.validateFactory)(config),
+    };
+}
+exports.shopifyFlow = shopifyFlow;
+//# sourceMappingURL=index.js.map

package/lib/flow/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAEA,yCAA2C;AAE3C,SAAgB,WAAW,CAAC,MAAuB;IACjD,OAAO;QACL,QAAQ,EAAE,IAAA,0BAAe,EAAC,MAAM,CAAC;KAClC,CAAC;AACJ,CAAC;AAJD,kCAIC"}

package/lib/flow/types.d.ts

@@ -0,0 +1,29 @@
+import { AdapterArgs } from '../../runtime/types';
+export interface FlowValidateParams extends AdapterArgs {
+    /**
+     * The raw body of the request.
+     */
+    rawBody: string;
+}
+export declare enum FlowValidationErrorReason {
+    MissingBody = "missing_body",
+    MissingHmac = "missing_hmac",
+    InvalidHmac = "invalid_hmac"
+}
+export interface FlowValidationInvalid {
+    /**
+     * Whether the request is a valid Flow request from Shopify.
+     */
+    valid: false;
+    /**
+     * The reason why the request is not valid.
+     */
+    reason: FlowValidationErrorReason;
+}
+export interface FlowValidationValid {
+    /**
+     * Whether the request is a valid Flow request from Shopify.
+     */
+    valid: true;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/flow/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAEhD,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,yBAAyB;IACnC,WAAW,iBAAiB;IAC5B,WAAW,iBAAiB;IAC5B,WAAW,iBAAiB;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,yBAAyB,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,IAAI,CAAC;CACb"}

package/lib/flow/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlowValidationErrorReason = void 0;
+var FlowValidationErrorReason;
+(function (FlowValidationErrorReason) {
+    FlowValidationErrorReason["MissingBody"] = "missing_body";
+    FlowValidationErrorReason["MissingHmac"] = "missing_hmac";
+    FlowValidationErrorReason["InvalidHmac"] = "invalid_hmac";
+})(FlowValidationErrorReason || (exports.FlowValidationErrorReason = FlowValidationErrorReason = {}));
+//# sourceMappingURL=types.js.map

package/lib/flow/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":";;;AASA,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,yDAA4B,CAAA;IAC5B,yDAA4B,CAAA;IAC5B,yDAA4B,CAAA;AAC9B,CAAC,EAJW,yBAAyB,yCAAzB,yBAAyB,QAIpC"}

package/lib/flow/validate.d.ts

@@ -0,0 +1,4 @@
+import { ConfigInterface } from '../base-types';
+import { FlowValidateParams, FlowValidationInvalid, FlowValidationValid } from './types';
+export declare function validateFactory(config: ConfigInterface): ({ rawBody, ...adapterArgs }: FlowValidateParams) => Promise<FlowValidationInvalid | FlowValidationValid>;
+//# sourceMappingURL=validate.d.ts.map

package/lib/flow/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["validate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AAK9C,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,SAAS,CAAC;AAEjB,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,iCAIlD,kBAAkB,KAAG,QAAQ,qBAAqB,GAAG,mBAAmB,CAAC,CAmB7E"}

package/lib/flow/validate.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFactory = void 0;
+const tslib_1 = require("tslib");
+const http_1 = require("../../runtime/http");
+const types_1 = require("../../runtime/crypto/types");
+const logger_1 = require("../logger");
+const types_2 = require("../types");
+const hmac_validator_1 = require("../utils/hmac-validator");
+const types_3 = require("./types");
+function validateFactory(config) {
+    return function validate(_a) {
+        var { rawBody } = _a, adapterArgs = tslib_1.__rest(_a, ["rawBody"]);
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const request = yield (0, http_1.abstractConvertRequest)(adapterArgs);
+            if (!rawBody.length) {
+                return fail(types_3.FlowValidationErrorReason.MissingBody, config);
+            }
+            const hmac = (0, http_1.getHeader)(request.headers, types_2.ShopifyHeader.Hmac);
+            if (!hmac) {
+                return fail(types_3.FlowValidationErrorReason.MissingHmac, config);
+            }
+            if (yield (0, hmac_validator_1.validateHmacString)(config, rawBody, hmac, types_1.HashFormat.Base64)) {
+                return succeed(config);
+            }
+            return fail(types_3.FlowValidationErrorReason.InvalidHmac, config);
+        });
+    };
+}
+exports.validateFactory = validateFactory;
+function fail(reason, config) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const log = (0, logger_1.logger)(config);
+        yield log.debug('Flow request is not valid', { reason });
+        return {
+            valid: false,
+            reason,
+        };
+    });
+}
+function succeed(config) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const log = (0, logger_1.logger)(config);
+        yield log.debug('Flow request is valid');
+        return {
+            valid: true,
+        };
+    });
+}
+//# sourceMappingURL=validate.js.map

package/lib/flow/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["validate.ts"],"names":[],"mappings":";;;;AAAA,6CAAqE;AACrE,sDAAsD;AAEtD,sCAAiC;AACjC,oCAAuC;AACvC,4DAA2D;AAE3D,mCAKiB;AAEjB,SAAgB,eAAe,CAAC,MAAuB;IACrD,OAAO,SAAe,QAAQ,CAAC,EAGV;YAHU,EAC7B,OAAO,OAEY,EADhB,WAAW,sBAFe,WAG9B,CADe;;YAEd,MAAM,OAAO,GAAG,MAAM,IAAA,6BAAsB,EAAC,WAAW,CAAC,CAAC;YAE1D,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBACpB,OAAO,IAAI,CAAC,iCAAyB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAC7D,CAAC;YAED,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,OAAO,CAAC,OAAO,EAAE,qBAAa,CAAC,IAAI,CAAC,CAAC;YAE5D,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,OAAO,IAAI,CAAC,iCAAyB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAC7D,CAAC;YAED,IAAI,MAAM,IAAA,mCAAkB,EAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;YAED,OAAO,IAAI,CAAC,iCAAyB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;;KAC5D,CAAC;AACJ,CAAC;AAvBD,0CAuBC;AAED,SAAe,IAAI,CACjB,MAAiC,EACjC,MAAuB;;QAEvB,MAAM,GAAG,GAAG,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,GAAG,CAAC,KAAK,CAAC,2BAA2B,EAAE,EAAC,MAAM,EAAC,CAAC,CAAC;QAEvD,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,MAAM;SACP,CAAC;IACJ,CAAC;CAAA;AAED,SAAe,OAAO,CAAC,MAAuB;;QAC5C,MAAM,GAAG,GAAG,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,GAAG,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAEzC,OAAO;YACL,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;CAAA"}

package/lib/index.d.ts

@@ -8,6 +8,7 @@ import { ShopifyUtils } from './utils';
 import { ShopifyWebhooks } from './webhooks';
 import { ShopifyBilling } from './billing';
 import { ShopifyLogger } from './logger';
+import { ShopifyFlow } from './flow';
 export * from './error';
 export * from './session/classes';
 export * from '../rest/types';
@@ -18,16 +19,18 @@ export * from './billing/types';
 export * from './clients/types';
 export * from './session/types';
 export * from './webhooks/types';
-export interface Shopify<Params extends ConfigParams = ConfigParams, Resources extends ShopifyRestResources = ShopifyRestResources, Future extends FutureFlagOptions = FutureFlagOptions> {
+export * from './flow/types';
+export interface Shopify<Params extends ConfigParams = ConfigParams, Resources extends ShopifyRestResources = ShopifyRestResources, _Future extends FutureFlagOptions = FutureFlagOptions> {
     config: ConfigInterface<Params>;
     clients: ShopifyClients;
-    auth: ShopifyAuth<Future>;
+    auth: ShopifyAuth;
     session: ShopifySession;
     utils: ShopifyUtils;
     webhooks: ShopifyWebhooks;
     billing: ShopifyBilling;
     logger: ShopifyLogger;
     rest: Resources;
+    flow: ShopifyFlow;
 }
 export declare function shopifyApi<Params extends ConfigParams<Resources, Future>, Resources extends ShopifyRestResources, Future extends FutureFlagOptions>({ future, restResources, ...config }: {
     future?: Future;

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,oBAAoB,EAAC,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAC,YAAY,EAAE,eAAe,EAAC,MAAM,cAAc,CAAC;AAE3D,OAAO,EAAgB,cAAc,EAAC,MAAM,WAAW,CAAC;AACxD,OAAO,EAAc,WAAW,EAAC,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAiB,cAAc,EAAC,MAAM,WAAW,CAAC;AACzD,OAAO,EAAe,YAAY,EAAC,MAAM,SAAS,CAAC;AACnD,OAAO,EAAkB,eAAe,EAAC,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAiB,cAAc,EAAC,MAAM,WAAW,CAAC;AACzD,OAAO,EAAS,aAAa,EAAC,MAAM,UAAU,CAAC;AAI/C,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAElC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AAEjC,MAAM,WAAW,OAAO,CACtB,MAAM,SAAS,YAAY,GAAG,YAAY,EAC1C,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,MAAM,SAAS,iBAAiB,GAAG,iBAAiB;IAEpD,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAChC,OAAO,EAAE,cAAc,CAAC;IACxB,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC1B,OAAO,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,EAAE,eAAe,CAAC;IAC1B,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,wBAAgB,UAAU,CACxB,MAAM,SAAS,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,EAC9C,SAAS,SAAS,oBAAoB,EACtC,MAAM,SAAS,iBAAiB,EAChC,EACA,MAAM,EACN,aAAa,EACb,GAAG,MAAM,EACV,EAAE;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,SAAS,CAAA;CAAC,GAAG,MAAM,GAAG,OAAO,CAChE,MAAM,EACN,SAAS,EACT,MAAM,CACP,CA+BA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,oBAAoB,EAAC,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAC,YAAY,EAAE,eAAe,EAAC,MAAM,cAAc,CAAC;AAE3D,OAAO,EAAgB,cAAc,EAAC,MAAM,WAAW,CAAC;AACxD,OAAO,EAAc,WAAW,EAAC,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAiB,cAAc,EAAC,MAAM,WAAW,CAAC;AACzD,OAAO,EAAe,YAAY,EAAC,MAAM,SAAS,CAAC;AACnD,OAAO,EAAkB,eAAe,EAAC,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAiB,cAAc,EAAC,MAAM,WAAW,CAAC;AACzD,OAAO,EAAS,aAAa,EAAC,MAAM,UAAU,CAAC;AAG/C,OAAO,EAAC,WAAW,EAAc,MAAM,QAAQ,CAAC;AAEhD,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAElC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAE7B,MAAM,WAAW,OAAO,CACtB,MAAM,SAAS,YAAY,GAAG,YAAY,EAC1C,SAAS,SAAS,oBAAoB,GAAG,oBAAoB,EAC7D,OAAO,SAAS,iBAAiB,GAAG,iBAAiB;IAErD,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;IAChC,OAAO,EAAE,cAAc,CAAC;IACxB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,EAAE,eAAe,CAAC;IAC1B,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;CACnB;AAED,wBAAgB,UAAU,CACxB,MAAM,SAAS,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,EAC9C,SAAS,SAAS,oBAAoB,EACtC,MAAM,SAAS,iBAAiB,EAChC,EACA,MAAM,EACN,aAAa,EACb,GAAG,MAAM,EACV,EAAE;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,SAAS,CAAA;CAAC,GAAG,MAAM,GAAG,OAAO,CAChE,MAAM,EACN,SAAS,EACT,MAAM,CACP,CAgCA"}