npm - @bigcommerce/checkout-sdk - Versions diffs - 1.308.2 → 1.308.3 - Mend

@bigcommerce/checkout-sdk 1.308.2 → 1.308.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (345) hide show

package/docs/interfaces/internal_.CheckoutStoreStatusSelector.md DELETED Viewed

@@ -1,760 +0,0 @@
-[@bigcommerce/checkout-sdk](../README.md) / [<internal\>](../modules/internal_.md) / CheckoutStoreStatusSelector
-# Interface: CheckoutStoreStatusSelector
-[<internal>](../modules/internal_.md).CheckoutStoreStatusSelector
-Responsible for checking the statuses of various asynchronous actions related
-to checkout.
-This object has a set of getters that return true if an action is in
-progress. For example, you can check whether a customer is submitting an
-order and waiting for the request to complete.
-## Table of contents
-### Methods
-- [isApplyingCoupon](internal_.CheckoutStoreStatusSelector.md#isapplyingcoupon)
-- [isApplyingGiftCertificate](internal_.CheckoutStoreStatusSelector.md#isapplyinggiftcertificate)
-- [isApplyingStoreCredit](internal_.CheckoutStoreStatusSelector.md#isapplyingstorecredit)
-- [isContinuingAsGuest](internal_.CheckoutStoreStatusSelector.md#iscontinuingasguest)
-- [isCreatingConsignments](internal_.CheckoutStoreStatusSelector.md#iscreatingconsignments)
-- [isCreatingCustomerAccount](internal_.CheckoutStoreStatusSelector.md#iscreatingcustomeraccount)
-- [isCreatingCustomerAddress](internal_.CheckoutStoreStatusSelector.md#iscreatingcustomeraddress)
-- [isCustomerStepPending](internal_.CheckoutStoreStatusSelector.md#iscustomersteppending)
-- [isDeletingConsignment](internal_.CheckoutStoreStatusSelector.md#isdeletingconsignment)
-- [isDeletingInstrument](internal_.CheckoutStoreStatusSelector.md#isdeletinginstrument)
-- [isExecutingPaymentMethodCheckout](internal_.CheckoutStoreStatusSelector.md#isexecutingpaymentmethodcheckout)
-- [isExecutingSpamCheck](internal_.CheckoutStoreStatusSelector.md#isexecutingspamcheck)
-- [isFinalizingOrder](internal_.CheckoutStoreStatusSelector.md#isfinalizingorder)
-- [isInitializingCustomer](internal_.CheckoutStoreStatusSelector.md#isinitializingcustomer)
-- [isInitializingPayment](internal_.CheckoutStoreStatusSelector.md#isinitializingpayment)
-- [isInitializingShipping](internal_.CheckoutStoreStatusSelector.md#isinitializingshipping)
-- [isLoadingBillingCountries](internal_.CheckoutStoreStatusSelector.md#isloadingbillingcountries)
-- [isLoadingCart](internal_.CheckoutStoreStatusSelector.md#isloadingcart)
-- [isLoadingCheckout](internal_.CheckoutStoreStatusSelector.md#isloadingcheckout)
-- [isLoadingConfig](internal_.CheckoutStoreStatusSelector.md#isloadingconfig)
-- [isLoadingInstruments](internal_.CheckoutStoreStatusSelector.md#isloadinginstruments)
-- [isLoadingOrder](internal_.CheckoutStoreStatusSelector.md#isloadingorder)
-- [isLoadingPaymentMethod](internal_.CheckoutStoreStatusSelector.md#isloadingpaymentmethod)
-- [isLoadingPaymentMethods](internal_.CheckoutStoreStatusSelector.md#isloadingpaymentmethods)
-- [isLoadingPickupOptions](internal_.CheckoutStoreStatusSelector.md#isloadingpickupoptions)
-- [isLoadingShippingCountries](internal_.CheckoutStoreStatusSelector.md#isloadingshippingcountries)
-- [isLoadingShippingOptions](internal_.CheckoutStoreStatusSelector.md#isloadingshippingoptions)
-- [isPaymentStepPending](internal_.CheckoutStoreStatusSelector.md#ispaymentsteppending)
-- [isPending](internal_.CheckoutStoreStatusSelector.md#ispending)
-- [isRemovingCoupon](internal_.CheckoutStoreStatusSelector.md#isremovingcoupon)
-- [isRemovingGiftCertificate](internal_.CheckoutStoreStatusSelector.md#isremovinggiftcertificate)
-- [isSelectingShippingOption](internal_.CheckoutStoreStatusSelector.md#isselectingshippingoption)
-- [isSendingSignInEmail](internal_.CheckoutStoreStatusSelector.md#issendingsigninemail)
-- [isShippingStepPending](internal_.CheckoutStoreStatusSelector.md#isshippingsteppending)
-- [isSigningIn](internal_.CheckoutStoreStatusSelector.md#issigningin)
-- [isSigningOut](internal_.CheckoutStoreStatusSelector.md#issigningout)
-- [isSubmittingOrder](internal_.CheckoutStoreStatusSelector.md#issubmittingorder)
-- [isUpdatingBillingAddress](internal_.CheckoutStoreStatusSelector.md#isupdatingbillingaddress)
-- [isUpdatingCheckout](internal_.CheckoutStoreStatusSelector.md#isupdatingcheckout)
-- [isUpdatingConsignment](internal_.CheckoutStoreStatusSelector.md#isupdatingconsignment)
-- [isUpdatingShippingAddress](internal_.CheckoutStoreStatusSelector.md#isupdatingshippingaddress)
-- [isUpdatingSubscriptions](internal_.CheckoutStoreStatusSelector.md#isupdatingsubscriptions)
-## Methods
-### isApplyingCoupon
-▸ **isApplyingCoupon**(): `boolean`
-Checks whether the current customer is applying a coupon code.
-#### Returns
-`boolean`
-True if applying a coupon code, otherwise false.
-___
-### isApplyingGiftCertificate
-▸ **isApplyingGiftCertificate**(): `boolean`
-Checks whether the current customer is applying a gift certificate.
-#### Returns
-`boolean`
-True if applying a gift certificate, otherwise false.
-___
-### isApplyingStoreCredit
-▸ **isApplyingStoreCredit**(): `boolean`
-Checks whether the current customer is applying store credit.
-#### Returns
-`boolean`
-True if applying store credit, otherwise false.
-___
-### isContinuingAsGuest
-▸ **isContinuingAsGuest**(): `boolean`
-Checks whether the shopper is continuing out as a guest.
-#### Returns
-`boolean`
-True if continuing as guest, otherwise false.
-___
-### isCreatingConsignments
-▸ **isCreatingConsignments**(): `boolean`
-Checks whether a given/any consignment is being updated.
-A consignment ID should be provided when checking for a specific consignment,
-otherwise it will check for any consignment.
-#### Returns
-`boolean`
-True if creating consignments, otherwise false.
-___
-### isCreatingCustomerAccount
-▸ **isCreatingCustomerAccount**(): `boolean`
-Checks whether a customer account is being created
-#### Returns
-`boolean`
-True if creating, otherwise false.
-___
-### isCreatingCustomerAddress
-▸ **isCreatingCustomerAddress**(): `boolean`
-Checks whether a customer address is being created
-#### Returns
-`boolean`
-True if creating, otherwise false.
-___
-### isCustomerStepPending
-▸ **isCustomerStepPending**(): `boolean`
-Checks whether the customer step of a checkout is in a pending state.
-The customer step is considered to be pending if it is in the process of
-initializing, signing in, signing out, and/or interacting with a customer
-widget.
-#### Returns
-`boolean`
-True if the customer step is pending, otherwise false.
-___
-### isDeletingConsignment
-▸ **isDeletingConsignment**(`consignmentId?`): `boolean`
-Checks whether a given/any consignment is being deleted.
-A consignment ID should be provided when checking for a specific consignment,
-otherwise it will check for any consignment.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `consignmentId?` | `string` | The identifier of the consignment to be checked. |
-#### Returns
-`boolean`
-True if deleting consignment(s), otherwise false.
-___
-### isDeletingInstrument
-▸ **isDeletingInstrument**(`instrumentId?`): `boolean`
-Checks whether the current customer is deleting a payment instrument.
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `instrumentId?` | `string` |
-#### Returns
-`boolean`
-True if deleting a payment instrument, otherwise false.
-___
-### isExecutingPaymentMethodCheckout
-▸ **isExecutingPaymentMethodCheckout**(`methodId?`): `boolean`
-Checks whether the current customer is executing payment method checkout.
-If an ID is provided, the method also checks whether the customer is
-executing payment method checkout using a specific customer method with the same ID.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `methodId?` | `string` | The identifier of the method used for continuing the current customer. |
-#### Returns
-`boolean`
-True if the customer is executing payment method checkout, otherwise false.
-___
-### isExecutingSpamCheck
-▸ **isExecutingSpamCheck**(): `boolean`
-Checks whether spam check is executing.
-#### Returns
-`boolean`
-True if the current checkout is being updated, otherwise false.
-___
-### isFinalizingOrder
-▸ **isFinalizingOrder**(): `boolean`
-Checks whether the current order is finalizing.
-#### Returns
-`boolean`
-True if the current order is finalizing, otherwise false.
-___
-### isInitializingCustomer
-▸ **isInitializingCustomer**(`methodId?`): `boolean`
-Checks whether the customer step is initializing.
-If an ID is provided, the method also checks whether the customer step is
-initializing using a specific customer method with the same ID.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `methodId?` | `string` | The identifier of the method used for initializing the customer step of checkout. |
-#### Returns
-`boolean`
-True if the customer step is initializing, otherwise false.
-___
-### isInitializingPayment
-▸ **isInitializingPayment**(`methodId?`): `boolean`
-Checks whether a specific or any payment method is initializing.
-The method returns true if no ID is provided and at least one payment
-method is initializing.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `methodId?` | `string` | The identifier of the payment method to check. |
-#### Returns
-`boolean`
-True if the payment method is initializing, otherwise false.
-___
-### isInitializingShipping
-▸ **isInitializingShipping**(`methodId?`): `boolean`
-Checks whether the shipping step of a checkout process is initializing.
-If an identifier is provided, the method also checks whether the shipping
-step is initializing using a specific shipping method with the same
-identifier.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `methodId?` | `string` | The identifer of the initialization method to check. |
-#### Returns
-`boolean`
-True if the shipping step is initializing, otherwise false.
-___
-### isLoadingBillingCountries
-▸ **isLoadingBillingCountries**(): `boolean`
-Checks whether billing countries are loading.
-#### Returns
-`boolean`
-True if billing countries are loading, otherwise false.
-___
-### isLoadingCart
-▸ **isLoadingCart**(): `boolean`
-Checks whether the current cart is loading.
-#### Returns
-`boolean`
-True if the current cart is loading, otherwise false.
-___
-### isLoadingCheckout
-▸ **isLoadingCheckout**(): `boolean`
-Checks whether the current checkout is loading.
-#### Returns
-`boolean`
-True if the current checkout is loading, otherwise false.
-___
-### isLoadingConfig
-▸ **isLoadingConfig**(): `boolean`
-Checks whether the checkout configuration of a store is loading.
-#### Returns
-`boolean`
-True if the configuration is loading, otherwise false.
-___
-### isLoadingInstruments
-▸ **isLoadingInstruments**(): `boolean`
-Checks whether the current customer's payment instruments are loading.
-#### Returns
-`boolean`
-True if payment instruments are loading, otherwise false.
-___
-### isLoadingOrder
-▸ **isLoadingOrder**(): `boolean`
-Checks whether the current order is loading.
-#### Returns
-`boolean`
-True if the current order is loading, otherwise false.
-___
-### isLoadingPaymentMethod
-▸ **isLoadingPaymentMethod**(`methodId?`): `boolean`
-Checks whether a specific or any payment method is loading.
-The method returns true if no ID is provided and at least one payment
-method is loading.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `methodId?` | `string` | The identifier of the payment method to check. |
-#### Returns
-`boolean`
-True if the payment method is loading, otherwise false.
-___
-### isLoadingPaymentMethods
-▸ **isLoadingPaymentMethods**(): `boolean`
-Checks whether payment methods are loading.
-#### Returns
-`boolean`
-True if payment methods are loading, otherwise false.
-___
-### isLoadingPickupOptions
-▸ **isLoadingPickupOptions**(): `boolean`
-Checks whether pickup options are loading.
-#### Returns
-`boolean`
-True if pickup options are loading, otherwise false.
-___
-### isLoadingShippingCountries
-▸ **isLoadingShippingCountries**(): `boolean`
-Checks whether shipping countries are loading.
-#### Returns
-`boolean`
-True if shipping countries are loading, otherwise false.
-___
-### isLoadingShippingOptions
-▸ **isLoadingShippingOptions**(): `boolean`
-Checks whether shipping options are loading.
-#### Returns
-`boolean`
-True if shipping options are loading, otherwise false.
-___
-### isPaymentStepPending
-▸ **isPaymentStepPending**(): `boolean`
-Checks whether the payment step of a checkout is in a pending state.
-The payment step is considered to be pending if it is in the process of
-initializing, submitting an order, finalizing an order, and/or
-interacting with a payment widget.
-#### Returns
-`boolean`
-True if the payment step is pending, otherwise false.
-___
-### isPending
-▸ **isPending**(): `boolean`
-Checks whether any checkout action is pending.
-#### Returns
-`boolean`
-True if there is a pending action, otherwise false.
-___
-### isRemovingCoupon
-▸ **isRemovingCoupon**(): `boolean`
-Checks whether the current customer is removing a coupon code.
-#### Returns
-`boolean`
-True if removing a coupon code, otherwise false.
-___
-### isRemovingGiftCertificate
-▸ **isRemovingGiftCertificate**(): `boolean`
-Checks whether the current customer is removing a gift certificate.
-#### Returns
-`boolean`
-True if removing a gift certificate, otherwise false.
-___
-### isSelectingShippingOption
-▸ **isSelectingShippingOption**(`consignmentId?`): `boolean`
-Checks whether a shipping option is being selected.
-A consignment ID should be provided when checking if a shipping option
-is being selected for a specific consignment, otherwise it will check
-for all consignments.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `consignmentId?` | `string` | The identifier of the consignment to be checked. |
-#### Returns
-`boolean`
-True if selecting a shipping option, otherwise false.
-___
-### isSendingSignInEmail
-▸ **isSendingSignInEmail**(): `boolean`
-Checks whether a sign-in email is being sent.
-#### Returns
-`boolean`
-True if sending a sign-in email, otherwise false
-___
-### isShippingStepPending
-▸ **isShippingStepPending**(): `boolean`
-Checks whether the shipping step of a checkout is in a pending state.
-The shipping step is considered to be pending if it is in the process of
-initializing, updating address, selecting a shipping option, and/or
-interacting with a shipping widget.
-#### Returns
-`boolean`
-True if the shipping step is pending, otherwise false.
-___
-### isSigningIn
-▸ **isSigningIn**(`methodId?`): `boolean`
-Checks whether the current customer is signing in.
-If an ID is provided, the method also checks whether the customer is
-signing in using a specific customer method with the same ID.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `methodId?` | `string` | The identifier of the method used for signing in the current customer. |
-#### Returns
-`boolean`
-True if the customer is signing in, otherwise false.
-___
-### isSigningOut
-▸ **isSigningOut**(`methodId?`): `boolean`
-Checks whether the current customer is signing out.
-If an ID is provided, the method also checks whether the customer is
-signing out using a specific customer method with the same ID.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `methodId?` | `string` | The identifier of the method used for signing out the current customer. |
-#### Returns
-`boolean`
-True if the customer is signing out, otherwise false.
-___
-### isSubmittingOrder
-▸ **isSubmittingOrder**(): `boolean`
-Checks whether the current order is submitting.
-#### Returns
-`boolean`
-True if the current order is submitting, otherwise false.
-___
-### isUpdatingBillingAddress
-▸ **isUpdatingBillingAddress**(): `boolean`
-Checks whether the billing address is being updated.
-#### Returns
-`boolean`
-True if updating their billing address, otherwise false.
-___
-### isUpdatingCheckout
-▸ **isUpdatingCheckout**(): `boolean`
-Checks whether the current checkout is being updated.
-#### Returns
-`boolean`
-True if the current checkout is being updated, otherwise false.
-___
-### isUpdatingConsignment
-▸ **isUpdatingConsignment**(`consignmentId?`): `boolean`
-Checks whether a given/any consignment is being updated.
-A consignment ID should be provided when checking for a specific consignment,
-otherwise it will check for any consignment.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `consignmentId?` | `string` | The identifier of the consignment to be checked. |
-#### Returns
-`boolean`
-True if updating consignment(s), otherwise false.
-___
-### isUpdatingShippingAddress
-▸ **isUpdatingShippingAddress**(): `boolean`
-Checks the shipping address is being updated.
-#### Returns
-`boolean`
-True if updating their shipping address, otherwise false.
-___
-### isUpdatingSubscriptions
-▸ **isUpdatingSubscriptions**(): `boolean`
-Checks whether the subscriptions are being updated.
-#### Returns
-`boolean`
-True if updating subscriptions, otherwise false.