@marteye/studiojs 1.1.47-beta.0 → 1.1.48-beta.0

package/README.md

@@ -1,52 +1,153 @@
-# 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
 ```
 
-## Usage
+## Create a client
+
+```ts
+import Studio from "@marteye/studiojs";
 
-### Importing the Library
+const studio = Studio({
+  apiKey: process.env.STUDIO_API_KEY!,
+  baseUrl: "https://app.marteyestudio.com/api", // optional
+  defaultTimeout: 30000, // optional
+  debug: false, // optional
+});
+```
 
-Using ES Modules:
+## Basic usage
 
-```javascript
-import StudioJS from "@marteye/studiojs";
+```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);
 ```
 
-Or using CommonJS:
+## Messaging
+
+StudioJS now exposes a single messaging interface:
 
-```javascript
-let StudioJS = require("@marteye/studiojs");
+- `studio.broadcast.send(...)`
+- `studio.broadcast.get(...)`
+
+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"],
+    },
+  ],
+});
 ```
 
-### Initializing the SDK
+### 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"],
+    },
+  ],
+});
+```
 
-Before using the library, initialize it with your API key. For more information on obtaining an API key, please contact your MartEye representative.
+### Get task status
+
+```ts
+const task = await studio.broadcast.get("greenfields", "sms", "task-id");
+console.log(task.status);
+```
 
-```javascript
-let studioClient = StudioJS.init({
-  apiKey: "YOUR_API_KEY_HERE",
+## Migration note
+
+`studio.sms` has been removed in favour of `studio.broadcast`.
+
+### 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
+## Reports
+
+Debt reporting is exposed under `studio.reports`.
+
+```ts
+const overview = await studio.reports.getDebtOperationalOverview(
+  "greenfields",
+  {
+    comparisonDays: 7,
+  }
+);
+
+const behavior = await studio.reports.getDebtBehavior("greenfields", {
+  comparisonDays: 7,
+});
+
+const product = await studio.reports.getDebtProduct("greenfields", {
+  limit: 500,
+});
+```
+
+These debt report endpoints are restricted to **Mart Owners and Admins**.
+
+## 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/index.d.ts

@@ -99,6 +99,7 @@ interface SettingsMarketDefaults {
     defaultUnitOfSale: UnitOfSale;
     defaultSuperType?: SuperType | null;
     defaultSettleDebtsFirst?: boolean;
+    showInvoiceAveragesAndStats?: boolean;
     liveEmailsEnabled?: boolean;
     lotDescriptionTemplateMap?: {
         default: string | undefined;
@@ -240,6 +241,7 @@ interface Sale {
      */
     publishStatus?: SalePublishStatus;
     enableLuckMoney?: boolean;
+    enableLotGrouping?: boolean;
 }
 interface TemplateSaleData {
     name?: string;
@@ -254,6 +256,7 @@ interface TemplateSaleData {
     };
     marteyeSettings?: MartEyeTimedSaleSettings | MartEyeLiveSaleSettings | null;
     enableLuckMoney?: boolean;
+    enableLotGrouping?: boolean;
 }
 interface SaleTemplate {
     id: string;
@@ -1249,12 +1252,55 @@ interface SendSMSPayload {
     reference?: string;
     senderName?: string;
 }
+type BroadcastType = "sms" | "email";
+type BroadcastKind = "broadcast" | "statement";
+interface BroadcastRecipient {
+    customerId: string;
+    displayName?: string;
+    accountNumber?: string;
+    phoneNumbers?: string[];
+    emails?: string[];
+}
+interface SMSBroadcastPayload {
+    type: "sms";
+    kind?: BroadcastKind;
+    message?: string;
+    senderName?: string;
+    recipients: BroadcastRecipient[];
+}
+interface EmailBroadcastPayload {
+    type: "email";
+    kind?: BroadcastKind;
+    message?: string;
+    subject?: string;
+    subdomain?: string;
+    recipients: BroadcastRecipient[];
+}
+type BroadcastPayload = SMSBroadcastPayload | EmailBroadcastPayload;
+interface BroadcastSendResultItem {
+    customerId: string;
+    taskId?: string;
+    status: "queued" | "skipped" | "failed";
+    recipientCount: number;
+    reason?: string;
+}
+interface BroadcastSendResponse {
+    success: boolean;
+    type: BroadcastType;
+    kind: BroadcastKind;
+    broadcastId: string;
+    sent: number;
+    skipped: number;
+    results: BroadcastSendResultItem[];
+}
 interface SMSTask {
     id: string;
     marketId: string;
+    broadcastId?: string;
     to: string[];
     message: string;
     customerId?: string;
+    accountNumber?: string;
     reference?: string;
     senderName?: string;
     metadata?: Record<string, any>;
@@ -1277,6 +1323,145 @@ interface SMSTask {
         };
     };
 }
+interface EmailTask {
+    id: string;
+    marketId: string;
+    broadcastId?: string;
+    marketName: string;
+    replyTo: string;
+    customerId: string;
+    accountNumber?: string;
+    templateId: string;
+    to: string[];
+    documents?: string[];
+    data: Record<string, any>;
+    status: "failed" | "pending" | "sent" | "delivered" | "opened" | "bounced" | "spam-complaint";
+    errorCode?: number;
+    errorMessage?: string;
+    providerMessageId?: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    sentAt?: Timestamp;
+    deliveredAt?: Timestamp;
+    openedAt?: Timestamp;
+    bouncedAt?: Timestamp;
+    subject?: string;
+    events?: {
+        id: string;
+        timestamp: Timestamp;
+        type: string;
+        recipient: string;
+    }[];
+}
+type BroadcastTask = SMSTask | EmailTask;
+interface DebtOperationalOverviewOptions {
+    comparisonDays?: number;
+}
+interface DebtPaymentHistoryPoint {
+    date: string;
+    daysToPay: number;
+}
+interface DebtRecentPaymentInfo {
+    date: string;
+    amountInCents: number;
+    daysToPay: number;
+}
+interface DebtPaymentBehavior {
+    avgDaysToPay: number | null;
+    paymentConsistency: "consistent" | "variable" | "erratic" | null;
+    recentTrend: "improving" | "stable" | "worsening" | null;
+    paymentHistory: DebtPaymentHistoryPoint[];
+    lastPayments: DebtRecentPaymentInfo[];
+    debtorDaysDSO: number | null;
+    debtorDaysDSO30DaysAgo: number | null;
+}
+interface DebtOutstandingInvoice {
+    invoiceId: string;
+    issuedAtSeconds: number;
+    amountDueInCents: number;
+    riskCategory?: "low" | "medium" | "high" | "critical";
+}
+interface DebtOperationalCustomer {
+    customerId: string;
+    displayName: string | null;
+    accountNumber: string | null;
+    balanceInCents: number;
+    balanceXDaysAgoInCents: number | null;
+    balanceChangeInCents: number | null;
+    balanceChangePercent: number | null;
+    lastPaymentDateSeconds: number | null;
+    daysSinceLastPayment: number | null;
+    outstandingInvoices: DebtOutstandingInvoice[];
+    warningSignCodes: Array<"paying_slower" | "buying_more_paying_less" | "stopped_paying" | "late_payments" | "high_risk_invoice">;
+    warningSignLabels: string[];
+    gmvLast30DaysInCents: number;
+    paymentsLast30DaysInCents: number;
+    ageBucket0to6: number;
+    ageBucket7to13: number;
+    ageBucket14to20: number;
+    ageBucket21to27: number;
+    ageBucket28to34: number;
+    ageBucket35plus: number;
+    avgDaysToPayRecent: number | null;
+    avgDaysToPayBaseline: number | null;
+    hasHighRiskInvoice: boolean;
+    invoiceCount: number;
+    paymentBehavior: DebtPaymentBehavior;
+}
+interface DebtOperationalInvoice {
+    invoiceId: string;
+    customerId: string;
+    issuedAtSeconds: number;
+    amountDueInCents: number;
+    daysOutstanding: number;
+    expectedPayDays: number | null;
+    daysOverdue: number | null;
+    riskCategory: "low" | "medium" | "high" | "critical";
+    customerWarnings: Array<"paying_slower" | "buying_more_paying_less" | "stopped_paying" | "late_payments" | "high_risk_invoice">;
+    customerAvgDaysToPay: number | null;
+}
+interface DebtOperationalOverviewResponse {
+    customers: DebtOperationalCustomer[];
+    invoices: DebtOperationalInvoice[];
+}
+interface DebtBehaviorCustomer {
+    customerId: string;
+    displayName: string | null;
+    accountNumber: string | null;
+    balanceInCents: number;
+    balanceXDaysAgoInCents: number | null;
+    balanceChangeInCents: number | null;
+    balanceChangePercent: number | null;
+    paymentBehavior: DebtPaymentBehavior;
+    warningSignCodes: DebtOperationalCustomer["warningSignCodes"];
+    warningSignLabels: string[];
+}
+interface DebtBehaviorResponse {
+    customers: DebtBehaviorCustomer[];
+}
+interface DebtProductOptions {
+    limit?: number;
+}
+interface DebtProductInvoice {
+    invoiceId: string;
+    outstandingInMilliCents: number;
+    issuedAtSeconds: number;
+}
+interface DebtProductCustomer {
+    owner: string | null;
+    customerId: string | null;
+    outstandingInMilliCents: number;
+    invoices: DebtProductInvoice[];
+}
+interface DebtProductRow {
+    productCode: string | null;
+    totalOutstandingInMilliCents: number;
+    customers: DebtProductCustomer[];
+}
+interface DebtProductResponse {
+    outstandingByProduct: DebtProductRow[];
+    overallOutstandingInMilliCents: number;
+}
 
 type types_Accessory = Accessory;
 type types_ActivityChange = ActivityChange;
@@ -1292,6 +1477,13 @@ type types_Application = Application;
 type types_AttributeDefinition = AttributeDefinition;
 type types_AttributeValueType = AttributeValueType;
 type types_BankDetails = BankDetails;
+type types_BroadcastKind = BroadcastKind;
+type types_BroadcastPayload = BroadcastPayload;
+type types_BroadcastRecipient = BroadcastRecipient;
+type types_BroadcastSendResponse = BroadcastSendResponse;
+type types_BroadcastSendResultItem = BroadcastSendResultItem;
+type types_BroadcastTask = BroadcastTask;
+type types_BroadcastType = BroadcastType;
 type types_Cart = Cart;
 type types_CartItem = CartItem;
 type types_ChequeField = ChequeField;
@@ -1303,10 +1495,27 @@ type types_Customer = Customer;
 type types_CustomerBankDetails = CustomerBankDetails;
 type types_CustomerContact = CustomerContact;
 type types_CustomerFromSearch = CustomerFromSearch;
+type types_DebtBehaviorCustomer = DebtBehaviorCustomer;
+type types_DebtBehaviorResponse = DebtBehaviorResponse;
+type types_DebtOperationalCustomer = DebtOperationalCustomer;
+type types_DebtOperationalInvoice = DebtOperationalInvoice;
+type types_DebtOperationalOverviewOptions = DebtOperationalOverviewOptions;
+type types_DebtOperationalOverviewResponse = DebtOperationalOverviewResponse;
+type types_DebtOutstandingInvoice = DebtOutstandingInvoice;
+type types_DebtPaymentBehavior = DebtPaymentBehavior;
+type types_DebtPaymentHistoryPoint = DebtPaymentHistoryPoint;
+type types_DebtProductCustomer = DebtProductCustomer;
+type types_DebtProductInvoice = DebtProductInvoice;
+type types_DebtProductOptions = DebtProductOptions;
+type types_DebtProductResponse = DebtProductResponse;
+type types_DebtProductRow = DebtProductRow;
+type types_DebtRecentPaymentInfo = DebtRecentPaymentInfo;
 type types_DeleteLotsResponse = DeleteLotsResponse;
 type types_DeviceType = DeviceType;
 type types_DisplayBoardMode = DisplayBoardMode;
 type types_DraftInvoice = DraftInvoice;
+type types_EmailBroadcastPayload = EmailBroadcastPayload;
+type types_EmailTask = EmailTask;
 type types_EmailWrapper = EmailWrapper;
 type types_FarmAssurances = FarmAssurances;
 type types_FieldPositions = FieldPositions;
@@ -1350,6 +1559,7 @@ type types_Product = Product;
 type types_ProductCodeConfiguration = ProductCodeConfiguration;
 type types_ProductConfiguration = ProductConfiguration;
 type types_ReadOptions = ReadOptions;
+type types_SMSBroadcastPayload = SMSBroadcastPayload;
 type types_SMSTask = SMSTask;
 type types_Sale = Sale;
 type types_SaleFromSearch = SaleFromSearch;
@@ -1386,7 +1596,7 @@ type types_WebhookEvent<T> = WebhookEvent<T>;
 type types_WebhookEventName = WebhookEventName;
 declare const types_supportedWebhookEvents: typeof supportedWebhookEvents;
 declare namespace types {
-  export { type types_Accessory as Accessory, type types_ActivityChange as ActivityChange, type types_ActivityLog as ActivityLog, type types_ActivityOperation as ActivityOperation, type types_Address as Address, type types_AddressWrapper as AddressWrapper, type types_AdjustmentTarget as AdjustmentTarget, type types_AdjustmentTotalTarget as AdjustmentTotalTarget, type types_AdjustmentsConfiguration as AdjustmentsConfiguration, type types_AppParameterConfig as AppParameterConfig, type types_Application as Application, type types_AttributeDefinition as AttributeDefinition, type types_AttributeValueType as AttributeValueType, type types_BankDetails as BankDetails, type types_Cart as Cart, type types_CartItem as CartItem, type types_ChequeField as ChequeField, type types_ClientType as ClientType, type types_CphLookupResponse as CphLookupResponse, type types_CurrenciesWithGuinea as CurrenciesWithGuinea, type types_Currency as Currency, type types_Customer as Customer, type types_CustomerBankDetails as CustomerBankDetails, type types_CustomerContact as CustomerContact, type types_CustomerFromSearch as CustomerFromSearch, type types_DeleteLotsResponse as DeleteLotsResponse, type types_DeviceType as DeviceType, type types_DisplayBoardMode as DisplayBoardMode, type types_DraftInvoice as DraftInvoice, type types_EmailWrapper as EmailWrapper, type types_FarmAssurances as FarmAssurances, type types_FieldPositions as FieldPositions, types_IMAGE_SIZES_VALUES as IMAGE_SIZES_VALUES, type types_ImageSizes as ImageSizes, type types_IncrementLadder as IncrementLadder, type types_IncrementLadderItem as IncrementLadderItem, type types_Invoice as Invoice, type types_InvoiceDeliveryPreference as InvoiceDeliveryPreference, type types_InvoiceField as InvoiceField, type types_InvoiceLineItem as InvoiceLineItem, type types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, type types_InvoiceTotals as InvoiceTotals, type types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_LivestockSuperTypes as LivestockSuperTypes, type types_Lot as Lot, type types_LotDeleteDecision as LotDeleteDecision, type types_LotDeletePreflightItem as LotDeletePreflightItem, type types_LotDeletePreflightResponse as LotDeletePreflightResponse, type types_LotDeleteReason as LotDeleteReason, type types_LotGeneratedValues as LotGeneratedValues, type types_LotIssue as LotIssue, type types_LotItem as LotItem, type types_LotSaleStatus as LotSaleStatus, type types_LotWithItemsAsArray as LotWithItemsAsArray, type types_Market as Market, type types_MarketBankDetails as MarketBankDetails, type types_MarketReportHeaders as MarketReportHeaders, type types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, type types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, type types_Media as Media, type types_MemberSharingConfiguration as MemberSharingConfiguration, type types_ObjectType as ObjectType, type types_Payment as Payment, type types_PaymentMethod as PaymentMethod, type types_Payout as Payout, type types_PayoutMethod as PayoutMethod, type types_PhoneNumberWrapper as PhoneNumberWrapper, type types_Printer as Printer, type types_Product as Product, type types_ProductCodeConfiguration as ProductCodeConfiguration, type types_ProductConfiguration as ProductConfiguration, type types_ReadOptions as ReadOptions, type types_SMSTask as SMSTask, type types_Sale as Sale, type types_SaleFromSearch as SaleFromSearch, type types_SalePublishStatus as SalePublishStatus, type types_SaleTemplate as SaleTemplate, type types_SendSMSPayload as SendSMSPayload, type types_SettingsAccessories as SettingsAccessories, type types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, type types_SettingsGlobalAttributes as SettingsGlobalAttributes, type types_SettingsMarketDefaults as SettingsMarketDefaults, type types_SettingsPrinters as SettingsPrinters, type types_SettingsProductCodes as SettingsProductCodes, type types_SettingsTaxRates as SettingsTaxRates, type types_ShortCustomerDetails as ShortCustomerDetails, type types_SimplePaymentIn as SimplePaymentIn, type types_SimplePaymentOut as SimplePaymentOut, type types_StoredDataGridConfig as StoredDataGridConfig, type types_StudioAppPartial as StudioAppPartial, type types_SubtotalGroups as SubtotalGroups, type types_SuperType as SuperType, type types_SupportedAttributeTypes as SupportedAttributeTypes, type types_SupportedCountryCode as SupportedCountryCode, types_SupportedCurrencyCodes as SupportedCurrencyCodes, type SupportedFileTypesNames$1 as SupportedFileTypesNames, types_SupportedPaymentMethods as SupportedPaymentMethods, types_SupportedSuperTypes as SupportedSuperTypes, types_SupportedUnitsOfSale as SupportedUnitsOfSale, type types_TablePosition as TablePosition, type types_TaxRate as TaxRate, type types_TemplateSaleData as TemplateSaleData, type types_UnitOfSale as UnitOfSale, types_VIDEO_TASKS_VALUES as VIDEO_TASKS_VALUES, type types_VideoTasks as VideoTasks, type types_WebhookEvent as WebhookEvent, type types_WebhookEventName as WebhookEventName, types_supportedWebhookEvents as supportedWebhookEvents };
+  export { type types_Accessory as Accessory, type types_ActivityChange as ActivityChange, type types_ActivityLog as ActivityLog, type types_ActivityOperation as ActivityOperation, type types_Address as Address, type types_AddressWrapper as AddressWrapper, type types_AdjustmentTarget as AdjustmentTarget, type types_AdjustmentTotalTarget as AdjustmentTotalTarget, type types_AdjustmentsConfiguration as AdjustmentsConfiguration, type types_AppParameterConfig as AppParameterConfig, type types_Application as Application, type types_AttributeDefinition as AttributeDefinition, type types_AttributeValueType as AttributeValueType, type types_BankDetails as BankDetails, type types_BroadcastKind as BroadcastKind, type types_BroadcastPayload as BroadcastPayload, type types_BroadcastRecipient as BroadcastRecipient, type types_BroadcastSendResponse as BroadcastSendResponse, type types_BroadcastSendResultItem as BroadcastSendResultItem, type types_BroadcastTask as BroadcastTask, type types_BroadcastType as BroadcastType, type types_Cart as Cart, type types_CartItem as CartItem, type types_ChequeField as ChequeField, type types_ClientType as ClientType, type types_CphLookupResponse as CphLookupResponse, type types_CurrenciesWithGuinea as CurrenciesWithGuinea, type types_Currency as Currency, type types_Customer as Customer, type types_CustomerBankDetails as CustomerBankDetails, type types_CustomerContact as CustomerContact, type types_CustomerFromSearch as CustomerFromSearch, type types_DebtBehaviorCustomer as DebtBehaviorCustomer, type types_DebtBehaviorResponse as DebtBehaviorResponse, type types_DebtOperationalCustomer as DebtOperationalCustomer, type types_DebtOperationalInvoice as DebtOperationalInvoice, type types_DebtOperationalOverviewOptions as DebtOperationalOverviewOptions, type types_DebtOperationalOverviewResponse as DebtOperationalOverviewResponse, type types_DebtOutstandingInvoice as DebtOutstandingInvoice, type types_DebtPaymentBehavior as DebtPaymentBehavior, type types_DebtPaymentHistoryPoint as DebtPaymentHistoryPoint, type types_DebtProductCustomer as DebtProductCustomer, type types_DebtProductInvoice as DebtProductInvoice, type types_DebtProductOptions as DebtProductOptions, type types_DebtProductResponse as DebtProductResponse, type types_DebtProductRow as DebtProductRow, type types_DebtRecentPaymentInfo as DebtRecentPaymentInfo, type types_DeleteLotsResponse as DeleteLotsResponse, type types_DeviceType as DeviceType, type types_DisplayBoardMode as DisplayBoardMode, type types_DraftInvoice as DraftInvoice, type types_EmailBroadcastPayload as EmailBroadcastPayload, type types_EmailTask as EmailTask, type types_EmailWrapper as EmailWrapper, type types_FarmAssurances as FarmAssurances, type types_FieldPositions as FieldPositions, types_IMAGE_SIZES_VALUES as IMAGE_SIZES_VALUES, type types_ImageSizes as ImageSizes, type types_IncrementLadder as IncrementLadder, type types_IncrementLadderItem as IncrementLadderItem, type types_Invoice as Invoice, type types_InvoiceDeliveryPreference as InvoiceDeliveryPreference, type types_InvoiceField as InvoiceField, type types_InvoiceLineItem as InvoiceLineItem, type types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, type types_InvoiceTotals as InvoiceTotals, type types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_LivestockSuperTypes as LivestockSuperTypes, type types_Lot as Lot, type types_LotDeleteDecision as LotDeleteDecision, type types_LotDeletePreflightItem as LotDeletePreflightItem, type types_LotDeletePreflightResponse as LotDeletePreflightResponse, type types_LotDeleteReason as LotDeleteReason, type types_LotGeneratedValues as LotGeneratedValues, type types_LotIssue as LotIssue, type types_LotItem as LotItem, type types_LotSaleStatus as LotSaleStatus, type types_LotWithItemsAsArray as LotWithItemsAsArray, type types_Market as Market, type types_MarketBankDetails as MarketBankDetails, type types_MarketReportHeaders as MarketReportHeaders, type types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, type types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, type types_Media as Media, type types_MemberSharingConfiguration as MemberSharingConfiguration, type types_ObjectType as ObjectType, type types_Payment as Payment, type types_PaymentMethod as PaymentMethod, type types_Payout as Payout, type types_PayoutMethod as PayoutMethod, type types_PhoneNumberWrapper as PhoneNumberWrapper, type types_Printer as Printer, type types_Product as Product, type types_ProductCodeConfiguration as ProductCodeConfiguration, type types_ProductConfiguration as ProductConfiguration, type types_ReadOptions as ReadOptions, type types_SMSBroadcastPayload as SMSBroadcastPayload, type types_SMSTask as SMSTask, type types_Sale as Sale, type types_SaleFromSearch as SaleFromSearch, type types_SalePublishStatus as SalePublishStatus, type types_SaleTemplate as SaleTemplate, type types_SendSMSPayload as SendSMSPayload, type types_SettingsAccessories as SettingsAccessories, type types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, type types_SettingsGlobalAttributes as SettingsGlobalAttributes, type types_SettingsMarketDefaults as SettingsMarketDefaults, type types_SettingsPrinters as SettingsPrinters, type types_SettingsProductCodes as SettingsProductCodes, type types_SettingsTaxRates as SettingsTaxRates, type types_ShortCustomerDetails as ShortCustomerDetails, type types_SimplePaymentIn as SimplePaymentIn, type types_SimplePaymentOut as SimplePaymentOut, type types_StoredDataGridConfig as StoredDataGridConfig, type types_StudioAppPartial as StudioAppPartial, type types_SubtotalGroups as SubtotalGroups, type types_SuperType as SuperType, type types_SupportedAttributeTypes as SupportedAttributeTypes, type types_SupportedCountryCode as SupportedCountryCode, types_SupportedCurrencyCodes as SupportedCurrencyCodes, type SupportedFileTypesNames$1 as SupportedFileTypesNames, types_SupportedPaymentMethods as SupportedPaymentMethods, types_SupportedSuperTypes as SupportedSuperTypes, types_SupportedUnitsOfSale as SupportedUnitsOfSale, type types_TablePosition as TablePosition, type types_TaxRate as TaxRate, type types_TemplateSaleData as TemplateSaleData, type types_UnitOfSale as UnitOfSale, types_VIDEO_TASKS_VALUES as VIDEO_TASKS_VALUES, type types_VideoTasks as VideoTasks, type types_WebhookEvent as WebhookEvent, type types_WebhookEventName as WebhookEventName, types_supportedWebhookEvents as supportedWebhookEvents };
 }
 
 interface ListContactsResponse {
@@ -1941,6 +2151,10 @@ declare function resources(httpClient: HttpClient): {
         list: (marketId: string, params?: ActivityListParams | undefined) => Promise<ActivityListResponse>;
         get: (marketId: string, activityId: string) => Promise<ActivityLog>;
     };
+    broadcast: {
+        send: (marketId: string, data: BroadcastPayload) => Promise<BroadcastSendResponse>;
+        get: (marketId: string, type: BroadcastType, taskId: string) => Promise<BroadcastTask>;
+    };
     markets: {
         get: (marketId: string, options?: ReadOptions | undefined) => Promise<Market>;
     };
@@ -1969,6 +2183,7 @@ declare function resources(httpClient: HttpClient): {
             image?: string | null | undefined;
             cover?: string | null | undefined;
             templateId?: string | null | undefined;
+            enableLotGrouping?: boolean | undefined;
             attributeDefaults?: {
                 [attributekey: string]: string | number | boolean;
             } | undefined;
@@ -1982,6 +2197,7 @@ declare function resources(httpClient: HttpClient): {
             defaultProductCode?: string | undefined;
             attributeDefaults?: Record<string, any> | undefined;
             publishStatus?: SalePublishStatus | undefined;
+            enableLotGrouping?: boolean | undefined;
             marteyeSettings?: {
                 description?: string | undefined;
                 image?: string | undefined;
@@ -2197,6 +2413,11 @@ declare function resources(httpClient: HttpClient): {
         get: (marketId: string, payoutId: string) => Promise<Payout>;
         create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
     };
+    reports: {
+        getDebtOperationalOverview: (marketId: string, options?: DebtOperationalOverviewOptions | undefined) => Promise<DebtOperationalOverviewResponse>;
+        getDebtBehavior: (marketId: string, options?: DebtOperationalOverviewOptions | undefined) => Promise<DebtBehaviorResponse>;
+        getDebtProduct: (marketId: string, options?: DebtProductOptions | undefined) => Promise<DebtProductResponse>;
+    };
     search: {
         query: (marketId: string, query: string) => Promise<SearchResult>;
     };
@@ -2230,10 +2451,6 @@ declare function resources(httpClient: HttpClient): {
         getLatestTransaction: (marketId: string, account: string) => Promise<LedgerTransaction>;
         listTransactions: (marketId: string, params: ListTransactionsParams) => Promise<TransactionsListResponse>;
     };
-    sms: {
-        sendSMS: (marketId: string, data: SendSMSPayload) => Promise<SMSTask>;
-        getSMS: (marketId: string, smsId: string) => Promise<SMSTask>;
-    };
 };
 
 type StudioInstance = ReturnType<typeof resources> & {
@@ -2250,6 +2467,10 @@ declare function Studio(info?: {
         list: (marketId: string, params?: ActivityListParams | undefined) => Promise<ActivityListResponse>;
         get: (marketId: string, activityId: string) => Promise<ActivityLog>;
     };
+    broadcast: {
+        send: (marketId: string, data: BroadcastPayload) => Promise<BroadcastSendResponse>;
+        get: (marketId: string, type: BroadcastType, taskId: string) => Promise<BroadcastTask>;
+    };
     markets: {
         get: (marketId: string, options?: ReadOptions | undefined) => Promise<Market>;
     };
@@ -2278,6 +2499,7 @@ declare function Studio(info?: {
             image?: string | null | undefined;
             cover?: string | null | undefined;
             templateId?: string | null | undefined;
+            enableLotGrouping?: boolean | undefined;
             attributeDefaults?: {
                 [attributekey: string]: string | number | boolean;
             } | undefined;
@@ -2291,6 +2513,7 @@ declare function Studio(info?: {
             defaultProductCode?: string | undefined;
             attributeDefaults?: Record<string, any> | undefined;
             publishStatus?: SalePublishStatus | undefined;
+            enableLotGrouping?: boolean | undefined;
             marteyeSettings?: {
                 description?: string | undefined;
                 image?: string | undefined;
@@ -2506,6 +2729,11 @@ declare function Studio(info?: {
         get: (marketId: string, payoutId: string) => Promise<Payout>;
         create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
     };
+    reports: {
+        getDebtOperationalOverview: (marketId: string, options?: DebtOperationalOverviewOptions | undefined) => Promise<DebtOperationalOverviewResponse>;
+        getDebtBehavior: (marketId: string, options?: DebtOperationalOverviewOptions | undefined) => Promise<DebtBehaviorResponse>;
+        getDebtProduct: (marketId: string, options?: DebtProductOptions | undefined) => Promise<DebtProductResponse>;
+    };
     search: {
         query: (marketId: string, query: string) => Promise<SearchResult>;
     };
@@ -2539,10 +2767,6 @@ declare function Studio(info?: {
         getLatestTransaction: (marketId: string, account: string) => Promise<LedgerTransaction>;
         listTransactions: (marketId: string, params: ListTransactionsParams) => Promise<TransactionsListResponse>;
     };
-    sms: {
-        sendSMS: (marketId: string, data: SendSMSPayload) => Promise<SMSTask>;
-        getSMS: (marketId: string, smsId: string) => Promise<SMSTask>;
-    };
 };
 
 /**
@@ -2703,4 +2927,11 @@ declare function sortByLotNumber<T extends {
  */
 declare function nextLotNumber(previousLotNumber: string): string;
 
-export { CattlePassport, type ChunkedFile, type CreateCustomerListPayload, type CreateCustomerPayload, type CustomerList, type CustomerListAddMembersResponse, type CustomerListDeleteResponse, type CustomerListFilterGroup, type CustomerListFilters, type CustomerListMember, type CustomerListMembersOptions, type CustomerListMembersResponse, type CustomerListPreviewResponse, type CustomerListProductCodesResponse, type CustomerListQuery, type CustomerListRefreshResponse, type CustomerListRemoveMemberResponse, type CustomerListReportRow, type CustomerListReportSummary, type CustomerListRole, type CustomerListType, type CustomerListViewOptions, type CustomerListViewResult, type CustomerListsListOptions, type CustomerListsListResponse, EarTag, type FarmAssuranceUpdate, type KeeperDetailsUpdate, type RollingDateConfig, Studio, StudioHeaders, type StudioInstance, type StudioManifest, types as StudioTypes, type UpdateCustomerListPayload, type UpdateCustomerPayload, createAppManifest, Studio as default, lotComparator, nextLotNumber, sortByLotNumber };
+declare function create(httpClient: HttpClient): {
+    getDebtOperationalOverview: (marketId: string, options?: DebtOperationalOverviewOptions) => Promise<DebtOperationalOverviewResponse>;
+    getDebtBehavior: (marketId: string, options?: DebtOperationalOverviewOptions) => Promise<DebtBehaviorResponse>;
+    getDebtProduct: (marketId: string, options?: DebtProductOptions) => Promise<DebtProductResponse>;
+};
+type Reports = ReturnType<typeof create>;
+
+export { CattlePassport, type ChunkedFile, type CreateCustomerListPayload, type CreateCustomerPayload, type CustomerList, type CustomerListAddMembersResponse, type CustomerListDeleteResponse, type CustomerListFilterGroup, type CustomerListFilters, type CustomerListMember, type CustomerListMembersOptions, type CustomerListMembersResponse, type CustomerListPreviewResponse, type CustomerListProductCodesResponse, type CustomerListQuery, type CustomerListRefreshResponse, type CustomerListRemoveMemberResponse, type CustomerListReportRow, type CustomerListReportSummary, type CustomerListRole, type CustomerListType, type CustomerListViewOptions, type CustomerListViewResult, type CustomerListsListOptions, type CustomerListsListResponse, type DebtBehaviorCustomer, type DebtBehaviorResponse, type DebtOperationalCustomer, type DebtOperationalInvoice, type DebtOperationalOverviewOptions, type DebtOperationalOverviewResponse, type DebtOutstandingInvoice, type DebtPaymentBehavior, type DebtPaymentHistoryPoint, type DebtProductCustomer, type DebtProductInvoice, type DebtProductOptions, type DebtProductResponse, type DebtProductRow, type DebtRecentPaymentInfo, EarTag, type FarmAssuranceUpdate, type KeeperDetailsUpdate, type Reports, type RollingDateConfig, Studio, StudioHeaders, type StudioInstance, type StudioManifest, types as StudioTypes, type UpdateCustomerListPayload, type UpdateCustomerPayload, createAppManifest, Studio as default, lotComparator, nextLotNumber, sortByLotNumber };