@marteye/studiojs 1.1.37 → 1.1.39

package/dist/index.d.ts

@@ -8,6 +8,48 @@ declare function SimpleHttpClient(baseUrl: string, apiKey: string, fetch: any, d
 };
 type HttpClient = ReturnType<typeof SimpleHttpClient>;
 
+interface LedgerBalanceResponse {
+    balanceInCents: number;
+}
+interface LedgerTransaction {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    transactionDate: string;
+    marketId: string;
+    account: string;
+    rollUpAccounts: string[];
+    accountType: "income" | "expense" | "asset" | "liability" | "equity";
+    accountName: string;
+    owner: "market" | string;
+    isMarketAccount: boolean;
+    amountInCents: number;
+    batchId: string;
+    batchDescription: string;
+    referenceId: string;
+    referenceType: string;
+    referenceTxnCount: number;
+    referenceGroupKey: string;
+    tags: Record<string, string | number | boolean>;
+    parentTransactionId: string | null;
+    currentBalanceInCents: number;
+    sumOfCreditsInCents: number;
+    sumOfDebitsInCents: number;
+    index: number;
+}
+interface TransactionsListResponse {
+    transactions: LedgerTransaction[];
+    nextCursor: string | null;
+    hasMore: boolean;
+}
+interface ListTransactionsParams {
+    account: string;
+    dateFrom?: string;
+    dateTo?: string;
+    limit?: number;
+    cursor?: string;
+}
+
 type Timestamp = string;
 type ClientType = "Seller" | "Buyer";
 type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
@@ -56,6 +98,7 @@ interface SettingsMarketDefaults {
     defaultUnitOfSale: UnitOfSale;
     defaultSuperType?: SuperType | null;
     defaultSettleDebtsFirst?: boolean;
+    liveEmailsEnabled?: boolean;
     lotDescriptionTemplateMap?: {
         default: string | undefined;
         [supertype: string]: string | undefined;
@@ -119,6 +162,7 @@ type DisplayBoardMode = "off" | "live" | "manual" | {
     type: "focused";
     field: string;
 };
+type SalePublishStatus = "unpublished" | "sale" | "saleAndCatalog";
 interface Sale {
     id: string;
     createdAt: Timestamp;
@@ -186,6 +230,13 @@ interface Sale {
         };
     };
     editedBy?: string[];
+    /**
+     * Publishing status for external systems
+     * - unpublished: Not listed in external system
+     * - sale: Sale date is listed externally
+     * - saleAndCatalog: Sale and catalog information synced
+     */
+    publishStatus?: SalePublishStatus;
 }
 interface TemplateSaleData {
     name?: string;
@@ -630,6 +681,7 @@ interface Customer {
     notes?: string;
     status?: "archived" | "deleted" | null;
     deleteAfter?: Timestamp;
+    casualBuyerLabels?: string[];
 }
 interface CustomerFromSearch extends Omit<Customer, "createdAt" | "updatedAt" | "lastItemPurchaseDate" | "lastItemSaleDate"> {
     createdAt: number;
@@ -1066,6 +1118,7 @@ interface AttributeDefinition {
     prefillableFromPreviousLot?: boolean;
     hidden?: boolean;
     showInSellerDetailsPanel?: boolean;
+    showInSellerReviewPanel?: boolean;
     displayTemplate?: string;
     displayTemplateMultiValue?: string;
     type: SupportedAttributeTypes;
@@ -1116,8 +1169,33 @@ interface CphLookupResponse {
     cphValid?: boolean | null;
     farmName?: string | null;
 }
+type ActivityOperation = "created" | "updated" | "deleted" | "voided";
+interface ActivityChange {
+    before?: any;
+    after?: any;
+}
+interface ActivityLog {
+    id: string;
+    firstEventAt: Timestamp;
+    lastEventAt: Timestamp;
+    userId: string | null;
+    userName?: string;
+    eventType: WebhookEventName;
+    entityType: ObjectType;
+    entityId: string;
+    entityLabel?: string;
+    saleIds: string[];
+    operation: ActivityOperation;
+    changeCount: number;
+    changes?: {
+        [fieldPath: string]: ActivityChange;
+    };
+}
 
 type types_Accessory = Accessory;
+type types_ActivityChange = ActivityChange;
+type types_ActivityLog = ActivityLog;
+type types_ActivityOperation = ActivityOperation;
 type types_Address = Address;
 type types_AddressWrapper = AddressWrapper;
 type types_AdjustmentTarget = AdjustmentTarget;
@@ -1182,6 +1260,7 @@ type types_ProductCodeConfiguration = ProductCodeConfiguration;
 type types_ProductConfiguration = ProductConfiguration;
 type types_Sale = Sale;
 type types_SaleFromSearch = SaleFromSearch;
+type types_SalePublishStatus = SalePublishStatus;
 type types_SaleTemplate = SaleTemplate;
 type types_SettingsAccessories = SettingsAccessories;
 type types_SettingsAdjustmentsConfiguration = SettingsAdjustmentsConfiguration;
@@ -1214,7 +1293,7 @@ type types_WebhookEventName = WebhookEventName;
 declare const types_supportedWebhookEvents: typeof supportedWebhookEvents;
 declare namespace types {
   export { types_IMAGE_SIZES_VALUES as IMAGE_SIZES_VALUES, types_LivestockSuperTypes as LivestockSuperTypes, types_SupportedCurrencyCodes as SupportedCurrencyCodes, types_SupportedPaymentMethods as SupportedPaymentMethods, types_SupportedSuperTypes as SupportedSuperTypes, types_SupportedUnitsOfSale as SupportedUnitsOfSale, types_VIDEO_TASKS_VALUES as VIDEO_TASKS_VALUES, types_supportedWebhookEvents as supportedWebhookEvents };
-  export type { types_Accessory as Accessory, types_Address as Address, types_AddressWrapper as AddressWrapper, types_AdjustmentTarget as AdjustmentTarget, types_AdjustmentTotalTarget as AdjustmentTotalTarget, types_AdjustmentsConfiguration as AdjustmentsConfiguration, types_AppParameterConfig as AppParameterConfig, types_Application as Application, types_AttributeDefinition as AttributeDefinition, types_AttributeValueType as AttributeValueType, types_BankDetails as BankDetails, types_Cart as Cart, types_CartItem as CartItem, types_ChequeField as ChequeField, types_ClientType as ClientType, types_CphLookupResponse as CphLookupResponse, types_CurrenciesWithGuinea as CurrenciesWithGuinea, types_Currency as Currency, types_Customer as Customer, types_CustomerBankDetails as CustomerBankDetails, types_CustomerContact as CustomerContact, types_CustomerFromSearch as CustomerFromSearch, types_DeviceType as DeviceType, types_DisplayBoardMode as DisplayBoardMode, types_DraftInvoice as DraftInvoice, types_EmailWrapper as EmailWrapper, types_FarmAssurances as FarmAssurances, types_FieldPositions as FieldPositions, types_ImageSizes as ImageSizes, types_IncrementLadder as IncrementLadder, types_IncrementLadderItem as IncrementLadderItem, types_Invoice as Invoice, types_InvoiceDeliveryPreference as InvoiceDeliveryPreference, types_InvoiceField as InvoiceField, types_InvoiceLineItem as InvoiceLineItem, types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, types_InvoiceTotals as InvoiceTotals, types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_Lot as Lot, types_LotGeneratedValues as LotGeneratedValues, types_LotIssue as LotIssue, types_LotItem as LotItem, types_LotSaleStatus as LotSaleStatus, types_LotWithItemsAsArray as LotWithItemsAsArray, types_Market as Market, types_MarketBankDetails as MarketBankDetails, types_MarketReportHeaders as MarketReportHeaders, types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, types_Media as Media, types_MemberSharingConfiguration as MemberSharingConfiguration, types_ObjectType as ObjectType, types_Payment as Payment, types_PaymentMethod as PaymentMethod, types_Payout as Payout, types_PayoutMethod as PayoutMethod, types_PhoneNumberWrapper as PhoneNumberWrapper, types_Printer as Printer, types_Product as Product, types_ProductCodeConfiguration as ProductCodeConfiguration, types_ProductConfiguration as ProductConfiguration, types_Sale as Sale, types_SaleFromSearch as SaleFromSearch, types_SaleTemplate as SaleTemplate, types_SettingsAccessories as SettingsAccessories, types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, types_SettingsGlobalAttributes as SettingsGlobalAttributes, types_SettingsMarketDefaults as SettingsMarketDefaults, types_SettingsPrinters as SettingsPrinters, types_SettingsProductCodes as SettingsProductCodes, types_SettingsTaxRates as SettingsTaxRates, types_ShortCustomerDetails as ShortCustomerDetails, types_SimplePaymentIn as SimplePaymentIn, types_SimplePaymentOut as SimplePaymentOut, types_StoredDataGridConfig as StoredDataGridConfig, types_StudioAppPartial as StudioAppPartial, types_SubtotalGroups as SubtotalGroups, types_SuperType as SuperType, types_SupportedAttributeTypes as SupportedAttributeTypes, types_SupportedCountryCode as SupportedCountryCode, SupportedFileTypesNames$1 as SupportedFileTypesNames, types_TablePosition as TablePosition, types_TaxRate as TaxRate, types_TemplateSaleData as TemplateSaleData, types_UnitOfSale as UnitOfSale, types_VideoTasks as VideoTasks, types_WebhookEvent as WebhookEvent, types_WebhookEventName as WebhookEventName };
+  export type { types_Accessory as Accessory, types_ActivityChange as ActivityChange, types_ActivityLog as ActivityLog, types_ActivityOperation as ActivityOperation, types_Address as Address, types_AddressWrapper as AddressWrapper, types_AdjustmentTarget as AdjustmentTarget, types_AdjustmentTotalTarget as AdjustmentTotalTarget, types_AdjustmentsConfiguration as AdjustmentsConfiguration, types_AppParameterConfig as AppParameterConfig, types_Application as Application, types_AttributeDefinition as AttributeDefinition, types_AttributeValueType as AttributeValueType, types_BankDetails as BankDetails, types_Cart as Cart, types_CartItem as CartItem, types_ChequeField as ChequeField, types_ClientType as ClientType, types_CphLookupResponse as CphLookupResponse, types_CurrenciesWithGuinea as CurrenciesWithGuinea, types_Currency as Currency, types_Customer as Customer, types_CustomerBankDetails as CustomerBankDetails, types_CustomerContact as CustomerContact, types_CustomerFromSearch as CustomerFromSearch, types_DeviceType as DeviceType, types_DisplayBoardMode as DisplayBoardMode, types_DraftInvoice as DraftInvoice, types_EmailWrapper as EmailWrapper, types_FarmAssurances as FarmAssurances, types_FieldPositions as FieldPositions, types_ImageSizes as ImageSizes, types_IncrementLadder as IncrementLadder, types_IncrementLadderItem as IncrementLadderItem, types_Invoice as Invoice, types_InvoiceDeliveryPreference as InvoiceDeliveryPreference, types_InvoiceField as InvoiceField, types_InvoiceLineItem as InvoiceLineItem, types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, types_InvoiceTotals as InvoiceTotals, types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_Lot as Lot, types_LotGeneratedValues as LotGeneratedValues, types_LotIssue as LotIssue, types_LotItem as LotItem, types_LotSaleStatus as LotSaleStatus, types_LotWithItemsAsArray as LotWithItemsAsArray, types_Market as Market, types_MarketBankDetails as MarketBankDetails, types_MarketReportHeaders as MarketReportHeaders, types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, types_Media as Media, types_MemberSharingConfiguration as MemberSharingConfiguration, types_ObjectType as ObjectType, types_Payment as Payment, types_PaymentMethod as PaymentMethod, types_Payout as Payout, types_PayoutMethod as PayoutMethod, types_PhoneNumberWrapper as PhoneNumberWrapper, types_Printer as Printer, types_Product as Product, types_ProductCodeConfiguration as ProductCodeConfiguration, types_ProductConfiguration as ProductConfiguration, types_Sale as Sale, types_SaleFromSearch as SaleFromSearch, types_SalePublishStatus as SalePublishStatus, types_SaleTemplate as SaleTemplate, types_SettingsAccessories as SettingsAccessories, types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, types_SettingsGlobalAttributes as SettingsGlobalAttributes, types_SettingsMarketDefaults as SettingsMarketDefaults, types_SettingsPrinters as SettingsPrinters, types_SettingsProductCodes as SettingsProductCodes, types_SettingsTaxRates as SettingsTaxRates, types_ShortCustomerDetails as ShortCustomerDetails, types_SimplePaymentIn as SimplePaymentIn, types_SimplePaymentOut as SimplePaymentOut, types_StoredDataGridConfig as StoredDataGridConfig, types_StudioAppPartial as StudioAppPartial, types_SubtotalGroups as SubtotalGroups, types_SuperType as SuperType, types_SupportedAttributeTypes as SupportedAttributeTypes, types_SupportedCountryCode as SupportedCountryCode, SupportedFileTypesNames$1 as SupportedFileTypesNames, types_TablePosition as TablePosition, types_TaxRate as TaxRate, types_TemplateSaleData as TemplateSaleData, types_UnitOfSale as UnitOfSale, types_VideoTasks as VideoTasks, types_WebhookEvent as WebhookEvent, types_WebhookEventName as WebhookEventName };
 }
 
 interface ListContactsResponse {
@@ -1346,6 +1425,31 @@ interface PayoutsListResponse {
     lastId: string | null;
     hasMore: boolean;
 }
+interface PayoutCreateResponse {
+    payout: Payout;
+}
+interface CreatePayoutRequest {
+    /** IDs of the seller invoices this payout is for. All must be for the same customer and have status "issued". */
+    invoiceIds: string[];
+    /** Payout method */
+    method: "BACS" | "Cheque" | "Cash";
+    /** Payout amount in cents. If not provided, defaults to the sum of amountDueInCents across all invoices. */
+    amountInCents?: number;
+    /** Transaction date (ISO 8601). Defaults to now. */
+    transactionDate?: string;
+    /** Cheque number or BACS reference */
+    reference?: string | null;
+    /** Optional notes */
+    notes?: string | null;
+    /** Account holder name (BACS only). Falls back to customer bank details or display name. */
+    accountName?: string;
+    /** 8-digit account number (BACS only). Falls back to customer bank details. */
+    accountNumber?: string;
+    /** 6-digit sort code (BACS only). Falls back to customer bank details. */
+    sortCode?: string;
+    /** Name on cheque (Cheque only). Falls back to customer display name. */
+    chequeMadePayableTo?: string;
+}
 
 interface PaymentsListResponse {
     payments: Payment[];
@@ -1501,7 +1605,47 @@ interface ListApplicationsResponse {
     hasMore: boolean;
 }
 
+interface LotsBySale {
+    saleId: string;
+    marketId: string;
+    lots: Lot[];
+}
+interface CartResponse {
+    customerId: string;
+    extras: CartItem[];
+    lotsBuyingBySale: LotsBySale[];
+    lotsSellingBySale: LotsBySale[];
+}
+interface AddExtraPayload {
+    productId: string;
+    clientType: "Seller" | "Buyer";
+    quantity: number;
+    unitPriceInCents: number;
+    passthroughFundsToCustomerId?: string | null;
+}
+
+interface ActivityListResponse {
+    data: ActivityLog[];
+    lastId: string | null;
+    hasMore: boolean;
+}
+interface ActivityListParams {
+    saleId?: string;
+    entityType?: string;
+    entityId?: string;
+    operation?: string;
+    memberId?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+    lastId?: string;
+}
+
 declare function resources(httpClient: HttpClient): {
+    activity: {
+        list: (marketId: string, params?: ActivityListParams) => Promise<ActivityListResponse>;
+        get: (marketId: string, activityId: string) => Promise<ActivityLog>;
+    };
     markets: {
         get: (marketId: string) => Promise<Market>;
     };
@@ -1538,6 +1682,7 @@ declare function resources(httpClient: HttpClient): {
             recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
             defaultProductCode?: string;
             attributeDefaults?: Record<string, any>;
+            publishStatus?: SalePublishStatus;
             marteyeSettings?: {
                 description?: string;
                 image?: string;
@@ -1637,6 +1782,11 @@ declare function resources(httpClient: HttpClient): {
         }) => Promise<LotItem>;
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
+    carts: {
+        get: (marketId: string, customerId: string) => Promise<CartResponse>;
+        addExtra: (marketId: string, customerId: string, data: AddExtraPayload) => Promise<CartResponse>;
+        removeExtra: (marketId: string, customerId: string, itemId: string) => Promise<void>;
+    };
     cph: {
         lookup: (marketId: string, cph: string) => Promise<CphLookupResponse>;
     };
@@ -1723,6 +1873,7 @@ declare function resources(httpClient: HttpClient): {
     payouts: {
         list: (marketId: string, lastId?: string | null) => Promise<PayoutsListResponse>;
         get: (marketId: string, payoutId: string) => Promise<Payout>;
+        create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
     };
     search: {
         query: (marketId: string, query: string) => Promise<SearchResult>;
@@ -1751,6 +1902,12 @@ declare function resources(httpClient: HttpClient): {
         update: (marketId: string, customerId: string, contactId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
         delete: (marketId: string, customerId: string, contactId: string) => Promise<void>;
     };
+    ledger: {
+        getBalance: (marketId: string, account: string) => Promise<LedgerBalanceResponse>;
+        getTransaction: (marketId: string, transactionId: string) => Promise<LedgerTransaction>;
+        getLatestTransaction: (marketId: string, account: string) => Promise<LedgerTransaction>;
+        listTransactions: (marketId: string, params: ListTransactionsParams) => Promise<TransactionsListResponse>;
+    };
 };
 
 type StudioInstance = ReturnType<typeof resources> & {
@@ -1763,6 +1920,10 @@ declare function Studio(info?: {
     debug?: boolean;
 }): {
     isDebugMode: boolean;
+    activity: {
+        list: (marketId: string, params?: ActivityListParams) => Promise<ActivityListResponse>;
+        get: (marketId: string, activityId: string) => Promise<ActivityLog>;
+    };
     markets: {
         get: (marketId: string) => Promise<Market>;
     };
@@ -1799,6 +1960,7 @@ declare function Studio(info?: {
             recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
             defaultProductCode?: string;
             attributeDefaults?: Record<string, any>;
+            publishStatus?: SalePublishStatus;
             marteyeSettings?: {
                 description?: string;
                 image?: string;
@@ -1898,6 +2060,11 @@ declare function Studio(info?: {
         }) => Promise<LotItem>;
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
+    carts: {
+        get: (marketId: string, customerId: string) => Promise<CartResponse>;
+        addExtra: (marketId: string, customerId: string, data: AddExtraPayload) => Promise<CartResponse>;
+        removeExtra: (marketId: string, customerId: string, itemId: string) => Promise<void>;
+    };
     cph: {
         lookup: (marketId: string, cph: string) => Promise<CphLookupResponse>;
     };
@@ -1984,6 +2151,7 @@ declare function Studio(info?: {
     payouts: {
         list: (marketId: string, lastId?: string | null) => Promise<PayoutsListResponse>;
         get: (marketId: string, payoutId: string) => Promise<Payout>;
+        create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
     };
     search: {
         query: (marketId: string, query: string) => Promise<SearchResult>;
@@ -2012,6 +2180,12 @@ declare function Studio(info?: {
         update: (marketId: string, customerId: string, contactId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
         delete: (marketId: string, customerId: string, contactId: string) => Promise<void>;
     };
+    ledger: {
+        getBalance: (marketId: string, account: string) => Promise<LedgerBalanceResponse>;
+        getTransaction: (marketId: string, transactionId: string) => Promise<LedgerTransaction>;
+        getLatestTransaction: (marketId: string, account: string) => Promise<LedgerTransaction>;
+        listTransactions: (marketId: string, params: ListTransactionsParams) => Promise<TransactionsListResponse>;
+    };
 };
 
 /**
@@ -2111,7 +2285,13 @@ declare function sortByLotNumber<T extends {
     lotNumber: string;
 }>(lots: T[]): T[];
 /***
- * Generate the next lot number in a sequence:
+ * Generate the next lot number in a sequence.
+ * Handles various formats:
+ * - Simple: "7" -> "8"
+ * - Alphanumeric: "7A" -> "7B"
+ * - Range: "1-3" -> "4", "1 - 3" -> "4" (flexible whitespace)
+ * - Range with alpha: "1-3A" -> "3B"
+ * - Compound: "1-3, 10" -> "11", "1-5, 7-9" -> "10"
  */
 declare function nextLotNumber(previousLotNumber: string): string;