@rechargeapps/storefront-client 0.27.0 → 0.29.0

package/dist/index.d.ts

@@ -121,6 +121,10 @@ interface AnalyticsData {
 /** preferred values are 'day', 'week', 'month' other values are available for backwards compatibility */
 declare type IntervalUnit = 'day' | 'week' | 'month' | 'days' | 'Days' | 'weeks' | 'Weeks' | 'months' | 'Months';
 declare type SubType<T, TRequired extends keyof T = keyof T, TOptional extends keyof T = keyof T> = Required<Pick<T, TRequired>> & Partial<Pick<T, TOptional>>;
+declare type BooleanString = 'true' | 'false';
+declare type BooleanNumbers = 0 | 1;
+declare type BooleanStringNumbers = '0' | '1';
+declare type BooleanLike = boolean | BooleanNumbers | BooleanStringNumbers | BooleanString;
 
 declare type MetafieldOwnerResource = 'customer' | 'subscription' | 'order' | 'charge';
 interface Metafield {
@@ -374,15 +378,69 @@ declare type SubscriptionUpdateProps = {
     use_external_variant_defaults?: boolean;
 };
 declare type UpdateSubscriptionRequest = Partial<Pick<Subscription, SubscriptionOptionalUpdateProps>> & SubscriptionUpdateProps;
-interface UpdateSubscriptionParams {
+interface BasicSubscriptionParams {
     /** Controls whether the QUEUED charges linked to the subscription should be regenerated upon subscription update. By default the flag is set to false which will delay charge regeneration 5 seconds. This enables running multiple calls to perform changes and receive responses much faster since the API won’t wait for a charge regeneration to complete. Setting this parameter to true will cause charge regeneration to complete before returning a response. */
     commit?: boolean;
+    /** If set to True, updates will also be applied to CANCELLED subscriptions. If null or False, only ACTIVE subscriptions will be updated. */
+    force_update?: boolean;
+}
+interface UpdateSubscriptionsParams {
+    /** If set to True, updates will also be applied to CANCELLED subscriptions. If null or False, only ACTIVE subscriptions will be updated. */
+    force_update?: boolean;
+}
+interface UpdateSubscriptionParams extends BasicSubscriptionParams {
+    /** If set to True, updates will also be applied to CANCELLED subscriptions. If null or False, only ACTIVE subscriptions will be updated. */
+    force_update?: boolean;
 }
 interface CancelSubscriptionRequest {
     cancellation_reason: string;
     cancellation_reason_comments?: string;
     send_email?: boolean;
 }
+interface UpdateSubscriptionsRequest extends UpdateSubscriptionRequest {
+    id: number;
+}
+interface Subscription_2021_01 {
+    is_prepaid: boolean;
+    order_day_of_month: number | null;
+    order_day_of_week: number | null;
+    order_interval_unit: 'day' | 'week' | 'month';
+    updated_at: IsoDateString;
+    id: number;
+    address_id: number;
+    analytics_data: AnalyticsData;
+    cancellation_reason: string | null;
+    cancellation_reason_comments: string | null;
+    cancelled_at: string | null;
+    charge_delay: number | null;
+    created_at: IsoDateString;
+    customer_id: number;
+    cutoff_day_of_month_before_and_after: number | null;
+    cutoff_day_of_week_before_and_after: number | null;
+    email: string;
+    expire_after_specific_number_of_charges: number | null;
+    first_charge_date: IsoDateString | null;
+    is_skippable: boolean;
+    is_swappable: boolean;
+    next_charge_scheduled_at: IsoDateString;
+    presentment_currency: string | null;
+    properties: Property[];
+    product_title: string | null;
+    quantity: number;
+    recharge_product_id: number;
+    shopify_product_id: number;
+    shopify_variant_id: number;
+    sku: string | null;
+    sku_override: boolean;
+    variant_title: string;
+    charge_interval_frequency: string;
+    has_queued_charges: BooleanLike;
+    locked_pending_charge_id: number;
+    max_retries_reached: BooleanLike;
+    order_interval_frequency: string;
+    price: number;
+    status: 'ACTIVE' | 'CANCELLED' | 'EXPIRED';
+}
 
 declare type CustomerIncludes = 'addresses' | 'metafields' | 'payment_methods' | 'subscriptions';
 interface GetCustomerOptions {
@@ -1767,7 +1825,7 @@ declare function listSubscriptions(session: Session, query?: SubscriptionListPar
  * need to match the values set in the respective Plans. The product, however, does need to have at least one Plan in order
  * to be added to a subscription.
  */
-declare function createSubscription(session: Session, createRequest: CreateSubscriptionRequest): Promise<Subscription>;
+declare function createSubscription(session: Session, createRequest: CreateSubscriptionRequest, query?: BasicSubscriptionParams): Promise<Subscription>;
 /**
  * Updating parameters like frequency, charge_interval_frequency, order_interval_frequency, order_interval_unit will cause our algorithm to automatically recalculate the next charge date (next_charge_scheduled_at).
  * WARNING: This update will remove skipped and manually changed charges.
@@ -1780,20 +1838,33 @@ declare function updateSubscription(session: Session, id: string | number, updat
  * next_charge_date parameters to match, their charges will get merged into a new charge
  * with a new id
  */
-declare function updateSubscriptionChargeDate(session: Session, id: string | number, date: IsoDateString): Promise<Subscription>;
+declare function updateSubscriptionChargeDate(session: Session, id: string | number, date: IsoDateString, query?: BasicSubscriptionParams): Promise<Subscription>;
 declare function updateSubscriptionAddress(session: Session, id: string | number, address_id: string | number): Promise<Subscription>;
 /**
  * An involuntary subscription cancelled due to max retries reached will trigger the
  * charge/max_retries_reached webhook. If this leads to the subscription being cancelled,
  * the subscription/cancelled webhook will trigger.
  */
-declare function cancelSubscription(session: Session, id: string | number, cancelRequest: CancelSubscriptionRequest): Promise<Subscription>;
+declare function cancelSubscription(session: Session, id: string | number, cancelRequest: CancelSubscriptionRequest, query?: BasicSubscriptionParams): Promise<Subscription>;
 /**
  * When activating subscription, following attributes will be set to null: cancelled_at, cancellation_reason
  * and cancellation_reason_comments.
  */
-declare function activateSubscription(session: Session, id: string | number): Promise<Subscription>;
+declare function activateSubscription(session: Session, id: string | number, query?: BasicSubscriptionParams): Promise<Subscription>;
 declare function skipSubscriptionCharge(session: Session, id: number | string, date: IsoDateString): Promise<Charge>;
+/**
+ * Bulk create new subscriptions.
+ * Must all be for the same address.
+ * There is a limit of 20 subscriptions per request.
+ */
+declare function createSubscriptions(session: Session, createRequestBulk: CreateSubscriptionRequest[]): Promise<Subscription[]>;
+/**
+ * Bulk create new subscriptions.
+ * Must all be for the same address.
+ * There is a limit of 20 subscriptions per request.
+ * Same rules apply as a single subscription update
+ */
+declare function updateSubscriptions(session: Session, addressId: string | number, updateRequestBulk: UpdateSubscriptionsRequest[], query?: UpdateSubscriptionsParams): Promise<Subscription[]>;
 
 declare function getCustomer(session: Session, options?: GetCustomerOptions): Promise<Customer>;
 declare function updateCustomer(session: Session, updateRequest: UpdateCustomerRequest): Promise<Customer>;
@@ -1808,4 +1879,4 @@ declare const api: {
 };
 declare function initRecharge(opt?: InitOptions): void;
 
-export { ActivateMembershipRequest, Address, AddressIncludes, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, AssociatedAddress, BundleAppProxy, BundleSelection, BundleSelectionAppProxy, BundleSelectionItem, BundleSelectionItemRequiredCreateProps, BundleSelectionListParams, BundleSelectionsResponse, BundleSelectionsSortBy, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, CancelMembershipRequest, CancelSubscriptionRequest, ChannelSettings, Charge, ChargeIncludes, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateBundleSelectionRequest, CreateMetafieldRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerOptionalUpdateProps, CustomerPortalAccessResponse, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, DynamicBundleItemAppProxy, DynamicBundlePropertiesAppProxy, ExternalId, ExternalTransactionId, FirstOption, GetAddressOptions, GetChargeOptions, GetCustomerOptions, GetPaymentMethodOptions, GetRequestOptions, GetSubscriptionOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Metafield, MetafieldCreateProps, MetafieldOptionalCreateProps, MetafieldOptionalUpdateProps, MetafieldOwnerResource, MetafieldRequiredCreateProps, Method, Onetime, OnetimeCreateProps, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeOptionalUpdateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderIncludes, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PasswordlessCodeResponse, PasswordlessValidateResponse, PaymentDetails, PaymentMethod, PaymentMethodIncludes, PaymentMethodListParams, PaymentMethodOptionalUpdateProps, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionIncludes, SubscriptionListParams, SubscriptionOptionalCreateProps, SubscriptionOptionalUpdateProps, SubscriptionPreferences, SubscriptionRequiredCreateProps, SubscriptionSortBy, SubscriptionStatus, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateBundleSelectionRequest, UpdateCustomerRequest, UpdateMetafieldRequest, UpdateOnetimeRequest, UpdatePaymentMethodRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, createAddress, createBundleSelection, createMetafield, createOnetime, createSubscription, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, getAddress, getBundleId, getBundleSelection, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getMembership, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, listAddresses, listBundleSelections, listCharges, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginShopifyApi, loginShopifyAppProxy, membershipIncludes, mergeAddresses, processCharge, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendPasswordlessCode, sendPasswordlessCodeAppProxy, skipCharge, skipFutureCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, validateBundle, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };
+export { ActivateMembershipRequest, Address, AddressIncludes, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, AssociatedAddress, BasicSubscriptionParams, BooleanLike, BooleanNumbers, BooleanString, BooleanStringNumbers, BundleAppProxy, BundleSelection, BundleSelectionAppProxy, BundleSelectionItem, BundleSelectionItemRequiredCreateProps, BundleSelectionListParams, BundleSelectionsResponse, BundleSelectionsSortBy, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, CancelMembershipRequest, CancelSubscriptionRequest, ChannelSettings, Charge, ChargeIncludes, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateBundleSelectionRequest, CreateMetafieldRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerOptionalUpdateProps, CustomerPortalAccessResponse, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, DynamicBundleItemAppProxy, DynamicBundlePropertiesAppProxy, ExternalId, ExternalTransactionId, FirstOption, GetAddressOptions, GetChargeOptions, GetCustomerOptions, GetPaymentMethodOptions, GetRequestOptions, GetSubscriptionOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Metafield, MetafieldCreateProps, MetafieldOptionalCreateProps, MetafieldOptionalUpdateProps, MetafieldOwnerResource, MetafieldRequiredCreateProps, Method, Onetime, OnetimeCreateProps, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeOptionalUpdateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderIncludes, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PasswordlessCodeResponse, PasswordlessValidateResponse, PaymentDetails, PaymentMethod, PaymentMethodIncludes, PaymentMethodListParams, PaymentMethodOptionalUpdateProps, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionIncludes, SubscriptionListParams, SubscriptionOptionalCreateProps, SubscriptionOptionalUpdateProps, SubscriptionPreferences, SubscriptionRequiredCreateProps, SubscriptionSortBy, SubscriptionStatus, Subscription_2021_01, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateBundleSelectionRequest, UpdateCustomerRequest, UpdateMetafieldRequest, UpdateOnetimeRequest, UpdatePaymentMethodRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, UpdateSubscriptionsParams, UpdateSubscriptionsRequest, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, createAddress, createBundleSelection, createMetafield, createOnetime, createSubscription, createSubscriptions, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, getAddress, getBundleId, getBundleSelection, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getMembership, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, listAddresses, listBundleSelections, listCharges, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginShopifyApi, loginShopifyAppProxy, membershipIncludes, mergeAddresses, processCharge, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendPasswordlessCode, sendPasswordlessCodeAppProxy, skipCharge, skipFutureCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateSubscriptions, validateBundle, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };