@marteye/studiojs 1.1.2 → 1.1.4

package/dist/index.d.ts

@@ -1,9 +1,17 @@
 type Timestamp = string;
+type ClientType = "Seller" | "Buyer";
 type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
+declare const SupportedSuperTypes: SuperType[];
+declare const LivestockSuperTypes: SuperType[];
 type Currency = "GBP" | "EUR" | "USD";
+declare const SupportedCurrencyCodes: Currency[];
 type SupportedCountryCode = "GB-ENG" | "GB-SCT" | "GB-WLS" | "GB-NIR" | "IE";
 type CurrenciesWithGuinea = Currency | "GUINEA-GBP";
 type UnitOfSale = "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
+declare const SupportedUnitsOfSale: UnitOfSale[];
+type PaymentMethod = "BACS" | "Cheque" | "BankTransfer" | "Cash" | "Card" | "Credit";
+type PayoutMethod = "BACS" | "Cheque" | "Cash";
+declare const SupportedPaymentMethods: PaymentMethod[];
 interface Market {
     id: string;
     createdAt: Timestamp;
@@ -25,7 +33,76 @@ interface Market {
     }[];
     paymentInstructions?: string;
 }
+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[];
+    };
+}
+interface SettingsProductCodes {
+    [code: string]: ProductCodeConfiguration;
+}
+interface SettingsTaxRates {
+    [id: string]: TaxRate;
+}
+interface SettingsAdjustmentsConfiguration {
+    [id: string]: AdjustmentsConfiguration;
+}
+interface SettingsAccessories {
+    [id: string]: Accessory;
+}
+interface SettingsPrinters {
+    [id: string]: Printer;
+}
+type DeviceType = "globeWeigh" | "allflexRaceReader";
+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;
+}
+interface SettingsGlobalAttributes {
+    [id: string]: AttributeDefinition;
+}
 type AttributeValueType = string | number | boolean | Timestamp | Media;
+/****
+ * Used to grant a user access to a market.
+ * Each member of staff should have their own.
+ */
+interface MemberSharingConfiguration {
+    uid: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    displayName?: string;
+    photoURL?: string;
+    marketId: string;
+    role: "Owner" | "Admin" | "Editor";
+}
 interface Sale {
     id: string;
     createdAt: Timestamp;
@@ -119,6 +196,11 @@ interface IncrementLadderItem {
     max: number;
     increment: number;
 }
+interface SaleFromSearch extends Omit<Omit<Omit<Sale, "createdAt">, "updatedAt">, "startsAt"> {
+    createdAt: number;
+    updatedAt: number;
+    startsAt: number;
+}
 type LotSaleStatus = "Sold" | "Unsold" | "Rerun" | "Resold" | null;
 interface Lot {
     id: string;
@@ -197,6 +279,9 @@ interface LotIssue {
     createdBy: string;
     blockCheckout: boolean;
 }
+interface LotWithItemsAsArray extends Omit<Lot, "itemMap"> {
+    items: LotItem[];
+}
 interface LotGeneratedValues {
     totalValueInCents?: number | null;
     description?: string | null;
@@ -232,6 +317,218 @@ interface LotItem {
         [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}
+ */
+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.
+ */
+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
+ */
+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
+ *
+ *  /settings/products
+ */
+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;
+    };
+}
+/***
+ * A market may offer other products and services. This is a way to track those.
+ * They simply create a line item on the invoice
+ */
+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;
+    };
+}
+interface Cart {
+    updatedAt: Timestamp;
+    itemsById: {
+        [itemId: string]: CartItem;
+    };
+}
+interface EmailWrapper {
+    email: string;
+    isVerified: boolean;
+    createdAt: Timestamp;
+}
+interface PhoneNumberWrapper {
+    phoneNumber: string;
+    isVerified: boolean;
+    createdAt: Timestamp;
+}
+interface AddressWrapper {
+    address: Address;
+    createdAt: Timestamp;
+    updatedAt?: Timestamp;
+    updatedBy?: string | null;
+}
+interface FarmAssurances {
+    createdAt: Timestamp;
+    updatedAt?: Timestamp;
+    updatedBy?: string | null;
+    memberReference: string;
+    expiryDate: Timestamp;
+    scope?: "Beef" | "Dairy" | "Pork" | "Sheep" | "Other";
+}
+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
+ */
+type MarketBankDetails = {
+    name: string;
+    bankId: string;
+    address: Address;
+} & ({
+    accountNumber: string;
+    sortCode: string;
+    IBAN?: never;
+} | {
+    IBAN: string;
+    accountNumber?: never;
+    sortCode?: never;
+});
+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;
+}
+interface CustomerFromSearch extends Omit<Customer, "createdAt" | "updatedAt" | "lastItemPurchaseDate" | "lastItemSaleDate"> {
+    createdAt: number;
+    updatedAt: number;
+    lastItemPurchaseDate?: number;
+    lastItemSaleDate?: number;
+}
 interface Address {
     id: string;
     nickname?: string;
@@ -261,7 +558,334 @@ interface Media {
         large?: ImageThumbnail;
     };
 }
+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
+ */
+type FieldPositions = {
+    id: ChequeField | InvoiceField;
+    x: number;
+    y: number;
+};
+type InvoiceField = "invoiceNumber" | "invoiceDate" | "description" | "lotNumber" | "quantity" | "weight" | "unitPrice" | "grossLineTotal" | "accountRef" | "accountName" | "businessAddress" | "customerAddress" | "lineItemsStartLine" | "footerBoundaryLine" | "vatNumber" | "saleName" | "subTotal" | "subTotalTable" | "tagList" | "tagNumber";
+type ChequeField = "chequeDate" | "chequeNumber" | "payee" | "amount" | "amountInWords" | "hunderdsOfThousands" | "tensOfThousands" | "thousands" | "hundreds" | "tens" | "units";
+type SubtotalGroups = "Commission" | string;
+type AdjustmentTotalTarget = "Per Invoice" | "Total - finalTotalInCents" | "Total - lotTotalLessCommissionInCentsExVat";
+type AdjustmentTarget = UnitOfSale | AdjustmentTotalTarget;
+/***
+ * Commission is added as a line item. Can also be used for levies etc
+ */
+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;
+}
+interface LineItemAdjustmentConfiguration extends AdjustmentsConfiguration {
+    adjustment: Adjustment & {
+        target: UnitOfSale;
+    };
+}
+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.
+ */
+interface TaxRate {
+    id: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    marketId: string;
+    description: string;
+    taxSubtotalGroup?: string | null;
+    percentage: number;
+    isExportTaxRate?: boolean;
+}
+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[];
+}
+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[];
+}
+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;
+}
+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;
+}
+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
+ */
+interface SimplePaymentOut {
+    payoutId: string;
+    amountInCents: number;
+    paymentMethod: PaymentMethod;
+    reference: string | null;
+    paidAt: Timestamp;
+}
+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: {
+        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;
+}
+/**
+ * @description Configuration for the printer
+ */
+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;
+}
+interface Printer {
+    name: string;
+    id: string;
+}
+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;
+        };
+    };
+}
+interface TablePosition {
+    id: InvoiceField | ChequeField | MarketReportHeaders;
+    title: string;
+    cellWidth: number;
+    halign: "left" | "center" | "right";
+}
 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";
+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"];
+type ObjectType = "market" | "sale" | "lot" | "invoice" | "payment" | "customer" | "member";
+interface WebhookEvent<T> {
+    id: string;
+    createdAt: Timestamp;
+    trigger: WebhookEventName;
+    marketId: string;
+    objectType: ObjectType;
+    data: {
+        object: T;
+        objectBefore?: T;
+    };
+}
 type SupportedAttributeTypes = "string" | "number" | "boolean" | "date" | "datetime" | "time";
 interface AttributeDefinition {
     id: string;
@@ -294,8 +918,118 @@ interface AttributeDefinition {
     maxDateExpression?: string;
     allowedValues?: string[];
 }
+interface StudioAppPartial {
+    id: string;
+    name: string;
+    version: string;
+    description: string;
+    icon: string;
+    parameterConfig: AppParameterConfig[];
+    parameterValues: {
+        [key: string]: string | number | boolean | string[];
+    };
+}
+type AppParameterConfig = {
+    id: string;
+    type: "string" | "number" | "boolean" | "string[]" | "password";
+    label: string;
+    description?: string;
+    required?: boolean;
+    defaultValue?: string | number | boolean | string[];
+};
 
-declare function Studio(apiKey: string, baseUrl?: string, defaultTimeout?: number, debug?: boolean): {
+type types_Accessory = Accessory;
+type types_Address = Address;
+type types_AddressWrapper = AddressWrapper;
+type types_AdjustmentTarget = AdjustmentTarget;
+type types_AdjustmentTotalTarget = AdjustmentTotalTarget;
+type types_AdjustmentsConfiguration = AdjustmentsConfiguration;
+type types_AppParameterConfig = AppParameterConfig;
+type types_AttributeDefinition = AttributeDefinition;
+type types_AttributeValueType = AttributeValueType;
+type types_BankDetails = BankDetails;
+type types_Cart = Cart;
+type types_CartItem = CartItem;
+type types_ChequeField = ChequeField;
+type types_ClientType = ClientType;
+type types_CurrenciesWithGuinea = CurrenciesWithGuinea;
+type types_Currency = Currency;
+type types_Customer = Customer;
+type types_CustomerFromSearch = CustomerFromSearch;
+type types_DeviceType = DeviceType;
+type types_DraftInvoice = DraftInvoice;
+type types_EmailWrapper = EmailWrapper;
+type types_FarmAssurances = FarmAssurances;
+type types_FieldPositions = FieldPositions;
+type types_IncrementLadder = IncrementLadder;
+type types_IncrementLadderItem = IncrementLadderItem;
+type types_Invoice = Invoice;
+type types_InvoiceField = InvoiceField;
+type types_InvoiceLineItem = InvoiceLineItem;
+type types_InvoiceTotalAdjustmentConfiguration = InvoiceTotalAdjustmentConfiguration;
+type types_InvoiceTotals = InvoiceTotals;
+type types_LineItemAdjustmentConfiguration = LineItemAdjustmentConfiguration;
+declare const types_LivestockSuperTypes: typeof LivestockSuperTypes;
+type types_Lot = Lot;
+type types_LotGeneratedValues = LotGeneratedValues;
+type types_LotIssue = LotIssue;
+type types_LotItem = LotItem;
+type types_LotSaleStatus = LotSaleStatus;
+type types_LotWithItemsAsArray = LotWithItemsAsArray;
+type types_Market = Market;
+type types_MarketBankDetails = MarketBankDetails;
+type types_MarketReportHeaders = MarketReportHeaders;
+type types_MartEyeLiveSaleSettings = MartEyeLiveSaleSettings;
+type types_MartEyeTimedSaleSettings = MartEyeTimedSaleSettings;
+type types_Media = Media;
+type types_MemberSharingConfiguration = MemberSharingConfiguration;
+type types_ObjectType = ObjectType;
+type types_Payment = Payment;
+type types_PaymentMethod = PaymentMethod;
+type types_Payout = Payout;
+type types_PayoutMethod = PayoutMethod;
+type types_PhoneNumberWrapper = PhoneNumberWrapper;
+type types_Printer = Printer;
+type types_Product = Product;
+type types_ProductCodeConfiguration = ProductCodeConfiguration;
+type types_ProductConfiguration = ProductConfiguration;
+type types_Sale = Sale;
+type types_SaleFromSearch = SaleFromSearch;
+type types_SettingsAccessories = SettingsAccessories;
+type types_SettingsAdjustmentsConfiguration = SettingsAdjustmentsConfiguration;
+type types_SettingsGlobalAttributes = SettingsGlobalAttributes;
+type types_SettingsMarketDefaults = SettingsMarketDefaults;
+type types_SettingsPrinters = SettingsPrinters;
+type types_SettingsProductCodes = SettingsProductCodes;
+type types_SettingsTaxRates = SettingsTaxRates;
+type types_ShortCustomerDetails = ShortCustomerDetails;
+type types_SimplePaymentIn = SimplePaymentIn;
+type types_SimplePaymentOut = SimplePaymentOut;
+type types_StudioAppPartial = StudioAppPartial;
+type types_SubtotalGroups = SubtotalGroups;
+type types_SuperType = SuperType;
+type types_SupportedAttributeTypes = SupportedAttributeTypes;
+type types_SupportedCountryCode = SupportedCountryCode;
+declare const types_SupportedCurrencyCodes: typeof SupportedCurrencyCodes;
+declare const types_SupportedPaymentMethods: typeof SupportedPaymentMethods;
+declare const types_SupportedSuperTypes: typeof SupportedSuperTypes;
+declare const types_SupportedUnitsOfSale: typeof SupportedUnitsOfSale;
+type types_TablePosition = TablePosition;
+type types_TaxRate = TaxRate;
+type types_UnitOfSale = UnitOfSale;
+type types_WebhookEvent<T> = WebhookEvent<T>;
+type types_WebhookEventName = WebhookEventName;
+declare const types_supportedWebhookEvents: typeof supportedWebhookEvents;
+declare namespace types {
+  export { type types_Accessory as Accessory, type types_Address as Address, type types_AddressWrapper as AddressWrapper, type types_AdjustmentTarget as AdjustmentTarget, type types_AdjustmentTotalTarget as AdjustmentTotalTarget, type types_AdjustmentsConfiguration as AdjustmentsConfiguration, type types_AppParameterConfig as AppParameterConfig, type types_AttributeDefinition as AttributeDefinition, type types_AttributeValueType as AttributeValueType, type types_BankDetails as BankDetails, type types_Cart as Cart, type types_CartItem as CartItem, type types_ChequeField as ChequeField, type types_ClientType as ClientType, type types_CurrenciesWithGuinea as CurrenciesWithGuinea, type types_Currency as Currency, type types_Customer as Customer, type types_CustomerFromSearch as CustomerFromSearch, type types_DeviceType as DeviceType, type types_DraftInvoice as DraftInvoice, type types_EmailWrapper as EmailWrapper, type types_FarmAssurances as FarmAssurances, type types_FieldPositions as FieldPositions, type types_IncrementLadder as IncrementLadder, type types_IncrementLadderItem as IncrementLadderItem, type types_Invoice as Invoice, type types_InvoiceField as InvoiceField, type types_InvoiceLineItem as InvoiceLineItem, type types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, type types_InvoiceTotals as InvoiceTotals, type types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_LivestockSuperTypes as LivestockSuperTypes, type types_Lot as Lot, type types_LotGeneratedValues as LotGeneratedValues, type types_LotIssue as LotIssue, type types_LotItem as LotItem, type types_LotSaleStatus as LotSaleStatus, type types_LotWithItemsAsArray as LotWithItemsAsArray, type types_Market as Market, type types_MarketBankDetails as MarketBankDetails, type types_MarketReportHeaders as MarketReportHeaders, type types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, type types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, type types_Media as Media, type types_MemberSharingConfiguration as MemberSharingConfiguration, type types_ObjectType as ObjectType, type types_Payment as Payment, type types_PaymentMethod as PaymentMethod, type types_Payout as Payout, type types_PayoutMethod as PayoutMethod, type types_PhoneNumberWrapper as PhoneNumberWrapper, type types_Printer as Printer, type types_Product as Product, type types_ProductCodeConfiguration as ProductCodeConfiguration, type types_ProductConfiguration as ProductConfiguration, type types_Sale as Sale, type types_SaleFromSearch as SaleFromSearch, type types_SettingsAccessories as SettingsAccessories, type types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, type types_SettingsGlobalAttributes as SettingsGlobalAttributes, type types_SettingsMarketDefaults as SettingsMarketDefaults, type types_SettingsPrinters as SettingsPrinters, type types_SettingsProductCodes as SettingsProductCodes, type types_SettingsTaxRates as SettingsTaxRates, type types_ShortCustomerDetails as ShortCustomerDetails, type types_SimplePaymentIn as SimplePaymentIn, type types_SimplePaymentOut as SimplePaymentOut, type types_StudioAppPartial as StudioAppPartial, type types_SubtotalGroups as SubtotalGroups, type types_SuperType as SuperType, type types_SupportedAttributeTypes as SupportedAttributeTypes, type types_SupportedCountryCode as SupportedCountryCode, types_SupportedCurrencyCodes as SupportedCurrencyCodes, types_SupportedPaymentMethods as SupportedPaymentMethods, types_SupportedSuperTypes as SupportedSuperTypes, types_SupportedUnitsOfSale as SupportedUnitsOfSale, type types_TablePosition as TablePosition, type types_TaxRate as TaxRate, type types_UnitOfSale as UnitOfSale, type types_WebhookEvent as WebhookEvent, type types_WebhookEventName as WebhookEventName, types_supportedWebhookEvents as supportedWebhookEvents };
+}
+
+declare function Studio(info: {
+    apiKey?: string;
+    baseUrl?: string;
+    defaultTimeout?: number;
+    debug?: boolean;
+}): {
     isDebugMode: boolean;
     markets: {
         get: (marketId: string) => Promise<Market>;
@@ -403,7 +1137,7 @@ declare function Studio(apiKey: string, baseUrl?: string, defaultTimeout?: numbe
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
     webhooks: {
-        constructEvent: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<WebhookEvent<T>>;
     };
     actions: {
         constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
@@ -474,4 +1208,4 @@ declare function createAppManifest(appConfig: {
     readonly manifest: StudioManifest;
 };
 
-export { Studio, StudioHeaders, type StudioManifest, createAppManifest, Studio as default };
+export { Studio, StudioHeaders, type StudioManifest, types as StudioTypes, createAppManifest, Studio as default };