ce-storefront 0.9.2 → 0.10.0
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.
- package/README.md +6 -55
- package/bin/mcp-server.js +763 -2034
- package/bin/mcp-server.js.map +22 -45
- package/docs/sdks/carts/README.md +164 -0
- package/docs/sdks/customers/README.md +79 -77
- package/esm/funcs/{kycCreateDocument.d.ts → cartsRedeemLoyaltyPoints.d.ts} +4 -4
- package/esm/funcs/cartsRedeemLoyaltyPoints.d.ts.map +1 -0
- package/esm/funcs/{kycVerifyDocument.js → cartsRedeemLoyaltyPoints.js} +9 -9
- package/esm/funcs/cartsRedeemLoyaltyPoints.js.map +1 -0
- package/esm/funcs/{kycListDocuments.d.ts → cartsRemoveLoyaltyPoints.d.ts} +4 -4
- package/esm/funcs/cartsRemoveLoyaltyPoints.d.ts.map +1 -0
- package/esm/funcs/{kycListDocuments.js → cartsRemoveLoyaltyPoints.js} +9 -9
- package/esm/funcs/cartsRemoveLoyaltyPoints.js.map +1 -0
- package/esm/funcs/{kycListKycDocument.d.ts → customersGetLoyaltyDetails.d.ts} +4 -4
- package/esm/funcs/customersGetLoyaltyDetails.d.ts.map +1 -0
- package/esm/funcs/{kycGetDocument.js → customersGetLoyaltyDetails.js} +10 -14
- package/esm/funcs/customersGetLoyaltyDetails.js.map +1 -0
- package/esm/lib/config.d.ts +4 -4
- package/esm/lib/config.js +4 -4
- package/esm/lib/config.js.map +1 -1
- package/esm/mcp-server/mcp-server.js +1 -1
- package/esm/mcp-server/mcp-server.js.map +1 -1
- package/esm/mcp-server/server.d.ts.map +1 -1
- package/esm/mcp-server/server.js +7 -17
- package/esm/mcp-server/server.js.map +1 -1
- package/esm/mcp-server/tools/cartsRedeemLoyaltyPoints.d.ts +8 -0
- package/esm/mcp-server/tools/cartsRedeemLoyaltyPoints.d.ts.map +1 -0
- package/esm/mcp-server/tools/{kycListDocuments.js → cartsRedeemLoyaltyPoints.js} +8 -8
- package/esm/mcp-server/tools/cartsRedeemLoyaltyPoints.js.map +1 -0
- package/esm/mcp-server/tools/cartsRemoveLoyaltyPoints.d.ts +8 -0
- package/esm/mcp-server/tools/cartsRemoveLoyaltyPoints.d.ts.map +1 -0
- package/esm/mcp-server/tools/{kycGetDocument.js → cartsRemoveLoyaltyPoints.js} +8 -8
- package/esm/mcp-server/tools/cartsRemoveLoyaltyPoints.js.map +1 -0
- package/esm/mcp-server/tools/customersGetLoyaltyDetails.d.ts +8 -0
- package/esm/mcp-server/tools/customersGetLoyaltyDetails.d.ts.map +1 -0
- package/esm/mcp-server/tools/{kycCreateDocument.js → customersGetLoyaltyDetails.js} +8 -8
- package/esm/mcp-server/tools/customersGetLoyaltyDetails.js.map +1 -0
- package/esm/models/components/customerloyalty.d.ts +41 -0
- package/esm/models/components/customerloyalty.d.ts.map +1 -0
- package/esm/models/components/customerloyalty.js +64 -0
- package/esm/models/components/customerloyalty.js.map +1 -0
- package/esm/models/components/index.d.ts +1 -6
- package/esm/models/components/index.d.ts.map +1 -1
- package/esm/models/components/index.js +1 -6
- package/esm/models/components/index.js.map +1 -1
- package/esm/models/operations/createorder.d.ts +14 -14
- package/esm/models/operations/createorder.d.ts.map +1 -1
- package/esm/models/operations/createorder.js +12 -12
- package/esm/models/operations/createorder.js.map +1 -1
- package/esm/models/operations/getaddressdetail.d.ts +15 -15
- package/esm/models/operations/getaddressdetail.d.ts.map +1 -1
- package/esm/models/operations/getaddressdetail.js +15 -17
- package/esm/models/operations/getaddressdetail.js.map +1 -1
- package/esm/models/operations/getloyaltydetails.d.ts +92 -0
- package/esm/models/operations/getloyaltydetails.d.ts.map +1 -0
- package/esm/models/operations/getloyaltydetails.js +105 -0
- package/esm/models/operations/getloyaltydetails.js.map +1 -0
- package/esm/models/operations/getorderdetail.d.ts +6 -6
- package/esm/models/operations/getorderdetail.d.ts.map +1 -1
- package/esm/models/operations/getorderdetail.js +6 -6
- package/esm/models/operations/getorderdetail.js.map +1 -1
- package/esm/models/operations/index.d.ts +3 -8
- package/esm/models/operations/index.d.ts.map +1 -1
- package/esm/models/operations/index.js +3 -8
- package/esm/models/operations/index.js.map +1 -1
- package/esm/models/operations/redeemloyaltypoints.d.ts +120 -0
- package/esm/models/operations/redeemloyaltypoints.d.ts.map +1 -0
- package/esm/models/operations/redeemloyaltypoints.js +130 -0
- package/esm/models/operations/redeemloyaltypoints.js.map +1 -0
- package/esm/models/operations/removeloyaltypoints.d.ts +93 -0
- package/esm/models/operations/removeloyaltypoints.d.ts.map +1 -0
- package/esm/models/operations/removeloyaltypoints.js +86 -0
- package/esm/models/operations/removeloyaltypoints.js.map +1 -0
- package/esm/models/operations/retryorderpayment.d.ts +14 -12
- package/esm/models/operations/retryorderpayment.d.ts.map +1 -1
- package/esm/models/operations/retryorderpayment.js +12 -10
- package/esm/models/operations/retryorderpayment.js.map +1 -1
- package/esm/sdk/carts.d.ts +14 -0
- package/esm/sdk/carts.d.ts.map +1 -1
- package/esm/sdk/carts.js +20 -0
- package/esm/sdk/carts.js.map +1 -1
- package/esm/sdk/customers.d.ts +7 -7
- package/esm/sdk/customers.d.ts.map +1 -1
- package/esm/sdk/customers.js +10 -10
- package/esm/sdk/customers.js.map +1 -1
- package/esm/sdk/sdk.d.ts +0 -3
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +0 -4
- package/esm/sdk/sdk.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/{kycVerifyDocument.ts → cartsRedeemLoyaltyPoints.ts} +19 -14
- package/src/funcs/{kycListDocuments.ts → cartsRemoveLoyaltyPoints.ts} +15 -18
- package/src/funcs/{kycGetDocument.ts → customersGetLoyaltyDetails.ts} +14 -24
- package/src/lib/config.ts +4 -4
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +7 -17
- package/src/mcp-server/tools/{kycListDocuments.ts → cartsRedeemLoyaltyPoints.ts} +7 -7
- package/src/mcp-server/tools/{kycDeleteDocument.ts → cartsRemoveLoyaltyPoints.ts} +7 -7
- package/src/mcp-server/tools/{kycCreateDocument.ts → customersGetLoyaltyDetails.ts} +7 -7
- package/src/models/components/customerloyalty.ts +109 -0
- package/src/models/components/index.ts +1 -6
- package/src/models/operations/createorder.ts +26 -28
- package/src/models/operations/getaddressdetail.ts +57 -66
- package/src/models/operations/getloyaltydetails.ts +220 -0
- package/src/models/operations/getorderdetail.ts +12 -12
- package/src/models/operations/index.ts +3 -8
- package/src/models/operations/redeemloyaltypoints.ts +283 -0
- package/src/models/operations/removeloyaltypoints.ts +202 -0
- package/src/models/operations/retryorderpayment.ts +26 -24
- package/src/sdk/carts.ts +36 -0
- package/src/sdk/customers.ts +18 -18
- package/src/sdk/sdk.ts +0 -6
- package/docs/sdks/kyc/README.md +0 -566
- package/esm/funcs/customersListAddresses.d.ts +0 -16
- package/esm/funcs/customersListAddresses.d.ts.map +0 -1
- package/esm/funcs/customersListAddresses.js +0 -86
- package/esm/funcs/customersListAddresses.js.map +0 -1
- package/esm/funcs/kycCreateDocument.d.ts.map +0 -1
- package/esm/funcs/kycCreateDocument.js +0 -110
- package/esm/funcs/kycCreateDocument.js.map +0 -1
- package/esm/funcs/kycDeleteDocument.d.ts +0 -17
- package/esm/funcs/kycDeleteDocument.d.ts.map +0 -1
- package/esm/funcs/kycDeleteDocument.js +0 -89
- package/esm/funcs/kycDeleteDocument.js.map +0 -1
- package/esm/funcs/kycGetDocument.d.ts +0 -17
- package/esm/funcs/kycGetDocument.d.ts.map +0 -1
- package/esm/funcs/kycGetDocument.js.map +0 -1
- package/esm/funcs/kycListDocuments.d.ts.map +0 -1
- package/esm/funcs/kycListDocuments.js.map +0 -1
- package/esm/funcs/kycListKycDocument.d.ts.map +0 -1
- package/esm/funcs/kycListKycDocument.js +0 -70
- package/esm/funcs/kycListKycDocument.js.map +0 -1
- package/esm/funcs/kycUpdateDocument.d.ts +0 -17
- package/esm/funcs/kycUpdateDocument.d.ts.map +0 -1
- package/esm/funcs/kycUpdateDocument.js +0 -115
- package/esm/funcs/kycUpdateDocument.js.map +0 -1
- package/esm/funcs/kycVerifyDocument.d.ts +0 -17
- package/esm/funcs/kycVerifyDocument.d.ts.map +0 -1
- package/esm/funcs/kycVerifyDocument.js.map +0 -1
- package/esm/mcp-server/tools/customersListAddresses.d.ts +0 -8
- package/esm/mcp-server/tools/customersListAddresses.d.ts.map +0 -1
- package/esm/mcp-server/tools/customersListAddresses.js +0 -28
- package/esm/mcp-server/tools/customersListAddresses.js.map +0 -1
- package/esm/mcp-server/tools/kycCreateDocument.d.ts +0 -8
- package/esm/mcp-server/tools/kycCreateDocument.d.ts.map +0 -1
- package/esm/mcp-server/tools/kycCreateDocument.js.map +0 -1
- package/esm/mcp-server/tools/kycDeleteDocument.d.ts +0 -8
- package/esm/mcp-server/tools/kycDeleteDocument.d.ts.map +0 -1
- package/esm/mcp-server/tools/kycDeleteDocument.js +0 -28
- package/esm/mcp-server/tools/kycDeleteDocument.js.map +0 -1
- package/esm/mcp-server/tools/kycGetDocument.d.ts +0 -8
- package/esm/mcp-server/tools/kycGetDocument.d.ts.map +0 -1
- package/esm/mcp-server/tools/kycGetDocument.js.map +0 -1
- package/esm/mcp-server/tools/kycListDocuments.d.ts +0 -8
- package/esm/mcp-server/tools/kycListDocuments.d.ts.map +0 -1
- package/esm/mcp-server/tools/kycListDocuments.js.map +0 -1
- package/esm/mcp-server/tools/kycListKycDocument.d.ts +0 -3
- package/esm/mcp-server/tools/kycListKycDocument.d.ts.map +0 -1
- package/esm/mcp-server/tools/kycListKycDocument.js +0 -23
- package/esm/mcp-server/tools/kycListKycDocument.js.map +0 -1
- package/esm/mcp-server/tools/kycUpdateDocument.d.ts +0 -8
- package/esm/mcp-server/tools/kycUpdateDocument.d.ts.map +0 -1
- package/esm/mcp-server/tools/kycUpdateDocument.js +0 -28
- package/esm/mcp-server/tools/kycUpdateDocument.js.map +0 -1
- package/esm/mcp-server/tools/kycVerifyDocument.d.ts +0 -8
- package/esm/mcp-server/tools/kycVerifyDocument.d.ts.map +0 -1
- package/esm/mcp-server/tools/kycVerifyDocument.js +0 -28
- package/esm/mcp-server/tools/kycVerifyDocument.js.map +0 -1
- package/esm/models/components/document.d.ts +0 -164
- package/esm/models/components/document.d.ts.map +0 -1
- package/esm/models/components/document.js +0 -172
- package/esm/models/components/document.js.map +0 -1
- package/esm/models/components/documentinput.d.ts +0 -65
- package/esm/models/components/documentinput.d.ts.map +0 -1
- package/esm/models/components/documentinput.js +0 -87
- package/esm/models/components/documentinput.js.map +0 -1
- package/esm/models/components/gstindetail.d.ts +0 -29
- package/esm/models/components/gstindetail.d.ts.map +0 -1
- package/esm/models/components/gstindetail.js +0 -31
- package/esm/models/components/gstindetail.js.map +0 -1
- package/esm/models/components/kycdocument.d.ts +0 -103
- package/esm/models/components/kycdocument.d.ts.map +0 -1
- package/esm/models/components/kycdocument.js +0 -101
- package/esm/models/components/kycdocument.js.map +0 -1
- package/esm/models/components/pandetail.d.ts +0 -29
- package/esm/models/components/pandetail.d.ts.map +0 -1
- package/esm/models/components/pandetail.js +0 -31
- package/esm/models/components/pandetail.js.map +0 -1
- package/esm/models/components/updatedocument.d.ts +0 -67
- package/esm/models/components/updatedocument.d.ts.map +0 -1
- package/esm/models/components/updatedocument.js +0 -91
- package/esm/models/components/updatedocument.js.map +0 -1
- package/esm/models/operations/createdocument.d.ts +0 -92
- package/esm/models/operations/createdocument.d.ts.map +0 -1
- package/esm/models/operations/createdocument.js +0 -97
- package/esm/models/operations/createdocument.js.map +0 -1
- package/esm/models/operations/deletedocument.d.ts +0 -67
- package/esm/models/operations/deletedocument.d.ts.map +0 -1
- package/esm/models/operations/deletedocument.js +0 -69
- package/esm/models/operations/deletedocument.js.map +0 -1
- package/esm/models/operations/getdocument.d.ts +0 -95
- package/esm/models/operations/getdocument.d.ts.map +0 -1
- package/esm/models/operations/getdocument.js +0 -97
- package/esm/models/operations/getdocument.js.map +0 -1
- package/esm/models/operations/listaddresses.d.ts +0 -183
- package/esm/models/operations/listaddresses.d.ts.map +0 -1
- package/esm/models/operations/listaddresses.js +0 -190
- package/esm/models/operations/listaddresses.js.map +0 -1
- package/esm/models/operations/listdocuments.d.ts +0 -90
- package/esm/models/operations/listdocuments.d.ts.map +0 -1
- package/esm/models/operations/listdocuments.js +0 -86
- package/esm/models/operations/listdocuments.js.map +0 -1
- package/esm/models/operations/listkycdocument.d.ts +0 -64
- package/esm/models/operations/listkycdocument.d.ts.map +0 -1
- package/esm/models/operations/listkycdocument.js +0 -74
- package/esm/models/operations/listkycdocument.js.map +0 -1
- package/esm/models/operations/updatedocument.d.ts +0 -97
- package/esm/models/operations/updatedocument.d.ts.map +0 -1
- package/esm/models/operations/updatedocument.js +0 -101
- package/esm/models/operations/updatedocument.js.map +0 -1
- package/esm/models/operations/verifydocument.d.ts +0 -140
- package/esm/models/operations/verifydocument.d.ts.map +0 -1
- package/esm/models/operations/verifydocument.js +0 -168
- package/esm/models/operations/verifydocument.js.map +0 -1
- package/esm/sdk/kyc.d.ts +0 -54
- package/esm/sdk/kyc.d.ts.map +0 -1
- package/esm/sdk/kyc.js +0 -78
- package/esm/sdk/kyc.js.map +0 -1
- package/src/funcs/customersListAddresses.ts +0 -166
- package/src/funcs/kycCreateDocument.ts +0 -207
- package/src/funcs/kycDeleteDocument.ts +0 -183
- package/src/funcs/kycListKycDocument.ts +0 -153
- package/src/funcs/kycUpdateDocument.ts +0 -214
- package/src/mcp-server/tools/customersListAddresses.ts +0 -37
- package/src/mcp-server/tools/kycGetDocument.ts +0 -37
- package/src/mcp-server/tools/kycListKycDocument.ts +0 -30
- package/src/mcp-server/tools/kycUpdateDocument.ts +0 -37
- package/src/mcp-server/tools/kycVerifyDocument.ts +0 -37
- package/src/models/components/document.ts +0 -260
- package/src/models/components/documentinput.ts +0 -154
- package/src/models/components/gstindetail.ts +0 -62
- package/src/models/components/kycdocument.ts +0 -161
- package/src/models/components/pandetail.ts +0 -62
- package/src/models/components/updatedocument.ts +0 -168
- package/src/models/operations/createdocument.ts +0 -210
- package/src/models/operations/deletedocument.ts +0 -150
- package/src/models/operations/getdocument.ts +0 -213
- package/src/models/operations/listaddresses.ts +0 -395
- package/src/models/operations/listdocuments.ts +0 -197
- package/src/models/operations/listkycdocument.ts +0 -153
- package/src/models/operations/updatedocument.ts +0 -219
- package/src/models/operations/verifydocument.ts +0 -346
- package/src/sdk/kyc.ts +0 -133
package/README.md
CHANGED
|
@@ -17,7 +17,6 @@ Commerce Engine Storefront APIs
|
|
|
17
17
|
* [SDK Example Usage](#sdk-example-usage)
|
|
18
18
|
* [Available Resources and Operations](#available-resources-and-operations)
|
|
19
19
|
* [Standalone functions](#standalone-functions)
|
|
20
|
-
* [File uploads](#file-uploads)
|
|
21
20
|
* [Retries](#retries)
|
|
22
21
|
* [Error Handling](#error-handling)
|
|
23
22
|
* [Server Selection](#server-selection)
|
|
@@ -220,6 +219,8 @@ run();
|
|
|
220
219
|
* [createCartAddress](docs/sdks/carts/README.md#createcartaddress) - Update cart address
|
|
221
220
|
* [applyCoupon](docs/sdks/carts/README.md#applycoupon) - Apply coupon
|
|
222
221
|
* [removeCoupon](docs/sdks/carts/README.md#removecoupon) - Remove coupon
|
|
222
|
+
* [redeemLoyaltyPoints](docs/sdks/carts/README.md#redeemloyaltypoints) - Redeem loyalty points
|
|
223
|
+
* [removeLoyaltyPoints](docs/sdks/carts/README.md#removeloyaltypoints) - Remove loyalty points
|
|
223
224
|
|
|
224
225
|
### [catalog](docs/sdks/catalog/README.md)
|
|
225
226
|
|
|
@@ -242,23 +243,13 @@ run();
|
|
|
242
243
|
|
|
243
244
|
### [customers](docs/sdks/customers/README.md)
|
|
244
245
|
|
|
245
|
-
* [listAddresses](docs/sdks/customers/README.md#listaddresses) - Retrieve all addresses
|
|
246
246
|
* [createAddress](docs/sdks/customers/README.md#createaddress) - Create address
|
|
247
247
|
* [getAddressDetail](docs/sdks/customers/README.md#getaddressdetail) - Retrieve particular address
|
|
248
248
|
* [updateAddressDetail](docs/sdks/customers/README.md#updateaddressdetail) - Update particular address
|
|
249
249
|
* [deleteAddress](docs/sdks/customers/README.md#deleteaddress) - Remove particular address
|
|
250
|
+
* [getLoyaltyDetails](docs/sdks/customers/README.md#getloyaltydetails) - Retrieve loyalty details
|
|
250
251
|
* [listUserReviews](docs/sdks/customers/README.md#listuserreviews) - Retrieve all reviews
|
|
251
252
|
|
|
252
|
-
### [kyc](docs/sdks/kyc/README.md)
|
|
253
|
-
|
|
254
|
-
* [listKycDocument](docs/sdks/kyc/README.md#listkycdocument) - List all kyc documents
|
|
255
|
-
* [listDocuments](docs/sdks/kyc/README.md#listdocuments) - List all documents
|
|
256
|
-
* [createDocument](docs/sdks/kyc/README.md#createdocument) - Create document
|
|
257
|
-
* [getDocument](docs/sdks/kyc/README.md#getdocument) - Retrieve document detail
|
|
258
|
-
* [updateDocument](docs/sdks/kyc/README.md#updatedocument) - Update document detail
|
|
259
|
-
* [deleteDocument](docs/sdks/kyc/README.md#deletedocument) - Delete document
|
|
260
|
-
* [verifyDocument](docs/sdks/kyc/README.md#verifydocument) - Verify document
|
|
261
|
-
|
|
262
253
|
### [orders](docs/sdks/orders/README.md)
|
|
263
254
|
|
|
264
255
|
* [createOrder](docs/sdks/orders/README.md#createorder) - Create order
|
|
@@ -312,7 +303,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
312
303
|
- [`cartsDeleteCart`](docs/sdks/carts/README.md#deletecart) - Delete cart
|
|
313
304
|
- [`cartsGetCart`](docs/sdks/carts/README.md#getcart) - Retrieve cart detail
|
|
314
305
|
- [`cartsGetUserCart`](docs/sdks/carts/README.md#getusercart) - Retrieve cart using user id
|
|
306
|
+
- [`cartsRedeemLoyaltyPoints`](docs/sdks/carts/README.md#redeemloyaltypoints) - Redeem loyalty points
|
|
315
307
|
- [`cartsRemoveCoupon`](docs/sdks/carts/README.md#removecoupon) - Remove coupon
|
|
308
|
+
- [`cartsRemoveLoyaltyPoints`](docs/sdks/carts/README.md#removeloyaltypoints) - Remove loyalty points
|
|
316
309
|
- [`cartsRemoveUserCart`](docs/sdks/carts/README.md#removeusercart) - Delete cart using user id
|
|
317
310
|
- [`cartsUpdateCart`](docs/sdks/carts/README.md#updatecart) - Add/delete cart item
|
|
318
311
|
- [`catalogGetProductDetail`](docs/sdks/catalog/README.md#getproductdetail) - Retrieve a product detail
|
|
@@ -330,16 +323,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
330
323
|
- [`customersCreateAddress`](docs/sdks/customers/README.md#createaddress) - Create address
|
|
331
324
|
- [`customersDeleteAddress`](docs/sdks/customers/README.md#deleteaddress) - Remove particular address
|
|
332
325
|
- [`customersGetAddressDetail`](docs/sdks/customers/README.md#getaddressdetail) - Retrieve particular address
|
|
333
|
-
- [`
|
|
326
|
+
- [`customersGetLoyaltyDetails`](docs/sdks/customers/README.md#getloyaltydetails) - Retrieve loyalty details
|
|
334
327
|
- [`customersListUserReviews`](docs/sdks/customers/README.md#listuserreviews) - Retrieve all reviews
|
|
335
328
|
- [`customersUpdateAddressDetail`](docs/sdks/customers/README.md#updateaddressdetail) - Update particular address
|
|
336
|
-
- [`kycCreateDocument`](docs/sdks/kyc/README.md#createdocument) - Create document
|
|
337
|
-
- [`kycDeleteDocument`](docs/sdks/kyc/README.md#deletedocument) - Delete document
|
|
338
|
-
- [`kycGetDocument`](docs/sdks/kyc/README.md#getdocument) - Retrieve document detail
|
|
339
|
-
- [`kycListDocuments`](docs/sdks/kyc/README.md#listdocuments) - List all documents
|
|
340
|
-
- [`kycListKycDocument`](docs/sdks/kyc/README.md#listkycdocument) - List all kyc documents
|
|
341
|
-
- [`kycUpdateDocument`](docs/sdks/kyc/README.md#updatedocument) - Update document detail
|
|
342
|
-
- [`kycVerifyDocument`](docs/sdks/kyc/README.md#verifydocument) - Verify document
|
|
343
329
|
- [`ordersCancelOrder`](docs/sdks/orders/README.md#cancelorder) - Cancel order
|
|
344
330
|
- [`ordersCreateOrder`](docs/sdks/orders/README.md#createorder) - Create order
|
|
345
331
|
- [`ordersGetOrderDetail`](docs/sdks/orders/README.md#getorderdetail) - Retrieve order detail
|
|
@@ -352,41 +338,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
352
338
|
</details>
|
|
353
339
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
354
340
|
|
|
355
|
-
<!-- Start File uploads [file-upload] -->
|
|
356
|
-
## File uploads
|
|
357
|
-
|
|
358
|
-
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
|
|
359
|
-
|
|
360
|
-
> [!TIP]
|
|
361
|
-
>
|
|
362
|
-
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
|
|
363
|
-
>
|
|
364
|
-
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
|
|
365
|
-
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
|
|
366
|
-
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
|
|
367
|
-
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
|
|
368
|
-
|
|
369
|
-
```typescript
|
|
370
|
-
import { CeStorefront } from "ce-storefront";
|
|
371
|
-
|
|
372
|
-
const ceStorefront = new CeStorefront({
|
|
373
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
374
|
-
});
|
|
375
|
-
|
|
376
|
-
async function run() {
|
|
377
|
-
const result = await ceStorefront.kyc.createDocument({
|
|
378
|
-
id: "<id>",
|
|
379
|
-
});
|
|
380
|
-
|
|
381
|
-
// Handle the result
|
|
382
|
-
console.log(result);
|
|
383
|
-
}
|
|
384
|
-
|
|
385
|
-
run();
|
|
386
|
-
|
|
387
|
-
```
|
|
388
|
-
<!-- End File uploads [file-upload] -->
|
|
389
|
-
|
|
390
341
|
<!-- Start Retries [retries] -->
|
|
391
342
|
## Retries
|
|
392
343
|
|