@marteye/studiojs 1.1.47 → 1.1.48-beta.0

package/dist/index.esm.js

@@ -51,7 +51,7 @@ function SimpleHttpClient(baseUrl, apiKey, fetch, defaultTimeout, debug = false)
         if (response.status === 404) {
             throw new Error(`${baseUrl}${path} not found`);
         }
-        throw new Error(`Request failed with status ${response.status}: ${await response.text()}}`);
+        throw new Error(`Request failed with status ${response.status}: ${await response.text()}`);
     }
     return {
         get: async (path, queryParams) => {
@@ -73,7 +73,7 @@ function SimpleHttpClient(baseUrl, apiKey, fetch, defaultTimeout, debug = false)
 }
 
 // Path: studiojs/src/resources/markets.ts
-function create$q(_) {
+function create$r(_) {
     const actions = {
         /***
          * This is used to construct the action from the request body
@@ -103,7 +103,7 @@ function create$q(_) {
     return actions;
 }
 
-function create$p(httpClient) {
+function create$q(httpClient) {
     let activity = {
         /**
          * List activity logs for a market with pagination and filtering
@@ -155,7 +155,7 @@ function create$p(httpClient) {
     return activity;
 }
 
-function create$o(httpClient) {
+function create$p(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/adjustments`);
@@ -172,7 +172,7 @@ function create$o(httpClient) {
     };
 }
 
-function create$n(httpClient) {
+function create$o(httpClient) {
     return {
         /**
          * Get the full cart for a customer including extras and uninvoiced lots
@@ -195,7 +195,7 @@ function create$n(httpClient) {
     };
 }
 
-function create$m(httpClient) {
+function create$n(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/extras`);
@@ -215,7 +215,7 @@ function create$m(httpClient) {
 /***
  * Bidder applications
  */
-function create$l(httpClient) {
+function create$m(httpClient) {
     let applications = {
         /**
          * List applications for a market with optional filtering
@@ -298,6 +298,13 @@ function create$l(httpClient) {
     return applications;
 }
 
+function create$l(httpClient) {
+    return {
+        send: async (marketId, data) => httpClient.post(`/${marketId}/broadcast/send`, data),
+        get: async (marketId, type, taskId) => httpClient.get(`/${marketId}/broadcast/${type}/${taskId}`),
+    };
+}
+
 // Path: studiojs/src/resources/markets.ts
 function create$k(httpClient) {
     let customers = {
@@ -5955,6 +5962,43 @@ function create$a(httpClient) {
 }
 
 function create$9(httpClient) {
+    let reports = {
+        getDebtOperationalOverview: async (marketId, options) => {
+            let queryParams = {};
+            if ((options === null || options === void 0 ? void 0 : options.comparisonDays) !== undefined) {
+                queryParams.comparisonDays = options.comparisonDays;
+            }
+            return httpClient.get(`/${marketId}/debt/operational-overview`, queryParams);
+        },
+        getDebtBehavior: async (marketId, options) => {
+            let overview = await reports.getDebtOperationalOverview(marketId, options);
+            return {
+                customers: overview.customers.map((customer) => ({
+                    customerId: customer.customerId,
+                    displayName: customer.displayName,
+                    accountNumber: customer.accountNumber,
+                    balanceInCents: customer.balanceInCents,
+                    balanceXDaysAgoInCents: customer.balanceXDaysAgoInCents,
+                    balanceChangeInCents: customer.balanceChangeInCents,
+                    balanceChangePercent: customer.balanceChangePercent,
+                    paymentBehavior: customer.paymentBehavior,
+                    warningSignCodes: customer.warningSignCodes,
+                    warningSignLabels: customer.warningSignLabels,
+                })),
+            };
+        },
+        getDebtProduct: async (marketId, options) => {
+            let queryParams = {};
+            if ((options === null || options === void 0 ? void 0 : options.limit) !== undefined) {
+                queryParams.limit = options.limit;
+            }
+            return httpClient.get(`/${marketId}/debt/outstanding-by-product`, queryParams);
+        },
+    };
+    return reports;
+}
+
+function create$8(httpClient) {
     return {
         get: async (marketId, saleId, options) => {
             return httpClient.get(`/${marketId}/sales/${saleId}`, (options === null || options === void 0 ? void 0 : options.at) ? { at: options.at } : undefined);
@@ -5971,7 +6015,7 @@ function create$9(httpClient) {
     };
 }
 
-function create$8(httpClient) {
+function create$7(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/sale-templates`);
@@ -5991,7 +6035,7 @@ function create$8(httpClient) {
     };
 }
 
-function create$7(httpClient) {
+function create$6(httpClient) {
     let search = {
         /**
          * Search for documents within a market
@@ -6006,7 +6050,7 @@ function create$7(httpClient) {
     return search;
 }
 
-function create$6(httpClient) {
+function create$5(httpClient) {
     return {
         get: async (marketId, options) => {
             return httpClient.get(`/${marketId}/settings`, (options === null || options === void 0 ? void 0 : options.at) ? { at: options.at } : undefined);
@@ -6014,60 +6058,13 @@ function create$6(httpClient) {
     };
 }
 
-function create$5(httpClient) {
-    return {
-        list: async (marketId) => {
-            return httpClient.get(`/${marketId}/tax_rates`);
-        },
-        get: async (marketId, id) => {
-            return httpClient.get(`/${marketId}/tax_rates/${id}`);
-        },
-    };
-}
-
-// Path: studiojs/src/resources/markets.ts
-function create$4(_) {
-    const webhooks = {
-        /***
-         * This is used to construct the webhook event from the request body
-         * @param body the request body
-         * @param signature the signature of the request taken from the header
-         * @param endpointSecret the pre-shared secret
-         * @returns the webhook event
-         */
-        constructEvent: async (bodyAsBuffer, signature, endpointSecret) => {
-            if (!endpointSecret) {
-                throw new Error("Endpoint secret is required");
-            }
-            if (!signature) {
-                throw new Error("Signature is required");
-            }
-            let bodyText = bodyAsBuffer.toString();
-            let expectedSignature = createHmac("sha256", endpointSecret)
-                .update(bodyText)
-                .digest("hex");
-            if (signature !== expectedSignature) {
-                console.error(`Unable to construct event. Signature mismatch.`, signature, "!=", expectedSignature);
-                throw new Error(`Unable to construct event. Signature mismatch.`);
-            }
-            try {
-                return JSON.parse(bodyText);
-            }
-            catch (e) {
-                throw new Error(`Unable to construct event. ${e}`);
-            }
-        },
-    };
-    return webhooks;
-}
-
-function create$3(httpClient) {
+function create$4(httpClient) {
     return {
         lookup: async (marketId, cph) => httpClient.get(`/${marketId}/cph`, { cph }),
     };
 }
 
-function create$2(httpClient) {
+function create$3(httpClient) {
     return {
         list: async (marketId, customerId, params) => {
             const query = {};
@@ -6092,7 +6089,7 @@ function create$2(httpClient) {
     };
 }
 
-function create$1(httpClient) {
+function create$2(httpClient) {
     let ledger = {
         /**
          * Get the current balance for a ledger account
@@ -6153,42 +6150,83 @@ function create$1(httpClient) {
     return ledger;
 }
 
-function create(httpClient) {
+function create$1(httpClient) {
     return {
-        sendSMS: async (marketId, data) => httpClient.post(`/${marketId}/sms/send`, data),
-        getSMS: async (marketId, smsId) => httpClient.get(`/${marketId}/sms/${smsId}`),
+        list: async (marketId) => {
+            return httpClient.get(`/${marketId}/tax_rates`);
+        },
+        get: async (marketId, id) => {
+            return httpClient.get(`/${marketId}/tax_rates/${id}`);
+        },
     };
 }
 
+// Path: studiojs/src/resources/markets.ts
+function create(_) {
+    const webhooks = {
+        /***
+         * This is used to construct the webhook event from the request body
+         * @param body the request body
+         * @param signature the signature of the request taken from the header
+         * @param endpointSecret the pre-shared secret
+         * @returns the webhook event
+         */
+        constructEvent: async (bodyAsBuffer, signature, endpointSecret) => {
+            if (!endpointSecret) {
+                throw new Error("Endpoint secret is required");
+            }
+            if (!signature) {
+                throw new Error("Signature is required");
+            }
+            let bodyText = bodyAsBuffer.toString();
+            let expectedSignature = createHmac("sha256", endpointSecret)
+                .update(bodyText)
+                .digest("hex");
+            if (signature !== expectedSignature) {
+                console.error(`Unable to construct event. Signature mismatch.`, signature, "!=", expectedSignature);
+                throw new Error(`Unable to construct event. Signature mismatch.`);
+            }
+            try {
+                return JSON.parse(bodyText);
+            }
+            catch (e) {
+                throw new Error(`Unable to construct event. ${e}`);
+            }
+        },
+    };
+    return webhooks;
+}
+
 function resources(httpClient) {
     return {
-        activity: create$p(httpClient),
+        activity: create$q(httpClient),
+        broadcast: create$l(httpClient),
         markets: create$e(httpClient),
         members: create$d(httpClient),
-        sales: create$9(httpClient),
+        sales: create$8(httpClient),
         lots: create$f(httpClient),
         lotitems: create$g(httpClient),
-        carts: create$n(httpClient),
-        cph: create$3(httpClient),
-        webhooks: create$4(),
-        actions: create$q(),
-        bidderApplications: create$l(httpClient),
-        settings: create$6(httpClient),
-        adjustments: create$o(httpClient),
-        extras: create$m(httpClient),
+        carts: create$o(httpClient),
+        cph: create$4(httpClient),
+        webhooks: create(),
+        actions: create$r(),
+        bidderApplications: create$m(httpClient),
+        settings: create$5(httpClient),
+        adjustments: create$p(httpClient),
+        extras: create$n(httpClient),
         productCodes: create$a(httpClient),
-        saleTemplates: create$8(httpClient),
-        taxRates: create$5(httpClient),
+        saleTemplates: create$7(httpClient),
+        taxRates: create$1(httpClient),
         customers: create$k(httpClient),
         customerLists: create$j(httpClient),
         invoices: create$h(httpClient),
         payments: create$c(httpClient),
         payouts: create$b(httpClient),
-        search: create$7(httpClient),
+        reports: create$9(httpClient),
+        search: create$6(httpClient),
         files: create$i(),
-        contacts: create$2(httpClient),
-        ledger: create$1(httpClient),
-        sms: create(httpClient),
+        contacts: create$3(httpClient),
+        ledger: create$2(httpClient),
     };
 }
 

package/dist/index.js

@@ -55,7 +55,7 @@ function SimpleHttpClient(baseUrl, apiKey, fetch, defaultTimeout, debug = false)
         if (response.status === 404) {
             throw new Error(`${baseUrl}${path} not found`);
         }
-        throw new Error(`Request failed with status ${response.status}: ${await response.text()}}`);
+        throw new Error(`Request failed with status ${response.status}: ${await response.text()}`);
     }
     return {
         get: async (path, queryParams) => {
@@ -77,7 +77,7 @@ function SimpleHttpClient(baseUrl, apiKey, fetch, defaultTimeout, debug = false)
 }
 
 // Path: studiojs/src/resources/markets.ts
-function create$q(_) {
+function create$r(_) {
     const actions = {
         /***
          * This is used to construct the action from the request body
@@ -107,7 +107,7 @@ function create$q(_) {
     return actions;
 }
 
-function create$p(httpClient) {
+function create$q(httpClient) {
     let activity = {
         /**
          * List activity logs for a market with pagination and filtering
@@ -159,7 +159,7 @@ function create$p(httpClient) {
     return activity;
 }
 
-function create$o(httpClient) {
+function create$p(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/adjustments`);
@@ -176,7 +176,7 @@ function create$o(httpClient) {
     };
 }
 
-function create$n(httpClient) {
+function create$o(httpClient) {
     return {
         /**
          * Get the full cart for a customer including extras and uninvoiced lots
@@ -199,7 +199,7 @@ function create$n(httpClient) {
     };
 }
 
-function create$m(httpClient) {
+function create$n(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/extras`);
@@ -219,7 +219,7 @@ function create$m(httpClient) {
 /***
  * Bidder applications
  */
-function create$l(httpClient) {
+function create$m(httpClient) {
     let applications = {
         /**
          * List applications for a market with optional filtering
@@ -302,6 +302,13 @@ function create$l(httpClient) {
     return applications;
 }
 
+function create$l(httpClient) {
+    return {
+        send: async (marketId, data) => httpClient.post(`/${marketId}/broadcast/send`, data),
+        get: async (marketId, type, taskId) => httpClient.get(`/${marketId}/broadcast/${type}/${taskId}`),
+    };
+}
+
 // Path: studiojs/src/resources/markets.ts
 function create$k(httpClient) {
     let customers = {
@@ -5959,6 +5966,43 @@ function create$a(httpClient) {
 }
 
 function create$9(httpClient) {
+    let reports = {
+        getDebtOperationalOverview: async (marketId, options) => {
+            let queryParams = {};
+            if ((options === null || options === void 0 ? void 0 : options.comparisonDays) !== undefined) {
+                queryParams.comparisonDays = options.comparisonDays;
+            }
+            return httpClient.get(`/${marketId}/debt/operational-overview`, queryParams);
+        },
+        getDebtBehavior: async (marketId, options) => {
+            let overview = await reports.getDebtOperationalOverview(marketId, options);
+            return {
+                customers: overview.customers.map((customer) => ({
+                    customerId: customer.customerId,
+                    displayName: customer.displayName,
+                    accountNumber: customer.accountNumber,
+                    balanceInCents: customer.balanceInCents,
+                    balanceXDaysAgoInCents: customer.balanceXDaysAgoInCents,
+                    balanceChangeInCents: customer.balanceChangeInCents,
+                    balanceChangePercent: customer.balanceChangePercent,
+                    paymentBehavior: customer.paymentBehavior,
+                    warningSignCodes: customer.warningSignCodes,
+                    warningSignLabels: customer.warningSignLabels,
+                })),
+            };
+        },
+        getDebtProduct: async (marketId, options) => {
+            let queryParams = {};
+            if ((options === null || options === void 0 ? void 0 : options.limit) !== undefined) {
+                queryParams.limit = options.limit;
+            }
+            return httpClient.get(`/${marketId}/debt/outstanding-by-product`, queryParams);
+        },
+    };
+    return reports;
+}
+
+function create$8(httpClient) {
     return {
         get: async (marketId, saleId, options) => {
             return httpClient.get(`/${marketId}/sales/${saleId}`, (options === null || options === void 0 ? void 0 : options.at) ? { at: options.at } : undefined);
@@ -5975,7 +6019,7 @@ function create$9(httpClient) {
     };
 }
 
-function create$8(httpClient) {
+function create$7(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/sale-templates`);
@@ -5995,7 +6039,7 @@ function create$8(httpClient) {
     };
 }
 
-function create$7(httpClient) {
+function create$6(httpClient) {
     let search = {
         /**
          * Search for documents within a market
@@ -6010,7 +6054,7 @@ function create$7(httpClient) {
     return search;
 }
 
-function create$6(httpClient) {
+function create$5(httpClient) {
     return {
         get: async (marketId, options) => {
             return httpClient.get(`/${marketId}/settings`, (options === null || options === void 0 ? void 0 : options.at) ? { at: options.at } : undefined);
@@ -6018,60 +6062,13 @@ function create$6(httpClient) {
     };
 }
 
-function create$5(httpClient) {
-    return {
-        list: async (marketId) => {
-            return httpClient.get(`/${marketId}/tax_rates`);
-        },
-        get: async (marketId, id) => {
-            return httpClient.get(`/${marketId}/tax_rates/${id}`);
-        },
-    };
-}
-
-// Path: studiojs/src/resources/markets.ts
-function create$4(_) {
-    const webhooks = {
-        /***
-         * This is used to construct the webhook event from the request body
-         * @param body the request body
-         * @param signature the signature of the request taken from the header
-         * @param endpointSecret the pre-shared secret
-         * @returns the webhook event
-         */
-        constructEvent: async (bodyAsBuffer, signature, endpointSecret) => {
-            if (!endpointSecret) {
-                throw new Error("Endpoint secret is required");
-            }
-            if (!signature) {
-                throw new Error("Signature is required");
-            }
-            let bodyText = bodyAsBuffer.toString();
-            let expectedSignature = crypto.createHmac("sha256", endpointSecret)
-                .update(bodyText)
-                .digest("hex");
-            if (signature !== expectedSignature) {
-                console.error(`Unable to construct event. Signature mismatch.`, signature, "!=", expectedSignature);
-                throw new Error(`Unable to construct event. Signature mismatch.`);
-            }
-            try {
-                return JSON.parse(bodyText);
-            }
-            catch (e) {
-                throw new Error(`Unable to construct event. ${e}`);
-            }
-        },
-    };
-    return webhooks;
-}
-
-function create$3(httpClient) {
+function create$4(httpClient) {
     return {
         lookup: async (marketId, cph) => httpClient.get(`/${marketId}/cph`, { cph }),
     };
 }
 
-function create$2(httpClient) {
+function create$3(httpClient) {
     return {
         list: async (marketId, customerId, params) => {
             const query = {};
@@ -6096,7 +6093,7 @@ function create$2(httpClient) {
     };
 }
 
-function create$1(httpClient) {
+function create$2(httpClient) {
     let ledger = {
         /**
          * Get the current balance for a ledger account
@@ -6157,42 +6154,83 @@ function create$1(httpClient) {
     return ledger;
 }
 
-function create(httpClient) {
+function create$1(httpClient) {
     return {
-        sendSMS: async (marketId, data) => httpClient.post(`/${marketId}/sms/send`, data),
-        getSMS: async (marketId, smsId) => httpClient.get(`/${marketId}/sms/${smsId}`),
+        list: async (marketId) => {
+            return httpClient.get(`/${marketId}/tax_rates`);
+        },
+        get: async (marketId, id) => {
+            return httpClient.get(`/${marketId}/tax_rates/${id}`);
+        },
     };
 }
 
+// Path: studiojs/src/resources/markets.ts
+function create(_) {
+    const webhooks = {
+        /***
+         * This is used to construct the webhook event from the request body
+         * @param body the request body
+         * @param signature the signature of the request taken from the header
+         * @param endpointSecret the pre-shared secret
+         * @returns the webhook event
+         */
+        constructEvent: async (bodyAsBuffer, signature, endpointSecret) => {
+            if (!endpointSecret) {
+                throw new Error("Endpoint secret is required");
+            }
+            if (!signature) {
+                throw new Error("Signature is required");
+            }
+            let bodyText = bodyAsBuffer.toString();
+            let expectedSignature = crypto.createHmac("sha256", endpointSecret)
+                .update(bodyText)
+                .digest("hex");
+            if (signature !== expectedSignature) {
+                console.error(`Unable to construct event. Signature mismatch.`, signature, "!=", expectedSignature);
+                throw new Error(`Unable to construct event. Signature mismatch.`);
+            }
+            try {
+                return JSON.parse(bodyText);
+            }
+            catch (e) {
+                throw new Error(`Unable to construct event. ${e}`);
+            }
+        },
+    };
+    return webhooks;
+}
+
 function resources(httpClient) {
     return {
-        activity: create$p(httpClient),
+        activity: create$q(httpClient),
+        broadcast: create$l(httpClient),
         markets: create$e(httpClient),
         members: create$d(httpClient),
-        sales: create$9(httpClient),
+        sales: create$8(httpClient),
         lots: create$f(httpClient),
         lotitems: create$g(httpClient),
-        carts: create$n(httpClient),
-        cph: create$3(httpClient),
-        webhooks: create$4(),
-        actions: create$q(),
-        bidderApplications: create$l(httpClient),
-        settings: create$6(httpClient),
-        adjustments: create$o(httpClient),
-        extras: create$m(httpClient),
+        carts: create$o(httpClient),
+        cph: create$4(httpClient),
+        webhooks: create(),
+        actions: create$r(),
+        bidderApplications: create$m(httpClient),
+        settings: create$5(httpClient),
+        adjustments: create$p(httpClient),
+        extras: create$n(httpClient),
         productCodes: create$a(httpClient),
-        saleTemplates: create$8(httpClient),
-        taxRates: create$5(httpClient),
+        saleTemplates: create$7(httpClient),
+        taxRates: create$1(httpClient),
         customers: create$k(httpClient),
         customerLists: create$j(httpClient),
         invoices: create$h(httpClient),
         payments: create$c(httpClient),
         payouts: create$b(httpClient),
-        search: create$7(httpClient),
+        reports: create$9(httpClient),
+        search: create$6(httpClient),
         files: create$i(),
-        contacts: create$2(httpClient),
-        ledger: create$1(httpClient),
-        sms: create(httpClient),
+        contacts: create$3(httpClient),
+        ledger: create$2(httpClient),
     };
 }
 

package/dist/resources/broadcast.d.ts

@@ -0,0 +1,7 @@
+import { HttpClient } from "../net/http";
+import { BroadcastPayload, BroadcastSendResponse, BroadcastTask, BroadcastType } from "../types";
+export default function create(httpClient: HttpClient): {
+    send: (marketId: string, data: BroadcastPayload) => Promise<BroadcastSendResponse>;
+    get: (marketId: string, type: BroadcastType, taskId: string) => Promise<BroadcastTask>;
+};
+export type Broadcast = ReturnType<typeof create>;

package/dist/resources/reports.d.ts

@@ -0,0 +1,8 @@
+import { HttpClient } from "../net/http";
+import { DebtBehaviorResponse, DebtOperationalOverviewOptions, DebtOperationalOverviewResponse, DebtProductOptions, DebtProductResponse } from "../types";
+export default 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>;
+};
+export type Reports = ReturnType<typeof create>;

package/dist/resources/sales.d.ts

@@ -19,6 +19,7 @@ type CreateSaleRequest = {
     image?: string | null;
     cover?: string | null;
     templateId?: string | null;
+    enableLotGrouping?: boolean;
     attributeDefaults?: {
         [attributekey: string]: string | number | boolean;
     };
@@ -37,6 +38,7 @@ export default function create(httpClient: HttpClient): {
         defaultProductCode?: string;
         attributeDefaults?: Record<string, any>;
         publishStatus?: SalePublishStatus;
+        enableLotGrouping?: boolean;
         marteyeSettings?: {
             description?: string;
             image?: string;