@marteye/studiojs 1.1.38 → 1.1.39

package/dist/index.d.ts

@@ -11,6 +11,44 @@ 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";
@@ -124,7 +162,7 @@ type DisplayBoardMode = "off" | "live" | "manual" | {
     type: "focused";
     field: string;
 };
-type SalePublishStatus = "unpublished" | "sale" | "catalogPublished";
+type SalePublishStatus = "unpublished" | "sale" | "saleAndCatalog";
 interface Sale {
     id: string;
     createdAt: Timestamp;
@@ -196,7 +234,7 @@ interface Sale {
      * Publishing status for external systems
      * - unpublished: Not listed in external system
      * - sale: Sale date is listed externally
-     * - catalogPublished: Sale and catalog information synced
+     * - saleAndCatalog: Sale and catalog information synced
      */
     publishStatus?: SalePublishStatus;
 }
@@ -643,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;
@@ -1079,6 +1118,7 @@ interface AttributeDefinition {
     prefillableFromPreviousLot?: boolean;
     hidden?: boolean;
     showInSellerDetailsPanel?: boolean;
+    showInSellerReviewPanel?: boolean;
     displayTemplate?: string;
     displayTemplateMultiValue?: string;
     type: SupportedAttributeTypes;
@@ -1129,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;
@@ -1228,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_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 };
+  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 {
@@ -1360,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[];
@@ -1534,7 +1624,28 @@ interface AddExtraPayload {
     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>;
     };
@@ -1762,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>;
@@ -1792,6 +1904,9 @@ declare function resources(httpClient: HttpClient): {
     };
     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>;
     };
 };
 
@@ -1805,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>;
     };
@@ -2032,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>;
@@ -2062,6 +2182,9 @@ declare function Studio(info?: {
     };
     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>;
     };
 };
 

package/dist/index.esm.js

@@ -70,7 +70,7 @@ function SimpleHttpClient(baseUrl, apiKey, fetch, defaultTimeout, debug = false)
 }
 
 // Path: studiojs/src/resources/markets.ts
-function create$m(_) {
+function create$n(_) {
     const actions = {
         /***
          * This is used to construct the action from the request body
@@ -100,6 +100,58 @@ function create$m(_) {
     return actions;
 }
 
+function create$m(httpClient) {
+    let activity = {
+        /**
+         * List activity logs for a market with pagination and filtering
+         * @param marketId - ID of the market
+         * @param params - Optional filtering and pagination parameters
+         * @returns Paginated list of activity logs
+         */
+        list: async (marketId, params) => {
+            let queryParams = {};
+            if (params === null || params === void 0 ? void 0 : params.saleId) {
+                queryParams.saleId = params.saleId;
+            }
+            if (params === null || params === void 0 ? void 0 : params.entityType) {
+                queryParams.entityType = params.entityType;
+            }
+            if (params === null || params === void 0 ? void 0 : params.entityId) {
+                queryParams.entityId = params.entityId;
+            }
+            if (params === null || params === void 0 ? void 0 : params.operation) {
+                queryParams.operation = params.operation;
+            }
+            if (params === null || params === void 0 ? void 0 : params.memberId) {
+                queryParams.memberId = params.memberId;
+            }
+            if (params === null || params === void 0 ? void 0 : params.from) {
+                queryParams.from = params.from;
+            }
+            if (params === null || params === void 0 ? void 0 : params.to) {
+                queryParams.to = params.to;
+            }
+            if ((params === null || params === void 0 ? void 0 : params.limit) !== undefined) {
+                queryParams.limit = String(params.limit);
+            }
+            if (params === null || params === void 0 ? void 0 : params.lastId) {
+                queryParams.lastId = params.lastId;
+            }
+            return httpClient.get(`/${marketId}/activity`, queryParams);
+        },
+        /**
+         * Get a specific activity log by ID
+         * @param marketId - ID of the market
+         * @param activityId - ID of the activity log entry
+         * @returns The activity log details
+         */
+        get: async (marketId, activityId) => {
+            return httpClient.get(`/${marketId}/activity/${activityId}`);
+        },
+    };
+    return activity;
+}
+
 function create$l(httpClient) {
     return {
         list: async (marketId) => {
@@ -5218,6 +5270,17 @@ function create$a(httpClient) {
         get: async (marketId, payoutId) => {
             return httpClient.get(`/${marketId}/payouts/${payoutId}`);
         },
+        /**
+         * Create a payout for one or more seller invoices.
+         * Use this to re-create a payout after voiding (e.g., lost cheque).
+         * Payment details will fall back to customer defaults if not provided.
+         * @param marketId - ID of the market
+         * @param data - Payout creation data
+         * @returns The created payout
+         */
+        create: async (marketId, data) => {
+            return httpClient.post(`/${marketId}/payouts`, data);
+        },
     };
     return payouts;
 }
@@ -5389,12 +5452,52 @@ function create(httpClient) {
         getBalance: async (marketId, account) => {
             return httpClient.get(`/${marketId}/ledger/balance`, { account });
         },
+        /**
+         * Get a transaction by ID
+         * @param marketId - ID of the market
+         * @param transactionId - ID of the transaction
+         * @returns The transaction details
+         */
+        getTransaction: async (marketId, transactionId) => {
+            return httpClient.get(`/${marketId}/ledger/transactions/${transactionId}`);
+        },
+        /**
+         * Get the latest transaction on an account
+         * @param marketId - ID of the market
+         * @param account - Full account string (format: owner:accountType:accountName)
+         * @returns The latest transaction on the account
+         */
+        getLatestTransaction: async (marketId, account) => {
+            return httpClient.get(`/${marketId}/ledger/transactions/latest`, { account });
+        },
+        /**
+         * List transactions for an account with optional date range and pagination
+         * @param marketId - ID of the market
+         * @param params - Query parameters
+         * @param params.account - Full account string (format: owner:accountType:accountName)
+         * @param params.dateFrom - Optional start date (ISO 8601 format, e.g. "2024-01-01")
+         * @param params.dateTo - Optional end date (ISO 8601 format, e.g. "2024-12-31")
+         * @param params.limit - Optional max results (default 50, max 100)
+         * @param params.cursor - Optional cursor for pagination
+         * @returns List of transactions with pagination info
+         */
+        listTransactions: async (marketId, params) => {
+            let queryParams = {
+                account: params.account,
+                dateFrom: params.dateFrom,
+                dateTo: params.dateTo,
+                limit: params.limit,
+                cursor: params.cursor,
+            };
+            return httpClient.get(`/${marketId}/ledger/transactions`, queryParams);
+        },
     };
     return ledger;
 }
 
 function resources(httpClient) {
     return {
+        activity: create$m(httpClient),
         markets: create$c(httpClient),
         sales: create$8(httpClient),
         lots: create$d(httpClient),
@@ -5402,7 +5505,7 @@ function resources(httpClient) {
         carts: create$k(httpClient),
         cph: create$2(httpClient),
         webhooks: create$3(),
-        actions: create$m(),
+        actions: create$n(),
         bidderApplications: create$i(httpClient),
         settings: create$5(httpClient),
         adjustments: create$l(httpClient),