zorihq 0.12.0 → 0.14.0

package/src/resources/v1/analytics/analytics.ts

@@ -43,10 +43,8 @@ export class Analytics extends APIResource {
    * ```ts
    * const dashboardMetricsResponse =
    *   await client.v1.analytics.dashboard({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -144,6 +142,8 @@ export interface DashboardMetricsResponse {
 }
 
 export interface EventFilterOptionsResponse {
+  event_names?: Array<string>;
+
   pages?: Array<string>;
 
   traffic_origins?: Array<string>;
@@ -278,23 +278,39 @@ export interface SessionMetricsResponse {
 export interface TopVisitor {
   browser_name?: string;
 
+  currency?: string;
+
   device_type?: string;
 
+  distinct_payments?: number;
+
+  email?: string;
+
   event_count?: number;
 
   external_id?: string;
 
+  first_payment_date?: string;
+
   first_seen?: string;
 
+  is_grouped?: boolean;
+
   last_seen?: string;
 
   location_city?: string;
 
   location_country_iso?: string;
 
+  name?: string;
+
+  time_to_first_purchase_seconds?: number;
+
+  total_revenue?: number;
+
   user_id?: string;
 
-  visitor_id?: string;
+  visitor_ids?: Array<string>;
 }
 
 export interface TopVisitorsResponse {
@@ -420,15 +436,15 @@ export interface VisitorsByOriginResponse {
 }
 
 export interface AnalyticsDashboardParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -436,7 +452,7 @@ export interface AnalyticsDashboardParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 Analytics.Visitors = Visitors;

package/src/resources/v1/analytics/events.ts

@@ -7,16 +7,15 @@ import { RequestOptions } from '../../../internal/request-options';
 
 export class Events extends APIResource {
   /**
-   * Get unique traffic origins and page paths to populate filter dropdowns
+   * Get unique traffic origins, page paths, and event names to populate filter
+   * dropdowns
    *
    * @example
    * ```ts
    * const eventFilterOptionsResponse =
    *   await client.v1.analytics.events.filterOptions({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -29,16 +28,14 @@ export class Events extends APIResource {
 
   /**
    * Get a list of recent events with optional filters (visitor_id, user_id,
-   * external_id, traffic_origin, page_path)
+   * external_id, traffic_origin, page_path, event_name)
    *
    * @example
    * ```ts
    * const recentEventsResponse =
    *   await client.v1.analytics.events.recent({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -48,15 +45,15 @@ export class Events extends APIResource {
 }
 
 export interface EventFilterOptionsParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -64,35 +61,37 @@ export interface EventFilterOptionsParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface EventRecentParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  event_name?: string;
 
-  customerID?: string;
+  external_id?: string;
 
-  externalID?: string;
+  limit?: number;
 
-  pagePath?: string;
+  offset?: number;
+
+  page_path?: string;
 
   referrer?: string;
 
-  trafficOrigin?: string;
+  traffic_origin?: string;
 
-  userID?: string;
+  user_id?: string;
 
   utmtag?: string;
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export declare namespace Events {

package/src/resources/v1/analytics/retention.ts

@@ -13,10 +13,8 @@ export class Retention extends APIResource {
    * ```ts
    * const churnRateResponse =
    *   await client.v1.analytics.retention.churnRate({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -34,10 +32,8 @@ export class Retention extends APIResource {
    * ```ts
    * const cohortAnalysisResponse =
    *   await client.v1.analytics.retention.cohorts({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -55,10 +51,8 @@ export class Retention extends APIResource {
    * ```ts
    * const returnRateResponse =
    *   await client.v1.analytics.retention.returnRate({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -71,15 +65,15 @@ export class Retention extends APIResource {
 }
 
 export interface RetentionChurnRateParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -87,19 +81,19 @@ export interface RetentionChurnRateParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface RetentionCohortsParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -107,19 +101,19 @@ export interface RetentionCohortsParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface RetentionReturnRateParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -127,7 +121,7 @@ export interface RetentionReturnRateParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export declare namespace Retention {

package/src/resources/v1/analytics/sessions.ts

@@ -13,10 +13,8 @@ export class Sessions extends APIResource {
    * ```ts
    * const bounceRateResponse =
    *   await client.v1.analytics.sessions.bounceRate({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -34,10 +32,8 @@ export class Sessions extends APIResource {
    * ```ts
    * const sessionMetricsResponse =
    *   await client.v1.analytics.sessions.metrics({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -50,15 +46,15 @@ export class Sessions extends APIResource {
 }
 
 export interface SessionBounceRateParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -66,19 +62,19 @@ export interface SessionBounceRateParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface SessionMetricsParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -86,7 +82,7 @@ export interface SessionMetricsParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export declare namespace Sessions {

package/src/resources/v1/analytics/users.ts

@@ -13,10 +13,8 @@ export class Users extends APIResource {
    * ```ts
    * const activeUsersResponse =
    *   await client.v1.analytics.users.active({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -26,15 +24,15 @@ export class Users extends APIResource {
 }
 
 export interface UserActiveParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -42,7 +40,7 @@ export interface UserActiveParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export declare namespace Users {

package/src/resources/v1/analytics/visitors.ts

@@ -13,10 +13,8 @@ export class Visitors extends APIResource {
    * ```ts
    * const visitorsByCountryResponse =
    *   await client.v1.analytics.visitors.byCountry({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -35,10 +33,8 @@ export class Visitors extends APIResource {
    * ```ts
    * const visitorsByDeviceResponse =
    *   await client.v1.analytics.visitors.byDevice({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -56,10 +52,8 @@ export class Visitors extends APIResource {
    * ```ts
    * const visitorsByOriginResponse =
    *   await client.v1.analytics.visitors.byOrigin({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -98,10 +92,7 @@ export class Visitors extends APIResource {
    * ```ts
    * const visitorProfileResponse =
    *   await client.v1.analytics.visitors.profile({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
    *   });
    * ```
    */
@@ -120,10 +111,8 @@ export class Visitors extends APIResource {
    * ```ts
    * const uniqueVisitorsTimelineResponse =
    *   await client.v1.analytics.visitors.timeline({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -135,16 +124,16 @@ export class Visitors extends APIResource {
   }
 
   /**
-   * Get a list of the most active visitors ranked by event count
+   * Get top visitors grouped by identified information (user_id, external_id, email)
+   * with payment metrics including revenue, distinct payments, and time to first
+   * purchase
    *
    * @example
    * ```ts
    * const topVisitorsResponse =
    *   await client.v1.analytics.visitors.top({
-   *     limit: 1,
-   *     offset: 0,
-   *     projectID: 'projectID',
-   *     timeBoundaries: 'last_hour',
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -154,15 +143,15 @@ export class Visitors extends APIResource {
 }
 
 export interface VisitorByCountryParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -170,19 +159,19 @@ export interface VisitorByCountryParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface VisitorByDeviceParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -190,19 +179,19 @@ export interface VisitorByDeviceParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface VisitorByOriginParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -210,7 +199,7 @@ export interface VisitorByOriginParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface VisitorIdentifyParams {
@@ -232,35 +221,23 @@ export interface VisitorIdentifyParams {
 }
 
 export interface VisitorProfileParams {
-  limit: number;
-
-  offset: number;
-
-  projectID: string;
-
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
-
-  customerID?: string;
-
-  referrer?: string;
-
-  utmtag?: string;
+  project_id: string;
 
-  utmtagValue?: string;
+  customer_id?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface VisitorTimelineParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -268,19 +245,19 @@ export interface VisitorTimelineParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export interface VisitorTopParams {
-  limit: number;
+  project_id: string;
 
-  offset: number;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  projectID: string;
+  customer_id?: string;
 
-  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  limit?: number;
 
-  customerID?: string;
+  offset?: number;
 
   referrer?: string;
 
@@ -288,7 +265,7 @@ export interface VisitorTopParams {
 
   utmtagValue?: string;
 
-  visitorID?: string;
+  visitor_id?: string;
 }
 
 export declare namespace Visitors {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.12.0'; // x-release-please-version
+export const VERSION = '0.14.0'; // x-release-please-version