@marteye/studiojs 1.1.46 → 1.1.47-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 +558 -265
- package/dist/index.esm.js +665 -50
- package/dist/index.js +665 -50
- package/dist/net/http.d.ts +3 -3
- package/dist/resources/actions.d.ts +1 -0
- package/dist/resources/customerLists.d.ts +214 -0
- package/dist/resources/lots.d.ts +4 -1
- package/dist/resources/sales.d.ts +1 -0
- package/dist/resources/sms.d.ts +7 -0
- package/dist/resources/webhooks.d.ts +1 -0
- package/dist/resources.d.ts +142 -116
- package/dist/studio.d.ts +142 -116
- package/dist/types.d.ts +68 -3
- package/package.json +1 -1
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: <
|
|
6
|
-
patch: <
|
|
7
|
-
delete: <
|
|
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>;
|
|
8
8
|
};
|
|
9
9
|
type HttpClient = ReturnType<typeof SimpleHttpClient>;
|
|
10
10
|
|
|
@@ -290,6 +290,7 @@ interface MartEyeLiveSaleSettings {
|
|
|
290
290
|
labels?: string[];
|
|
291
291
|
tags?: string[];
|
|
292
292
|
queueLots?: boolean;
|
|
293
|
+
markSubjectLotsAsSold?: boolean;
|
|
293
294
|
}
|
|
294
295
|
interface MartEyeTimedSaleSettings {
|
|
295
296
|
description?: string;
|
|
@@ -342,6 +343,35 @@ interface SaleFromSearch extends Omit<Omit<Omit<Sale, "createdAt">, "updatedAt">
|
|
|
342
343
|
startsAt: number;
|
|
343
344
|
}
|
|
344
345
|
type LotSaleStatus = "Sold" | "Unsold" | "Rerun" | "Resold" | null;
|
|
346
|
+
type LotDeleteDecision = "allow" | "confirm" | "block";
|
|
347
|
+
type LotDeleteReason = "local_only" | "not_started" | "started" | "started_with_bids" | "finished" | "studio_locked" | "not_found" | "sync_unavailable" | "link_unresolved";
|
|
348
|
+
interface LotDeletePreflightItem {
|
|
349
|
+
lotId: string;
|
|
350
|
+
lotNumber: string | null;
|
|
351
|
+
decision: LotDeleteDecision;
|
|
352
|
+
reason: LotDeleteReason;
|
|
353
|
+
isMartEyeEnabled: boolean;
|
|
354
|
+
saleType: "LIVE" | "TIMED" | null;
|
|
355
|
+
started: boolean;
|
|
356
|
+
finished: boolean;
|
|
357
|
+
hasBids: boolean;
|
|
358
|
+
bidCount: number;
|
|
359
|
+
startAt: string | null;
|
|
360
|
+
endAt: string | null;
|
|
361
|
+
}
|
|
362
|
+
interface LotDeletePreflightResponse {
|
|
363
|
+
version: 1;
|
|
364
|
+
saleId: string;
|
|
365
|
+
lotId: string;
|
|
366
|
+
result: LotDeletePreflightItem;
|
|
367
|
+
}
|
|
368
|
+
interface DeleteLotsResponse {
|
|
369
|
+
version: 1;
|
|
370
|
+
saleId: string;
|
|
371
|
+
status: "deleted" | "blocked" | "confirmation_required";
|
|
372
|
+
deletedLotIds: string[];
|
|
373
|
+
results: LotDeletePreflightItem[];
|
|
374
|
+
}
|
|
345
375
|
interface Lot {
|
|
346
376
|
id: string;
|
|
347
377
|
saleId: string;
|
|
@@ -1103,9 +1133,9 @@ interface TablePosition {
|
|
|
1103
1133
|
cellWidth: number;
|
|
1104
1134
|
halign: "left" | "center" | "right";
|
|
1105
1135
|
}
|
|
1106
|
-
type WebhookEventName = "market.updated" | "sale.created" | "sale.updated" | "sale.deleted" | "lot.created" | "lot.updated" | "lot.deleted" | "lot.media.created" | "lot.media.deleted" | "invoice.created" | "invoice.updated" | "invoice.deleted" | "payment.created" | "payment.updated" | "payment.deleted" | "payout.created" | "payout.updated" | "payout.deleted" | "customer.created" | "customer.updated" | "customer.deleted" | "member.created" | "member.updated" | "member.deleted";
|
|
1107
|
-
declare const supportedWebhookEvents: readonly ["market.updated", "sale.created", "sale.updated", "sale.deleted", "lot.created", "lot.updated", "lot.deleted", "lot.media.created", "lot.media.deleted", "invoice.created", "invoice.updated", "invoice.deleted", "payment.created", "payment.updated", "payment.deleted", "payout.created", "payout.updated", "payout.deleted", "customer.created", "customer.updated", "customer.deleted", "member.created", "member.updated", "member.deleted"];
|
|
1108
|
-
type ObjectType = "market" | "sale" | "lot" | "invoice" | "payment" | "customer" | "member";
|
|
1136
|
+
type WebhookEventName = "market.updated" | "sale.created" | "sale.updated" | "sale.deleted" | "lot.created" | "lot.updated" | "lot.deleted" | "lot.media.created" | "lot.media.deleted" | "invoice.created" | "invoice.updated" | "invoice.deleted" | "payment.created" | "payment.updated" | "payment.deleted" | "payout.created" | "payout.updated" | "payout.deleted" | "customer.created" | "customer.updated" | "customer.deleted" | "member.created" | "member.updated" | "member.deleted" | "sms-task.created" | "sms-task.updated" | "sms-task.deleted";
|
|
1137
|
+
declare const supportedWebhookEvents: readonly ["market.updated", "sale.created", "sale.updated", "sale.deleted", "lot.created", "lot.updated", "lot.deleted", "lot.media.created", "lot.media.deleted", "invoice.created", "invoice.updated", "invoice.deleted", "payment.created", "payment.updated", "payment.deleted", "payout.created", "payout.updated", "payout.deleted", "customer.created", "customer.updated", "customer.deleted", "member.created", "member.updated", "member.deleted", "sms-task.created", "sms-task.updated", "sms-task.deleted"];
|
|
1138
|
+
type ObjectType = "market" | "sale" | "lot" | "invoice" | "payment" | "customer" | "member" | "sms-task";
|
|
1109
1139
|
interface WebhookEvent<T> {
|
|
1110
1140
|
id: string;
|
|
1111
1141
|
createdAt: Timestamp;
|
|
@@ -1212,6 +1242,41 @@ interface ActivityLog {
|
|
|
1212
1242
|
[fieldPath: string]: ActivityChange;
|
|
1213
1243
|
};
|
|
1214
1244
|
}
|
|
1245
|
+
interface SendSMSPayload {
|
|
1246
|
+
to: string[];
|
|
1247
|
+
message: string;
|
|
1248
|
+
customerId?: string;
|
|
1249
|
+
reference?: string;
|
|
1250
|
+
senderName?: string;
|
|
1251
|
+
}
|
|
1252
|
+
interface SMSTask {
|
|
1253
|
+
id: string;
|
|
1254
|
+
marketId: string;
|
|
1255
|
+
to: string[];
|
|
1256
|
+
message: string;
|
|
1257
|
+
customerId?: string;
|
|
1258
|
+
reference?: string;
|
|
1259
|
+
senderName?: string;
|
|
1260
|
+
metadata?: Record<string, any>;
|
|
1261
|
+
status: "pending" | "sent" | "delivered" | "failed" | "partial";
|
|
1262
|
+
errorCode?: string;
|
|
1263
|
+
errorMessage?: string;
|
|
1264
|
+
providerMessageIds?: string[];
|
|
1265
|
+
providerName?: string;
|
|
1266
|
+
createdAt: Timestamp;
|
|
1267
|
+
updatedAt: Timestamp;
|
|
1268
|
+
sentAt?: Timestamp;
|
|
1269
|
+
deliveredAt?: Timestamp;
|
|
1270
|
+
recipientStatus?: {
|
|
1271
|
+
[phoneNumber: string]: {
|
|
1272
|
+
status: "pending" | "sent" | "delivered" | "failed";
|
|
1273
|
+
providerMessageId?: string;
|
|
1274
|
+
errorCode?: string;
|
|
1275
|
+
errorMessage?: string;
|
|
1276
|
+
timestamp: Timestamp;
|
|
1277
|
+
};
|
|
1278
|
+
};
|
|
1279
|
+
}
|
|
1215
1280
|
|
|
1216
1281
|
type types_Accessory = Accessory;
|
|
1217
1282
|
type types_ActivityChange = ActivityChange;
|
|
@@ -1238,6 +1303,7 @@ type types_Customer = Customer;
|
|
|
1238
1303
|
type types_CustomerBankDetails = CustomerBankDetails;
|
|
1239
1304
|
type types_CustomerContact = CustomerContact;
|
|
1240
1305
|
type types_CustomerFromSearch = CustomerFromSearch;
|
|
1306
|
+
type types_DeleteLotsResponse = DeleteLotsResponse;
|
|
1241
1307
|
type types_DeviceType = DeviceType;
|
|
1242
1308
|
type types_DisplayBoardMode = DisplayBoardMode;
|
|
1243
1309
|
type types_DraftInvoice = DraftInvoice;
|
|
@@ -1257,6 +1323,10 @@ type types_InvoiceTotals = InvoiceTotals;
|
|
|
1257
1323
|
type types_LineItemAdjustmentConfiguration = LineItemAdjustmentConfiguration;
|
|
1258
1324
|
declare const types_LivestockSuperTypes: typeof LivestockSuperTypes;
|
|
1259
1325
|
type types_Lot = Lot;
|
|
1326
|
+
type types_LotDeleteDecision = LotDeleteDecision;
|
|
1327
|
+
type types_LotDeletePreflightItem = LotDeletePreflightItem;
|
|
1328
|
+
type types_LotDeletePreflightResponse = LotDeletePreflightResponse;
|
|
1329
|
+
type types_LotDeleteReason = LotDeleteReason;
|
|
1260
1330
|
type types_LotGeneratedValues = LotGeneratedValues;
|
|
1261
1331
|
type types_LotIssue = LotIssue;
|
|
1262
1332
|
type types_LotItem = LotItem;
|
|
@@ -1280,10 +1350,12 @@ type types_Product = Product;
|
|
|
1280
1350
|
type types_ProductCodeConfiguration = ProductCodeConfiguration;
|
|
1281
1351
|
type types_ProductConfiguration = ProductConfiguration;
|
|
1282
1352
|
type types_ReadOptions = ReadOptions;
|
|
1353
|
+
type types_SMSTask = SMSTask;
|
|
1283
1354
|
type types_Sale = Sale;
|
|
1284
1355
|
type types_SaleFromSearch = SaleFromSearch;
|
|
1285
1356
|
type types_SalePublishStatus = SalePublishStatus;
|
|
1286
1357
|
type types_SaleTemplate = SaleTemplate;
|
|
1358
|
+
type types_SendSMSPayload = SendSMSPayload;
|
|
1287
1359
|
type types_SettingsAccessories = SettingsAccessories;
|
|
1288
1360
|
type types_SettingsAdjustmentsConfiguration = SettingsAdjustmentsConfiguration;
|
|
1289
1361
|
type types_SettingsGlobalAttributes = SettingsGlobalAttributes;
|
|
@@ -1314,8 +1386,7 @@ type types_WebhookEvent<T> = WebhookEvent<T>;
|
|
|
1314
1386
|
type types_WebhookEventName = WebhookEventName;
|
|
1315
1387
|
declare const types_supportedWebhookEvents: typeof supportedWebhookEvents;
|
|
1316
1388
|
declare namespace types {
|
|
1317
|
-
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 };
|
|
1318
|
-
export type { types_Accessory as Accessory, 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_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_DeviceType as DeviceType, types_DisplayBoardMode as DisplayBoardMode, 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_InvoiceDeliveryPreference as InvoiceDeliveryPreference, 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_ReadOptions as ReadOptions, types_Sale as Sale, types_SaleFromSearch as SaleFromSearch, types_SalePublishStatus as SalePublishStatus, types_SaleTemplate as SaleTemplate, 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 };
|
|
1389
|
+
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_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_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_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_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 };
|
|
1319
1390
|
}
|
|
1320
1391
|
|
|
1321
1392
|
interface ListContactsResponse {
|
|
@@ -1351,16 +1422,6 @@ type VariantProcessingState = {
|
|
|
1351
1422
|
type: SupportedFileTypesNames;
|
|
1352
1423
|
}>>;
|
|
1353
1424
|
};
|
|
1354
|
-
/**
|
|
1355
|
-
|--------------------------------------------------
|
|
1356
|
-
| END OF MEDIA CRATE CODE
|
|
1357
|
-
|--------------------------------------------------
|
|
1358
|
-
*/
|
|
1359
|
-
type MediaFinishUploadResponse = {
|
|
1360
|
-
message: string;
|
|
1361
|
-
mediaType: string;
|
|
1362
|
-
process: VariantProcessingState;
|
|
1363
|
-
};
|
|
1364
1425
|
type MediaUploadOptions = {
|
|
1365
1426
|
marketId: string;
|
|
1366
1427
|
saleId: string;
|
|
@@ -1405,15 +1466,6 @@ type ChunkedInput = {
|
|
|
1405
1466
|
chunks: ChunkedFile[];
|
|
1406
1467
|
uploadConfig: MediaUploadOptions;
|
|
1407
1468
|
};
|
|
1408
|
-
/**
|
|
1409
|
-
* Handles the complete file upload process including chunking and progress tracking -
|
|
1410
|
-
* WEB: Pass in a file and we will chunk it and upload it in parallel
|
|
1411
|
-
* NATIVE: You need to chunk the file yourself.
|
|
1412
|
-
* @param {FileInput | ChunkedInput} input - Either {file, options} or {fileName, chunks, options}
|
|
1413
|
-
* @returns {Promise<MediaFinishUploadResponse>}
|
|
1414
|
-
* @throws {Error} When upload fails
|
|
1415
|
-
*/
|
|
1416
|
-
declare const uploadMultipartFile: (input: FileInput | ChunkedInput, token: string) => Promise<MediaFinishUploadResponse>;
|
|
1417
1469
|
type SingleFileInput = {
|
|
1418
1470
|
file?: File;
|
|
1419
1471
|
filePath?: never;
|
|
@@ -1423,10 +1475,6 @@ type SingleFileInput = {
|
|
|
1423
1475
|
file?: never;
|
|
1424
1476
|
uploadConfig: MediaUploadOptions;
|
|
1425
1477
|
};
|
|
1426
|
-
declare const uploadSingleFile: (input: SingleFileInput, token: string) => Promise<{
|
|
1427
|
-
message: string;
|
|
1428
|
-
data: Media;
|
|
1429
|
-
}>;
|
|
1430
1478
|
|
|
1431
1479
|
/**
|
|
1432
1480
|
* Search result interface based on the API implementation
|
|
@@ -1692,23 +1740,219 @@ interface ActivityListParams {
|
|
|
1692
1740
|
lastId?: string;
|
|
1693
1741
|
}
|
|
1694
1742
|
|
|
1743
|
+
type CustomerListType = "simple" | "smart";
|
|
1744
|
+
type CustomerListRole = "buyer" | "seller" | "both";
|
|
1745
|
+
interface GeoBounds {
|
|
1746
|
+
north: number;
|
|
1747
|
+
south: number;
|
|
1748
|
+
east: number;
|
|
1749
|
+
west: number;
|
|
1750
|
+
}
|
|
1751
|
+
interface RollingDateConfig {
|
|
1752
|
+
windowDays: number;
|
|
1753
|
+
originalStart: string;
|
|
1754
|
+
originalEnd: string;
|
|
1755
|
+
}
|
|
1756
|
+
interface CustomerListQuery {
|
|
1757
|
+
role: CustomerListRole;
|
|
1758
|
+
filter?: string;
|
|
1759
|
+
excludeFilters?: string[];
|
|
1760
|
+
bounds?: GeoBounds;
|
|
1761
|
+
rollingDateConfig?: RollingDateConfig;
|
|
1762
|
+
secondaryFilter?: {
|
|
1763
|
+
role: CustomerListRole;
|
|
1764
|
+
filter?: string;
|
|
1765
|
+
bounds?: GeoBounds;
|
|
1766
|
+
rollingDateConfig?: RollingDateConfig;
|
|
1767
|
+
};
|
|
1768
|
+
}
|
|
1769
|
+
interface CustomerList {
|
|
1770
|
+
id: string;
|
|
1771
|
+
marketId: string;
|
|
1772
|
+
name: string;
|
|
1773
|
+
slug: string;
|
|
1774
|
+
description?: string;
|
|
1775
|
+
type: CustomerListType;
|
|
1776
|
+
query?: CustomerListQuery;
|
|
1777
|
+
rollingDateConfig?: RollingDateConfig;
|
|
1778
|
+
excludedCustomerIds?: string[];
|
|
1779
|
+
memberCount: number;
|
|
1780
|
+
refreshStatus?: "idle" | "refreshing" | "failed";
|
|
1781
|
+
refreshError?: string;
|
|
1782
|
+
lastRefreshedAt?: string;
|
|
1783
|
+
lastRefreshDurationMs?: number;
|
|
1784
|
+
lastRefreshCostEstimate?: number;
|
|
1785
|
+
lastRollingDateRange?: {
|
|
1786
|
+
start: string;
|
|
1787
|
+
end: string;
|
|
1788
|
+
};
|
|
1789
|
+
createdAt: string;
|
|
1790
|
+
createdBy: string;
|
|
1791
|
+
updatedAt: string;
|
|
1792
|
+
updatedBy: string;
|
|
1793
|
+
}
|
|
1794
|
+
interface CustomerListMember {
|
|
1795
|
+
marketId: string;
|
|
1796
|
+
listId: string;
|
|
1797
|
+
customerId: string;
|
|
1798
|
+
dateAdded: string;
|
|
1799
|
+
addedBy: string;
|
|
1800
|
+
customerDisplayName?: string;
|
|
1801
|
+
customerAccountNumber?: string;
|
|
1802
|
+
email?: string;
|
|
1803
|
+
phoneNumber?: string;
|
|
1804
|
+
}
|
|
1805
|
+
interface CustomerListFilterGroup {
|
|
1806
|
+
role: CustomerListRole;
|
|
1807
|
+
dateStart?: string | null;
|
|
1808
|
+
dateEnd?: string | null;
|
|
1809
|
+
productCodes?: string[];
|
|
1810
|
+
geoBounds?: GeoBounds | null;
|
|
1811
|
+
rollingDateConfig?: RollingDateConfig;
|
|
1812
|
+
}
|
|
1813
|
+
interface CustomerListFilters {
|
|
1814
|
+
role?: CustomerListRole | null;
|
|
1815
|
+
dateStart?: string | null;
|
|
1816
|
+
dateEnd?: string | null;
|
|
1817
|
+
productCodes?: string[];
|
|
1818
|
+
excludeDateStart?: string | null;
|
|
1819
|
+
excludeDateEnd?: string | null;
|
|
1820
|
+
excludedProductCodes?: string[];
|
|
1821
|
+
geoBounds?: GeoBounds | null;
|
|
1822
|
+
boughtOnlineOnly?: boolean;
|
|
1823
|
+
cattleBreeds?: string[];
|
|
1824
|
+
sheepBreeds?: string[];
|
|
1825
|
+
rollingDateConfig?: RollingDateConfig;
|
|
1826
|
+
secondaryFilter?: CustomerListFilterGroup | null;
|
|
1827
|
+
}
|
|
1828
|
+
interface CustomerListReportRow {
|
|
1829
|
+
customerId: string;
|
|
1830
|
+
displayName?: string | null;
|
|
1831
|
+
accountNumber?: string | null;
|
|
1832
|
+
purchasedItemCount: number;
|
|
1833
|
+
totalPurchasedValueInCents: number;
|
|
1834
|
+
soldItemCount: number;
|
|
1835
|
+
totalSoldValueInCents: number;
|
|
1836
|
+
lastSaleDate?: string | null;
|
|
1837
|
+
lastPurchaseDate?: string | null;
|
|
1838
|
+
productCodesSold?: string[] | null;
|
|
1839
|
+
productCodesBought?: string[] | null;
|
|
1840
|
+
latitude?: number | null;
|
|
1841
|
+
longitude?: number | null;
|
|
1842
|
+
address1?: string | null;
|
|
1843
|
+
address2?: string | null;
|
|
1844
|
+
city?: string | null;
|
|
1845
|
+
province?: string | null;
|
|
1846
|
+
zip?: string | null;
|
|
1847
|
+
country?: string | null;
|
|
1848
|
+
email?: string | null;
|
|
1849
|
+
phoneNumber?: string | null;
|
|
1850
|
+
}
|
|
1851
|
+
interface CustomerListReportSummary {
|
|
1852
|
+
totalCustomers: number;
|
|
1853
|
+
totalSoldValueInCents: number;
|
|
1854
|
+
totalPurchasedValueInCents: number;
|
|
1855
|
+
customersWithLocation: number;
|
|
1856
|
+
uniqueProductCodes: string[];
|
|
1857
|
+
}
|
|
1858
|
+
type CustomerListViewResult = {
|
|
1859
|
+
mode: "simple";
|
|
1860
|
+
list: CustomerList;
|
|
1861
|
+
members: CustomerListMember[];
|
|
1862
|
+
total: number;
|
|
1863
|
+
} | {
|
|
1864
|
+
mode: "smart";
|
|
1865
|
+
list: CustomerList;
|
|
1866
|
+
effectiveFilters: CustomerListFilters;
|
|
1867
|
+
rows: CustomerListReportRow[];
|
|
1868
|
+
summary: CustomerListReportSummary;
|
|
1869
|
+
};
|
|
1870
|
+
interface CustomerListsListOptions {
|
|
1871
|
+
type?: CustomerListType;
|
|
1872
|
+
limit?: number;
|
|
1873
|
+
offset?: number;
|
|
1874
|
+
}
|
|
1875
|
+
interface CustomerListMembersOptions {
|
|
1876
|
+
limit?: number;
|
|
1877
|
+
offset?: number;
|
|
1878
|
+
includeArchived?: boolean;
|
|
1879
|
+
}
|
|
1880
|
+
interface CustomerListViewOptions {
|
|
1881
|
+
identifierType?: "auto" | "id" | "slug";
|
|
1882
|
+
limit?: number;
|
|
1883
|
+
offset?: number;
|
|
1884
|
+
allMembers?: boolean;
|
|
1885
|
+
refresh?: boolean;
|
|
1886
|
+
}
|
|
1887
|
+
interface CustomerListsListResponse {
|
|
1888
|
+
lists: CustomerList[];
|
|
1889
|
+
total: number;
|
|
1890
|
+
}
|
|
1891
|
+
interface CustomerListMembersResponse {
|
|
1892
|
+
members: CustomerListMember[];
|
|
1893
|
+
total: number;
|
|
1894
|
+
hasMore: boolean;
|
|
1895
|
+
}
|
|
1896
|
+
interface CustomerListPreviewResponse {
|
|
1897
|
+
rows: CustomerListReportRow[];
|
|
1898
|
+
summary: CustomerListReportSummary;
|
|
1899
|
+
}
|
|
1900
|
+
interface CustomerListProductCodesResponse {
|
|
1901
|
+
uniqueProductCodes: string[];
|
|
1902
|
+
}
|
|
1903
|
+
interface CustomerListAddMembersResponse {
|
|
1904
|
+
added: number;
|
|
1905
|
+
alreadyMembers: number;
|
|
1906
|
+
notFound: number;
|
|
1907
|
+
memberCount: number;
|
|
1908
|
+
}
|
|
1909
|
+
interface CustomerListRemoveMemberResponse {
|
|
1910
|
+
removed: boolean;
|
|
1911
|
+
memberCount: number;
|
|
1912
|
+
}
|
|
1913
|
+
interface CustomerListDeleteResponse {
|
|
1914
|
+
deleted: boolean;
|
|
1915
|
+
membersRemoved: number;
|
|
1916
|
+
}
|
|
1917
|
+
interface CustomerListRefreshResponse {
|
|
1918
|
+
refreshStatus: "refreshing";
|
|
1919
|
+
message: string;
|
|
1920
|
+
}
|
|
1921
|
+
type CreateCustomerListPayload = {
|
|
1922
|
+
name: string;
|
|
1923
|
+
description?: string;
|
|
1924
|
+
type: "simple";
|
|
1925
|
+
} | {
|
|
1926
|
+
name: string;
|
|
1927
|
+
description?: string;
|
|
1928
|
+
type: "smart";
|
|
1929
|
+
query?: CustomerListQuery;
|
|
1930
|
+
filters?: CustomerListFilters;
|
|
1931
|
+
};
|
|
1932
|
+
interface UpdateCustomerListPayload {
|
|
1933
|
+
name?: string;
|
|
1934
|
+
description?: string | null;
|
|
1935
|
+
query?: CustomerListQuery;
|
|
1936
|
+
filters?: Partial<CustomerListFilters>;
|
|
1937
|
+
}
|
|
1938
|
+
|
|
1695
1939
|
declare function resources(httpClient: HttpClient): {
|
|
1696
1940
|
activity: {
|
|
1697
|
-
list: (marketId: string, params?: ActivityListParams) => Promise<ActivityListResponse>;
|
|
1941
|
+
list: (marketId: string, params?: ActivityListParams | undefined) => Promise<ActivityListResponse>;
|
|
1698
1942
|
get: (marketId: string, activityId: string) => Promise<ActivityLog>;
|
|
1699
1943
|
};
|
|
1700
1944
|
markets: {
|
|
1701
|
-
get: (marketId: string, options?: ReadOptions) => Promise<Market>;
|
|
1945
|
+
get: (marketId: string, options?: ReadOptions | undefined) => Promise<Market>;
|
|
1702
1946
|
};
|
|
1703
1947
|
members: {
|
|
1704
|
-
list: (marketId: string, params?: MembersListParams) => Promise<MembersListResponse>;
|
|
1948
|
+
list: (marketId: string, params?: MembersListParams | undefined) => Promise<MembersListResponse>;
|
|
1705
1949
|
get: (marketId: string, memberId: string) => Promise<Member>;
|
|
1706
1950
|
};
|
|
1707
1951
|
sales: {
|
|
1708
|
-
get: (marketId: string, saleId: string, options?: ReadOptions) => Promise<Sale>;
|
|
1952
|
+
get: (marketId: string, saleId: string, options?: ReadOptions | undefined) => Promise<Sale>;
|
|
1709
1953
|
list: (marketId: string, opts: {
|
|
1710
|
-
start?: string;
|
|
1711
|
-
end?: string;
|
|
1954
|
+
start?: string | undefined;
|
|
1955
|
+
end?: string | undefined;
|
|
1712
1956
|
}) => Promise<{
|
|
1713
1957
|
start: string;
|
|
1714
1958
|
end: string;
|
|
@@ -1718,122 +1962,126 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1718
1962
|
name: string;
|
|
1719
1963
|
startsAt: string;
|
|
1720
1964
|
availableProductCodes: string[];
|
|
1721
|
-
recurring?:
|
|
1722
|
-
martEyeSaleType?: "LIVE" | "TIMED" | null;
|
|
1723
|
-
location?: string | null;
|
|
1724
|
-
description?: string | null;
|
|
1725
|
-
image?: string | null;
|
|
1726
|
-
cover?: string | null;
|
|
1727
|
-
templateId?: string | null;
|
|
1965
|
+
recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
|
|
1966
|
+
martEyeSaleType?: "LIVE" | "TIMED" | null | undefined;
|
|
1967
|
+
location?: string | null | undefined;
|
|
1968
|
+
description?: string | null | undefined;
|
|
1969
|
+
image?: string | null | undefined;
|
|
1970
|
+
cover?: string | null | undefined;
|
|
1971
|
+
templateId?: string | null | undefined;
|
|
1728
1972
|
attributeDefaults?: {
|
|
1729
1973
|
[attributekey: string]: string | number | boolean;
|
|
1730
|
-
};
|
|
1974
|
+
} | undefined;
|
|
1731
1975
|
}) => Promise<{
|
|
1732
1976
|
saleId: string;
|
|
1733
1977
|
}>;
|
|
1734
1978
|
update: (marketId: string, saleId: string, data: {
|
|
1735
|
-
name?: string;
|
|
1736
|
-
startsAt?: string;
|
|
1737
|
-
recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
|
|
1738
|
-
defaultProductCode?: string;
|
|
1739
|
-
attributeDefaults?: Record<string, any
|
|
1740
|
-
publishStatus?: SalePublishStatus;
|
|
1979
|
+
name?: string | undefined;
|
|
1980
|
+
startsAt?: string | undefined;
|
|
1981
|
+
recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
|
|
1982
|
+
defaultProductCode?: string | undefined;
|
|
1983
|
+
attributeDefaults?: Record<string, any> | undefined;
|
|
1984
|
+
publishStatus?: SalePublishStatus | undefined;
|
|
1741
1985
|
marteyeSettings?: {
|
|
1742
|
-
description?: string;
|
|
1743
|
-
image?: string;
|
|
1744
|
-
logo?: string;
|
|
1986
|
+
description?: string | undefined;
|
|
1987
|
+
image?: string | undefined;
|
|
1988
|
+
logo?: string | undefined;
|
|
1745
1989
|
type: "LIVE" | "TIMED";
|
|
1746
|
-
location?: string | null;
|
|
1747
|
-
descriptionLines?: string[];
|
|
1748
|
-
descriptionLink?: string;
|
|
1749
|
-
deposit?: number;
|
|
1750
|
-
hidePrices?: boolean;
|
|
1751
|
-
hideReplay?: boolean;
|
|
1752
|
-
labels?: string[];
|
|
1753
|
-
tags?: string[];
|
|
1754
|
-
details?:
|
|
1990
|
+
location?: string | null | undefined;
|
|
1991
|
+
descriptionLines?: string[] | undefined;
|
|
1992
|
+
descriptionLink?: string | undefined;
|
|
1993
|
+
deposit?: number | undefined;
|
|
1994
|
+
hidePrices?: boolean | undefined;
|
|
1995
|
+
hideReplay?: boolean | undefined;
|
|
1996
|
+
labels?: string[] | undefined;
|
|
1997
|
+
tags?: string[] | undefined;
|
|
1998
|
+
details?: {
|
|
1755
1999
|
markdownBase64: string;
|
|
1756
2000
|
title: string;
|
|
1757
|
-
}
|
|
1758
|
-
cover?: string;
|
|
1759
|
-
primaryColour?: string;
|
|
1760
|
-
secondaryColour?: string;
|
|
1761
|
-
foregroundColour?: string;
|
|
1762
|
-
extensionTime?: number;
|
|
1763
|
-
incrementLadder?:
|
|
2001
|
+
}[] | undefined;
|
|
2002
|
+
cover?: string | undefined;
|
|
2003
|
+
primaryColour?: string | undefined;
|
|
2004
|
+
secondaryColour?: string | undefined;
|
|
2005
|
+
foregroundColour?: string | undefined;
|
|
2006
|
+
extensionTime?: number | undefined;
|
|
2007
|
+
incrementLadder?: {
|
|
1764
2008
|
max: number;
|
|
1765
2009
|
increment: number;
|
|
1766
|
-
}
|
|
1767
|
-
hideNav?: boolean;
|
|
1768
|
-
signInOverrideLink?: string;
|
|
1769
|
-
published?: boolean;
|
|
1770
|
-
pin?: boolean;
|
|
1771
|
-
cascade?: boolean;
|
|
1772
|
-
reportEmail?: string;
|
|
1773
|
-
queueLots?: boolean;
|
|
1774
|
-
|
|
2010
|
+
}[] | undefined;
|
|
2011
|
+
hideNav?: boolean | undefined;
|
|
2012
|
+
signInOverrideLink?: string | undefined;
|
|
2013
|
+
published?: boolean | undefined;
|
|
2014
|
+
pin?: boolean | undefined;
|
|
2015
|
+
cascade?: boolean | undefined;
|
|
2016
|
+
reportEmail?: string | undefined;
|
|
2017
|
+
queueLots?: boolean | undefined;
|
|
2018
|
+
markSubjectLotsAsSold?: boolean | undefined;
|
|
2019
|
+
} | null | undefined;
|
|
1775
2020
|
}) => Promise<Sale>;
|
|
1776
2021
|
};
|
|
1777
2022
|
lots: {
|
|
1778
|
-
get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions) => Promise<Lot>;
|
|
2023
|
+
get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions | undefined) => Promise<Lot>;
|
|
1779
2024
|
list: (marketId: string, saleId: string, filters?: {
|
|
1780
|
-
group?: string;
|
|
1781
|
-
productCode?: string;
|
|
1782
|
-
saleStatus?: LotSaleStatus;
|
|
1783
|
-
sellerCustomerId?: string;
|
|
1784
|
-
buyerCustomerId?: string;
|
|
1785
|
-
}) => Promise<Lot[]>;
|
|
2025
|
+
group?: string | undefined;
|
|
2026
|
+
productCode?: string | undefined;
|
|
2027
|
+
saleStatus?: LotSaleStatus | undefined;
|
|
2028
|
+
sellerCustomerId?: string | undefined;
|
|
2029
|
+
buyerCustomerId?: string | undefined;
|
|
2030
|
+
} | undefined) => Promise<Lot[]>;
|
|
1786
2031
|
create: (marketId: string, saleId: string, data: {
|
|
1787
|
-
index?: number;
|
|
1788
|
-
lotNumber?: string;
|
|
1789
|
-
group?: string;
|
|
1790
|
-
productCode?: string;
|
|
1791
|
-
sellerCustomerId?: string;
|
|
1792
|
-
attributes?: Record<string, any
|
|
1793
|
-
metadata?: Record<string, any
|
|
1794
|
-
buyerCustomerId?: string;
|
|
1795
|
-
unitPriceInCents?: number;
|
|
1796
|
-
reservePriceInCents?: number;
|
|
1797
|
-
startingPriceInCents?: number;
|
|
1798
|
-
startAt?: string;
|
|
1799
|
-
endAt?: string;
|
|
1800
|
-
previousLotNumber?: string;
|
|
1801
|
-
saleStatus?: LotSaleStatus;
|
|
2032
|
+
index?: number | undefined;
|
|
2033
|
+
lotNumber?: string | undefined;
|
|
2034
|
+
group?: string | undefined;
|
|
2035
|
+
productCode?: string | undefined;
|
|
2036
|
+
sellerCustomerId?: string | undefined;
|
|
2037
|
+
attributes?: Record<string, any> | undefined;
|
|
2038
|
+
metadata?: Record<string, any> | undefined;
|
|
2039
|
+
buyerCustomerId?: string | undefined;
|
|
2040
|
+
unitPriceInCents?: number | undefined;
|
|
2041
|
+
reservePriceInCents?: number | undefined;
|
|
2042
|
+
startingPriceInCents?: number | undefined;
|
|
2043
|
+
startAt?: string | undefined;
|
|
2044
|
+
endAt?: string | undefined;
|
|
2045
|
+
previousLotNumber?: string | undefined;
|
|
2046
|
+
saleStatus?: LotSaleStatus | undefined;
|
|
1802
2047
|
}) => Promise<Lot>;
|
|
1803
2048
|
update: (marketId: string, saleId: string, lotId: string, data: {
|
|
1804
|
-
productCode?: string;
|
|
1805
|
-
attributes?: Record<string, any
|
|
1806
|
-
sellerCasual?: string | null;
|
|
1807
|
-
sellerCustomerId?: string | null;
|
|
1808
|
-
lotNumber?: string | null;
|
|
1809
|
-
remarks?: string;
|
|
1810
|
-
notes?: string;
|
|
1811
|
-
unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
|
|
1812
|
-
unitPriceInCents?: number;
|
|
1813
|
-
reservePriceInCents?: number;
|
|
1814
|
-
startingPriceInCents?: number;
|
|
1815
|
-
buyerCasual?: string | null;
|
|
1816
|
-
buyerCustomerId?: string | null;
|
|
1817
|
-
startAt?: string | null;
|
|
1818
|
-
endAt?: string | null;
|
|
1819
|
-
saleStatus?: LotSaleStatus;
|
|
1820
|
-
metadata?: Record<string, any
|
|
1821
|
-
inputAccessories?: Record<string, any
|
|
2049
|
+
productCode?: string | undefined;
|
|
2050
|
+
attributes?: Record<string, any> | undefined;
|
|
2051
|
+
sellerCasual?: string | null | undefined;
|
|
2052
|
+
sellerCustomerId?: string | null | undefined;
|
|
2053
|
+
lotNumber?: string | null | undefined;
|
|
2054
|
+
remarks?: string | undefined;
|
|
2055
|
+
notes?: string | undefined;
|
|
2056
|
+
unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
|
|
2057
|
+
unitPriceInCents?: number | undefined;
|
|
2058
|
+
reservePriceInCents?: number | undefined;
|
|
2059
|
+
startingPriceInCents?: number | undefined;
|
|
2060
|
+
buyerCasual?: string | null | undefined;
|
|
2061
|
+
buyerCustomerId?: string | null | undefined;
|
|
2062
|
+
startAt?: string | null | undefined;
|
|
2063
|
+
endAt?: string | null | undefined;
|
|
2064
|
+
saleStatus?: LotSaleStatus | undefined;
|
|
2065
|
+
metadata?: Record<string, any> | undefined;
|
|
2066
|
+
inputAccessories?: Record<string, any> | undefined;
|
|
1822
2067
|
}) => Promise<Lot>;
|
|
1823
2068
|
delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
|
|
2069
|
+
deletePreflight: (marketId: string, saleId: string, lotId: string) => Promise<LotDeletePreflightResponse>;
|
|
2070
|
+
deletePreflightBatch: (marketId: string, saleId: string, lotIds: string[]) => Promise<DeleteLotsResponse>;
|
|
2071
|
+
deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[] | undefined) => Promise<DeleteLotsResponse>;
|
|
1824
2072
|
};
|
|
1825
2073
|
lotitems: {
|
|
1826
2074
|
create: (marketId: string, saleId: string, lotId: string, data: {
|
|
1827
|
-
attributes?: Record<string, any
|
|
1828
|
-
notes?:
|
|
2075
|
+
attributes?: Record<string, any> | undefined;
|
|
2076
|
+
notes?: {
|
|
1829
2077
|
text: string;
|
|
1830
|
-
}
|
|
1831
|
-
metadata?: Record<string, any
|
|
2078
|
+
}[] | undefined;
|
|
2079
|
+
metadata?: Record<string, any> | undefined;
|
|
1832
2080
|
}) => Promise<LotItem>;
|
|
1833
2081
|
update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
|
|
1834
|
-
attributes?: Record<string, any
|
|
1835
|
-
index?: number;
|
|
1836
|
-
metadata?: Record<string, any
|
|
2082
|
+
attributes?: Record<string, any> | undefined;
|
|
2083
|
+
index?: number | undefined;
|
|
2084
|
+
metadata?: Record<string, any> | undefined;
|
|
1837
2085
|
}) => Promise<LotItem>;
|
|
1838
2086
|
delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
|
|
1839
2087
|
};
|
|
@@ -1846,27 +2094,27 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1846
2094
|
lookup: (marketId: string, cph: string) => Promise<CphLookupResponse>;
|
|
1847
2095
|
};
|
|
1848
2096
|
webhooks: {
|
|
1849
|
-
constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string |
|
|
2097
|
+
constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<WebhookEvent<T>>;
|
|
1850
2098
|
};
|
|
1851
2099
|
actions: {
|
|
1852
2100
|
constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
|
|
1853
2101
|
};
|
|
1854
2102
|
bidderApplications: {
|
|
1855
|
-
list: (marketId: string, options?: ListApplicationsOptions) => Promise<ListApplicationsResponse>;
|
|
2103
|
+
list: (marketId: string, options?: ListApplicationsOptions | undefined) => Promise<ListApplicationsResponse>;
|
|
1856
2104
|
get: (marketId: string, applicationId: string) => Promise<Application>;
|
|
1857
2105
|
create: (marketId: string, applicationData: CreateApplicationPayload) => Promise<Application>;
|
|
1858
2106
|
update: (marketId: string, applicationId: string, updateData: UpdateApplicationPayload) => Promise<Application>;
|
|
1859
|
-
approve: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
|
|
1860
|
-
reject: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
|
|
2107
|
+
approve: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
|
|
2108
|
+
reject: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
|
|
1861
2109
|
unlink: (marketId: string, applicationId: string) => Promise<Application>;
|
|
1862
2110
|
delete: (marketId: string, applicationId: string) => Promise<void>;
|
|
1863
2111
|
};
|
|
1864
2112
|
settings: {
|
|
1865
|
-
get: (marketId: string, options?: ReadOptions) => Promise<SettingsMarketDefaults>;
|
|
2113
|
+
get: (marketId: string, options?: ReadOptions | undefined) => Promise<SettingsMarketDefaults>;
|
|
1866
2114
|
};
|
|
1867
2115
|
adjustments: {
|
|
1868
2116
|
list: (marketId: string) => Promise<AdjustmentsConfiguration[]>;
|
|
1869
|
-
get: (marketId: string, id: string, options?: ReadOptions) => Promise<AdjustmentsConfiguration>;
|
|
2117
|
+
get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<AdjustmentsConfiguration>;
|
|
1870
2118
|
create: (marketId: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
|
|
1871
2119
|
update: (marketId: string, id: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
|
|
1872
2120
|
};
|
|
@@ -1878,7 +2126,7 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1878
2126
|
};
|
|
1879
2127
|
productCodes: {
|
|
1880
2128
|
list: (marketId: string) => Promise<ProductCodeConfiguration[]>;
|
|
1881
|
-
get: (marketId: string, id: string, options?: ReadOptions) => Promise<ProductCodeConfiguration>;
|
|
2129
|
+
get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<ProductCodeConfiguration>;
|
|
1882
2130
|
create: (marketId: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
|
|
1883
2131
|
update: (marketId: string, id: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
|
|
1884
2132
|
};
|
|
@@ -1892,13 +2140,13 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1892
2140
|
create: (marketId: string, body: {
|
|
1893
2141
|
saleId: string;
|
|
1894
2142
|
name: string;
|
|
1895
|
-
description?: string | null;
|
|
2143
|
+
description?: string | null | undefined;
|
|
1896
2144
|
}) => Promise<{
|
|
1897
2145
|
templateId: string;
|
|
1898
2146
|
}>;
|
|
1899
2147
|
update: (marketId: string, templateId: string, body: {
|
|
1900
|
-
name?: string;
|
|
1901
|
-
description?: string | null;
|
|
2148
|
+
name?: string | undefined;
|
|
2149
|
+
description?: string | null | undefined;
|
|
1902
2150
|
}) => Promise<{
|
|
1903
2151
|
template: SaleTemplate;
|
|
1904
2152
|
}>;
|
|
@@ -1911,24 +2159,41 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1911
2159
|
get: (marketId: string, id: string) => Promise<TaxRate>;
|
|
1912
2160
|
};
|
|
1913
2161
|
customers: {
|
|
1914
|
-
list: (marketId: string, lastId?: string | null) => Promise<CustomersListResponse>;
|
|
1915
|
-
get: (marketId: string, customerId: string, options?: ReadOptions) => Promise<Customer>;
|
|
2162
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<CustomersListResponse>;
|
|
2163
|
+
get: (marketId: string, customerId: string, options?: ReadOptions | undefined) => Promise<Customer>;
|
|
1916
2164
|
avatar: (marketId: string, customerId: string) => Promise<Customer>;
|
|
1917
2165
|
create: (marketId: string, customerData: CreateCustomerPayload) => Promise<Customer>;
|
|
1918
2166
|
update: (marketId: string, customerId: string, customerData: UpdateCustomerPayload) => Promise<Customer>;
|
|
1919
2167
|
getByAccountNumber: (marketId: string, accountNumber: string) => Promise<Customer | null>;
|
|
1920
2168
|
getByMartEyeUid: (marketId: string, marteyeUid: string) => Promise<Customer | null>;
|
|
1921
2169
|
};
|
|
2170
|
+
customerLists: {
|
|
2171
|
+
list: (marketId: string, options?: CustomerListsListOptions | undefined) => Promise<CustomerListsListResponse>;
|
|
2172
|
+
listAll: (marketId: string, options?: Omit<CustomerListsListOptions, "offset"> | undefined) => Promise<CustomerList[]>;
|
|
2173
|
+
get: (marketId: string, listId: string) => Promise<CustomerList>;
|
|
2174
|
+
getBySlug: (marketId: string, slug: string) => Promise<CustomerList>;
|
|
2175
|
+
create: (marketId: string, payload: CreateCustomerListPayload) => Promise<CustomerList>;
|
|
2176
|
+
update: (marketId: string, listId: string, payload: UpdateCustomerListPayload) => Promise<CustomerList>;
|
|
2177
|
+
delete: (marketId: string, listId: string) => Promise<CustomerListDeleteResponse>;
|
|
2178
|
+
refresh: (marketId: string, listId: string) => Promise<CustomerListRefreshResponse>;
|
|
2179
|
+
getMembers: (marketId: string, listId: string, options?: CustomerListMembersOptions | undefined) => Promise<CustomerListMembersResponse>;
|
|
2180
|
+
getAllMembers: (marketId: string, listId: string, options?: Omit<CustomerListMembersOptions, "offset"> | undefined) => Promise<CustomerListMember[]>;
|
|
2181
|
+
addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<CustomerListAddMembersResponse>;
|
|
2182
|
+
removeMember: (marketId: string, listId: string, customerId: string) => Promise<CustomerListRemoveMemberResponse>;
|
|
2183
|
+
preview: (marketId: string, filters: CustomerListFilters) => Promise<CustomerListPreviewResponse>;
|
|
2184
|
+
listProductCodes: (marketId: string) => Promise<CustomerListProductCodesResponse>;
|
|
2185
|
+
view: (marketId: string, listIdOrSlug: string, options?: CustomerListViewOptions | undefined) => Promise<CustomerListViewResult>;
|
|
2186
|
+
};
|
|
1922
2187
|
invoices: {
|
|
1923
|
-
list: (marketId: string, lastId?: string | null) => Promise<InvoicesListResponse>;
|
|
1924
|
-
get: (marketId: string, invoiceId: string, options?: ReadOptions) => Promise<Invoice>;
|
|
2188
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<InvoicesListResponse>;
|
|
2189
|
+
get: (marketId: string, invoiceId: string, options?: ReadOptions | undefined) => Promise<Invoice>;
|
|
1925
2190
|
};
|
|
1926
2191
|
payments: {
|
|
1927
|
-
list: (marketId: string, lastId?: string | null) => Promise<PaymentsListResponse>;
|
|
2192
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<PaymentsListResponse>;
|
|
1928
2193
|
get: (marketId: string, paymentId: string) => Promise<Payment>;
|
|
1929
2194
|
};
|
|
1930
2195
|
payouts: {
|
|
1931
|
-
list: (marketId: string, lastId?: string | null) => Promise<PayoutsListResponse>;
|
|
2196
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<PayoutsListResponse>;
|
|
1932
2197
|
get: (marketId: string, payoutId: string) => Promise<Payout>;
|
|
1933
2198
|
create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
|
|
1934
2199
|
};
|
|
@@ -1936,11 +2201,11 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1936
2201
|
query: (marketId: string, query: string) => Promise<SearchResult>;
|
|
1937
2202
|
};
|
|
1938
2203
|
files: {
|
|
1939
|
-
uploadSingleFile: (input:
|
|
2204
|
+
uploadSingleFile: (input: SingleFileInput, token: string) => Promise<{
|
|
1940
2205
|
message: string;
|
|
1941
2206
|
data: Media;
|
|
1942
2207
|
}>;
|
|
1943
|
-
uploadMultipartFile: (input:
|
|
2208
|
+
uploadMultipartFile: (input: FileInput | ChunkedInput, token: string) => Promise<{
|
|
1944
2209
|
message: string;
|
|
1945
2210
|
mediaType: string;
|
|
1946
2211
|
process: VariantProcessingState;
|
|
@@ -1951,9 +2216,9 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1951
2216
|
};
|
|
1952
2217
|
contacts: {
|
|
1953
2218
|
list: (marketId: string, customerId: string, params?: {
|
|
1954
|
-
lastId?: string;
|
|
1955
|
-
limit?: number;
|
|
1956
|
-
}) => Promise<ListContactsResponse>;
|
|
2219
|
+
lastId?: string | undefined;
|
|
2220
|
+
limit?: number | undefined;
|
|
2221
|
+
} | undefined) => Promise<ListContactsResponse>;
|
|
1957
2222
|
get: (marketId: string, customerId: string, contactId: string) => Promise<CustomerContact>;
|
|
1958
2223
|
create: (marketId: string, customerId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
|
|
1959
2224
|
update: (marketId: string, customerId: string, contactId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
|
|
@@ -1965,6 +2230,10 @@ declare function resources(httpClient: HttpClient): {
|
|
|
1965
2230
|
getLatestTransaction: (marketId: string, account: string) => Promise<LedgerTransaction>;
|
|
1966
2231
|
listTransactions: (marketId: string, params: ListTransactionsParams) => Promise<TransactionsListResponse>;
|
|
1967
2232
|
};
|
|
2233
|
+
sms: {
|
|
2234
|
+
sendSMS: (marketId: string, data: SendSMSPayload) => Promise<SMSTask>;
|
|
2235
|
+
getSMS: (marketId: string, smsId: string) => Promise<SMSTask>;
|
|
2236
|
+
};
|
|
1968
2237
|
};
|
|
1969
2238
|
|
|
1970
2239
|
type StudioInstance = ReturnType<typeof resources> & {
|
|
@@ -1978,21 +2247,21 @@ declare function Studio(info?: {
|
|
|
1978
2247
|
}): {
|
|
1979
2248
|
isDebugMode: boolean;
|
|
1980
2249
|
activity: {
|
|
1981
|
-
list: (marketId: string, params?: ActivityListParams) => Promise<ActivityListResponse>;
|
|
2250
|
+
list: (marketId: string, params?: ActivityListParams | undefined) => Promise<ActivityListResponse>;
|
|
1982
2251
|
get: (marketId: string, activityId: string) => Promise<ActivityLog>;
|
|
1983
2252
|
};
|
|
1984
2253
|
markets: {
|
|
1985
|
-
get: (marketId: string, options?: ReadOptions) => Promise<Market>;
|
|
2254
|
+
get: (marketId: string, options?: ReadOptions | undefined) => Promise<Market>;
|
|
1986
2255
|
};
|
|
1987
2256
|
members: {
|
|
1988
|
-
list: (marketId: string, params?: MembersListParams) => Promise<MembersListResponse>;
|
|
2257
|
+
list: (marketId: string, params?: MembersListParams | undefined) => Promise<MembersListResponse>;
|
|
1989
2258
|
get: (marketId: string, memberId: string) => Promise<Member>;
|
|
1990
2259
|
};
|
|
1991
2260
|
sales: {
|
|
1992
|
-
get: (marketId: string, saleId: string, options?: ReadOptions) => Promise<Sale>;
|
|
2261
|
+
get: (marketId: string, saleId: string, options?: ReadOptions | undefined) => Promise<Sale>;
|
|
1993
2262
|
list: (marketId: string, opts: {
|
|
1994
|
-
start?: string;
|
|
1995
|
-
end?: string;
|
|
2263
|
+
start?: string | undefined;
|
|
2264
|
+
end?: string | undefined;
|
|
1996
2265
|
}) => Promise<{
|
|
1997
2266
|
start: string;
|
|
1998
2267
|
end: string;
|
|
@@ -2002,122 +2271,126 @@ declare function Studio(info?: {
|
|
|
2002
2271
|
name: string;
|
|
2003
2272
|
startsAt: string;
|
|
2004
2273
|
availableProductCodes: string[];
|
|
2005
|
-
recurring?:
|
|
2006
|
-
martEyeSaleType?: "LIVE" | "TIMED" | null;
|
|
2007
|
-
location?: string | null;
|
|
2008
|
-
description?: string | null;
|
|
2009
|
-
image?: string | null;
|
|
2010
|
-
cover?: string | null;
|
|
2011
|
-
templateId?: string | null;
|
|
2274
|
+
recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
|
|
2275
|
+
martEyeSaleType?: "LIVE" | "TIMED" | null | undefined;
|
|
2276
|
+
location?: string | null | undefined;
|
|
2277
|
+
description?: string | null | undefined;
|
|
2278
|
+
image?: string | null | undefined;
|
|
2279
|
+
cover?: string | null | undefined;
|
|
2280
|
+
templateId?: string | null | undefined;
|
|
2012
2281
|
attributeDefaults?: {
|
|
2013
2282
|
[attributekey: string]: string | number | boolean;
|
|
2014
|
-
};
|
|
2283
|
+
} | undefined;
|
|
2015
2284
|
}) => Promise<{
|
|
2016
2285
|
saleId: string;
|
|
2017
2286
|
}>;
|
|
2018
2287
|
update: (marketId: string, saleId: string, data: {
|
|
2019
|
-
name?: string;
|
|
2020
|
-
startsAt?: string;
|
|
2021
|
-
recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
|
|
2022
|
-
defaultProductCode?: string;
|
|
2023
|
-
attributeDefaults?: Record<string, any
|
|
2024
|
-
publishStatus?: SalePublishStatus;
|
|
2288
|
+
name?: string | undefined;
|
|
2289
|
+
startsAt?: string | undefined;
|
|
2290
|
+
recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
|
|
2291
|
+
defaultProductCode?: string | undefined;
|
|
2292
|
+
attributeDefaults?: Record<string, any> | undefined;
|
|
2293
|
+
publishStatus?: SalePublishStatus | undefined;
|
|
2025
2294
|
marteyeSettings?: {
|
|
2026
|
-
description?: string;
|
|
2027
|
-
image?: string;
|
|
2028
|
-
logo?: string;
|
|
2295
|
+
description?: string | undefined;
|
|
2296
|
+
image?: string | undefined;
|
|
2297
|
+
logo?: string | undefined;
|
|
2029
2298
|
type: "LIVE" | "TIMED";
|
|
2030
|
-
location?: string | null;
|
|
2031
|
-
descriptionLines?: string[];
|
|
2032
|
-
descriptionLink?: string;
|
|
2033
|
-
deposit?: number;
|
|
2034
|
-
hidePrices?: boolean;
|
|
2035
|
-
hideReplay?: boolean;
|
|
2036
|
-
labels?: string[];
|
|
2037
|
-
tags?: string[];
|
|
2038
|
-
details?:
|
|
2299
|
+
location?: string | null | undefined;
|
|
2300
|
+
descriptionLines?: string[] | undefined;
|
|
2301
|
+
descriptionLink?: string | undefined;
|
|
2302
|
+
deposit?: number | undefined;
|
|
2303
|
+
hidePrices?: boolean | undefined;
|
|
2304
|
+
hideReplay?: boolean | undefined;
|
|
2305
|
+
labels?: string[] | undefined;
|
|
2306
|
+
tags?: string[] | undefined;
|
|
2307
|
+
details?: {
|
|
2039
2308
|
markdownBase64: string;
|
|
2040
2309
|
title: string;
|
|
2041
|
-
}
|
|
2042
|
-
cover?: string;
|
|
2043
|
-
primaryColour?: string;
|
|
2044
|
-
secondaryColour?: string;
|
|
2045
|
-
foregroundColour?: string;
|
|
2046
|
-
extensionTime?: number;
|
|
2047
|
-
incrementLadder?:
|
|
2310
|
+
}[] | undefined;
|
|
2311
|
+
cover?: string | undefined;
|
|
2312
|
+
primaryColour?: string | undefined;
|
|
2313
|
+
secondaryColour?: string | undefined;
|
|
2314
|
+
foregroundColour?: string | undefined;
|
|
2315
|
+
extensionTime?: number | undefined;
|
|
2316
|
+
incrementLadder?: {
|
|
2048
2317
|
max: number;
|
|
2049
2318
|
increment: number;
|
|
2050
|
-
}
|
|
2051
|
-
hideNav?: boolean;
|
|
2052
|
-
signInOverrideLink?: string;
|
|
2053
|
-
published?: boolean;
|
|
2054
|
-
pin?: boolean;
|
|
2055
|
-
cascade?: boolean;
|
|
2056
|
-
reportEmail?: string;
|
|
2057
|
-
queueLots?: boolean;
|
|
2058
|
-
|
|
2319
|
+
}[] | undefined;
|
|
2320
|
+
hideNav?: boolean | undefined;
|
|
2321
|
+
signInOverrideLink?: string | undefined;
|
|
2322
|
+
published?: boolean | undefined;
|
|
2323
|
+
pin?: boolean | undefined;
|
|
2324
|
+
cascade?: boolean | undefined;
|
|
2325
|
+
reportEmail?: string | undefined;
|
|
2326
|
+
queueLots?: boolean | undefined;
|
|
2327
|
+
markSubjectLotsAsSold?: boolean | undefined;
|
|
2328
|
+
} | null | undefined;
|
|
2059
2329
|
}) => Promise<Sale>;
|
|
2060
2330
|
};
|
|
2061
2331
|
lots: {
|
|
2062
|
-
get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions) => Promise<Lot>;
|
|
2332
|
+
get: (marketId: string, saleId: string, lotId: string, options?: ReadOptions | undefined) => Promise<Lot>;
|
|
2063
2333
|
list: (marketId: string, saleId: string, filters?: {
|
|
2064
|
-
group?: string;
|
|
2065
|
-
productCode?: string;
|
|
2066
|
-
saleStatus?: LotSaleStatus;
|
|
2067
|
-
sellerCustomerId?: string;
|
|
2068
|
-
buyerCustomerId?: string;
|
|
2069
|
-
}) => Promise<Lot[]>;
|
|
2334
|
+
group?: string | undefined;
|
|
2335
|
+
productCode?: string | undefined;
|
|
2336
|
+
saleStatus?: LotSaleStatus | undefined;
|
|
2337
|
+
sellerCustomerId?: string | undefined;
|
|
2338
|
+
buyerCustomerId?: string | undefined;
|
|
2339
|
+
} | undefined) => Promise<Lot[]>;
|
|
2070
2340
|
create: (marketId: string, saleId: string, data: {
|
|
2071
|
-
index?: number;
|
|
2072
|
-
lotNumber?: string;
|
|
2073
|
-
group?: string;
|
|
2074
|
-
productCode?: string;
|
|
2075
|
-
sellerCustomerId?: string;
|
|
2076
|
-
attributes?: Record<string, any
|
|
2077
|
-
metadata?: Record<string, any
|
|
2078
|
-
buyerCustomerId?: string;
|
|
2079
|
-
unitPriceInCents?: number;
|
|
2080
|
-
reservePriceInCents?: number;
|
|
2081
|
-
startingPriceInCents?: number;
|
|
2082
|
-
startAt?: string;
|
|
2083
|
-
endAt?: string;
|
|
2084
|
-
previousLotNumber?: string;
|
|
2085
|
-
saleStatus?: LotSaleStatus;
|
|
2341
|
+
index?: number | undefined;
|
|
2342
|
+
lotNumber?: string | undefined;
|
|
2343
|
+
group?: string | undefined;
|
|
2344
|
+
productCode?: string | undefined;
|
|
2345
|
+
sellerCustomerId?: string | undefined;
|
|
2346
|
+
attributes?: Record<string, any> | undefined;
|
|
2347
|
+
metadata?: Record<string, any> | undefined;
|
|
2348
|
+
buyerCustomerId?: string | undefined;
|
|
2349
|
+
unitPriceInCents?: number | undefined;
|
|
2350
|
+
reservePriceInCents?: number | undefined;
|
|
2351
|
+
startingPriceInCents?: number | undefined;
|
|
2352
|
+
startAt?: string | undefined;
|
|
2353
|
+
endAt?: string | undefined;
|
|
2354
|
+
previousLotNumber?: string | undefined;
|
|
2355
|
+
saleStatus?: LotSaleStatus | undefined;
|
|
2086
2356
|
}) => Promise<Lot>;
|
|
2087
2357
|
update: (marketId: string, saleId: string, lotId: string, data: {
|
|
2088
|
-
productCode?: string;
|
|
2089
|
-
attributes?: Record<string, any
|
|
2090
|
-
sellerCasual?: string | null;
|
|
2091
|
-
sellerCustomerId?: string | null;
|
|
2092
|
-
lotNumber?: string | null;
|
|
2093
|
-
remarks?: string;
|
|
2094
|
-
notes?: string;
|
|
2095
|
-
unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
|
|
2096
|
-
unitPriceInCents?: number;
|
|
2097
|
-
reservePriceInCents?: number;
|
|
2098
|
-
startingPriceInCents?: number;
|
|
2099
|
-
buyerCasual?: string | null;
|
|
2100
|
-
buyerCustomerId?: string | null;
|
|
2101
|
-
startAt?: string | null;
|
|
2102
|
-
endAt?: string | null;
|
|
2103
|
-
saleStatus?: LotSaleStatus;
|
|
2104
|
-
metadata?: Record<string, any
|
|
2105
|
-
inputAccessories?: Record<string, any
|
|
2358
|
+
productCode?: string | undefined;
|
|
2359
|
+
attributes?: Record<string, any> | undefined;
|
|
2360
|
+
sellerCasual?: string | null | undefined;
|
|
2361
|
+
sellerCustomerId?: string | null | undefined;
|
|
2362
|
+
lotNumber?: string | null | undefined;
|
|
2363
|
+
remarks?: string | undefined;
|
|
2364
|
+
notes?: string | undefined;
|
|
2365
|
+
unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
|
|
2366
|
+
unitPriceInCents?: number | undefined;
|
|
2367
|
+
reservePriceInCents?: number | undefined;
|
|
2368
|
+
startingPriceInCents?: number | undefined;
|
|
2369
|
+
buyerCasual?: string | null | undefined;
|
|
2370
|
+
buyerCustomerId?: string | null | undefined;
|
|
2371
|
+
startAt?: string | null | undefined;
|
|
2372
|
+
endAt?: string | null | undefined;
|
|
2373
|
+
saleStatus?: LotSaleStatus | undefined;
|
|
2374
|
+
metadata?: Record<string, any> | undefined;
|
|
2375
|
+
inputAccessories?: Record<string, any> | undefined;
|
|
2106
2376
|
}) => Promise<Lot>;
|
|
2107
2377
|
delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
|
|
2378
|
+
deletePreflight: (marketId: string, saleId: string, lotId: string) => Promise<LotDeletePreflightResponse>;
|
|
2379
|
+
deletePreflightBatch: (marketId: string, saleId: string, lotIds: string[]) => Promise<DeleteLotsResponse>;
|
|
2380
|
+
deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[] | undefined) => Promise<DeleteLotsResponse>;
|
|
2108
2381
|
};
|
|
2109
2382
|
lotitems: {
|
|
2110
2383
|
create: (marketId: string, saleId: string, lotId: string, data: {
|
|
2111
|
-
attributes?: Record<string, any
|
|
2112
|
-
notes?:
|
|
2384
|
+
attributes?: Record<string, any> | undefined;
|
|
2385
|
+
notes?: {
|
|
2113
2386
|
text: string;
|
|
2114
|
-
}
|
|
2115
|
-
metadata?: Record<string, any
|
|
2387
|
+
}[] | undefined;
|
|
2388
|
+
metadata?: Record<string, any> | undefined;
|
|
2116
2389
|
}) => Promise<LotItem>;
|
|
2117
2390
|
update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
|
|
2118
|
-
attributes?: Record<string, any
|
|
2119
|
-
index?: number;
|
|
2120
|
-
metadata?: Record<string, any
|
|
2391
|
+
attributes?: Record<string, any> | undefined;
|
|
2392
|
+
index?: number | undefined;
|
|
2393
|
+
metadata?: Record<string, any> | undefined;
|
|
2121
2394
|
}) => Promise<LotItem>;
|
|
2122
2395
|
delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
|
|
2123
2396
|
};
|
|
@@ -2130,27 +2403,27 @@ declare function Studio(info?: {
|
|
|
2130
2403
|
lookup: (marketId: string, cph: string) => Promise<CphLookupResponse>;
|
|
2131
2404
|
};
|
|
2132
2405
|
webhooks: {
|
|
2133
|
-
constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string |
|
|
2406
|
+
constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<WebhookEvent<T>>;
|
|
2134
2407
|
};
|
|
2135
2408
|
actions: {
|
|
2136
2409
|
constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
|
|
2137
2410
|
};
|
|
2138
2411
|
bidderApplications: {
|
|
2139
|
-
list: (marketId: string, options?: ListApplicationsOptions) => Promise<ListApplicationsResponse>;
|
|
2412
|
+
list: (marketId: string, options?: ListApplicationsOptions | undefined) => Promise<ListApplicationsResponse>;
|
|
2140
2413
|
get: (marketId: string, applicationId: string) => Promise<Application>;
|
|
2141
2414
|
create: (marketId: string, applicationData: CreateApplicationPayload) => Promise<Application>;
|
|
2142
2415
|
update: (marketId: string, applicationId: string, updateData: UpdateApplicationPayload) => Promise<Application>;
|
|
2143
|
-
approve: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
|
|
2144
|
-
reject: (marketId: string, applicationId: string, notes?: string) => Promise<Application>;
|
|
2416
|
+
approve: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
|
|
2417
|
+
reject: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<Application>;
|
|
2145
2418
|
unlink: (marketId: string, applicationId: string) => Promise<Application>;
|
|
2146
2419
|
delete: (marketId: string, applicationId: string) => Promise<void>;
|
|
2147
2420
|
};
|
|
2148
2421
|
settings: {
|
|
2149
|
-
get: (marketId: string, options?: ReadOptions) => Promise<SettingsMarketDefaults>;
|
|
2422
|
+
get: (marketId: string, options?: ReadOptions | undefined) => Promise<SettingsMarketDefaults>;
|
|
2150
2423
|
};
|
|
2151
2424
|
adjustments: {
|
|
2152
2425
|
list: (marketId: string) => Promise<AdjustmentsConfiguration[]>;
|
|
2153
|
-
get: (marketId: string, id: string, options?: ReadOptions) => Promise<AdjustmentsConfiguration>;
|
|
2426
|
+
get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<AdjustmentsConfiguration>;
|
|
2154
2427
|
create: (marketId: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
|
|
2155
2428
|
update: (marketId: string, id: string, data: Partial<AdjustmentsConfiguration>) => Promise<AdjustmentsConfiguration>;
|
|
2156
2429
|
};
|
|
@@ -2162,7 +2435,7 @@ declare function Studio(info?: {
|
|
|
2162
2435
|
};
|
|
2163
2436
|
productCodes: {
|
|
2164
2437
|
list: (marketId: string) => Promise<ProductCodeConfiguration[]>;
|
|
2165
|
-
get: (marketId: string, id: string, options?: ReadOptions) => Promise<ProductCodeConfiguration>;
|
|
2438
|
+
get: (marketId: string, id: string, options?: ReadOptions | undefined) => Promise<ProductCodeConfiguration>;
|
|
2166
2439
|
create: (marketId: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
|
|
2167
2440
|
update: (marketId: string, id: string, data: Partial<ProductCodeConfiguration>) => Promise<ProductCodeConfiguration>;
|
|
2168
2441
|
};
|
|
@@ -2176,13 +2449,13 @@ declare function Studio(info?: {
|
|
|
2176
2449
|
create: (marketId: string, body: {
|
|
2177
2450
|
saleId: string;
|
|
2178
2451
|
name: string;
|
|
2179
|
-
description?: string | null;
|
|
2452
|
+
description?: string | null | undefined;
|
|
2180
2453
|
}) => Promise<{
|
|
2181
2454
|
templateId: string;
|
|
2182
2455
|
}>;
|
|
2183
2456
|
update: (marketId: string, templateId: string, body: {
|
|
2184
|
-
name?: string;
|
|
2185
|
-
description?: string | null;
|
|
2457
|
+
name?: string | undefined;
|
|
2458
|
+
description?: string | null | undefined;
|
|
2186
2459
|
}) => Promise<{
|
|
2187
2460
|
template: SaleTemplate;
|
|
2188
2461
|
}>;
|
|
@@ -2195,24 +2468,41 @@ declare function Studio(info?: {
|
|
|
2195
2468
|
get: (marketId: string, id: string) => Promise<TaxRate>;
|
|
2196
2469
|
};
|
|
2197
2470
|
customers: {
|
|
2198
|
-
list: (marketId: string, lastId?: string | null) => Promise<CustomersListResponse>;
|
|
2199
|
-
get: (marketId: string, customerId: string, options?: ReadOptions) => Promise<Customer>;
|
|
2471
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<CustomersListResponse>;
|
|
2472
|
+
get: (marketId: string, customerId: string, options?: ReadOptions | undefined) => Promise<Customer>;
|
|
2200
2473
|
avatar: (marketId: string, customerId: string) => Promise<Customer>;
|
|
2201
2474
|
create: (marketId: string, customerData: CreateCustomerPayload) => Promise<Customer>;
|
|
2202
2475
|
update: (marketId: string, customerId: string, customerData: UpdateCustomerPayload) => Promise<Customer>;
|
|
2203
2476
|
getByAccountNumber: (marketId: string, accountNumber: string) => Promise<Customer | null>;
|
|
2204
2477
|
getByMartEyeUid: (marketId: string, marteyeUid: string) => Promise<Customer | null>;
|
|
2205
2478
|
};
|
|
2479
|
+
customerLists: {
|
|
2480
|
+
list: (marketId: string, options?: CustomerListsListOptions | undefined) => Promise<CustomerListsListResponse>;
|
|
2481
|
+
listAll: (marketId: string, options?: Omit<CustomerListsListOptions, "offset"> | undefined) => Promise<CustomerList[]>;
|
|
2482
|
+
get: (marketId: string, listId: string) => Promise<CustomerList>;
|
|
2483
|
+
getBySlug: (marketId: string, slug: string) => Promise<CustomerList>;
|
|
2484
|
+
create: (marketId: string, payload: CreateCustomerListPayload) => Promise<CustomerList>;
|
|
2485
|
+
update: (marketId: string, listId: string, payload: UpdateCustomerListPayload) => Promise<CustomerList>;
|
|
2486
|
+
delete: (marketId: string, listId: string) => Promise<CustomerListDeleteResponse>;
|
|
2487
|
+
refresh: (marketId: string, listId: string) => Promise<CustomerListRefreshResponse>;
|
|
2488
|
+
getMembers: (marketId: string, listId: string, options?: CustomerListMembersOptions | undefined) => Promise<CustomerListMembersResponse>;
|
|
2489
|
+
getAllMembers: (marketId: string, listId: string, options?: Omit<CustomerListMembersOptions, "offset"> | undefined) => Promise<CustomerListMember[]>;
|
|
2490
|
+
addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<CustomerListAddMembersResponse>;
|
|
2491
|
+
removeMember: (marketId: string, listId: string, customerId: string) => Promise<CustomerListRemoveMemberResponse>;
|
|
2492
|
+
preview: (marketId: string, filters: CustomerListFilters) => Promise<CustomerListPreviewResponse>;
|
|
2493
|
+
listProductCodes: (marketId: string) => Promise<CustomerListProductCodesResponse>;
|
|
2494
|
+
view: (marketId: string, listIdOrSlug: string, options?: CustomerListViewOptions | undefined) => Promise<CustomerListViewResult>;
|
|
2495
|
+
};
|
|
2206
2496
|
invoices: {
|
|
2207
|
-
list: (marketId: string, lastId?: string | null) => Promise<InvoicesListResponse>;
|
|
2208
|
-
get: (marketId: string, invoiceId: string, options?: ReadOptions) => Promise<Invoice>;
|
|
2497
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<InvoicesListResponse>;
|
|
2498
|
+
get: (marketId: string, invoiceId: string, options?: ReadOptions | undefined) => Promise<Invoice>;
|
|
2209
2499
|
};
|
|
2210
2500
|
payments: {
|
|
2211
|
-
list: (marketId: string, lastId?: string | null) => Promise<PaymentsListResponse>;
|
|
2501
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<PaymentsListResponse>;
|
|
2212
2502
|
get: (marketId: string, paymentId: string) => Promise<Payment>;
|
|
2213
2503
|
};
|
|
2214
2504
|
payouts: {
|
|
2215
|
-
list: (marketId: string, lastId?: string | null) => Promise<PayoutsListResponse>;
|
|
2505
|
+
list: (marketId: string, lastId?: string | null | undefined) => Promise<PayoutsListResponse>;
|
|
2216
2506
|
get: (marketId: string, payoutId: string) => Promise<Payout>;
|
|
2217
2507
|
create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
|
|
2218
2508
|
};
|
|
@@ -2220,11 +2510,11 @@ declare function Studio(info?: {
|
|
|
2220
2510
|
query: (marketId: string, query: string) => Promise<SearchResult>;
|
|
2221
2511
|
};
|
|
2222
2512
|
files: {
|
|
2223
|
-
uploadSingleFile: (input:
|
|
2513
|
+
uploadSingleFile: (input: SingleFileInput, token: string) => Promise<{
|
|
2224
2514
|
message: string;
|
|
2225
2515
|
data: Media;
|
|
2226
2516
|
}>;
|
|
2227
|
-
uploadMultipartFile: (input:
|
|
2517
|
+
uploadMultipartFile: (input: FileInput | ChunkedInput, token: string) => Promise<{
|
|
2228
2518
|
message: string;
|
|
2229
2519
|
mediaType: string;
|
|
2230
2520
|
process: VariantProcessingState;
|
|
@@ -2235,9 +2525,9 @@ declare function Studio(info?: {
|
|
|
2235
2525
|
};
|
|
2236
2526
|
contacts: {
|
|
2237
2527
|
list: (marketId: string, customerId: string, params?: {
|
|
2238
|
-
lastId?: string;
|
|
2239
|
-
limit?: number;
|
|
2240
|
-
}) => Promise<ListContactsResponse>;
|
|
2528
|
+
lastId?: string | undefined;
|
|
2529
|
+
limit?: number | undefined;
|
|
2530
|
+
} | undefined) => Promise<ListContactsResponse>;
|
|
2241
2531
|
get: (marketId: string, customerId: string, contactId: string) => Promise<CustomerContact>;
|
|
2242
2532
|
create: (marketId: string, customerId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
|
|
2243
2533
|
update: (marketId: string, customerId: string, contactId: string, payload: CreateOrUpdateContactPayload) => Promise<CustomerContact>;
|
|
@@ -2249,6 +2539,10 @@ declare function Studio(info?: {
|
|
|
2249
2539
|
getLatestTransaction: (marketId: string, account: string) => Promise<LedgerTransaction>;
|
|
2250
2540
|
listTransactions: (marketId: string, params: ListTransactionsParams) => Promise<TransactionsListResponse>;
|
|
2251
2541
|
};
|
|
2542
|
+
sms: {
|
|
2543
|
+
sendSMS: (marketId: string, data: SendSMSPayload) => Promise<SMSTask>;
|
|
2544
|
+
getSMS: (marketId: string, smsId: string) => Promise<SMSTask>;
|
|
2545
|
+
};
|
|
2252
2546
|
};
|
|
2253
2547
|
|
|
2254
2548
|
/**
|
|
@@ -2409,5 +2703,4 @@ declare function sortByLotNumber<T extends {
|
|
|
2409
2703
|
*/
|
|
2410
2704
|
declare function nextLotNumber(previousLotNumber: string): string;
|
|
2411
2705
|
|
|
2412
|
-
export { CattlePassport, EarTag, Studio, StudioHeaders, types as StudioTypes, createAppManifest, Studio as default, lotComparator, nextLotNumber, sortByLotNumber };
|
|
2413
|
-
export type { ChunkedFile, CreateCustomerPayload, FarmAssuranceUpdate, KeeperDetailsUpdate, StudioInstance, StudioManifest, UpdateCustomerPayload };
|
|
2706
|
+
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 };
|