@aifeatures/admin-react 0.25.0 → 0.27.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.cts CHANGED
@@ -4,7 +4,7 @@ import * as React from 'react';
4
4
  /**
5
5
  * Email marketing wire types (plan U10), mirroring the aifeatures routes:
6
6
  * marketing-settings-api, audience-api, marketing-drafts-api, broadcasts-api,
7
- * welcome-api and recovery-api.
7
+ * templates-api and automations-api.
8
8
  */
9
9
  interface MarketingSettings {
10
10
  business_name: string | null;
@@ -87,7 +87,7 @@ interface ContactImportReport {
87
87
  reason: ImportSkipReason;
88
88
  }>;
89
89
  }
90
- type EmailDraftKind = 'broadcast' | 'welcome' | 'recovery';
90
+ type EmailDraftKind = 'broadcast' | 'automation' | 'welcome' | 'recovery';
91
91
  type EmailDraftBlock = {
92
92
  type: 'heading';
93
93
  text: string;
@@ -215,38 +215,71 @@ interface Broadcast {
215
215
  unsubscribed: number;
216
216
  };
217
217
  }
218
- interface WelcomeStep {
219
- id: string;
220
- position: number;
221
- delay_days: number;
222
- draft_id: string | null;
223
- published: boolean;
224
- published_version: number | null;
225
- published_at: string | null;
226
- }
227
- interface WelcomeSequence {
228
- active: boolean;
229
- tag_id: string | null;
230
- steps: WelcomeStep[];
231
- }
232
- interface RecoveryStep {
233
- step: number;
218
+ /** An automation's trigger (automations plan R8): joined a list, purchase made, abandoned checkout. */
219
+ type AutomationTrigger = 'joined_list' | 'purchase_made' | 'abandoned_checkout';
220
+ /** Draft has never been on; Off takes no new entries and sends no new steps (emails already queued still go out). */
221
+ type AutomationStatus = 'draft' | 'on' | 'off';
222
+ type AutomationStep = {
223
+ step_key: string;
224
+ type: 'send';
225
+ /** The email: an `automation` draft of this automation. */
234
226
  draft_id: string;
235
- published: boolean;
236
- published_version: number | null;
237
- published_at: string | null;
238
- }
239
- interface RecoveryFlow {
240
- active: boolean;
241
- offsets_hours: number[];
242
- steps: RecoveryStep[];
227
+ subject: string;
228
+ /** The step has a live publication: a save sends the new version to the next people who reach it. */
229
+ live: boolean;
230
+ } | {
231
+ step_key: string;
232
+ type: 'wait';
233
+ wait_hours: number;
234
+ };
235
+ /** A step as a step-list save sends it (the whole list, KTD16). */
236
+ type AutomationStepInput = {
237
+ type: 'send';
238
+ draft_id: string;
239
+ } | {
240
+ type: 'wait';
241
+ wait_hours: number;
242
+ };
243
+ interface Automation {
244
+ id: string;
245
+ name: string;
246
+ trigger_type: AutomationTrigger;
247
+ /** Joined a list only: the list it watches; null is any list. */
248
+ list_tag_id: string | null;
249
+ status: AutomationStatus;
250
+ /** Its trigger takes new entries; an On automation that is not reads as unavailable (R17). */
251
+ available: boolean;
252
+ /** Why it would not take entries or send right now, in fix order: `trigger_unavailable`, `checkout_consent_off`, or a send readiness reason. */
243
253
  blocked_by: string[];
244
- counts: {
245
- abandoned: number;
246
- emailed: number;
247
- recovered: number;
248
- skipped: number;
249
- };
254
+ /** Moves with every write to the automation, its steps or its emails; turn-on sends the one on screen (KTD38). */
255
+ version: number;
256
+ steps: AutomationStep[];
257
+ created_at: string;
258
+ updated_at: string;
259
+ }
260
+ type AutomationSuggestionKey = 'welcome' | 'post_purchase' | 'recovery';
261
+ /** What the site can automate (KTD19). */
262
+ interface AutomationCapabilities {
263
+ store: boolean;
264
+ checkout_consent: 'on' | 'off_available' | 'unavailable';
265
+ usable_triggers: AutomationTrigger[];
266
+ /** One per usable trigger, in display order. */
267
+ suggestions: AutomationSuggestionKey[];
268
+ }
269
+ interface AutomationList {
270
+ automations: Automation[];
271
+ capabilities: AutomationCapabilities;
272
+ }
273
+ /** One email step's stats, summed over every version that has been live (R23). */
274
+ interface AutomationStepStats {
275
+ step_key: string;
276
+ sent: number;
277
+ delivered: number;
278
+ opened: number;
279
+ clicked: number;
280
+ bounced: number;
281
+ complained: number;
282
+ unsubscribed: number;
250
283
  }
251
284
 
252
285
  /** Latest send attempt per kind; delivered means accepted by the recipient's mail server. */
@@ -2215,8 +2248,11 @@ interface AifeaturesApiClient {
2215
2248
  targeting: BroadcastTargeting;
2216
2249
  scheduled_at?: string | null;
2217
2250
  }): Promise<BroadcastPlan>;
2218
- getWelcomeSequence(siteId: string): Promise<WelcomeSequence>;
2219
- getRecoveryFlow(siteId: string): Promise<RecoveryFlow>;
2251
+ /** The site's automations, oldest first, with what the site can automate. */
2252
+ getAutomations(siteId: string): Promise<AutomationList>;
2253
+ getAutomation(siteId: string, automationId: string): Promise<Automation>;
2254
+ /** Each email step's sends, opens and clicks, in step order. */
2255
+ getAutomationStats(siteId: string, automationId: string): Promise<AutomationStepStats[]>;
2220
2256
  }
2221
2257
  declare function createApiClient(siteToken: string, apiUrl?: string): AifeaturesApiClient;
2222
2258
 
@@ -3056,6 +3092,10 @@ type PickImage = () => Promise<PickedImage | null>;
3056
3092
  * - On an aifeatures error, reject with an Error whose `code` is the
3057
3093
  * aifeatures error `code` (`version_conflict`, `over_allowance`,
3058
3094
  * `template_in_use`, `template_archived`, …): the view keys its recovery on it.
3095
+ * Copy the error body's `step_key` (an automation refusal naming the email,
3096
+ * `email_empty` or `postal_address_missing`) and `automation_id`
3097
+ * (`automation_exists`) onto the Error too: the Automations tab links to
3098
+ * that email or automation, and says less without them.
3059
3099
  */
3060
3100
  declare const EMAIL_ORG_ACTIONS: {
3061
3101
  readonly commitBroadcast: {
@@ -3116,6 +3156,30 @@ declare const EMAIL_ORG_ACTIONS: {
3116
3156
  readonly path: "/sites/{siteId}/marketing/templates/{templateId}";
3117
3157
  readonly params: readonly ["templateId"];
3118
3158
  };
3159
+ readonly updateAutomation: {
3160
+ readonly method: "PUT";
3161
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}";
3162
+ readonly params: readonly ["automationId"];
3163
+ };
3164
+ readonly addSuggestedAutomation: {
3165
+ readonly method: "POST";
3166
+ readonly path: "/sites/{siteId}/marketing/automation-suggestions";
3167
+ };
3168
+ readonly turnOnAutomation: {
3169
+ readonly method: "POST";
3170
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}/turn-on";
3171
+ readonly params: readonly ["automationId"];
3172
+ };
3173
+ readonly turnOffAutomation: {
3174
+ readonly method: "POST";
3175
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}/turn-off";
3176
+ readonly params: readonly ["automationId"];
3177
+ };
3178
+ readonly deleteAutomation: {
3179
+ readonly method: "DELETE";
3180
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}";
3181
+ readonly params: readonly ["automationId"];
3182
+ };
3119
3183
  readonly importContacts: {
3120
3184
  readonly method: "POST";
3121
3185
  readonly path: "/sites/{siteId}/contacts/import";
@@ -3151,60 +3215,6 @@ declare const EMAIL_ORG_ACTIONS: {
3151
3215
  readonly path: "/forms/{formId}";
3152
3216
  readonly params: readonly ["formId"];
3153
3217
  };
3154
- readonly createWelcomeStep: {
3155
- readonly method: "POST";
3156
- readonly path: "/sites/{siteId}/marketing/welcome/steps";
3157
- };
3158
- readonly updateWelcomeStep: {
3159
- readonly method: "PATCH";
3160
- readonly path: "/sites/{siteId}/marketing/welcome/steps/{stepId}";
3161
- readonly params: readonly ["stepId"];
3162
- };
3163
- readonly deleteWelcomeStep: {
3164
- readonly method: "DELETE";
3165
- readonly path: "/sites/{siteId}/marketing/welcome/steps/{stepId}";
3166
- readonly params: readonly ["stepId"];
3167
- };
3168
- readonly publishWelcomeStep: {
3169
- readonly method: "POST";
3170
- readonly path: "/sites/{siteId}/marketing/welcome/steps/{stepId}/publish";
3171
- readonly params: readonly ["stepId"];
3172
- };
3173
- readonly activateWelcome: {
3174
- readonly method: "POST";
3175
- readonly path: "/sites/{siteId}/marketing/welcome/activate";
3176
- };
3177
- readonly pauseWelcome: {
3178
- readonly method: "POST";
3179
- readonly path: "/sites/{siteId}/marketing/welcome/pause";
3180
- };
3181
- readonly updateWelcome: {
3182
- readonly method: "PATCH";
3183
- readonly path: "/sites/{siteId}/marketing/welcome";
3184
- };
3185
- readonly setRecoveryStep: {
3186
- readonly method: "PUT";
3187
- readonly path: "/sites/{siteId}/marketing/recovery/steps/{step}";
3188
- readonly params: readonly ["step"];
3189
- };
3190
- readonly publishRecoveryStep: {
3191
- readonly method: "POST";
3192
- readonly path: "/sites/{siteId}/marketing/recovery/steps/{step}/publish";
3193
- readonly params: readonly ["step"];
3194
- };
3195
- readonly deleteRecoveryStep: {
3196
- readonly method: "DELETE";
3197
- readonly path: "/sites/{siteId}/marketing/recovery/steps/{step}";
3198
- readonly params: readonly ["step"];
3199
- };
3200
- readonly activateRecovery: {
3201
- readonly method: "POST";
3202
- readonly path: "/sites/{siteId}/marketing/recovery/activate";
3203
- };
3204
- readonly pauseRecovery: {
3205
- readonly method: "POST";
3206
- readonly path: "/sites/{siteId}/marketing/recovery/pause";
3207
- };
3208
3218
  };
3209
3219
  type EmailOrgAction = keyof typeof EMAIL_ORG_ACTIONS;
3210
3220
  interface EmailOrgRequest {
@@ -3260,6 +3270,12 @@ interface EmailViewProps extends EmailSiteInfo {
3260
3270
  initialDraftId?: string;
3261
3271
  /** Deep link (`show_view('email', {tab})`): open this tab. The old `template` opens Templates. */
3262
3272
  initialTab?: EmailViewInitialTab;
3273
+ /**
3274
+ * Deep link (`show_view('email', {automation_id})`): open this automation's
3275
+ * canvas on the Automations tab; an id the site no longer has opens the
3276
+ * list. Wins over `initialTab`.
3277
+ */
3278
+ initialAutomationId?: string;
3263
3279
  /**
3264
3280
  * Deep link (`show_view('email', {template_id})`): open this template;
3265
3281
  * `standard` is the built-in one, and an id the site no longer has opens the
@@ -3292,6 +3308,8 @@ interface EmailViewProps extends EmailSiteInfo {
3292
3308
  onTurnOn?: () => Promise<void>;
3293
3309
  /** Open the host's Settings → Store, where checkout marketing consent lives. */
3294
3310
  onOpenStoreSettings?: () => void;
3311
+ /** Open the host's Settings → Branding, where the logo every email shows lives. */
3312
+ onOpenBrandSettings?: () => void;
3295
3313
  /**
3296
3314
  * Bump to refetch everything the view shows in place (an agent turn changed
3297
3315
  * email data). Keeps the open tab and never overwrites a draft edit the
@@ -3305,7 +3323,8 @@ type EmailViewTab = "audience" | "broadcasts" | "automations" | "templates" | "s
3305
3323
  type EmailViewInitialTab = EmailViewTab | "template";
3306
3324
  /**
3307
3325
  * EmailView — the merchant's email marketing view (plan U10; email templates
3308
- * U15): audience, broadcasts, templates and settings.
3326
+ * U15; automations U6): audience, broadcasts, automations, templates and
3327
+ * settings.
3309
3328
  * Reads use the site token; every write goes through `onOrgAction`.
3310
3329
  */
3311
3330
  /**
@@ -4205,4 +4224,4 @@ interface DashboardViewProps {
4205
4224
  */
4206
4225
  declare function DashboardView({ refreshKey, onBackToWebsite, primaryConversion, onChangePrimaryConversion, onOpenSurface, needsPaidPlan, onUpgradePlan, onConnectStripe, }: DashboardViewProps): react_jsx_runtime.JSX.Element;
4207
4226
 
4208
- export { AUDIENCE_PAGE_SIZE, type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsConversionRow, type AnalyticsConversions, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsGoalTargetRow, type AnalyticsGoalTargets, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type Broadcast, type BroadcastPlan, type BroadcastStatus, type BroadcastTargeting, type BusinessSummary, type BusinessVisitors, type ContactConsentStatus, ContactImport, type ContactImportProps, type ContactImportReport, type ContactTagRef, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type CurrencyRestatement, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, DOUBLE_OPT_IN_HELP, DashboardView, type DashboardViewProps, EMAIL_ORG_ACTIONS, EMAIL_READINESS_TEXT, type EmailDelivery, type EmailDomainSetupResult, type EmailDraft, type EmailDraftBlock, type EmailDraftKind, type EmailDraftPreview, type EmailOrgAction, type EmailOrgRequest, type EmailResource, type EmailSideStatus, type EmailTemplatePreview, type EmailTemplateRef, type EmailTemplateStatus, type EmailTemplateSummary, EmailView, type EmailViewInitialTab, type EmailViewProps, type EmailViewTab, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, ExportCsvButton, type ExportCsvButtonProps, type ExportOrdersOptions, type ExportPeopleOptions, type ExportRetainersOptions, type ExportSubscriptionsOptions, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type FormsLocation, type FormsTab, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, IMPORT_ATTESTATION, type ImportSkipReason, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoiceSettingsPanel, type InvoiceSettingsPanelProps, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type MarketingContact, type MarketingContactStats, type MarketingContactsPage, type MarketingSettings, type MarketingTag, type NeedsAttentionItem, type NeedsAttentionType, NotificationRecipientsSettings, type NotificationRecipientsSettingsProps, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type PrimaryConversion, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RecoveryFlow, type RecoveryStep, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type ShippingRate, type SiteSettings, type StoreInvoiceSettingsInput, StoreSettings, type StoreSettingsProps, type StoreSettingsSection, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateSiteSettingsInput, type UpdateSiteSettingsResult, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseAudienceOptions, type UseAudienceReturn, type UseBroadcastsOptions, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCsvExportOptions, type UseCsvExportReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEmailDraftsOptions, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSiteSettingsOptions, type UseSiteSettingsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, type WelcomeSequence, type WelcomeStep, buildEmailOrgRequest, chargedTotal, createApiClient, emailReadinessText, formatPrice, isEmailOrgAction, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useAudience, useBroadcasts, useBusinessSummary, useCsvExport, useCustomers, useEmailDrafts, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSiteSettings, useSubmissions, useSubscriptions };
4227
+ export { AUDIENCE_PAGE_SIZE, type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsConversionRow, type AnalyticsConversions, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsGoalTargetRow, type AnalyticsGoalTargets, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type Automation, type AutomationCapabilities, type AutomationList, type AutomationStatus, type AutomationStep, type AutomationStepInput, type AutomationStepStats, type AutomationSuggestionKey, type AutomationTrigger, type Broadcast, type BroadcastPlan, type BroadcastStatus, type BroadcastTargeting, type BusinessSummary, type BusinessVisitors, type ContactConsentStatus, ContactImport, type ContactImportProps, type ContactImportReport, type ContactTagRef, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type CurrencyRestatement, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, DOUBLE_OPT_IN_HELP, DashboardView, type DashboardViewProps, EMAIL_ORG_ACTIONS, EMAIL_READINESS_TEXT, type EmailDelivery, type EmailDomainSetupResult, type EmailDraft, type EmailDraftBlock, type EmailDraftKind, type EmailDraftPreview, type EmailOrgAction, type EmailOrgRequest, type EmailResource, type EmailSideStatus, type EmailTemplatePreview, type EmailTemplateRef, type EmailTemplateStatus, type EmailTemplateSummary, EmailView, type EmailViewInitialTab, type EmailViewProps, type EmailViewTab, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, ExportCsvButton, type ExportCsvButtonProps, type ExportOrdersOptions, type ExportPeopleOptions, type ExportRetainersOptions, type ExportSubscriptionsOptions, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type FormsLocation, type FormsTab, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, IMPORT_ATTESTATION, type ImportSkipReason, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoiceSettingsPanel, type InvoiceSettingsPanelProps, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type MarketingContact, type MarketingContactStats, type MarketingContactsPage, type MarketingSettings, type MarketingTag, type NeedsAttentionItem, type NeedsAttentionType, NotificationRecipientsSettings, type NotificationRecipientsSettingsProps, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type PrimaryConversion, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type ShippingRate, type SiteSettings, type StoreInvoiceSettingsInput, StoreSettings, type StoreSettingsProps, type StoreSettingsSection, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateSiteSettingsInput, type UpdateSiteSettingsResult, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseAudienceOptions, type UseAudienceReturn, type UseBroadcastsOptions, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCsvExportOptions, type UseCsvExportReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEmailDraftsOptions, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSiteSettingsOptions, type UseSiteSettingsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, buildEmailOrgRequest, chargedTotal, createApiClient, emailReadinessText, formatPrice, isEmailOrgAction, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useAudience, useBroadcasts, useBusinessSummary, useCsvExport, useCustomers, useEmailDrafts, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSiteSettings, useSubmissions, useSubscriptions };
package/dist/index.d.ts CHANGED
@@ -4,7 +4,7 @@ import * as React from 'react';
4
4
  /**
5
5
  * Email marketing wire types (plan U10), mirroring the aifeatures routes:
6
6
  * marketing-settings-api, audience-api, marketing-drafts-api, broadcasts-api,
7
- * welcome-api and recovery-api.
7
+ * templates-api and automations-api.
8
8
  */
9
9
  interface MarketingSettings {
10
10
  business_name: string | null;
@@ -87,7 +87,7 @@ interface ContactImportReport {
87
87
  reason: ImportSkipReason;
88
88
  }>;
89
89
  }
90
- type EmailDraftKind = 'broadcast' | 'welcome' | 'recovery';
90
+ type EmailDraftKind = 'broadcast' | 'automation' | 'welcome' | 'recovery';
91
91
  type EmailDraftBlock = {
92
92
  type: 'heading';
93
93
  text: string;
@@ -215,38 +215,71 @@ interface Broadcast {
215
215
  unsubscribed: number;
216
216
  };
217
217
  }
218
- interface WelcomeStep {
219
- id: string;
220
- position: number;
221
- delay_days: number;
222
- draft_id: string | null;
223
- published: boolean;
224
- published_version: number | null;
225
- published_at: string | null;
226
- }
227
- interface WelcomeSequence {
228
- active: boolean;
229
- tag_id: string | null;
230
- steps: WelcomeStep[];
231
- }
232
- interface RecoveryStep {
233
- step: number;
218
+ /** An automation's trigger (automations plan R8): joined a list, purchase made, abandoned checkout. */
219
+ type AutomationTrigger = 'joined_list' | 'purchase_made' | 'abandoned_checkout';
220
+ /** Draft has never been on; Off takes no new entries and sends no new steps (emails already queued still go out). */
221
+ type AutomationStatus = 'draft' | 'on' | 'off';
222
+ type AutomationStep = {
223
+ step_key: string;
224
+ type: 'send';
225
+ /** The email: an `automation` draft of this automation. */
234
226
  draft_id: string;
235
- published: boolean;
236
- published_version: number | null;
237
- published_at: string | null;
238
- }
239
- interface RecoveryFlow {
240
- active: boolean;
241
- offsets_hours: number[];
242
- steps: RecoveryStep[];
227
+ subject: string;
228
+ /** The step has a live publication: a save sends the new version to the next people who reach it. */
229
+ live: boolean;
230
+ } | {
231
+ step_key: string;
232
+ type: 'wait';
233
+ wait_hours: number;
234
+ };
235
+ /** A step as a step-list save sends it (the whole list, KTD16). */
236
+ type AutomationStepInput = {
237
+ type: 'send';
238
+ draft_id: string;
239
+ } | {
240
+ type: 'wait';
241
+ wait_hours: number;
242
+ };
243
+ interface Automation {
244
+ id: string;
245
+ name: string;
246
+ trigger_type: AutomationTrigger;
247
+ /** Joined a list only: the list it watches; null is any list. */
248
+ list_tag_id: string | null;
249
+ status: AutomationStatus;
250
+ /** Its trigger takes new entries; an On automation that is not reads as unavailable (R17). */
251
+ available: boolean;
252
+ /** Why it would not take entries or send right now, in fix order: `trigger_unavailable`, `checkout_consent_off`, or a send readiness reason. */
243
253
  blocked_by: string[];
244
- counts: {
245
- abandoned: number;
246
- emailed: number;
247
- recovered: number;
248
- skipped: number;
249
- };
254
+ /** Moves with every write to the automation, its steps or its emails; turn-on sends the one on screen (KTD38). */
255
+ version: number;
256
+ steps: AutomationStep[];
257
+ created_at: string;
258
+ updated_at: string;
259
+ }
260
+ type AutomationSuggestionKey = 'welcome' | 'post_purchase' | 'recovery';
261
+ /** What the site can automate (KTD19). */
262
+ interface AutomationCapabilities {
263
+ store: boolean;
264
+ checkout_consent: 'on' | 'off_available' | 'unavailable';
265
+ usable_triggers: AutomationTrigger[];
266
+ /** One per usable trigger, in display order. */
267
+ suggestions: AutomationSuggestionKey[];
268
+ }
269
+ interface AutomationList {
270
+ automations: Automation[];
271
+ capabilities: AutomationCapabilities;
272
+ }
273
+ /** One email step's stats, summed over every version that has been live (R23). */
274
+ interface AutomationStepStats {
275
+ step_key: string;
276
+ sent: number;
277
+ delivered: number;
278
+ opened: number;
279
+ clicked: number;
280
+ bounced: number;
281
+ complained: number;
282
+ unsubscribed: number;
250
283
  }
251
284
 
252
285
  /** Latest send attempt per kind; delivered means accepted by the recipient's mail server. */
@@ -2215,8 +2248,11 @@ interface AifeaturesApiClient {
2215
2248
  targeting: BroadcastTargeting;
2216
2249
  scheduled_at?: string | null;
2217
2250
  }): Promise<BroadcastPlan>;
2218
- getWelcomeSequence(siteId: string): Promise<WelcomeSequence>;
2219
- getRecoveryFlow(siteId: string): Promise<RecoveryFlow>;
2251
+ /** The site's automations, oldest first, with what the site can automate. */
2252
+ getAutomations(siteId: string): Promise<AutomationList>;
2253
+ getAutomation(siteId: string, automationId: string): Promise<Automation>;
2254
+ /** Each email step's sends, opens and clicks, in step order. */
2255
+ getAutomationStats(siteId: string, automationId: string): Promise<AutomationStepStats[]>;
2220
2256
  }
2221
2257
  declare function createApiClient(siteToken: string, apiUrl?: string): AifeaturesApiClient;
2222
2258
 
@@ -3056,6 +3092,10 @@ type PickImage = () => Promise<PickedImage | null>;
3056
3092
  * - On an aifeatures error, reject with an Error whose `code` is the
3057
3093
  * aifeatures error `code` (`version_conflict`, `over_allowance`,
3058
3094
  * `template_in_use`, `template_archived`, …): the view keys its recovery on it.
3095
+ * Copy the error body's `step_key` (an automation refusal naming the email,
3096
+ * `email_empty` or `postal_address_missing`) and `automation_id`
3097
+ * (`automation_exists`) onto the Error too: the Automations tab links to
3098
+ * that email or automation, and says less without them.
3059
3099
  */
3060
3100
  declare const EMAIL_ORG_ACTIONS: {
3061
3101
  readonly commitBroadcast: {
@@ -3116,6 +3156,30 @@ declare const EMAIL_ORG_ACTIONS: {
3116
3156
  readonly path: "/sites/{siteId}/marketing/templates/{templateId}";
3117
3157
  readonly params: readonly ["templateId"];
3118
3158
  };
3159
+ readonly updateAutomation: {
3160
+ readonly method: "PUT";
3161
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}";
3162
+ readonly params: readonly ["automationId"];
3163
+ };
3164
+ readonly addSuggestedAutomation: {
3165
+ readonly method: "POST";
3166
+ readonly path: "/sites/{siteId}/marketing/automation-suggestions";
3167
+ };
3168
+ readonly turnOnAutomation: {
3169
+ readonly method: "POST";
3170
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}/turn-on";
3171
+ readonly params: readonly ["automationId"];
3172
+ };
3173
+ readonly turnOffAutomation: {
3174
+ readonly method: "POST";
3175
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}/turn-off";
3176
+ readonly params: readonly ["automationId"];
3177
+ };
3178
+ readonly deleteAutomation: {
3179
+ readonly method: "DELETE";
3180
+ readonly path: "/sites/{siteId}/marketing/automations/{automationId}";
3181
+ readonly params: readonly ["automationId"];
3182
+ };
3119
3183
  readonly importContacts: {
3120
3184
  readonly method: "POST";
3121
3185
  readonly path: "/sites/{siteId}/contacts/import";
@@ -3151,60 +3215,6 @@ declare const EMAIL_ORG_ACTIONS: {
3151
3215
  readonly path: "/forms/{formId}";
3152
3216
  readonly params: readonly ["formId"];
3153
3217
  };
3154
- readonly createWelcomeStep: {
3155
- readonly method: "POST";
3156
- readonly path: "/sites/{siteId}/marketing/welcome/steps";
3157
- };
3158
- readonly updateWelcomeStep: {
3159
- readonly method: "PATCH";
3160
- readonly path: "/sites/{siteId}/marketing/welcome/steps/{stepId}";
3161
- readonly params: readonly ["stepId"];
3162
- };
3163
- readonly deleteWelcomeStep: {
3164
- readonly method: "DELETE";
3165
- readonly path: "/sites/{siteId}/marketing/welcome/steps/{stepId}";
3166
- readonly params: readonly ["stepId"];
3167
- };
3168
- readonly publishWelcomeStep: {
3169
- readonly method: "POST";
3170
- readonly path: "/sites/{siteId}/marketing/welcome/steps/{stepId}/publish";
3171
- readonly params: readonly ["stepId"];
3172
- };
3173
- readonly activateWelcome: {
3174
- readonly method: "POST";
3175
- readonly path: "/sites/{siteId}/marketing/welcome/activate";
3176
- };
3177
- readonly pauseWelcome: {
3178
- readonly method: "POST";
3179
- readonly path: "/sites/{siteId}/marketing/welcome/pause";
3180
- };
3181
- readonly updateWelcome: {
3182
- readonly method: "PATCH";
3183
- readonly path: "/sites/{siteId}/marketing/welcome";
3184
- };
3185
- readonly setRecoveryStep: {
3186
- readonly method: "PUT";
3187
- readonly path: "/sites/{siteId}/marketing/recovery/steps/{step}";
3188
- readonly params: readonly ["step"];
3189
- };
3190
- readonly publishRecoveryStep: {
3191
- readonly method: "POST";
3192
- readonly path: "/sites/{siteId}/marketing/recovery/steps/{step}/publish";
3193
- readonly params: readonly ["step"];
3194
- };
3195
- readonly deleteRecoveryStep: {
3196
- readonly method: "DELETE";
3197
- readonly path: "/sites/{siteId}/marketing/recovery/steps/{step}";
3198
- readonly params: readonly ["step"];
3199
- };
3200
- readonly activateRecovery: {
3201
- readonly method: "POST";
3202
- readonly path: "/sites/{siteId}/marketing/recovery/activate";
3203
- };
3204
- readonly pauseRecovery: {
3205
- readonly method: "POST";
3206
- readonly path: "/sites/{siteId}/marketing/recovery/pause";
3207
- };
3208
3218
  };
3209
3219
  type EmailOrgAction = keyof typeof EMAIL_ORG_ACTIONS;
3210
3220
  interface EmailOrgRequest {
@@ -3260,6 +3270,12 @@ interface EmailViewProps extends EmailSiteInfo {
3260
3270
  initialDraftId?: string;
3261
3271
  /** Deep link (`show_view('email', {tab})`): open this tab. The old `template` opens Templates. */
3262
3272
  initialTab?: EmailViewInitialTab;
3273
+ /**
3274
+ * Deep link (`show_view('email', {automation_id})`): open this automation's
3275
+ * canvas on the Automations tab; an id the site no longer has opens the
3276
+ * list. Wins over `initialTab`.
3277
+ */
3278
+ initialAutomationId?: string;
3263
3279
  /**
3264
3280
  * Deep link (`show_view('email', {template_id})`): open this template;
3265
3281
  * `standard` is the built-in one, and an id the site no longer has opens the
@@ -3292,6 +3308,8 @@ interface EmailViewProps extends EmailSiteInfo {
3292
3308
  onTurnOn?: () => Promise<void>;
3293
3309
  /** Open the host's Settings → Store, where checkout marketing consent lives. */
3294
3310
  onOpenStoreSettings?: () => void;
3311
+ /** Open the host's Settings → Branding, where the logo every email shows lives. */
3312
+ onOpenBrandSettings?: () => void;
3295
3313
  /**
3296
3314
  * Bump to refetch everything the view shows in place (an agent turn changed
3297
3315
  * email data). Keeps the open tab and never overwrites a draft edit the
@@ -3305,7 +3323,8 @@ type EmailViewTab = "audience" | "broadcasts" | "automations" | "templates" | "s
3305
3323
  type EmailViewInitialTab = EmailViewTab | "template";
3306
3324
  /**
3307
3325
  * EmailView — the merchant's email marketing view (plan U10; email templates
3308
- * U15): audience, broadcasts, templates and settings.
3326
+ * U15; automations U6): audience, broadcasts, automations, templates and
3327
+ * settings.
3309
3328
  * Reads use the site token; every write goes through `onOrgAction`.
3310
3329
  */
3311
3330
  /**
@@ -4205,4 +4224,4 @@ interface DashboardViewProps {
4205
4224
  */
4206
4225
  declare function DashboardView({ refreshKey, onBackToWebsite, primaryConversion, onChangePrimaryConversion, onOpenSurface, needsPaidPlan, onUpgradePlan, onConnectStripe, }: DashboardViewProps): react_jsx_runtime.JSX.Element;
4207
4226
 
4208
- export { AUDIENCE_PAGE_SIZE, type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsConversionRow, type AnalyticsConversions, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsGoalTargetRow, type AnalyticsGoalTargets, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type Broadcast, type BroadcastPlan, type BroadcastStatus, type BroadcastTargeting, type BusinessSummary, type BusinessVisitors, type ContactConsentStatus, ContactImport, type ContactImportProps, type ContactImportReport, type ContactTagRef, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type CurrencyRestatement, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, DOUBLE_OPT_IN_HELP, DashboardView, type DashboardViewProps, EMAIL_ORG_ACTIONS, EMAIL_READINESS_TEXT, type EmailDelivery, type EmailDomainSetupResult, type EmailDraft, type EmailDraftBlock, type EmailDraftKind, type EmailDraftPreview, type EmailOrgAction, type EmailOrgRequest, type EmailResource, type EmailSideStatus, type EmailTemplatePreview, type EmailTemplateRef, type EmailTemplateStatus, type EmailTemplateSummary, EmailView, type EmailViewInitialTab, type EmailViewProps, type EmailViewTab, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, ExportCsvButton, type ExportCsvButtonProps, type ExportOrdersOptions, type ExportPeopleOptions, type ExportRetainersOptions, type ExportSubscriptionsOptions, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type FormsLocation, type FormsTab, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, IMPORT_ATTESTATION, type ImportSkipReason, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoiceSettingsPanel, type InvoiceSettingsPanelProps, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type MarketingContact, type MarketingContactStats, type MarketingContactsPage, type MarketingSettings, type MarketingTag, type NeedsAttentionItem, type NeedsAttentionType, NotificationRecipientsSettings, type NotificationRecipientsSettingsProps, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type PrimaryConversion, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RecoveryFlow, type RecoveryStep, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type ShippingRate, type SiteSettings, type StoreInvoiceSettingsInput, StoreSettings, type StoreSettingsProps, type StoreSettingsSection, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateSiteSettingsInput, type UpdateSiteSettingsResult, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseAudienceOptions, type UseAudienceReturn, type UseBroadcastsOptions, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCsvExportOptions, type UseCsvExportReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEmailDraftsOptions, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSiteSettingsOptions, type UseSiteSettingsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, type WelcomeSequence, type WelcomeStep, buildEmailOrgRequest, chargedTotal, createApiClient, emailReadinessText, formatPrice, isEmailOrgAction, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useAudience, useBroadcasts, useBusinessSummary, useCsvExport, useCustomers, useEmailDrafts, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSiteSettings, useSubmissions, useSubscriptions };
4227
+ export { AUDIENCE_PAGE_SIZE, type AdjustInventoryInput, type AifeaturesApiClient, AifeaturesApiError, type AifeaturesContextValue, AifeaturesProvider, type AifeaturesProviderProps, type AnalyticsBreakdown, type AnalyticsBreakdownName, type AnalyticsBreakdownRow, type AnalyticsChannelRow, type AnalyticsChannels, type AnalyticsConversionRow, type AnalyticsConversions, type AnalyticsFilter, type AnalyticsFilterDimension, type AnalyticsGoalTargetRow, type AnalyticsGoalTargets, type AnalyticsPeriod, type AnalyticsRealtime, type AnalyticsSourced, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsSummaryData, type AnalyticsSummaryMetrics, type AnalyticsTimeseries, type AnalyticsTimeseriesRow, AnalyticsView, type AnalyticsViewProps, type ApiError, type Attachment, type Automation, type AutomationCapabilities, type AutomationList, type AutomationStatus, type AutomationStep, type AutomationStepInput, type AutomationStepStats, type AutomationSuggestionKey, type AutomationTrigger, type Broadcast, type BroadcastPlan, type BroadcastStatus, type BroadcastTargeting, type BusinessSummary, type BusinessVisitors, type ContactConsentStatus, ContactImport, type ContactImportProps, type ContactImportReport, type ContactTagRef, type CreateEventDestinationInput, type CreateFormInput, type CreateOptionInput, type CreateProductInput, type CreatePromoInput, type CreateVariantInput, type CurrencyRestatement, type Customer, type CustomerAddress, CustomerDetail, type CustomerDetail$1 as CustomerDetailData, type CustomerDetailProps, CustomersList, type CustomersListProps, type CustomersListResponse, DOUBLE_OPT_IN_HELP, DashboardView, type DashboardViewProps, EMAIL_ORG_ACTIONS, EMAIL_READINESS_TEXT, type EmailDelivery, type EmailDomainSetupResult, type EmailDraft, type EmailDraftBlock, type EmailDraftKind, type EmailDraftPreview, type EmailOrgAction, type EmailOrgRequest, type EmailResource, type EmailSideStatus, type EmailTemplatePreview, type EmailTemplateRef, type EmailTemplateStatus, type EmailTemplateSummary, EmailView, type EmailViewInitialTab, type EmailViewProps, type EmailViewTab, type EventDeliveriesListResponse, type EventDelivery, type EventDestination, type EventDestinationSecretResponse, type EventDestinationsListResponse, ExportCsvButton, type ExportCsvButtonProps, type ExportOrdersOptions, type ExportPeopleOptions, type ExportRetainersOptions, type ExportSubscriptionsOptions, type Form, FormSettings, type FormSettingsProps, FormSubmissions, type FormSubmissionsProps, FormsDashboard, type FormsDashboardProps, FormsList, type FormsListProps, type FormsListResponse, type FormsLocation, type FormsTab, type GetBusinessSummaryOptions, type GetCustomersOptions, type GetInvoicesOptions, type GetOrdersOptions, type GetPeopleOptions, type GetProductsOptions, type GetSubmissionsOptions, type GetSubscriptionsOptions, IMPORT_ATTESTATION, type ImportSkipReason, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceDeliveryState, InvoiceDetail, type InvoiceDetailProps, type InvoiceLabel, InvoiceLabelBadge, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, InvoiceSettingsPanel, type InvoiceSettingsPanelProps, InvoicesList, type InvoicesListProps, InvoicesView, type InvoicesViewProps, LeadsView, type LeadsViewProps, type LowStockProduct, MAX_ANALYTICS_FILTERS, MAX_ANALYTICS_FILTER_VALUES, type MarketingContact, type MarketingContactStats, type MarketingContactsPage, type MarketingSettings, type MarketingTag, type NeedsAttentionItem, type NeedsAttentionType, NotificationRecipientsSettings, type NotificationRecipientsSettingsProps, type Order, OrderDetail, type OrderDetailProps, type OrderStatus, OrderStatusBadge, OrdersList, type OrdersListProps, OrdersView, type OrdersViewProps, type PaginatedInvoices, type PaginatedOrders, type PaginatedSubmissions, type PaginatedSubscriptions, PaymentsDashboard, type PaymentsDashboardProps, PaymentsSetup, type PaymentsSetupProps, type PaymentsStatus, type PaymentsStatusReason, type PaymentsStatusResponse, type PeopleListResponse, type Person, type PersonDetail, type PersonOrder, type PersonSource, type PersonSubmission, type PrimaryConversion, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentType, type ProductOption, ProductSettings, type ProductSettingsProps, type ProductStats, type ProductVariant, ProductsList, type ProductsListProps, type ProductsListResponse, ProductsView, type ProductsViewProps, type Promo, type PromosListResponse, PromosPanel, REALTIME_FAILURES_BEFORE_ERROR, REALTIME_POLL_MS, type RefundRequest, type ReportSlot, RetainerStatusBadge, RetainersPanel, type RetainersPanelProps, type RevenueCurrencyTotal, type RevenuePeriod, type SetInventoryInput, type SetOrderFulfillmentInput, type SettledRevenue, type ShippingRate, type SiteSettings, type StoreInvoiceSettingsInput, StoreSettings, type StoreSettingsProps, type StoreSettingsSection, type Submission, SubmissionDetail, type SubmissionDetailProps, type SubmissionMetadata, type Subscription, SubscriptionsView, type SubscriptionsViewProps, type UpdateEventDestinationInput, type UpdateFormInput, type UpdateOptionInput, type UpdateProductInput, type UpdateSiteSettingsInput, type UpdateSiteSettingsResult, type UpdateVariantInput, type UseAnalyticsOptions, type UseAnalyticsReturn, type UseAudienceOptions, type UseAudienceReturn, type UseBroadcastsOptions, type UseBusinessSummaryOptions, type UseBusinessSummaryReturn, type UseCsvExportOptions, type UseCsvExportReturn, type UseCustomersOptions, type UseCustomersReturn, type UseEmailDraftsOptions, type UseEventDestinationsReturn, type UseFormsReturn, type UseInvoicesOptions, type UseInvoicesReturn, type UseOrdersOptions, type UseOrdersReturn, type UsePaymentsStatusReturn, type UsePeopleOptions, type UsePeopleReturn, type UsePersonOptions, type UsePersonReturn, type UseProductsOptions, type UseProductsReturn, type UseRealtimeVisitorsReturn, type UseSiteSettingsOptions, type UseSiteSettingsReturn, type UseSubmissionsOptions, type UseSubmissionsReturn, type UseSubscriptionsOptions, type UseSubscriptionsReturn, type VariantInventory, type VariantOptionValue, VariantsEditor, type VariantsEditorProps, ViewShell, type ViewShellProps, WebhookDeliveries, type WebhookDeliveriesProps, WebhookSettings, type WebhookSettingsProps, buildEmailOrgRequest, chargedTotal, createApiClient, emailReadinessText, formatPrice, isEmailOrgAction, isZeroDecimalCurrency, toMajorUnits, toMinorUnits, useAifeaturesContext as useAifeatures, useAifeaturesContext, useAnalytics, useAudience, useBroadcasts, useBusinessSummary, useCsvExport, useCustomers, useEmailDrafts, useEventDestinations, useForms, useInvoices, useOrders, usePaymentsStatus, usePeople, usePerson, useProducts, useRealtimeVisitors, useRetainers, useSiteSettings, useSubmissions, useSubscriptions };