@marteye/studiojs 1.1.48 → 1.1.49-beta.0

package/dist/studio.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import Resources from "./resources";
 export type StudioInstance = ReturnType<typeof Resources> & {
     isDebugMode: boolean;
@@ -11,7 +10,7 @@ export declare function Studio(info?: {
 }): {
     isDebugMode: boolean;
     activity: {
-        list: (marketId: string, params?: import("./resources/activity").ActivityListParams | undefined) => Promise<import("./resources/activity").ActivityListResponse>;
+        list: (marketId: string, params?: import("./resources/activity").ActivityListParams) => Promise<import("./resources/activity").ActivityListResponse>;
         get: (marketId: string, activityId: string) => Promise<import("./types").ActivityLog>;
     };
     broadcast: {
@@ -19,17 +18,17 @@ export declare function Studio(info?: {
         get: (marketId: string, type: import("./types").BroadcastType, taskId: string) => Promise<import("./types").BroadcastTask>;
     };
     markets: {
-        get: (marketId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Market>;
+        get: (marketId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Market>;
     };
     members: {
-        list: (marketId: string, params?: import("./resources/members").MembersListParams | undefined) => Promise<import("./resources/members").MembersListResponse>;
+        list: (marketId: string, params?: import("./resources/members").MembersListParams) => Promise<import("./resources/members").MembersListResponse>;
         get: (marketId: string, memberId: string) => Promise<import("./resources/members").Member>;
     };
     sales: {
-        get: (marketId: string, saleId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Sale>;
+        get: (marketId: string, saleId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Sale>;
         list: (marketId: string, opts: {
-            start?: string | undefined;
-            end?: string | undefined;
+            start?: string;
+            end?: string;
         }) => Promise<{
             start: string;
             end: string;
@@ -39,128 +38,128 @@ export declare function Studio(info?: {
             name: string;
             startsAt: string;
             availableProductCodes: string[];
-            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
-            martEyeSaleType?: "LIVE" | "TIMED" | null | undefined;
-            location?: string | null | undefined;
-            description?: string | null | undefined;
-            image?: string | null | undefined;
-            cover?: string | null | undefined;
-            templateId?: string | null | undefined;
-            enableLotGrouping?: boolean | undefined;
+            recurring?: null | "Weekly" | "Bi-weekly" | "Monthly";
+            martEyeSaleType?: "LIVE" | "TIMED" | null;
+            location?: string | null;
+            description?: string | null;
+            image?: string | null;
+            cover?: string | null;
+            templateId?: string | null;
+            enableLotGrouping?: boolean;
             attributeDefaults?: {
                 [attributekey: string]: string | number | boolean;
-            } | undefined;
+            };
         }) => Promise<{
             saleId: string;
         }>;
         update: (marketId: string, saleId: string, data: {
-            name?: string | undefined;
-            startsAt?: string | undefined;
-            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null | undefined;
-            defaultProductCode?: string | undefined;
-            attributeDefaults?: Record<string, any> | undefined;
-            publishStatus?: import("./types").SalePublishStatus | undefined;
-            enableLotGrouping?: boolean | undefined;
+            name?: string;
+            startsAt?: string;
+            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
+            defaultProductCode?: string;
+            attributeDefaults?: Record<string, any>;
+            publishStatus?: import("./types").SalePublishStatus;
+            enableLotGrouping?: boolean;
             marteyeSettings?: {
-                description?: string | undefined;
-                image?: string | undefined;
-                logo?: string | undefined;
+                description?: string;
+                image?: string;
+                logo?: string;
                 type: "LIVE" | "TIMED";
-                location?: string | null | undefined;
-                descriptionLines?: string[] | undefined;
-                descriptionLink?: string | undefined;
-                deposit?: number | undefined;
-                hidePrices?: boolean | undefined;
-                hideReplay?: boolean | undefined;
-                labels?: string[] | undefined;
-                tags?: string[] | undefined;
-                details?: {
+                location?: string | null;
+                descriptionLines?: string[];
+                descriptionLink?: string;
+                deposit?: number;
+                hidePrices?: boolean;
+                hideReplay?: boolean;
+                labels?: string[];
+                tags?: string[];
+                details?: Array<{
                     markdownBase64: string;
                     title: string;
-                }[] | undefined;
-                cover?: string | undefined;
-                primaryColour?: string | undefined;
-                secondaryColour?: string | undefined;
-                foregroundColour?: string | undefined;
-                extensionTime?: number | undefined;
-                incrementLadder?: {
+                }>;
+                cover?: string;
+                primaryColour?: string;
+                secondaryColour?: string;
+                foregroundColour?: string;
+                extensionTime?: number;
+                incrementLadder?: Array<{
                     max: number;
                     increment: number;
-                }[] | undefined;
-                hideNav?: boolean | undefined;
-                signInOverrideLink?: string | undefined;
-                published?: boolean | undefined;
-                pin?: boolean | undefined;
-                cascade?: boolean | undefined;
-                reportEmail?: string | undefined;
-                queueLots?: boolean | undefined;
-                markSubjectLotsAsSold?: boolean | undefined;
-            } | null | undefined;
+                }>;
+                hideNav?: boolean;
+                signInOverrideLink?: string;
+                published?: boolean;
+                pin?: boolean;
+                cascade?: boolean;
+                reportEmail?: string;
+                queueLots?: boolean;
+                markSubjectLotsAsSold?: boolean;
+            } | null;
         }) => Promise<import("./types").Sale>;
     };
     lots: {
-        get: (marketId: string, saleId: string, lotId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Lot>;
+        get: (marketId: string, saleId: string, lotId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Lot>;
         list: (marketId: string, saleId: string, filters?: {
-            group?: string | undefined;
-            productCode?: string | undefined;
-            saleStatus?: import("./types").LotSaleStatus | undefined;
-            sellerCustomerId?: string | undefined;
-            buyerCustomerId?: string | undefined;
-        } | undefined) => Promise<import("./types").Lot[]>;
+            group?: string;
+            productCode?: string;
+            saleStatus?: import("./types").LotSaleStatus;
+            sellerCustomerId?: string;
+            buyerCustomerId?: string;
+        }) => Promise<import("./types").Lot[]>;
         create: (marketId: string, saleId: string, data: {
-            index?: number | undefined;
-            lotNumber?: string | undefined;
-            group?: string | undefined;
-            productCode?: string | undefined;
-            sellerCustomerId?: string | undefined;
-            attributes?: Record<string, any> | undefined;
-            metadata?: Record<string, any> | undefined;
-            buyerCustomerId?: string | undefined;
-            unitPriceInCents?: number | undefined;
-            reservePriceInCents?: number | undefined;
-            startingPriceInCents?: number | undefined;
-            startAt?: string | undefined;
-            endAt?: string | undefined;
-            previousLotNumber?: string | undefined;
-            saleStatus?: import("./types").LotSaleStatus | undefined;
+            index?: number;
+            lotNumber?: string;
+            group?: string;
+            productCode?: string;
+            sellerCustomerId?: string;
+            attributes?: Record<string, any>;
+            metadata?: Record<string, any>;
+            buyerCustomerId?: string;
+            unitPriceInCents?: number;
+            reservePriceInCents?: number;
+            startingPriceInCents?: number;
+            startAt?: string;
+            endAt?: string;
+            previousLotNumber?: string;
+            saleStatus?: import("./types").LotSaleStatus;
         }) => Promise<import("./types").Lot>;
         update: (marketId: string, saleId: string, lotId: string, data: {
-            productCode?: string | undefined;
-            attributes?: Record<string, any> | undefined;
-            sellerCasual?: string | null | undefined;
-            sellerCustomerId?: string | null | undefined;
-            lotNumber?: string | null | undefined;
-            remarks?: string | undefined;
-            notes?: string | undefined;
-            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG" | undefined;
-            unitPriceInCents?: number | undefined;
-            reservePriceInCents?: number | undefined;
-            startingPriceInCents?: number | undefined;
-            buyerCasual?: string | null | undefined;
-            buyerCustomerId?: string | null | undefined;
-            startAt?: string | null | undefined;
-            endAt?: string | null | undefined;
-            saleStatus?: import("./types").LotSaleStatus | undefined;
-            metadata?: Record<string, any> | undefined;
-            inputAccessories?: Record<string, any> | undefined;
+            productCode?: string;
+            attributes?: Record<string, any>;
+            sellerCasual?: string | null;
+            sellerCustomerId?: string | null;
+            lotNumber?: string | null;
+            remarks?: string;
+            notes?: string;
+            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
+            unitPriceInCents?: number;
+            reservePriceInCents?: number;
+            startingPriceInCents?: number;
+            buyerCasual?: string | null;
+            buyerCustomerId?: string | null;
+            startAt?: string | null;
+            endAt?: string | null;
+            saleStatus?: import("./types").LotSaleStatus;
+            metadata?: Record<string, any>;
+            inputAccessories?: Record<string, any>;
         }) => Promise<import("./types").Lot>;
         delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
         deletePreflight: (marketId: string, saleId: string, lotId: string) => Promise<import("./types").LotDeletePreflightResponse>;
         deletePreflightBatch: (marketId: string, saleId: string, lotIds: string[]) => Promise<import("./types").DeleteLotsResponse>;
-        deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[] | undefined) => Promise<import("./types").DeleteLotsResponse>;
+        deleteBatch: (marketId: string, saleId: string, lotIds: string[], confirmedLotIds?: string[]) => Promise<import("./types").DeleteLotsResponse>;
     };
     lotitems: {
         create: (marketId: string, saleId: string, lotId: string, data: {
-            attributes?: Record<string, any> | undefined;
-            notes?: {
+            attributes?: Record<string, any>;
+            notes?: Array<{
                 text: string;
-            }[] | undefined;
-            metadata?: Record<string, any> | undefined;
+            }>;
+            metadata?: Record<string, any>;
         }) => Promise<import("./types").LotItem>;
         update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
-            attributes?: Record<string, any> | undefined;
-            index?: number | undefined;
-            metadata?: Record<string, any> | undefined;
+            attributes?: Record<string, any>;
+            index?: number;
+            metadata?: Record<string, any>;
         }) => Promise<import("./types").LotItem>;
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
@@ -173,27 +172,27 @@ export declare function Studio(info?: {
         lookup: (marketId: string, cph: string) => Promise<import("./types").CphLookupResponse>;
     };
     webhooks: {
-        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<import("./types").WebhookEvent<T>>;
+        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | undefined | null, endpointSecret: string | undefined | null) => Promise<import("./types").WebhookEvent<T>>;
     };
     actions: {
         constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
     };
     bidderApplications: {
-        list: (marketId: string, options?: import("./resources/bidderApplications").ListApplicationsOptions | undefined) => Promise<import("./resources/bidderApplications").ListApplicationsResponse>;
+        list: (marketId: string, options?: import("./resources/bidderApplications").ListApplicationsOptions) => Promise<import("./resources/bidderApplications").ListApplicationsResponse>;
         get: (marketId: string, applicationId: string) => Promise<import("./types").Application>;
         create: (marketId: string, applicationData: import("./resources/bidderApplications").CreateApplicationPayload) => Promise<import("./types").Application>;
         update: (marketId: string, applicationId: string, updateData: import("./resources/bidderApplications").UpdateApplicationPayload) => Promise<import("./types").Application>;
-        approve: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<import("./types").Application>;
-        reject: (marketId: string, applicationId: string, notes?: string | undefined) => Promise<import("./types").Application>;
+        approve: (marketId: string, applicationId: string, notes?: string) => Promise<import("./types").Application>;
+        reject: (marketId: string, applicationId: string, notes?: string) => Promise<import("./types").Application>;
         unlink: (marketId: string, applicationId: string) => Promise<import("./types").Application>;
         delete: (marketId: string, applicationId: string) => Promise<void>;
     };
     settings: {
-        get: (marketId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").SettingsMarketDefaults>;
+        get: (marketId: string, options?: import("./types").ReadOptions) => Promise<import("./types").SettingsMarketDefaults>;
     };
     adjustments: {
         list: (marketId: string) => Promise<import("./types").AdjustmentsConfiguration[]>;
-        get: (marketId: string, id: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").AdjustmentsConfiguration>;
+        get: (marketId: string, id: string, options?: import("./types").ReadOptions) => Promise<import("./types").AdjustmentsConfiguration>;
         create: (marketId: string, data: Partial<import("./types").AdjustmentsConfiguration>) => Promise<import("./types").AdjustmentsConfiguration>;
         update: (marketId: string, id: string, data: Partial<import("./types").AdjustmentsConfiguration>) => Promise<import("./types").AdjustmentsConfiguration>;
     };
@@ -204,8 +203,10 @@ export declare function Studio(info?: {
         update: (marketId: string, id: string, data: import("./resources/extras").UpdateExtraPayload) => Promise<import("./types").Product>;
     };
     productCodes: {
-        list: (marketId: string) => Promise<import("./types").ProductCodeConfiguration[]>;
-        get: (marketId: string, id: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").ProductCodeConfiguration>;
+        list: (marketId: string, options?: {
+            includeArchived?: boolean;
+        }) => Promise<import("./types").ProductCodeConfiguration[]>;
+        get: (marketId: string, id: string, options?: import("./types").ReadOptions) => Promise<import("./types").ProductCodeConfiguration>;
         create: (marketId: string, data: Partial<import("./types").ProductCodeConfiguration>) => Promise<import("./types").ProductCodeConfiguration>;
         update: (marketId: string, id: string, data: Partial<import("./types").ProductCodeConfiguration>) => Promise<import("./types").ProductCodeConfiguration>;
     };
@@ -219,13 +220,13 @@ export declare function Studio(info?: {
         create: (marketId: string, body: {
             saleId: string;
             name: string;
-            description?: string | null | undefined;
+            description?: string | null;
         }) => Promise<{
             templateId: string;
         }>;
         update: (marketId: string, templateId: string, body: {
-            name?: string | undefined;
-            description?: string | null | undefined;
+            name?: string;
+            description?: string | null;
         }) => Promise<{
             template: import("./types").SaleTemplate;
         }>;
@@ -238,8 +239,8 @@ export declare function Studio(info?: {
         get: (marketId: string, id: string) => Promise<import("./types").TaxRate>;
     };
     customers: {
-        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("./resources/customers").CustomersListResponse>;
-        get: (marketId: string, customerId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Customer>;
+        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/customers").CustomersListResponse>;
+        get: (marketId: string, customerId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Customer>;
         avatar: (marketId: string, customerId: string) => Promise<import("./types").Customer>;
         create: (marketId: string, customerData: import(".").CreateCustomerPayload) => Promise<import("./types").Customer>;
         update: (marketId: string, customerId: string, customerData: import(".").UpdateCustomerPayload) => Promise<import("./types").Customer>;
@@ -247,32 +248,32 @@ export declare function Studio(info?: {
         getByMartEyeUid: (marketId: string, marteyeUid: string) => Promise<import("./types").Customer | null>;
     };
     customerLists: {
-        list: (marketId: string, options?: import(".").CustomerListsListOptions | undefined) => Promise<import(".").CustomerListsListResponse>;
-        listAll: (marketId: string, options?: Omit<import(".").CustomerListsListOptions, "offset"> | undefined) => Promise<import(".").CustomerList[]>;
+        list: (marketId: string, options?: import(".").CustomerListsListOptions) => Promise<import(".").CustomerListsListResponse>;
+        listAll: (marketId: string, options?: Omit<import(".").CustomerListsListOptions, "offset">) => Promise<import(".").CustomerList[]>;
         get: (marketId: string, listId: string) => Promise<import(".").CustomerList>;
         getBySlug: (marketId: string, slug: string) => Promise<import(".").CustomerList>;
         create: (marketId: string, payload: import(".").CreateCustomerListPayload) => Promise<import(".").CustomerList>;
         update: (marketId: string, listId: string, payload: import(".").UpdateCustomerListPayload) => Promise<import(".").CustomerList>;
         delete: (marketId: string, listId: string) => Promise<import(".").CustomerListDeleteResponse>;
         refresh: (marketId: string, listId: string) => Promise<import(".").CustomerListRefreshResponse>;
-        getMembers: (marketId: string, listId: string, options?: import(".").CustomerListMembersOptions | undefined) => Promise<import(".").CustomerListMembersResponse>;
-        getAllMembers: (marketId: string, listId: string, options?: Omit<import(".").CustomerListMembersOptions, "offset"> | undefined) => Promise<import(".").CustomerListMember[]>;
+        getMembers: (marketId: string, listId: string, options?: import(".").CustomerListMembersOptions) => Promise<import(".").CustomerListMembersResponse>;
+        getAllMembers: (marketId: string, listId: string, options?: Omit<import(".").CustomerListMembersOptions, "offset">) => Promise<import(".").CustomerListMember[]>;
         addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<import(".").CustomerListAddMembersResponse>;
         removeMember: (marketId: string, listId: string, customerId: string) => Promise<import(".").CustomerListRemoveMemberResponse>;
         preview: (marketId: string, filters: import(".").CustomerListFilters) => Promise<import(".").CustomerListPreviewResponse>;
         listProductCodes: (marketId: string) => Promise<import(".").CustomerListProductCodesResponse>;
-        view: (marketId: string, listIdOrSlug: string, options?: import(".").CustomerListViewOptions | undefined) => Promise<import(".").CustomerListViewResult>;
+        view: (marketId: string, listIdOrSlug: string, options?: import(".").CustomerListViewOptions) => Promise<import(".").CustomerListViewResult>;
     };
     invoices: {
-        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("./resources/invoices").InvoicesListResponse>;
-        get: (marketId: string, invoiceId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Invoice>;
+        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/invoices").InvoicesListResponse>;
+        get: (marketId: string, invoiceId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Invoice>;
     };
     payments: {
-        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("./resources/payments").PaymentsListResponse>;
+        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/payments").PaymentsListResponse>;
         get: (marketId: string, paymentId: string) => Promise<import("./types").Payment>;
     };
     payouts: {
-        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("./resources/payouts").PayoutsListResponse>;
+        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/payouts").PayoutsListResponse>;
         get: (marketId: string, payoutId: string) => Promise<import("./types").Payout>;
         create: (marketId: string, data: import("./resources/payouts").CreatePayoutRequest) => Promise<import("./resources/payouts").PayoutCreateResponse>;
     };
@@ -280,11 +281,11 @@ export declare function Studio(info?: {
         query: (marketId: string, query: string) => Promise<import("./resources/search").SearchResult>;
     };
     files: {
-        uploadSingleFile: (input: import("./utils/multipart-upload").SingleFileInput, token: string) => Promise<{
+        uploadSingleFile: (input: Parameters<typeof import("./utils/multipart-upload").uploadSingleFile>[0], token: string) => Promise<{
             message: string;
             data: import("./types").Media;
         }>;
-        uploadMultipartFile: (input: import("./index.common").FileInput | import("./index.common").ChunkedInput, token: string) => Promise<{
+        uploadMultipartFile: (input: Parameters<typeof import("./utils/multipart-upload").uploadMultipartFile>[0], token: string) => Promise<{
             message: string;
             mediaType: string;
             process: import("./utils/multipart-upload").VariantProcessingState;
@@ -295,9 +296,9 @@ export declare function Studio(info?: {
     };
     contacts: {
         list: (marketId: string, customerId: string, params?: {
-            lastId?: string | undefined;
-            limit?: number | undefined;
-        } | undefined) => Promise<import("./resources/contacts").ListContactsResponse>;
+            lastId?: string;
+            limit?: number;
+        }) => Promise<import("./resources/contacts").ListContactsResponse>;
         get: (marketId: string, customerId: string, contactId: string) => Promise<import("./types").CustomerContact>;
         create: (marketId: string, customerId: string, payload: import("./resources/contacts").CreateOrUpdateContactPayload) => Promise<import("./types").CustomerContact>;
         update: (marketId: string, customerId: string, contactId: string, payload: import("./resources/contacts").CreateOrUpdateContactPayload) => Promise<import("./types").CustomerContact>;

package/dist/types.d.ts

@@ -1,10 +1,17 @@
 type Timestamp = string;
 export type ClientType = "Seller" | "Buyer";
-export type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
+export type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Dogs" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
 export declare const SupportedSuperTypes: SuperType[];
 export declare const LivestockSuperTypes: SuperType[];
 export type Currency = "GBP" | "EUR" | "USD";
 export declare const SupportedCurrencyCodes: Currency[];
+export declare const AccountTiers: {
+    readonly free: 0;
+    readonly basic: 1;
+    readonly standard: 2;
+    readonly premium: 3;
+};
+export type AccountTier = (typeof AccountTiers)[keyof typeof AccountTiers];
 export type SupportedCountryCode = "GB-ENG" | "GB-SCT" | "GB-WLS" | "GB-NIR" | "IE";
 export type CurrenciesWithGuinea = Currency | "GUINEA-GBP";
 export type UnitOfSale = "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
@@ -33,6 +40,7 @@ export interface Market {
         createdAt: Timestamp;
     }[];
     paymentInstructions?: string;
+    accountTier?: AccountTier;
 }
 export interface SettingsMarketDefaults {
     updatedAt: Timestamp;
@@ -59,6 +67,7 @@ export interface SettingsMarketDefaults {
     selectDocumentIdsMap: {
         [supertype: string]: string[];
     };
+    priceEntrySheetColumnOrder?: string[];
     enableLuckMoney?: boolean;
 }
 export interface SettingsProductCodes {
@@ -192,6 +201,8 @@ export interface Sale {
             count: number;
             sold: number;
             invoiced: number;
+            invoicedBuyer?: number;
+            invoicedSeller?: number;
             valueInCents: number;
         };
         lotItems: {
@@ -228,6 +239,7 @@ export interface TemplateSaleData {
     marteyeSettings?: MartEyeTimedSaleSettings | MartEyeLiveSaleSettings | null;
     enableLuckMoney?: boolean;
     enableLotGrouping?: boolean;
+    customAttributes?: AttributeDefinition[];
 }
 export interface SaleTemplate {
     id: string;
@@ -319,6 +331,7 @@ export interface SaleFromSearch extends Omit<Omit<Omit<Sale, "createdAt">, "upda
 export type LotSaleStatus = "Sold" | "Unsold" | "Rerun" | "Resold" | null;
 export type LotDeleteDecision = "allow" | "confirm" | "block";
 export type LotDeleteReason = "local_only" | "not_started" | "started" | "started_with_bids" | "finished" | "studio_locked" | "not_found" | "sync_unavailable" | "link_unresolved";
+export type LotDeleteStudioLockReason = "invoice" | "sale_status";
 export interface LotDeletePreflightItem {
     lotId: string;
     lotNumber: string | null;
@@ -332,6 +345,8 @@ export interface LotDeletePreflightItem {
     bidCount: number;
     startAt: string | null;
     endAt: string | null;
+    studioLockReason?: LotDeleteStudioLockReason;
+    lockedSaleStatus?: string | null;
 }
 export interface LotDeletePreflightResponse {
     version: 1;
@@ -432,6 +447,8 @@ export interface LotWithItemsAsArray extends Omit<Lot, "itemMap"> {
 export interface LotGeneratedValues {
     totalValueInCents?: number | null;
     description?: string | null;
+    buyerInvoiceDescription?: string | null;
+    sellerStatementDescription?: string | null;
     pricePerKiloInCents?: number | null;
     averageWeightKg?: number | null;
     pricePerItemInCents?: number | null;
@@ -525,6 +542,9 @@ export interface ProductCodeConfiguration {
     createdAt?: Timestamp;
     updatedAt?: Timestamp;
     updatedBy?: string | null;
+    archived?: boolean;
+    archivedAt?: Timestamp | null;
+    archivedBy?: string | null;
     superType: SuperType;
     description: string;
     icon?: string;
@@ -546,7 +566,21 @@ export interface ProductCodeConfiguration {
         [attributekey: string]: AttributeValueType;
     };
     lotDescriptionTemplate?: string;
+    sellerStatementLotDescriptionTemplate?: string;
+    buyerInvoiceLotDescriptionTemplate?: string;
     rostrumAttributes?: string[];
+    benthamSheepBuilder?: {
+        topFieldOrder?: string[];
+        topFieldVisibility?: Record<string, boolean>;
+        lotFieldOrder?: string[];
+        lotFieldVisibility?: Record<string, boolean>;
+        createLotOnRowAdd?: boolean;
+        sendCreatedLotsToDisplayBoard?: boolean;
+        displayBoardTrigger?: "auto" | {
+            type: "focused";
+            field: string;
+        };
+    };
     selectDocumentIds?: string[] | null;
 }
 /***
@@ -774,6 +808,7 @@ export type ChequeField = "chequeDate" | "chequeNumber" | "payee" | "amount" | "
 export type SubtotalGroups = "Commission" | string;
 export type AdjustmentTotalTarget = "Per Invoice" | "Total - finalTotalInCents" | "Total - lotTotalLessCommissionInCentsExVat";
 export type AdjustmentTarget = UnitOfSale | AdjustmentTotalTarget;
+export type LadderCalculationMode = "progressive" | "threshold";
 /***
  * Commission is added as a line item. Can also be used for levies etc
  */
@@ -821,6 +856,7 @@ interface Adjustment {
     } | null;
     fixedAmountInCents?: number | null;
     ladder?: {
+        mode?: LadderCalculationMode;
         steps: {
             percentageValue?: number;
             upToAmountInCents?: number | null;
@@ -891,6 +927,8 @@ export interface Payout {
     accountNumber?: string;
     sortCode?: string;
     chequeMadePayableTo?: string;
+    chequeIsPrinted?: boolean;
+    chequeIssuedManually?: boolean;
     transactionDate: Timestamp;
     reference: string | null;
     status: "pending" | "complete" | "void";
@@ -1104,6 +1142,11 @@ export interface AttributeDefinition {
     shortName?: string;
     description?: string;
     martEyeAttribute?: string;
+    scope?: "global" | "sale";
+    saleScoped?: boolean;
+    archivedAt?: Timestamp | null;
+    archivedBy?: string | null;
+    archivedSyncToMartEye?: boolean | null;
     applyTo: string[];
     level: "item" | "lot";
     readonly?: boolean;
@@ -1198,6 +1241,8 @@ export interface SendSMSPayload {
     customerId?: string;
     reference?: string;
     senderName?: string;
+    communicationContext?: string;
+    metadata?: Record<string, any>;
 }
 export type BroadcastType = "sms" | "email";
 export type BroadcastKind = "broadcast" | "statement";
@@ -1213,6 +1258,7 @@ export interface BroadcastRecipient {
 export interface SMSBroadcastPayload {
     type: "sms";
     kind?: BroadcastKind;
+    communicationContext?: string;
     message?: string;
     senderName?: string;
     recipients: BroadcastRecipient[];
@@ -1220,6 +1266,7 @@ export interface SMSBroadcastPayload {
 export interface EmailBroadcastPayload {
     type: "email";
     kind?: BroadcastKind;
+    communicationContext?: string;
     message?: string;
     subject?: string;
     subdomain?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marteye/studiojs",
-  "version": "1.1.48",
+  "version": "1.1.49-beta.0",
   "description": "MartEye Studio JavaScript SDK",
   "license": "MIT",
   "source": "src/index.ts",