ce-storefront 0.8.2 → 0.9.0

package/README.md

@@ -17,6 +17,7 @@ Commerce Engine Storefront APIs
   * [SDK Example Usage](#sdk-example-usage)
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
+  * [File uploads](#file-uploads)
   * [Retries](#retries)
   * [Error Handling](#error-handling)
   * [Server Selection](#server-selection)
@@ -248,6 +249,16 @@ run();
 * [deleteAddress](docs/sdks/customers/README.md#deleteaddress) - Remove particular address
 * [listUserReviews](docs/sdks/customers/README.md#listuserreviews) - Retrieve all reviews
 
+### [kyc](docs/sdks/kyc/README.md)
+
+* [listDocumentType](docs/sdks/kyc/README.md#listdocumenttype) - List all document types
+* [listDocuments](docs/sdks/kyc/README.md#listdocuments) - List all documents
+* [createDocument](docs/sdks/kyc/README.md#createdocument) - Create document
+* [getDocument](docs/sdks/kyc/README.md#getdocument) - Retrieve document detail
+* [updateDocument](docs/sdks/kyc/README.md#updatedocument) - Update document detail
+* [deleteDocument](docs/sdks/kyc/README.md#deletedocument) - Delete document
+* [verifyDocument](docs/sdks/kyc/README.md#verifydocument) - Verify document
+
 ### [orders](docs/sdks/orders/README.md)
 
 * [createOrder](docs/sdks/orders/README.md#createorder) - Create order
@@ -322,6 +333,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`customersListAddresses`](docs/sdks/customers/README.md#listaddresses) - Retrieve all addresses
 - [`customersListUserReviews`](docs/sdks/customers/README.md#listuserreviews) - Retrieve all reviews
 - [`customersUpdateAddressDetail`](docs/sdks/customers/README.md#updateaddressdetail) - Update particular address
+- [`kycCreateDocument`](docs/sdks/kyc/README.md#createdocument) - Create document
+- [`kycDeleteDocument`](docs/sdks/kyc/README.md#deletedocument) - Delete document
+- [`kycGetDocument`](docs/sdks/kyc/README.md#getdocument) - Retrieve document detail
+- [`kycListDocuments`](docs/sdks/kyc/README.md#listdocuments) - List all documents
+- [`kycListDocumentType`](docs/sdks/kyc/README.md#listdocumenttype) - List all document types
+- [`kycUpdateDocument`](docs/sdks/kyc/README.md#updatedocument) - Update document detail
+- [`kycVerifyDocument`](docs/sdks/kyc/README.md#verifydocument) - Verify document
 - [`ordersCancelOrder`](docs/sdks/orders/README.md#cancelorder) - Cancel order
 - [`ordersCreateOrder`](docs/sdks/orders/README.md#createorder) - Create order
 - [`ordersGetOrderDetail`](docs/sdks/orders/README.md#getorderdetail) - Retrieve order detail
@@ -334,6 +352,41 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
 
+<!-- Start File uploads [file-upload] -->
+## File uploads
+
+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.
+
+> [!TIP]
+>
+> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
+>
+> - **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).
+> - **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.
+> - **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.
+> - **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).
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await ceStorefront.kyc.createDocument({
+    id: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End File uploads [file-upload] -->
+
 <!-- Start Retries [retries] -->
 ## Retries