zorihq 0.11.1 → 0.12.0

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

@@ -43,8 +43,10 @@ export class Analytics extends APIResource {
    * ```ts
    * const dashboardMetricsResponse =
    *   await client.v1.analytics.dashboard({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -120,35 +122,20 @@ export interface DashboardMetricsResponse {
 
   avg_session_duration_seconds?: number;
 
-  /**
-   * Engagement metrics
-   */
   bounce_rate?: number;
 
-  /**
-   * Active users
-   */
   dau?: number;
 
   mau?: number;
 
   return_rate?: number;
 
-  /**
-   * Sessions
-   */
   sessions_today?: number;
 
-  /**
-   * Total metrics
-   */
   total_events?: number;
 
   total_sessions_in_period?: number;
 
-  /**
-   * Total unique sessions in period
-   */
   unique_sessions?: number;
 
   unique_visitors?: number;
@@ -157,14 +144,8 @@ export interface DashboardMetricsResponse {
 }
 
 export interface EventFilterOptionsResponse {
-  /**
-   * Unique page paths
-   */
   pages?: Array<string>;
 
-  /**
-   * Unique referrer domains
-   */
   traffic_origins?: Array<string>;
 }
 
@@ -215,16 +196,10 @@ export interface RecentEvent {
 
   click_element_selector?: string;
 
-  /**
-   * Click element details
-   */
   click_element_tag?: string;
 
   click_element_text?: string;
 
-  /**
-   * Click element classification
-   */
   click_element_type?: string;
 
   click_position_x?: number;
@@ -357,16 +332,10 @@ export interface VisitorEvent {
 
   click_element_selector?: string;
 
-  /**
-   * Click element details
-   */
   click_element_tag?: string;
 
   click_element_text?: string;
 
-  /**
-   * Click element classification
-   */
   click_element_type?: string;
 
   click_position_x?: number;
@@ -451,15 +420,23 @@ export interface VisitorsByOriginResponse {
 }
 
 export interface AnalyticsDashboardParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  offset: number;
+
+  projectID: string;
+
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customerID?: string;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 Analytics.Visitors = Visitors;

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

@@ -13,7 +13,10 @@ export class Events extends APIResource {
    * ```ts
    * const eventFilterOptionsResponse =
    *   await client.v1.analytics.events.filterOptions({
-   *     project_id: 'project_id',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -32,7 +35,10 @@ export class Events extends APIResource {
    * ```ts
    * const recentEventsResponse =
    *   await client.v1.analytics.events.recent({
-   *     project_id: 'project_id',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -42,57 +48,51 @@ export class Events extends APIResource {
 }
 
 export interface EventFilterOptionsParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Time range
-   */
-  time_range?: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  offset: number;
+
+  projectID: string;
+
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customerID?: string;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export interface EventRecentParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Filter by external ID
-   */
-  external_id?: string;
+  offset: number;
 
-  /**
-   * Maximum number of events to return (default: 15)
-   */
-  limit?: number;
+  projectID: string;
 
-  /**
-   * Offset for pagination (default: 0)
-   */
-  offset?: number;
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  /**
-   * Filter by page path
-   */
-  page_path?: string;
+  customerID?: string;
 
-  /**
-   * Filter by traffic origin (referrer domain)
-   */
-  traffic_origin?: string;
+  externalID?: string;
 
-  /**
-   * Filter by user ID
-   */
-  user_id?: string;
+  pagePath?: string;
 
-  /**
-   * Filter by visitor ID
-   */
-  visitor_id?: string;
+  referrer?: string;
+
+  trafficOrigin?: string;
+
+  userID?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export declare namespace Events {

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

@@ -13,8 +13,10 @@ export class Retention extends APIResource {
    * ```ts
    * const churnRateResponse =
    *   await client.v1.analytics.retention.churnRate({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -32,8 +34,10 @@ export class Retention extends APIResource {
    * ```ts
    * const cohortAnalysisResponse =
    *   await client.v1.analytics.retention.cohorts({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -51,8 +55,10 @@ export class Retention extends APIResource {
    * ```ts
    * const returnRateResponse =
    *   await client.v1.analytics.retention.returnRate({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -65,44 +71,63 @@ export class Retention extends APIResource {
 }
 
 export interface RetentionChurnRateParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  offset: number;
 
-  /**
-   * Days of inactivity to consider churned (default: 30)
-   */
-  churn_threshold_days?: number;
+  projectID: string;
+
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customerID?: string;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export interface RetentionCohortsParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  offset: number;
+
+  projectID: string;
+
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customerID?: string;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export interface RetentionReturnRateParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  offset: number;
+
+  projectID: string;
+
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customerID?: string;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export declare namespace Retention {

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

@@ -13,8 +13,10 @@ export class Sessions extends APIResource {
    * ```ts
    * const bounceRateResponse =
    *   await client.v1.analytics.sessions.bounceRate({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -32,8 +34,10 @@ export class Sessions extends APIResource {
    * ```ts
    * const sessionMetricsResponse =
    *   await client.v1.analytics.sessions.metrics({
-   *     project_id: 'project_id',
-   *     time_range: 'last_hour',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -46,32 +50,43 @@ export class Sessions extends APIResource {
 }
 
 export interface SessionBounceRateParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  offset: number;
 
-  /**
-   * Limit for per-page breakdown (default: 20)
-   */
-  limit?: number;
+  projectID: string;
+
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customerID?: string;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export interface SessionMetricsParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  limit: number;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  offset: number;
+
+  projectID: string;
+
+  timeBoundaries: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customerID?: string;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export declare namespace Sessions {

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

@@ -13,7 +13,10 @@ export class Users extends APIResource {
    * ```ts
    * const activeUsersResponse =
    *   await client.v1.analytics.users.active({
-   *     project_id: 'project_id',
+   *     limit: 1,
+   *     offset: 0,
+   *     projectID: 'projectID',
+   *     timeBoundaries: 'last_hour',
    *   });
    * ```
    */
@@ -23,10 +26,23 @@ export class Users extends APIResource {
 }
 
 export interface UserActiveParams {
-  /**
-   * Project ID
-   */
-  project_id: string;
+  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;
+
+  utmtagValue?: string;
+
+  visitorID?: string;
 }
 
 export declare namespace Users {