@marteye/studiojs 1.1.14 → 1.1.16

package/dist/index.common.d.ts

@@ -0,0 +1,11 @@
+/**
+|--------------------------------------------------
+| Common code for the Studio JS SDK
+| Code here can run in both Node, Native and Browser environments
+|--------------------------------------------------
+*/
+import { ChunkedFile, MediaUploadOptions, FileInput, ChunkedInput } from "./utils/multipart-upload";
+export type { ChunkedFile, MediaUploadOptions, FileInput, ChunkedInput };
+import * as StudioTypes from "./types";
+export { StudioTypes };
+export * from "./createApp";

package/dist/index.d.ts

@@ -1,3 +1,93 @@
+import { z } from 'zod';
+
+declare const videoTaskSchema: z.ZodEnum<["compressed", "thumbnail"]>;
+declare const imageSizeSchema: z.ZodEnum<["small", "medium", "large"]>;
+type ImageSize = z.infer<typeof imageSizeSchema>;
+type VideoTask = z.infer<typeof videoTaskSchema>;
+type SupportedFileTypesNames$1 = "image" | "video" | "file";
+type VariantProcessingState = {
+    fileName: string;
+    thumbHash: string;
+    path: string;
+    url: string;
+    fileType: string;
+    variants: Partial<Record<ImageSize | VideoTask, {
+        url: string;
+        isProcessing: boolean;
+        type: SupportedFileTypesNames$1;
+    }>>;
+};
+/**
+ |--------------------------------------------------
+ | END OF MEDIA CRATE CODE
+ |--------------------------------------------------
+ */
+type MediaFinishUploadResponse = {
+    message: string;
+    mediaType: string;
+    process: VariantProcessingState;
+};
+type MediaUploadOptions = {
+    marketId: string;
+    saleId: string;
+    lotId: string;
+    attributeId: string;
+    options?: {
+        bucket?: "raw";
+        parallelParts?: number;
+        baseUrl?: string;
+        progressCallback?: (progress: {
+            /**
+             * The state of the upload
+             */
+            state: "uploading" | "finished" | "failed" | "starting";
+            /**
+             * The progress of the upload
+             */
+            progress: number;
+            /**
+             * The current part number
+             */
+            currentPart?: number;
+            /**
+             * The total parts
+             */
+            totalParts?: number;
+        }) => void;
+    };
+};
+type ChunkedFile = {
+    partNumber: string;
+    chunk: string;
+    fileExtension: string;
+    fileMimeType: string;
+};
+type FileInput = {
+    file: File;
+    uploadConfig: MediaUploadOptions;
+};
+type ChunkedInput = {
+    fileName: string;
+    chunks: ChunkedFile[];
+    uploadConfig: MediaUploadOptions;
+};
+/**
+ * Handles the complete file upload process including chunking and progress tracking -
+ * WEB: Pass in a file and we will chunk it and upload it in parallel
+ * NATIVE: You need to chunk the file yourself.
+ * @param {FileInput | ChunkedInput} input - Either {file, options} or {fileName, chunks, options}
+ * @returns {Promise<MediaFinishUploadResponse>}
+ * @throws {Error} When upload fails
+ */
+declare const uploadFile: (input: FileInput | ChunkedInput, token: string) => Promise<MediaFinishUploadResponse>;
+
+declare function SimpleHttpClient(baseUrl: string, apiKey: string, fetch: any, defaultTimeout: number, debug?: boolean): {
+    get: <T>(path: string, queryParams?: any) => Promise<T>;
+    post: <T>(path: string, body: any) => Promise<T>;
+    delete: <T>(path: string) => Promise<T>;
+};
+type HttpClient = ReturnType<typeof SimpleHttpClient>;
+
 /**
  * Search result interface based on the API implementation
  */
@@ -558,21 +648,22 @@ interface Address {
     zip: string;
     country: string;
 }
-interface ImageThumbnail {
-    url: string;
-    width: number;
-    height: number;
-}
+declare const IMAGE_SIZES_VALUES: readonly ["small", "medium", "large"];
+declare const VIDEO_TASKS_VALUES: readonly ["compressed", "thumbnail"];
+type ImageSizes = (typeof IMAGE_SIZES_VALUES)[number];
+type VideoTasks = (typeof VIDEO_TASKS_VALUES)[number];
+type SupportedFileTypesNames = "image" | "video" | "file";
 interface Media {
-    id: string;
+    fileName: string;
+    path: string;
     url: string;
-    type: "image/jpeg" | "image/png" | "video/mp4" | "application/pdf";
-    filename: string;
-    thumbnails?: {
-        small?: ImageThumbnail;
-        medium?: ImageThumbnail;
-        large?: ImageThumbnail;
-    };
+    fileType: string;
+    variants: Partial<Record<ImageSizes | VideoTasks, {
+        url: string;
+        isLocal?: boolean;
+        isProcessing: boolean;
+        type: SupportedFileTypesNames;
+    }>>;
 }
 type MarketReportHeaders = "grossServices" | "vatOnServices" | "grossGoods" | "vatOnGoods" | "netTotal" | "contra";
 /**
@@ -977,6 +1068,8 @@ type types_DraftInvoice = DraftInvoice;
 type types_EmailWrapper = EmailWrapper;
 type types_FarmAssurances = FarmAssurances;
 type types_FieldPositions = FieldPositions;
+declare const types_IMAGE_SIZES_VALUES: typeof IMAGE_SIZES_VALUES;
+type types_ImageSizes = ImageSizes;
 type types_IncrementLadder = IncrementLadder;
 type types_IncrementLadderItem = IncrementLadderItem;
 type types_Invoice = Invoice;
@@ -1027,17 +1120,21 @@ type types_SuperType = SuperType;
 type types_SupportedAttributeTypes = SupportedAttributeTypes;
 type types_SupportedCountryCode = SupportedCountryCode;
 declare const types_SupportedCurrencyCodes: typeof SupportedCurrencyCodes;
+type types_SupportedFileTypesNames = SupportedFileTypesNames;
 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;
+declare const types_VIDEO_TASKS_VALUES: typeof VIDEO_TASKS_VALUES;
+type types_VideoTasks = VideoTasks;
 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 };
+  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_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_CurrenciesWithGuinea as CurrenciesWithGuinea, types_Currency as Currency, types_Customer as Customer, types_CustomerFromSearch as CustomerFromSearch, types_DeviceType as DeviceType, 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_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_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_StudioAppPartial as StudioAppPartial, types_SubtotalGroups as SubtotalGroups, types_SuperType as SuperType, types_SupportedAttributeTypes as SupportedAttributeTypes, types_SupportedCountryCode as SupportedCountryCode, types_SupportedFileTypesNames as SupportedFileTypesNames, types_TablePosition as TablePosition, types_TaxRate as TaxRate, types_UnitOfSale as UnitOfSale, types_VideoTasks as VideoTasks, types_WebhookEvent as WebhookEvent, types_WebhookEventName as WebhookEventName };
 }
 
 interface CreateCustomerPayload {
@@ -1062,6 +1159,179 @@ interface CreateCustomerPayload {
     marteyeUid?: string;
 }
 
+declare function resources(httpClient: HttpClient): {
+    markets: {
+        get: (marketId: string) => Promise<Market>;
+    };
+    sales: {
+        get: (marketId: string, saleId: string) => Promise<Sale>;
+        list: (marketId: string, opts: {
+            start?: string;
+            end?: string;
+        }) => Promise<{
+            start: string;
+            end: string;
+            sales: Sale[];
+        }>;
+        create: (marketId: string, saleData: {
+            name: string;
+            startsAt: string;
+            availableProductCodes: string[];
+            recurring?: null | "Weekly" | "Bi-weekly" | "Monthly";
+            martEyeSaleType?: "LIVE" | "TIMED" | null;
+            location?: string | null;
+            description?: string | null;
+            image?: string | null;
+            cover?: string | null;
+            attributeDefaults?: {
+                [attributekey: string]: string | number | boolean;
+            };
+        }) => Promise<{
+            saleId: string;
+        }>;
+        update: (marketId: string, saleId: string, data: {
+            name?: string;
+            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
+            defaultProductCode?: string;
+            attributeDefaults?: Record<string, any>;
+            martEyeId?: string | null;
+            marteyeSettings?: {
+                description?: string;
+                image?: string;
+                logo?: string;
+                type: "LIVE" | "TIMED";
+                location?: string | null;
+                descriptionLines?: string[];
+                descriptionLink?: string;
+                deposit?: number;
+                hidePrices?: boolean;
+                hideReplay?: boolean;
+                labels?: string[];
+                tags?: string[];
+                details?: Array<{
+                    markdownBase64: string;
+                    title: string;
+                }>;
+                cover?: string;
+                primaryColour?: string;
+                secondaryColour?: string;
+                foregroundColour?: string;
+                extensionTime?: number;
+                incrementLadder?: Array<{
+                    max: number;
+                    increment: number;
+                }>;
+                hideNav?: boolean;
+                signInOverrideLink?: string;
+                published?: boolean;
+                pin?: boolean;
+                cascade?: boolean;
+                reportEmail?: string;
+            } | null;
+        }) => Promise<Sale>;
+    };
+    lots: {
+        get: (marketId: string, saleId: string, lotId: string) => Promise<Lot>;
+        list: (marketId: string, saleId: string) => Promise<Lot[]>;
+        create: (marketId: string, saleId: string, data: {
+            index?: number;
+            lotNumber?: string;
+            group?: string;
+            productCode?: string;
+            sellerCustomerId?: string;
+            attributes?: Record<string, any>;
+            metadata?: Record<string, any>;
+            buyerCustomerId?: string;
+            unitPriceInCents?: number;
+            reservePriceInCents?: number;
+            startingPriceInCents?: number;
+            startAt?: string;
+            endAt?: string;
+            previousLotNumber?: string;
+            saleStatus?: LotSaleStatus;
+        }) => Promise<Lot>;
+        update: (marketId: string, saleId: string, lotId: string, data: {
+            productCode?: string;
+            attributes?: Record<string, any>;
+            sellerCasual?: string | null;
+            sellerCustomerId?: string | null;
+            lotNumber?: string | null;
+            remarks?: string;
+            notes?: string;
+            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
+            unitPriceInCents?: number;
+            reservePriceInCents?: number;
+            startingPriceInCents?: number;
+            buyerCasual?: string | null;
+            buyerCustomerId?: string | null;
+            startAt?: string | null;
+            endAt?: string | null;
+            saleStatus?: LotSaleStatus;
+            metadata?: Record<string, any>;
+        }) => Promise<Lot>;
+        delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
+    };
+    lotitems: {
+        create: (marketId: string, saleId: string, lotId: string, data: {
+            attributes?: Record<string, any>;
+            notes?: Array<{
+                text: string;
+            }>;
+            metadata?: Record<string, any>;
+        }) => Promise<LotItem>;
+        update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
+            attributes?: Record<string, any>;
+            index?: number;
+            metadata?: Record<string, any>;
+        }) => Promise<LotItem>;
+        delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
+    };
+    webhooks: {
+        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | undefined | null, endpointSecret: string | undefined | null) => Promise<WebhookEvent<T>>;
+    };
+    actions: {
+        constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
+    };
+    settings: {
+        get: (marketId: string) => Promise<SettingsMarketDefaults>;
+    };
+    adjustments: {
+        list: (marketId: string) => Promise<AdjustmentsConfiguration[]>;
+        get: (marketId: string, id: string) => Promise<AdjustmentsConfiguration>;
+    };
+    productCodes: {
+        list: (marketId: string) => Promise<ProductCodeConfiguration[]>;
+        get: (marketId: string, id: string) => Promise<ProductCodeConfiguration>;
+    };
+    taxRates: {
+        list: (marketId: string) => Promise<TaxRate[]>;
+        get: (marketId: string, id: string) => Promise<TaxRate>;
+    };
+    customers: {
+        list: (marketId: string) => Promise<Customer>;
+        get: (marketId: string, customerId: string) => Promise<Customer>;
+        avatar: (marketId: string, customerId: string) => Promise<Customer>;
+        create: (marketId: string, customerData: CreateCustomerPayload) => Promise<Customer>;
+        getByAccountNumber: (marketId: string, accountNumber: string) => Promise<Customer | null>;
+    };
+    search: {
+        query: (marketId: string, query: string) => Promise<SearchResult>;
+    };
+    files: {
+        uploadFile: (input: Parameters<typeof uploadFile>[0], token: string) => Promise<{
+            message: string;
+            mediaType: string;
+            process: VariantProcessingState;
+        }>;
+        deleteFile: (fileUrl: string, token: string) => Promise<{
+            data: boolean;
+        }>;
+    };
+};
+
+type StudioInstance = ReturnType<typeof resources> & {
+    isDebugMode: boolean;
+};
 declare function Studio(info?: {
     apiKey?: string;
     baseUrl?: string;
@@ -1075,8 +1345,8 @@ declare function Studio(info?: {
     sales: {
         get: (marketId: string, saleId: string) => Promise<Sale>;
         list: (marketId: string, opts: {
-            start?: string | undefined;
-            end?: string | undefined;
+            start?: string;
+            end?: string;
         }) => Promise<{
             start: string;
             end: string;
@@ -1086,117 +1356,117 @@ declare function Studio(info?: {
             name: string;
             startsAt: string;
             availableProductCodes: string[];
-            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
-            martEyeSaleType?: "LIVE" | "TIMED" | null | undefined;
-            location?: string | null | undefined;
-            description?: string | null | undefined;
-            image?: string | null | undefined;
-            cover?: string | null | undefined;
+            recurring?: null | "Weekly" | "Bi-weekly" | "Monthly";
+            martEyeSaleType?: "LIVE" | "TIMED" | null;
+            location?: string | null;
+            description?: string | null;
+            image?: string | null;
+            cover?: string | null;
             attributeDefaults?: {
                 [attributekey: string]: string | number | boolean;
-            } | undefined;
+            };
         }) => Promise<{
             saleId: string;
         }>;
         update: (marketId: string, saleId: string, data: {
-            name?: string | undefined;
-            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
-            defaultProductCode?: string | undefined;
-            attributeDefaults?: Record<string, any> | undefined;
-            martEyeId?: string | null | undefined;
+            name?: string;
+            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
+            defaultProductCode?: string;
+            attributeDefaults?: Record<string, any>;
+            martEyeId?: string | null;
             marteyeSettings?: {
-                description?: string | undefined;
-                image?: string | undefined;
-                logo?: string | undefined;
+                description?: string;
+                image?: string;
+                logo?: string;
                 type: "LIVE" | "TIMED";
-                location?: string | null | undefined;
-                descriptionLines?: string[] | undefined;
-                descriptionLink?: string | undefined;
-                deposit?: number | undefined;
-                hidePrices?: boolean | undefined;
-                hideReplay?: boolean | undefined;
-                labels?: string[] | undefined;
-                tags?: string[] | undefined;
-                details?: {
+                location?: string | null;
+                descriptionLines?: string[];
+                descriptionLink?: string;
+                deposit?: number;
+                hidePrices?: boolean;
+                hideReplay?: boolean;
+                labels?: string[];
+                tags?: string[];
+                details?: Array<{
                     markdownBase64: string;
                     title: string;
-                }[] | undefined;
-                cover?: string | undefined;
-                primaryColour?: string | undefined;
-                secondaryColour?: string | undefined;
-                foregroundColour?: string | undefined;
-                extensionTime?: number | undefined;
-                incrementLadder?: {
+                }>;
+                cover?: string;
+                primaryColour?: string;
+                secondaryColour?: string;
+                foregroundColour?: string;
+                extensionTime?: number;
+                incrementLadder?: Array<{
                     max: number;
                     increment: number;
-                }[] | undefined;
-                hideNav?: boolean | undefined;
-                signInOverrideLink?: string | undefined;
-                published?: boolean | undefined;
-                pin?: boolean | undefined;
-                cascade?: boolean | undefined;
-                reportEmail?: string | undefined;
-            } | null | undefined;
+                }>;
+                hideNav?: boolean;
+                signInOverrideLink?: string;
+                published?: boolean;
+                pin?: boolean;
+                cascade?: boolean;
+                reportEmail?: string;
+            } | null;
         }) => Promise<Sale>;
     };
     lots: {
         get: (marketId: string, saleId: string, lotId: string) => Promise<Lot>;
         list: (marketId: string, saleId: string) => Promise<Lot[]>;
         create: (marketId: string, saleId: string, data: {
-            index?: number | undefined;
-            lotNumber?: string | undefined;
-            group?: string | undefined;
-            productCode?: string | undefined;
-            sellerCustomerId?: string | undefined;
-            attributes?: Record<string, any> | undefined;
-            metadata?: Record<string, any> | undefined;
-            buyerCustomerId?: string | undefined;
-            unitPriceInCents?: number | undefined;
-            reservePriceInCents?: number | undefined;
-            startingPriceInCents?: number | undefined;
-            startAt?: string | undefined;
-            endAt?: string | undefined;
-            previousLotNumber?: string | undefined;
-            saleStatus?: LotSaleStatus | undefined;
+            index?: number;
+            lotNumber?: string;
+            group?: string;
+            productCode?: string;
+            sellerCustomerId?: string;
+            attributes?: Record<string, any>;
+            metadata?: Record<string, any>;
+            buyerCustomerId?: string;
+            unitPriceInCents?: number;
+            reservePriceInCents?: number;
+            startingPriceInCents?: number;
+            startAt?: string;
+            endAt?: string;
+            previousLotNumber?: string;
+            saleStatus?: LotSaleStatus;
         }) => Promise<Lot>;
         update: (marketId: string, saleId: string, lotId: string, data: {
-            productCode?: string | undefined;
-            attributes?: Record<string, any> | undefined;
-            sellerCasual?: string | null | undefined;
-            sellerCustomerId?: string | null | undefined;
-            lotNumber?: string | null | undefined;
-            remarks?: string | undefined;
-            notes?: string | undefined;
-            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
-            unitPriceInCents?: number | undefined;
-            reservePriceInCents?: number | undefined;
-            startingPriceInCents?: number | undefined;
-            buyerCasual?: string | null | undefined;
-            buyerCustomerId?: string | null | undefined;
-            startAt?: string | null | undefined;
-            endAt?: string | null | undefined;
-            saleStatus?: LotSaleStatus | undefined;
-            metadata?: Record<string, any> | undefined;
+            productCode?: string;
+            attributes?: Record<string, any>;
+            sellerCasual?: string | null;
+            sellerCustomerId?: string | null;
+            lotNumber?: string | null;
+            remarks?: string;
+            notes?: string;
+            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
+            unitPriceInCents?: number;
+            reservePriceInCents?: number;
+            startingPriceInCents?: number;
+            buyerCasual?: string | null;
+            buyerCustomerId?: string | null;
+            startAt?: string | null;
+            endAt?: string | null;
+            saleStatus?: LotSaleStatus;
+            metadata?: Record<string, any>;
         }) => Promise<Lot>;
         delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
     };
     lotitems: {
         create: (marketId: string, saleId: string, lotId: string, data: {
-            attributes?: Record<string, any> | undefined;
-            notes?: {
+            attributes?: Record<string, any>;
+            notes?: Array<{
                 text: string;
-            }[] | undefined;
-            metadata?: Record<string, any> | undefined;
+            }>;
+            metadata?: Record<string, any>;
         }) => Promise<LotItem>;
         update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
-            attributes?: Record<string, any> | undefined;
-            index?: number | undefined;
-            metadata?: Record<string, any> | undefined;
+            attributes?: Record<string, any>;
+            index?: number;
+            metadata?: Record<string, any>;
         }) => Promise<LotItem>;
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
     webhooks: {
-        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<WebhookEvent<T>>;
+        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | undefined | null, endpointSecret: string | undefined | null) => Promise<WebhookEvent<T>>;
     };
     actions: {
         constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
@@ -1226,6 +1496,16 @@ declare function Studio(info?: {
     search: {
         query: (marketId: string, query: string) => Promise<SearchResult>;
     };
+    files: {
+        uploadFile: (input: Parameters<typeof uploadFile>[0], token: string) => Promise<{
+            message: string;
+            mediaType: string;
+            process: VariantProcessingState;
+        }>;
+        deleteFile: (fileUrl: string, token: string) => Promise<{
+            data: boolean;
+        }>;
+    };
 };
 
 /**
@@ -1292,4 +1572,5 @@ declare function createAppManifest(appConfig: {
     readonly manifest: StudioManifest;
 };
 
-export { Studio, StudioHeaders, type StudioManifest, types as StudioTypes, createAppManifest, Studio as default };
+export { Studio, StudioHeaders, types as StudioTypes, createAppManifest, Studio as default };
+export type { ChunkedFile, StudioInstance, StudioManifest };