@bigcommerce/checkout-sdk 1.227.2 → 1.228.0

package/docs/README.md

@@ -221,6 +221,7 @@
 * [InputStyles](interfaces/inputstyles.md)
 * [Item](interfaces/item.md)
 * [Item_2](interfaces/item_2.md)
+* [Item_3](interfaces/item_3.md)
 * [KlarnaLoadResponse](interfaces/klarnaloadresponse.md)
 * [KlarnaLoadResponse_2](interfaces/klarnaloadresponse_2.md)
 * [KlarnaPaymentInitializeOptions](interfaces/klarnapaymentinitializeoptions.md)
@@ -242,6 +243,7 @@
 * [MonerisStylingProps](interfaces/monerisstylingprops.md)
 * [NonceGenerationError](interfaces/noncegenerationerror.md)
 * [NonceInstrument](interfaces/nonceinstrument.md)
+* [Option](interfaces/option.md)
 * [OptionsResponse](interfaces/optionsresponse.md)
 * [OpyPaymentInitializeOptions](interfaces/opypaymentinitializeoptions.md)
 * [Order](interfaces/order.md)
@@ -276,7 +278,9 @@
 * [PaypalExpressPaymentInitializeOptions](interfaces/paypalexpresspaymentinitializeoptions.md)
 * [PaypalFieldsStyleOptions](interfaces/paypalfieldsstyleoptions.md)
 * [PhysicalItem](interfaces/physicalitem.md)
+* [PickupMethod](interfaces/pickupmethod.md)
 * [PickupOptionRequestBody](interfaces/pickupoptionrequestbody.md)
+* [PickupOptionResult](interfaces/pickupoptionresult.md)
 * [Promotion](interfaces/promotion.md)
 * [Radius](interfaces/radius.md)
 * [Region](interfaces/region.md)

package/docs/classes/checkoutservice.md

@@ -901,21 +901,20 @@ ___
 Loads a list of pickup options for a given criteria.
 
 ```js
-const state = await service.loadPickupOptions({
-    search_area: {
-        radius: {
-            value: 1.4,
-            unit: 'KM'
-        },
-        coordinates: {
-            latitude: 1.4,
-            longitude: 0
-        },
+const consignmentId = '1';
+const searchArea = {
+    radius: {
+        value: 1.4,
+        unit: 'KM'
     },
-    consignmentId: 1,
-});
+    coordinates: {
+        latitude: 1.4,
+        longitude: 0
+    },
+};
+const state = await service.loadPickupOptions({ consignmentId, searchArea });
 
-console.log(state.data.getPickupOptions());
+console.log(state.data.getPickupOptions(consignmentId, searchArea));
 ```
 
 **`alpha`** 

package/docs/interfaces/checkoutstoreerrorselector.md

@@ -41,6 +41,7 @@ you can use this object to retrieve the reason for the failure.
 * [getLoadPaymentMethodsError](checkoutstoreerrorselector.md#getloadpaymentmethodserror)
 * [getLoadShippingCountriesError](checkoutstoreerrorselector.md#getloadshippingcountrieserror)
 * [getLoadShippingOptionsError](checkoutstoreerrorselector.md#getloadshippingoptionserror)
+* [getPickupOptionsError](checkoutstoreerrorselector.md#getpickupoptionserror)
 * [getRemoveCouponError](checkoutstoreerrorselector.md#getremovecouponerror)
 * [getRemoveGiftCertificateError](checkoutstoreerrorselector.md#getremovegiftcertificateerror)
 * [getSelectShippingOptionError](checkoutstoreerrorselector.md#getselectshippingoptionerror)
@@ -392,6 +393,18 @@ The error object if unable to load, otherwise undefined.
 
 ___
 
+###  getPickupOptionsError
+
+▸ **getPickupOptionsError**(): *[Error](amazonpaywidgeterror.md#error) | undefined*
+
+Returns an error if unable to fetch pickup options.
+
+**Returns:** *[Error](amazonpaywidgeterror.md#error) | undefined*
+
+The error object if unable to fetch pickup options, otherwise undefined.
+
+___
+
 ###  getRemoveCouponError
 
 ▸ **getRemoveCouponError**(): *[RequestError](../classes/requesterror.md) | undefined*

package/docs/interfaces/checkoutstoreselector.md

@@ -31,6 +31,7 @@ checkout information, such as shipping and billing details.
 * [getOrder](checkoutstoreselector.md#getorder)
 * [getPaymentMethod](checkoutstoreselector.md#getpaymentmethod)
 * [getPaymentMethods](checkoutstoreselector.md#getpaymentmethods)
+* [getPickupOptions](checkoutstoreselector.md#getpickupoptions)
 * [getSelectedPaymentMethod](checkoutstoreselector.md#getselectedpaymentmethod)
 * [getSelectedShippingOption](checkoutstoreselector.md#getselectedshippingoption)
 * [getShippingAddress](checkoutstoreselector.md#getshippingaddress)
@@ -279,6 +280,26 @@ The list of payment methods if it is loaded, otherwise undefined.
 
 ___
 
+###  getPickupOptions
+
+▸ **getPickupOptions**(`consignmentId`: string, `searchArea`: [SearchArea](searcharea.md)): *[PickupOptionResult](pickupoptionresult.md)[] | undefined*
+
+Gets a list of pickup options for specified parameters.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`consignmentId` | string | Id of consignment. |
+`searchArea` | [SearchArea](searcharea.md) | An object containing of radius and co-ordinates. |
+
+**Returns:** *[PickupOptionResult](pickupoptionresult.md)[] | undefined*
+
+The set of shipping address form fields if it is loaded,
+otherwise undefined.
+
+___
+
 ###  getSelectedPaymentMethod
 
 ▸ **getSelectedPaymentMethod**(): *[PaymentMethod](paymentmethod.md) | undefined*

package/docs/interfaces/checkoutstorestatusselector.md

@@ -41,6 +41,7 @@ order and waiting for the request to complete.
 * [isLoadingOrder](checkoutstorestatusselector.md#isloadingorder)
 * [isLoadingPaymentMethod](checkoutstorestatusselector.md#isloadingpaymentmethod)
 * [isLoadingPaymentMethods](checkoutstorestatusselector.md#isloadingpaymentmethods)
+* [isLoadingPickupOptions](checkoutstorestatusselector.md#isloadingpickupoptions)
 * [isLoadingShippingCountries](checkoutstorestatusselector.md#isloadingshippingcountries)
 * [isLoadingShippingOptions](checkoutstorestatusselector.md#isloadingshippingoptions)
 * [isPaymentStepPending](checkoutstorestatusselector.md#ispaymentsteppending)
@@ -417,6 +418,18 @@ 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*

package/docs/interfaces/inputdetail.md

@@ -47,7 +47,7 @@ ___
 
 ### `Optional` items
 
-• **items**? : *[Item](item.md)[]*
+• **items**? : *[Item_2](item_2.md)[]*
 
 In case of a select, the items to choose from.
 

package/docs/interfaces/inputdetail_2.md

@@ -47,7 +47,7 @@ ___
 
 ### `Optional` items
 
-• **items**? : *[Item_2](item_2.md)[]*
+• **items**? : *[Item_3](item_3.md)[]*
 
 In case of a select, the items to choose from.
 

package/docs/interfaces/item.md

@@ -10,21 +10,17 @@
 
 ### Properties
 
-* [id](item.md#optional-id)
-* [name](item.md#optional-name)
+* [quantity](item.md#quantity)
+* [variantId](item.md#variantid)
 
 ## Properties
 
-### `Optional` id
+###  quantity
 
-• **id**? : *undefined | string*
-
-The value to provide in the result.
+• **quantity**: *number*
 
 ___
 
-### `Optional` name
-
-• **name**? : *undefined | string*
+###  variantId
 
-The display name.
+• **variantId**: *number*

package/docs/interfaces/item_3.md

@@ -0,0 +1,30 @@
+[@bigcommerce/checkout-sdk](../README.md) › [Item_3](item_3.md)
+
+# Interface: Item_3
+
+## Hierarchy
+
+* **Item_3**
+
+## Index
+
+### Properties
+
+* [id](item_3.md#optional-id)
+* [name](item_3.md#optional-name)
+
+## Properties
+
+### `Optional` id
+
+• **id**? : *undefined | string*
+
+The value to provide in the result.
+
+___
+
+### `Optional` name
+
+• **name**? : *undefined | string*
+
+The display name.

package/docs/interfaces/option.md

@@ -0,0 +1,26 @@
+[@bigcommerce/checkout-sdk](../README.md) › [Option](option.md)
+
+# Interface: Option
+
+## Hierarchy
+
+* **Option**
+
+## Index
+
+### Properties
+
+* [itemQuantities](option.md#itemquantities)
+* [pickupMethod](option.md#pickupmethod)
+
+## Properties
+
+###  itemQuantities
+
+• **itemQuantities**: *[Item](item.md)*
+
+___
+
+###  pickupMethod
+
+• **pickupMethod**: *[PickupMethod](pickupmethod.md)*

package/docs/interfaces/pickupmethod.md

@@ -0,0 +1,47 @@
+[@bigcommerce/checkout-sdk](../README.md) › [PickupMethod](pickupmethod.md)
+
+# Interface: PickupMethod
+
+## Hierarchy
+
+* **PickupMethod**
+
+## Index
+
+### Properties
+
+* [collectionInstructions](pickupmethod.md#collectioninstructions)
+* [collectionTimeDescription](pickupmethod.md#collectiontimedescription)
+* [displayName](pickupmethod.md#displayname)
+* [id](pickupmethod.md#id)
+* [locationId](pickupmethod.md#locationid)
+
+## Properties
+
+###  collectionInstructions
+
+• **collectionInstructions**: *string*
+
+___
+
+###  collectionTimeDescription
+
+• **collectionTimeDescription**: *string*
+
+___
+
+###  displayName
+
+• **displayName**: *string*
+
+___
+
+###  id
+
+• **id**: *number*
+
+___
+
+###  locationId
+
+• **locationId**: *number*

package/docs/interfaces/pickupoptionresult.md

@@ -0,0 +1,19 @@
+[@bigcommerce/checkout-sdk](../README.md) › [PickupOptionResult](pickupoptionresult.md)
+
+# Interface: PickupOptionResult
+
+## Hierarchy
+
+* **PickupOptionResult**
+
+## Index
+
+### Properties
+
+* [options](pickupoptionresult.md#options)
+
+## Properties
+
+###  options
+
+• **options**: *[Option](option.md)[]*

package/docs/interfaces/subinputdetail.md

@@ -29,7 +29,7 @@ ___
 
 ### `Optional` items
 
-• **items**? : *[Item](item.md)[]*
+• **items**? : *[Item_2](item_2.md)[]*
 
 In case of a select, the items to choose from.
 

package/docs/interfaces/subinputdetail_2.md

@@ -29,7 +29,7 @@ ___
 
 ### `Optional` items
 
-• **items**? : *[Item_2](item_2.md)[]*
+• **items**? : *[Item_3](item_3.md)[]*
 
 In case of a select, the items to choose from.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.227.2",
+  "version": "1.228.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",