arky-sdk 0.9.6 → 0.9.11
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/README.md +113 -194
- package/dist/{admin-DjYydKeB.d.ts → admin-BKXmDIVk.d.ts} +412 -405
- package/dist/{admin-DlL8mCxL.d.cts → admin-CAwQrMOX.d.cts} +412 -405
- package/dist/admin.cjs +767 -373
- package/dist/admin.cjs.map +1 -1
- package/dist/admin.d.cts +3 -3
- package/dist/admin.d.ts +3 -3
- package/dist/admin.js +767 -373
- package/dist/admin.js.map +1 -1
- package/dist/{api-BbBHcd4p.d.cts → api-DJI3S6XA.d.cts} +1440 -525
- package/dist/{api-BbBHcd4p.d.ts → api-DJI3S6XA.d.ts} +1440 -525
- package/dist/{index-CZxubTDA.d.ts → index-BaSBPLdF.d.ts} +1 -1
- package/dist/{index-nCF3Z6Af.d.cts → index-u-gjHnKs.d.cts} +1 -1
- package/dist/index.cjs +874 -471
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +874 -471
- package/dist/index.js.map +1 -1
- package/dist/storefront.cjs +493 -300
- package/dist/storefront.cjs.map +1 -1
- package/dist/storefront.d.cts +172 -89
- package/dist/storefront.d.ts +172 -89
- package/dist/storefront.js +491 -299
- package/dist/storefront.js.map +1 -1
- package/dist/types.cjs.map +1 -1
- package/dist/types.d.cts +1 -1
- package/dist/types.d.ts +1 -1
- package/dist/types.js.map +1 -1
- package/dist/utils.d.cts +2 -2
- package/dist/utils.d.ts +2 -2
- package/package.json +7 -10
- package/scripts/contract-admin.mjs +137 -0
- package/scripts/contract-storefront.mjs +296 -0
- package/dist/storefront-store.cjs +0 -2809
- package/dist/storefront-store.cjs.map +0 -1
- package/dist/storefront-store.d.cts +0 -5
- package/dist/storefront-store.d.ts +0 -5
- package/dist/storefront-store.js +0 -2807
- package/dist/storefront-store.js.map +0 -1
- package/scripts/smoke-store.mjs +0 -41
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
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-
|
|
1
|
+
import { w as GetCurrentCartParams, R as RequestOptions$1, C as Cart, x as GetCartParams, U as UpdateCartParams, y as AddCartItemParams, z as RemoveCartItemParams, D as ClearCartParams, Q as QuoteCartParams, f as OrderQuote, H as CheckoutCartParams, O as OrderCheckoutResult, ab as Contact, k as Store, M as Market, ac as UpdateAccountContactParams, ad as AccountUpdateResponse, ae as DeleteAccountParams, af as GetMeParams, ag as Account, ah as SearchAccountsParams, ai as MagicLinkVerifyParams, aj as AuthToken, ak as CreateStoreParams, al as UpdateStoreParams, am as DeleteStoreParams, an as GetStoreParams, ao as GetStoresParams, o as PaginatedResponse, ap as GetSubscriptionPlansParams, aq as SubscriptionPlan, ar as SubscribeParams, as as CreatePortalSessionParams, at as AddMemberParams, au as RemoveMemberParams, av as ListBuildHooksParams, aw as BuildHook, ax as CreateBuildHookParams, ay as UpdateBuildHookParams, az as DeleteBuildHookParams, aA as TestWebhookParams, aB as ListWebhooksParams, aC as Webhook, aD as CreateWebhookParams, aE as UpdateWebhookParams, aF as DeleteWebhookParams, aG as StoreRuntimeConfig, aH as FindStoreMediaParams, aI as Media, L as Location, aJ as CreateLocationParams, aK as UpdateLocationParams, aL as DeleteLocationParams, aM as CreateMarketParams, aN as UpdateMarketParams, aO as DeleteMarketParams, aP as ListPaymentProvidersParams, aQ as PaymentProvider, aR as RefreshPaymentProvidersParams, aS as ConnectStripePaymentProviderParams, aT as StripePaymentProviderConnectResponse, aU as DeletePaymentProviderParams, aV as GetMediaParams, aW as UploadStoreMediaParams, aX as DeleteStoreMediaParams, aY as GetStoreMediaParams, aZ as UpdateMediaParams, a_ as TrackEmailOpenParams, a$ as TriggerNotificationParams, b0 as CreateMailboxParams, b1 as Mailbox, b2 as UpdateMailboxParams, b3 as GetMailboxParams, b4 as TestMailboxParams, b5 as TestMailboxResult, b6 as PrepareMailboxParams, b7 as FindMailboxesParams, b8 as GetSocialCapabilitiesParams, b9 as SocialProviderCapability, ba as ListSocialAccountsParams, bb as SocialAccount, bc as ConnectSocialAccountParams, bd as SocialConnectResponse, be as GetSocialOAuthAttemptParams, bf as SocialOAuthCallbackResponse, bg as SelectSocialDestinationParams, bh as DeleteSocialAccountParams, bi as CreateSocialPublicationParams, bj as SocialPublicationMutationResponse, bk as UpdateSocialPublicationParams, bl as GetSocialPublicationParams, bm as SocialPublication, bn as FindSocialPublicationsParams, bo as ValidateSocialPublicationParams, bp as SocialPublicationValidation, bq as ScheduleSocialPublicationParams, br as CancelSocialPublicationParams, bs as GetSocialPublicationCommentsParams, bt as SocialPublicationComment, bu as SyncSocialPublicationCommentsParams, bv as GetSocialPublicationCommentThreadParams, bw as SyncSocialPublicationCommentThreadParams, bx as FindSocialPublicationCommentsParams, by as ClassifySocialPublicationCommentsParams, bz as SocialPublicationCommentClassificationResult, bA as ReplySocialPublicationCommentParams, bB as SocialPublicationCommentReplyResponse, bC as GetSocialPublicationMetricsParams, bD as SocialPublicationMetricSnapshot, bE as SyncSocialPublicationMetricsParams, bF as SyncSocialEngagementParams, bG as SocialPublicationEngagementSyncResult, bH as CreateCollectionParams, l as Collection, bI as UpdateCollectionParams, bJ as DeleteCollectionParams, G as GetCollectionParams, bK as GetCollectionsParams, bL as CreateEntryParams, a as CollectionEntry, bM as UpdateEntryParams, bN as DeleteEntryParams, m as GetEntryParams, n as GetEntriesParams, bO as CreateFormParams, b as Form, bP as UpdateFormParams, bQ as DeleteFormParams, p as GetFormParams, bR as GetFormsParams, q as SubmitFormParams, r as FormSubmission, bS as GetFormSubmissionsParams, bT as GetFormSubmissionParams, bU as UpdateFormSubmissionParams, bV as CreateTaxonomyParams, T as Taxonomy, bW as UpdateTaxonomyParams, bX as DeleteTaxonomyParams, s as GetTaxonomyParams, bY as GetTaxonomiesParams, t as GetTaxonomyChildrenParams, bZ as CreateEmailTemplateParams, b_ as EmailTemplate, b$ as UpdateEmailTemplateParams, c0 as DeleteEmailTemplateParams, c1 as GetEmailTemplateParams, c2 as GetEmailTemplatesParams, c3 as PreviewEmailTemplateParams, c4 as PreviewEmailTemplateResponse, c5 as CreateProductParams, c as Product, c6 as UpdateProductParams, c7 as DeleteProductParams, u as GetProductParams, v as GetProductsParams, c8 as UpdateOrderParams, J as Order, I as GetOrderParams, K as GetOrdersParams, c9 as GetQuoteParams, ca as ProcessOrderRefundParams, cb as ProcessOrderRefundResponse, N as DownloadDigitalAccessParams, V as DigitalAccessDownloadResponse, cc as GetShippingRatesParams, cd as ShippingRate, ce as ShipParams, cf as ShipResult, cg as CreateCartParams, ch as FindCartsParams, ci as CreateServiceParams, S as Service, cj as UpdateServiceParams, ck as DeleteServiceParams, W as GetServiceParams, X as GetServicesParams, _ as GetAvailabilityParams, e as AvailabilityResponse, Y as FindServiceProvidersParams, cl as ServiceProvider, cm as CreateServiceProviderParams, cn as UpdateServiceProviderParams, co as DeleteServiceProviderParams, cp as CreateProviderParams, d as Provider, cq as UpdateProviderParams, cr as DeleteProviderParams, $ as GetProviderParams, a0 as GetProvidersParams, cs as CreatePromoCodeParams, ct as PromoCode, cu as UpdatePromoCodeParams, cv as DeletePromoCodeParams, cw as GetPromoCodeParams, cx as GetPromoCodesParams, cy as CreateContactParams, cz as Contact$1, cA as GetContactParams, j as ContactDetail, cB as FindContactsParams, cC as UpdateContactParams, cD as MergeContactsParams, cE as ImportContactsParams, cF as ImportContactsResult, cG as CreateContactListParams, a2 as ContactList, cH as UpdateContactListParams, a1 as GetContactListParams, a3 as FindContactListsParams, cI as ImportContactsIntoContactListParams, cJ as ImportContactsIntoContactListResult, cK as ImportContactListPreviewParams, cL as ImportContactsPreviewResult, cM as AddContactListContactParams, cN as ContactListMember, cO as UpdateContactListContactParams, cP as RemoveContactListContactParams, cQ as FindContactListContactsParams, cR as Action, cS as FindActionsParams, cT as CreateCampaignParams, cU as Campaign, cV as UpdateCampaignParams, cW as GetCampaignParams, cX as FindCampaignsParams, cY as LaunchCampaignParams, cZ as DuplicateCampaignParams, c_ as GetCampaignLaunchReadinessParams, c$ as CampaignLaunchReadiness, d0 as ImportCampaignEnrollmentsParams, d1 as CampaignEnrollmentImportResult, d2 as GenerateOutreachPersonalizedDraftsParams, d3 as FindCampaignEnrollmentsParams, d4 as CampaignEnrollment, d5 as GetCampaignEnrollmentConversationParams, d6 as CampaignEnrollmentConversationResponse, d7 as UpdateCampaignEnrollmentParams, d8 as UpdateCampaignEnrollmentDraftParams, d9 as UpdateCampaignEnrollmentStepExecutionParams, da as ReplyCampaignEnrollmentParams, db as StopCampaignEnrollmentParams, dc as FindCampaignMessagesParams, dd as CampaignMessage, de as UpdateCampaignMessageParams, df as CreateSuppressionParams, dg as Suppression, dh as UpdateSuppressionParams, di as GetSuppressionParams, dj as FindSuppressionsParams, dk as CreateLeadResearchRunParams, dl as LeadResearchRun, dm as FindLeadResearchRunsParams, dn as GetLeadResearchRunParams, dp as UpdateLeadResearchRunParams, dq as CancelLeadResearchRunParams, dr as SendLeadResearchMessageParams, ds as SendLeadResearchMessageResult, dt as FindLeadResearchMessagesParams, du as LeadResearchMessage, dv as ValidateLeadEmailParams, dw as LeadEmailValidationResult, dx as CreateWorkflowParams, dy as Workflow, dz as UpdateWorkflowParams, dA as DeleteWorkflowParams, dB as GetWorkflowParams, dC as GetWorkflowsParams, dD as TriggerWorkflowParams, dE as WorkflowExecution, dF as GetWorkflowExecutionsParams, dG as GetWorkflowExecutionParams, dH as GetWorkflowAccountsParams, dI as WorkflowAccount, dJ as GetWorkflowAccountConnectUrlParams, dK as WorkflowAccountConnectUrl, dL as ConnectWorkflowAccountParams, dM as DeleteWorkflowAccountParams, a4 as SubscribeContactListParams, a5 as ContactListSubscribeResponse, a6 as ContactListAccessParams, a7 as ContactListAccessResponse } from './api-DJI3S6XA.cjs';
|
|
2
|
+
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-u-gjHnKs.cjs';
|
|
3
3
|
|
|
4
4
|
interface CartApi {
|
|
5
5
|
current(params?: GetCurrentCartParams, options?: RequestOptions$1): Promise<Cart>;
|
|
@@ -54,43 +54,111 @@ interface CartController {
|
|
|
54
54
|
}
|
|
55
55
|
declare function createCartController(cartApi: CartApi): CartController;
|
|
56
56
|
|
|
57
|
-
type
|
|
57
|
+
type ContactToken = {
|
|
58
58
|
id: string;
|
|
59
59
|
token: string;
|
|
60
60
|
created_at: number;
|
|
61
61
|
};
|
|
62
62
|
type IdentifyResponse = {
|
|
63
|
-
|
|
64
|
-
token:
|
|
63
|
+
contact: Contact;
|
|
64
|
+
token: ContactToken;
|
|
65
65
|
store: Store;
|
|
66
66
|
market: Market | null;
|
|
67
67
|
code_sent: boolean;
|
|
68
68
|
};
|
|
69
|
-
type VerifyResponse =
|
|
70
|
-
interface
|
|
69
|
+
type VerifyResponse = ContactToken;
|
|
70
|
+
interface StorefrontAction {
|
|
71
71
|
store_id: string;
|
|
72
|
-
|
|
73
|
-
|
|
72
|
+
contact_id: string;
|
|
73
|
+
key: string;
|
|
74
|
+
type?: string;
|
|
74
75
|
payload: Record<string, unknown>;
|
|
75
76
|
created_at: number;
|
|
76
77
|
}
|
|
77
|
-
|
|
78
|
+
type TrackActionParams = {
|
|
79
|
+
key: string;
|
|
80
|
+
type?: string;
|
|
81
|
+
payload?: Record<string, unknown>;
|
|
82
|
+
} | {
|
|
78
83
|
type: string;
|
|
84
|
+
key?: string;
|
|
79
85
|
payload?: Record<string, unknown>;
|
|
86
|
+
};
|
|
87
|
+
declare const COMMON_ACTION_KEYS: readonly ["page.view", "product.view", "service.view", "provider.view", "cart.added", "cart.removed", "checkout.started", "order.created", "signin", "signup", "verified.email", "search", "share", "wishlist.added"];
|
|
88
|
+
type CommonActionKey = (typeof COMMON_ACTION_KEYS)[number];
|
|
89
|
+
interface UseExperimentParams {
|
|
90
|
+
key: string;
|
|
91
|
+
store_id?: string;
|
|
92
|
+
}
|
|
93
|
+
interface ExperimentUseResponse {
|
|
94
|
+
experiment_key: string;
|
|
95
|
+
experiment_version: number;
|
|
96
|
+
variant_key: string;
|
|
97
|
+
goal_action_key: string;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
type ExperimentStatus = "draft" | "running" | "paused" | "completed";
|
|
101
|
+
interface ExperimentVariant {
|
|
102
|
+
key: string;
|
|
103
|
+
weight: number;
|
|
104
|
+
}
|
|
105
|
+
interface Experiment {
|
|
106
|
+
id: string;
|
|
107
|
+
store_id: string;
|
|
108
|
+
key: string;
|
|
109
|
+
status: ExperimentStatus;
|
|
110
|
+
version: number;
|
|
111
|
+
goal_action_key: string;
|
|
112
|
+
variants: ExperimentVariant[];
|
|
113
|
+
created_at: number;
|
|
114
|
+
updated_at: number;
|
|
115
|
+
}
|
|
116
|
+
interface CreateExperimentParams {
|
|
117
|
+
store_id?: string;
|
|
118
|
+
key: string;
|
|
119
|
+
goal_action_key: string;
|
|
120
|
+
variants: ExperimentVariant[];
|
|
121
|
+
status?: ExperimentStatus;
|
|
122
|
+
}
|
|
123
|
+
interface UpdateExperimentParams {
|
|
124
|
+
store_id?: string;
|
|
125
|
+
key: string;
|
|
126
|
+
goal_action_key?: string;
|
|
127
|
+
variants?: ExperimentVariant[];
|
|
128
|
+
status?: ExperimentStatus;
|
|
129
|
+
}
|
|
130
|
+
interface GetExperimentParams {
|
|
131
|
+
store_id?: string;
|
|
132
|
+
key: string;
|
|
133
|
+
}
|
|
134
|
+
interface FindExperimentsParams {
|
|
135
|
+
store_id?: string;
|
|
136
|
+
limit?: number;
|
|
137
|
+
cursor?: string;
|
|
138
|
+
}
|
|
139
|
+
interface ExperimentVariantResult {
|
|
140
|
+
variant_key: string;
|
|
141
|
+
weight: number;
|
|
142
|
+
shown: number;
|
|
143
|
+
wins: number;
|
|
144
|
+
conversion_rate: number;
|
|
145
|
+
}
|
|
146
|
+
interface ExperimentResults {
|
|
147
|
+
experiment: Experiment;
|
|
148
|
+
variants: ExperimentVariantResult[];
|
|
149
|
+
winning_variant_key?: string | null;
|
|
80
150
|
}
|
|
81
|
-
declare const COMMON_ACTIVITY_TYPES: readonly ["page_view", "product_view", "service_view", "provider_view", "cart_added", "cart_removed", "checkout_started", "purchase", "order_created", "signin", "signup", "verified_email", "search", "share", "wishlist_added"];
|
|
82
|
-
type CommonActivityType = (typeof COMMON_ACTIVITY_TYPES)[number];
|
|
83
151
|
|
|
84
152
|
interface AnalyticsTimeRange {
|
|
85
153
|
from: number;
|
|
86
154
|
to: number;
|
|
87
155
|
}
|
|
88
|
-
type AnalyticsReportKey = "business_overview" | "
|
|
89
|
-
type
|
|
156
|
+
type AnalyticsReportKey = "business_overview" | "contact_funnel" | "outreach_overview" | "outreach_funnel" | "action_by_country" | "top_action_pages" | "entity_status_overview" | "data_health" | "orders_created" | "contacts_created" | "form_submissions_created" | "carts_abandoned" | "campaign_messages_sent" | "campaign_messages_received" | "suppressions_created" | "media_count" | "products_by_status" | "services_by_status" | "providers_by_status" | "collections_by_status" | "entries_by_status" | "contacts_by_status" | "contact_lists_by_status" | "mailboxes_by_status" | "campaigns_by_status" | "campaign_enrollments_by_status" | "campaign_messages_by_status" | "support_conversations_by_status" | "lead_research_runs_by_status" | "suppressions_by_status" | "workflows_by_status" | "promo_codes_by_status" | "email_templates_by_status" | "forms_by_status" | "taxonomies_by_status" | "carts_by_status" | "orders_by_status" | "order_items_by_status" | "recent_action";
|
|
157
|
+
type ActionFeedCategory = "orders" | "carts" | "promo_codes" | "submissions" | "contacts" | "contact_lists" | "products" | "services" | "providers" | "cms" | "workflows" | "actions";
|
|
90
158
|
interface AnalyticsReportRequest {
|
|
91
159
|
key: AnalyticsReportKey;
|
|
92
160
|
limit?: number;
|
|
93
|
-
category?:
|
|
161
|
+
category?: ActionFeedCategory;
|
|
94
162
|
cursor_created_at?: number;
|
|
95
163
|
cursor_id?: string;
|
|
96
164
|
}
|
|
@@ -112,7 +180,7 @@ interface AnalyticsBreakdownItem {
|
|
|
112
180
|
key: string;
|
|
113
181
|
label: string;
|
|
114
182
|
value: number;
|
|
115
|
-
|
|
183
|
+
unique_contacts?: number;
|
|
116
184
|
unique_visitors?: number;
|
|
117
185
|
}
|
|
118
186
|
interface AnalyticsBreakdownData {
|
|
@@ -121,11 +189,11 @@ interface AnalyticsBreakdownData {
|
|
|
121
189
|
interface BusinessOverviewData {
|
|
122
190
|
visitors: number;
|
|
123
191
|
new_visitors: number;
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
192
|
+
known_contacts: number;
|
|
193
|
+
new_known_contacts: number;
|
|
194
|
+
email_known_contacts: number;
|
|
195
|
+
verified_contacts: number;
|
|
196
|
+
new_verified_contacts: number;
|
|
129
197
|
buyers: number;
|
|
130
198
|
orders: number;
|
|
131
199
|
revenue: number;
|
|
@@ -143,30 +211,30 @@ interface RevenueByCurrencyData {
|
|
|
143
211
|
revenue: number;
|
|
144
212
|
average_order_value: number;
|
|
145
213
|
}
|
|
146
|
-
interface
|
|
147
|
-
key: "visitors" | "
|
|
214
|
+
interface ContactFunnelStage {
|
|
215
|
+
key: "visitors" | "email_known_contacts" | "verified_contacts" | "buyers" | string;
|
|
148
216
|
label: string;
|
|
149
217
|
value: number;
|
|
150
218
|
}
|
|
151
|
-
interface
|
|
152
|
-
stages:
|
|
219
|
+
interface ContactFunnelData {
|
|
220
|
+
stages: ContactFunnelStage[];
|
|
153
221
|
visitor_to_known_rate?: number;
|
|
154
222
|
visitor_to_buyer_rate?: number;
|
|
155
223
|
}
|
|
156
224
|
interface OutreachOverviewData {
|
|
157
|
-
|
|
158
|
-
|
|
225
|
+
contact_lists: number;
|
|
226
|
+
active_contact_lists: number;
|
|
159
227
|
mailboxes: number;
|
|
160
228
|
active_mailboxes: number;
|
|
161
229
|
campaigns: number;
|
|
162
230
|
active_campaigns: number;
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
231
|
+
campaign_enrollments: number;
|
|
232
|
+
new_campaign_enrollments: number;
|
|
233
|
+
active_campaign_enrollments: number;
|
|
234
|
+
completed_campaign_enrollments: number;
|
|
235
|
+
replied_campaign_enrollments: number;
|
|
236
|
+
suppressed_campaign_enrollments: number;
|
|
237
|
+
failed_campaign_enrollments: number;
|
|
170
238
|
campaign_messages_sent: number;
|
|
171
239
|
outreach_bounces: number;
|
|
172
240
|
campaign_messages_received: number;
|
|
@@ -178,7 +246,7 @@ interface OutreachOverviewData {
|
|
|
178
246
|
suppression_rate: number;
|
|
179
247
|
}
|
|
180
248
|
interface OutreachFunnelStage {
|
|
181
|
-
key: "
|
|
249
|
+
key: "contact_lists" | "campaigns" | "campaign_enrollments" | "campaign_messages_sent" | "outreach_bounces" | "campaign_messages_received" | string;
|
|
182
250
|
label: string;
|
|
183
251
|
value: number;
|
|
184
252
|
}
|
|
@@ -188,40 +256,24 @@ interface OutreachFunnelData {
|
|
|
188
256
|
bounce_rate?: number;
|
|
189
257
|
suppression_rate?: number;
|
|
190
258
|
}
|
|
191
|
-
interface OutreachVariantPerformanceItem {
|
|
192
|
-
campaign_id: string;
|
|
193
|
-
step_id: string;
|
|
194
|
-
step_position: number;
|
|
195
|
-
step_variant_id: string;
|
|
196
|
-
step_variant_name: string;
|
|
197
|
-
sent: number;
|
|
198
|
-
bounced: number;
|
|
199
|
-
failed: number;
|
|
200
|
-
replies: number;
|
|
201
|
-
reply_rate: number;
|
|
202
|
-
bounce_rate: number;
|
|
203
|
-
}
|
|
204
|
-
interface OutreachVariantPerformanceData {
|
|
205
|
-
variants: OutreachVariantPerformanceItem[];
|
|
206
|
-
}
|
|
207
259
|
interface EntityStatusOverviewData {
|
|
208
260
|
entities: Record<string, AnalyticsBreakdownItem[]>;
|
|
209
261
|
}
|
|
210
262
|
interface DataHealthData {
|
|
211
|
-
|
|
212
|
-
|
|
263
|
+
anonymous_contacts: number;
|
|
264
|
+
known_contacts: number;
|
|
213
265
|
duplicate_emails: number;
|
|
214
266
|
unknown_country_events: number;
|
|
215
267
|
unknown_device_events: number;
|
|
216
268
|
}
|
|
217
|
-
interface
|
|
269
|
+
interface ActionFeedItem {
|
|
218
270
|
id: string;
|
|
219
271
|
entity: string;
|
|
220
272
|
entity_id: string;
|
|
221
273
|
action: string;
|
|
222
274
|
event_type: string;
|
|
223
275
|
status: string;
|
|
224
|
-
|
|
276
|
+
contact_id: string;
|
|
225
277
|
category: string;
|
|
226
278
|
title: string;
|
|
227
279
|
description: string;
|
|
@@ -230,12 +282,12 @@ interface ActivityFeedItem {
|
|
|
230
282
|
payload: unknown;
|
|
231
283
|
created_at: number;
|
|
232
284
|
}
|
|
233
|
-
interface
|
|
285
|
+
interface ActionFeedSummary {
|
|
234
286
|
total: number;
|
|
235
287
|
orders: number;
|
|
236
288
|
submissions: number;
|
|
237
|
-
|
|
238
|
-
|
|
289
|
+
contacts: number;
|
|
290
|
+
contact_lists: number;
|
|
239
291
|
abandoned_carts: number;
|
|
240
292
|
carts: number;
|
|
241
293
|
promo_codes: number;
|
|
@@ -244,26 +296,26 @@ interface ActivityFeedSummary {
|
|
|
244
296
|
providers: number;
|
|
245
297
|
cms: number;
|
|
246
298
|
workflows: number;
|
|
247
|
-
|
|
299
|
+
actions: number;
|
|
248
300
|
window_start: number;
|
|
249
301
|
}
|
|
250
|
-
interface
|
|
302
|
+
interface ActionFeedCursor {
|
|
251
303
|
created_at: number;
|
|
252
304
|
id: string;
|
|
253
305
|
}
|
|
254
|
-
interface
|
|
255
|
-
items:
|
|
256
|
-
summary:
|
|
257
|
-
next_cursor?:
|
|
306
|
+
interface ActionFeedData {
|
|
307
|
+
items: ActionFeedItem[];
|
|
308
|
+
summary: ActionFeedSummary;
|
|
309
|
+
next_cursor?: ActionFeedCursor | null;
|
|
258
310
|
meta: {
|
|
259
311
|
row_count: number;
|
|
260
312
|
execution_ms: number;
|
|
261
313
|
};
|
|
262
314
|
}
|
|
263
|
-
type AnalyticsMetricReportKey = "orders_created" | "
|
|
264
|
-
type AnalyticsBreakdownReportKey = "
|
|
265
|
-
type
|
|
266
|
-
type AnalyticsCompositeReportKey = "business_overview" | "
|
|
315
|
+
type AnalyticsMetricReportKey = "orders_created" | "contacts_created" | "form_submissions_created" | "carts_abandoned" | "campaign_messages_sent" | "campaign_messages_received" | "suppressions_created" | "media_count";
|
|
316
|
+
type AnalyticsBreakdownReportKey = "action_by_country" | "top_action_pages" | "products_by_status" | "services_by_status" | "providers_by_status" | "collections_by_status" | "entries_by_status" | "contacts_by_status" | "contact_lists_by_status" | "mailboxes_by_status" | "campaigns_by_status" | "campaign_enrollments_by_status" | "campaign_messages_by_status" | "support_conversations_by_status" | "lead_research_runs_by_status" | "suppressions_by_status" | "workflows_by_status" | "promo_codes_by_status" | "email_templates_by_status" | "forms_by_status" | "taxonomies_by_status" | "carts_by_status" | "orders_by_status" | "order_items_by_status";
|
|
317
|
+
type AnalyticsActionReportKey = "recent_action";
|
|
318
|
+
type AnalyticsCompositeReportKey = "business_overview" | "contact_funnel" | "outreach_overview" | "outreach_funnel" | "entity_status_overview" | "data_health";
|
|
267
319
|
type AnalyticsReport = {
|
|
268
320
|
key: AnalyticsMetricReportKey;
|
|
269
321
|
data: AnalyticsMetricData;
|
|
@@ -274,17 +326,14 @@ type AnalyticsReport = {
|
|
|
274
326
|
key: "business_overview";
|
|
275
327
|
data: BusinessOverviewData;
|
|
276
328
|
} | {
|
|
277
|
-
key: "
|
|
278
|
-
data:
|
|
329
|
+
key: "contact_funnel";
|
|
330
|
+
data: ContactFunnelData;
|
|
279
331
|
} | {
|
|
280
332
|
key: "outreach_overview";
|
|
281
333
|
data: OutreachOverviewData;
|
|
282
334
|
} | {
|
|
283
335
|
key: "outreach_funnel";
|
|
284
336
|
data: OutreachFunnelData;
|
|
285
|
-
} | {
|
|
286
|
-
key: "outreach_variant_performance";
|
|
287
|
-
data: OutreachVariantPerformanceData;
|
|
288
337
|
} | {
|
|
289
338
|
key: "entity_status_overview";
|
|
290
339
|
data: EntityStatusOverviewData;
|
|
@@ -292,8 +341,8 @@ type AnalyticsReport = {
|
|
|
292
341
|
key: "data_health";
|
|
293
342
|
data: DataHealthData;
|
|
294
343
|
} | {
|
|
295
|
-
key:
|
|
296
|
-
data:
|
|
344
|
+
key: AnalyticsActionReportKey;
|
|
345
|
+
data: ActionFeedData;
|
|
297
346
|
};
|
|
298
347
|
interface AnalyticsBlockResponse {
|
|
299
348
|
id: string;
|
|
@@ -337,7 +386,6 @@ type EdgeTrigger = {
|
|
|
337
386
|
type: "default";
|
|
338
387
|
};
|
|
339
388
|
interface SupportAgentAiConfig {
|
|
340
|
-
integration_id: string;
|
|
341
389
|
system_prompt: string;
|
|
342
390
|
tools: string[];
|
|
343
391
|
max_context_messages: number;
|
|
@@ -360,7 +408,7 @@ interface SupportConversation {
|
|
|
360
408
|
store_id: string;
|
|
361
409
|
agent_id?: string;
|
|
362
410
|
current_node_id?: string;
|
|
363
|
-
|
|
411
|
+
contact_id?: string;
|
|
364
412
|
assigned_account_id?: string | null;
|
|
365
413
|
status: "active" | "ai_mode" | "escalated" | "resolved";
|
|
366
414
|
data: Record<string, unknown>;
|
|
@@ -372,7 +420,7 @@ interface SupportMessage {
|
|
|
372
420
|
id: string;
|
|
373
421
|
store_id: string;
|
|
374
422
|
conversation_id: string;
|
|
375
|
-
role: "system" | "user" | "assistant" | "staff" | "
|
|
423
|
+
role: "system" | "user" | "assistant" | "staff" | "action";
|
|
376
424
|
content: string;
|
|
377
425
|
buttons?: string[];
|
|
378
426
|
metadata: Record<string, unknown>;
|
|
@@ -441,31 +489,14 @@ interface UpdateSupportAgentParams {
|
|
|
441
489
|
ai_config?: SupportAgentAiConfig;
|
|
442
490
|
}
|
|
443
491
|
|
|
444
|
-
interface Activity {
|
|
445
|
-
id: string;
|
|
446
|
-
store_id: string;
|
|
447
|
-
profile_id: string;
|
|
448
|
-
type: string;
|
|
449
|
-
payload: Record<string, unknown>;
|
|
450
|
-
created_at: number;
|
|
451
|
-
country_code?: string | null;
|
|
452
|
-
city?: string | null;
|
|
453
|
-
region?: string | null;
|
|
454
|
-
timezone?: string | null;
|
|
455
|
-
device_type?: string | null;
|
|
456
|
-
browser?: string | null;
|
|
457
|
-
os?: string | null;
|
|
458
|
-
language?: string | null;
|
|
459
|
-
session_idx?: number | null;
|
|
460
|
-
}
|
|
461
492
|
interface TimelineParams {
|
|
462
|
-
|
|
493
|
+
contact_id: string;
|
|
463
494
|
store_id?: string;
|
|
464
495
|
limit?: number;
|
|
465
496
|
cursor?: string;
|
|
466
497
|
}
|
|
467
498
|
|
|
468
|
-
interface
|
|
499
|
+
interface WorkflowToolOperation {
|
|
469
500
|
name: string;
|
|
470
501
|
value: string;
|
|
471
502
|
description?: string;
|
|
@@ -474,12 +505,12 @@ interface IntegrationOperation {
|
|
|
474
505
|
body?: Record<string, unknown> | string;
|
|
475
506
|
headers?: Record<string, string>;
|
|
476
507
|
}
|
|
477
|
-
interface
|
|
508
|
+
interface WorkflowToolResource {
|
|
478
509
|
name: string;
|
|
479
510
|
value: string;
|
|
480
|
-
operations:
|
|
511
|
+
operations: WorkflowToolOperation[];
|
|
481
512
|
}
|
|
482
|
-
interface
|
|
513
|
+
interface WorkflowTool {
|
|
483
514
|
id: string;
|
|
484
515
|
name: string;
|
|
485
516
|
description: string;
|
|
@@ -490,7 +521,7 @@ interface IntegrationService {
|
|
|
490
521
|
website?: string;
|
|
491
522
|
docsUrl?: string;
|
|
492
523
|
urlPatterns: string[];
|
|
493
|
-
resources:
|
|
524
|
+
resources: WorkflowToolResource[];
|
|
494
525
|
triggers?: Array<{
|
|
495
526
|
name: string;
|
|
496
527
|
value: string;
|
|
@@ -550,6 +581,7 @@ interface RequestErrorContext {
|
|
|
550
581
|
interface RequestOptions<T = unknown> {
|
|
551
582
|
headers?: Record<string, string>;
|
|
552
583
|
params?: QueryParams | Record<string, any>;
|
|
584
|
+
signal?: AbortSignal;
|
|
553
585
|
transformRequest?: (data: unknown) => unknown;
|
|
554
586
|
onSuccess?: (ctx: RequestSuccessContext<T>) => void | Promise<void>;
|
|
555
587
|
onError?: (ctx: RequestErrorContext) => void | Promise<void>;
|
|
@@ -600,7 +632,7 @@ declare function fetchSvgContent(mediaObject: any): Promise<string | null>;
|
|
|
600
632
|
declare function getSvgContentForAstro(mediaObject: any): Promise<string>;
|
|
601
633
|
declare function injectSvgIntoElement(mediaObject: any, targetElement: HTMLElement, className?: string): Promise<void>;
|
|
602
634
|
|
|
603
|
-
declare const SDK_VERSION = "0.9.
|
|
635
|
+
declare const SDK_VERSION = "0.9.11";
|
|
604
636
|
declare const SUPPORTED_FRAMEWORKS: readonly ["astro", "react", "vue", "svelte", "vanilla"];
|
|
605
637
|
|
|
606
638
|
interface ApiConfig {
|
|
@@ -617,22 +649,22 @@ interface AdminSessionInternal {
|
|
|
617
649
|
access_expires_at?: number;
|
|
618
650
|
email?: string;
|
|
619
651
|
}
|
|
620
|
-
interface
|
|
652
|
+
interface ContactSessionInternal {
|
|
621
653
|
access_token: string;
|
|
622
|
-
|
|
654
|
+
contact: Contact;
|
|
623
655
|
store: Store;
|
|
624
656
|
market: Market | null;
|
|
625
657
|
}
|
|
626
658
|
interface AdminSession {
|
|
627
659
|
email?: string;
|
|
628
660
|
}
|
|
629
|
-
interface
|
|
630
|
-
|
|
661
|
+
interface ContactSession {
|
|
662
|
+
contact: Contact;
|
|
631
663
|
store: Store;
|
|
632
664
|
market: Market | null;
|
|
633
665
|
}
|
|
634
666
|
type AdminSessionUpdater = (updater: (prev: AdminSessionInternal | null) => AdminSessionInternal | null) => void;
|
|
635
|
-
type
|
|
667
|
+
type ContactSessionUpdater = (updater: (prev: ContactSessionInternal | null) => ContactSessionInternal | null) => void;
|
|
636
668
|
type AuthStateListener<T> = (session: T | null) => void;
|
|
637
669
|
|
|
638
670
|
type CreateAdminConfig = Omit<HttpClientConfig, "authStorage" | "storeId"> & {
|
|
@@ -642,38 +674,86 @@ type CreateAdminConfig = Omit<HttpClientConfig, "authStorage" | "storeId"> & {
|
|
|
642
674
|
apiToken?: string;
|
|
643
675
|
};
|
|
644
676
|
declare function createAdmin(config: CreateAdminConfig): {
|
|
645
|
-
auth: {
|
|
646
|
-
code(params: {
|
|
647
|
-
email: string;
|
|
648
|
-
}, options?: RequestOptions$1): Promise<{
|
|
649
|
-
sent: boolean;
|
|
650
|
-
}>;
|
|
651
|
-
verify(params: MagicLinkVerifyParams, options?: RequestOptions$1): Promise<AuthToken>;
|
|
652
|
-
refresh(params: {
|
|
653
|
-
refresh_token: string;
|
|
654
|
-
}, options?: RequestOptions$1): Promise<AuthToken>;
|
|
655
|
-
storeCode(storeId: string, params: {
|
|
656
|
-
email: string;
|
|
657
|
-
}, options?: RequestOptions$1): Promise<{
|
|
658
|
-
sent: boolean;
|
|
659
|
-
}>;
|
|
660
|
-
storeVerify(storeId: string, params: MagicLinkVerifyParams, options?: RequestOptions$1): Promise<AuthToken>;
|
|
661
|
-
magicLink(params: MagicLinkRequestParams, options?: RequestOptions$1): Promise<{
|
|
662
|
-
sent: boolean;
|
|
663
|
-
}>;
|
|
664
|
-
};
|
|
665
677
|
account: {
|
|
666
|
-
|
|
667
|
-
|
|
678
|
+
update: (params: UpdateAccountContactParams, options?: RequestOptions$1) => Promise<AccountUpdateResponse>;
|
|
679
|
+
delete: (_params: DeleteAccountParams, options?: RequestOptions$1) => Promise<{
|
|
668
680
|
deleted: boolean;
|
|
669
681
|
}>;
|
|
670
|
-
getMe(_params: GetMeParams, options?: RequestOptions$1)
|
|
671
|
-
|
|
682
|
+
getMe: (_params: GetMeParams, options?: RequestOptions$1) => Promise<Account>;
|
|
683
|
+
search: (params: SearchAccountsParams, options?: RequestOptions$1) => Promise<{
|
|
672
684
|
items: Account[];
|
|
673
685
|
cursor?: string | null;
|
|
674
686
|
}>;
|
|
687
|
+
auth: {
|
|
688
|
+
code(params: {
|
|
689
|
+
email: string;
|
|
690
|
+
}, options?: RequestOptions$1): Promise<{
|
|
691
|
+
sent: boolean;
|
|
692
|
+
}>;
|
|
693
|
+
verify(params: MagicLinkVerifyParams, options?: RequestOptions$1): Promise<AuthToken>;
|
|
694
|
+
refresh(params: {
|
|
695
|
+
refresh_token: string;
|
|
696
|
+
}, options?: RequestOptions$1): Promise<AuthToken>;
|
|
697
|
+
storeCode(storeId: string, params: {
|
|
698
|
+
email: string;
|
|
699
|
+
}, options?: RequestOptions$1): Promise<{
|
|
700
|
+
sent: boolean;
|
|
701
|
+
}>;
|
|
702
|
+
storeVerify(storeId: string, params: MagicLinkVerifyParams, options?: RequestOptions$1): Promise<AuthToken>;
|
|
703
|
+
};
|
|
675
704
|
};
|
|
676
705
|
store: {
|
|
706
|
+
create: (params: CreateStoreParams, options?: RequestOptions$1) => Promise<Store>;
|
|
707
|
+
update: (params: UpdateStoreParams, options?: RequestOptions$1) => Promise<Store>;
|
|
708
|
+
delete: (params: DeleteStoreParams, options?: RequestOptions$1) => Promise<{
|
|
709
|
+
deleted: boolean;
|
|
710
|
+
}>;
|
|
711
|
+
get: (_params: GetStoreParams, options?: RequestOptions$1) => Promise<Store>;
|
|
712
|
+
find: (params?: GetStoresParams, options?: RequestOptions$1) => Promise<PaginatedResponse<Store>>;
|
|
713
|
+
subscription: {
|
|
714
|
+
getPlans: (_params: GetSubscriptionPlansParams, options?: RequestOptions$1) => Promise<PaginatedResponse<SubscriptionPlan>>;
|
|
715
|
+
subscribe: (params: SubscribeParams, options?: RequestOptions$1) => Promise<{
|
|
716
|
+
checkout_url?: string;
|
|
717
|
+
}>;
|
|
718
|
+
createPortalSession: (params: CreatePortalSessionParams, options?: RequestOptions$1) => Promise<{
|
|
719
|
+
portal_url: string;
|
|
720
|
+
}>;
|
|
721
|
+
};
|
|
722
|
+
member: {
|
|
723
|
+
add: (params: AddMemberParams, options?: RequestOptions$1) => Promise<boolean>;
|
|
724
|
+
invite: (params: AddMemberParams, options?: RequestOptions$1) => Promise<boolean>;
|
|
725
|
+
remove: (params: RemoveMemberParams, options?: RequestOptions$1) => Promise<{
|
|
726
|
+
removed: boolean;
|
|
727
|
+
}>;
|
|
728
|
+
};
|
|
729
|
+
buildHook: {
|
|
730
|
+
list: (params: ListBuildHooksParams, options?: RequestOptions$1) => Promise<BuildHook[]>;
|
|
731
|
+
create: (params: CreateBuildHookParams, options?: RequestOptions$1) => Promise<BuildHook>;
|
|
732
|
+
update: (params: UpdateBuildHookParams, options?: RequestOptions$1) => Promise<BuildHook>;
|
|
733
|
+
delete: (params: DeleteBuildHookParams, options?: RequestOptions$1) => Promise<{
|
|
734
|
+
deleted: boolean;
|
|
735
|
+
}>;
|
|
736
|
+
};
|
|
737
|
+
webhook: {
|
|
738
|
+
test: (params: TestWebhookParams, options?: RequestOptions$1) => Promise<{
|
|
739
|
+
tested: boolean;
|
|
740
|
+
}>;
|
|
741
|
+
list: (params: ListWebhooksParams, options?: RequestOptions$1) => Promise<Webhook[]>;
|
|
742
|
+
create: (params: CreateWebhookParams, options?: RequestOptions$1) => Promise<Webhook>;
|
|
743
|
+
update: (params: UpdateWebhookParams, options?: RequestOptions$1) => Promise<Webhook>;
|
|
744
|
+
delete: (params: DeleteWebhookParams, options?: RequestOptions$1) => Promise<{
|
|
745
|
+
deleted: boolean;
|
|
746
|
+
}>;
|
|
747
|
+
};
|
|
748
|
+
config: {
|
|
749
|
+
get: (params: {
|
|
750
|
+
store_id: string;
|
|
751
|
+
type: "payment" | "shipping";
|
|
752
|
+
}, options?: RequestOptions$1) => Promise<StoreRuntimeConfig>;
|
|
753
|
+
};
|
|
754
|
+
media: {
|
|
755
|
+
find: (params: FindStoreMediaParams, options?: RequestOptions$1) => Promise<PaginatedResponse<Media>>;
|
|
756
|
+
};
|
|
677
757
|
location: {
|
|
678
758
|
getCountries(options?: RequestOptions$1): Promise<GetCountriesResponse>;
|
|
679
759
|
getCountry(countryCode: string, options?: RequestOptions$1): Promise<LocationCountry>;
|
|
@@ -694,78 +774,46 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
694
774
|
deleted: boolean;
|
|
695
775
|
}>;
|
|
696
776
|
};
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
subscribe(params: SubscribeParams, options?: RequestOptions$1): Promise<{
|
|
706
|
-
checkout_url?: string;
|
|
707
|
-
}>;
|
|
708
|
-
createPortalSession(params: CreatePortalSessionParams, options?: RequestOptions$1): Promise<{
|
|
709
|
-
portal_url: string;
|
|
710
|
-
}>;
|
|
711
|
-
addMember(params: AddMemberParams, options?: RequestOptions$1): Promise<boolean>;
|
|
712
|
-
inviteUser(params: InviteUserParams, options?: RequestOptions$1): Promise<boolean>;
|
|
713
|
-
removeMember(params: RemoveMemberParams, options?: RequestOptions$1): Promise<{
|
|
714
|
-
removed: boolean;
|
|
715
|
-
}>;
|
|
716
|
-
testWebhook(params: TestWebhookParams, options?: RequestOptions$1): Promise<{
|
|
717
|
-
tested: boolean;
|
|
718
|
-
}>;
|
|
719
|
-
getStoreMedia(params: GetStoreMediaParams2, options?: RequestOptions$1): Promise<PaginatedResponse<Media>>;
|
|
720
|
-
oauthConnect(params: OAuthConnectParams, options?: RequestOptions$1): Promise<Integration>;
|
|
721
|
-
oauthDisconnect(params: OAuthDisconnectParams, options?: RequestOptions$1): Promise<{
|
|
722
|
-
disconnected: boolean;
|
|
723
|
-
}>;
|
|
724
|
-
listIntegrations(params: ListIntegrationsParams, options?: RequestOptions$1): Promise<Integration[]>;
|
|
725
|
-
createIntegration(params: CreateIntegrationParams, options?: RequestOptions$1): Promise<Integration>;
|
|
726
|
-
updateIntegration(params: UpdateIntegrationParams, options?: RequestOptions$1): Promise<Integration>;
|
|
727
|
-
deleteIntegration(params: DeleteIntegrationParams, options?: RequestOptions$1): Promise<{
|
|
728
|
-
deleted: boolean;
|
|
729
|
-
}>;
|
|
730
|
-
getIntegrationConfig(params: {
|
|
731
|
-
store_id: string;
|
|
732
|
-
type: "payment" | "shipping";
|
|
733
|
-
}, options?: RequestOptions$1): Promise<unknown>;
|
|
734
|
-
listWebhooks(params: ListWebhooksParams, options?: RequestOptions$1): Promise<Webhook[]>;
|
|
735
|
-
createWebhook(params: CreateWebhookParams, options?: RequestOptions$1): Promise<Webhook>;
|
|
736
|
-
updateWebhook(params: UpdateWebhookParams, options?: RequestOptions$1): Promise<Webhook>;
|
|
737
|
-
deleteWebhook(params: DeleteWebhookParams, options?: RequestOptions$1): Promise<{
|
|
738
|
-
deleted: boolean;
|
|
739
|
-
}>;
|
|
777
|
+
paymentProvider: {
|
|
778
|
+
list: (params?: ListPaymentProvidersParams, options?: RequestOptions$1) => Promise<PaymentProvider[]>;
|
|
779
|
+
refresh: (params?: RefreshPaymentProvidersParams, options?: RequestOptions$1) => Promise<PaymentProvider[]>;
|
|
780
|
+
connectStripe: (params: ConnectStripePaymentProviderParams, options?: RequestOptions$1) => Promise<StripePaymentProviderConnectResponse>;
|
|
781
|
+
delete: (params: DeletePaymentProviderParams, options?: RequestOptions$1) => Promise<{
|
|
782
|
+
deleted: boolean;
|
|
783
|
+
}>;
|
|
784
|
+
};
|
|
740
785
|
};
|
|
741
786
|
media: {
|
|
742
787
|
getMedia(params: GetMediaParams, options?: RequestOptions$1): Promise<Media>;
|
|
743
|
-
uploadStoreMedia(params: UploadStoreMediaParams,
|
|
788
|
+
uploadStoreMedia(params: UploadStoreMediaParams, options?: RequestOptions$1): Promise<Media[]>;
|
|
744
789
|
deleteStoreMedia(params: DeleteStoreMediaParams, options?: RequestOptions$1): Promise<{
|
|
745
790
|
deleted: boolean;
|
|
746
791
|
}>;
|
|
747
|
-
getStoreMedia(params: GetStoreMediaParams,
|
|
792
|
+
getStoreMedia(params: GetStoreMediaParams, options?: RequestOptions$1): Promise<PaginatedResponse<Media>>;
|
|
748
793
|
updateMedia(params: UpdateMediaParams, options?: RequestOptions$1): Promise<Media>;
|
|
749
794
|
};
|
|
750
795
|
notification: {
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
796
|
+
email: {
|
|
797
|
+
trackOpen: (params: TrackEmailOpenParams, options?: RequestOptions$1) => Promise<void>;
|
|
798
|
+
};
|
|
799
|
+
trigger: {
|
|
800
|
+
send: (params: TriggerNotificationParams, options?: RequestOptions$1) => Promise<{
|
|
801
|
+
success: boolean;
|
|
802
|
+
message: string;
|
|
803
|
+
}>;
|
|
804
|
+
};
|
|
805
|
+
mailbox: {
|
|
806
|
+
create(params: CreateMailboxParams, options?: RequestOptions$1): Promise<Mailbox>;
|
|
807
|
+
update(params: UpdateMailboxParams, options?: RequestOptions$1): Promise<Mailbox>;
|
|
808
|
+
get(params: GetMailboxParams, options?: RequestOptions$1): Promise<Mailbox>;
|
|
809
|
+
test(params: TestMailboxParams, options?: RequestOptions$1): Promise<TestMailboxResult>;
|
|
810
|
+
prepare(params: PrepareMailboxParams, options?: RequestOptions$1): Promise<Mailbox>;
|
|
811
|
+
find(params?: FindMailboxesParams, options?: RequestOptions$1): Promise<PaginatedResponse<Mailbox>>;
|
|
812
|
+
};
|
|
765
813
|
};
|
|
766
814
|
platform: {
|
|
767
815
|
getCurrencies(options?: RequestOptions$1): Promise<string[]>;
|
|
768
|
-
|
|
816
|
+
getWorkflowTools(options?: RequestOptions$1): Promise<WorkflowTool[]>;
|
|
769
817
|
getWebhookEvents(options?: RequestOptions$1): Promise<{
|
|
770
818
|
data: string[];
|
|
771
819
|
}>;
|
|
@@ -782,7 +830,7 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
782
830
|
put(params: {
|
|
783
831
|
key: string;
|
|
784
832
|
value: unknown;
|
|
785
|
-
|
|
833
|
+
previous_key?: string;
|
|
786
834
|
}, options?: RequestOptions$1): Promise<{
|
|
787
835
|
ok: boolean;
|
|
788
836
|
}>;
|
|
@@ -802,37 +850,51 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
802
850
|
message: string;
|
|
803
851
|
}>;
|
|
804
852
|
};
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
create: (params: CreateNodeParams, options?: RequestOptions$1) => Promise<Node>;
|
|
814
|
-
update: (params: UpdateNodeParams, options?: RequestOptions$1) => Promise<Node>;
|
|
815
|
-
delete: (params: DeleteNodeParams, options?: RequestOptions$1) => Promise<{
|
|
853
|
+
social: {
|
|
854
|
+
account: {
|
|
855
|
+
getCapabilities: (params?: GetSocialCapabilitiesParams, options?: RequestOptions$1) => Promise<SocialProviderCapability[]>;
|
|
856
|
+
list: (params?: ListSocialAccountsParams, options?: RequestOptions$1) => Promise<SocialAccount[]>;
|
|
857
|
+
connect: (params: ConnectSocialAccountParams, options?: RequestOptions$1) => Promise<SocialConnectResponse>;
|
|
858
|
+
getOAuthAttempt: (params: GetSocialOAuthAttemptParams, options?: RequestOptions$1) => Promise<SocialOAuthCallbackResponse>;
|
|
859
|
+
selectDestination: (params: SelectSocialDestinationParams, options?: RequestOptions$1) => Promise<SocialOAuthCallbackResponse>;
|
|
860
|
+
delete: (params: DeleteSocialAccountParams, options?: RequestOptions$1) => Promise<{
|
|
816
861
|
deleted: boolean;
|
|
817
862
|
}>;
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
863
|
+
};
|
|
864
|
+
publication: {
|
|
865
|
+
create: (params: CreateSocialPublicationParams, options?: RequestOptions$1) => Promise<SocialPublicationMutationResponse>;
|
|
866
|
+
update: (params: UpdateSocialPublicationParams, options?: RequestOptions$1) => Promise<SocialPublicationMutationResponse>;
|
|
867
|
+
get: (params: GetSocialPublicationParams, options?: RequestOptions$1) => Promise<SocialPublication>;
|
|
868
|
+
find: (params?: FindSocialPublicationsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<SocialPublication>>;
|
|
869
|
+
validate: (params: ValidateSocialPublicationParams, options?: RequestOptions$1) => Promise<SocialPublicationValidation>;
|
|
870
|
+
schedule: (params: ScheduleSocialPublicationParams, options?: RequestOptions$1) => Promise<SocialPublicationMutationResponse>;
|
|
871
|
+
cancel: (params: CancelSocialPublicationParams, options?: RequestOptions$1) => Promise<SocialPublication>;
|
|
872
|
+
getComments: (params: GetSocialPublicationCommentsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<SocialPublicationComment>>;
|
|
873
|
+
syncComments: (params: SyncSocialPublicationCommentsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<SocialPublicationComment>>;
|
|
874
|
+
getCommentThread: (params: GetSocialPublicationCommentThreadParams, options?: RequestOptions$1) => Promise<PaginatedResponse<SocialPublicationComment>>;
|
|
875
|
+
syncCommentThread: (params: SyncSocialPublicationCommentThreadParams, options?: RequestOptions$1) => Promise<PaginatedResponse<SocialPublicationComment>>;
|
|
876
|
+
findComments: (params?: FindSocialPublicationCommentsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<SocialPublicationComment>>;
|
|
877
|
+
classifyComments: (params?: ClassifySocialPublicationCommentsParams, options?: RequestOptions$1) => Promise<SocialPublicationCommentClassificationResult>;
|
|
878
|
+
replyToComment: (params: ReplySocialPublicationCommentParams, options?: RequestOptions$1) => Promise<SocialPublicationCommentReplyResponse>;
|
|
879
|
+
getMetrics: (params: GetSocialPublicationMetricsParams, options?: RequestOptions$1) => Promise<SocialPublicationMetricSnapshot>;
|
|
880
|
+
syncMetrics: (params: SyncSocialPublicationMetricsParams, options?: RequestOptions$1) => Promise<SocialPublicationMetricSnapshot>;
|
|
881
|
+
syncEngagement: (params?: SyncSocialEngagementParams, options?: RequestOptions$1) => Promise<SocialPublicationEngagementSyncResult>;
|
|
882
|
+
};
|
|
883
|
+
};
|
|
884
|
+
cms: {
|
|
885
|
+
collection: {
|
|
886
|
+
create: (params: CreateCollectionParams, options?: RequestOptions$1) => Promise<Collection>;
|
|
887
|
+
update: (params: UpdateCollectionParams, options?: RequestOptions$1) => Promise<Collection>;
|
|
888
|
+
delete: (params: DeleteCollectionParams, options?: RequestOptions$1) => Promise<boolean>;
|
|
889
|
+
get: (params: GetCollectionParams, options?: RequestOptions$1) => Promise<Collection>;
|
|
890
|
+
find: (params?: GetCollectionsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<Collection>>;
|
|
891
|
+
};
|
|
892
|
+
entry: {
|
|
893
|
+
create: (params: CreateEntryParams, options?: RequestOptions$1) => Promise<CollectionEntry>;
|
|
894
|
+
update: (params: UpdateEntryParams, options?: RequestOptions$1) => Promise<CollectionEntry>;
|
|
895
|
+
delete: (params: DeleteEntryParams, options?: RequestOptions$1) => Promise<boolean>;
|
|
896
|
+
get: (params: GetEntryParams, options?: RequestOptions$1) => Promise<CollectionEntry>;
|
|
897
|
+
find: (params: GetEntriesParams, options?: RequestOptions$1) => Promise<PaginatedResponse<CollectionEntry>>;
|
|
836
898
|
};
|
|
837
899
|
form: {
|
|
838
900
|
create: (params: CreateFormParams, options?: RequestOptions$1) => Promise<Form>;
|
|
@@ -883,7 +945,12 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
883
945
|
get: (params: GetOrderParams, options?: RequestOptions$1) => Promise<Order>;
|
|
884
946
|
find: (params: GetOrdersParams, options?: RequestOptions$1) => Promise<PaginatedResponse<Order>>;
|
|
885
947
|
getQuote: (params: GetQuoteParams, options?: RequestOptions$1) => Promise<OrderQuote>;
|
|
886
|
-
processRefund: (params: ProcessOrderRefundParams, options?: RequestOptions$1) => Promise<
|
|
948
|
+
processRefund: (params: ProcessOrderRefundParams, options?: RequestOptions$1) => Promise<ProcessOrderRefundResponse>;
|
|
949
|
+
downloadDigitalAccess: (params: DownloadDigitalAccessParams, options?: RequestOptions$1) => Promise<DigitalAccessDownloadResponse>;
|
|
950
|
+
getShippingRates: (params: GetShippingRatesParams, options?: RequestOptions$1) => Promise<{
|
|
951
|
+
rates: ShippingRate[];
|
|
952
|
+
}>;
|
|
953
|
+
ship: (params: ShipParams, options?: RequestOptions$1) => Promise<ShipResult>;
|
|
887
954
|
};
|
|
888
955
|
cart: {
|
|
889
956
|
create: (params: CreateCartParams, options?: RequestOptions$1) => Promise<Cart>;
|
|
@@ -926,16 +993,16 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
926
993
|
};
|
|
927
994
|
};
|
|
928
995
|
crm: {
|
|
929
|
-
|
|
930
|
-
create: (params:
|
|
931
|
-
get: (params:
|
|
932
|
-
find: (params?:
|
|
933
|
-
items:
|
|
996
|
+
contact: {
|
|
997
|
+
create: (params: CreateContactParams, options?: RequestOptions$1) => Promise<Contact$1>;
|
|
998
|
+
get: (params: GetContactParams, options?: RequestOptions$1) => Promise<ContactDetail>;
|
|
999
|
+
find: (params?: FindContactsParams, options?: RequestOptions$1) => Promise<{
|
|
1000
|
+
items: Contact$1[];
|
|
934
1001
|
cursor?: string;
|
|
935
1002
|
}>;
|
|
936
|
-
update: (params:
|
|
937
|
-
merge: (params:
|
|
938
|
-
import: (params:
|
|
1003
|
+
update: (params: UpdateContactParams, options?: RequestOptions$1) => Promise<Contact$1>;
|
|
1004
|
+
merge: (params: MergeContactsParams, options?: RequestOptions$1) => Promise<Contact$1>;
|
|
1005
|
+
import: (params: ImportContactsParams, options?: RequestOptions$1) => Promise<ImportContactsResult>;
|
|
939
1006
|
revokeToken: (params: {
|
|
940
1007
|
id: string;
|
|
941
1008
|
token_id: string;
|
|
@@ -950,38 +1017,32 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
950
1017
|
deleted: boolean;
|
|
951
1018
|
}>;
|
|
952
1019
|
};
|
|
953
|
-
|
|
954
|
-
create(params:
|
|
955
|
-
update(params:
|
|
956
|
-
get(params:
|
|
957
|
-
find(params?:
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
find(params: FindProfileListProfilesParams, options?: RequestOptions$1): Promise<PaginatedResponse<ProfileListMember>>;
|
|
967
|
-
};
|
|
968
|
-
profiles: {
|
|
969
|
-
add(params: AddProfileListProfileParams, options?: RequestOptions$1): Promise<ProfileListMember>;
|
|
970
|
-
update(params: UpdateProfileListProfileParams, options?: RequestOptions$1): Promise<ProfileListMember>;
|
|
971
|
-
remove(params: RemoveProfileListProfileParams, options?: RequestOptions$1): Promise<{
|
|
972
|
-
deleted: boolean;
|
|
973
|
-
}>;
|
|
974
|
-
find(params: FindProfileListProfilesParams, options?: RequestOptions$1): Promise<PaginatedResponse<ProfileListMember>>;
|
|
975
|
-
};
|
|
1020
|
+
contactList: {
|
|
1021
|
+
create: (params: CreateContactListParams, options?: RequestOptions$1) => Promise<ContactList>;
|
|
1022
|
+
update: (params: UpdateContactListParams, options?: RequestOptions$1) => Promise<ContactList>;
|
|
1023
|
+
get: (params: GetContactListParams, options?: RequestOptions$1) => Promise<ContactList>;
|
|
1024
|
+
find: (params?: FindContactListsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<ContactList>>;
|
|
1025
|
+
importContacts: (params: ImportContactsIntoContactListParams, options?: RequestOptions$1) => Promise<ImportContactsIntoContactListResult>;
|
|
1026
|
+
previewImportContacts: (params: ImportContactListPreviewParams, options?: RequestOptions$1) => Promise<ImportContactsPreviewResult>;
|
|
1027
|
+
addMember: (params: AddContactListContactParams, options?: RequestOptions$1) => Promise<ContactListMember>;
|
|
1028
|
+
updateMember: (params: UpdateContactListContactParams, options?: RequestOptions$1) => Promise<ContactListMember>;
|
|
1029
|
+
removeMember: (params: RemoveContactListContactParams, options?: RequestOptions$1) => Promise<{
|
|
1030
|
+
deleted: boolean;
|
|
1031
|
+
}>;
|
|
1032
|
+
findMembers: (params: FindContactListContactsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<ContactListMember>>;
|
|
976
1033
|
};
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
1034
|
+
action: {
|
|
1035
|
+
timeline(params: TimelineParams, options?: RequestOptions$1): Promise<{
|
|
1036
|
+
items: Action[];
|
|
1037
|
+
cursor: string | null;
|
|
1038
|
+
}>;
|
|
1039
|
+
find(params: FindActionsParams, options?: RequestOptions$1): Promise<{
|
|
1040
|
+
items: Action[];
|
|
1041
|
+
cursor: string | null;
|
|
1042
|
+
}>;
|
|
984
1043
|
};
|
|
1044
|
+
};
|
|
1045
|
+
outreach: {
|
|
985
1046
|
campaign: {
|
|
986
1047
|
create(params: CreateCampaignParams, options?: RequestOptions$1): Promise<Campaign>;
|
|
987
1048
|
update(params: UpdateCampaignParams, options?: RequestOptions$1): Promise<Campaign>;
|
|
@@ -990,16 +1051,17 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
990
1051
|
launch(params: LaunchCampaignParams, options?: RequestOptions$1): Promise<Campaign>;
|
|
991
1052
|
duplicate(params: DuplicateCampaignParams, options?: RequestOptions$1): Promise<Campaign>;
|
|
992
1053
|
launchReadiness(params: GetCampaignLaunchReadinessParams, options?: RequestOptions$1): Promise<CampaignLaunchReadiness>;
|
|
993
|
-
|
|
1054
|
+
importEnrollments(params: ImportCampaignEnrollmentsParams, options?: RequestOptions$1): Promise<CampaignEnrollmentImportResult>;
|
|
994
1055
|
generatePersonalizedDrafts(params: GenerateOutreachPersonalizedDraftsParams, options?: RequestOptions$1): Promise<Campaign>;
|
|
995
1056
|
};
|
|
996
|
-
|
|
997
|
-
find(params?:
|
|
998
|
-
get(params:
|
|
999
|
-
update(params:
|
|
1000
|
-
updateDraft(params:
|
|
1001
|
-
|
|
1002
|
-
|
|
1057
|
+
campaignEnrollment: {
|
|
1058
|
+
find(params?: FindCampaignEnrollmentsParams, options?: RequestOptions$1): Promise<PaginatedResponse<CampaignEnrollment>>;
|
|
1059
|
+
get(params: GetCampaignEnrollmentConversationParams, options?: RequestOptions$1): Promise<CampaignEnrollmentConversationResponse>;
|
|
1060
|
+
update(params: UpdateCampaignEnrollmentParams, options?: RequestOptions$1): Promise<CampaignEnrollment>;
|
|
1061
|
+
updateDraft(params: UpdateCampaignEnrollmentDraftParams, options?: RequestOptions$1): Promise<CampaignEnrollment>;
|
|
1062
|
+
updateStepExecution(params: UpdateCampaignEnrollmentStepExecutionParams, options?: RequestOptions$1): Promise<CampaignEnrollmentConversationResponse>;
|
|
1063
|
+
reply(params: ReplyCampaignEnrollmentParams, options?: RequestOptions$1): Promise<CampaignEnrollmentConversationResponse>;
|
|
1064
|
+
stop(params: StopCampaignEnrollmentParams, options?: RequestOptions$1): Promise<CampaignEnrollmentConversationResponse>;
|
|
1003
1065
|
};
|
|
1004
1066
|
campaignMessage: {
|
|
1005
1067
|
find(params?: FindCampaignMessagesParams, options?: RequestOptions$1): Promise<PaginatedResponse<CampaignMessage>>;
|
|
@@ -1012,67 +1074,15 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
1012
1074
|
find(params?: FindSuppressionsParams, options?: RequestOptions$1): Promise<PaginatedResponse<Suppression>>;
|
|
1013
1075
|
};
|
|
1014
1076
|
leadResearch: {
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
};
|
|
1024
|
-
message: {
|
|
1025
|
-
send: (params: SendLeadResearchMessageParams, options?: RequestOptions$1) => Promise<SendLeadResearchMessageResult>;
|
|
1026
|
-
find: (params: FindLeadResearchMessagesParams, options?: RequestOptions$1) => Promise<LeadResearchMessage[]>;
|
|
1027
|
-
};
|
|
1028
|
-
email: {
|
|
1029
|
-
validate: (params: ValidateLeadEmailParams, options?: RequestOptions$1) => Promise<LeadEmailValidationResult>;
|
|
1030
|
-
};
|
|
1031
|
-
createRun: (params: CreateLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1032
|
-
findRuns: (params?: FindLeadResearchRunsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<LeadResearchRun>>;
|
|
1033
|
-
getRun: (params: GetLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1034
|
-
updateRun: (params: UpdateLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1035
|
-
cancelRun: (params: CancelLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1036
|
-
sendMessage: (params: SendLeadResearchMessageParams, options?: RequestOptions$1) => Promise<SendLeadResearchMessageResult>;
|
|
1037
|
-
findMessages: (params: FindLeadResearchMessagesParams, options?: RequestOptions$1) => Promise<LeadResearchMessage[]>;
|
|
1038
|
-
validateEmail: (params: ValidateLeadEmailParams, options?: RequestOptions$1) => Promise<LeadEmailValidationResult>;
|
|
1077
|
+
createRun(params: CreateLeadResearchRunParams, options?: RequestOptions$1): Promise<LeadResearchRun>;
|
|
1078
|
+
findRuns(params?: FindLeadResearchRunsParams, options?: RequestOptions$1): Promise<PaginatedResponse<LeadResearchRun>>;
|
|
1079
|
+
getRun(params: GetLeadResearchRunParams, options?: RequestOptions$1): Promise<LeadResearchRun>;
|
|
1080
|
+
updateRun(params: UpdateLeadResearchRunParams, options?: RequestOptions$1): Promise<LeadResearchRun>;
|
|
1081
|
+
cancelRun(params: CancelLeadResearchRunParams, options?: RequestOptions$1): Promise<LeadResearchRun>;
|
|
1082
|
+
sendMessage(params: SendLeadResearchMessageParams, options?: RequestOptions$1): Promise<SendLeadResearchMessageResult>;
|
|
1083
|
+
findMessages(params: FindLeadResearchMessagesParams, options?: RequestOptions$1): Promise<LeadResearchMessage[]>;
|
|
1084
|
+
validateEmail(params: ValidateLeadEmailParams, options?: RequestOptions$1): Promise<LeadEmailValidationResult>;
|
|
1039
1085
|
};
|
|
1040
|
-
activity: {
|
|
1041
|
-
timeline(params: TimelineParams, options?: RequestOptions$1): Promise<{
|
|
1042
|
-
items: Activity[];
|
|
1043
|
-
cursor: string | null;
|
|
1044
|
-
}>;
|
|
1045
|
-
find(params: FindActivitiesParams, options?: RequestOptions$1): Promise<{
|
|
1046
|
-
items: Activity[];
|
|
1047
|
-
cursor: string | null;
|
|
1048
|
-
}>;
|
|
1049
|
-
};
|
|
1050
|
-
};
|
|
1051
|
-
leadResearch: {
|
|
1052
|
-
run: {
|
|
1053
|
-
create: (params: CreateLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1054
|
-
find: (params?: FindLeadResearchRunsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<LeadResearchRun>>;
|
|
1055
|
-
get: (params: GetLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1056
|
-
update: (params: UpdateLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1057
|
-
cancel: (params: CancelLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1058
|
-
sendMessage: (params: SendLeadResearchMessageParams, options?: RequestOptions$1) => Promise<SendLeadResearchMessageResult>;
|
|
1059
|
-
findMessages: (params: FindLeadResearchMessagesParams, options?: RequestOptions$1) => Promise<LeadResearchMessage[]>;
|
|
1060
|
-
};
|
|
1061
|
-
message: {
|
|
1062
|
-
send: (params: SendLeadResearchMessageParams, options?: RequestOptions$1) => Promise<SendLeadResearchMessageResult>;
|
|
1063
|
-
find: (params: FindLeadResearchMessagesParams, options?: RequestOptions$1) => Promise<LeadResearchMessage[]>;
|
|
1064
|
-
};
|
|
1065
|
-
email: {
|
|
1066
|
-
validate: (params: ValidateLeadEmailParams, options?: RequestOptions$1) => Promise<LeadEmailValidationResult>;
|
|
1067
|
-
};
|
|
1068
|
-
createRun: (params: CreateLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1069
|
-
findRuns: (params?: FindLeadResearchRunsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<LeadResearchRun>>;
|
|
1070
|
-
getRun: (params: GetLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1071
|
-
updateRun: (params: UpdateLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1072
|
-
cancelRun: (params: CancelLeadResearchRunParams, options?: RequestOptions$1) => Promise<LeadResearchRun>;
|
|
1073
|
-
sendMessage: (params: SendLeadResearchMessageParams, options?: RequestOptions$1) => Promise<SendLeadResearchMessageResult>;
|
|
1074
|
-
findMessages: (params: FindLeadResearchMessagesParams, options?: RequestOptions$1) => Promise<LeadResearchMessage[]>;
|
|
1075
|
-
validateEmail: (params: ValidateLeadEmailParams, options?: RequestOptions$1) => Promise<LeadEmailValidationResult>;
|
|
1076
1086
|
};
|
|
1077
1087
|
automation: {
|
|
1078
1088
|
workflow: {
|
|
@@ -1086,46 +1096,47 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
1086
1096
|
trigger: (params: TriggerWorkflowParams, options?: RequestOptions$1) => Promise<WorkflowExecution>;
|
|
1087
1097
|
getExecutions: (params: GetWorkflowExecutionsParams, options?: RequestOptions$1) => Promise<PaginatedResponse<WorkflowExecution>>;
|
|
1088
1098
|
getExecution: (params: GetWorkflowExecutionParams, options?: RequestOptions$1) => Promise<WorkflowExecution>;
|
|
1099
|
+
listAccounts: (params?: GetWorkflowAccountsParams, options?: RequestOptions$1) => Promise<WorkflowAccount[]>;
|
|
1100
|
+
getAccountConnectUrl: (params: GetWorkflowAccountConnectUrlParams, options?: RequestOptions$1) => Promise<WorkflowAccountConnectUrl>;
|
|
1101
|
+
connectAccount: (params: ConnectWorkflowAccountParams, options?: RequestOptions$1) => Promise<WorkflowAccount>;
|
|
1102
|
+
deleteAccount: (params: DeleteWorkflowAccountParams, options?: RequestOptions$1) => Promise<boolean>;
|
|
1089
1103
|
};
|
|
1090
1104
|
support: {
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
resolve(params: ResolveSupportConversationParams, opts?: RequestOptions$1): Promise<SupportConversation>;
|
|
1127
|
-
assign(params: AssignSupportConversationParams, opts?: RequestOptions$1): Promise<SupportConversation>;
|
|
1128
|
-
};
|
|
1105
|
+
createAgent: (params: CreateSupportAgentParams, opts?: RequestOptions$1) => Promise<SupportAgent>;
|
|
1106
|
+
getAgent: (params: {
|
|
1107
|
+
store_id: string;
|
|
1108
|
+
id: string;
|
|
1109
|
+
}, opts?: RequestOptions$1) => Promise<SupportAgent>;
|
|
1110
|
+
findAgents: (params: {
|
|
1111
|
+
store_id: string;
|
|
1112
|
+
status?: string;
|
|
1113
|
+
limit?: number;
|
|
1114
|
+
cursor?: string;
|
|
1115
|
+
}, opts?: RequestOptions$1) => Promise<{
|
|
1116
|
+
items: SupportAgent[];
|
|
1117
|
+
cursor?: string;
|
|
1118
|
+
}>;
|
|
1119
|
+
updateAgent: (params: UpdateSupportAgentParams, opts?: RequestOptions$1) => Promise<SupportAgent>;
|
|
1120
|
+
deleteAgent: (params: {
|
|
1121
|
+
store_id: string;
|
|
1122
|
+
id: string;
|
|
1123
|
+
}, opts?: RequestOptions$1) => Promise<void>;
|
|
1124
|
+
findConversations: (params: {
|
|
1125
|
+
store_id: string;
|
|
1126
|
+
status?: string;
|
|
1127
|
+
agent_id?: string;
|
|
1128
|
+
query?: string;
|
|
1129
|
+
limit?: number;
|
|
1130
|
+
cursor?: string;
|
|
1131
|
+
}, opts?: RequestOptions$1) => Promise<{
|
|
1132
|
+
items: SupportConversation[];
|
|
1133
|
+
cursor?: string;
|
|
1134
|
+
}>;
|
|
1135
|
+
getConversation: (params: GetSupportConversationParams, opts?: RequestOptions$1) => Promise<SupportConversationResponse>;
|
|
1136
|
+
sendConversationMessage: (params: SendSupportMessageParams, opts?: RequestOptions$1) => Promise<SupportConversationResponse>;
|
|
1137
|
+
replyToConversation: (params: ReplySupportConversationParams, opts?: RequestOptions$1) => Promise<SupportConversationResponse>;
|
|
1138
|
+
resolveConversation: (params: ResolveSupportConversationParams, opts?: RequestOptions$1) => Promise<SupportConversation>;
|
|
1139
|
+
assignConversation: (params: AssignSupportConversationParams, opts?: RequestOptions$1) => Promise<SupportConversation>;
|
|
1129
1140
|
};
|
|
1130
1141
|
};
|
|
1131
1142
|
analytics: {
|
|
@@ -1133,6 +1144,13 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
1133
1144
|
store_id?: string;
|
|
1134
1145
|
}): Promise<AnalyticsResponse>;
|
|
1135
1146
|
};
|
|
1147
|
+
experiments: {
|
|
1148
|
+
create(params: CreateExperimentParams, options?: RequestOptions$1): Promise<Experiment>;
|
|
1149
|
+
update(params: UpdateExperimentParams, options?: RequestOptions$1): Promise<Experiment>;
|
|
1150
|
+
get(params: GetExperimentParams, options?: RequestOptions$1): Promise<Experiment>;
|
|
1151
|
+
find(params?: FindExperimentsParams, options?: RequestOptions$1): Promise<PaginatedResponse<Experiment>>;
|
|
1152
|
+
results(params: GetExperimentParams, options?: RequestOptions$1): Promise<ExperimentResults>;
|
|
1153
|
+
};
|
|
1136
1154
|
setStoreId: (storeId: string) => void;
|
|
1137
1155
|
getStoreId: () => string;
|
|
1138
1156
|
setMarket: (market: string) => void;
|
|
@@ -1143,7 +1161,6 @@ declare function createAdmin(config: CreateAdminConfig): {
|
|
|
1143
1161
|
readonly isAuthenticated: boolean;
|
|
1144
1162
|
onAuthStateChanged(listener: AuthStateListener<AdminSession>): () => void;
|
|
1145
1163
|
logout(): Promise<void>;
|
|
1146
|
-
extractBlockValues: typeof extractBlockValues;
|
|
1147
1164
|
utils: {
|
|
1148
1165
|
getImageUrl: (imageBlock: any, isBlock?: boolean) => any;
|
|
1149
1166
|
getBlockValue: (entry: any, blockKey: string) => any;
|
|
@@ -1199,15 +1216,15 @@ declare function createStorefront(config: CreateStorefrontConfig): {
|
|
|
1199
1216
|
email?: string;
|
|
1200
1217
|
verify?: boolean;
|
|
1201
1218
|
market?: string;
|
|
1202
|
-
}) => Promise<
|
|
1219
|
+
}) => Promise<ContactSession>;
|
|
1203
1220
|
verify: (params: {
|
|
1204
1221
|
code: string;
|
|
1205
|
-
}) => Promise<
|
|
1222
|
+
}) => Promise<ContactToken>;
|
|
1206
1223
|
logout: () => Promise<void>;
|
|
1207
|
-
me: () => Promise<
|
|
1208
|
-
readonly session:
|
|
1224
|
+
me: () => Promise<ContactDetail>;
|
|
1225
|
+
readonly session: ContactSession | null;
|
|
1209
1226
|
readonly isAuthenticated: boolean;
|
|
1210
|
-
onAuthStateChanged(listener: AuthStateListener<
|
|
1227
|
+
onAuthStateChanged(listener: AuthStateListener<ContactSession>): () => void;
|
|
1211
1228
|
store: {
|
|
1212
1229
|
getStore(options?: RequestOptions$1): Promise<Store>;
|
|
1213
1230
|
location: {
|
|
@@ -1240,25 +1257,12 @@ declare function createStorefront(config: CreateStorefrontConfig): {
|
|
|
1240
1257
|
};
|
|
1241
1258
|
cart: CartController;
|
|
1242
1259
|
cms: {
|
|
1243
|
-
|
|
1244
|
-
get(params:
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
key: string;
|
|
1250
|
-
store_id: string;
|
|
1251
|
-
parent_id?: string | null;
|
|
1252
|
-
blocks: Block[];
|
|
1253
|
-
taxonomies: TaxonomyEntry[];
|
|
1254
|
-
status: NodeStatus;
|
|
1255
|
-
slug: Record<string, string>;
|
|
1256
|
-
children: Node[];
|
|
1257
|
-
created_at: number;
|
|
1258
|
-
updated_at: number;
|
|
1259
|
-
}>;
|
|
1260
|
-
find(params: GetNodesParams, options?: RequestOptions$1): Promise<PaginatedResponse<Node>>;
|
|
1261
|
-
getChildren(params: GetNodeChildrenParams, options?: RequestOptions$1): Promise<PaginatedResponse<Node>>;
|
|
1260
|
+
collection: {
|
|
1261
|
+
get(params: GetCollectionParams, options?: RequestOptions$1): Promise<Collection>;
|
|
1262
|
+
};
|
|
1263
|
+
entry: {
|
|
1264
|
+
get(params: GetEntryParams, options?: RequestOptions$1): Promise<CollectionEntry>;
|
|
1265
|
+
find(params: GetEntriesParams, options?: RequestOptions$1): Promise<PaginatedResponse<CollectionEntry>>;
|
|
1262
1266
|
};
|
|
1263
1267
|
form: {
|
|
1264
1268
|
get(params: GetFormParams, options?: RequestOptions$1): Promise<Form>;
|
|
@@ -1287,6 +1291,7 @@ declare function createStorefront(config: CreateStorefrontConfig): {
|
|
|
1287
1291
|
order: {
|
|
1288
1292
|
get(params: GetOrderParams, options?: RequestOptions$1): Promise<Order>;
|
|
1289
1293
|
find(params: GetOrdersParams, options?: RequestOptions$1): Promise<PaginatedResponse<Order>>;
|
|
1294
|
+
downloadDigitalAccess(params: DownloadDigitalAccessParams, options?: RequestOptions$1): Promise<DigitalAccessDownloadResponse>;
|
|
1290
1295
|
};
|
|
1291
1296
|
service: {
|
|
1292
1297
|
get(params: GetServiceParams, options?: RequestOptions$1): Promise<Service>;
|
|
@@ -1300,7 +1305,7 @@ declare function createStorefront(config: CreateStorefrontConfig): {
|
|
|
1300
1305
|
};
|
|
1301
1306
|
};
|
|
1302
1307
|
crm: {
|
|
1303
|
-
|
|
1308
|
+
contact: {
|
|
1304
1309
|
identify(params?: {
|
|
1305
1310
|
email?: string;
|
|
1306
1311
|
verify?: boolean;
|
|
@@ -1310,24 +1315,27 @@ declare function createStorefront(config: CreateStorefrontConfig): {
|
|
|
1310
1315
|
code: string;
|
|
1311
1316
|
}, options?: RequestOptions$1): Promise<VerifyResponse>;
|
|
1312
1317
|
logout(options?: RequestOptions$1): Promise<void>;
|
|
1313
|
-
getMe(options?: RequestOptions$1): Promise<
|
|
1318
|
+
getMe(options?: RequestOptions$1): Promise<ContactDetail>;
|
|
1314
1319
|
};
|
|
1315
|
-
|
|
1316
|
-
get(params:
|
|
1317
|
-
find(params?:
|
|
1318
|
-
subscribe(params:
|
|
1319
|
-
checkAccess(params:
|
|
1320
|
+
contactList: {
|
|
1321
|
+
get(params: GetContactListParams, options?: RequestOptions$1): Promise<ContactList>;
|
|
1322
|
+
find(params?: FindContactListsParams, options?: RequestOptions$1): Promise<PaginatedResponse<ContactList>>;
|
|
1323
|
+
subscribe(params: SubscribeContactListParams, options?: RequestOptions$1): Promise<ContactListSubscribeResponse>;
|
|
1324
|
+
checkAccess(params: ContactListAccessParams, options?: RequestOptions$1): Promise<ContactListAccessResponse>;
|
|
1320
1325
|
unsubscribe(token: string, options?: RequestOptions$1): Promise<{
|
|
1321
|
-
|
|
1326
|
+
success: boolean;
|
|
1322
1327
|
}>;
|
|
1323
1328
|
confirm(token: string, options?: RequestOptions$1): Promise<{
|
|
1324
|
-
|
|
1329
|
+
success: boolean;
|
|
1325
1330
|
}>;
|
|
1326
1331
|
};
|
|
1327
1332
|
};
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
track(params:
|
|
1333
|
+
action: {
|
|
1334
|
+
COMMON_ACTION_KEYS: readonly ["page.view", "product.view", "service.view", "provider.view", "cart.added", "cart.removed", "checkout.started", "order.created", "signin", "signup", "verified.email", "search", "share", "wishlist.added"];
|
|
1335
|
+
track(params: TrackActionParams): Promise<void>;
|
|
1336
|
+
};
|
|
1337
|
+
experiments: {
|
|
1338
|
+
use(params: UseExperimentParams, options?: RequestOptions$1): Promise<ExperimentUseResponse>;
|
|
1331
1339
|
};
|
|
1332
1340
|
support: {
|
|
1333
1341
|
startConversation(params?: Omit<StartSupportConversationParams, "store_id">, opts?: RequestOptions$1): Promise<SupportConversationResponse>;
|
|
@@ -1340,7 +1348,6 @@ declare function createStorefront(config: CreateStorefrontConfig): {
|
|
|
1340
1348
|
getMarket: () => string;
|
|
1341
1349
|
setLocale: (l: string) => void;
|
|
1342
1350
|
getLocale: () => string;
|
|
1343
|
-
extractBlockValues: typeof extractBlockValues;
|
|
1344
1351
|
utils: {
|
|
1345
1352
|
getImageUrl: (imageBlock: any, isBlock?: boolean) => any;
|
|
1346
1353
|
getBlockValue: (entry: any, blockKey: string) => any;
|
|
@@ -1386,4 +1393,4 @@ declare function createStorefront(config: CreateStorefrontConfig): {
|
|
|
1386
1393
|
};
|
|
1387
1394
|
};
|
|
1388
1395
|
|
|
1389
|
-
export { type
|
|
1396
|
+
export { type AnalyticsActionReportKey as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type ExperimentUseResponse as E, type CartControllerRefreshParams as F, type GetSupportConversationParams as G, type CartControllerRemoveItemParams as H, type IdentifyResponse as I, type CartControllerState as J, type CartControllerUpdateParams as K, type CommonActionKey as L, type HttpClientConfig as M, createCartController as N, createStorefront as O, type ActionFeedCategory as P, type ActionFeedCursor as Q, type ActionFeedData as R, type StartSupportConversationParams as S, type TrackActionParams as T, type UseExperimentParams as U, type VerifyResponse as V, type ActionFeedItem as W, type ActionFeedSummary as X, type AdminSession as Y, type AdminSessionInternal as Z, type AdminSessionUpdater as _, type ContactSession as a, type AnalyticsBlockRequest as a0, type AnalyticsBlockResponse as a1, type AnalyticsBreakdownData as a2, type AnalyticsBreakdownItem as a3, type AnalyticsBreakdownReportKey as a4, type AnalyticsCompositeReportKey as a5, type AnalyticsMetricData as a6, type AnalyticsMetricReportKey as a7, type AnalyticsReport as a8, type AnalyticsReportKey as a9, type OutreachFunnelData as aA, type OutreachFunnelStage as aB, type OutreachOverviewData as aC, type ReplySupportConversationParams as aD, type ResolveSupportConversationParams as aE, type RevenueByCurrencyData as aF, SDK_VERSION as aG, SUPPORTED_FRAMEWORKS as aH, type SupportAction as aI, type SupportAgent as aJ, type SupportAgentAiConfig as aK, type SupportAgentEdge as aL, type SupportAgentNode as aM, type SupportConversation as aN, type SupportMessage as aO, type TimelineParams as aP, type UpdateExperimentParams as aQ, type WorkflowTool as aR, type WorkflowToolOperation as aS, type WorkflowToolResource as aT, createAdmin as aU, type AnalyticsReportRequest as aa, type AnalyticsRequest as ab, type AnalyticsResponse as ac, type AnalyticsTimeRange as ad, type ApiConfig as ae, type AssignSupportConversationParams as af, type BusinessOverviewData as ag, type ContactFunnelData as ah, type ContactFunnelStage as ai, type ContactSessionInternal as aj, type ContactSessionUpdater as ak, type CreateAdminConfig as al, type CreateExperimentParams as am, type DataHealthData as an, type EdgeTrigger as ao, type EntityStatusOverviewData as ap, type Experiment as aq, type ExperimentResults as ar, type ExperimentStatus as as, type ExperimentVariant as at, type ExperimentVariantResult as au, type FindExperimentsParams as av, type GetCountriesResponse as aw, type GetExperimentParams as ax, type LocationCountry as ay, type LocationState as az, type ContactToken as b, type CartController as c, type SupportConversationResponse as d, type SendSupportMessageParams as e, formatBlockValue as f, getBlockLabel as g, extractBlockValues as h, findTimeZone as i, humanize as j, categorify as k, formatDate as l, getSvgContentForAstro as m, fetchSvgContent as n, injectSvgIntoElement as o, prepareBlocksForSubmission as p, type StorefrontAction as q, type AuthStorage as r, slugify as s, COMMON_ACTION_KEYS as t, type CartApi as u, validatePhoneNumber as v, type CartControllerAddItemParams as w, type CartControllerCheckoutParams as x, type CartControllerClearParams as y, type CartControllerInitParams as z };
|