@marteye/studiojs 1.1.48 → 1.1.49-beta.0

package/README.md

@@ -1,130 +1,52 @@
-# MartEye Studio JavaScript SDK (`@marteye/studiojs`)
+# MartEye Studio JavaScript SDK (@marteye/studiojs)
 
-JavaScript/TypeScript SDK for the MartEye Studio API.
+This library is a JavaScript SDK that allows you to easily integrate with MartEye Studio's API. It provides methods to interact with various resources, manage data, and leverage the powerful features offered by MartEye Studio.
 
 ## Installation
 
-```bash
-npm install @marteye/studiojs
-```
+You can install the library using npm or yarn:
 
-For the beta release channel:
+Using npm:
 
 ```bash
-npm install @marteye/studiojs@beta
-```
-
-## Create a client
-
-```ts
-import Studio from "@marteye/studiojs";
-
-const studio = Studio({
-  apiKey: process.env.STUDIO_API_KEY!,
-  baseUrl: "https://app.marteyestudio.com/api", // optional
-  defaultTimeout: 30000, // optional
-  debug: false, // optional
-});
+npm install @marteye/studiojs
 ```
 
-## Basic usage
-
-```ts
-const market = await studio.markets.get("greenfields");
-console.log(market.name);
+Using yarn:
 
-const sales = await studio.sales.list("greenfields", {
-  start: "2026-01-01",
-  end: "2026-12-31",
-});
-
-console.log(sales.sales.length);
+```bash
+yarn add @marteye/studiojs
 ```
 
-## Messaging
+## Usage
 
-StudioJS now exposes a single messaging interface:
+### Importing the Library
 
-- `studio.broadcast.send(...)`
-- `studio.broadcast.get(...)`
+Using ES Modules:
 
-Messaging is unified by:
-
-- `type`: `"sms" | "email"`
-- `kind`: `"broadcast" | "statement"`
-
-### Send an SMS broadcast
-
-```ts
-await studio.broadcast.send("greenfields", {
-  type: "sms",
-  kind: "broadcast",
-  message: "Sale starts at 7pm",
-  recipients: [
-    {
-      customerId: "customer-1",
-      phoneNumbers: ["+447911123456"],
-    },
-  ],
-});
-```
-
-### Send a statement email
-
-```ts
-await studio.broadcast.send("greenfields", {
-  type: "email",
-  kind: "statement",
-  message: "Dear {{customerName}}, your balance is {{balance}}.",
-  recipients: [
-    {
-      customerId: "customer-1",
-      emails: ["buyer@example.com"],
-    },
-  ],
-});
+```javascript
+import StudioJS from "@marteye/studiojs";
 ```
 
-### Get task status
+Or using CommonJS:
 
-```ts
-const task = await studio.broadcast.get("greenfields", "sms", "task-id");
-console.log(task.status);
+```javascript
+let StudioJS = require("@marteye/studiojs");
 ```
 
-## Migration note
+### Initializing the SDK
 
-`studio.sms` has been removed in favour of `studio.broadcast`.
+Before using the library, initialize it with your API key. For more information on obtaining an API key, please contact your MartEye representative.
 
-### Before
-
-```ts
-await studio.sms.sendSMS(marketId, payload);
-await studio.sms.getSMS(marketId, smsId);
-```
-
-### After
-
-```ts
-await studio.broadcast.send(marketId, {
-  type: "sms",
-  kind: "broadcast",
-  message: "Hello",
-  recipients: [{ customerId: "c1", phoneNumbers: ["+447911123456"] }],
+```javascript
+let studioClient = StudioJS.init({
+  apiKey: "YOUR_API_KEY_HERE",
 });
-
-await studio.broadcast.get(marketId, "sms", taskId);
 ```
 
-## Types
-
-Relevant exported types include:
+## Contributing
 
-- `BroadcastPayload`
-- `BroadcastSendResponse`
-- `BroadcastTask`
-- `SMSTask`
-- `EmailTask`
+Contributions are welcome! Please open an issue or submit a pull request if you have suggestions or improvements.
 
 ## License
 

package/dist/index.common.d.ts

@@ -9,3 +9,4 @@ export type { ChunkedFile, MediaUploadOptions, FileInput, ChunkedInput };
 import * as StudioTypes from "./types";
 export { StudioTypes };
 export * from "./createApp";
+export * from "./media-crate-client";