@bigcommerce/checkout-sdk 1.237.2 → 1.238.1

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 (18) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/dist/checkout-button.js +1 -1
  3. package/dist/checkout-button.js.map +1 -1
  4. package/dist/checkout-button.umd.js +2 -2
  5. package/dist/checkout-button.umd.js.map +1 -1
  6. package/dist/checkout-sdk.d.ts +17 -4
  7. package/dist/checkout-sdk.js +1 -1
  8. package/dist/checkout-sdk.js.map +1 -1
  9. package/dist/checkout-sdk.umd.js +3 -3
  10. package/dist/checkout-sdk.umd.js.map +1 -1
  11. package/docs/README.md +9 -1
  12. package/docs/classes/checkoutservice.md +5 -5
  13. package/docs/interfaces/consignmentassignmentbaserequestbodywithaddress.md +33 -0
  14. package/docs/interfaces/consignmentassignmentbaserequestbodywithshippingaddress.md +33 -0
  15. package/docs/interfaces/stripeupepaymentinitializeoptions.md +9 -0
  16. package/docs/interfaces/stripev3paymentinitializeoptions.md +1 -1
  17. package/package.json +1 -1
  18. package/docs/interfaces/consignmentassignmentrequestbody.md +0 -40
package/docs/README.md CHANGED
@@ -142,7 +142,8 @@
142
142
  * [CheckoutStoreSelector](interfaces/checkoutstoreselector.md)
143
143
  * [CheckoutStoreStatusSelector](interfaces/checkoutstorestatusselector.md)
144
144
  * [Consignment](interfaces/consignment.md)
145
- * [ConsignmentAssignmentRequestBody](interfaces/consignmentassignmentrequestbody.md)
145
+ * [ConsignmentAssignmentBaseRequestBodyWithAddress](interfaces/consignmentassignmentbaserequestbodywithaddress.md)
146
+ * [ConsignmentAssignmentBaseRequestBodyWithShippingAddress](interfaces/consignmentassignmentbaserequestbodywithshippingaddress.md)
146
147
  * [ConsignmentCreateRequestBody](interfaces/consignmentcreaterequestbody.md)
147
148
  * [ConsignmentLineItem](interfaces/consignmentlineitem.md)
148
149
  * [ConsignmentPickupOption](interfaces/consignmentpickupoption.md)
@@ -348,6 +349,7 @@
348
349
  * [BraintreeFormFieldStyles](README.md#braintreeformfieldstyles)
349
350
  * [CheckoutIncludeParam](README.md#checkoutincludeparam)
350
351
  * [ComparableCheckout](README.md#comparablecheckout)
352
+ * [ConsignmentAssignmentRequestBody](README.md#consignmentassignmentrequestbody)
351
353
  * [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
352
354
  * [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
353
355
  * [FlashMessageType](README.md#flashmessagetype)
@@ -463,6 +465,12 @@ ___
463
465
 
464
466
  ___
465
467
 
468
+ ### ConsignmentAssignmentRequestBody
469
+
470
+ Ƭ **ConsignmentAssignmentRequestBody**: *[ConsignmentAssignmentBaseRequestBodyWithShippingAddress](interfaces/consignmentassignmentbaserequestbodywithshippingaddress.md) | [ConsignmentAssignmentBaseRequestBodyWithAddress](interfaces/consignmentassignmentbaserequestbodywithaddress.md)*
471
+
472
+ ___
473
+
466
474
  ### ConsignmentsRequestBody
467
475
 
468
476
  Ƭ **ConsignmentsRequestBody**: *[ConsignmentCreateRequestBody](interfaces/consignmentcreaterequestbody.md)[]*
package/docs/classes/checkoutservice.md CHANGED
@@ -149,7 +149,7 @@ ___
149
149
 
150
150
  ### assignItemsToAddress
151
151
 
152
- ▸ **assignItemsToAddress**(`consignment`: [ConsignmentAssignmentRequestBody](../interfaces/consignmentassignmentrequestbody.md), `options?`: [RequestOptions](../interfaces/requestoptions.md)): *Promise‹[CheckoutSelectors](../interfaces/checkoutselectors.md)›*
152
+ ▸ **assignItemsToAddress**(`consignment`: [ConsignmentAssignmentRequestBody](../README.md#consignmentassignmentrequestbody), `options?`: [RequestOptions](../interfaces/requestoptions.md)): *Promise‹[CheckoutSelectors](../interfaces/checkoutselectors.md)›*
153
153
 
154
154
  Convenience method that assigns items to be shipped to a specific address.
155
155
 
@@ -161,7 +161,7 @@ will be created.
161
161
 
162
162
  Name | Type | Description |
163
163
  ------ | ------ | ------ |
164
- `consignment` | [ConsignmentAssignmentRequestBody](../interfaces/consignmentassignmentrequestbody.md) | The consignment data that will be used. |
164
+ `consignment` | [ConsignmentAssignmentRequestBody](../README.md#consignmentassignmentrequestbody) | The consignment data that will be used. |
165
165
  `options?` | [RequestOptions](../interfaces/requestoptions.md) | Options for the request |
166
166
 
167
167
  **Returns:** *Promise‹[CheckoutSelectors](../interfaces/checkoutselectors.md)›*
@@ -311,7 +311,7 @@ checkoutService.createCustomerAddress({
311
311
  address1: '55 Market St',
312
312
  stateOrProvinceCode: 'CA',
313
313
  countryCode: 'US',
314
- postalCode: '90110'
314
+ postalCode: '90110',
315
315
  customFields: [],
316
316
  });
317
317
  ```
@@ -1350,7 +1350,7 @@ ___
1350
1350
 
1351
1351
  ### unassignItemsToAddress
1352
1352
 
1353
- ▸ **unassignItemsToAddress**(`consignment`: [ConsignmentAssignmentRequestBody](../interfaces/consignmentassignmentrequestbody.md), `options?`: [RequestOptions](../interfaces/requestoptions.md)): *Promise‹[CheckoutSelectors](../interfaces/checkoutselectors.md)›*
1353
+ ▸ **unassignItemsToAddress**(`consignment`: [ConsignmentAssignmentRequestBody](../README.md#consignmentassignmentrequestbody), `options?`: [RequestOptions](../interfaces/requestoptions.md)): *Promise‹[CheckoutSelectors](../interfaces/checkoutselectors.md)›*
1354
1354
 
1355
1355
  Convenience method that unassigns items from a specific shipping address.
1356
1356
 
@@ -1362,7 +1362,7 @@ after the unassignment, it will be deleted.
1362
1362
 
1363
1363
  Name | Type | Description |
1364
1364
  ------ | ------ | ------ |
1365
- `consignment` | [ConsignmentAssignmentRequestBody](../interfaces/consignmentassignmentrequestbody.md) | The consignment data that will be used. |
1365
+ `consignment` | [ConsignmentAssignmentRequestBody](../README.md#consignmentassignmentrequestbody) | The consignment data that will be used. |
1366
1366
  `options?` | [RequestOptions](../interfaces/requestoptions.md) | Options for the request |
1367
1367
 
1368
1368
  **Returns:** *Promise‹[CheckoutSelectors](../interfaces/checkoutselectors.md)›*
package/docs/interfaces/consignmentassignmentbaserequestbodywithaddress.md ADDED
@@ -0,0 +1,33 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) › [ConsignmentAssignmentBaseRequestBodyWithAddress](consignmentassignmentbaserequestbodywithaddress.md)
2
+
3
+ # Interface: ConsignmentAssignmentBaseRequestBodyWithAddress
4
+
5
+ ## Hierarchy
6
+
7
+ * **ConsignmentAssignmentBaseRequestBodyWithAddress**
8
+
9
+ ## Index
10
+
11
+ ### Properties
12
+
13
+ * [address](consignmentassignmentbaserequestbodywithaddress.md#address)
14
+ * [lineItems](consignmentassignmentbaserequestbodywithaddress.md#lineitems)
15
+ * [pickupOption](consignmentassignmentbaserequestbodywithaddress.md#optional-pickupoption)
16
+
17
+ ## Properties
18
+
19
+ ### address
20
+
21
+ • **address**: *[AddressRequestBody](addressrequestbody.md)*
22
+
23
+ ___
24
+
25
+ ### lineItems
26
+
27
+ • **lineItems**: *[ConsignmentLineItem](consignmentlineitem.md)[]*
28
+
29
+ ___
30
+
31
+ ### `Optional` pickupOption
32
+
33
+ • **pickupOption**? : *[ConsignmentPickupOption](consignmentpickupoption.md)*
package/docs/interfaces/consignmentassignmentbaserequestbodywithshippingaddress.md ADDED
@@ -0,0 +1,33 @@
1
+ [@bigcommerce/checkout-sdk](../README.md) › [ConsignmentAssignmentBaseRequestBodyWithShippingAddress](consignmentassignmentbaserequestbodywithshippingaddress.md)
2
+
3
+ # Interface: ConsignmentAssignmentBaseRequestBodyWithShippingAddress
4
+
5
+ ## Hierarchy
6
+
7
+ * **ConsignmentAssignmentBaseRequestBodyWithShippingAddress**
8
+
9
+ ## Index
10
+
11
+ ### Properties
12
+
13
+ * [lineItems](consignmentassignmentbaserequestbodywithshippingaddress.md#lineitems)
14
+ * [pickupOption](consignmentassignmentbaserequestbodywithshippingaddress.md#optional-pickupoption)
15
+ * [shippingAddress](consignmentassignmentbaserequestbodywithshippingaddress.md#shippingaddress)
16
+
17
+ ## Properties
18
+
19
+ ### lineItems
20
+
21
+ • **lineItems**: *[ConsignmentLineItem](consignmentlineitem.md)[]*
22
+
23
+ ___
24
+
25
+ ### `Optional` pickupOption
26
+
27
+ • **pickupOption**? : *[ConsignmentPickupOption](consignmentpickupoption.md)*
28
+
29
+ ___
30
+
31
+ ### shippingAddress
32
+
33
+ • **shippingAddress**: *[AddressRequestBody](addressrequestbody.md)*
package/docs/interfaces/stripeupepaymentinitializeoptions.md CHANGED
@@ -31,6 +31,7 @@ service.initializePayment({
31
31
  ### Properties
32
32
 
33
33
  * [containerId](stripeupepaymentinitializeoptions.md#containerid)
34
+ * [style](stripeupepaymentinitializeoptions.md#optional-style)
34
35
 
35
36
  ## Properties
36
37
 
@@ -39,3 +40,11 @@ service.initializePayment({
39
40
  • **containerId**: *string*
40
41
 
41
42
  The location to insert the credit card number form field.
43
+
44
+ ___
45
+
46
+ ### `Optional` style
47
+
48
+ • **style**? : *undefined | object*
49
+
50
+ Checkout styles from store theme
package/docs/interfaces/stripev3paymentinitializeoptions.md CHANGED
@@ -35,7 +35,7 @@ service.initializePayment({
35
35
  },
36
36
  iban: {
37
37
  classes: { base: 'form-input' },
38
- supportedCountries: ['SEPA],
38
+ supportedCountries: ['SEPA'],
39
39
  },
40
40
  idealBank: {
41
41
  classes: { base: 'form-input' },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigcommerce/checkout-sdk",
3
- "version": "1.237.2",
3
+ "version": "1.238.1",
4
4
  "description": "BigCommerce Checkout JavaScript SDK",
5
5
  "license": "MIT",
6
6
  "main": "dist/checkout-sdk.js",
package/docs/interfaces/consignmentassignmentrequestbody.md DELETED
@@ -1,40 +0,0 @@
1
- [@bigcommerce/checkout-sdk](../README.md) › [ConsignmentAssignmentRequestBody](consignmentassignmentrequestbody.md)
2
-
3
- # Interface: ConsignmentAssignmentRequestBody
4
-
5
- ## Hierarchy
6
-
7
- * **ConsignmentAssignmentRequestBody**
8
-
9
- ## Index
10
-
11
- ### Properties
12
-
13
- * [address](consignmentassignmentrequestbody.md#address)
14
- * [lineItems](consignmentassignmentrequestbody.md#lineitems)
15
- * [pickupOption](consignmentassignmentrequestbody.md#optional-pickupoption)
16
- * [shippingAddress](consignmentassignmentrequestbody.md#optional-shippingaddress)
17
-
18
- ## Properties
19
-
20
- ### address
21
-
22
- • **address**: *[AddressRequestBody](addressrequestbody.md)*
23
-
24
- ___
25
-
26
- ### lineItems
27
-
28
- • **lineItems**: *[ConsignmentLineItem](consignmentlineitem.md)[]*
29
-
30
- ___
31
-
32
- ### `Optional` pickupOption
33
-
34
- • **pickupOption**? : *[ConsignmentPickupOption](consignmentpickupoption.md)*
35
-
36
- ___
37
-
38
- ### `Optional` shippingAddress
39
-
40
- • **shippingAddress**? : *[AddressRequestBody](addressrequestbody.md)*