@rechargeapps/storefront-client 1.3.1 → 1.3.3

package/dist/index.d.ts

@@ -12,7 +12,7 @@ interface ListParams<T> {
     /** default is 50, max is 250 */
     limit?: number;
     /** next or previous cursor returned by previous list call */
-    cursor?: number;
+    cursor?: string;
     /** sort list by option */
     sort_by?: T;
 }
@@ -237,7 +237,7 @@ interface PaymentMethodListParams extends ListParams<PaymentMethodSortBy> {
     /** Return the payment_methods linked to the given processor_name. */
     processor_name?: ProcessorName;
     /** Return the payment_methods linked to the given address_id. */
-    address_id?: string;
+    address_id?: string | number;
     /** Return the payment_methods linked to the given processor_payment_method_token. */
     processor_payment_method_token?: string;
     /** Include related data options */
@@ -345,9 +345,9 @@ interface GetSubscriptionOptions {
 type SubscriptionSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
 interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
     /** Return the subscriptions linked to the given address_id. */
-    address_id?: string;
+    address_id?: string | number;
     /** Return the subscriptions linked to the given address_ids. */
-    address_ids?: string[];
+    address_ids?: (string | number)[];
     /** Return the subscriptions created before the given date. */
     created_at_max?: IsoDateString;
     /** Return the subscriptions created after the given date. */
@@ -355,7 +355,7 @@ interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
     /** Return the subscriptions linked to the given external_variant_id */
     external_variant_id?: string;
     /** Comma-separated list of subscription_ids to filter */
-    ids?: string[];
+    ids?: (string | number)[];
     /** Return the subscriptions with specified status. */
     status?: SubscriptionStatus;
     /** Return the subscriptions updated before the given date. */
@@ -658,29 +658,29 @@ interface OrdersResponse {
 type OrderSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'processed_at-asc' | 'processed_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
 interface OrderListParams extends ListParams<OrderSortBy> {
     /** Filter orders by address. */
-    address_id?: string;
+    address_id?: string | number;
     /** Filter orders by charge. */
-    charge_id?: string;
+    charge_id?: string | number;
     /** Show orders created after the given date. */
     created_at_min?: IsoDateString;
     /** Show orders created before the given date. */
     created_at_max?: IsoDateString;
     /** Filter orders by external_order_id. */
-    external_order_id?: string;
+    external_order_id?: string | number;
     /** Filter orders by id. */
-    ids?: string[];
+    ids?: (string | number)[];
     /** Show orders scheduled before the given date. */
     scheduled_at_max?: IsoDateString;
     /** Show orders scheduled after the given date. */
     scheduled_at_min?: IsoDateString;
     /** Filter orders with/without external_order_id. */
-    has_external_order?: string;
+    has_external_order?: boolean;
     /** Filter orders by status. */
     status?: OrderStatus;
     /** Filter orders by type. */
     type?: OrderType;
     /** Filter orders by subscription or onetime. */
-    purchase_item_id?: string;
+    purchase_item_id?: string | number;
     /** Show orders updated before the given date. */
     updated_at_max?: IsoDateString;
     /** Show orders updated after the given date. */
@@ -727,6 +727,8 @@ interface Charge {
     external_order_id: ExternalId;
     /** An object containing the associated external transaction ID. */
     external_transaction_id: ExternalTransactionId;
+    /** Specifies whether the Charge is scheduled for a regeneration (if the Subscription related to the charge was updated in the last 5 seconds using commit=false). */
+    has_uncommited_changes?: boolean;
     /** A list of line_item objects, each containing information about a distinct purchase item. */
     line_items: LineItem[];
     /** Notes associated with the Charge. */
@@ -739,8 +741,6 @@ interface Charge {
     payment_processor: string;
     /** The date and time when the transaction was processed. */
     processed_at: IsoDateString;
-    /** The date when the next attempt will be placed. */
-    retry_date: IsoDateString;
     /** The date time of when the Charge is/was scheduled to process. */
     scheduled_at: IsoDateString;
     /** The shipping Address of the Charge. */
@@ -779,6 +779,16 @@ interface Charge {
         metafields?: Metafield[];
         payment_methods?: PaymentMethod[];
     };
+    /** Error reason as sentence text (typically returned direct from the payment processor). e.g. "error": "Customer needs to update credit card" */
+    error?: string;
+    /** Structured reason why the charge failed such as CUSTOMER_NEEDS_TO_UPDATE_CARD. */
+    error_type?: string;
+    /** Shows how many times an attempt to charge was placed. */
+    charge_attempts?: number;
+    /** Indicates if Recharge was able to find the external_variant_id from the Charge. */
+    external_variant_id_not_found?: boolean;
+    /** The date when the next attempt will be placed. */
+    retry_date?: IsoDateString;
 }
 interface ChargeResponse {
     charge: Charge;
@@ -795,22 +805,22 @@ interface GetChargeOptions {
 type ChargeSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
 interface ChargeListParams extends ListParams<ChargeSortBy> {
     /** Filter Charges by Address. */
-    address_id?: string;
+    address_id?: string | number;
     /** List Charges that contain the given discount_id. */
-    discount_id?: string;
+    discount_id?: string | number;
     /** List Charges that contain the given discount_code. */
     discount_code?: string;
     /** Filter Charges by the associated order ID in the external e-commerce platform. */
-    external_order_id?: string;
+    external_order_id?: string | number;
     /**
      * Filter Charges by ID.
      * If passing multiple values, must be comma separated. Non-integer values will result in a 422 error.
      */
-    ids?: string;
+    ids?: string | number;
     /** Filter Charges by a Subscription or Onetime ID. */
-    purchase_item_id?: string;
+    purchase_item_id?: string | number;
     /** Filter Charges by a comma-separated list of Subscription or Onetime IDs. */
-    purchase_item_ids?: string;
+    purchase_item_ids?: string | number;
     /** Filter Charges by specific scheduled charge date. */
     scheduled_at?: IsoDateString;
     /** Show Charges scheduled to be processed before the given date. */
@@ -836,8 +846,8 @@ interface ChargeListParams extends ListParams<ChargeSortBy> {
 }
 
 interface CreateAddressRequest {
-    /** Unique numeric identifier for the customer associated with the address. */
-    customer_id: number;
+    /** Unique numeric identifier for the customer associated with the address, if not provided will be auto-filled from Session */
+    customer_id?: number;
     /** The street associated with the Address. Minimum length is 1 character. */
     address1: string;
     /** Any additional information associated with the Address. */
@@ -977,7 +987,7 @@ interface GetAddressOptions {
 type AddressSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
 interface AddressListParams extends ListParams<AddressSortBy> {
     /** Returns addresses that have the provided discount_id. */
-    discount_id?: string;
+    discount_id?: string | number;
     /** Returns addresses that have the provided discount_code. */
     discount_code?: string;
     /** Returns addresses created after the given time. */
@@ -1042,6 +1052,8 @@ declare function sendPasswordlessCode(email: string, options?: PasswordlessOptio
 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>;
+/** @internal */
+declare function loginCustomerPortal(): Promise<Session>;
 
 type Method = 'get' | 'post' | 'put' | 'delete';
 type Request = <T>(method: Method, url: string, options?: RequestOptions) => Promise<T>;
@@ -1139,9 +1151,9 @@ interface BundleSelectionsResponse {
 type BundleSelectionsSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
 interface BundleSelectionListParams extends ListParams<BundleSelectionsSortBy> {
     /** Filter BundleSelections by Subscription or Onetime ID. */
-    purchase_item_ids?: string[];
+    purchase_item_ids?: (string | number)[];
     /** Filter BundleSelections by BundleVariants. */
-    bundle_variant_ids?: string[];
+    bundle_variant_ids?: (string | number)[];
 }
 
 type FirstOption = 'onetime' | 'autodeliver';
@@ -1529,7 +1541,7 @@ type MembershipIncludes = `${membershipIncludes}` | `${membershipIncludes},${mem
 interface MembershipListParams extends ListParams<MembershipsSortBy> {
     include?: MembershipIncludes;
     /** Return the memberships linked to the given membership_program_ids. */
-    membership_program_ids?: string[];
+    membership_program_ids?: (string | number)[];
     /** Return the memberships with specified status. */
     status?: MembershipStatus;
     /** Returns memberships created after the given time. */
@@ -1653,7 +1665,7 @@ type MembershipProgramIncludes = 'membership_benefits' | 'collections';
 /** @internal */
 interface MembershipProgramListParams extends ListParams<MembershipProgramSortBy> {
     /** Return the membership program with specified IDs. */
-    ids?: number[];
+    ids?: (string | number)[];
     /** Return the membership program with specified status. */
     status?: MembershipProgramStatus;
     /** If true the response will include the deleted membership programs as well as the others. */
@@ -1717,17 +1729,17 @@ interface OnetimesResponse {
 type OnetimesSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
 interface OnetimeListParams extends ListParams<OnetimesSortBy> {
     /** Return the onetimes linked to the given address_id. */
-    address_id?: string;
+    address_id?: string | number;
     /** Return the onetimes linked to the given address_ids. */
-    address_ids?: string[];
+    address_ids?: (string | number)[];
     /** Return the onetimes created before the given date. */
     created_at_max?: IsoDateString;
     /** Return the onetimes created after the given date. */
     created_at_min?: IsoDateString;
     /** Return the onetimes linked to the given external_variant_id */
-    external_variant_id?: string;
+    external_variant_id?: string | number;
     /** Comma-separated list of onetime_ids to filter */
-    ids?: string[];
+    ids?: (string | number)[];
     /** If true the response will include the cancelled Onetimes as well as the others. */
     include_cancelled?: boolean;
     /** Return the onetimes updated before the given date. */
@@ -1827,7 +1839,7 @@ interface PlansResponse {
 type PlanSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
 interface PlanListParams extends ListParams<PlanSortBy> {
     /** Return the Plans linked to the Product record in Recharge with the indicated external_product_id */
-    external_product_id?: string;
+    external_product_id?: string | number;
     /** Return the plans updated before the given date. */
     updated_at_max?: IsoDateString;
     /** Return the plans updated after the given date. */
@@ -1983,4 +1995,4 @@ declare const api: {
 };
 declare function initRecharge(opt?: InitOptions): void;
 
-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, ChangeMembershipRequest, ChannelSettings, Charge, ChargeIncludes, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateBundleSelectionRequest, CreateMetafieldRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerPortalAccessResponse, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, DynamicBundleItemAppProxy, DynamicBundlePropertiesAppProxy, ExternalAttributeSchema, ExternalId, ExternalTransactionId, FirstOption, GetAddressOptions, GetChargeOptions, GetCustomerOptions, GetMembershipProgramOptions, GetPaymentMethodOptions, GetRequestOptions, GetSubscriptionOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipBenefit, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipProgram, MembershipProgramIncludes, MembershipProgramListParams, MembershipProgramListResponse, MembershipProgramResponse, MembershipProgramSortBy, MembershipProgramStatus, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Metafield, MetafieldOptionalCreateProps, MetafieldOwnerResource, MetafieldRequiredCreateProps, Method, Onetime, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderIncludes, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PasswordlessCodeResponse, PasswordlessOptions, PasswordlessValidateResponse, PaymentDetails, PaymentMethod, PaymentMethodIncludes, PaymentMethodListParams, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionIncludes, SubscriptionListParams, SubscriptionOptionalCreateProps, 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, changeMembership, 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, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, intervalUnit, listAddresses, listBundleSelections, listCharges, listMembershipPrograms, 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 };
+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, ChangeMembershipRequest, ChannelSettings, Charge, ChargeIncludes, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateBundleSelectionRequest, CreateMetafieldRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerPortalAccessResponse, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, DynamicBundleItemAppProxy, DynamicBundlePropertiesAppProxy, ExternalAttributeSchema, ExternalId, ExternalTransactionId, FirstOption, GetAddressOptions, GetChargeOptions, GetCustomerOptions, GetMembershipProgramOptions, GetPaymentMethodOptions, GetRequestOptions, GetSubscriptionOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipBenefit, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipProgram, MembershipProgramIncludes, MembershipProgramListParams, MembershipProgramListResponse, MembershipProgramResponse, MembershipProgramSortBy, MembershipProgramStatus, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Metafield, MetafieldOptionalCreateProps, MetafieldOwnerResource, MetafieldRequiredCreateProps, Method, Onetime, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderIncludes, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PasswordlessCodeResponse, PasswordlessOptions, PasswordlessValidateResponse, PaymentDetails, PaymentMethod, PaymentMethodIncludes, PaymentMethodListParams, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionIncludes, SubscriptionListParams, SubscriptionOptionalCreateProps, 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, changeMembership, 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, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, intervalUnit, listAddresses, listBundleSelections, listCharges, listMembershipPrograms, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginCustomerPortal, 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 };