@marteye/studiojs 1.1.47 → 1.1.48-beta.1

package/README.md

@@ -1,52 +1,130 @@
-# MartEye Studio JavaScript SDK (@marteye/studiojs)
+# MartEye Studio JavaScript SDK (`@marteye/studiojs`)
 
-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.
+JavaScript/TypeScript SDK for the MartEye Studio API.
 
 ## Installation
 
-You can install the library using npm or yarn:
-
-Using npm:
-
 ```bash
 npm install @marteye/studiojs
 ```
 
-Using yarn:
+For the beta release channel:
 
 ```bash
-yarn add @marteye/studiojs
+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
+});
+```
+
+## Basic usage
+
+```ts
+const market = await studio.markets.get("greenfields");
+console.log(market.name);
+
+const sales = await studio.sales.list("greenfields", {
+  start: "2026-01-01",
+  end: "2026-12-31",
+});
+
+console.log(sales.sales.length);
 ```
 
-## Usage
+## Messaging
 
-### Importing the Library
+StudioJS now exposes a single messaging interface:
 
-Using ES Modules:
+- `studio.broadcast.send(...)`
+- `studio.broadcast.get(...)`
 
-```javascript
-import StudioJS from "@marteye/studiojs";
+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"],
+    },
+  ],
+});
 ```
 
-Or using CommonJS:
+### Get task status
 
-```javascript
-let StudioJS = require("@marteye/studiojs");
+```ts
+const task = await studio.broadcast.get("greenfields", "sms", "task-id");
+console.log(task.status);
 ```
 
-### Initializing the SDK
+## Migration note
 
-Before using the library, initialize it with your API key. For more information on obtaining an API key, please contact your MartEye representative.
+`studio.sms` has been removed in favour of `studio.broadcast`.
 
-```javascript
-let studioClient = StudioJS.init({
-  apiKey: "YOUR_API_KEY_HERE",
+### 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"] }],
 });
+
+await studio.broadcast.get(marketId, "sms", taskId);
 ```
 
-## Contributing
+## Types
+
+Relevant exported types include:
 
-Contributions are welcome! Please open an issue or submit a pull request if you have suggestions or improvements.
+- `BroadcastPayload`
+- `BroadcastSendResponse`
+- `BroadcastTask`
+- `SMSTask`
+- `EmailTask`
 
 ## License
 

package/dist/__tests__/activity.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/cattlePassport.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/customerLists.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/customerLists.unit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/eartag.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/lot-util.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/lots.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/markets.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/media.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/sales.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/studio.test.d.ts

@@ -0,0 +1,311 @@
+/// <reference types="node" />
+export declare function createTestStudio(opts?: {
+    debug?: boolean;
+}): {
+    TEST_CONFIG: {
+        apiKey: string;
+        marketId: string;
+        baseUrl: string;
+        timeout: number;
+    };
+    isDebugMode: boolean;
+    activity: {
+        list: (marketId: string, params?: import("../resources/activity").ActivityListParams | undefined) => Promise<import("../resources/activity").ActivityListResponse>;
+        get: (marketId: string, activityId: string) => Promise<import("../types").ActivityLog>;
+    };
+    broadcast: {
+        send: (marketId: string, data: import("../types").BroadcastPayload) => Promise<import("../types").BroadcastSendResponse>;
+        get: (marketId: string, type: import("../types").BroadcastType, taskId: string) => Promise<import("../types").BroadcastTask>;
+    };
+    markets: {
+        get: (marketId: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").Market>;
+    };
+    members: {
+        list: (marketId: string, params?: import("../resources/members").MembersListParams | undefined) => Promise<import("../resources/members").MembersListResponse>;
+        get: (marketId: string, memberId: string) => Promise<import("../resources/members").Member>;
+    };
+    sales: {
+        get: (marketId: string, saleId: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").Sale>;
+        list: (marketId: string, opts: {
+            start?: string | undefined;
+            end?: string | undefined;
+        }) => Promise<{
+            start: string;
+            end: string;
+            sales: import("../types").Sale[];
+        }>;
+        create: (marketId: string, saleData: {
+            name: string;
+            startsAt: string;
+            availableProductCodes: string[];
+            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
+            martEyeSaleType?: "LIVE" | "TIMED" | null | undefined;
+            location?: string | null | undefined;
+            description?: string | null | undefined;
+            image?: string | null | undefined;
+            cover?: string | null | undefined;
+            templateId?: string | null | undefined;
+            enableLotGrouping?: boolean | undefined;
+            attributeDefaults?: {
+                [attributekey: string]: string | number | boolean;
+            } | undefined;
+        }) => Promise<{
+            saleId: string;
+        }>;
+        update: (marketId: string, saleId: string, data: {
+            name?: string | undefined;
+            startsAt?: string | undefined;
+            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
+            defaultProductCode?: string | undefined;
+            attributeDefaults?: Record<string, any> | undefined;
+            publishStatus?: import("../types").SalePublishStatus | undefined;
+            enableLotGrouping?: boolean | undefined;
+            marteyeSettings?: {
+                description?: string | undefined;
+                image?: string | undefined;
+                logo?: string | undefined;
+                type: "LIVE" | "TIMED";
+                location?: string | null | undefined;
+                descriptionLines?: string[] | undefined;
+                descriptionLink?: string | undefined;
+                deposit?: number | undefined;
+                hidePrices?: boolean | undefined;
+                hideReplay?: boolean | undefined;
+                labels?: string[] | undefined;
+                tags?: string[] | undefined;
+                details?: {
+                    markdownBase64: string;
+                    title: string;
+                }[] | undefined;
+                cover?: string | undefined;
+                primaryColour?: string | undefined;
+                secondaryColour?: string | undefined;
+                foregroundColour?: string | undefined;
+                extensionTime?: number | undefined;
+                incrementLadder?: {
+                    max: number;
+                    increment: number;
+                }[] | undefined;
+                hideNav?: boolean | undefined;
+                signInOverrideLink?: string | undefined;
+                published?: boolean | undefined;
+                pin?: boolean | undefined;
+                cascade?: boolean | undefined;
+                reportEmail?: string | undefined;
+                queueLots?: boolean | undefined;
+                markSubjectLotsAsSold?: boolean | undefined;
+            } | null | undefined;
+        }) => Promise<import("../types").Sale>;
+    };
+    lots: {
+        get: (marketId: string, saleId: string, lotId: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").Lot>;
+        list: (marketId: string, saleId: string, filters?: {
+            group?: string | undefined;
+            productCode?: string | undefined;
+            saleStatus?: import("../types").LotSaleStatus | undefined;
+            sellerCustomerId?: string | undefined;
+            buyerCustomerId?: string | undefined;
+        } | undefined) => Promise<import("../types").Lot[]>;
+        create: (marketId: string, saleId: string, data: {
+            index?: number | undefined;
+            lotNumber?: string | undefined;
+            group?: string | undefined;
+            productCode?: string | undefined;
+            sellerCustomerId?: string | undefined;
+            attributes?: Record<string, any> | undefined;
+            metadata?: Record<string, any> | undefined;
+            buyerCustomerId?: string | undefined;
+            unitPriceInCents?: number | undefined;
+            reservePriceInCents?: number | undefined;
+            startingPriceInCents?: number | undefined;
+            startAt?: string | undefined;
+            endAt?: string | undefined;
+            previousLotNumber?: string | undefined;
+            saleStatus?: import("../types").LotSaleStatus | undefined;
+        }) => Promise<import("../types").Lot>;
+        update: (marketId: string, saleId: string, lotId: string, data: {
+            productCode?: string | undefined;
+            attributes?: Record<string, any> | undefined;
+            sellerCasual?: string | null | undefined;
+            sellerCustomerId?: string | null | undefined;
+            lotNumber?: string | null | undefined;
+            remarks?: string | undefined;
+            notes?: string | undefined;
+            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
+            unitPriceInCents?: number | undefined;
+            reservePriceInCents?: number | undefined;
+            startingPriceInCents?: number | undefined;
+            buyerCasual?: string | null | undefined;
+            buyerCustomerId?: string | null | undefined;
+            startAt?: string | null | undefined;
+            endAt?: string | null | undefined;
+            saleStatus?: import("../types").LotSaleStatus | undefined;
+            metadata?: Record<string, any> | undefined;
+            inputAccessories?: Record<string, any> | undefined;
+        }) => Promise<import("../types").Lot>;
+        delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
+        deletePreflight: (marketId: string, saleId: string, lotId: string) => Promise<import("../types").LotDeletePreflightResponse>;
+        deletePreflightBatch: (marketId: string, saleId: string, lotIds: string[]) => Promise<import("../types").DeleteLotsResponse>;
+        deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[] | undefined) => Promise<import("../types").DeleteLotsResponse>;
+    };
+    lotitems: {
+        create: (marketId: string, saleId: string, lotId: string, data: {
+            attributes?: Record<string, any> | undefined;
+            notes?: {
+                text: string;
+            }[] | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("../types").LotItem>;
+        update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
+            attributes?: Record<string, any> | undefined;
+            index?: number | undefined;
+            metadata?: Record<string, any> | undefined;
+        }) => Promise<import("../types").LotItem>;
+        delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
+    };
+    carts: {
+        get: (marketId: string, customerId: string) => Promise<import("../resources/carts").CartResponse>;
+        addExtra: (marketId: string, customerId: string, data: import("../resources/carts").AddExtraPayload) => Promise<import("../resources/carts").CartResponse>;
+        removeExtra: (marketId: string, customerId: string, itemId: string) => Promise<void>;
+    };
+    cph: {
+        lookup: (marketId: string, cph: string) => Promise<import("../types").CphLookupResponse>;
+    };
+    webhooks: {
+        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<import("../types").WebhookEvent<T>>;
+    };
+    actions: {
+        constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+    };
+    bidderApplications: {
+        list: (marketId: string, options?: import("../resources/bidderApplications").ListApplicationsOptions | undefined) => Promise<import("../resources/bidderApplications").ListApplicationsResponse>;
+        get: (marketId: string, applicationId: string) => Promise<import("../types").Application>;
+        create: (marketId: string, applicationData: import("../resources/bidderApplications").CreateApplicationPayload) => Promise<import("../types").Application>;
+        update: (marketId: string, applicationId: string, updateData: import("../resources/bidderApplications").UpdateApplicationPayload) => Promise<import("../types").Application>;
+        approve: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<import("../types").Application>;
+        reject: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<import("../types").Application>;
+        unlink: (marketId: string, applicationId: string) => Promise<import("../types").Application>;
+        delete: (marketId: string, applicationId: string) => Promise<void>;
+    };
+    settings: {
+        get: (marketId: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").SettingsMarketDefaults>;
+    };
+    adjustments: {
+        list: (marketId: string) => Promise<import("../types").AdjustmentsConfiguration[]>;
+        get: (marketId: string, id: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").AdjustmentsConfiguration>;
+        create: (marketId: string, data: Partial<import("../types").AdjustmentsConfiguration>) => Promise<import("../types").AdjustmentsConfiguration>;
+        update: (marketId: string, id: string, data: Partial<import("../types").AdjustmentsConfiguration>) => Promise<import("../types").AdjustmentsConfiguration>;
+    };
+    extras: {
+        list: (marketId: string) => Promise<import("../types").Product[]>;
+        get: (marketId: string, id: string) => Promise<import("../types").Product>;
+        create: (marketId: string, data: import("../resources/extras").CreateExtraPayload) => Promise<import("../types").Product>;
+        update: (marketId: string, id: string, data: import("../resources/extras").UpdateExtraPayload) => Promise<import("../types").Product>;
+    };
+    productCodes: {
+        list: (marketId: string) => Promise<import("../types").ProductCodeConfiguration[]>;
+        get: (marketId: string, id: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").ProductCodeConfiguration>;
+        create: (marketId: string, data: Partial<import("../types").ProductCodeConfiguration>) => Promise<import("../types").ProductCodeConfiguration>;
+        update: (marketId: string, id: string, data: Partial<import("../types").ProductCodeConfiguration>) => Promise<import("../types").ProductCodeConfiguration>;
+    };
+    saleTemplates: {
+        list: (marketId: string) => Promise<{
+            templates: import("../types").SaleTemplate[];
+        }>;
+        get: (marketId: string, templateId: string) => Promise<{
+            template: import("../types").SaleTemplate;
+        }>;
+        create: (marketId: string, body: {
+            saleId: string;
+            name: string;
+            description?: string | null | undefined;
+        }) => Promise<{
+            templateId: string;
+        }>;
+        update: (marketId: string, templateId: string, body: {
+            name?: string | undefined;
+            description?: string | null | undefined;
+        }) => Promise<{
+            template: import("../types").SaleTemplate;
+        }>;
+        delete: (marketId: string, templateId: string) => Promise<{
+            success: boolean;
+        }>;
+    };
+    taxRates: {
+        list: (marketId: string) => Promise<import("../types").TaxRate[]>;
+        get: (marketId: string, id: string) => Promise<import("../types").TaxRate>;
+    };
+    customers: {
+        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("../resources/customers").CustomersListResponse>;
+        get: (marketId: string, customerId: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").Customer>;
+        avatar: (marketId: string, customerId: string) => Promise<import("../types").Customer>;
+        create: (marketId: string, customerData: import("..").CreateCustomerPayload) => Promise<import("../types").Customer>;
+        update: (marketId: string, customerId: string, customerData: import("..").UpdateCustomerPayload) => Promise<import("../types").Customer>;
+        getByAccountNumber: (marketId: string, accountNumber: string) => Promise<import("../types").Customer | null>;
+        getByMartEyeUid: (marketId: string, marteyeUid: string) => Promise<import("../types").Customer | null>;
+    };
+    customerLists: {
+        list: (marketId: string, options?: import("..").CustomerListsListOptions | undefined) => Promise<import("..").CustomerListsListResponse>;
+        listAll: (marketId: string, options?: Omit<import("..").CustomerListsListOptions, "offset"> | undefined) => Promise<import("..").CustomerList[]>;
+        get: (marketId: string, listId: string) => Promise<import("..").CustomerList>;
+        getBySlug: (marketId: string, slug: string) => Promise<import("..").CustomerList>;
+        create: (marketId: string, payload: import("..").CreateCustomerListPayload) => Promise<import("..").CustomerList>;
+        update: (marketId: string, listId: string, payload: import("..").UpdateCustomerListPayload) => Promise<import("..").CustomerList>;
+        delete: (marketId: string, listId: string) => Promise<import("..").CustomerListDeleteResponse>;
+        refresh: (marketId: string, listId: string) => Promise<import("..").CustomerListRefreshResponse>;
+        getMembers: (marketId: string, listId: string, options?: import("..").CustomerListMembersOptions | undefined) => Promise<import("..").CustomerListMembersResponse>;
+        getAllMembers: (marketId: string, listId: string, options?: Omit<import("..").CustomerListMembersOptions, "offset"> | undefined) => Promise<import("..").CustomerListMember[]>;
+        addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<import("..").CustomerListAddMembersResponse>;
+        removeMember: (marketId: string, listId: string, customerId: string) => Promise<import("..").CustomerListRemoveMemberResponse>;
+        preview: (marketId: string, filters: import("..").CustomerListFilters) => Promise<import("..").CustomerListPreviewResponse>;
+        listProductCodes: (marketId: string) => Promise<import("..").CustomerListProductCodesResponse>;
+        view: (marketId: string, listIdOrSlug: string, options?: import("..").CustomerListViewOptions | undefined) => Promise<import("..").CustomerListViewResult>;
+    };
+    invoices: {
+        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("../resources/invoices").InvoicesListResponse>;
+        get: (marketId: string, invoiceId: string, options?: import("../types").ReadOptions | undefined) => Promise<import("../types").Invoice>;
+    };
+    payments: {
+        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("../resources/payments").PaymentsListResponse>;
+        get: (marketId: string, paymentId: string) => Promise<import("../types").Payment>;
+    };
+    payouts: {
+        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("../resources/payouts").PayoutsListResponse>;
+        get: (marketId: string, payoutId: string) => Promise<import("../types").Payout>;
+        create: (marketId: string, data: import("../resources/payouts").CreatePayoutRequest) => Promise<import("../resources/payouts").PayoutCreateResponse>;
+    };
+    search: {
+        query: (marketId: string, query: string) => Promise<import("../resources/search").SearchResult>;
+    };
+    files: {
+        uploadSingleFile: (input: import("../utils/multipart-upload").SingleFileInput, token: string) => Promise<{
+            message: string;
+            data: import("../types").Media;
+        }>;
+        uploadMultipartFile: (input: import("../index.common").FileInput | import("../index.common").ChunkedInput, token: string) => Promise<{
+            message: string;
+            mediaType: string;
+            process: import("../utils/multipart-upload").VariantProcessingState;
+        }>;
+        deleteFile: (fileUrl: string, token: string) => Promise<{
+            data: boolean;
+        }>;
+    };
+    contacts: {
+        list: (marketId: string, customerId: string, params?: {
+            lastId?: string | undefined;
+            limit?: number | undefined;
+        } | undefined) => Promise<import("../resources/contacts").ListContactsResponse>;
+        get: (marketId: string, customerId: string, contactId: string) => Promise<import("../types").CustomerContact>;
+        create: (marketId: string, customerId: string, payload: import("../resources/contacts").CreateOrUpdateContactPayload) => Promise<import("../types").CustomerContact>;
+        update: (marketId: string, customerId: string, contactId: string, payload: import("../resources/contacts").CreateOrUpdateContactPayload) => Promise<import("../types").CustomerContact>;
+        delete: (marketId: string, customerId: string, contactId: string) => Promise<void>;
+    };
+    ledger: {
+        getBalance: (marketId: string, account: string) => Promise<import("../resources/ledger").LedgerBalanceResponse>;
+        getTransaction: (marketId: string, transactionId: string) => Promise<import("../resources/ledger").LedgerTransaction>;
+        getLatestTransaction: (marketId: string, account: string) => Promise<import("../resources/ledger").LedgerTransaction>;
+        listTransactions: (marketId: string, params: import("../resources/ledger").ListTransactionsParams) => Promise<import("../resources/ledger").TransactionsListResponse>;
+    };
+};