@marteye/studiojs 1.1.48 → 1.1.49-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -2,9 +2,9 @@ import { z } from 'zod';
2
2
 
3
3
  declare function SimpleHttpClient(baseUrl: string, apiKey: string, fetch: any, defaultTimeout: number, debug?: boolean): {
4
4
  get: <T>(path: string, queryParams?: any) => Promise<T>;
5
- post: <T_1>(path: string, body: any) => Promise<T_1>;
6
- patch: <T_2>(path: string, body: any) => Promise<T_2>;
7
- delete: <T_3>(path: string) => Promise<T_3>;
5
+ post: <T>(path: string, body: any) => Promise<T>;
6
+ patch: <T>(path: string, body: any) => Promise<T>;
7
+ delete: <T>(path: string) => Promise<T>;
8
8
  };
9
9
  type HttpClient = ReturnType<typeof SimpleHttpClient>;
10
10
 
@@ -53,11 +53,18 @@ interface ListTransactionsParams {
53
53
 
54
54
  type Timestamp = string;
55
55
  type ClientType = "Seller" | "Buyer";
56
- type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
56
+ type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Dogs" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
57
57
  declare const SupportedSuperTypes: SuperType[];
58
58
  declare const LivestockSuperTypes: SuperType[];
59
59
  type Currency = "GBP" | "EUR" | "USD";
60
60
  declare const SupportedCurrencyCodes: Currency[];
61
+ declare const AccountTiers: {
62
+ readonly free: 0;
63
+ readonly basic: 1;
64
+ readonly standard: 2;
65
+ readonly premium: 3;
66
+ };
67
+ type AccountTier = (typeof AccountTiers)[keyof typeof AccountTiers];
61
68
  type SupportedCountryCode = "GB-ENG" | "GB-SCT" | "GB-WLS" | "GB-NIR" | "IE";
62
69
  type CurrenciesWithGuinea = Currency | "GUINEA-GBP";
63
70
  type UnitOfSale = "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
@@ -86,6 +93,7 @@ interface Market {
86
93
  createdAt: Timestamp;
87
94
  }[];
88
95
  paymentInstructions?: string;
96
+ accountTier?: AccountTier;
89
97
  }
90
98
  interface SettingsMarketDefaults {
91
99
  updatedAt: Timestamp;
@@ -112,6 +120,7 @@ interface SettingsMarketDefaults {
112
120
  selectDocumentIdsMap: {
113
121
  [supertype: string]: string[];
114
122
  };
123
+ priceEntrySheetColumnOrder?: string[];
115
124
  enableLuckMoney?: boolean;
116
125
  }
117
126
  interface SettingsProductCodes {
@@ -221,6 +230,8 @@ interface Sale {
221
230
  count: number;
222
231
  sold: number;
223
232
  invoiced: number;
233
+ invoicedBuyer?: number;
234
+ invoicedSeller?: number;
224
235
  valueInCents: number;
225
236
  };
226
237
  lotItems: {
@@ -257,6 +268,7 @@ interface TemplateSaleData {
257
268
  marteyeSettings?: MartEyeTimedSaleSettings | MartEyeLiveSaleSettings | null;
258
269
  enableLuckMoney?: boolean;
259
270
  enableLotGrouping?: boolean;
271
+ customAttributes?: AttributeDefinition[];
260
272
  }
261
273
  interface SaleTemplate {
262
274
  id: string;
@@ -348,6 +360,7 @@ interface SaleFromSearch extends Omit<Omit<Omit<Sale, "createdAt">, "updatedAt">
348
360
  type LotSaleStatus = "Sold" | "Unsold" | "Rerun" | "Resold" | null;
349
361
  type LotDeleteDecision = "allow" | "confirm" | "block";
350
362
  type LotDeleteReason = "local_only" | "not_started" | "started" | "started_with_bids" | "finished" | "studio_locked" | "not_found" | "sync_unavailable" | "link_unresolved";
363
+ type LotDeleteStudioLockReason = "invoice" | "sale_status";
351
364
  interface LotDeletePreflightItem {
352
365
  lotId: string;
353
366
  lotNumber: string | null;
@@ -361,6 +374,8 @@ interface LotDeletePreflightItem {
361
374
  bidCount: number;
362
375
  startAt: string | null;
363
376
  endAt: string | null;
377
+ studioLockReason?: LotDeleteStudioLockReason;
378
+ lockedSaleStatus?: string | null;
364
379
  }
365
380
  interface LotDeletePreflightResponse {
366
381
  version: 1;
@@ -461,6 +476,8 @@ interface LotWithItemsAsArray extends Omit<Lot, "itemMap"> {
461
476
  interface LotGeneratedValues {
462
477
  totalValueInCents?: number | null;
463
478
  description?: string | null;
479
+ buyerInvoiceDescription?: string | null;
480
+ sellerStatementDescription?: string | null;
464
481
  pricePerKiloInCents?: number | null;
465
482
  averageWeightKg?: number | null;
466
483
  pricePerItemInCents?: number | null;
@@ -554,6 +571,9 @@ interface ProductCodeConfiguration {
554
571
  createdAt?: Timestamp;
555
572
  updatedAt?: Timestamp;
556
573
  updatedBy?: string | null;
574
+ archived?: boolean;
575
+ archivedAt?: Timestamp | null;
576
+ archivedBy?: string | null;
557
577
  superType: SuperType;
558
578
  description: string;
559
579
  icon?: string;
@@ -575,7 +595,21 @@ interface ProductCodeConfiguration {
575
595
  [attributekey: string]: AttributeValueType;
576
596
  };
577
597
  lotDescriptionTemplate?: string;
598
+ sellerStatementLotDescriptionTemplate?: string;
599
+ buyerInvoiceLotDescriptionTemplate?: string;
578
600
  rostrumAttributes?: string[];
601
+ benthamSheepBuilder?: {
602
+ topFieldOrder?: string[];
603
+ topFieldVisibility?: Record<string, boolean>;
604
+ lotFieldOrder?: string[];
605
+ lotFieldVisibility?: Record<string, boolean>;
606
+ createLotOnRowAdd?: boolean;
607
+ sendCreatedLotsToDisplayBoard?: boolean;
608
+ displayBoardTrigger?: "auto" | {
609
+ type: "focused";
610
+ field: string;
611
+ };
612
+ };
579
613
  selectDocumentIds?: string[] | null;
580
614
  }
581
615
  /***
@@ -803,6 +837,7 @@ type ChequeField = "chequeDate" | "chequeNumber" | "payee" | "amount" | "amountI
803
837
  type SubtotalGroups = "Commission" | string;
804
838
  type AdjustmentTotalTarget = "Per Invoice" | "Total - finalTotalInCents" | "Total - lotTotalLessCommissionInCentsExVat";
805
839
  type AdjustmentTarget = UnitOfSale | AdjustmentTotalTarget;
840
+ type LadderCalculationMode = "progressive" | "threshold";
806
841
  /***
807
842
  * Commission is added as a line item. Can also be used for levies etc
808
843
  */
@@ -850,6 +885,7 @@ interface Adjustment {
850
885
  } | null;
851
886
  fixedAmountInCents?: number | null;
852
887
  ladder?: {
888
+ mode?: LadderCalculationMode;
853
889
  steps: {
854
890
  percentageValue?: number;
855
891
  upToAmountInCents?: number | null;
@@ -920,6 +956,8 @@ interface Payout {
920
956
  accountNumber?: string;
921
957
  sortCode?: string;
922
958
  chequeMadePayableTo?: string;
959
+ chequeIsPrinted?: boolean;
960
+ chequeIssuedManually?: boolean;
923
961
  transactionDate: Timestamp;
924
962
  reference: string | null;
925
963
  status: "pending" | "complete" | "void";
@@ -1157,6 +1195,11 @@ interface AttributeDefinition {
1157
1195
  shortName?: string;
1158
1196
  description?: string;
1159
1197
  martEyeAttribute?: string;
1198
+ scope?: "global" | "sale";
1199
+ saleScoped?: boolean;
1200
+ archivedAt?: Timestamp | null;
1201
+ archivedBy?: string | null;
1202
+ archivedSyncToMartEye?: boolean | null;
1160
1203
  applyTo: string[];
1161
1204
  level: "item" | "lot";
1162
1205
  readonly?: boolean;
@@ -1251,6 +1294,8 @@ interface SendSMSPayload {
1251
1294
  customerId?: string;
1252
1295
  reference?: string;
1253
1296
  senderName?: string;
1297
+ communicationContext?: string;
1298
+ metadata?: Record<string, any>;
1254
1299
  }
1255
1300
  type BroadcastType = "sms" | "email";
1256
1301
  type BroadcastKind = "broadcast" | "statement";
@@ -1266,6 +1311,7 @@ interface BroadcastRecipient {
1266
1311
  interface SMSBroadcastPayload {
1267
1312
  type: "sms";
1268
1313
  kind?: BroadcastKind;
1314
+ communicationContext?: string;
1269
1315
  message?: string;
1270
1316
  senderName?: string;
1271
1317
  recipients: BroadcastRecipient[];
@@ -1273,6 +1319,7 @@ interface SMSBroadcastPayload {
1273
1319
  interface EmailBroadcastPayload {
1274
1320
  type: "email";
1275
1321
  kind?: BroadcastKind;
1322
+ communicationContext?: string;
1276
1323
  message?: string;
1277
1324
  subject?: string;
1278
1325
  subdomain?: string;
@@ -1360,6 +1407,8 @@ interface EmailTask {
1360
1407
  type BroadcastTask = SMSTask | EmailTask;
1361
1408
 
1362
1409
  type types_Accessory = Accessory;
1410
+ type types_AccountTier = AccountTier;
1411
+ declare const types_AccountTiers: typeof AccountTiers;
1363
1412
  type types_ActivityChange = ActivityChange;
1364
1413
  type types_ActivityLog = ActivityLog;
1365
1414
  type types_ActivityOperation = ActivityOperation;
@@ -1411,6 +1460,7 @@ type types_InvoiceField = InvoiceField;
1411
1460
  type types_InvoiceLineItem = InvoiceLineItem;
1412
1461
  type types_InvoiceTotalAdjustmentConfiguration = InvoiceTotalAdjustmentConfiguration;
1413
1462
  type types_InvoiceTotals = InvoiceTotals;
1463
+ type types_LadderCalculationMode = LadderCalculationMode;
1414
1464
  type types_LineItemAdjustmentConfiguration = LineItemAdjustmentConfiguration;
1415
1465
  declare const types_LivestockSuperTypes: typeof LivestockSuperTypes;
1416
1466
  type types_Lot = Lot;
@@ -1418,6 +1468,7 @@ type types_LotDeleteDecision = LotDeleteDecision;
1418
1468
  type types_LotDeletePreflightItem = LotDeletePreflightItem;
1419
1469
  type types_LotDeletePreflightResponse = LotDeletePreflightResponse;
1420
1470
  type types_LotDeleteReason = LotDeleteReason;
1471
+ type types_LotDeleteStudioLockReason = LotDeleteStudioLockReason;
1421
1472
  type types_LotGeneratedValues = LotGeneratedValues;
1422
1473
  type types_LotIssue = LotIssue;
1423
1474
  type types_LotItem = LotItem;
@@ -1479,7 +1530,8 @@ type types_WebhookEvent<T> = WebhookEvent<T>;
1479
1530
  type types_WebhookEventName = WebhookEventName;
1480
1531
  declare const types_supportedWebhookEvents: typeof supportedWebhookEvents;
1481
1532
  declare namespace types {
1482
- export { type types_Accessory as Accessory, type types_ActivityChange as ActivityChange, type types_ActivityLog as ActivityLog, type types_ActivityOperation as ActivityOperation, 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_Application as Application, type types_AttributeDefinition as AttributeDefinition, type types_AttributeValueType as AttributeValueType, type types_BankDetails as BankDetails, type types_BroadcastKind as BroadcastKind, type types_BroadcastPayload as BroadcastPayload, type types_BroadcastRecipient as BroadcastRecipient, type types_BroadcastSendResponse as BroadcastSendResponse, type types_BroadcastSendResultItem as BroadcastSendResultItem, type types_BroadcastTask as BroadcastTask, type types_BroadcastType as BroadcastType, type types_Cart as Cart, type types_CartItem as CartItem, type types_ChequeField as ChequeField, type types_ClientType as ClientType, type types_CphLookupResponse as CphLookupResponse, type types_CurrenciesWithGuinea as CurrenciesWithGuinea, type types_Currency as Currency, type types_Customer as Customer, type types_CustomerBankDetails as CustomerBankDetails, type types_CustomerContact as CustomerContact, type types_CustomerFromSearch as CustomerFromSearch, type types_DeleteLotsResponse as DeleteLotsResponse, type types_DeviceType as DeviceType, type types_DisplayBoardMode as DisplayBoardMode, type types_DraftInvoice as DraftInvoice, type types_EmailBroadcastPayload as EmailBroadcastPayload, type types_EmailDeliveryClass as EmailDeliveryClass, type types_EmailTask as EmailTask, type types_EmailWrapper as EmailWrapper, type types_FarmAssurances as FarmAssurances, type types_FieldPositions as FieldPositions, types_IMAGE_SIZES_VALUES as IMAGE_SIZES_VALUES, type types_ImageSizes as ImageSizes, type types_IncrementLadder as IncrementLadder, type types_IncrementLadderItem as IncrementLadderItem, type types_Invoice as Invoice, type types_InvoiceDeliveryPreference as InvoiceDeliveryPreference, 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_LotDeleteDecision as LotDeleteDecision, type types_LotDeletePreflightItem as LotDeletePreflightItem, type types_LotDeletePreflightResponse as LotDeletePreflightResponse, type types_LotDeleteReason as LotDeleteReason, 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_PostmarkMessageStream as PostmarkMessageStream, type types_Printer as Printer, type types_Product as Product, type types_ProductCodeConfiguration as ProductCodeConfiguration, type types_ProductConfiguration as ProductConfiguration, type types_ReadOptions as ReadOptions, type types_SMSBroadcastPayload as SMSBroadcastPayload, type types_SMSTask as SMSTask, type types_Sale as Sale, type types_SaleFromSearch as SaleFromSearch, type types_SalePublishStatus as SalePublishStatus, type types_SaleTemplate as SaleTemplate, type types_SendSMSPayload as SendSMSPayload, 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_StoredDataGridConfig as StoredDataGridConfig, 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, type SupportedFileTypesNames$1 as SupportedFileTypesNames, types_SupportedPaymentMethods as SupportedPaymentMethods, types_SupportedSuperTypes as SupportedSuperTypes, types_SupportedUnitsOfSale as SupportedUnitsOfSale, type types_TablePosition as TablePosition, type types_TaxRate as TaxRate, type types_TemplateSaleData as TemplateSaleData, type types_UnitOfSale as UnitOfSale, types_VIDEO_TASKS_VALUES as VIDEO_TASKS_VALUES, type types_VideoTasks as VideoTasks, type types_WebhookEvent as WebhookEvent, type types_WebhookEventName as WebhookEventName, types_supportedWebhookEvents as supportedWebhookEvents };
1533
+ export { types_AccountTiers as AccountTiers, 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 };
1534
+ export type { types_Accessory as Accessory, types_AccountTier as AccountTier, types_ActivityChange as ActivityChange, types_ActivityLog as ActivityLog, types_ActivityOperation as ActivityOperation, types_Address as Address, types_AddressWrapper as AddressWrapper, types_AdjustmentTarget as AdjustmentTarget, types_AdjustmentTotalTarget as AdjustmentTotalTarget, types_AdjustmentsConfiguration as AdjustmentsConfiguration, types_AppParameterConfig as AppParameterConfig, types_Application as Application, types_AttributeDefinition as AttributeDefinition, types_AttributeValueType as AttributeValueType, types_BankDetails as BankDetails, types_BroadcastKind as BroadcastKind, types_BroadcastPayload as BroadcastPayload, types_BroadcastRecipient as BroadcastRecipient, types_BroadcastSendResponse as BroadcastSendResponse, types_BroadcastSendResultItem as BroadcastSendResultItem, types_BroadcastTask as BroadcastTask, types_BroadcastType as BroadcastType, types_Cart as Cart, types_CartItem as CartItem, types_ChequeField as ChequeField, types_ClientType as ClientType, types_CphLookupResponse as CphLookupResponse, types_CurrenciesWithGuinea as CurrenciesWithGuinea, types_Currency as Currency, types_Customer as Customer, types_CustomerBankDetails as CustomerBankDetails, types_CustomerContact as CustomerContact, types_CustomerFromSearch as CustomerFromSearch, types_DeleteLotsResponse as DeleteLotsResponse, types_DeviceType as DeviceType, types_DisplayBoardMode as DisplayBoardMode, types_DraftInvoice as DraftInvoice, types_EmailBroadcastPayload as EmailBroadcastPayload, types_EmailDeliveryClass as EmailDeliveryClass, types_EmailTask as EmailTask, types_EmailWrapper as EmailWrapper, types_FarmAssurances as FarmAssurances, types_FieldPositions as FieldPositions, types_ImageSizes as ImageSizes, types_IncrementLadder as IncrementLadder, types_IncrementLadderItem as IncrementLadderItem, types_Invoice as Invoice, types_InvoiceDeliveryPreference as InvoiceDeliveryPreference, types_InvoiceField as InvoiceField, types_InvoiceLineItem as InvoiceLineItem, types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, types_InvoiceTotals as InvoiceTotals, types_LadderCalculationMode as LadderCalculationMode, types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_Lot as Lot, types_LotDeleteDecision as LotDeleteDecision, types_LotDeletePreflightItem as LotDeletePreflightItem, types_LotDeletePreflightResponse as LotDeletePreflightResponse, types_LotDeleteReason as LotDeleteReason, types_LotDeleteStudioLockReason as LotDeleteStudioLockReason, 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_PostmarkMessageStream as PostmarkMessageStream, types_Printer as Printer, types_Product as Product, types_ProductCodeConfiguration as ProductCodeConfiguration, types_ProductConfiguration as ProductConfiguration, types_ReadOptions as ReadOptions, types_SMSBroadcastPayload as SMSBroadcastPayload, types_SMSTask as SMSTask, types_Sale as Sale, types_SaleFromSearch as SaleFromSearch, types_SalePublishStatus as SalePublishStatus, types_SaleTemplate as SaleTemplate, types_SendSMSPayload as SendSMSPayload, types_SettingsAccessories as SettingsAccessories, types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, types_SettingsGlobalAttributes as SettingsGlobalAttributes, types_SettingsMarketDefaults as SettingsMarketDefaults, types_SettingsPrinters as SettingsPrinters, types_SettingsProductCodes as SettingsProductCodes, types_SettingsTaxRates as SettingsTaxRates, types_ShortCustomerDetails as ShortCustomerDetails, types_SimplePaymentIn as SimplePaymentIn, types_SimplePaymentOut as SimplePaymentOut, types_StoredDataGridConfig as StoredDataGridConfig, types_StudioAppPartial as StudioAppPartial, types_SubtotalGroups as SubtotalGroups, types_SuperType as SuperType, types_SupportedAttributeTypes as SupportedAttributeTypes, types_SupportedCountryCode as SupportedCountryCode, SupportedFileTypesNames$1 as SupportedFileTypesNames, types_TablePosition as TablePosition, types_TaxRate as TaxRate, types_TemplateSaleData as TemplateSaleData, types_UnitOfSale as UnitOfSale, types_VideoTasks as VideoTasks, types_WebhookEvent as WebhookEvent, types_WebhookEventName as WebhookEventName };
1483
1535
  }
1484
1536
 
1485
1537
  interface ListContactsResponse {
@@ -1515,6 +1567,16 @@ type VariantProcessingState = {
1515
1567
  type: SupportedFileTypesNames;
1516
1568
  }>>;
1517
1569
  };
1570
+ /**
1571
+ |--------------------------------------------------
1572
+ | END OF MEDIA CRATE CODE
1573
+ |--------------------------------------------------
1574
+ */
1575
+ type MediaFinishUploadResponse = {
1576
+ message: string;
1577
+ mediaType: string;
1578
+ process: VariantProcessingState;
1579
+ };
1518
1580
  type MediaUploadOptions = {
1519
1581
  marketId: string;
1520
1582
  saleId: string;
@@ -1559,6 +1621,15 @@ type ChunkedInput = {
1559
1621
  chunks: ChunkedFile[];
1560
1622
  uploadConfig: MediaUploadOptions;
1561
1623
  };
1624
+ /**
1625
+ * Handles the complete file upload process including chunking and progress tracking -
1626
+ * WEB: Pass in a file and we will chunk it and upload it in parallel
1627
+ * NATIVE: You need to chunk the file yourself.
1628
+ * @param {FileInput | ChunkedInput} input - Either {file, options} or {fileName, chunks, options}
1629
+ * @returns {Promise<MediaFinishUploadResponse>}
1630
+ * @throws {Error} When upload fails
1631
+ */
1632
+ declare const uploadMultipartFile: (input: FileInput | ChunkedInput, token: string) => Promise<MediaFinishUploadResponse>;
1562
1633
  type SingleFileInput = {
1563
1634
  file?: File;
1564
1635
  filePath?: never;
@@ -1568,6 +1639,10 @@ type SingleFileInput = {
1568
1639
  file?: never;
1569
1640
  uploadConfig: MediaUploadOptions;
1570
1641
  };
1642
+ declare const uploadSingleFile: (input: SingleFileInput, token: string) => Promise<{
1643
+ message: string;
1644
+ data: Media;
1645
+ }>;
1571
1646
 
1572
1647
  /**
1573
1648
  * Search result interface based on the API implementation
@@ -1612,6 +1687,10 @@ interface CreatePayoutRequest {
1612
1687
  sortCode?: string;
1613
1688
  /** Name on cheque (Cheque only). Falls back to customer display name. */
1614
1689
  chequeMadePayableTo?: string;
1690
+ /** True when the cheque has already been issued and should not be queued for Studio printing. */
1691
+ chequeIsPrinted?: boolean;
1692
+ /** True when the cheque was written or printed outside Studio. */
1693
+ chequeIssuedManually?: boolean;
1615
1694
  }
1616
1695
 
1617
1696
  interface PaymentsListResponse {
@@ -1835,6 +1914,7 @@ interface ActivityListParams {
1835
1914
 
1836
1915
  type CustomerListType = "simple" | "smart";
1837
1916
  type CustomerListRole = "buyer" | "seller" | "both";
1917
+ type CustomerListSourceCustomerType = Exclude<CustomerListRole, "both">;
1838
1918
  interface GeoBounds {
1839
1919
  north: number;
1840
1920
  south: number;
@@ -1851,11 +1931,16 @@ interface CustomerListQuery {
1851
1931
  filter?: string;
1852
1932
  excludeFilters?: string[];
1853
1933
  bounds?: GeoBounds;
1934
+ sourceCustomerType?: CustomerListSourceCustomerType | null;
1935
+ sourceSaleId?: string | null;
1936
+ sourceCustomerIds?: string[];
1854
1937
  rollingDateConfig?: RollingDateConfig;
1855
1938
  secondaryFilter?: {
1856
1939
  role: CustomerListRole;
1857
1940
  filter?: string;
1858
1941
  bounds?: GeoBounds;
1942
+ sourceCustomerType?: CustomerListSourceCustomerType | null;
1943
+ sourceCustomerIds?: string[];
1859
1944
  rollingDateConfig?: RollingDateConfig;
1860
1945
  };
1861
1946
  }
@@ -1896,10 +1981,13 @@ interface CustomerListMember {
1896
1981
  phoneNumber?: string;
1897
1982
  }
1898
1983
  interface CustomerListFilterGroup {
1899
- role: CustomerListRole;
1984
+ role?: CustomerListRole | null;
1900
1985
  dateStart?: string | null;
1901
1986
  dateEnd?: string | null;
1902
1987
  productCodes?: string[];
1988
+ sourceCustomerType?: CustomerListSourceCustomerType | null;
1989
+ sourceCustomerIds?: string[];
1990
+ sourceSaleId?: string | null;
1903
1991
  geoBounds?: GeoBounds | null;
1904
1992
  rollingDateConfig?: RollingDateConfig;
1905
1993
  }
@@ -1908,6 +1996,9 @@ interface CustomerListFilters {
1908
1996
  dateStart?: string | null;
1909
1997
  dateEnd?: string | null;
1910
1998
  productCodes?: string[];
1999
+ sourceCustomerType?: CustomerListSourceCustomerType | null;
2000
+ sourceCustomerIds?: string[];
2001
+ sourceSaleId?: string | null;
1911
2002
  excludeDateStart?: string | null;
1912
2003
  excludeDateEnd?: string | null;
1913
2004
  excludedProductCodes?: string[];
@@ -1989,6 +2080,10 @@ interface CustomerListMembersResponse {
1989
2080
  interface CustomerListPreviewResponse {
1990
2081
  rows: CustomerListReportRow[];
1991
2082
  summary: CustomerListReportSummary;
2083
+ sourceGroups?: Array<{
2084
+ source: CustomerListReportRow;
2085
+ targets: CustomerListReportRow[];
2086
+ }>;
1992
2087
  }
1993
2088
  interface CustomerListProductCodesResponse {
1994
2089
  uniqueProductCodes: string[];
@@ -2031,7 +2126,7 @@ interface UpdateCustomerListPayload {
2031
2126
 
2032
2127
  declare function resources(httpClient: HttpClient): {
2033
2128
  activity: {
2034
- list: (marketId: string, params?: ActivityListParams | undefined) => Promise<ActivityListResponse>;
2129
+ list: (marketId: string, params?: ActivityListParams) => Promise<ActivityListResponse>;
2035
2130
  get: (marketId: string, activityId: string) => Promise<ActivityLog>;
2036
2131
  };
2037
2132
  broadcast: {
@@ -2039,17 +2134,17 @@ declare function resources(httpClient: HttpClient): {
2039
2134
  get: (marketId: string, type: BroadcastType, taskId: string) => Promise<BroadcastTask>;
2040
2135
  };
2041
2136
  markets: {
2042
- get: (marketId: string, options?: ReadOptions | undefined) => Promise<Market>;
2137
+ get: (marketId: string, options?: ReadOptions) => Promise<Market>;
2043
2138
  };
2044
2139
  members: {
2045
- list: (marketId: string, params?: MembersListParams | undefined) => Promise<MembersListResponse>;
2140
+ list: (marketId: string, params?: MembersListParams) => Promise<MembersListResponse>;
2046
2141
  get: (marketId: string, memberId: string) => Promise<Member>;
2047
2142
  };
2048
2143
  sales: {
2049
- get: (marketId: string, saleId: string, options?: ReadOptions | undefined) => Promise<Sale>;
2144
+ get: (marketId: string, saleId: string, options?: ReadOptions) => Promise<Sale>;
2050
2145
  list: (marketId: string, opts: {
2051
- start?: string | undefined;
2052
- end?: string | undefined;
2146
+ start?: string;
2147
+ end?: string;
2053
2148
  }) => Promise<{
2054
2149
  start: string;
2055
2150
  end: string;
@@ -2059,128 +2154,128 @@ declare function resources(httpClient: HttpClient): {
2059
2154
  name: string;
2060
2155
  startsAt: string;
2061
2156
  availableProductCodes: string[];
2062
- recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
2063
- martEyeSaleType?: "LIVE" | "TIMED" | null | undefined;
2064
- location?: string | null | undefined;
2065
- description?: string | null | undefined;
2066
- image?: string | null | undefined;
2067
- cover?: string | null | undefined;
2068
- templateId?: string | null | undefined;
2069
- enableLotGrouping?: boolean | undefined;
2157
+ recurring?: null | "Weekly" | "Bi-weekly" | "Monthly";
2158
+ martEyeSaleType?: "LIVE" | "TIMED" | null;
2159
+ location?: string | null;
2160
+ description?: string | null;
2161
+ image?: string | null;
2162
+ cover?: string | null;
2163
+ templateId?: string | null;
2164
+ enableLotGrouping?: boolean;
2070
2165
  attributeDefaults?: {
2071
2166
  [attributekey: string]: string | number | boolean;
2072
- } | undefined;
2167
+ };
2073
2168
  }) => Promise<{
2074
2169
  saleId: string;
2075
2170
  }>;
2076
2171
  update: (marketId: string, saleId: string, data: {
2077
- name?: string | undefined;
2078
- startsAt?: string | undefined;
2079
- recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
2080
- defaultProductCode?: string | undefined;
2081
- attributeDefaults?: Record<string, any> | undefined;
2082
- publishStatus?: SalePublishStatus | undefined;
2083
- enableLotGrouping?: boolean | undefined;
2172
+ name?: string;
2173
+ startsAt?: string;
2174
+ recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
2175
+ defaultProductCode?: string;
2176
+ attributeDefaults?: Record<string, any>;
2177
+ publishStatus?: SalePublishStatus;
2178
+ enableLotGrouping?: boolean;
2084
2179
  marteyeSettings?: {
2085
- description?: string | undefined;
2086
- image?: string | undefined;
2087
- logo?: string | undefined;
2180
+ description?: string;
2181
+ image?: string;
2182
+ logo?: string;
2088
2183
  type: "LIVE" | "TIMED";
2089
- location?: string | null | undefined;
2090
- descriptionLines?: string[] | undefined;
2091
- descriptionLink?: string | undefined;
2092
- deposit?: number | undefined;
2093
- hidePrices?: boolean | undefined;
2094
- hideReplay?: boolean | undefined;
2095
- labels?: string[] | undefined;
2096
- tags?: string[] | undefined;
2097
- details?: {
2184
+ location?: string | null;
2185
+ descriptionLines?: string[];
2186
+ descriptionLink?: string;
2187
+ deposit?: number;
2188
+ hidePrices?: boolean;
2189
+ hideReplay?: boolean;
2190
+ labels?: string[];
2191
+ tags?: string[];
2192
+ details?: Array<{
2098
2193
  markdownBase64: string;
2099
2194
  title: string;
2100
- }[] | undefined;
2101
- cover?: string | undefined;
2102
- primaryColour?: string | undefined;
2103
- secondaryColour?: string | undefined;
2104
- foregroundColour?: string | undefined;
2105
- extensionTime?: number | undefined;
2106
- incrementLadder?: {
2195
+ }>;
2196
+ cover?: string;
2197
+ primaryColour?: string;
2198
+ secondaryColour?: string;
2199
+ foregroundColour?: string;
2200
+ extensionTime?: number;
2201
+ incrementLadder?: Array<{
2107
2202
  max: number;
2108
2203
  increment: number;
2109
- }[] | undefined;
2110
- hideNav?: boolean | undefined;
2111
- signInOverrideLink?: string | undefined;
2112
- published?: boolean | undefined;
2113
- pin?: boolean | undefined;
2114
- cascade?: boolean | undefined;
2115
- reportEmail?: string | undefined;
2116
- queueLots?: boolean | undefined;
2117
- markSubjectLotsAsSold?: boolean | undefined;
2118
- } | null | undefined;
2204
+ }>;
2205
+ hideNav?: boolean;
2206
+ signInOverrideLink?: string;
2207
+ published?: boolean;
2208
+ pin?: boolean;
2209
+ cascade?: boolean;
2210
+ reportEmail?: string;
2211
+ queueLots?: boolean;
2212
+ markSubjectLotsAsSold?: boolean;
2213
+ } | null;
2119
2214
  }) => Promise<Sale>;
2120
2215
  };
2121
2216
  lots: {
2122
- get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions | undefined) => Promise<Lot>;
2217
+ get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions) => Promise<Lot>;
2123
2218
  list: (marketId: string, saleId: string, filters?: {
2124
- group?: string | undefined;
2125
- productCode?: string | undefined;
2126
- saleStatus?: LotSaleStatus | undefined;
2127
- sellerCustomerId?: string | undefined;
2128
- buyerCustomerId?: string | undefined;
2129
- } | undefined) => Promise<Lot[]>;
2219
+ group?: string;
2220
+ productCode?: string;
2221
+ saleStatus?: LotSaleStatus;
2222
+ sellerCustomerId?: string;
2223
+ buyerCustomerId?: string;
2224
+ }) => Promise<Lot[]>;
2130
2225
  create: (marketId: string, saleId: string, data: {
2131
- index?: number | undefined;
2132
- lotNumber?: string | undefined;
2133
- group?: string | undefined;
2134
- productCode?: string | undefined;
2135
- sellerCustomerId?: string | undefined;
2136
- attributes?: Record<string, any> | undefined;
2137
- metadata?: Record<string, any> | undefined;
2138
- buyerCustomerId?: string | undefined;
2139
- unitPriceInCents?: number | undefined;
2140
- reservePriceInCents?: number | undefined;
2141
- startingPriceInCents?: number | undefined;
2142
- startAt?: string | undefined;
2143
- endAt?: string | undefined;
2144
- previousLotNumber?: string | undefined;
2145
- saleStatus?: LotSaleStatus | undefined;
2226
+ index?: number;
2227
+ lotNumber?: string;
2228
+ group?: string;
2229
+ productCode?: string;
2230
+ sellerCustomerId?: string;
2231
+ attributes?: Record<string, any>;
2232
+ metadata?: Record<string, any>;
2233
+ buyerCustomerId?: string;
2234
+ unitPriceInCents?: number;
2235
+ reservePriceInCents?: number;
2236
+ startingPriceInCents?: number;
2237
+ startAt?: string;
2238
+ endAt?: string;
2239
+ previousLotNumber?: string;
2240
+ saleStatus?: LotSaleStatus;
2146
2241
  }) => Promise<Lot>;
2147
2242
  update: (marketId: string, saleId: string, lotId: string, data: {
2148
- productCode?: string | undefined;
2149
- attributes?: Record<string, any> | undefined;
2150
- sellerCasual?: string | null | undefined;
2151
- sellerCustomerId?: string | null | undefined;
2152
- lotNumber?: string | null | undefined;
2153
- remarks?: string | undefined;
2154
- notes?: string | undefined;
2155
- unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
2156
- unitPriceInCents?: number | undefined;
2157
- reservePriceInCents?: number | undefined;
2158
- startingPriceInCents?: number | undefined;
2159
- buyerCasual?: string | null | undefined;
2160
- buyerCustomerId?: string | null | undefined;
2161
- startAt?: string | null | undefined;
2162
- endAt?: string | null | undefined;
2163
- saleStatus?: LotSaleStatus | undefined;
2164
- metadata?: Record<string, any> | undefined;
2165
- inputAccessories?: Record<string, any> | undefined;
2243
+ productCode?: string;
2244
+ attributes?: Record<string, any>;
2245
+ sellerCasual?: string | null;
2246
+ sellerCustomerId?: string | null;
2247
+ lotNumber?: string | null;
2248
+ remarks?: string;
2249
+ notes?: string;
2250
+ unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
2251
+ unitPriceInCents?: number;
2252
+ reservePriceInCents?: number;
2253
+ startingPriceInCents?: number;
2254
+ buyerCasual?: string | null;
2255
+ buyerCustomerId?: string | null;
2256
+ startAt?: string | null;
2257
+ endAt?: string | null;
2258
+ saleStatus?: LotSaleStatus;
2259
+ metadata?: Record<string, any>;
2260
+ inputAccessories?: Record<string, any>;
2166
2261
  }) => Promise<Lot>;
2167
2262
  delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
2168
2263
  deletePreflight: (marketId: string, saleId: string, lotId: string) => Promise<LotDeletePreflightResponse>;
2169
2264
  deletePreflightBatch: (marketId: string, saleId: string, lotIds: string[]) => Promise<DeleteLotsResponse>;
2170
- deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[] | undefined) => Promise<DeleteLotsResponse>;
2265
+ deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[]) => Promise<DeleteLotsResponse>;
2171
2266
  };
2172
2267
  lotitems: {
2173
2268
  create: (marketId: string, saleId: string, lotId: string, data: {
2174
- attributes?: Record<string, any> | undefined;
2175
- notes?: {
2269
+ attributes?: Record<string, any>;
2270
+ notes?: Array<{
2176
2271
  text: string;
2177
- }[] | undefined;
2178
- metadata?: Record<string, any> | undefined;
2272
+ }>;
2273
+ metadata?: Record<string, any>;
2179
2274
  }) => Promise<LotItem>;
2180
2275
  update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
2181
- attributes?: Record<string, any> | undefined;
2182
- index?: number | undefined;
2183
- metadata?: Record<string, any> | undefined;
2276
+ attributes?: Record<string, any>;
2277
+ index?: number;
2278
+ metadata?: Record<string, any>;
2184
2279
  }) => Promise<LotItem>;
2185
2280
  delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
2186
2281
  };
@@ -2193,27 +2288,27 @@ declare function resources(httpClient: HttpClient): {
2193
2288
  lookup: (marketId: string, cph: string) => Promise<CphLookupResponse>;
2194
2289
  };
2195
2290
  webhooks: {
2196
- constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<WebhookEvent<T>>;
2291
+ constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | undefined | null, endpointSecret: string | undefined | null) => Promise<WebhookEvent<T>>;
2197
2292
  };
2198
2293
  actions: {
2199
2294
  constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
2200
2295
  };
2201
2296
  bidderApplications: {
2202
- list: (marketId: string, options?: ListApplicationsOptions | undefined) => Promise<ListApplicationsResponse>;
2297
+ list: (marketId: string, options?: ListApplicationsOptions) => Promise<ListApplicationsResponse>;
2203
2298
  get: (marketId: string, applicationId: string) => Promise<Application>;
2204
2299
  create: (marketId: string, applicationData: CreateApplicationPayload) => Promise<Application>;
2205
2300
  update: (marketId: string, applicationId: string, updateData: UpdateApplicationPayload) => Promise<Application>;
2206
- approve: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
2207
- reject: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
2301
+ approve: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
2302
+ reject: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
2208
2303
  unlink: (marketId: string, applicationId: string) => Promise<Application>;
2209
2304
  delete: (marketId: string, applicationId: string) => Promise<void>;
2210
2305
  };
2211
2306
  settings: {
2212
- get: (marketId: string, options?: ReadOptions | undefined) => Promise<SettingsMarketDefaults>;
2307
+ get: (marketId: string, options?: ReadOptions) => Promise<SettingsMarketDefaults>;
2213
2308
  };
2214
2309
  adjustments: {
2215
2310
  list: (marketId: string) => Promise<AdjustmentsConfiguration[]>;
2216
- get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<AdjustmentsConfiguration>;
2311
+ get: (marketId: string, id: string, options?: ReadOptions) => Promise<AdjustmentsConfiguration>;
2217
2312
  create: (marketId: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
2218
2313
  update: (marketId: string, id: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
2219
2314
  };
@@ -2224,8 +2319,10 @@ declare function resources(httpClient: HttpClient): {
2224
2319
  update: (marketId: string, id: string, data: UpdateExtraPayload) => Promise<Product>;
2225
2320
  };
2226
2321
  productCodes: {
2227
- list: (marketId: string) => Promise<ProductCodeConfiguration[]>;
2228
- get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<ProductCodeConfiguration>;
2322
+ list: (marketId: string, options?: {
2323
+ includeArchived?: boolean;
2324
+ }) => Promise<ProductCodeConfiguration[]>;
2325
+ get: (marketId: string, id: string, options?: ReadOptions) => Promise<ProductCodeConfiguration>;
2229
2326
  create: (marketId: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
2230
2327
  update: (marketId: string, id: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
2231
2328
  };
@@ -2239,13 +2336,13 @@ declare function resources(httpClient: HttpClient): {
2239
2336
  create: (marketId: string, body: {
2240
2337
  saleId: string;
2241
2338
  name: string;
2242
- description?: string | null | undefined;
2339
+ description?: string | null;
2243
2340
  }) => Promise<{
2244
2341
  templateId: string;
2245
2342
  }>;
2246
2343
  update: (marketId: string, templateId: string, body: {
2247
- name?: string | undefined;
2248
- description?: string | null | undefined;
2344
+ name?: string;
2345
+ description?: string | null;
2249
2346
  }) => Promise<{
2250
2347
  template: SaleTemplate;
2251
2348
  }>;
@@ -2258,8 +2355,8 @@ declare function resources(httpClient: HttpClient): {
2258
2355
  get: (marketId: string, id: string) => Promise<TaxRate>;
2259
2356
  };
2260
2357
  customers: {
2261
- list: (marketId: string, lastId?: string | null | undefined) => Promise<CustomersListResponse>;
2262
- get: (marketId: string, customerId: string, options?: ReadOptions | undefined) => Promise<Customer>;
2358
+ list: (marketId: string, lastId?: string | null) => Promise<CustomersListResponse>;
2359
+ get: (marketId: string, customerId: string, options?: ReadOptions) => Promise<Customer>;
2263
2360
  avatar: (marketId: string, customerId: string) => Promise<Customer>;
2264
2361
  create: (marketId: string, customerData: CreateCustomerPayload) => Promise<Customer>;
2265
2362
  update: (marketId: string, customerId: string, customerData: UpdateCustomerPayload) => Promise<Customer>;
@@ -2267,32 +2364,32 @@ declare function resources(httpClient: HttpClient): {
2267
2364
  getByMartEyeUid: (marketId: string, marteyeUid: string) => Promise<Customer | null>;
2268
2365
  };
2269
2366
  customerLists: {
2270
- list: (marketId: string, options?: CustomerListsListOptions | undefined) => Promise<CustomerListsListResponse>;
2271
- listAll: (marketId: string, options?: Omit<CustomerListsListOptions, "offset"> | undefined) => Promise<CustomerList[]>;
2367
+ list: (marketId: string, options?: CustomerListsListOptions) => Promise<CustomerListsListResponse>;
2368
+ listAll: (marketId: string, options?: Omit<CustomerListsListOptions, "offset">) => Promise<CustomerList[]>;
2272
2369
  get: (marketId: string, listId: string) => Promise<CustomerList>;
2273
2370
  getBySlug: (marketId: string, slug: string) => Promise<CustomerList>;
2274
2371
  create: (marketId: string, payload: CreateCustomerListPayload) => Promise<CustomerList>;
2275
2372
  update: (marketId: string, listId: string, payload: UpdateCustomerListPayload) => Promise<CustomerList>;
2276
2373
  delete: (marketId: string, listId: string) => Promise<CustomerListDeleteResponse>;
2277
2374
  refresh: (marketId: string, listId: string) => Promise<CustomerListRefreshResponse>;
2278
- getMembers: (marketId: string, listId: string, options?: CustomerListMembersOptions | undefined) => Promise<CustomerListMembersResponse>;
2279
- getAllMembers: (marketId: string, listId: string, options?: Omit<CustomerListMembersOptions, "offset"> | undefined) => Promise<CustomerListMember[]>;
2375
+ getMembers: (marketId: string, listId: string, options?: CustomerListMembersOptions) => Promise<CustomerListMembersResponse>;
2376
+ getAllMembers: (marketId: string, listId: string, options?: Omit<CustomerListMembersOptions, "offset">) => Promise<CustomerListMember[]>;
2280
2377
  addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<CustomerListAddMembersResponse>;
2281
2378
  removeMember: (marketId: string, listId: string, customerId: string) => Promise<CustomerListRemoveMemberResponse>;
2282
2379
  preview: (marketId: string, filters: CustomerListFilters) => Promise<CustomerListPreviewResponse>;
2283
2380
  listProductCodes: (marketId: string) => Promise<CustomerListProductCodesResponse>;
2284
- view: (marketId: string, listIdOrSlug: string, options?: CustomerListViewOptions | undefined) => Promise<CustomerListViewResult>;
2381
+ view: (marketId: string, listIdOrSlug: string, options?: CustomerListViewOptions) => Promise<CustomerListViewResult>;
2285
2382
  };
2286
2383
  invoices: {
2287
- list: (marketId: string, lastId?: string | null | undefined) => Promise<InvoicesListResponse>;
2288
- get: (marketId: string, invoiceId: string, options?: ReadOptions | undefined) => Promise<Invoice>;
2384
+ list: (marketId: string, lastId?: string | null) => Promise<InvoicesListResponse>;
2385
+ get: (marketId: string, invoiceId: string, options?: ReadOptions) => Promise<Invoice>;
2289
2386
  };
2290
2387
  payments: {
2291
- list: (marketId: string, lastId?: string | null | undefined) => Promise<PaymentsListResponse>;
2388
+ list: (marketId: string, lastId?: string | null) => Promise<PaymentsListResponse>;
2292
2389
  get: (marketId: string, paymentId: string) => Promise<Payment>;
2293
2390
  };
2294
2391
  payouts: {
2295
- list: (marketId: string, lastId?: string | null | undefined) => Promise<PayoutsListResponse>;
2392
+ list: (marketId: string, lastId?: string | null) => Promise<PayoutsListResponse>;
2296
2393
  get: (marketId: string, payoutId: string) => Promise<Payout>;
2297
2394
  create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
2298
2395
  };
@@ -2300,11 +2397,11 @@ declare function resources(httpClient: HttpClient): {
2300
2397
  query: (marketId: string, query: string) => Promise<SearchResult>;
2301
2398
  };
2302
2399
  files: {
2303
- uploadSingleFile: (input: SingleFileInput, token: string) => Promise<{
2400
+ uploadSingleFile: (input: Parameters<typeof uploadSingleFile>[0], token: string) => Promise<{
2304
2401
  message: string;
2305
2402
  data: Media;
2306
2403
  }>;
2307
- uploadMultipartFile: (input: FileInput | ChunkedInput, token: string) => Promise<{
2404
+ uploadMultipartFile: (input: Parameters<typeof uploadMultipartFile>[0], token: string) => Promise<{
2308
2405
  message: string;
2309
2406
  mediaType: string;
2310
2407
  process: VariantProcessingState;
@@ -2315,9 +2412,9 @@ declare function resources(httpClient: HttpClient): {
2315
2412
  };
2316
2413
  contacts: {
2317
2414
  list: (marketId: string, customerId: string, params?: {
2318
- lastId?: string | undefined;
2319
- limit?: number | undefined;
2320
- } | undefined) => Promise<ListContactsResponse>;
2415
+ lastId?: string;
2416
+ limit?: number;
2417
+ }) => Promise<ListContactsResponse>;
2321
2418
  get: (marketId: string, customerId: string, contactId: string) => Promise<CustomerContact>;
2322
2419
  create: (marketId: string, customerId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
2323
2420
  update: (marketId: string, customerId: string, contactId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
@@ -2342,7 +2439,7 @@ declare function Studio(info?: {
2342
2439
  }): {
2343
2440
  isDebugMode: boolean;
2344
2441
  activity: {
2345
- list: (marketId: string, params?: ActivityListParams | undefined) => Promise<ActivityListResponse>;
2442
+ list: (marketId: string, params?: ActivityListParams) => Promise<ActivityListResponse>;
2346
2443
  get: (marketId: string, activityId: string) => Promise<ActivityLog>;
2347
2444
  };
2348
2445
  broadcast: {
@@ -2350,17 +2447,17 @@ declare function Studio(info?: {
2350
2447
  get: (marketId: string, type: BroadcastType, taskId: string) => Promise<BroadcastTask>;
2351
2448
  };
2352
2449
  markets: {
2353
- get: (marketId: string, options?: ReadOptions | undefined) => Promise<Market>;
2450
+ get: (marketId: string, options?: ReadOptions) => Promise<Market>;
2354
2451
  };
2355
2452
  members: {
2356
- list: (marketId: string, params?: MembersListParams | undefined) => Promise<MembersListResponse>;
2453
+ list: (marketId: string, params?: MembersListParams) => Promise<MembersListResponse>;
2357
2454
  get: (marketId: string, memberId: string) => Promise<Member>;
2358
2455
  };
2359
2456
  sales: {
2360
- get: (marketId: string, saleId: string, options?: ReadOptions | undefined) => Promise<Sale>;
2457
+ get: (marketId: string, saleId: string, options?: ReadOptions) => Promise<Sale>;
2361
2458
  list: (marketId: string, opts: {
2362
- start?: string | undefined;
2363
- end?: string | undefined;
2459
+ start?: string;
2460
+ end?: string;
2364
2461
  }) => Promise<{
2365
2462
  start: string;
2366
2463
  end: string;
@@ -2370,128 +2467,128 @@ declare function Studio(info?: {
2370
2467
  name: string;
2371
2468
  startsAt: string;
2372
2469
  availableProductCodes: string[];
2373
- recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
2374
- martEyeSaleType?: "LIVE" | "TIMED" | null | undefined;
2375
- location?: string | null | undefined;
2376
- description?: string | null | undefined;
2377
- image?: string | null | undefined;
2378
- cover?: string | null | undefined;
2379
- templateId?: string | null | undefined;
2380
- enableLotGrouping?: boolean | undefined;
2470
+ recurring?: null | "Weekly" | "Bi-weekly" | "Monthly";
2471
+ martEyeSaleType?: "LIVE" | "TIMED" | null;
2472
+ location?: string | null;
2473
+ description?: string | null;
2474
+ image?: string | null;
2475
+ cover?: string | null;
2476
+ templateId?: string | null;
2477
+ enableLotGrouping?: boolean;
2381
2478
  attributeDefaults?: {
2382
2479
  [attributekey: string]: string | number | boolean;
2383
- } | undefined;
2480
+ };
2384
2481
  }) => Promise<{
2385
2482
  saleId: string;
2386
2483
  }>;
2387
2484
  update: (marketId: string, saleId: string, data: {
2388
- name?: string | undefined;
2389
- startsAt?: string | undefined;
2390
- recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
2391
- defaultProductCode?: string | undefined;
2392
- attributeDefaults?: Record<string, any> | undefined;
2393
- publishStatus?: SalePublishStatus | undefined;
2394
- enableLotGrouping?: boolean | undefined;
2485
+ name?: string;
2486
+ startsAt?: string;
2487
+ recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
2488
+ defaultProductCode?: string;
2489
+ attributeDefaults?: Record<string, any>;
2490
+ publishStatus?: SalePublishStatus;
2491
+ enableLotGrouping?: boolean;
2395
2492
  marteyeSettings?: {
2396
- description?: string | undefined;
2397
- image?: string | undefined;
2398
- logo?: string | undefined;
2493
+ description?: string;
2494
+ image?: string;
2495
+ logo?: string;
2399
2496
  type: "LIVE" | "TIMED";
2400
- location?: string | null | undefined;
2401
- descriptionLines?: string[] | undefined;
2402
- descriptionLink?: string | undefined;
2403
- deposit?: number | undefined;
2404
- hidePrices?: boolean | undefined;
2405
- hideReplay?: boolean | undefined;
2406
- labels?: string[] | undefined;
2407
- tags?: string[] | undefined;
2408
- details?: {
2497
+ location?: string | null;
2498
+ descriptionLines?: string[];
2499
+ descriptionLink?: string;
2500
+ deposit?: number;
2501
+ hidePrices?: boolean;
2502
+ hideReplay?: boolean;
2503
+ labels?: string[];
2504
+ tags?: string[];
2505
+ details?: Array<{
2409
2506
  markdownBase64: string;
2410
2507
  title: string;
2411
- }[] | undefined;
2412
- cover?: string | undefined;
2413
- primaryColour?: string | undefined;
2414
- secondaryColour?: string | undefined;
2415
- foregroundColour?: string | undefined;
2416
- extensionTime?: number | undefined;
2417
- incrementLadder?: {
2508
+ }>;
2509
+ cover?: string;
2510
+ primaryColour?: string;
2511
+ secondaryColour?: string;
2512
+ foregroundColour?: string;
2513
+ extensionTime?: number;
2514
+ incrementLadder?: Array<{
2418
2515
  max: number;
2419
2516
  increment: number;
2420
- }[] | undefined;
2421
- hideNav?: boolean | undefined;
2422
- signInOverrideLink?: string | undefined;
2423
- published?: boolean | undefined;
2424
- pin?: boolean | undefined;
2425
- cascade?: boolean | undefined;
2426
- reportEmail?: string | undefined;
2427
- queueLots?: boolean | undefined;
2428
- markSubjectLotsAsSold?: boolean | undefined;
2429
- } | null | undefined;
2517
+ }>;
2518
+ hideNav?: boolean;
2519
+ signInOverrideLink?: string;
2520
+ published?: boolean;
2521
+ pin?: boolean;
2522
+ cascade?: boolean;
2523
+ reportEmail?: string;
2524
+ queueLots?: boolean;
2525
+ markSubjectLotsAsSold?: boolean;
2526
+ } | null;
2430
2527
  }) => Promise<Sale>;
2431
2528
  };
2432
2529
  lots: {
2433
- get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions | undefined) => Promise<Lot>;
2530
+ get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions) => Promise<Lot>;
2434
2531
  list: (marketId: string, saleId: string, filters?: {
2435
- group?: string | undefined;
2436
- productCode?: string | undefined;
2437
- saleStatus?: LotSaleStatus | undefined;
2438
- sellerCustomerId?: string | undefined;
2439
- buyerCustomerId?: string | undefined;
2440
- } | undefined) => Promise<Lot[]>;
2532
+ group?: string;
2533
+ productCode?: string;
2534
+ saleStatus?: LotSaleStatus;
2535
+ sellerCustomerId?: string;
2536
+ buyerCustomerId?: string;
2537
+ }) => Promise<Lot[]>;
2441
2538
  create: (marketId: string, saleId: string, data: {
2442
- index?: number | undefined;
2443
- lotNumber?: string | undefined;
2444
- group?: string | undefined;
2445
- productCode?: string | undefined;
2446
- sellerCustomerId?: string | undefined;
2447
- attributes?: Record<string, any> | undefined;
2448
- metadata?: Record<string, any> | undefined;
2449
- buyerCustomerId?: string | undefined;
2450
- unitPriceInCents?: number | undefined;
2451
- reservePriceInCents?: number | undefined;
2452
- startingPriceInCents?: number | undefined;
2453
- startAt?: string | undefined;
2454
- endAt?: string | undefined;
2455
- previousLotNumber?: string | undefined;
2456
- saleStatus?: LotSaleStatus | undefined;
2539
+ index?: number;
2540
+ lotNumber?: string;
2541
+ group?: string;
2542
+ productCode?: string;
2543
+ sellerCustomerId?: string;
2544
+ attributes?: Record<string, any>;
2545
+ metadata?: Record<string, any>;
2546
+ buyerCustomerId?: string;
2547
+ unitPriceInCents?: number;
2548
+ reservePriceInCents?: number;
2549
+ startingPriceInCents?: number;
2550
+ startAt?: string;
2551
+ endAt?: string;
2552
+ previousLotNumber?: string;
2553
+ saleStatus?: LotSaleStatus;
2457
2554
  }) => Promise<Lot>;
2458
2555
  update: (marketId: string, saleId: string, lotId: string, data: {
2459
- productCode?: string | undefined;
2460
- attributes?: Record<string, any> | undefined;
2461
- sellerCasual?: string | null | undefined;
2462
- sellerCustomerId?: string | null | undefined;
2463
- lotNumber?: string | null | undefined;
2464
- remarks?: string | undefined;
2465
- notes?: string | undefined;
2466
- unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
2467
- unitPriceInCents?: number | undefined;
2468
- reservePriceInCents?: number | undefined;
2469
- startingPriceInCents?: number | undefined;
2470
- buyerCasual?: string | null | undefined;
2471
- buyerCustomerId?: string | null | undefined;
2472
- startAt?: string | null | undefined;
2473
- endAt?: string | null | undefined;
2474
- saleStatus?: LotSaleStatus | undefined;
2475
- metadata?: Record<string, any> | undefined;
2476
- inputAccessories?: Record<string, any> | undefined;
2556
+ productCode?: string;
2557
+ attributes?: Record<string, any>;
2558
+ sellerCasual?: string | null;
2559
+ sellerCustomerId?: string | null;
2560
+ lotNumber?: string | null;
2561
+ remarks?: string;
2562
+ notes?: string;
2563
+ unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
2564
+ unitPriceInCents?: number;
2565
+ reservePriceInCents?: number;
2566
+ startingPriceInCents?: number;
2567
+ buyerCasual?: string | null;
2568
+ buyerCustomerId?: string | null;
2569
+ startAt?: string | null;
2570
+ endAt?: string | null;
2571
+ saleStatus?: LotSaleStatus;
2572
+ metadata?: Record<string, any>;
2573
+ inputAccessories?: Record<string, any>;
2477
2574
  }) => Promise<Lot>;
2478
2575
  delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
2479
2576
  deletePreflight: (marketId: string, saleId: string, lotId: string) => Promise<LotDeletePreflightResponse>;
2480
2577
  deletePreflightBatch: (marketId: string, saleId: string, lotIds: string[]) => Promise<DeleteLotsResponse>;
2481
- deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[] | undefined) => Promise<DeleteLotsResponse>;
2578
+ deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[]) => Promise<DeleteLotsResponse>;
2482
2579
  };
2483
2580
  lotitems: {
2484
2581
  create: (marketId: string, saleId: string, lotId: string, data: {
2485
- attributes?: Record<string, any> | undefined;
2486
- notes?: {
2582
+ attributes?: Record<string, any>;
2583
+ notes?: Array<{
2487
2584
  text: string;
2488
- }[] | undefined;
2489
- metadata?: Record<string, any> | undefined;
2585
+ }>;
2586
+ metadata?: Record<string, any>;
2490
2587
  }) => Promise<LotItem>;
2491
2588
  update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
2492
- attributes?: Record<string, any> | undefined;
2493
- index?: number | undefined;
2494
- metadata?: Record<string, any> | undefined;
2589
+ attributes?: Record<string, any>;
2590
+ index?: number;
2591
+ metadata?: Record<string, any>;
2495
2592
  }) => Promise<LotItem>;
2496
2593
  delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
2497
2594
  };
@@ -2504,27 +2601,27 @@ declare function Studio(info?: {
2504
2601
  lookup: (marketId: string, cph: string) => Promise<CphLookupResponse>;
2505
2602
  };
2506
2603
  webhooks: {
2507
- constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<WebhookEvent<T>>;
2604
+ constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | undefined | null, endpointSecret: string | undefined | null) => Promise<WebhookEvent<T>>;
2508
2605
  };
2509
2606
  actions: {
2510
2607
  constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
2511
2608
  };
2512
2609
  bidderApplications: {
2513
- list: (marketId: string, options?: ListApplicationsOptions | undefined) => Promise<ListApplicationsResponse>;
2610
+ list: (marketId: string, options?: ListApplicationsOptions) => Promise<ListApplicationsResponse>;
2514
2611
  get: (marketId: string, applicationId: string) => Promise<Application>;
2515
2612
  create: (marketId: string, applicationData: CreateApplicationPayload) => Promise<Application>;
2516
2613
  update: (marketId: string, applicationId: string, updateData: UpdateApplicationPayload) => Promise<Application>;
2517
- approve: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
2518
- reject: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
2614
+ approve: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
2615
+ reject: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
2519
2616
  unlink: (marketId: string, applicationId: string) => Promise<Application>;
2520
2617
  delete: (marketId: string, applicationId: string) => Promise<void>;
2521
2618
  };
2522
2619
  settings: {
2523
- get: (marketId: string, options?: ReadOptions | undefined) => Promise<SettingsMarketDefaults>;
2620
+ get: (marketId: string, options?: ReadOptions) => Promise<SettingsMarketDefaults>;
2524
2621
  };
2525
2622
  adjustments: {
2526
2623
  list: (marketId: string) => Promise<AdjustmentsConfiguration[]>;
2527
- get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<AdjustmentsConfiguration>;
2624
+ get: (marketId: string, id: string, options?: ReadOptions) => Promise<AdjustmentsConfiguration>;
2528
2625
  create: (marketId: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
2529
2626
  update: (marketId: string, id: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
2530
2627
  };
@@ -2535,8 +2632,10 @@ declare function Studio(info?: {
2535
2632
  update: (marketId: string, id: string, data: UpdateExtraPayload) => Promise<Product>;
2536
2633
  };
2537
2634
  productCodes: {
2538
- list: (marketId: string) => Promise<ProductCodeConfiguration[]>;
2539
- get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<ProductCodeConfiguration>;
2635
+ list: (marketId: string, options?: {
2636
+ includeArchived?: boolean;
2637
+ }) => Promise<ProductCodeConfiguration[]>;
2638
+ get: (marketId: string, id: string, options?: ReadOptions) => Promise<ProductCodeConfiguration>;
2540
2639
  create: (marketId: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
2541
2640
  update: (marketId: string, id: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
2542
2641
  };
@@ -2550,13 +2649,13 @@ declare function Studio(info?: {
2550
2649
  create: (marketId: string, body: {
2551
2650
  saleId: string;
2552
2651
  name: string;
2553
- description?: string | null | undefined;
2652
+ description?: string | null;
2554
2653
  }) => Promise<{
2555
2654
  templateId: string;
2556
2655
  }>;
2557
2656
  update: (marketId: string, templateId: string, body: {
2558
- name?: string | undefined;
2559
- description?: string | null | undefined;
2657
+ name?: string;
2658
+ description?: string | null;
2560
2659
  }) => Promise<{
2561
2660
  template: SaleTemplate;
2562
2661
  }>;
@@ -2569,8 +2668,8 @@ declare function Studio(info?: {
2569
2668
  get: (marketId: string, id: string) => Promise<TaxRate>;
2570
2669
  };
2571
2670
  customers: {
2572
- list: (marketId: string, lastId?: string | null | undefined) => Promise<CustomersListResponse>;
2573
- get: (marketId: string, customerId: string, options?: ReadOptions | undefined) => Promise<Customer>;
2671
+ list: (marketId: string, lastId?: string | null) => Promise<CustomersListResponse>;
2672
+ get: (marketId: string, customerId: string, options?: ReadOptions) => Promise<Customer>;
2574
2673
  avatar: (marketId: string, customerId: string) => Promise<Customer>;
2575
2674
  create: (marketId: string, customerData: CreateCustomerPayload) => Promise<Customer>;
2576
2675
  update: (marketId: string, customerId: string, customerData: UpdateCustomerPayload) => Promise<Customer>;
@@ -2578,32 +2677,32 @@ declare function Studio(info?: {
2578
2677
  getByMartEyeUid: (marketId: string, marteyeUid: string) => Promise<Customer | null>;
2579
2678
  };
2580
2679
  customerLists: {
2581
- list: (marketId: string, options?: CustomerListsListOptions | undefined) => Promise<CustomerListsListResponse>;
2582
- listAll: (marketId: string, options?: Omit<CustomerListsListOptions, "offset"> | undefined) => Promise<CustomerList[]>;
2680
+ list: (marketId: string, options?: CustomerListsListOptions) => Promise<CustomerListsListResponse>;
2681
+ listAll: (marketId: string, options?: Omit<CustomerListsListOptions, "offset">) => Promise<CustomerList[]>;
2583
2682
  get: (marketId: string, listId: string) => Promise<CustomerList>;
2584
2683
  getBySlug: (marketId: string, slug: string) => Promise<CustomerList>;
2585
2684
  create: (marketId: string, payload: CreateCustomerListPayload) => Promise<CustomerList>;
2586
2685
  update: (marketId: string, listId: string, payload: UpdateCustomerListPayload) => Promise<CustomerList>;
2587
2686
  delete: (marketId: string, listId: string) => Promise<CustomerListDeleteResponse>;
2588
2687
  refresh: (marketId: string, listId: string) => Promise<CustomerListRefreshResponse>;
2589
- getMembers: (marketId: string, listId: string, options?: CustomerListMembersOptions | undefined) => Promise<CustomerListMembersResponse>;
2590
- getAllMembers: (marketId: string, listId: string, options?: Omit<CustomerListMembersOptions, "offset"> | undefined) => Promise<CustomerListMember[]>;
2688
+ getMembers: (marketId: string, listId: string, options?: CustomerListMembersOptions) => Promise<CustomerListMembersResponse>;
2689
+ getAllMembers: (marketId: string, listId: string, options?: Omit<CustomerListMembersOptions, "offset">) => Promise<CustomerListMember[]>;
2591
2690
  addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<CustomerListAddMembersResponse>;
2592
2691
  removeMember: (marketId: string, listId: string, customerId: string) => Promise<CustomerListRemoveMemberResponse>;
2593
2692
  preview: (marketId: string, filters: CustomerListFilters) => Promise<CustomerListPreviewResponse>;
2594
2693
  listProductCodes: (marketId: string) => Promise<CustomerListProductCodesResponse>;
2595
- view: (marketId: string, listIdOrSlug: string, options?: CustomerListViewOptions | undefined) => Promise<CustomerListViewResult>;
2694
+ view: (marketId: string, listIdOrSlug: string, options?: CustomerListViewOptions) => Promise<CustomerListViewResult>;
2596
2695
  };
2597
2696
  invoices: {
2598
- list: (marketId: string, lastId?: string | null | undefined) => Promise<InvoicesListResponse>;
2599
- get: (marketId: string, invoiceId: string, options?: ReadOptions | undefined) => Promise<Invoice>;
2697
+ list: (marketId: string, lastId?: string | null) => Promise<InvoicesListResponse>;
2698
+ get: (marketId: string, invoiceId: string, options?: ReadOptions) => Promise<Invoice>;
2600
2699
  };
2601
2700
  payments: {
2602
- list: (marketId: string, lastId?: string | null | undefined) => Promise<PaymentsListResponse>;
2701
+ list: (marketId: string, lastId?: string | null) => Promise<PaymentsListResponse>;
2603
2702
  get: (marketId: string, paymentId: string) => Promise<Payment>;
2604
2703
  };
2605
2704
  payouts: {
2606
- list: (marketId: string, lastId?: string | null | undefined) => Promise<PayoutsListResponse>;
2705
+ list: (marketId: string, lastId?: string | null) => Promise<PayoutsListResponse>;
2607
2706
  get: (marketId: string, payoutId: string) => Promise<Payout>;
2608
2707
  create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
2609
2708
  };
@@ -2611,11 +2710,11 @@ declare function Studio(info?: {
2611
2710
  query: (marketId: string, query: string) => Promise<SearchResult>;
2612
2711
  };
2613
2712
  files: {
2614
- uploadSingleFile: (input: SingleFileInput, token: string) => Promise<{
2713
+ uploadSingleFile: (input: Parameters<typeof uploadSingleFile>[0], token: string) => Promise<{
2615
2714
  message: string;
2616
2715
  data: Media;
2617
2716
  }>;
2618
- uploadMultipartFile: (input: FileInput | ChunkedInput, token: string) => Promise<{
2717
+ uploadMultipartFile: (input: Parameters<typeof uploadMultipartFile>[0], token: string) => Promise<{
2619
2718
  message: string;
2620
2719
  mediaType: string;
2621
2720
  process: VariantProcessingState;
@@ -2626,9 +2725,9 @@ declare function Studio(info?: {
2626
2725
  };
2627
2726
  contacts: {
2628
2727
  list: (marketId: string, customerId: string, params?: {
2629
- lastId?: string | undefined;
2630
- limit?: number | undefined;
2631
- } | undefined) => Promise<ListContactsResponse>;
2728
+ lastId?: string;
2729
+ limit?: number;
2730
+ }) => Promise<ListContactsResponse>;
2632
2731
  get: (marketId: string, customerId: string, contactId: string) => Promise<CustomerContact>;
2633
2732
  create: (marketId: string, customerId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
2634
2733
  update: (marketId: string, customerId: string, contactId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
@@ -2706,6 +2805,291 @@ declare function createAppManifest(appConfig: {
2706
2805
  readonly manifest: StudioManifest;
2707
2806
  };
2708
2807
 
2808
+ declare const MEDIA_CRATE_V2_BASE_URL_ENV_VARS: readonly ["MEDIA_CRATE_V2_BASE_URL", "NEXT_PUBLIC_MEDIA_CRATE_BASE_URL"];
2809
+ type MediaCrateProjectEnv = Record<string, string | undefined>;
2810
+ declare const MEDIA_CRATE_SINGLE_UPLOAD_MAX_BYTES: number;
2811
+ declare const MEDIA_CRATE_MULTIPART_MAX_CHUNK_BYTES: number;
2812
+ declare const MEDIA_CRATE_DEFAULT_CHUNK_BYTES: number;
2813
+ declare const MEDIA_CRATE_MEDIA_STATUSES: readonly ["uploading", "processing", "done", "error", "deleted", "partial", "expired", "indeterminate"];
2814
+ /** @deprecated Use MEDIA_CRATE_MEDIA_STATUSES. */
2815
+ declare const MEDIA_CRATE_ASSET_STATUSES: readonly ["uploading", "processing", "done", "error", "deleted", "partial", "expired", "indeterminate"];
2816
+ type MediaCrateUploadMode = "lot" | "transform" | "direct";
2817
+ type MediaCrateMediaMode = Exclude<MediaCrateUploadMode, "lot">;
2818
+ type MediaCrateMediaStatus = (typeof MEDIA_CRATE_MEDIA_STATUSES)[number];
2819
+ /** @deprecated Use MediaCrateUploadMode. */
2820
+ type MediaCrateAssetMode = MediaCrateUploadMode;
2821
+ /** @deprecated Use MediaCrateMediaStatus. */
2822
+ type MediaCrateAssetStatus = MediaCrateMediaStatus;
2823
+ type MediaCrateUploadStrategy = "auto" | "single" | "multipart";
2824
+ type MediaCrateExpectedVariant = {
2825
+ url: string;
2826
+ key: string;
2827
+ ready: boolean;
2828
+ };
2829
+ type MediaCrateExpectedUrls = {
2830
+ original: MediaCrateExpectedVariant;
2831
+ variants?: Record<string, MediaCrateExpectedVariant>;
2832
+ };
2833
+ type MediaCrateStatusUrls = MediaCrateExpectedUrls;
2834
+ type MediaCrateVariantSource = MediaCrateExpectedUrls | MediaCrateStatusUrls | {
2835
+ expected: MediaCrateExpectedUrls;
2836
+ } | {
2837
+ urls: MediaCrateStatusUrls;
2838
+ };
2839
+ type MediaCrateVariantSelectionOptions = {
2840
+ /** Only return the variant if Media Crate marks it as ready. */
2841
+ requireReady?: boolean;
2842
+ /** Fall back to the original URL when the named variant is absent. */
2843
+ fallbackToOriginal?: boolean;
2844
+ };
2845
+ declare function getMediaCrateVariant(source: MediaCrateVariantSource, variantName: string, opts?: MediaCrateVariantSelectionOptions): MediaCrateExpectedVariant | undefined;
2846
+ declare function getMediaCrateVariantUrl(source: MediaCrateVariantSource, variantName: string, opts?: MediaCrateVariantSelectionOptions): string | undefined;
2847
+ declare function requireMediaCrateVariantUrl(source: MediaCrateVariantSource, variantName: string, opts?: MediaCrateVariantSelectionOptions): string;
2848
+ type MediaCrateUploadResult = {
2849
+ message?: string;
2850
+ assetId: string;
2851
+ statusUrl: string;
2852
+ status: MediaCrateMediaStatus;
2853
+ expected: MediaCrateExpectedUrls;
2854
+ retryAfterMs?: number;
2855
+ };
2856
+ type MediaCrateStatusResult = {
2857
+ assetId: string;
2858
+ marketId: string;
2859
+ mode: MediaCrateUploadMode;
2860
+ status: MediaCrateMediaStatus;
2861
+ urls: MediaCrateStatusUrls;
2862
+ error?: string;
2863
+ retryAfterMs?: number;
2864
+ attemptCount?: number;
2865
+ subStatus?: "queued-for-capacity";
2866
+ queuedSince?: string;
2867
+ };
2868
+ type MediaCrateDuplicateResult = MediaCrateUploadResult;
2869
+ type MediaCrateMultipartStartResult = {
2870
+ message: string;
2871
+ data: {
2872
+ parsedFilePath: string;
2873
+ uploadId: string;
2874
+ key: string;
2875
+ assetId: string;
2876
+ generation: number;
2877
+ status: "started";
2878
+ };
2879
+ };
2880
+ type MediaCrateMultipartChunkResult = {
2881
+ message: string;
2882
+ data: {
2883
+ partNumber: number;
2884
+ eTag?: string | null;
2885
+ };
2886
+ };
2887
+ type MediaCrateStandaloneMultipartStartResult = MediaCrateUploadResult & {
2888
+ uploadId: string;
2889
+ targetKey: string;
2890
+ };
2891
+ type MediaCrateStandaloneMultipartChunkResult = {
2892
+ partNumber: number;
2893
+ eTag?: string | null;
2894
+ };
2895
+ type MediaCrateErrorResponse = {
2896
+ message: string;
2897
+ collidingKeys?: string[];
2898
+ };
2899
+ type MediaCrateMultipartSection = {
2900
+ partNumber: string;
2901
+ eTag: string;
2902
+ };
2903
+ type MediaCrateUploadProgressPhase = "starting" | "resuming" | "uploading" | "retrying" | "finishing" | "uploaded" | "error";
2904
+ type MediaCrateUploadProgress = {
2905
+ phase: MediaCrateUploadProgressPhase;
2906
+ bytesUploaded: number;
2907
+ totalBytes: number;
2908
+ partNumber?: number;
2909
+ totalParts?: number;
2910
+ attempt?: number;
2911
+ uploadId?: string;
2912
+ };
2913
+ type ReactNativeFormDataFile = {
2914
+ uri: string;
2915
+ type?: string;
2916
+ name?: string;
2917
+ };
2918
+ type MediaCrateUploadPartBody = Blob | ArrayBuffer | Uint8Array | string | ReactNativeFormDataFile;
2919
+ type MediaCrateUploadPartRequest = {
2920
+ start: number;
2921
+ end: number;
2922
+ partNumber: number;
2923
+ };
2924
+ type MediaCrateUploadSource = {
2925
+ name: string;
2926
+ type?: string;
2927
+ size: number;
2928
+ lastModified?: number;
2929
+ fingerprint?: string;
2930
+ /**
2931
+ * Set this to false for adapters that can only upload through multipart
2932
+ * form-data, for example some React Native URI-backed sources.
2933
+ */
2934
+ canUseSingleUpload?: boolean;
2935
+ getPart: (request: MediaCrateUploadPartRequest) => Promise<MediaCrateUploadPartBody>;
2936
+ };
2937
+ type MediaCrateMultipartSession = {
2938
+ key: string;
2939
+ mode: MediaCrateUploadMode;
2940
+ path: string;
2941
+ marketId: string;
2942
+ uploadId: string;
2943
+ chunkSize: number;
2944
+ totalBytes: number;
2945
+ totalParts: number;
2946
+ sourceFingerprint: string;
2947
+ overwrite: boolean;
2948
+ sections: MediaCrateMultipartSection[];
2949
+ targetKey?: string;
2950
+ startResult?: MediaCrateUploadResult;
2951
+ createdAt: number;
2952
+ updatedAt: number;
2953
+ };
2954
+ type MediaCrateMultipartSessionStore = {
2955
+ get: (key: string) => Promise<MediaCrateMultipartSession | null>;
2956
+ set: (key: string, session: MediaCrateMultipartSession) => Promise<void>;
2957
+ delete: (key: string) => Promise<void>;
2958
+ };
2959
+ type MediaCrateClientOptions = {
2960
+ baseUrl?: string;
2961
+ marketId: string;
2962
+ getFirebaseToken: () => Promise<string>;
2963
+ fetchImpl?: typeof fetch;
2964
+ sessionStore?: MediaCrateMultipartSessionStore;
2965
+ chunkSizeBytes?: number;
2966
+ maxPartAttempts?: number;
2967
+ maxFinishAttempts?: number;
2968
+ retryBaseDelayMs?: number;
2969
+ maxConcurrentParts?: number;
2970
+ defaultUploadStrategy?: MediaCrateUploadStrategy;
2971
+ sleep?: (durationMs: number) => Promise<void>;
2972
+ now?: () => number;
2973
+ random?: () => number;
2974
+ };
2975
+ type MediaCrateUploadOptions = {
2976
+ overwrite?: boolean;
2977
+ strategy?: MediaCrateUploadStrategy;
2978
+ chunkSizeBytes?: number;
2979
+ maxConcurrentParts?: number;
2980
+ sessionKey?: string;
2981
+ onProgress?: (progress: MediaCrateUploadProgress) => void;
2982
+ };
2983
+ type MediaCrateLotMediaUploadOptions = MediaCrateUploadOptions & {
2984
+ saleId: string;
2985
+ lotId: string;
2986
+ attributeId: string;
2987
+ source: MediaCrateUploadSource;
2988
+ fileName?: string;
2989
+ };
2990
+ type MediaCrateMediaUploadOptions = MediaCrateUploadOptions & {
2991
+ mode: MediaCrateMediaMode;
2992
+ path: string;
2993
+ source: MediaCrateUploadSource;
2994
+ };
2995
+ type MediaCrateDeleteOptions = {
2996
+ fileUrl: string;
2997
+ };
2998
+ type MediaCrateDuplicateOptions = {
2999
+ sourceUrl: string;
3000
+ targetFilePath: string;
3001
+ targetFileName?: string;
3002
+ overwrite?: boolean;
3003
+ };
3004
+ type ParsedErrorBody = Partial<MediaCrateErrorResponse> & {
3005
+ [key: string]: unknown;
3006
+ };
3007
+ declare class MediaCrateHttpError extends Error {
3008
+ status: number;
3009
+ method: string;
3010
+ url: string;
3011
+ body: ParsedErrorBody | string | null;
3012
+ collidingKeys?: string[];
3013
+ constructor(args: {
3014
+ status: number;
3015
+ method: string;
3016
+ url: string;
3017
+ message: string;
3018
+ body: ParsedErrorBody | string | null;
3019
+ collidingKeys?: string[];
3020
+ });
3021
+ }
3022
+ declare class MediaCrateUploadSourceError extends Error {
3023
+ constructor(message: string);
3024
+ }
3025
+ declare class InMemoryMediaCrateMultipartSessionStore implements MediaCrateMultipartSessionStore {
3026
+ private sessions;
3027
+ get(key: string): Promise<MediaCrateMultipartSession | null>;
3028
+ set(key: string, session: MediaCrateMultipartSession): Promise<void>;
3029
+ delete(key: string): Promise<void>;
3030
+ }
3031
+ declare function createWebUploadSource(file: Blob, opts?: {
3032
+ name?: string;
3033
+ type?: string;
3034
+ lastModified?: number;
3035
+ fingerprint?: string;
3036
+ }): MediaCrateUploadSource;
3037
+ declare class MediaCrateClient {
3038
+ readonly baseUrl: string;
3039
+ readonly marketId: string;
3040
+ private getFirebaseToken;
3041
+ private fetchImpl;
3042
+ private sessionStore;
3043
+ private chunkSizeBytes;
3044
+ private maxPartAttempts;
3045
+ private maxFinishAttempts;
3046
+ private retryBaseDelayMs;
3047
+ private maxConcurrentParts;
3048
+ private defaultUploadStrategy;
3049
+ private sleep;
3050
+ private now;
3051
+ private random;
3052
+ constructor(opts: MediaCrateClientOptions);
3053
+ createMediaPath(...segments: string[]): string;
3054
+ createLotMediaPath(args: {
3055
+ saleId: string;
3056
+ lotId: string;
3057
+ attributeId: string;
3058
+ fileName: string;
3059
+ }): string;
3060
+ uploadLotMedia(opts: MediaCrateLotMediaUploadOptions): Promise<MediaCrateUploadResult>;
3061
+ uploadMedia(opts: MediaCrateMediaUploadOptions): Promise<MediaCrateUploadResult>;
3062
+ private upload;
3063
+ getStatus(statusUrl: string): Promise<MediaCrateStatusResult>;
3064
+ delete(opts: MediaCrateDeleteOptions): Promise<void>;
3065
+ duplicate(opts: MediaCrateDuplicateOptions): Promise<MediaCrateDuplicateResult>;
3066
+ cancelMultipartUpload(args: {
3067
+ mode: MediaCrateUploadMode;
3068
+ path: string;
3069
+ uploadId: string;
3070
+ fileName?: string;
3071
+ sessionKey?: string;
3072
+ }): Promise<void>;
3073
+ private resolveUploadStrategy;
3074
+ private uploadSingle;
3075
+ private uploadMultipart;
3076
+ private getOrStartMultipartSession;
3077
+ private startMultipartUpload;
3078
+ private uploadPartWithRetry;
3079
+ private uploadMultipartPart;
3080
+ private finishMultipartUploadWithRetry;
3081
+ private finishMultipartUpload;
3082
+ private cancelDirectMultipartUpload;
3083
+ private cancelProcessedMultipartUpload;
3084
+ private runWithRetry;
3085
+ private getRetryDelay;
3086
+ private createBaseHeaders;
3087
+ private createUploadHeaders;
3088
+ private assertPathMatchesMarket;
3089
+ private urlFor;
3090
+ }
3091
+ declare function getMediaCrateBaseUrlFromEnv(env?: MediaCrateProjectEnv): string;
3092
+
2709
3093
  type CountryCode = keyof typeof EarTag.countryCodes;
2710
3094
  declare class EarTag {
2711
3095
  static regexISO24631: RegExp;
@@ -2800,4 +3184,5 @@ declare function sortByLotNumber<T extends {
2800
3184
  */
2801
3185
  declare function nextLotNumber(previousLotNumber: string): string;
2802
3186
 
2803
- export { CattlePassport, type ChunkedFile, type CreateCustomerListPayload, type CreateCustomerPayload, type CustomerList, type CustomerListAddMembersResponse, type CustomerListDeleteResponse, type CustomerListFilterGroup, type CustomerListFilters, type CustomerListMember, type CustomerListMembersOptions, type CustomerListMembersResponse, type CustomerListPreviewResponse, type CustomerListProductCodesResponse, type CustomerListQuery, type CustomerListRefreshResponse, type CustomerListRemoveMemberResponse, type CustomerListReportRow, type CustomerListReportSummary, type CustomerListRole, type CustomerListType, type CustomerListViewOptions, type CustomerListViewResult, type CustomerListsListOptions, type CustomerListsListResponse, EarTag, type FarmAssuranceUpdate, type KeeperDetailsUpdate, type RollingDateConfig, Studio, StudioHeaders, type StudioInstance, type StudioManifest, types as StudioTypes, type UpdateCustomerListPayload, type UpdateCustomerPayload, createAppManifest, Studio as default, lotComparator, nextLotNumber, sortByLotNumber };
3187
+ export { CattlePassport, EarTag, InMemoryMediaCrateMultipartSessionStore, MEDIA_CRATE_ASSET_STATUSES, MEDIA_CRATE_DEFAULT_CHUNK_BYTES, MEDIA_CRATE_MEDIA_STATUSES, MEDIA_CRATE_MULTIPART_MAX_CHUNK_BYTES, MEDIA_CRATE_SINGLE_UPLOAD_MAX_BYTES, MEDIA_CRATE_V2_BASE_URL_ENV_VARS, MediaCrateClient, MediaCrateHttpError, MediaCrateUploadSourceError, Studio, StudioHeaders, types as StudioTypes, createAppManifest, createWebUploadSource, Studio as default, getMediaCrateBaseUrlFromEnv, getMediaCrateVariant, getMediaCrateVariantUrl, lotComparator, nextLotNumber, requireMediaCrateVariantUrl, sortByLotNumber };
3188
+ export type { ChunkedFile, CreateCustomerListPayload, CreateCustomerPayload, CustomerList, CustomerListAddMembersResponse, CustomerListDeleteResponse, CustomerListFilterGroup, CustomerListFilters, CustomerListMember, CustomerListMembersOptions, CustomerListMembersResponse, CustomerListPreviewResponse, CustomerListProductCodesResponse, CustomerListQuery, CustomerListRefreshResponse, CustomerListRemoveMemberResponse, CustomerListReportRow, CustomerListReportSummary, CustomerListRole, CustomerListType, CustomerListViewOptions, CustomerListViewResult, CustomerListsListOptions, CustomerListsListResponse, FarmAssuranceUpdate, KeeperDetailsUpdate, MediaCrateAssetMode, MediaCrateAssetStatus, MediaCrateClientOptions, MediaCrateDeleteOptions, MediaCrateDuplicateOptions, MediaCrateDuplicateResult, MediaCrateErrorResponse, MediaCrateExpectedUrls, MediaCrateExpectedVariant, MediaCrateLotMediaUploadOptions, MediaCrateMediaMode, MediaCrateMediaStatus, MediaCrateMediaUploadOptions, MediaCrateMultipartChunkResult, MediaCrateMultipartSection, MediaCrateMultipartSession, MediaCrateMultipartSessionStore, MediaCrateMultipartStartResult, MediaCrateProjectEnv, MediaCrateStandaloneMultipartChunkResult, MediaCrateStandaloneMultipartStartResult, MediaCrateStatusResult, MediaCrateStatusUrls, MediaCrateUploadMode, MediaCrateUploadOptions, MediaCrateUploadPartBody, MediaCrateUploadPartRequest, MediaCrateUploadProgress, MediaCrateUploadProgressPhase, MediaCrateUploadResult, MediaCrateUploadSource, MediaCrateUploadStrategy, MediaCrateVariantSelectionOptions, MediaCrateVariantSource, ReactNativeFormDataFile, RollingDateConfig, StudioInstance, StudioManifest, UpdateCustomerListPayload, UpdateCustomerPayload };