@marteye/studiojs 1.1.46 → 1.1.47-beta.0

package/dist/resources.d.ts

@@ -1,21 +1,22 @@
+/// <reference types="node" />
 import type { HttpClient } from "./net/http";
 export default function resources(httpClient: HttpClient): {
     activity: {
-        list: (marketId: string, params?: import("./resources/activity").ActivityListParams) => Promise<import("./resources/activity").ActivityListResponse>;
+        list: (marketId: string, params?: import("./resources/activity").ActivityListParams | undefined) => Promise<import("./resources/activity").ActivityListResponse>;
         get: (marketId: string, activityId: string) => Promise<import("./types").ActivityLog>;
     };
     markets: {
-        get: (marketId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Market>;
+        get: (marketId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Market>;
     };
     members: {
-        list: (marketId: string, params?: import("./resources/members").MembersListParams) => Promise<import("./resources/members").MembersListResponse>;
+        list: (marketId: string, params?: import("./resources/members").MembersListParams | undefined) => 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) => Promise<import("./types").Sale>;
+        get: (marketId: string, saleId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Sale>;
         list: (marketId: string, opts: {
-            start?: string;
-            end?: string;
+            start?: string | undefined;
+            end?: string | undefined;
         }) => Promise<{
             start: string;
             end: string;
@@ -25,122 +26,126 @@ export default function resources(httpClient: HttpClient): {
             name: string;
             startsAt: string;
             availableProductCodes: string[];
-            recurring?: null | "Weekly" | "Bi-weekly" | "Monthly";
-            martEyeSaleType?: "LIVE" | "TIMED" | null;
-            location?: string | null;
-            description?: string | null;
-            image?: string | null;
-            cover?: string | null;
-            templateId?: string | null;
+            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;
             attributeDefaults?: {
                 [attributekey: string]: string | number | boolean;
-            };
+            } | undefined;
         }) => Promise<{
             saleId: string;
         }>;
         update: (marketId: string, saleId: string, data: {
-            name?: string;
-            startsAt?: string;
-            recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
-            defaultProductCode?: string;
-            attributeDefaults?: Record<string, any>;
-            publishStatus?: import("./types").SalePublishStatus;
+            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;
             marteyeSettings?: {
-                description?: string;
-                image?: string;
-                logo?: string;
+                description?: string | undefined;
+                image?: string | undefined;
+                logo?: string | undefined;
                 type: "LIVE" | "TIMED";
-                location?: string | null;
-                descriptionLines?: string[];
-                descriptionLink?: string;
-                deposit?: number;
-                hidePrices?: boolean;
-                hideReplay?: boolean;
-                labels?: string[];
-                tags?: string[];
-                details?: Array<{
+                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?: {
                     markdownBase64: string;
                     title: string;
-                }>;
-                cover?: string;
-                primaryColour?: string;
-                secondaryColour?: string;
-                foregroundColour?: string;
-                extensionTime?: number;
-                incrementLadder?: Array<{
+                }[] | undefined;
+                cover?: string | undefined;
+                primaryColour?: string | undefined;
+                secondaryColour?: string | undefined;
+                foregroundColour?: string | undefined;
+                extensionTime?: number | undefined;
+                incrementLadder?: {
                     max: number;
                     increment: number;
-                }>;
-                hideNav?: boolean;
-                signInOverrideLink?: string;
-                published?: boolean;
-                pin?: boolean;
-                cascade?: boolean;
-                reportEmail?: string;
-                queueLots?: boolean;
-            } | null;
+                }[] | 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;
         }) => Promise<import("./types").Sale>;
     };
     lots: {
-        get: (marketId: string, saleId: string, lotId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Lot>;
+        get: (marketId: string, saleId: string, lotId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").Lot>;
         list: (marketId: string, saleId: string, filters?: {
-            group?: string;
-            productCode?: string;
-            saleStatus?: import("./types").LotSaleStatus;
-            sellerCustomerId?: string;
-            buyerCustomerId?: string;
-        }) => Promise<import("./types").Lot[]>;
+            group?: string | undefined;
+            productCode?: string | undefined;
+            saleStatus?: import("./types").LotSaleStatus | undefined;
+            sellerCustomerId?: string | undefined;
+            buyerCustomerId?: string | undefined;
+        } | undefined) => Promise<import("./types").Lot[]>;
         create: (marketId: string, saleId: string, data: {
-            index?: number;
-            lotNumber?: string;
-            group?: string;
-            productCode?: string;
-            sellerCustomerId?: string;
-            attributes?: Record<string, any>;
-            metadata?: Record<string, any>;
-            buyerCustomerId?: string;
-            unitPriceInCents?: number;
-            reservePriceInCents?: number;
-            startingPriceInCents?: number;
-            startAt?: string;
-            endAt?: string;
-            previousLotNumber?: string;
-            saleStatus?: import("./types").LotSaleStatus;
+            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;
         }) => Promise<import("./types").Lot>;
         update: (marketId: string, saleId: string, lotId: string, data: {
-            productCode?: string;
-            attributes?: Record<string, any>;
-            sellerCasual?: string | null;
-            sellerCustomerId?: string | null;
-            lotNumber?: string | null;
-            remarks?: string;
-            notes?: string;
-            unitOfSale?: "Per KG" | "Per Item" | "Per Lot" | "Per 1000KG";
-            unitPriceInCents?: number;
-            reservePriceInCents?: number;
-            startingPriceInCents?: number;
-            buyerCasual?: string | null;
-            buyerCustomerId?: string | null;
-            startAt?: string | null;
-            endAt?: string | null;
-            saleStatus?: import("./types").LotSaleStatus;
-            metadata?: Record<string, any>;
-            inputAccessories?: Record<string, any>;
+            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;
         }) => 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>;
     };
     lotitems: {
         create: (marketId: string, saleId: string, lotId: string, data: {
-            attributes?: Record<string, any>;
-            notes?: Array<{
+            attributes?: Record<string, any> | undefined;
+            notes?: {
                 text: string;
-            }>;
-            metadata?: Record<string, any>;
+            }[] | undefined;
+            metadata?: Record<string, any> | undefined;
         }) => Promise<import("./types").LotItem>;
         update: (marketId: string, saleId: string, lotId: string, itemId: string, data: {
-            attributes?: Record<string, any>;
-            index?: number;
-            metadata?: Record<string, any>;
+            attributes?: Record<string, any> | undefined;
+            index?: number | undefined;
+            metadata?: Record<string, any> | undefined;
         }) => Promise<import("./types").LotItem>;
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
@@ -153,27 +158,27 @@ export default function resources(httpClient: HttpClient): {
         lookup: (marketId: string, cph: string) => Promise<import("./types").CphLookupResponse>;
     };
     webhooks: {
-        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | undefined | null, endpointSecret: string | undefined | null) => Promise<import("./types").WebhookEvent<T>>;
+        constructEvent: <T extends unknown>(bodyAsBuffer: Buffer, signature: string | null | undefined, endpointSecret: string | null | undefined) => Promise<import("./types").WebhookEvent<T>>;
     };
     actions: {
         constructAction: (bodyAsBuffer: Buffer, signature: string, endpointSecret: string) => Promise<any>;
     };
     bidderApplications: {
-        list: (marketId: string, options?: import("./resources/bidderApplications").ListApplicationsOptions) => Promise<import("./resources/bidderApplications").ListApplicationsResponse>;
+        list: (marketId: string, options?: import("./resources/bidderApplications").ListApplicationsOptions | undefined) => 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) => Promise<import("./types").Application>;
-        reject: (marketId: string, applicationId: string, notes?: string) => 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>;
         unlink: (marketId: string, applicationId: string) => Promise<import("./types").Application>;
         delete: (marketId: string, applicationId: string) => Promise<void>;
     };
     settings: {
-        get: (marketId: string, options?: import("./types").ReadOptions) => Promise<import("./types").SettingsMarketDefaults>;
+        get: (marketId: string, options?: import("./types").ReadOptions | undefined) => Promise<import("./types").SettingsMarketDefaults>;
     };
     adjustments: {
         list: (marketId: string) => Promise<import("./types").AdjustmentsConfiguration[]>;
-        get: (marketId: string, id: string, options?: import("./types").ReadOptions) => Promise<import("./types").AdjustmentsConfiguration>;
+        get: (marketId: string, id: string, options?: import("./types").ReadOptions | undefined) => 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>;
     };
@@ -185,7 +190,7 @@ export default function resources(httpClient: HttpClient): {
     };
     productCodes: {
         list: (marketId: string) => Promise<import("./types").ProductCodeConfiguration[]>;
-        get: (marketId: string, id: string, options?: import("./types").ReadOptions) => Promise<import("./types").ProductCodeConfiguration>;
+        get: (marketId: string, id: string, options?: import("./types").ReadOptions | undefined) => 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>;
     };
@@ -199,13 +204,13 @@ export default function resources(httpClient: HttpClient): {
         create: (marketId: string, body: {
             saleId: string;
             name: string;
-            description?: string | null;
+            description?: string | null | undefined;
         }) => Promise<{
             templateId: string;
         }>;
         update: (marketId: string, templateId: string, body: {
-            name?: string;
-            description?: string | null;
+            name?: string | undefined;
+            description?: string | null | undefined;
         }) => Promise<{
             template: import("./types").SaleTemplate;
         }>;
@@ -218,24 +223,41 @@ export default function resources(httpClient: HttpClient): {
         get: (marketId: string, id: string) => Promise<import("./types").TaxRate>;
     };
     customers: {
-        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/customers").CustomersListResponse>;
-        get: (marketId: string, customerId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Customer>;
+        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>;
         avatar: (marketId: string, customerId: string) => Promise<import("./types").Customer>;
         create: (marketId: string, customerData: import("./resources/customers").CreateCustomerPayload) => Promise<import("./types").Customer>;
         update: (marketId: string, customerId: string, customerData: import("./resources/customers").UpdateCustomerPayload) => Promise<import("./types").Customer>;
         getByAccountNumber: (marketId: string, accountNumber: string) => Promise<import("./types").Customer | null>;
         getByMartEyeUid: (marketId: string, marteyeUid: string) => Promise<import("./types").Customer | null>;
     };
+    customerLists: {
+        list: (marketId: string, options?: import("./resources/customerLists").CustomerListsListOptions | undefined) => Promise<import("./resources/customerLists").CustomerListsListResponse>;
+        listAll: (marketId: string, options?: Omit<import("./resources/customerLists").CustomerListsListOptions, "offset"> | undefined) => Promise<import("./resources/customerLists").CustomerList[]>;
+        get: (marketId: string, listId: string) => Promise<import("./resources/customerLists").CustomerList>;
+        getBySlug: (marketId: string, slug: string) => Promise<import("./resources/customerLists").CustomerList>;
+        create: (marketId: string, payload: import("./resources/customerLists").CreateCustomerListPayload) => Promise<import("./resources/customerLists").CustomerList>;
+        update: (marketId: string, listId: string, payload: import("./resources/customerLists").UpdateCustomerListPayload) => Promise<import("./resources/customerLists").CustomerList>;
+        delete: (marketId: string, listId: string) => Promise<import("./resources/customerLists").CustomerListDeleteResponse>;
+        refresh: (marketId: string, listId: string) => Promise<import("./resources/customerLists").CustomerListRefreshResponse>;
+        getMembers: (marketId: string, listId: string, options?: import("./resources/customerLists").CustomerListMembersOptions | undefined) => Promise<import("./resources/customerLists").CustomerListMembersResponse>;
+        getAllMembers: (marketId: string, listId: string, options?: Omit<import("./resources/customerLists").CustomerListMembersOptions, "offset"> | undefined) => Promise<import("./resources/customerLists").CustomerListMember[]>;
+        addMembers: (marketId: string, listId: string, customerIds: string[]) => Promise<import("./resources/customerLists").CustomerListAddMembersResponse>;
+        removeMember: (marketId: string, listId: string, customerId: string) => Promise<import("./resources/customerLists").CustomerListRemoveMemberResponse>;
+        preview: (marketId: string, filters: import("./resources/customerLists").CustomerListFilters) => Promise<import("./resources/customerLists").CustomerListPreviewResponse>;
+        listProductCodes: (marketId: string) => Promise<import("./resources/customerLists").CustomerListProductCodesResponse>;
+        view: (marketId: string, listIdOrSlug: string, options?: import("./resources/customerLists").CustomerListViewOptions | undefined) => Promise<import("./resources/customerLists").CustomerListViewResult>;
+    };
     invoices: {
-        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/invoices").InvoicesListResponse>;
-        get: (marketId: string, invoiceId: string, options?: import("./types").ReadOptions) => Promise<import("./types").Invoice>;
+        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>;
     };
     payments: {
-        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/payments").PaymentsListResponse>;
+        list: (marketId: string, lastId?: string | null | undefined) => Promise<import("./resources/payments").PaymentsListResponse>;
         get: (marketId: string, paymentId: string) => Promise<import("./types").Payment>;
     };
     payouts: {
-        list: (marketId: string, lastId?: string | null) => Promise<import("./resources/payouts").PayoutsListResponse>;
+        list: (marketId: string, lastId?: string | null | undefined) => 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>;
     };
@@ -243,11 +265,11 @@ export default function resources(httpClient: HttpClient): {
         query: (marketId: string, query: string) => Promise<import("./resources/search").SearchResult>;
     };
     files: {
-        uploadSingleFile: (input: Parameters<typeof import("./utils/multipart-upload").uploadSingleFile>[0], token: string) => Promise<{
+        uploadSingleFile: (input: import("./utils/multipart-upload").SingleFileInput, token: string) => Promise<{
             message: string;
             data: import("./types").Media;
         }>;
-        uploadMultipartFile: (input: Parameters<typeof import("./utils/multipart-upload").uploadMultipartFile>[0], token: string) => Promise<{
+        uploadMultipartFile: (input: import("./index.common").FileInput | import("./index.common").ChunkedInput, token: string) => Promise<{
             message: string;
             mediaType: string;
             process: import("./utils/multipart-upload").VariantProcessingState;
@@ -258,9 +280,9 @@ export default function resources(httpClient: HttpClient): {
     };
     contacts: {
         list: (marketId: string, customerId: string, params?: {
-            lastId?: string;
-            limit?: number;
-        }) => Promise<import("./resources/contacts").ListContactsResponse>;
+            lastId?: string | undefined;
+            limit?: number | undefined;
+        } | undefined) => 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>;
@@ -272,4 +294,8 @@ export default function resources(httpClient: HttpClient): {
         getLatestTransaction: (marketId: string, account: string) => Promise<import("./resources/ledger").LedgerTransaction>;
         listTransactions: (marketId: string, params: import("./resources/ledger").ListTransactionsParams) => Promise<import("./resources/ledger").TransactionsListResponse>;
     };
+    sms: {
+        sendSMS: (marketId: string, data: import("./types").SendSMSPayload) => Promise<import("./types").SMSTask>;
+        getSMS: (marketId: string, smsId: string) => Promise<import("./types").SMSTask>;
+    };
 };