@marteye/studiojs 1.1.45 → 1.1.47-beta.0

package/dist/net/http.d.ts

@@ -1,7 +1,7 @@
 export default function SimpleHttpClient(baseUrl: string, apiKey: string, fetch: any, defaultTimeout: number, debug?: boolean): {
     get: <T>(path: string, queryParams?: any) => Promise<T>;
-    post: <T>(path: string, body: any) => Promise<T>;
-    patch: <T>(path: string, body: any) => Promise<T>;
-    delete: <T>(path: string) => Promise<T>;
+    post: <T_1>(path: string, body: any) => Promise<T_1>;
+    patch: <T_2>(path: string, body: any) => Promise<T_2>;
+    delete: <T_3>(path: string) => Promise<T_3>;
 };
 export type HttpClient = ReturnType<typeof SimpleHttpClient>;

package/dist/resources/actions.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { HttpClient } from "../net/http";
 export default function create(_: HttpClient): {
     /***

package/dist/resources/customerLists.d.ts

@@ -0,0 +1,214 @@
+import { HttpClient } from "../net/http";
+export type CustomerListType = "simple" | "smart";
+export type CustomerListRole = "buyer" | "seller" | "both";
+export interface GeoBounds {
+    north: number;
+    south: number;
+    east: number;
+    west: number;
+}
+export interface RollingDateConfig {
+    windowDays: number;
+    originalStart: string;
+    originalEnd: string;
+}
+export interface CustomerListQuery {
+    role: CustomerListRole;
+    filter?: string;
+    excludeFilters?: string[];
+    bounds?: GeoBounds;
+    rollingDateConfig?: RollingDateConfig;
+    secondaryFilter?: {
+        role: CustomerListRole;
+        filter?: string;
+        bounds?: GeoBounds;
+        rollingDateConfig?: RollingDateConfig;
+    };
+}
+export interface CustomerList {
+    id: string;
+    marketId: string;
+    name: string;
+    slug: string;
+    description?: string;
+    type: CustomerListType;
+    query?: CustomerListQuery;
+    rollingDateConfig?: RollingDateConfig;
+    excludedCustomerIds?: string[];
+    memberCount: number;
+    refreshStatus?: "idle" | "refreshing" | "failed";
+    refreshError?: string;
+    lastRefreshedAt?: string;
+    lastRefreshDurationMs?: number;
+    lastRefreshCostEstimate?: number;
+    lastRollingDateRange?: {
+        start: string;
+        end: string;
+    };
+    createdAt: string;
+    createdBy: string;
+    updatedAt: string;
+    updatedBy: string;
+}
+export interface CustomerListMember {
+    marketId: string;
+    listId: string;
+    customerId: string;
+    dateAdded: string;
+    addedBy: string;
+    customerDisplayName?: string;
+    customerAccountNumber?: string;
+    email?: string;
+    phoneNumber?: string;
+}
+export interface CustomerListFilterGroup {
+    role: CustomerListRole;
+    dateStart?: string | null;
+    dateEnd?: string | null;
+    productCodes?: string[];
+    geoBounds?: GeoBounds | null;
+    rollingDateConfig?: RollingDateConfig;
+}
+export interface CustomerListFilters {
+    role?: CustomerListRole | null;
+    dateStart?: string | null;
+    dateEnd?: string | null;
+    productCodes?: string[];
+    excludeDateStart?: string | null;
+    excludeDateEnd?: string | null;
+    excludedProductCodes?: string[];
+    geoBounds?: GeoBounds | null;
+    boughtOnlineOnly?: boolean;
+    cattleBreeds?: string[];
+    sheepBreeds?: string[];
+    rollingDateConfig?: RollingDateConfig;
+    secondaryFilter?: CustomerListFilterGroup | null;
+}
+export interface CustomerListReportRow {
+    customerId: string;
+    displayName?: string | null;
+    accountNumber?: string | null;
+    purchasedItemCount: number;
+    totalPurchasedValueInCents: number;
+    soldItemCount: number;
+    totalSoldValueInCents: number;
+    lastSaleDate?: string | null;
+    lastPurchaseDate?: string | null;
+    productCodesSold?: string[] | null;
+    productCodesBought?: string[] | null;
+    latitude?: number | null;
+    longitude?: number | null;
+    address1?: string | null;
+    address2?: string | null;
+    city?: string | null;
+    province?: string | null;
+    zip?: string | null;
+    country?: string | null;
+    email?: string | null;
+    phoneNumber?: string | null;
+}
+export interface CustomerListReportSummary {
+    totalCustomers: number;
+    totalSoldValueInCents: number;
+    totalPurchasedValueInCents: number;
+    customersWithLocation: number;
+    uniqueProductCodes: string[];
+}
+export type CustomerListViewResult = {
+    mode: "simple";
+    list: CustomerList;
+    members: CustomerListMember[];
+    total: number;
+} | {
+    mode: "smart";
+    list: CustomerList;
+    effectiveFilters: CustomerListFilters;
+    rows: CustomerListReportRow[];
+    summary: CustomerListReportSummary;
+};
+export interface CustomerListsListOptions {
+    type?: CustomerListType;
+    limit?: number;
+    offset?: number;
+}
+export interface CustomerListMembersOptions {
+    limit?: number;
+    offset?: number;
+    includeArchived?: boolean;
+}
+export interface CustomerListViewOptions {
+    identifierType?: "auto" | "id" | "slug";
+    limit?: number;
+    offset?: number;
+    allMembers?: boolean;
+    refresh?: boolean;
+}
+export interface CustomerListsListResponse {
+    lists: CustomerList[];
+    total: number;
+}
+export interface CustomerListMembersResponse {
+    members: CustomerListMember[];
+    total: number;
+    hasMore: boolean;
+}
+export interface CustomerListPreviewResponse {
+    rows: CustomerListReportRow[];
+    summary: CustomerListReportSummary;
+}
+export interface CustomerListProductCodesResponse {
+    uniqueProductCodes: string[];
+}
+export interface CustomerListAddMembersResponse {
+    added: number;
+    alreadyMembers: number;
+    notFound: number;
+    memberCount: number;
+}
+export interface CustomerListRemoveMemberResponse {
+    removed: boolean;
+    memberCount: number;
+}
+export interface CustomerListDeleteResponse {
+    deleted: boolean;
+    membersRemoved: number;
+}
+export interface CustomerListRefreshResponse {
+    refreshStatus: "refreshing";
+    message: string;
+}
+export type CreateCustomerListPayload = {
+    name: string;
+    description?: string;
+    type: "simple";
+} | {
+    name: string;
+    description?: string;
+    type: "smart";
+    query?: CustomerListQuery;
+    filters?: CustomerListFilters;
+};
+export interface UpdateCustomerListPayload {
+    name?: string;
+    description?: string | null;
+    query?: CustomerListQuery;
+    filters?: Partial<CustomerListFilters>;
+}
+export default function create(httpClient: HttpClient): {
+    list: (marketId: string, options?: CustomerListsListOptions) => Promise<CustomerListsListResponse>;
+    listAll: (marketId: string, options?: Omit<CustomerListsListOptions, "offset">) => Promise<CustomerList[]>;
+    get: (marketId: string, listId: string) => Promise<CustomerList>;
+    getBySlug: (marketId: string, slug: string) => Promise<CustomerList>;
+    create: (marketId: string, payload: CreateCustomerListPayload) => Promise<CustomerList>;
+    update: (marketId: string, listId: string, payload: UpdateCustomerListPayload) => Promise<CustomerList>;
+    delete: (marketId: string, listId: string) => Promise<CustomerListDeleteResponse>;
+    refresh: (marketId: string, listId: string) => Promise<CustomerListRefreshResponse>;
+    getMembers: (marketId: string, listId: string, options?: CustomerListMembersOptions) => Promise<CustomerListMembersResponse>;
+    getAllMembers: (marketId: string, listId: string, options?: Omit<CustomerListMembersOptions, "offset">) => Promise<CustomerListMember[]>;
+    addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<CustomerListAddMembersResponse>;
+    removeMember: (marketId: string, listId: string, customerId: string) => Promise<CustomerListRemoveMemberResponse>;
+    preview: (marketId: string, filters: CustomerListFilters) => Promise<CustomerListPreviewResponse>;
+    listProductCodes: (marketId: string) => Promise<CustomerListProductCodesResponse>;
+    view: (marketId: string, listIdOrSlug: string, options?: CustomerListViewOptions) => Promise<CustomerListViewResult>;
+};
+export type CustomerLists = ReturnType<typeof create>;

package/dist/resources/lots.d.ts

@@ -1,5 +1,5 @@
 import { HttpClient } from "../net/http";
-import { Lot, LotSaleStatus, ReadOptions } from "../types";
+import { DeleteLotsResponse, Lot, LotDeletePreflightResponse, LotSaleStatus, ReadOptions } from "../types";
 /**
  * Defines the possible status values for a lot in a sale
  */
@@ -50,5 +50,8 @@ export default function create(httpClient: HttpClient): {
         inputAccessories?: Record<string, any>;
     }) => Promise<Lot>;
     delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
+    deletePreflight: (marketId: string, saleId: string, lotId: string) => Promise<LotDeletePreflightResponse>;
+    deletePreflightBatch: (marketId: string, saleId: string, lotIds: string[]) => Promise<DeleteLotsResponse>;
+    deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[]) => Promise<DeleteLotsResponse>;
 };
 export type Lots = ReturnType<typeof create>;

package/dist/resources/sales.d.ts

@@ -70,6 +70,7 @@ export default function create(httpClient: HttpClient): {
             cascade?: boolean;
             reportEmail?: string;
             queueLots?: boolean;
+            markSubjectLotsAsSold?: boolean;
         } | null;
     }) => Promise<Sale>;
 };

package/dist/resources/sms.d.ts

@@ -0,0 +1,7 @@
+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>;

package/dist/resources/webhooks.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { HttpClient } from "../net/http";
 import { WebhookEvent } from "../types";
 export default function create(_: HttpClient): {