zorihq 0.4.1 → 0.6.0

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

@@ -3,6 +3,17 @@
 import { APIResource } from '../../../core/resource';
 import * as EventsAPI from './events';
 import { EventRecentParams, Events } from './events';
+import * as RetentionAPI from './retention';
+import {
+  Retention,
+  RetentionChurnRateParams,
+  RetentionCohortsParams,
+  RetentionReturnRateParams,
+} from './retention';
+import * as SessionsAPI from './sessions';
+import { SessionBounceRateParams, SessionMetricsParams, Sessions } from './sessions';
+import * as UsersAPI from './users';
+import { UserActiveParams, Users } from './users';
 import * as VisitorsAPI from './visitors';
 import {
   VisitorByCountryParams,
@@ -13,10 +24,86 @@ import {
   VisitorTopParams,
   Visitors,
 } from './visitors';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class Analytics extends APIResource {
   visitors: VisitorsAPI.Visitors = new VisitorsAPI.Visitors(this._client);
   events: EventsAPI.Events = new EventsAPI.Events(this._client);
+  sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+  retention: RetentionAPI.Retention = new RetentionAPI.Retention(this._client);
+
+  /**
+   * Get combined key metrics including sessions, active users, bounce rate, and
+   * retention for dashboard display
+   *
+   * @example
+   * ```ts
+   * const dashboardMetricsResponse =
+   *   await client.v1.analytics.dashboard({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  dashboard(query: AnalyticsDashboardParams, options?: RequestOptions): APIPromise<DashboardMetricsResponse> {
+    return this._client.get('/api/v1/analytics/dashboard', { query, ...options });
+  }
+}
+
+export interface ActiveUsersResponse {
+  dau?: number;
+
+  mau?: number;
+
+  wau?: number;
+}
+
+export interface BounceRateByPageMetric {
+  bounce_rate?: number;
+
+  page?: string;
+
+  sessions?: number;
+}
+
+export interface BounceRateResponse {
+  by_page?: Array<BounceRateByPageMetric>;
+
+  overall_bounce_rate?: number;
+}
+
+export interface ChurnRateResponse {
+  churn_rate_percent?: number;
+
+  churn_threshold_days?: number;
+
+  churned_users?: number;
+
+  total_users?: number;
+}
+
+export interface CohortAnalysisResponse {
+  cohorts?: Array<CohortData>;
+}
+
+export interface CohortData {
+  cohort_period?: string;
+
+  cohort_size?: number;
+
+  month_1_retention?: number;
+
+  month_2_retention?: number;
+
+  month_3_retention?: number;
+
+  week_1_retention?: number;
+
+  week_2_retention?: number;
+
+  week_4_retention?: number;
 }
 
 export interface CountryDataPoint {
@@ -27,6 +114,42 @@ export interface CountryDataPoint {
   unique_visitors?: number;
 }
 
+export interface DashboardMetricsResponse {
+  avg_pages_per_session?: number;
+
+  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;
+
+  unique_visitors?: number;
+
+  wau?: number;
+}
+
 export interface EventsOverTimeDataPoint {
   event_count?: number;
 
@@ -69,6 +192,24 @@ export interface RecentEventsResponse {
   total?: number;
 }
 
+export interface ReturnRateResponse {
+  avg_time_between_sessions_hours?: number;
+
+  return_rate_percent?: number;
+
+  returning_users?: number;
+
+  total_users?: number;
+}
+
+export interface SessionMetricsResponse {
+  average_pages_per_session?: number;
+
+  average_session_duration_seconds?: number;
+
+  total_sessions?: number;
+}
+
 export interface TopVisitor {
   browser_name?: string;
 
@@ -165,16 +306,40 @@ export interface VisitorsByOriginResponse {
   data?: Array<OriginDataPoint>;
 }
 
+export interface AnalyticsDashboardParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+
 Analytics.Visitors = Visitors;
 Analytics.Events = Events;
+Analytics.Sessions = Sessions;
+Analytics.Users = Users;
+Analytics.Retention = Retention;
 
 export declare namespace Analytics {
   export {
+    type ActiveUsersResponse as ActiveUsersResponse,
+    type BounceRateByPageMetric as BounceRateByPageMetric,
+    type BounceRateResponse as BounceRateResponse,
+    type ChurnRateResponse as ChurnRateResponse,
+    type CohortAnalysisResponse as CohortAnalysisResponse,
+    type CohortData as CohortData,
     type CountryDataPoint as CountryDataPoint,
+    type DashboardMetricsResponse as DashboardMetricsResponse,
     type EventsOverTimeDataPoint as EventsOverTimeDataPoint,
     type OriginDataPoint as OriginDataPoint,
     type RecentEvent as RecentEvent,
     type RecentEventsResponse as RecentEventsResponse,
+    type ReturnRateResponse as ReturnRateResponse,
+    type SessionMetricsResponse as SessionMetricsResponse,
     type TopVisitor as TopVisitor,
     type TopVisitorsResponse as TopVisitorsResponse,
     type UniqueVisitorsDataPoint as UniqueVisitorsDataPoint,
@@ -185,6 +350,7 @@ export declare namespace Analytics {
     type VisitorsByCountryResponse as VisitorsByCountryResponse,
     type VisitorsByDeviceResponse as VisitorsByDeviceResponse,
     type VisitorsByOriginResponse as VisitorsByOriginResponse,
+    type AnalyticsDashboardParams as AnalyticsDashboardParams,
   };
 
   export {
@@ -198,4 +364,19 @@ export declare namespace Analytics {
   };
 
   export { Events as Events, type EventRecentParams as EventRecentParams };
+
+  export {
+    Sessions as Sessions,
+    type SessionBounceRateParams as SessionBounceRateParams,
+    type SessionMetricsParams as SessionMetricsParams,
+  };
+
+  export { Users as Users, type UserActiveParams as UserActiveParams };
+
+  export {
+    Retention as Retention,
+    type RetentionChurnRateParams as RetentionChurnRateParams,
+    type RetentionCohortsParams as RetentionCohortsParams,
+    type RetentionReturnRateParams as RetentionReturnRateParams,
+  };
 }

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

@@ -2,11 +2,20 @@
 
 export {
   Analytics,
+  type ActiveUsersResponse,
+  type BounceRateByPageMetric,
+  type BounceRateResponse,
+  type ChurnRateResponse,
+  type CohortAnalysisResponse,
+  type CohortData,
   type CountryDataPoint,
+  type DashboardMetricsResponse,
   type EventsOverTimeDataPoint,
   type OriginDataPoint,
   type RecentEvent,
   type RecentEventsResponse,
+  type ReturnRateResponse,
+  type SessionMetricsResponse,
   type TopVisitor,
   type TopVisitorsResponse,
   type UniqueVisitorsDataPoint,
@@ -17,8 +26,17 @@ export {
   type VisitorsByCountryResponse,
   type VisitorsByDeviceResponse,
   type VisitorsByOriginResponse,
+  type AnalyticsDashboardParams,
 } from './analytics';
 export { Events, type EventRecentParams } from './events';
+export {
+  Retention,
+  type RetentionChurnRateParams,
+  type RetentionCohortsParams,
+  type RetentionReturnRateParams,
+} from './retention';
+export { Sessions, type SessionBounceRateParams, type SessionMetricsParams } from './sessions';
+export { Users, type UserActiveParams } from './users';
 export {
   Visitors,
   type VisitorByCountryParams,

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

@@ -0,0 +1,114 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AnalyticsAPI from './analytics';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Retention extends APIResource {
+  /**
+   * Get metrics about user churn based on inactivity threshold
+   *
+   * @example
+   * ```ts
+   * const churnRateResponse =
+   *   await client.v1.analytics.retention.churnRate({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  churnRate(
+    query: RetentionChurnRateParams,
+    options?: RequestOptions,
+  ): APIPromise<AnalyticsAPI.ChurnRateResponse> {
+    return this._client.get('/api/v1/analytics/retention/churn-rate', { query, ...options });
+  }
+
+  /**
+   * Get cohort retention analysis showing how user groups retain over time
+   *
+   * @example
+   * ```ts
+   * const cohortAnalysisResponse =
+   *   await client.v1.analytics.retention.cohorts({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  cohorts(
+    query: RetentionCohortsParams,
+    options?: RequestOptions,
+  ): APIPromise<AnalyticsAPI.CohortAnalysisResponse> {
+    return this._client.get('/api/v1/analytics/retention/cohorts', { query, ...options });
+  }
+
+  /**
+   * Get metrics about user return rate and time between sessions
+   *
+   * @example
+   * ```ts
+   * const returnRateResponse =
+   *   await client.v1.analytics.retention.returnRate({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  returnRate(
+    query: RetentionReturnRateParams,
+    options?: RequestOptions,
+  ): APIPromise<AnalyticsAPI.ReturnRateResponse> {
+    return this._client.get('/api/v1/analytics/retention/return-rate', { query, ...options });
+  }
+}
+
+export interface RetentionChurnRateParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  /**
+   * Days of inactivity to consider churned (default: 30)
+   */
+  churn_threshold_days?: number;
+}
+
+export interface RetentionCohortsParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+
+export interface RetentionReturnRateParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+
+export declare namespace Retention {
+  export {
+    type RetentionChurnRateParams as RetentionChurnRateParams,
+    type RetentionCohortsParams as RetentionCohortsParams,
+    type RetentionReturnRateParams as RetentionReturnRateParams,
+  };
+}

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

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AnalyticsAPI from './analytics';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Sessions extends APIResource {
+  /**
+   * Get bounce rate metrics including overall bounce rate and per-page breakdown
+   *
+   * @example
+   * ```ts
+   * const bounceRateResponse =
+   *   await client.v1.analytics.sessions.bounceRate({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  bounceRate(
+    query: SessionBounceRateParams,
+    options?: RequestOptions,
+  ): APIPromise<AnalyticsAPI.BounceRateResponse> {
+    return this._client.get('/api/v1/analytics/sessions/bounce-rate', { query, ...options });
+  }
+
+  /**
+   * Get session metrics including average duration and pages per session
+   *
+   * @example
+   * ```ts
+   * const sessionMetricsResponse =
+   *   await client.v1.analytics.sessions.metrics({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  metrics(
+    query: SessionMetricsParams,
+    options?: RequestOptions,
+  ): APIPromise<AnalyticsAPI.SessionMetricsResponse> {
+    return this._client.get('/api/v1/analytics/sessions/metrics', { query, ...options });
+  }
+}
+
+export interface SessionBounceRateParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  /**
+   * Limit for per-page breakdown (default: 20)
+   */
+  limit?: number;
+}
+
+export interface SessionMetricsParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+
+export declare namespace Sessions {
+  export {
+    type SessionBounceRateParams as SessionBounceRateParams,
+    type SessionMetricsParams as SessionMetricsParams,
+  };
+}

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

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AnalyticsAPI from './analytics';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Users extends APIResource {
+  /**
+   * Get daily, weekly, and monthly active user counts
+   *
+   * @example
+   * ```ts
+   * const activeUsersResponse =
+   *   await client.v1.analytics.users.active({
+   *     project_id: 'project_id',
+   *   });
+   * ```
+   */
+  active(query: UserActiveParams, options?: RequestOptions): APIPromise<AnalyticsAPI.ActiveUsersResponse> {
+    return this._client.get('/api/v1/analytics/users/active', { query, ...options });
+  }
+}
+
+export interface UserActiveParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+}
+
+export declare namespace Users {
+  export { type UserActiveParams as UserActiveParams };
+}

package/src/resources/v1/index.ts

@@ -2,11 +2,20 @@
 
 export {
   Analytics,
+  type ActiveUsersResponse,
+  type BounceRateByPageMetric,
+  type BounceRateResponse,
+  type ChurnRateResponse,
+  type CohortAnalysisResponse,
+  type CohortData,
   type CountryDataPoint,
+  type DashboardMetricsResponse,
   type EventsOverTimeDataPoint,
   type OriginDataPoint,
   type RecentEvent,
   type RecentEventsResponse,
+  type ReturnRateResponse,
+  type SessionMetricsResponse,
   type TopVisitor,
   type TopVisitorsResponse,
   type UniqueVisitorsDataPoint,
@@ -17,6 +26,7 @@ export {
   type VisitorsByCountryResponse,
   type VisitorsByDeviceResponse,
   type VisitorsByOriginResponse,
+  type AnalyticsDashboardParams,
 } from './analytics/index';
 export {
   Auth,
@@ -31,6 +41,17 @@ export {
   type AuthRegisterAccountParams,
   type AuthRequestPasswordRecoveryParams,
 } from './auth';
+export {
+  PaymentProviders,
+  type CreatePaymentProviderRequest,
+  type ListPaymentProvidersResponse,
+  type PaymentProviderResponse,
+  type UpdatePaymentProviderRequest,
+  type PaymentProviderDeleteResponse,
+  type PaymentProviderCreateParams,
+  type PaymentProviderUpdateParams,
+  type PaymentProviderListParams,
+} from './payment-providers';
 export {
   Projects,
   type CreateProjectRequest,