@marteye/studiojs 1.1.47 → 1.1.48-beta.0

package/dist/resources.d.ts

@@ -5,6 +5,10 @@ export default function resources(httpClient: HttpClient): {
         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>;
     };
@@ -33,6 +37,7 @@ export default 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;
@@ -46,6 +51,7 @@ export default function resources(httpClient: HttpClient): {
             defaultProductCode?: string | undefined;
             attributeDefaults?: Record<string, any> | undefined;
             publishStatus?: import("./types").SalePublishStatus | undefined;
+            enableLotGrouping?: boolean | undefined;
             marteyeSettings?: {
                 description?: string | undefined;
                 image?: string | undefined;
@@ -261,6 +267,11 @@ export default function resources(httpClient: HttpClient): {
         get: (marketId: string, payoutId: string) => Promise<import("./types").Payout>;
         create: (marketId: string, data: import("./resources/payouts").CreatePayoutRequest) => Promise<import("./resources/payouts").PayoutCreateResponse>;
     };
+    reports: {
+        getDebtOperationalOverview: (marketId: string, options?: import("./types").DebtOperationalOverviewOptions | undefined) => Promise<import("./types").DebtOperationalOverviewResponse>;
+        getDebtBehavior: (marketId: string, options?: import("./types").DebtOperationalOverviewOptions | undefined) => Promise<import("./types").DebtBehaviorResponse>;
+        getDebtProduct: (marketId: string, options?: import("./types").DebtProductOptions | undefined) => Promise<import("./types").DebtProductResponse>;
+    };
     search: {
         query: (marketId: string, query: string) => Promise<import("./resources/search").SearchResult>;
     };
@@ -294,8 +305,4 @@ export default function resources(httpClient: HttpClient): {
         getLatestTransaction: (marketId: string, account: string) => Promise<import("./resources/ledger").LedgerTransaction>;
         listTransactions: (marketId: string, params: import("./resources/ledger").ListTransactionsParams) => Promise<import("./resources/ledger").TransactionsListResponse>;
     };
-    sms: {
-        sendSMS: (marketId: string, data: import("./types").SendSMSPayload) => Promise<import("./types").SMSTask>;
-        getSMS: (marketId: string, smsId: string) => Promise<import("./types").SMSTask>;
-    };
 };

package/dist/studio.d.ts

@@ -14,6 +14,10 @@ export declare function Studio(info?: {
         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>;
     };
@@ -42,6 +46,7 @@ export 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;
@@ -55,6 +60,7 @@ export declare function Studio(info?: {
             defaultProductCode?: string | undefined;
             attributeDefaults?: Record<string, any> | undefined;
             publishStatus?: import("./types").SalePublishStatus | undefined;
+            enableLotGrouping?: boolean | undefined;
             marteyeSettings?: {
                 description?: string | undefined;
                 image?: string | undefined;
@@ -270,6 +276,11 @@ export declare function Studio(info?: {
         get: (marketId: string, payoutId: string) => Promise<import("./types").Payout>;
         create: (marketId: string, data: import("./resources/payouts").CreatePayoutRequest) => Promise<import("./resources/payouts").PayoutCreateResponse>;
     };
+    reports: {
+        getDebtOperationalOverview: (marketId: string, options?: import("./types").DebtOperationalOverviewOptions | undefined) => Promise<import("./types").DebtOperationalOverviewResponse>;
+        getDebtBehavior: (marketId: string, options?: import("./types").DebtOperationalOverviewOptions | undefined) => Promise<import("./types").DebtBehaviorResponse>;
+        getDebtProduct: (marketId: string, options?: import("./types").DebtProductOptions | undefined) => Promise<import("./types").DebtProductResponse>;
+    };
     search: {
         query: (marketId: string, query: string) => Promise<import("./resources/search").SearchResult>;
     };
@@ -303,8 +314,4 @@ export declare function Studio(info?: {
         getLatestTransaction: (marketId: string, account: string) => Promise<import("./resources/ledger").LedgerTransaction>;
         listTransactions: (marketId: string, params: import("./resources/ledger").ListTransactionsParams) => Promise<import("./resources/ledger").TransactionsListResponse>;
     };
-    sms: {
-        sendSMS: (marketId: string, data: import("./types").SendSMSPayload) => Promise<import("./types").SMSTask>;
-        getSMS: (marketId: string, smsId: string) => Promise<import("./types").SMSTask>;
-    };
 };

package/dist/types.d.ts

@@ -46,6 +46,7 @@ export interface SettingsMarketDefaults {
     defaultUnitOfSale: UnitOfSale;
     defaultSuperType?: SuperType | null;
     defaultSettleDebtsFirst?: boolean;
+    showInvoiceAveragesAndStats?: boolean;
     liveEmailsEnabled?: boolean;
     lotDescriptionTemplateMap?: {
         default: string | undefined;
@@ -211,6 +212,7 @@ export interface Sale {
      */
     publishStatus?: SalePublishStatus;
     enableLuckMoney?: boolean;
+    enableLotGrouping?: boolean;
 }
 export interface TemplateSaleData {
     name?: string;
@@ -225,6 +227,7 @@ export interface TemplateSaleData {
     };
     marteyeSettings?: MartEyeTimedSaleSettings | MartEyeLiveSaleSettings | null;
     enableLuckMoney?: boolean;
+    enableLotGrouping?: boolean;
 }
 export interface SaleTemplate {
     id: string;
@@ -1196,12 +1199,55 @@ export interface SendSMSPayload {
     reference?: string;
     senderName?: string;
 }
+export type BroadcastType = "sms" | "email";
+export type BroadcastKind = "broadcast" | "statement";
+export interface BroadcastRecipient {
+    customerId: string;
+    displayName?: string;
+    accountNumber?: string;
+    phoneNumbers?: string[];
+    emails?: string[];
+}
+export interface SMSBroadcastPayload {
+    type: "sms";
+    kind?: BroadcastKind;
+    message?: string;
+    senderName?: string;
+    recipients: BroadcastRecipient[];
+}
+export interface EmailBroadcastPayload {
+    type: "email";
+    kind?: BroadcastKind;
+    message?: string;
+    subject?: string;
+    subdomain?: string;
+    recipients: BroadcastRecipient[];
+}
+export type BroadcastPayload = SMSBroadcastPayload | EmailBroadcastPayload;
+export interface BroadcastSendResultItem {
+    customerId: string;
+    taskId?: string;
+    status: "queued" | "skipped" | "failed";
+    recipientCount: number;
+    reason?: string;
+}
+export interface BroadcastSendResponse {
+    success: boolean;
+    type: BroadcastType;
+    kind: BroadcastKind;
+    broadcastId: string;
+    sent: number;
+    skipped: number;
+    results: BroadcastSendResultItem[];
+}
 export interface SMSTask {
     id: string;
     marketId: string;
+    broadcastId?: string;
     to: string[];
     message: string;
     customerId?: string;
+    accountNumber?: string;
     reference?: string;
     senderName?: string;
     metadata?: Record<string, any>;
@@ -1224,4 +1270,143 @@ export interface SMSTask {
         };
     };
 }
+export 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;
+    }[];
+}
+export type BroadcastTask = SMSTask | EmailTask;
+export interface DebtOperationalOverviewOptions {
+    comparisonDays?: number;
+}
+export interface DebtPaymentHistoryPoint {
+    date: string;
+    daysToPay: number;
+}
+export interface DebtRecentPaymentInfo {
+    date: string;
+    amountInCents: number;
+    daysToPay: number;
+}
+export 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;
+}
+export interface DebtOutstandingInvoice {
+    invoiceId: string;
+    issuedAtSeconds: number;
+    amountDueInCents: number;
+    riskCategory?: "low" | "medium" | "high" | "critical";
+}
+export 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;
+}
+export 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;
+}
+export interface DebtOperationalOverviewResponse {
+    customers: DebtOperationalCustomer[];
+    invoices: DebtOperationalInvoice[];
+}
+export 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[];
+}
+export interface DebtBehaviorResponse {
+    customers: DebtBehaviorCustomer[];
+}
+export interface DebtProductOptions {
+    limit?: number;
+}
+export interface DebtProductInvoice {
+    invoiceId: string;
+    outstandingInMilliCents: number;
+    issuedAtSeconds: number;
+}
+export interface DebtProductCustomer {
+    owner: string | null;
+    customerId: string | null;
+    outstandingInMilliCents: number;
+    invoices: DebtProductInvoice[];
+}
+export interface DebtProductRow {
+    productCode: string | null;
+    totalOutstandingInMilliCents: number;
+    customers: DebtProductCustomer[];
+}
+export interface DebtProductResponse {
+    outstandingByProduct: DebtProductRow[];
+    overallOutstandingInMilliCents: number;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marteye/studiojs",
-  "version": "1.1.47",
+  "version": "1.1.48-beta.0",
   "description": "MartEye Studio JavaScript SDK",
   "license": "MIT",
   "source": "src/index.ts",
@@ -27,7 +27,8 @@
     "test": "jest --coverage",
     "test:watch": "jest --watch",
     "build:types": "tsc --emitDeclarationOnly",
-    "build:publish": "npm run build && npm publish --access public"
+    "build:publish": "npm run build && npm publish --access public",
+    "build:publish:beta": "npm run build && npm publish --tag beta --access public"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.0",

package/dist/resources/sms.d.ts

@@ -1,7 +0,0 @@
-import { HttpClient } from "../net/http";
-import { SendSMSPayload, SMSTask } from "../types";
-export default function create(httpClient: HttpClient): {
-    sendSMS: (marketId: string, data: SendSMSPayload) => Promise<SMSTask>;
-    getSMS: (marketId: string, smsId: string) => Promise<SMSTask>;
-};
-export type SMS = ReturnType<typeof create>;