@marteye/studiojs 1.1.35 → 1.1.37

package/dist/types.d.ts

@@ -10,6 +10,7 @@ export type CurrenciesWithGuinea = Currency | "GUINEA-GBP";
 export type UnitOfSale = "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
 export declare const SupportedUnitsOfSale: UnitOfSale[];
 export type PaymentMethod = "BACS" | "Cheque" | "BankTransfer" | "Cash" | "Card" | "Credit";
+export type InvoiceDeliveryPreference = "email" | "printed" | "both";
 export type PayoutMethod = "BACS" | "Cheque" | "Cash";
 export declare const SupportedPaymentMethods: PaymentMethod[];
 export interface Market {
@@ -44,6 +45,7 @@ export interface SettingsMarketDefaults {
     defaultPayoutPreference: PayoutMethod;
     defaultUnitOfSale: UnitOfSale;
     defaultSuperType?: SuperType | null;
+    defaultSettleDebtsFirst?: boolean;
     lotDescriptionTemplateMap?: {
         default: string | undefined;
         [supertype: string]: string | undefined;
@@ -98,6 +100,10 @@ export interface Printer {
      */
     name: string;
     friendlyName: string;
+    /**
+     * Optional single IPP URI if linked by IP discovery
+     */
+    uri?: string;
     chequePrinter?: boolean;
     /**
      * The next cheque number to use when printing a cheque
@@ -195,6 +201,40 @@ export interface Sale {
     };
     editedBy?: string[];
 }
+export interface TemplateSaleData {
+    name?: string;
+    description?: string | null;
+    image?: string | null;
+    location?: string | null;
+    martEyeSaleType?: "LIVE" | "TIMED" | null;
+    cover?: string | null;
+    availableProductCodes: string[];
+    attributeDefaults?: {
+        [attributekey: string]: AttributeValueType;
+    };
+    marteyeSettings?: MartEyeTimedSaleSettings | MartEyeLiveSaleSettings | null;
+}
+export interface SaleTemplate {
+    id: string;
+    marketId: string;
+    name: string;
+    description?: string | null;
+    sourceSaleId?: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    createdBy: string;
+    saleData: TemplateSaleData;
+    lotGridConfigs?: {
+        [configId: string]: StoredDataGridConfig;
+    };
+}
+export interface StoredDataGridConfig {
+    widths?: {
+        [key: string]: number;
+    };
+    hiddenColumnIds: string[];
+    columnOrder: string[];
+}
 export interface MartEyeLiveSaleSettings {
     description?: string;
     image?: string;
@@ -398,6 +438,11 @@ export interface Product {
     subtotalGroup?: SubtotalGroups | null | undefined;
     passThroughFundsToAnotherCustomer?: boolean;
     isEnabled?: boolean;
+    relatedTo?: {
+        lotId: string;
+        saleId: string;
+    } | null;
+    obfusicate?: boolean;
     metadata: {
         [key: string]: string | number | boolean | Timestamp | Media;
     };
@@ -464,31 +509,6 @@ export interface ProductCodeConfiguration {
 export interface ProductConfiguration {
     [id: string]: Product;
 }
-/***
- * A market may offer other products and services. This is a way to track those.
- * They simply create a line item on the invoice
- */
-export interface Product {
-    id: string;
-    createdAt: Timestamp;
-    updatedAt: Timestamp;
-    marketId: string;
-    name: string;
-    taxRateId: string;
-    defaultUnitPriceInCents: number;
-    unitPriceIncludesVat?: boolean;
-    applyToClients: ClientType[];
-    subtotalGroup?: SubtotalGroups | null | undefined;
-    passThroughFundsToAnotherCustomer?: boolean;
-    relatedTo?: {
-        lotId: string;
-        saleId: string;
-    } | null;
-    obfusicate?: boolean;
-    metadata: {
-        [key: string]: string | number | boolean | Timestamp | Media;
-    };
-}
 export interface Cart {
     customerId: string;
     updatedAt: Timestamp;
@@ -531,6 +551,37 @@ export type BankDetails = {
     accountNumber?: never;
     sortCode?: never;
 });
+export type CustomerBankDetails = BankDetails & {
+    id?: string;
+    createdAt?: Timestamp;
+    updatedAt?: Timestamp;
+    updatedBy?: string | null;
+};
+export interface CustomerContact {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    marketId: string;
+    displayName: string;
+    email?: string | null;
+    phoneNumber?: string | null;
+    /** @deprecated */
+    landlineNumber?: string | null;
+    /** @deprecated */
+    address?: Address;
+    isPrimary?: boolean;
+    isActive?: boolean;
+    isDeleted?: boolean;
+    isVerified?: boolean;
+    accountEmails?: boolean;
+    marketingEmails?: boolean;
+    marteyeUid?: string | null;
+    notes?: string | null;
+    metadata?: {
+        [key: string]: string | number | boolean | Timestamp | Media;
+    };
+}
 /**
  * Used to store the bank details for a market
  */
@@ -556,19 +607,25 @@ export interface Customer {
     isMarketAccount?: boolean;
     accountNumber?: string;
     bidderNumber?: number | null;
+    displayName?: string | null;
     firstName?: string | null;
     lastName?: string | null;
     tradingName?: string | null;
     email?: EmailWrapper;
     phoneNumber?: PhoneNumberWrapper;
+    /** @deprecated */
     otherPhoneNumbers?: PhoneNumberWrapper[];
     address: AddressWrapper;
+    /** @deprecated */
     otherAddresses: {
         [addressId: string]: AddressWrapper;
     };
     photoURL?: string | null;
     payoutPreference?: PayoutMethod;
-    bankDetails?: BankDetails;
+    invoiceDeliveryPreference?: InvoiceDeliveryPreference;
+    statementDeliveryPreference?: InvoiceDeliveryPreference;
+    bankDetails?: CustomerBankDetails | CustomerBankDetails[] | null;
+    contacts?: CustomerContact[];
     attributeDefaultsBuyer?: {
         [attributekey: string]: AttributeValueType[];
     };
@@ -585,6 +642,8 @@ export interface Customer {
     hasPurchasedItems?: boolean;
     hasSoldItems?: boolean;
     notes?: string;
+    status?: "archived" | "deleted" | null;
+    deleteAfter?: Timestamp;
 }
 export interface CustomerFromSearch extends Omit<Customer, "createdAt" | "updatedAt" | "lastItemPurchaseDate" | "lastItemSaleDate"> {
     createdAt: number;
@@ -756,6 +815,10 @@ export interface Payment {
     voidedBy?: string | null;
     voidReason?: string | null;
     invoiceIds: string[];
+    invoices?: Array<{
+        id: string;
+        amountAppliedInCents?: number;
+    }>;
     transactionIds: string[];
 }
 export interface Payout {
@@ -767,6 +830,10 @@ export interface Payout {
     customerId: string;
     method: PayoutMethod | "Credit";
     amountInCents: number;
+    invoices?: Array<{
+        id: string;
+        amountAppliedInCents?: number;
+    }>;
     accountName?: string;
     accountNumber?: string;
     sortCode?: string;
@@ -1022,4 +1089,21 @@ export type AppParameterConfig = {
     required?: boolean;
     defaultValue?: string | number | boolean | string[];
 };
+export interface CphLookupResponse {
+    cph: string;
+    county: string;
+    parish: string;
+    holding: string;
+    subLocation?: string;
+    country: string;
+    region: string | null;
+    spatialUnit: string | null;
+    office: string | null;
+    ahdoNumber: string | null;
+    parishName: string;
+    tbTestingInterval: string | null;
+    tbArea: string | null;
+    cphValid?: boolean | null;
+    farmName?: string | null;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marteye/studiojs",
-  "version": "1.1.35",
+  "version": "1.1.37",
   "description": "MartEye Studio JavaScript SDK",
   "license": "MIT",
   "source": "src/index.ts",