zorihq 0.11.1 → 0.13.0

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

@@ -120,35 +120,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 +142,8 @@ export interface DashboardMetricsResponse {
 }
 
 export interface EventFilterOptionsResponse {
-  /**
-   * Unique page paths
-   */
   pages?: Array<string>;
 
-  /**
-   * Unique referrer domains
-   */
   traffic_origins?: Array<string>;
 }
 
@@ -215,16 +194,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 +330,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 +418,23 @@ export interface VisitorsByOriginResponse {
 }
 
 export interface AnalyticsDashboardParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 Analytics.Visitors = Visitors;

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

@@ -14,6 +14,7 @@ export class Events extends APIResource {
    * const eventFilterOptionsResponse =
    *   await client.v1.analytics.events.filterOptions({
    *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -33,6 +34,7 @@ export class Events extends APIResource {
    * const recentEventsResponse =
    *   await client.v1.analytics.events.recent({
    *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -42,56 +44,50 @@ export class Events extends APIResource {
 }
 
 export interface EventFilterOptionsParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range?: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface EventRecentParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Filter by external ID
-   */
-  external_id?: string;
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  externalID?: string;
 
-  /**
-   * Maximum number of events to return (default: 15)
-   */
   limit?: number;
 
-  /**
-   * Offset for pagination (default: 0)
-   */
   offset?: number;
 
-  /**
-   * Filter by page path
-   */
-  page_path?: string;
+  pagePath?: string;
 
-  /**
-   * Filter by traffic origin (referrer domain)
-   */
-  traffic_origin?: string;
+  referrer?: string;
 
-  /**
-   * Filter by user ID
-   */
-  user_id?: string;
+  trafficOrigin?: string;
+
+  userID?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
 
-  /**
-   * Filter by visitor ID
-   */
   visitor_id?: string;
 }
 

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

@@ -65,44 +65,63 @@ export class Retention extends APIResource {
 }
 
 export interface RetentionChurnRateParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 
-  /**
-   * Days of inactivity to consider churned (default: 30)
-   */
-  churn_threshold_days?: number;
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface RetentionCohortsParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface RetentionReturnRateParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export declare namespace Retention {

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

@@ -46,32 +46,43 @@ export class Sessions extends APIResource {
 }
 
 export interface SessionBounceRateParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
 
-  /**
-   * Limit for per-page breakdown (default: 20)
-   */
   limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface SessionMetricsParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export declare namespace Sessions {

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

@@ -14,6 +14,7 @@ export class Users extends APIResource {
    * const activeUsersResponse =
    *   await client.v1.analytics.users.active({
    *     project_id: 'project_id',
+   *     time_range: 'last_hour',
    *   });
    * ```
    */
@@ -23,10 +24,23 @@ export class Users extends APIResource {
 }
 
 export interface UserActiveParams {
-  /**
-   * Project ID
-   */
   project_id: string;
+
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export declare namespace Users {

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

@@ -93,7 +93,6 @@ export class Visitors extends APIResource {
    * const visitorProfileResponse =
    *   await client.v1.analytics.visitors.profile({
    *     project_id: 'project_id',
-   *     visitor_id: 'visitor_id',
    *   });
    * ```
    */
@@ -142,39 +141,63 @@ export class Visitors extends APIResource {
 }
 
 export interface VisitorByCountryParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface VisitorByDeviceParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface VisitorByOriginParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface VisitorIdentifyParams {
@@ -196,44 +219,51 @@ export interface VisitorIdentifyParams {
 }
 
 export interface VisitorProfileParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Visitor ID
-   */
-  visitor_id: string;
+  customer_id?: string;
+
+  visitor_id?: string;
 }
 
 export interface VisitorTimelineParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
+
+  limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export interface VisitorTopParams {
-  /**
-   * Project ID
-   */
   project_id: string;
 
-  /**
-   * Time range
-   */
-  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+  time_range: 'last_hour' | 'today' | 'yesterday' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  customer_id?: string;
 
-  /**
-   * Maximum number of visitors to return (default: 50)
-   */
   limit?: number;
+
+  offset?: number;
+
+  referrer?: string;
+
+  utmtag?: string;
+
+  utmtagValue?: string;
+
+  visitor_id?: string;
 }
 
 export declare namespace Visitors {

package/src/resources/v1/payment-providers/payment-providers.ts

@@ -156,9 +156,6 @@ export interface ProviderField {
 }
 
 export interface ProviderInstructionsResponse {
-  /**
-   * "oauth" or "manual"
-   */
   connection_method?: string;
 
   fields?: Array<ProviderField>;

package/src/resources/v1/revenue/cohort.ts

@@ -23,9 +23,6 @@ export class Cohort extends APIResource {
 }
 
 export interface CohortGetMetricsResponse {
-  /**
-   * Customers with only visitor_id
-   */
   anonymous_customers?: number;
 
   avg_order_value?: number;
@@ -36,70 +33,34 @@ export interface CohortGetMetricsResponse {
 
   avg_revenue_per_visitor?: number;
 
-  /**
-   * Time metrics
-   */
   avg_time_to_first_purchase_hours?: number;
 
-  /**
-   * paying_customers / total_customers \* 100
-   */
   conversion_rate?: number;
 
   currency?: string;
 
-  /**
-   * Customer identity mapping
-   */
   identified_customers?: number;
 
-  /**
-   * Median time to first payment
-   */
   median_time_to_first_purchase_hours?: number;
 
-  /**
-   * Unique customer identities who made payments
-   */
   paying_customers?: number;
 
-  /**
-   * Total unique customer identities in cohort
-   */
   total_customers?: number;
 
-  /**
-   * Payment metrics
-   */
   total_payments?: number;
 
-  /**
-   * Revenue metrics
-   */
   total_revenue?: number;
 
-  /**
-   * Cohort size
-   */
   total_visitors?: number;
 
-  /**
-   * paying_customers / total_visitors \* 100
-   */
   visitor_conversion_rate?: number;
 }
 
 export interface CohortGetMetricsParams {
   project_id: string;
 
-  /**
-   * List of visitor IDs to analyze
-   */
   visitor_ids: Array<string>;
 
-  /**
-   * Optional: filter by payment date
-   */
   time_range?: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
 }