arky-sdk 0.7.134 → 0.8.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.
@@ -135,6 +135,62 @@ interface AnalyticsQueryResponse {
135
135
  execution_ms: number;
136
136
  };
137
137
  }
138
+ type ActivityFeedCategory = "orders" | "carts" | "promo_codes" | "submissions" | "customers" | "audiences" | "products" | "services" | "providers" | "cms" | "workflows" | "agents" | "activities";
139
+ interface ActivityFeedQuery {
140
+ limit?: number;
141
+ since?: number;
142
+ cursor_created_at?: number;
143
+ cursor_id?: string;
144
+ category?: ActivityFeedCategory;
145
+ }
146
+ interface ActivityFeedItem {
147
+ id: string;
148
+ entity: string;
149
+ entity_id: string;
150
+ action: string;
151
+ event_type: string;
152
+ status: string;
153
+ customer_id: string;
154
+ category: string;
155
+ title: string;
156
+ description: string;
157
+ href?: string | null;
158
+ booking_count: number;
159
+ data: unknown;
160
+ payload: unknown;
161
+ created_at: number;
162
+ }
163
+ interface ActivityFeedSummary {
164
+ total: number;
165
+ orders: number;
166
+ submissions: number;
167
+ customers: number;
168
+ audiences: number;
169
+ abandoned_carts: number;
170
+ carts: number;
171
+ promo_codes: number;
172
+ products: number;
173
+ services: number;
174
+ providers: number;
175
+ cms: number;
176
+ workflows: number;
177
+ agents: number;
178
+ activities: number;
179
+ window_start: number;
180
+ }
181
+ interface ActivityFeedCursor {
182
+ created_at: number;
183
+ id: string;
184
+ }
185
+ interface ActivityFeedResponse {
186
+ items: ActivityFeedItem[];
187
+ summary: ActivityFeedSummary;
188
+ next_cursor?: ActivityFeedCursor | null;
189
+ meta: {
190
+ row_count: number;
191
+ execution_ms: number;
192
+ };
193
+ }
138
194
 
139
195
  interface Activity {
140
196
  id: string;
@@ -709,6 +765,9 @@ declare function createAdmin(config: CreateAdminConfig): {
709
765
  query: (spec: AnalyticsQuery, options?: RequestOptions$1 & {
710
766
  store_id?: string;
711
767
  }) => Promise<AnalyticsQueryResponse>;
768
+ activityFeed: (query?: ActivityFeedQuery, options?: RequestOptions$1 & {
769
+ store_id?: string;
770
+ }) => Promise<ActivityFeedResponse>;
712
771
  };
713
772
  setStoreId: (storeId: string) => void;
714
773
  getStoreId: () => string;
@@ -993,4 +1052,4 @@ declare function createStorefront(config: CreateStorefrontConfig): {
993
1052
  };
994
1053
  };
995
1054
 
996
- export { type AnalyticsQueryResponse as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsQuery as _, type CustomerSession as a, type AnalyticsRow as a0, type Measure as a1, type Dimension as a2, type Filter as a3, type FilterField as a4, type FilterOp as a5, type Granularity as a6, type EntityKind as a7, type TimeRange as a8, type TimeUnit as a9, type OrderBy as aa, type TimelineParams as ab, type IntegrationOperation as ac, type IntegrationResource as ad, type IntegrationService as ae, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType 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 };
1055
+ export { type AnalyticsQueryResponse as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsQuery as _, type CustomerSession as a, type AnalyticsRow as a0, type Measure as a1, type Dimension as a2, type Filter as a3, type FilterField as a4, type FilterOp as a5, type Granularity as a6, type EntityKind as a7, type TimeRange as a8, type TimeUnit as a9, type OrderBy as aa, type ActivityFeedCategory as ab, type ActivityFeedQuery as ac, type ActivityFeedItem as ad, type ActivityFeedSummary as ae, type ActivityFeedCursor as af, type ActivityFeedResponse as ag, type TimelineParams as ah, type IntegrationOperation as ai, type IntegrationResource as aj, type IntegrationService as ak, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType 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 };
@@ -135,6 +135,62 @@ interface AnalyticsQueryResponse {
135
135
  execution_ms: number;
136
136
  };
137
137
  }
138
+ type ActivityFeedCategory = "orders" | "carts" | "promo_codes" | "submissions" | "customers" | "audiences" | "products" | "services" | "providers" | "cms" | "workflows" | "agents" | "activities";
139
+ interface ActivityFeedQuery {
140
+ limit?: number;
141
+ since?: number;
142
+ cursor_created_at?: number;
143
+ cursor_id?: string;
144
+ category?: ActivityFeedCategory;
145
+ }
146
+ interface ActivityFeedItem {
147
+ id: string;
148
+ entity: string;
149
+ entity_id: string;
150
+ action: string;
151
+ event_type: string;
152
+ status: string;
153
+ customer_id: string;
154
+ category: string;
155
+ title: string;
156
+ description: string;
157
+ href?: string | null;
158
+ booking_count: number;
159
+ data: unknown;
160
+ payload: unknown;
161
+ created_at: number;
162
+ }
163
+ interface ActivityFeedSummary {
164
+ total: number;
165
+ orders: number;
166
+ submissions: number;
167
+ customers: number;
168
+ audiences: number;
169
+ abandoned_carts: number;
170
+ carts: number;
171
+ promo_codes: number;
172
+ products: number;
173
+ services: number;
174
+ providers: number;
175
+ cms: number;
176
+ workflows: number;
177
+ agents: number;
178
+ activities: number;
179
+ window_start: number;
180
+ }
181
+ interface ActivityFeedCursor {
182
+ created_at: number;
183
+ id: string;
184
+ }
185
+ interface ActivityFeedResponse {
186
+ items: ActivityFeedItem[];
187
+ summary: ActivityFeedSummary;
188
+ next_cursor?: ActivityFeedCursor | null;
189
+ meta: {
190
+ row_count: number;
191
+ execution_ms: number;
192
+ };
193
+ }
138
194
 
139
195
  interface Activity {
140
196
  id: string;
@@ -709,6 +765,9 @@ declare function createAdmin(config: CreateAdminConfig): {
709
765
  query: (spec: AnalyticsQuery, options?: RequestOptions$1 & {
710
766
  store_id?: string;
711
767
  }) => Promise<AnalyticsQueryResponse>;
768
+ activityFeed: (query?: ActivityFeedQuery, options?: RequestOptions$1 & {
769
+ store_id?: string;
770
+ }) => Promise<ActivityFeedResponse>;
712
771
  };
713
772
  setStoreId: (storeId: string) => void;
714
773
  getStoreId: () => string;
@@ -993,4 +1052,4 @@ declare function createStorefront(config: CreateStorefrontConfig): {
993
1052
  };
994
1053
  };
995
1054
 
996
- export { type AnalyticsQueryResponse as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsQuery as _, type CustomerSession as a, type AnalyticsRow as a0, type Measure as a1, type Dimension as a2, type Filter as a3, type FilterField as a4, type FilterOp as a5, type Granularity as a6, type EntityKind as a7, type TimeRange as a8, type TimeUnit as a9, type OrderBy as aa, type TimelineParams as ab, type IntegrationOperation as ac, type IntegrationResource as ad, type IntegrationService as ae, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType 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 };
1055
+ export { type AnalyticsQueryResponse as $, type AuthStateListener as A, type CartControllerListener as B, type CreateStorefrontConfig as C, type CartControllerQuoteParams as D, type CartControllerRefreshParams as E, type CartControllerRemoveItemParams as F, type CartControllerState as G, type CartControllerUpdateParams as H, type IdentifyResponse as I, type HttpClientConfig as J, type AuthStorage as K, SUPPORTED_FRAMEWORKS as L, type ApiConfig as M, type AdminSessionInternal as N, type CustomerSessionInternal as O, type AdminSession as P, type AdminSessionUpdater as Q, type CustomerSessionUpdater as R, SDK_VERSION as S, type TrackParams as T, type CreateAdminConfig as U, type VerifyResponse as V, createAdmin as W, type LocationState as X, type LocationCountry as Y, type GetCountriesResponse as Z, type AnalyticsQuery as _, type CustomerSession as a, type AnalyticsRow as a0, type Measure as a1, type Dimension as a2, type Filter as a3, type FilterField as a4, type FilterOp as a5, type Granularity as a6, type EntityKind as a7, type TimeRange as a8, type TimeUnit as a9, type OrderBy as aa, type ActivityFeedCategory as ab, type ActivityFeedQuery as ac, type ActivityFeedItem as ad, type ActivityFeedSummary as ae, type ActivityFeedCursor as af, type ActivityFeedResponse as ag, type TimelineParams as ah, type IntegrationOperation as ai, type IntegrationResource as aj, type IntegrationService as ak, type CustomerToken as b, type CartController as c, findTimeZone as d, extractBlockValues as e, formatBlockValue as f, getBlockLabel as g, humanize as h, categorify as i, formatDate as j, getSvgContentForAstro as k, fetchSvgContent as l, injectSvgIntoElement as m, type Activity$1 as n, COMMON_ACTIVITY_TYPES as o, prepareBlocksForSubmission as p, createStorefront as q, createCartController as r, slugify as s, type CommonActivityType 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 };
package/dist/admin.cjs CHANGED
@@ -1891,6 +1891,13 @@ var createAnalyticsApi = (apiConfig) => {
1891
1891
  spec,
1892
1892
  options
1893
1893
  );
1894
+ },
1895
+ async activityFeed(query = {}, options) {
1896
+ const store_id = options?.store_id || apiConfig.storeId;
1897
+ return apiConfig.httpClient.get(
1898
+ `/v1/stores/${store_id}/analytics/activity-feed`,
1899
+ { ...options, params: query }
1900
+ );
1894
1901
  }
1895
1902
  };
1896
1903
  };
@@ -2428,7 +2435,8 @@ function createAdmin(config) {
2428
2435
  }
2429
2436
  },
2430
2437
  analytics: {
2431
- query: analyticsApi.query
2438
+ query: analyticsApi.query,
2439
+ activityFeed: analyticsApi.activityFeed
2432
2440
  },
2433
2441
  setStoreId: (storeId) => {
2434
2442
  apiConfig.storeId = storeId;