arky-sdk 0.7.78 → 0.7.84

package/dist/index.d.ts

@@ -1,13 +1,15 @@
+import * as nanostores from 'nanostores';
+import { atom, computed } from 'nanostores';
 import { RequestOptions, MagicLinkVerifyParams, MagicLinkRequestParams, UpdateAccountProfileParams, DeleteAccountParams, GetMeParams, SearchAccountsParams, Location, CreateLocationParams, UpdateLocationParams, DeleteLocationParams, Market, CreateMarketParams, UpdateMarketParams, DeleteMarketParams, CreateBusinessParams, UpdateBusinessParams, DeleteBusinessParams, GetBusinessParams, GetBusinessesParams, GetSubscriptionPlansParams, SubscribeParams, CreatePortalSessionParams, InviteUserParams, RemoveMemberParams, HandleInvitationParams, TestWebhookParams, GetBusinessMediaParams2, OAuthConnectParams, OAuthDisconnectParams, ListIntegrationsParams, CreateIntegrationParams, UpdateIntegrationParams, DeleteIntegrationParams, ListWebhooksParams, CreateWebhookParams, UpdateWebhookParams, DeleteWebhookParams, GetMediaParams, UploadBusinessMediaParams, DeleteBusinessMediaParams, GetBusinessMediaParams, UpdateMediaParams, TrackEmailOpenParams, TriggerNotificationParams, CreatePromoCodeParams, UpdatePromoCodeParams, DeletePromoCodeParams, GetPromoCodeParams, GetPromoCodesParams, GetShippingRatesParams, ShippingRate, ShipParams, ShipResult, CreateNodeParams, UpdateNodeParams, DeleteNodeParams, GetNodeParams, GetNodesParams, GetNodeChildrenParams, CreateFormParams, UpdateFormParams, DeleteFormParams, GetFormParams, GetFormsParams, SubmitFormParams, GetFormSubmissionsParams, GetFormSubmissionParams, UpdateFormSubmissionParams, CreateTaxonomyParams, UpdateTaxonomyParams, DeleteTaxonomyParams, GetTaxonomyParams, GetTaxonomiesParams, GetTaxonomyChildrenParams, CreateEmailTemplateParams, UpdateEmailTemplateParams, DeleteEmailTemplateParams, GetEmailTemplateParams, GetEmailTemplatesParams, CreateProductParams, UpdateProductParams, DeleteProductParams, GetProductParams, GetProductsParams, CreateOrderParams, UpdateOrderParams, GetOrderParams, GetOrdersParams, GetQuoteParams, ProcessOrderRefundParams, Slot, CreateBookingParams, UpdateBookingParams, GetBookingParams, SearchBookingsParams, GetBookingQuoteParams, ProcessBookingRefundParams, GetAvailabilityParams, AvailabilityResponse, CancelBookingItemParams, CreateServiceParams, UpdateServiceParams, DeleteServiceParams, GetServiceParams, GetServicesParams, FindServiceProvidersParams, CreateServiceProviderParams, UpdateServiceProviderParams, DeleteServiceProviderParams, CreateProviderParams, UpdateProviderParams, DeleteProviderParams, GetProviderParams, GetProvidersParams, CreateCustomerParams, Customer, GetCustomerParams, FindCustomersParams, UpdateCustomerParams, MergeCustomersParams, CreateAudienceParams, UpdateAudienceParams, GetAudienceParams, GetAudiencesParams, GetAudienceSubscribersParams, AddAudienceSubscriberParams, RemoveAudienceSubscriberParams, CreateAgentParams, UpdateAgentParams, DeleteAgentParams, GetAgentParams, GetAgentsParams, RunAgentParams, GetAgentChatsParams, GetAgentChatParams, UpdateAgentChatParams, RateAgentChatParams, GetBusinessChatsParams, CreateWorkflowParams, UpdateWorkflowParams, DeleteWorkflowParams, GetWorkflowParams, GetWorkflowsParams, TriggerWorkflowParams, GetWorkflowExecutionsParams, GetWorkflowExecutionParams } from './types.js';
 export { Access, Address, AgentChatStatus, AgentStatus, ApiResponse, Audience, AudienceAccessResponse, AudienceStatus, AudienceSubscribeResponse, AudienceSubscriber, AudienceSubscription, AudienceSubscriptionPayment, AudienceSubscriptionProvider, AudienceSubscriptionSource, AudienceSubscriptionStatus, AvailabilitySlot, Block, BookingCartItem, BookingPayment, BookingPaymentPromoCode, BookingPaymentProvider, BookingPaymentRefund, BookingPaymentTax, BookingPaymentTaxLine, BookingProviderStatus, BookingQuote, BookingServiceStatus, BookingStoreState, Business, BusinessSubscription, BusinessSubscriptionPayment, BusinessSubscriptionProvider, BusinessSubscriptionSource, BusinessSubscriptionStatus, CustomerStatus, CustomsDeclaration, CustomsItem, DaySlots, EmailTemplateStatus, EshopCartItem, EshopStoreState, Event, EventAction, ExecutionStatus, FormStatus, GeoLocation, GeoLocationBlock, Integration, IntegrationProvider, Language, Media, MediaResolution, Node, NodeResult, NodeStatus, OrderPayment, OrderPaymentPromoCode, OrderPaymentProvider, OrderPaymentRefund, OrderPaymentTax, OrderPaymentTaxLine, OrderQuote, OrderShipping, PaginatedResponse, Parcel, PaymentMethod, PaymentMethodType, Price, ProductStatus, PromoCodeStatus, PromoCodeValidation, ProviderAvailability, ProviderWithTimeline, PurchaseLabelResult, Shipment, ShipmentLine, ShippingAddress, ShippingMethod, ShippingStatus, ShippingWeightTier, SystemTemplateKey, TaxonomyStatus, Webhook, WebhookEventSubscription, Workflow, WorkflowEdge, WorkflowExecution, WorkflowHttpMethod, WorkflowHttpNode, WorkflowNode, WorkflowStatus, WorkflowSwitchNode, WorkflowTransformNode, WorkflowTriggerNode, Zone, ZoneLocation } from './types.js';
 import { f as formatPayment, a as formatMinor, g as getCurrencySymbol, b as getCurrencyName, i as isValidKey, v as validateKey, t as toKey, n as nameToKey, c as getAvailableStock, d as getReservedStock, h as hasStock, e as getInventoryAt, j as getFirstAvailableFCId } from './index-DTg5d847.js';
 
 interface Activity$1 {
-    businessId: string;
-    customerId: string;
+    business_id: string;
+    customer_id: string;
     type: string;
     payload: Record<string, any>;
-    createdAt: number;
+    created_at: number;
 }
 interface TrackParams {
     type: string;
@@ -17,10 +19,10 @@ declare const COMMON_ACTIVITY_TYPES: readonly ["page_view", "product_view", "ser
 type CommonActivityType = (typeof COMMON_ACTIVITY_TYPES)[number];
 
 interface AuthTokens {
-    accessToken: string;
-    refreshToken?: string;
-    accessExpiresAt?: number;
-    accountId?: string;
+    access_token: string;
+    refresh_token?: string;
+    access_expires_at?: number;
+    account_id?: string;
 }
 interface HttpClientConfig {
     baseUrl: string;
@@ -34,65 +36,83 @@ interface HttpClientConfig {
     isAuthenticated?: () => boolean;
 }
 
-interface AnalyticsSummary {
-    orders: number;
-    ordersChange: number;
-    bookings: number;
-    bookingsChange: number;
-    newCustomers: number;
-    newCustomersChange: number;
-    formSubmissions: number;
-    formSubmissionsChange: number;
+type EntityKind = "product" | "service" | "provider" | "node" | "customer" | "audience" | "agent" | "workflow" | "promo_code" | "email_template" | "form" | "taxonomy" | "media" | "order" | "booking";
+type Granularity = "hour" | "day" | "week" | "month" | {
+    minutes: 5 | 10 | 15 | 30;
+};
+type Measure = "count" | "uniq_customers" | "orders_created" | "bookings_created" | "new_customers" | "form_submissions" | {
+    entity_state: {
+        entity: EntityKind;
+        status: string;
+    };
+};
+type Dimension = "country_code" | "city" | "device_type" | "browser" | "os" | "language" | "activity_type" | "entity" | "entity_status" | {
+    time_bucket: {
+        granularity: Granularity;
+    };
+};
+type FilterField = "type" | "country_code" | "device_type" | "browser" | "os" | "language" | "entity" | "action" | "customer_id";
+type FilterOp = "eq" | "neq" | "in" | "not_in" | "contains";
+interface Filter {
+    field: FilterField;
+    op: FilterOp;
+    values: string[];
+}
+type TimeUnit = "hour" | "day" | "week" | "month";
+type TimeRange = {
+    from: number;
+    unit: TimeUnit;
+    to?: number;
+} | {
+    from: number;
+    to: number;
+};
+interface OrderBy {
+    field: string;
+    dir: "asc" | "desc";
+}
+interface AnalyticsQuery {
+    measures: Measure[];
+    dimensions?: Dimension[];
+    filters?: Filter[];
+    time_range: TimeRange;
+    granularity?: Granularity;
+    order_by?: OrderBy[];
+    limit?: number;
+}
+interface AnalyticsRow {
+    [key: string]: string | number | null;
 }
-interface StatusBreakdown {
-    status: string;
-    count: number;
+interface AnalyticsQueryResponse {
+    rows: AnalyticsRow[];
+    meta: {
+        row_count: number;
+        execution_ms: number;
+    };
 }
 
 interface Activity {
-    businessId: string;
-    customerId: string;
+    business_id: string;
+    customer_id: string;
     type: string;
     payload: Record<string, any>;
-    createdAt: number;
-    countryCode?: string | null;
+    created_at: number;
+    country_code?: string | null;
     city?: string | null;
     region?: string | null;
     timezone?: string | null;
-    deviceType?: string | null;
+    device_type?: string | null;
     browser?: string | null;
     os?: string | null;
     language?: string | null;
-    sessionIdx?: number | null;
+    session_idx?: number | null;
 }
 interface TimelineParams {
-    customerId: string;
+    customer_id: string;
     businessId?: string;
     limit?: number;
     cursor?: string;
 }
-interface CountParams {
-    businessId?: string;
-    type?: string;
-    payloadKey?: string;
-    payloadValue?: string;
-    windowSeconds?: number;
-}
-interface ActivityTypeInfo {
-    type: string;
-    eventCount: number;
-    firstSeenAt: number;
-    lastSeenAt: number;
-}
-interface CountryBreakdownItem {
-    countryCode: string;
-    eventCount: number;
-    distinctCustomers: number;
-}
-interface CountryBreakdownParams {
-    businessId?: string;
-    windowSeconds?: number;
-}
 
 interface LocationState {
     code: string;
@@ -108,6 +128,20 @@ interface GetCountriesResponse {
     cursor: string | null;
 }
 
+interface StorefrontStores {
+    business: ReturnType<typeof atom<any>>;
+    market: ReturnType<typeof atom<any>>;
+    loading: ReturnType<typeof atom<boolean>>;
+    error: ReturnType<typeof atom<string | null>>;
+    initialized: ReturnType<typeof atom<boolean>>;
+    currency: ReturnType<typeof computed>;
+    currencySymbol: ReturnType<typeof computed>;
+    paymentMethods: ReturnType<typeof computed>;
+    paymentMethodObjects: ReturnType<typeof computed>;
+    paymentConfig: ReturnType<typeof computed>;
+    zones: ReturnType<typeof computed>;
+}
+
 declare function getBlockLabel(block: any): string;
 declare function formatBlockValue(block: any): string;
 declare function prepareBlocksForSubmission(formData: any, blockTypes?: Record<string, string>): any[];
@@ -138,15 +172,7 @@ declare function fetchSvgContent(mediaObject: any): Promise<string | null>;
 declare function getSvgContentForAstro(mediaObject: any): Promise<string>;
 declare function injectSvgIntoElement(mediaObject: any, targetElement: HTMLElement, className?: string): Promise<void>;
 
-declare global {
-    interface Window {
-        dataLayer: any[];
-        gtag: (...args: any[]) => void;
-    }
-}
-declare function track(eventName: string, params?: Record<string, any>): void;
-
-declare const SDK_VERSION = "0.7.74";
+declare const SDK_VERSION = "0.7.84";
 declare const SUPPORTED_FRAMEWORKS: readonly ["astro", "react", "vue", "svelte", "vanilla"];
 interface ApiConfig {
     httpClient: any;
@@ -168,7 +194,7 @@ declare function createAdmin(config: HttpClientConfig & {
         }, options?: RequestOptions): Promise<any>;
         verify(params: MagicLinkVerifyParams, options?: RequestOptions): Promise<any>;
         refresh(params: {
-            refreshToken: string;
+            refresh_token: string;
         }, options?: RequestOptions): Promise<any>;
         businessCode(businessId: string, params: {
             email: string;
@@ -224,7 +250,7 @@ declare function createAdmin(config: HttpClientConfig & {
         deleteIntegration(params: DeleteIntegrationParams, options?: RequestOptions): Promise<any>;
         getIntegrationConfig(params: {
             businessId: string;
-            type: "payment" | "shipping" | "analytics";
+            type: "payment" | "shipping";
         }, options?: RequestOptions): Promise<any>;
         listWebhooks(params: ListWebhooksParams, options?: RequestOptions): Promise<any>;
         createWebhook(params: CreateWebhookParams, options?: RequestOptions): Promise<any>;
@@ -381,20 +407,6 @@ declare function createAdmin(config: HttpClientConfig & {
                 items: Activity[];
                 cursor: string | null;
             }>;
-            count(params: CountParams, options?: RequestOptions): Promise<{
-                total: number;
-                distinctCustomers: number;
-            }>;
-            types(params?: {
-                businessId?: string;
-            }, options?: RequestOptions): Promise<{
-                items: ActivityTypeInfo[];
-                uniqueCount: number;
-            }>;
-            countryBreakdown(params?: CountryBreakdownParams, options?: RequestOptions): Promise<{
-                items: CountryBreakdownItem[];
-                unknownCount: number;
-            }>;
         };
     };
     automation: {
@@ -426,13 +438,9 @@ declare function createAdmin(config: HttpClientConfig & {
         };
     };
     analytics: {
-        track: typeof track;
-        getSummary: (params?: {
-            period?: string;
-        }, options?: RequestOptions) => Promise<AnalyticsSummary>;
-        getStatusBreakdown: (params: {
-            entity: string;
-        }, options?: RequestOptions) => Promise<StatusBreakdown[]>;
+        query: (spec: AnalyticsQuery, options?: RequestOptions & {
+            businessId?: string;
+        }) => Promise<AnalyticsQueryResponse>;
     };
     setBusinessId: (businessId: string) => void;
     getBusinessId: () => string;
@@ -481,7 +489,6 @@ declare function createAdmin(config: HttpClientConfig & {
         validateKey: typeof validateKey;
         toKey: typeof toKey;
         nameToKey: typeof nameToKey;
-        track: typeof track;
         getAvailableStock: typeof getAvailableStock;
         getReservedStock: typeof getReservedStock;
         hasStock: typeof hasStock;
@@ -489,16 +496,33 @@ declare function createAdmin(config: HttpClientConfig & {
         getFirstAvailableFCId: typeof getFirstAvailableFCId;
     };
 }>;
+interface StorefrontSession {
+    business: any;
+    market: any;
+}
 declare function createStorefront(config: HttpClientConfig & {
-    market: string;
+    market?: string;
     locale?: string;
-}): Promise<{
+}): {
+    init: () => Promise<StorefrontSession>;
+    stores: {
+        business: nanostores.PreinitializedWritableAtom<any> & object;
+        market: nanostores.PreinitializedWritableAtom<any> & object;
+        loading: nanostores.PreinitializedWritableAtom<boolean> & object;
+        error: nanostores.PreinitializedWritableAtom<string> & object;
+        initialized: nanostores.PreinitializedWritableAtom<boolean> & object;
+        currency: nanostores.ReadableAtom<any>;
+        currencySymbol: nanostores.ReadableAtom<any>;
+        paymentMethods: nanostores.ReadableAtom<any>;
+        paymentMethodObjects: nanostores.ReadableAtom<any>;
+        paymentConfig: nanostores.ReadableAtom<{
+            provider: any;
+            enabled: boolean;
+        }>;
+        zones: nanostores.ReadableAtom<any>;
+    };
     business: {
         getBusiness(options?: RequestOptions): any;
-        getIntegrationConfig(params: {
-            businessId?: string;
-            type: "payment" | "shipping" | "analytics";
-        }, options?: RequestOptions): any;
         location: {
             getCountries(options?: RequestOptions): any;
             getCountry(countryCode: string, options?: RequestOptions): any;
@@ -562,9 +586,7 @@ declare function createStorefront(config: HttpClientConfig & {
         customer: {
             initialize(params?: {
                 businessId?: string;
-            }, options?: RequestOptions): any;
-            signInAnonymously(params?: {
-                businessId?: string;
+                market?: string;
             }, options?: RequestOptions): any;
             connect(params: any, options?: RequestOptions): any;
             requestCode(params: {
@@ -577,7 +599,7 @@ declare function createStorefront(config: HttpClientConfig & {
                 businessId?: string;
             }, options?: RequestOptions): any;
             refreshToken(params: {
-                refreshToken: string;
+                refresh_token: string;
                 businessId?: string;
             }, options?: RequestOptions): any;
             getMe(options?: RequestOptions): any;
@@ -607,35 +629,32 @@ declare function createStorefront(config: HttpClientConfig & {
             sendMessage(params: {
                 id: string;
                 message: string;
-                chatId?: string;
+                chat_id?: string;
                 businessId?: string;
             }, options?: RequestOptions): any;
             getChat(params: {
                 id: string;
-                chatId: string;
+                chat_id: string;
                 businessId?: string;
             }, options?: RequestOptions): any;
             getChatMessages(params: {
                 id: string;
-                chatId: string;
+                chat_id: string;
                 limit?: number;
                 businessId?: string;
             }, options?: RequestOptions): any;
             rateChat(params: {
                 id: string;
-                chatId: string;
+                chat_id: string;
                 rating: number;
                 comment?: string;
                 businessId?: string;
             }, options?: RequestOptions): any;
         };
     };
-    analytics: {
-        track: typeof track;
-    };
     setBusinessId: (businessId: string) => void;
     getBusinessId: () => string;
-    setMarket: (market: string) => void;
+    setMarket: (key: string) => void;
     getMarket: () => string;
     setLocale: (locale: string) => void;
     getLocale: () => string;
@@ -680,13 +699,12 @@ declare function createStorefront(config: HttpClientConfig & {
         validateKey: typeof validateKey;
         toKey: typeof toKey;
         nameToKey: typeof nameToKey;
-        track: typeof track;
         getAvailableStock: typeof getAvailableStock;
         getReservedStock: typeof getReservedStock;
         hasStock: typeof hasStock;
         getInventoryAt: typeof getInventoryAt;
         getFirstAvailableFCId: typeof getFirstAvailableFCId;
     };
-}>;
+};
 
-export { type Activity$1 as Activity, type ActivityTypeInfo, type AnalyticsSummary, type ApiConfig, AvailabilityResponse, COMMON_ACTIVITY_TYPES, type CommonActivityType, type CountParams, CreateAgentParams, CreateLocationParams, DeleteLocationParams, GetAgentParams, GetAgentsParams, GetAvailabilityParams, type GetCountriesResponse, GetShippingRatesParams, type HttpClientConfig, Location, type LocationCountry, type LocationState, Market, SDK_VERSION, SUPPORTED_FRAMEWORKS, ShipParams, ShipResult, ShippingRate, Slot, type StatusBreakdown, type TimelineParams, type TrackParams, UpdateAgentParams, UpdateLocationParams, createAdmin, createStorefront };
+export { type Activity$1 as Activity, type AnalyticsQuery, type AnalyticsQueryResponse, type AnalyticsRow, type ApiConfig, AvailabilityResponse, COMMON_ACTIVITY_TYPES, type CommonActivityType, CreateAgentParams, CreateLocationParams, DeleteLocationParams, type Dimension, type EntityKind, type Filter, type FilterField, type FilterOp, GetAgentParams, GetAgentsParams, GetAvailabilityParams, type GetCountriesResponse, GetShippingRatesParams, type Granularity, type HttpClientConfig, Location, type LocationCountry, type LocationState, Market, type Measure, type OrderBy, SDK_VERSION, SUPPORTED_FRAMEWORKS, ShipParams, ShipResult, ShippingRate, Slot, type StorefrontSession, type StorefrontStores, type TimeRange, type TimeUnit, type TimelineParams, type TrackParams, UpdateAgentParams, UpdateLocationParams, createAdmin, createStorefront };