@marteye/studiojs 1.0.0 → 1.1.1

package/dist/types.d.ts

@@ -1,13 +1,940 @@
-export default function Studio(apiKey: string, baseUrl?: string, defaultTimeout?: number): {
-    markets: {
-        get: (marketId: string) => Promise<import("all-types").Market>;
+type Timestamp = string;
+export type ClientType = "Seller" | "Buyer";
+export type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
+export declare const SupportedSuperTypes: SuperType[];
+export declare const LivestockSuperTypes: SuperType[];
+export type Currency = "GBP" | "EUR" | "USD";
+export declare const SupportedCurrencyCodes: Currency[];
+export type SupportedCountryCode = "GB-ENG" | "GB-SCT" | "GB-WLS" | "GB-NIR" | "IE";
+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 PayoutMethod = "BACS" | "Cheque" | "Cash";
+export declare const SupportedPaymentMethods: PaymentMethod[];
+export interface Market {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    name: string;
+    description: string;
+    logo: string;
+    primaryColour: string;
+    secondaryColour: string;
+    countryCode: SupportedCountryCode;
+    address: Address;
+    telephone?: string;
+    vatNumber?: string;
+    email?: string;
+    movementLocationNumbers?: {
+        number: string;
+        type: "CPH" | "Herd Number" | "Flock Number" | "Other";
+        createdAt: Timestamp;
+    }[];
+    paymentInstructions?: string;
+}
+export interface SettingsMarketDefaults {
+    updatedAt: Timestamp;
+    updatedBy: string | null;
+    marketId: string;
+    name: string;
+    description: string;
+    address: Address;
+    defaultCurrency: Currency;
+    defaultPayoutPreference: PayoutMethod;
+    defaultUnitOfSale: UnitOfSale;
+    defaultSuperType?: SuperType | null;
+    lotDescriptionTemplateMap?: {
+        default: string | undefined;
+        [supertype: string]: string | undefined;
     };
+    rostrumAttributesMap?: {
+        default: string[] | undefined;
+        [supertype: string]: string[] | undefined;
+    };
+    selectDocumentIdsMap: {
+        [supertype: string]: string[];
+    };
+}
+export interface SettingsProductCodes {
+    [code: string]: ProductCodeConfiguration;
+}
+export interface SettingsTaxRates {
+    [id: string]: TaxRate;
+}
+export interface SettingsAdjustmentsConfiguration {
+    [id: string]: AdjustmentsConfiguration;
+}
+export interface SettingsAccessories {
+    [id: string]: Accessory;
+}
+export interface SettingsPrinters {
+    [id: string]: Printer;
+}
+export type DeviceType = "globeWeigh" | "allflexRaceReader";
+export interface Accessory {
+    deviceId: string;
+    deviceType: DeviceType;
+    friendlyName: string;
+    endOfMessagePattern: string;
+    host: string;
+    isEnabled: boolean;
+    port: number;
+    regex: string;
+    saleProfileId: string;
+    timeoutMs: number;
+    updatedAt: Timestamp;
+    createdAt: Timestamp;
+}
+/**
+ * @description Configuration for the printer
+ */
+export interface Printer {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    /**
+     * @description The name of the printer. Its the same as the id
+     */
+    name: string;
+    friendlyName: string;
+    chequePrinter?: boolean;
+    /**
+     * The next cheque number to use when printing a cheque
+     */
+    nextChequeNumber?: number;
+    lastPrintedAt?: Timestamp;
+    lastPrinterMessage?: string;
+}
+export interface SettingsGlobalAttributes {
+    [id: string]: AttributeDefinition;
+}
+export type AttributeValueType = string | number | boolean | Timestamp | Media;
+/****
+ * Used to grant a user access to a market.
+ * Each member of staff should have their own.
+ */
+export interface MemberSharingConfiguration {
+    uid: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    displayName?: string;
+    photoURL?: string;
+    marketId: string;
+    role: "Owner" | "Admin" | "Editor";
+}
+export interface Sale {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    startsAt: Timestamp;
+    closedAt?: Timestamp | null;
+    marketId: string;
+    name: string;
+    recurring?: null | "Weekly" | "Bi-weekly" | "Monthly";
+    defaultProductCode: string;
+    /**
+     * Default attributes values for any new lot item
+     */
+    attributeDefaults?: {
+        [attributekey: string]: AttributeValueType;
+    };
+    /**
+     * the codes that are allowed for the sale
+     */
+    availableProductCodes: string[];
+    /**
+     * the supertypes from the product codes. e..g Cattle, Sheep, Pigs etc
+     */
+    superTypes: SuperType[];
+    attributeSet: AttributeDefinition[];
+    attributeSetByProductCode: {
+        [code: string]: string[];
+    };
+    currentLotGroup?: string | null;
+    nextLotGroup?: string | null;
+    /**
+     * Auto queue the next lot when the current lot is sold in rostrum
+     */
+    autoQueue?: boolean;
+    /**
+     * The sale profile ID to use for this sale. Which is used to find settings specific devices and printers etc.
+     */
+    saleProfileId?: string | null;
+    /**
+     * Show the display board
+     */
+    displayBoard?: boolean;
+    martEyeId?: string | null;
+    marteyeSettings?: MartEyeTimedSaleSettings | MartEyeLiveSaleSettings | null;
+}
+export interface MartEyeLiveSaleSettings {
+    description?: string;
+    image?: string;
+    logo?: string;
+    type: "LIVE";
+    location?: string | null;
+    descriptionLines?: string[];
+    descriptionLink?: string;
+    deposit?: number;
+    hidePrices?: boolean;
+    hideReplay?: boolean;
+    labels?: string[];
+    tags?: string[];
+}
+export interface MartEyeTimedSaleSettings {
+    description?: string;
+    image?: string;
+    logo?: string;
+    type: "TIMED";
+    /**
+     * The location of the sale. This could be a physical location Ring 1 / Ring 2 / Farm Address etc
+     */
+    location?: string | null;
+    details?: {
+        markdownBase64: string;
+        title: string;
+    }[];
+    cover?: string;
+    primaryColour?: string;
+    secondaryColour?: string;
+    foregroundColour?: string;
+    extensionTime: number;
+    incrementLadder: IncrementLadder;
+    hideNav?: boolean;
+    signInOverrideLink?: string;
+    published?: boolean;
+    pin?: boolean;
+    labels?: string[];
+    deposit?: number;
+    cascade?: boolean;
+    reportEmail?: string;
+}
+export type IncrementLadder = IncrementLadderItem[];
+export interface IncrementLadderItem {
+    max: number;
+    increment: number;
+}
+export interface SaleFromSearch extends Omit<Omit<Omit<Sale, "createdAt">, "updatedAt">, "startsAt"> {
+    createdAt: number;
+    updatedAt: number;
+    startsAt: number;
+}
+export type LotSaleStatus = "Sold" | "Unsold" | "Rerun" | "Resold" | null;
+export interface Lot {
+    id: string;
+    saleId: string;
+    marketId: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    productCode: string;
+    superType?: SuperType;
+    isLivestock?: boolean;
+    attributes: {
+        [key: string]: AttributeValueType;
+    };
+    loadingAttributes?: {
+        [attributePath: string]: {
+            id: string;
+            startAt: Timestamp;
+            path: string;
+        };
+    };
+    itemMap: {
+        [itemId: string]: LotItem;
+    };
+    sellerCasual?: string | null;
+    sellerCustomerId: string | null;
+    seller?: ShortCustomerDetails;
+    lotNumber?: string | null;
+    index: number;
+    group?: string;
+    remarks?: string;
+    notes?: string;
+    currency: CurrenciesWithGuinea;
+    unitOfSale: UnitOfSale;
+    unitPriceInCents?: number;
+    buyerCasual?: string | null;
+    buyerCustomerId: string | null;
+    buyer?: ShortCustomerDetails | null;
+    startedAt?: Timestamp;
+    endedAt?: Timestamp;
+    sellerInvoiceId: string | null;
+    sellerInvoiceNumber?: number | undefined | null;
+    buyerInvoiceId: string | null;
+    buyerInvoiceNumber?: number | undefined | null;
+    voidedSellerInvoiceIds?: string[];
+    voidedBuyerInvoiceIds?: string[];
+    saleStatus?: LotSaleStatus;
+    void?: boolean;
+    originalLot?: string;
+    metadata: {
+        [key: string]: any;
+    };
+    generated?: LotGeneratedValues;
+    issues?: {
+        [issueId: string]: LotIssue;
+    };
+    resolvedIssues?: {
+        [issueId: string]: LotIssue;
+    };
+    /***
+     * Default values for any new lot item
+     */
+    itemAttributeDefaults?: {
+        [attributekey: string]: AttributeValueType;
+    };
+}
+type LotIssueCode = "unknown-attribute" | "validation-error" | "staff-flagged";
+export interface LotIssue {
+    id: string;
+    itemId?: string | null;
+    path?: string | null;
+    code: LotIssueCode;
+    description: string;
+    severity: "error" | "warning" | "info";
+    createdAt: Timestamp;
+    createdBy: string;
+    blockCheckout: boolean;
+}
+export interface LotWithItemsAsArray extends Omit<Lot, "itemMap"> {
+    items: LotItem[];
+}
+export interface LotGeneratedValues {
+    totalValueInCents?: number | null;
+    description?: string | null;
+    pricePerKiloInCents?: number | null;
+    averageWeightKg?: number | null;
+    pricePerItemInCents?: number | null;
+    countOfItems?: number | null;
+}
+export interface ShortCustomerDetails {
+    isSet: boolean;
+    id?: string;
+    copiedInAt?: Timestamp;
+    accountNumber?: string;
+    bidderNumber?: number | null;
+    displayName?: string;
+    avatar?: string | null;
+}
+export interface LotItem {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    index: number;
+    attributes: {
+        [key: string]: AttributeValueType;
+    };
+    notes: {
+        id: string;
+        text: string;
+        createdAt: Timestamp;
+    }[];
+    metadata: {
+        [key: string]: string | number | boolean | Timestamp | Media;
+    };
+}
+/***
+ * A market may offer other products and services. This is a way to track those.
+ * They simply create a line item on the invoice
+ *
+ *  /settings/products
+ */
+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;
+    isEnabled?: boolean;
+    metadata: {
+        [key: string]: string | number | boolean | Timestamp | Media;
+    };
+}
+/***
+ * When a product is added to a cart it becomes a CartProductItem
+ *
+ *
+ * markets/ballymena/carts/{userId}
+ *
+ *  {id: CartItem}
+ */
+export interface CartItem {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    marketId: string;
+    customerId: string;
+    productId: string;
+    clientType: ClientType;
+    quantity: number;
+    unitPriceInCents: number;
+    passthroughFundsToCustomerId?: string | null;
+    generated?: {
+        totalInCents: number;
+    };
+}
+/***
+ * Items have codes. And those codes are used to apply the correct commission rates, report movements etc.
+ */
+export interface ProductCodeConfiguration {
+    code: string;
+    createdAt?: Timestamp;
+    updatedAt?: Timestamp;
+    updatedBy?: string | null;
+    superType: SuperType;
+    description: string;
+    icon?: string;
+    metadata: {
+        [key: string]: string | number | boolean | Timestamp | Media;
+    };
+    taxRateId: string;
+    subtotalGroup?: SubtotalGroups | null;
+    adjustmentIds: string[];
+    unitPriceIncludesVat?: boolean;
+    totalExVatRebatePecentage?: number;
+    defaultCurrency?: CurrenciesWithGuinea;
+    defaultUnitOfSale: UnitOfSale;
+    defaultLotRange?: {
+        min: number;
+        max: number;
+    };
+    attributeDefaults?: {
+        [attributekey: string]: AttributeValueType;
+    };
+    lotDescriptionTemplate?: string;
+    rostrumAttributes?: string[];
+    selectDocumentIds?: string[] | null;
+}
+/***
+ * How the products are stored in settings
+ */
+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 {
+    updatedAt: Timestamp;
+    itemsById: {
+        [itemId: string]: CartItem;
+    };
+}
+export interface EmailWrapper {
+    email: string;
+    isVerified: boolean;
+    createdAt: Timestamp;
+}
+export interface PhoneNumberWrapper {
+    phoneNumber: string;
+    isVerified: boolean;
+    createdAt: Timestamp;
+}
+export interface AddressWrapper {
+    address: Address;
+    createdAt: Timestamp;
+    updatedAt?: Timestamp;
+    updatedBy?: string | null;
+}
+export interface FarmAssurances {
+    createdAt: Timestamp;
+    updatedAt?: Timestamp;
+    updatedBy?: string | null;
+    memberReference: string;
+    expiryDate: Timestamp;
+    scope?: "Beef" | "Dairy" | "Pork" | "Sheep" | "Other";
+}
+export type BankDetails = {
+    accountName?: string;
+} & ({
+    accountNumber: string;
+    sortCode: string;
+    IBAN?: never;
+} | {
+    IBAN: string;
+    accountNumber?: never;
+    sortCode?: never;
+});
+/**
+ * Used to store the bank details for a market
+ */
+export type MarketBankDetails = {
+    name: string;
+    bankId: string;
+    address: Address;
+} & ({
+    accountNumber: string;
+    sortCode: string;
+    IBAN?: never;
+} | {
+    IBAN: string;
+    accountNumber?: never;
+    sortCode?: never;
+});
+export interface Customer {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    marketId: string;
+    isMarketAccount?: boolean;
+    accountNumber?: string;
+    bidderNumber?: number | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    tradingName?: string | null;
+    email?: EmailWrapper;
+    phoneNumber?: PhoneNumberWrapper;
+    otherPhoneNumbers?: PhoneNumberWrapper[];
+    address: AddressWrapper;
+    otherAddresses: {
+        [addressId: string]: AddressWrapper;
+    };
+    photoURL?: string | null;
+    payoutPreference?: PayoutMethod;
+    bankDetails?: BankDetails;
+    attributeDefaultsBuyer?: {
+        [attributekey: string]: AttributeValueType[];
+    };
+    attributeDefaultsSeller?: {
+        [attributekey: string]: AttributeValueType[];
+    };
+    preferSettleDebtsFirst?: boolean;
+    vatNumber?: string;
+    metadata: {
+        [key: string]: string | number | boolean | Timestamp | Media;
+    };
+    lastItemPurchaseDate?: Timestamp;
+    lastItemSaleDate?: Timestamp;
+    hasPurchasedItems?: boolean;
+    hasSoldItems?: boolean;
+    notes?: string;
+}
+export interface CustomerFromSearch extends Omit<Customer, "createdAt" | "updatedAt" | "lastItemPurchaseDate" | "lastItemSaleDate"> {
+    createdAt: number;
+    updatedAt: number;
+    lastItemPurchaseDate?: number;
+    lastItemSaleDate?: number;
+}
+export interface Address {
+    id: string;
+    nickname?: string;
+    company?: string;
+    firstName?: string;
+    lastName?: string;
+    address1: string;
+    address2?: string;
+    city: string;
+    province?: string;
+    zip: string;
+    country: string;
+}
+interface ImageThumbnail {
+    url: string;
+    width: number;
+    height: number;
+}
+export interface Media {
+    id: string;
+    url: string;
+    type: "image/jpeg" | "image/png" | "video/mp4" | "application/pdf";
+    filename: string;
+    thumbnails?: {
+        small?: ImageThumbnail;
+        medium?: ImageThumbnail;
+        large?: ImageThumbnail;
+    };
+}
+export type MarketReportHeaders = "grossServices" | "vatOnServices" | "grossGoods" | "vatOnGoods" | "netTotal" | "contra";
+/**
+ * Content types which will denote the position of the data on the invoice wihth out with a cheque
+ */
+export type FieldPositions = {
+    id: ChequeField | InvoiceField;
+    x: number;
+    y: number;
+};
+export type InvoiceField = "invoiceNumber" | "invoiceDate" | "description" | "lotNumber" | "quantity" | "weight" | "unitPrice" | "grossLineTotal" | "accountRef" | "accountName" | "businessAddress" | "customerAddress" | "lineItemsStartLine" | "footerBoundaryLine" | "vatNumber" | "saleName" | "subTotal" | "subTotalTable" | "tagList" | "tagNumber";
+export type ChequeField = "chequeDate" | "chequeNumber" | "payee" | "amount" | "amountInWords" | "hunderdsOfThousands" | "tensOfThousands" | "thousands" | "hundreds" | "tens" | "units";
+export type SubtotalGroups = "Commission" | string;
+export type AdjustmentTotalTarget = "Per Invoice" | "Total - finalTotalInCents" | "Total - lotTotalLessCommissionInCentsExVat";
+export type AdjustmentTarget = UnitOfSale | AdjustmentTotalTarget;
+/***
+ * Commission is added as a line item. Can also be used for levies etc
+ */
+export interface AdjustmentsConfiguration {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    name?: string | null;
+    description?: string | null;
+    applyToClients: ClientType[];
+    subtotalGroup?: SubtotalGroups | null | undefined;
+    type: "commission" | "levy" | "vat-rebate";
+    filter?: {
+        currency?: CurrenciesWithGuinea | null;
+        quantity?: {
+            min?: number;
+            max?: number;
+        } | null;
+        unitPrice?: {
+            minInCents?: number;
+            maxInCents?: number;
+        } | null;
+        totalPrice?: {
+            minInCents?: number;
+            maxInCents?: number;
+        } | null;
+        customerIsVATRegistered?: boolean | null;
+        customerWithinTaxRegion?: boolean | null;
+        attribute?: {
+            key: string;
+            value: string | number | boolean | null;
+        } | null;
+    };
+    taxRateId: string;
+    adjustment: Adjustment & {
+        target: AdjustmentTarget;
+    };
+}
+interface Adjustment {
+    percentage?: {
+        value?: number;
+        floorInCents?: number;
+        ceilingInCents?: number;
+    } | null;
+    fixedAmountInCents?: number | null;
+}
+export interface LineItemAdjustmentConfiguration extends AdjustmentsConfiguration {
+    adjustment: Adjustment & {
+        target: UnitOfSale;
+    };
+}
+export interface InvoiceTotalAdjustmentConfiguration extends AdjustmentsConfiguration {
+    adjustment: Adjustment & {
+        target: AdjustmentTotalTarget;
+    };
+}
+/***
+ * Tax config is used to generate the invoice but the user can still edit the invoice, overriding the final values.
+ */
+export interface TaxRate {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    marketId: string;
+    description: string;
+    taxSubtotalGroup?: string | null;
+    percentage: number;
+    isExportTaxRate?: boolean;
+}
+export interface Payment {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string;
+    transactionDate: Timestamp;
+    marketId: string;
+    customerId: string;
+    method: PaymentMethod;
+    amountInCents: number;
+    reference: string | null;
+    status: "complete" | "void";
+    voidedAt?: Timestamp | null;
+    voidedBy?: string | null;
+    voidReason?: string | null;
+    invoiceIds: string[];
+    transactionIds: string[];
+}
+export interface Payout {
+    id: string;
+    marketId: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy: string | null;
+    customerId: string;
+    method: PayoutMethod | "Credit";
+    amountInCents: number;
+    accountName?: string;
+    accountNumber?: string;
+    sortCode?: string;
+    chequeMadePayableTo?: string;
+    transactionDate: Timestamp;
+    reference: string | null;
+    status: "pending" | "complete" | "void";
+    notes: string | null;
+    completedAt?: Timestamp | null;
+    completedBy?: string | null;
+    voidedAt?: Timestamp | null;
+    voidedBy?: string | null;
+    voidReason?: string | null;
+    transactionIds: string[];
+    invoiceIds: string[];
+}
+export interface DraftInvoice extends InvoiceTotals {
+    id: string;
+    currency: Currency;
+    status: "draft";
+    issuedAt?: Timestamp;
+    lotIdents: {
+        lotId: string;
+        saleId: string;
+    }[];
+    clientType: ClientType;
+    customerId: string;
+    customerAccountNumber: string;
+    name: string;
+    address: Address;
+    email: string | null;
+    superTypes?: SuperType[];
+    customerIsVATRegistered: boolean;
+    customerWithinTaxRegion: boolean;
+    lineItems: InvoiceLineItem[];
+    adjustmentLineItems: InvoiceLineItem[];
+    vatNumber?: string;
+    extraProductIds: string[];
+    payoutMethod?: PayoutMethod | null;
+    payoutParams?: {
+        settleDebtsFirst: boolean;
+        accountName?: string;
+        accountNumber?: string;
+        sortCode?: string;
+        chequeMadePayableTo?: string;
+    };
+    potentialPayoutsById?: {
+        [payoutId: string]: {
+            id: string;
+            amountInCents: number;
+            paymentMethod: PaymentMethod;
+            invoice?: {
+                id: string;
+                invoiceNumber: number;
+                fullyPaid: boolean;
+            };
+        };
+    };
+    attributeValues?: {
+        [attributekey: string]: AttributeValueType;
+    };
+    attributes: AttributeDefinition[];
+    averages?: {
+        label: string;
+        value: number;
+        formattedValue: string;
+    }[];
+    paymentInstructions?: string | null;
+}
+export interface InvoiceTotals {
+    lotTotalInCentsExVat: number;
+    vatOnLotTotalInCents: number;
+    commissionTotalInCents?: number;
+    vatOnCommissionInCents?: number;
+    nonCommissionAdjustmentsInCents?: number;
+    vatOnAdjustmentsInCents?: number;
+    subtotalGroupTotals: {
+        [key in SubtotalGroups]: number;
+    };
+    taxSubtotalGroupTotals: {
+        [key in string]: number;
+    };
+    finalTotalInCents: number;
+}
+export interface SimplePaymentIn {
+    paymentId: string;
+    amountInCents: number;
+    paymentMethod: PaymentMethod;
+    reference: string | null;
+    paidAt: Timestamp;
+}
+/**
+ * Used on invoice to show the payout. Use payout collection for the source of truth
+ */
+export interface SimplePaymentOut {
+    payoutId: string;
+    amountInCents: number;
+    paymentMethod: PaymentMethod;
+    reference: string | null;
+    paidAt: Timestamp;
+}
+export interface Invoice extends Omit<Omit<Omit<Omit<DraftInvoice, "ledgerAccountTotals">, "potentialPayoutsById">, "payoutParams">, "status"> {
+    id: string;
+    invoiceNumber: number;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    updatedBy?: string | null;
+    marketId: string;
+    saleIds: string[];
     sales: {
-        get: (marketId: string, saleId: string) => Promise<import("all-types").Sale>;
+        id: string;
+        name?: string;
+    }[];
+    transactionIds?: string[];
+    status: "draft" | "issued" | "void" | "imported" | "paid";
+    paymentsInById: {
+        [paymentId: string]: SimplePaymentIn;
+    };
+    payoutMethod: PayoutMethod | null;
+    payoutsById: {
+        [payoutId: string]: SimplePaymentOut;
+    };
+    voidReason?: string;
+    voidedAt?: Timestamp;
+    voidedBy?: string;
+    description?: string;
+    footnotes?: string[];
+    metadata: {
+        [key: string]: string | number | boolean | Timestamp | Media;
+    };
+    /***
+     * this is important to add when adding an invoice
+     * it creates a lock so we only ever get sequential invoice numbers
+     * The invoice will have this as null until the next invoice is created
+     */
+    internalNextInvoiceId: string | null;
+    emailNotifications?: string[];
+    pitchPayLink: string | null;
+}
+export interface Printer {
+    name: string;
+    id: string;
+}
+export interface InvoiceLineItem {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    subtotalGroup?: SubtotalGroups | null;
+    clientType: ClientType;
+    description: string;
+    index?: number;
+    quantity: number;
+    impreciseUnitPriceInCents: number;
+    unitOfSale?: UnitOfSale;
+    unitPriceIncludesVat?: boolean;
+    taxRate: TaxRate;
+    taxAmountInCents: number;
+    discountAmountInCents?: number;
+    totalAmountInCentsExVat: number;
+    saleId?: string;
+    lotId?: string;
+    lotProductCode?: string;
+    superType?: SuperType | null;
+    productId?: string;
+    productRelatedTo?: {
+        lotId: string;
+        saleId: string;
+    } | null;
+    productObfusicate?: boolean;
+    passthroughFundsToCustomerId?: string | null;
+    adjustmentConfig?: AdjustmentsConfiguration;
+    metadata: {
+        [key: string]: string | number | boolean | Timestamp | Media | {
+            [key: string]: string | number | boolean | Timestamp;
+        };
+    };
+}
+export interface TablePosition {
+    id: InvoiceField | ChequeField | MarketReportHeaders;
+    title: string;
+    cellWidth: number;
+    halign: "left" | "center" | "right";
+}
+export type WebhookEventName = "market.updated" | "sale.created" | "sale.updated" | "sale.deleted" | "lot.created" | "lot.updated" | "lot.deleted" | "lot.media.created" | "lot.media.deleted" | "invoice.created" | "invoice.updated" | "invoice.deleted" | "payment.created" | "payment.updated" | "payment.deleted" | "payout.created" | "payout.updated" | "payout.deleted" | "customer.created" | "customer.updated" | "customer.deleted" | "member.created" | "member.updated" | "member.deleted";
+export declare const supportedWebhookEvents: readonly ["market.updated", "sale.created", "sale.updated", "sale.deleted", "lot.created", "lot.updated", "lot.deleted", "lot.media.created", "lot.media.deleted", "invoice.created", "invoice.updated", "invoice.deleted", "payment.created", "payment.updated", "payment.deleted", "payout.created", "payout.updated", "payout.deleted", "customer.created", "customer.updated", "customer.deleted", "member.created", "member.updated", "member.deleted"];
+export type ObjectType = "market" | "sale" | "lot" | "invoice" | "payment" | "customer" | "member";
+export interface WebhookEvent<T> {
+    id: string;
+    createdAt: Timestamp;
+    trigger: WebhookEventName;
+    marketId: string;
+    objectType: ObjectType;
+    data: {
+        object: T;
+        objectBefore?: T;
     };
-    lots: {
-        get: (marketId: string, saleId: string, lotId: string) => Promise<import("all-types").Lot>;
+}
+export type SupportedAttributeTypes = "string" | "number" | "boolean" | "date" | "datetime" | "time";
+export interface AttributeDefinition {
+    id: string;
+    name: string;
+    shortName?: string;
+    description?: string;
+    applyTo: string[];
+    level: "item" | "lot";
+    readonly?: boolean;
+    lotDetailFlyoutGroup?: string;
+    buyerCheckoutGroup?: string;
+    sellerCheckoutGroup?: string;
+    buyerCustomerAttribute?: boolean;
+    sellerCustomerAttribute?: boolean;
+    defaultHiddenOnSaleSheet?: boolean;
+    prefillableFromPreviousLot?: boolean;
+    hidden?: boolean;
+    showInSellerDetailsPanel?: boolean;
+    displayTemplate?: string;
+    displayTemplateMultiValue?: string;
+    type: SupportedAttributeTypes;
+    requiredPreSale: boolean;
+    requiredToCheckout: boolean;
+    minValue?: number;
+    maxValue?: number;
+    minLength?: number;
+    maxLength?: number;
+    regexPattern?: string;
+    minDateExpression?: string;
+    maxDateExpression?: string;
+    allowedValues?: string[];
+}
+export interface StudioAppPartial {
+    id: string;
+    name: string;
+    version: string;
+    description: string;
+    icon: string;
+    parameterConfig: AppParameterConfig[];
+    parameterValues: {
+        [key: string]: string | number | boolean | string[];
     };
+}
+export type AppParameterConfig = {
+    id: string;
+    type: "string" | "number" | "boolean" | "string[]" | "password";
+    label: string;
+    description?: string;
+    required?: boolean;
+    defaultValue?: string | number | boolean | string[];
 };
-
-//# sourceMappingURL=types.d.ts.map
+export {};