@marteye/studiojs 1.1.10 → 1.1.12

package/dist/index.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Search result interface based on the API implementation
+ */
+interface SearchResult {
+    hits: Array<{
+        id: string;
+        marketId: string;
+        title: string;
+        [key: string]: any;
+    }>;
+    processingTimeMs: number;
+    query: string;
+}
+
 type Timestamp = string;
 type ClientType = "Seller" | "Buyer";
 type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
@@ -1024,6 +1038,30 @@ declare namespace types {
   export { type types_Accessory as Accessory, type types_Address as Address, type types_AddressWrapper as AddressWrapper, type types_AdjustmentTarget as AdjustmentTarget, type types_AdjustmentTotalTarget as AdjustmentTotalTarget, type types_AdjustmentsConfiguration as AdjustmentsConfiguration, type types_AppParameterConfig as AppParameterConfig, type types_AttributeDefinition as AttributeDefinition, type types_AttributeValueType as AttributeValueType, type types_BankDetails as BankDetails, type types_Cart as Cart, type types_CartItem as CartItem, type types_ChequeField as ChequeField, type types_ClientType as ClientType, type types_CurrenciesWithGuinea as CurrenciesWithGuinea, type types_Currency as Currency, type types_Customer as Customer, type types_CustomerFromSearch as CustomerFromSearch, type types_DeviceType as DeviceType, type types_DraftInvoice as DraftInvoice, type types_EmailWrapper as EmailWrapper, type types_FarmAssurances as FarmAssurances, type types_FieldPositions as FieldPositions, type types_IncrementLadder as IncrementLadder, type types_IncrementLadderItem as IncrementLadderItem, type types_Invoice as Invoice, type types_InvoiceField as InvoiceField, type types_InvoiceLineItem as InvoiceLineItem, type types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, type types_InvoiceTotals as InvoiceTotals, type types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_LivestockSuperTypes as LivestockSuperTypes, type types_Lot as Lot, type types_LotGeneratedValues as LotGeneratedValues, type types_LotIssue as LotIssue, type types_LotItem as LotItem, type types_LotSaleStatus as LotSaleStatus, type types_LotWithItemsAsArray as LotWithItemsAsArray, type types_Market as Market, type types_MarketBankDetails as MarketBankDetails, type types_MarketReportHeaders as MarketReportHeaders, type types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, type types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, type types_Media as Media, type types_MemberSharingConfiguration as MemberSharingConfiguration, type types_ObjectType as ObjectType, type types_Payment as Payment, type types_PaymentMethod as PaymentMethod, type types_Payout as Payout, type types_PayoutMethod as PayoutMethod, type types_PhoneNumberWrapper as PhoneNumberWrapper, type types_Printer as Printer, type types_Product as Product, type types_ProductCodeConfiguration as ProductCodeConfiguration, type types_ProductConfiguration as ProductConfiguration, type types_Sale as Sale, type types_SaleFromSearch as SaleFromSearch, type types_SettingsAccessories as SettingsAccessories, type types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, type types_SettingsGlobalAttributes as SettingsGlobalAttributes, type types_SettingsMarketDefaults as SettingsMarketDefaults, type types_SettingsPrinters as SettingsPrinters, type types_SettingsProductCodes as SettingsProductCodes, type types_SettingsTaxRates as SettingsTaxRates, type types_ShortCustomerDetails as ShortCustomerDetails, type types_SimplePaymentIn as SimplePaymentIn, type types_SimplePaymentOut as SimplePaymentOut, type types_StudioAppPartial as StudioAppPartial, type types_SubtotalGroups as SubtotalGroups, type types_SuperType as SuperType, type types_SupportedAttributeTypes as SupportedAttributeTypes, type types_SupportedCountryCode as SupportedCountryCode, types_SupportedCurrencyCodes as SupportedCurrencyCodes, types_SupportedPaymentMethods as SupportedPaymentMethods, types_SupportedSuperTypes as SupportedSuperTypes, types_SupportedUnitsOfSale as SupportedUnitsOfSale, type types_TablePosition as TablePosition, type types_TaxRate as TaxRate, type types_UnitOfSale as UnitOfSale, type types_WebhookEvent as WebhookEvent, type types_WebhookEventName as WebhookEventName, types_supportedWebhookEvents as supportedWebhookEvents };
 }
 
+interface CreateCustomerPayload {
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phone?: string;
+    tradingName: string;
+    accountNumberPrefix?: string;
+    accountNumber?: string;
+    cphNumber?: string;
+    farmName?: string;
+    address: {
+        company?: string;
+        firstName?: string;
+        lastName?: string;
+        address1: string;
+        address2?: string;
+        city: string;
+        province?: string;
+        zip: string;
+        country: string;
+    };
+    marteyeUid?: string;
+}
+
 declare function Studio(info?: {
     apiKey?: string;
     baseUrl?: string;
@@ -1173,6 +1211,16 @@ declare function Studio(info?: {
         list: (marketId: string) => Promise<TaxRate[]>;
         get: (marketId: string, id: string) => Promise<TaxRate>;
     };
+    customers: {
+        list: (marketId: string) => Promise<Customer>;
+        get: (marketId: string, customerId: string) => Promise<Customer>;
+        avatar: (marketId: string, customerId: string) => Promise<Customer>;
+        create: (marketId: string, customerData: CreateCustomerPayload) => Promise<Customer>;
+        getByAccountNumber: (marketId: string, accountNumber: string) => Promise<Customer | null>;
+    };
+    search: {
+        query: (marketId: string, query: string) => Promise<SearchResult>;
+    };
 };
 
 /**

package/dist/index.esm.js

@@ -67,7 +67,7 @@ function SimpleHttpClient(baseUrl, apiKey, fetch, defaultTimeout, debug = false)
 }
 
 // Path: studiojs/src/resources/markets.ts
-function create$9(_) {
+function create$b(_) {
     const actions = {
         /***
          * This is used to construct the action from the request body
@@ -97,7 +97,7 @@ function create$9(_) {
     return actions;
 }
 
-function create$8(httpClient) {
+function create$a(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/adjustments`);
@@ -108,7 +108,41 @@ function create$8(httpClient) {
     };
 }
 
-function create$7(httpClient) {
+// Path: studiojs/src/resources/markets.ts
+function create$9(httpClient) {
+    let customers = {
+        list: async (marketId) => {
+            return httpClient.get(`/${marketId}/customers`);
+        },
+        get: async (marketId, customerId) => {
+            return httpClient.get(`/${marketId}/customers/${customerId}`);
+        },
+        avatar: async (marketId, customerId) => {
+            return httpClient.get(`/${marketId}/customers/${customerId}/avatar`);
+        },
+        create: async (marketId, customerData) => {
+            return httpClient.post(`/${marketId}/customers`, customerData);
+        },
+        /**
+         * Get a customer by their account number
+         * @param marketId - ID of the market the customer belongs to
+         * @param accountNumber - The customer's account number to search for
+         * @returns The customer with the specified account number or null if not found
+         */
+        getByAccountNumber: async (marketId, accountNumber) => {
+            const response = await httpClient.get(`/${marketId}/customers`, { accountNumber });
+            // API returns a list of customers, but when filtering by account number,
+            // we should get at most one customer since account numbers are unique
+            if (response.customers && response.customers.length > 0) {
+                return response.customers[0];
+            }
+            return null;
+        },
+    };
+    return customers;
+}
+
+function create$8(httpClient) {
     return {
         create: async (marketId, saleId, lotId, data) => {
             return httpClient.post(`/${marketId}/sales/${saleId}/lots/${lotId}/items`, data);
@@ -122,7 +156,7 @@ function create$7(httpClient) {
     };
 }
 
-function create$6(httpClient) {
+function create$7(httpClient) {
     return {
         get: async (marketId, saleId, lotId) => {
             return httpClient.get(`/${marketId}/sales/${saleId}/lots/${lotId}`);
@@ -142,7 +176,7 @@ function create$6(httpClient) {
     };
 }
 
-function create$5(httpClient) {
+function create$6(httpClient) {
     const markets = {
         get: async (marketId) => {
             return httpClient.get(`/${marketId}`);
@@ -164,7 +198,7 @@ function create$5(httpClient) {
     return markets;
 }
 
-function create$4(httpClient) {
+function create$5(httpClient) {
     return {
         list: async (marketId) => {
             return httpClient.get(`/${marketId}/product_codes`);
@@ -175,7 +209,7 @@ function create$4(httpClient) {
     };
 }
 
-function create$3(httpClient) {
+function create$4(httpClient) {
     return {
         get: async (marketId, saleId) => {
             return httpClient.get(`/${marketId}/sales/${saleId}`);
@@ -192,6 +226,21 @@ function create$3(httpClient) {
     };
 }
 
+function create$3(httpClient) {
+    let search = {
+        /**
+         * Search for documents within a market
+         * @param marketId - ID of the market to search in
+         * @param query - Search query string
+         * @returns Search results containing matching documents
+         */
+        query: async (marketId, query) => {
+            return httpClient.get(`/${marketId}/search`, { q: query });
+        },
+    };
+    return search;
+}
+
 function create$2(httpClient) {
     return {
         get: async (marketId) => {
@@ -249,16 +298,18 @@ function create(_) {
 
 function resources(httpClient) {
     return {
-        markets: create$5(httpClient),
-        sales: create$3(httpClient),
-        lots: create$6(httpClient),
-        lotitems: create$7(httpClient),
+        markets: create$6(httpClient),
+        sales: create$4(httpClient),
+        lots: create$7(httpClient),
+        lotitems: create$8(httpClient),
         webhooks: create(),
-        actions: create$9(),
+        actions: create$b(),
         settings: create$2(httpClient),
-        adjustments: create$8(httpClient),
-        productCodes: create$4(httpClient),
+        adjustments: create$a(httpClient),
+        productCodes: create$5(httpClient),
         taxRates: create$1(httpClient),
+        customers: create$9(httpClient),
+        search: create$3(httpClient),
     };
 }