zorihq 0.8.0 → 0.9.0

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

@@ -10,8 +10,6 @@ import {
   RetentionCohortsParams,
   RetentionReturnRateParams,
 } from './retention';
-import * as RevenueAPI from './revenue';
-import { Revenue, RevenueByUtmParams, RevenueTimelineParams } from './revenue';
 import * as SessionsAPI from './sessions';
 import { SessionBounceRateParams, SessionMetricsParams, Sessions } from './sessions';
 import * as UsersAPI from './users';
@@ -33,7 +31,6 @@ 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);
-  revenue: RevenueAPI.Revenue = new RevenueAPI.Revenue(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);
@@ -121,21 +118,6 @@ export interface CountryDataPoint {
 export interface DashboardMetricsResponse {
   avg_pages_per_session?: number;
 
-  /**
-   * Average revenue for identified visitors only (deprecated)
-   */
-  avg_revenue_per_identified_customer?: number;
-
-  /**
-   * 3. Average revenue per unique session
-   */
-  avg_revenue_per_session?: number;
-
-  /**
-   * Average revenue per paying visitor
-   */
-  avg_revenue_per_visitor?: number;
-
   avg_session_duration_seconds?: number;
 
   /**
@@ -143,18 +125,6 @@ export interface DashboardMetricsResponse {
    */
   bounce_rate?: number;
 
-  /**
-   * 4. % of unique visitors who made payment
-   */
-  conversion_rate?: number;
-
-  /**
-   * Same as ConversionRate (deprecated, use ConversionRate)
-   */
-  conversion_to_paying?: number;
-
-  currency?: string;
-
   /**
    * Active users
    */
@@ -162,11 +132,6 @@ export interface DashboardMetricsResponse {
 
   mau?: number;
 
-  /**
-   * Additional revenue metrics (kept for compatibility)
-   */
-  paying_visitors?: number;
-
   return_rate?: number;
 
   /**
@@ -179,21 +144,6 @@ export interface DashboardMetricsResponse {
    */
   total_events?: number;
 
-  /**
-   * Count of successful payments
-   */
-  total_payments?: number;
-
-  /**
-   * Revenue metrics - 4 key metrics as separate queries
-   */
-  total_revenue?: number;
-
-  /**
-   * 2. Total revenue for identified customers only
-   */
-  total_revenue_identified_customers?: number;
-
   total_sessions_in_period?: number;
 
   /**
@@ -251,33 +201,10 @@ export interface ManualIdentifyResponse {
 }
 
 export interface OriginDataPoint {
-  /**
-   * Average revenue per paying visitor
-   */
-  avg_revenue_per_visitor?: number;
-
-  /**
-   * paying_visitors / unique_visitors \* 100
-   */
-  conversion_rate?: number;
-
-  currency?: string;
-
   origin?: string;
 
-  paying_visitors?: number;
-
-  payment_count?: number;
-
   percentage?: number;
 
-  revenue_percentage?: number;
-
-  /**
-   * Revenue in smallest currency unit (cents)
-   */
-  total_revenue?: number;
-
   unique_visitors?: number;
 }
 
@@ -333,27 +260,6 @@ export interface ReturnRateResponse {
   total_users?: number;
 }
 
-export interface RevenueByUtmResponse {
-  data?: Array<UtmRevenueDataPoint>;
-}
-
-export interface RevenueTimelineDataPoint {
-  currency?: string;
-
-  payment_count?: number;
-
-  timestamp?: string;
-
-  /**
-   * Revenue in smallest currency unit (cents)
-   */
-  total_revenue?: number;
-}
-
-export interface RevenueTimelineResponse {
-  data?: Array<RevenueTimelineDataPoint>;
-}
-
 export interface SessionMetricsResponse {
   average_pages_per_session?: number;
 
@@ -365,8 +271,6 @@ export interface SessionMetricsResponse {
 export interface TopVisitor {
   browser_name?: string;
 
-  currency?: string;
-
   device_type?: string;
 
   event_count?: number;
@@ -381,13 +285,6 @@ export interface TopVisitor {
 
   location_country_iso?: string;
 
-  payment_count?: number;
-
-  /**
-   * Total revenue in smallest currency unit (cents)
-   */
-  total_revenue?: number;
-
   user_id?: string;
 
   visitor_id?: string;
@@ -411,38 +308,6 @@ export interface UniqueVisitorsTimelineResponse {
   data?: Array<UniqueVisitorsDataPoint>;
 }
 
-export interface UtmRevenueDataPoint {
-  /**
-   * Average revenue per paying visitor
-   */
-  avg_revenue_per_visitor?: number;
-
-  /**
-   * paying_visitors / unique_visitors \* 100
-   */
-  conversion_rate?: number;
-
-  currency?: string;
-
-  paying_visitors?: number;
-
-  payment_count?: number;
-
-  revenue_percentage?: number;
-
-  /**
-   * Revenue in smallest currency unit (cents)
-   */
-  total_revenue?: number;
-
-  unique_visitors?: number;
-
-  /**
-   * The UTM parameter value
-   */
-  utm_value?: string;
-}
-
 export interface VisitorDataPoint {
   desktop?: number;
 
@@ -469,30 +334,7 @@ export interface VisitorEvent {
   referrer_url?: string;
 }
 
-export interface VisitorPayment {
-  amount?: number;
-
-  currency?: string;
-
-  payment_id?: string;
-
-  payment_timestamp?: string;
-
-  product_name?: string;
-
-  provider_type?: string;
-
-  status?: string;
-}
-
 export interface VisitorProfileResponse {
-  /**
-   * Average payment amount
-   */
-  avg_order_value?: number;
-
-  currency?: string;
-
   custom_traits?: { [key: string]: unknown };
 
   email?: string;
@@ -505,8 +347,6 @@ export interface VisitorProfileResponse {
 
   first_identified_at?: string;
 
-  first_payment_date?: string;
-
   first_referrer_url?: string;
 
   first_seen?: string;
@@ -517,8 +357,6 @@ export interface VisitorProfileResponse {
 
   last_identified_at?: string;
 
-  last_payment_date?: string;
-
   last_seen?: string;
 
   location_city?: string;
@@ -527,19 +365,10 @@ export interface VisitorProfileResponse {
 
   name?: string;
 
-  payment_count?: number;
-
-  payments?: Array<VisitorPayment>;
-
   phone?: string;
 
   total_events?: number;
 
-  /**
-   * Revenue fields
-   */
-  total_revenue?: number;
-
   user_id?: string;
 
   visitor_id?: string;
@@ -571,7 +400,6 @@ export interface AnalyticsDashboardParams {
 
 Analytics.Visitors = Visitors;
 Analytics.Events = Events;
-Analytics.Revenue = Revenue;
 Analytics.Sessions = Sessions;
 Analytics.Users = Users;
 Analytics.Retention = Retention;
@@ -594,18 +422,13 @@ export declare namespace Analytics {
     type RecentEvent as RecentEvent,
     type RecentEventsResponse as RecentEventsResponse,
     type ReturnRateResponse as ReturnRateResponse,
-    type RevenueByUtmResponse as RevenueByUtmResponse,
-    type RevenueTimelineDataPoint as RevenueTimelineDataPoint,
-    type RevenueTimelineResponse as RevenueTimelineResponse,
     type SessionMetricsResponse as SessionMetricsResponse,
     type TopVisitor as TopVisitor,
     type TopVisitorsResponse as TopVisitorsResponse,
     type UniqueVisitorsDataPoint as UniqueVisitorsDataPoint,
     type UniqueVisitorsTimelineResponse as UniqueVisitorsTimelineResponse,
-    type UtmRevenueDataPoint as UtmRevenueDataPoint,
     type VisitorDataPoint as VisitorDataPoint,
     type VisitorEvent as VisitorEvent,
-    type VisitorPayment as VisitorPayment,
     type VisitorProfileResponse as VisitorProfileResponse,
     type VisitorsByCountryResponse as VisitorsByCountryResponse,
     type VisitorsByDeviceResponse as VisitorsByDeviceResponse,
@@ -630,12 +453,6 @@ export declare namespace Analytics {
     type EventRecentParams as EventRecentParams,
   };
 
-  export {
-    Revenue as Revenue,
-    type RevenueByUtmParams as RevenueByUtmParams,
-    type RevenueTimelineParams as RevenueTimelineParams,
-  };
-
   export {
     Sessions as Sessions,
     type SessionBounceRateParams as SessionBounceRateParams,

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

@@ -18,18 +18,13 @@ export {
   type RecentEvent,
   type RecentEventsResponse,
   type ReturnRateResponse,
-  type RevenueByUtmResponse,
-  type RevenueTimelineDataPoint,
-  type RevenueTimelineResponse,
   type SessionMetricsResponse,
   type TopVisitor,
   type TopVisitorsResponse,
   type UniqueVisitorsDataPoint,
   type UniqueVisitorsTimelineResponse,
-  type UtmRevenueDataPoint,
   type VisitorDataPoint,
   type VisitorEvent,
-  type VisitorPayment,
   type VisitorProfileResponse,
   type VisitorsByCountryResponse,
   type VisitorsByDeviceResponse,
@@ -43,7 +38,6 @@ export {
   type RetentionCohortsParams,
   type RetentionReturnRateParams,
 } from './retention';
-export { Revenue, type RevenueByUtmParams, type RevenueTimelineParams } from './revenue';
 export { Sessions, type SessionBounceRateParams, type SessionMetricsParams } from './sessions';
 export { Users, type UserActiveParams } from './users';
 export {

package/src/resources/v1/index.ts

@@ -18,18 +18,13 @@ export {
   type RecentEvent,
   type RecentEventsResponse,
   type ReturnRateResponse,
-  type RevenueByUtmResponse,
-  type RevenueTimelineDataPoint,
-  type RevenueTimelineResponse,
   type SessionMetricsResponse,
   type TopVisitor,
   type TopVisitorsResponse,
   type UniqueVisitorsDataPoint,
   type UniqueVisitorsTimelineResponse,
-  type UtmRevenueDataPoint,
   type VisitorDataPoint,
   type VisitorEvent,
-  type VisitorPayment,
   type VisitorProfileResponse,
   type VisitorsByCountryResponse,
   type VisitorsByDeviceResponse,
@@ -71,4 +66,22 @@ export {
   type ProjectCreateParams,
   type ProjectUpdateParams,
 } from './projects';
+export {
+  Revenue,
+  type AttributionByOriginResponse,
+  type AttributionByUtmResponse,
+  type ConversionMetricsResponse,
+  type CustomerProfileResponse,
+  type DashboardResponse,
+  type OriginAttributionDataPoint,
+  type Payment,
+  type RevenueOverTimeDataPoint,
+  type TimelineDataPoint,
+  type TimelineResponse,
+  type TopCustomer,
+  type TopCustomersResponse,
+  type UtmAttributionDataPoint,
+  type RevenueDashboardParams,
+  type RevenueTimelineParams,
+} from './revenue/index';
 export { V1 } from './v1';

package/src/resources/v1/{analytics/revenue.ts → revenue/attribution.ts}

@@ -1,48 +1,53 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as AnalyticsAPI from './analytics';
+import * as RevenueAPI from './revenue';
 import { APIPromise } from '../../../core/api-promise';
 import { RequestOptions } from '../../../internal/request-options';
 
-export class Revenue extends APIResource {
+export class Attribution extends APIResource {
   /**
-   * Get revenue metrics grouped by UTM source, medium, or campaign
+   * Get revenue metrics grouped by traffic origin (referrer domain) using
+   * first-touch attribution
    *
    * @example
    * ```ts
-   * const revenueByUtmResponse =
-   *   await client.v1.analytics.revenue.byUtm({
+   * const attributionByOriginResponse =
+   *   await client.v1.revenue.attribution.byOrigin({
    *     project_id: 'project_id',
    *     time_range: 'last_hour',
    *   });
    * ```
    */
-  byUtm(query: RevenueByUtmParams, options?: RequestOptions): APIPromise<AnalyticsAPI.RevenueByUtmResponse> {
-    return this._client.get('/api/v1/analytics/revenue/by-utm', { query, ...options });
+  byOrigin(
+    query: AttributionByOriginParams,
+    options?: RequestOptions,
+  ): APIPromise<RevenueAPI.AttributionByOriginResponse> {
+    return this._client.get('/api/v1/revenue/attribution/origin', { query, ...options });
   }
 
   /**
-   * Get revenue metrics over time for chart visualization
+   * Get revenue metrics grouped by UTM source, medium, or campaign using first-touch
+   * attribution
    *
    * @example
    * ```ts
-   * const revenueTimelineResponse =
-   *   await client.v1.analytics.revenue.timeline({
+   * const attributionByUtmResponse =
+   *   await client.v1.revenue.attribution.byUtm({
    *     project_id: 'project_id',
    *     time_range: 'last_hour',
    *   });
    * ```
    */
-  timeline(
-    query: RevenueTimelineParams,
+  byUtm(
+    query: AttributionByUtmParams,
     options?: RequestOptions,
-  ): APIPromise<AnalyticsAPI.RevenueTimelineResponse> {
-    return this._client.get('/api/v1/analytics/revenue/timeline', { query, ...options });
+  ): APIPromise<RevenueAPI.AttributionByUtmResponse> {
+    return this._client.get('/api/v1/revenue/attribution/utm', { query, ...options });
   }
 }
 
-export interface RevenueByUtmParams {
+export interface AttributionByOriginParams {
   /**
    * Project ID
    */
@@ -52,14 +57,9 @@ export interface RevenueByUtmParams {
    * Time range
    */
   time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
-
-  /**
-   * UTM type: source, medium, or campaign (default: source)
-   */
-  utm_type?: string;
 }
 
-export interface RevenueTimelineParams {
+export interface AttributionByUtmParams {
   /**
    * Project ID
    */
@@ -69,11 +69,16 @@ export interface RevenueTimelineParams {
    * Time range
    */
   time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  /**
+   * UTM type: source, medium, or campaign (default: source)
+   */
+  utm_type?: string;
 }
 
-export declare namespace Revenue {
+export declare namespace Attribution {
   export {
-    type RevenueByUtmParams as RevenueByUtmParams,
-    type RevenueTimelineParams as RevenueTimelineParams,
+    type AttributionByOriginParams as AttributionByOriginParams,
+    type AttributionByUtmParams as AttributionByUtmParams,
   };
 }

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

@@ -0,0 +1,44 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as RevenueAPI from './revenue';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Conversion extends APIResource {
+  /**
+   * Get conversion funnel metrics including conversion rate, time to purchase, and
+   * customer lifetime value
+   *
+   * @example
+   * ```ts
+   * const conversionMetricsResponse =
+   *   await client.v1.revenue.conversion.metrics({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  metrics(
+    query: ConversionMetricsParams,
+    options?: RequestOptions,
+  ): APIPromise<RevenueAPI.ConversionMetricsResponse> {
+    return this._client.get('/api/v1/revenue/conversion/metrics', { query, ...options });
+  }
+}
+
+export interface ConversionMetricsParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+
+export declare namespace Conversion {
+  export { type ConversionMetricsParams as ConversionMetricsParams };
+}

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

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as RevenueAPI from './revenue';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Customers extends APIResource {
+  /**
+   * Get detailed revenue information for a specific customer including payment
+   * history and attribution
+   *
+   * @example
+   * ```ts
+   * const customerProfileResponse =
+   *   await client.v1.revenue.customers.profile({
+   *     project_id: 'project_id',
+   *     visitor_id: 'visitor_id',
+   *   });
+   * ```
+   */
+  profile(
+    query: CustomerProfileParams,
+    options?: RequestOptions,
+  ): APIPromise<RevenueAPI.CustomerProfileResponse> {
+    return this._client.get('/api/v1/revenue/customers/profile', { query, ...options });
+  }
+
+  /**
+   * Get a list of customers ranked by total revenue
+   *
+   * @example
+   * ```ts
+   * const topCustomersResponse =
+   *   await client.v1.revenue.customers.top({
+   *     project_id: 'project_id',
+   *     time_range: 'last_hour',
+   *   });
+   * ```
+   */
+  top(query: CustomerTopParams, options?: RequestOptions): APIPromise<RevenueAPI.TopCustomersResponse> {
+    return this._client.get('/api/v1/revenue/customers/top', { query, ...options });
+  }
+}
+
+export interface CustomerProfileParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Visitor ID
+   */
+  visitor_id: string;
+}
+
+export interface CustomerTopParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+
+  /**
+   * Maximum number of customers to return (default: 50)
+   */
+  limit?: number;
+}
+
+export declare namespace Customers {
+  export { type CustomerProfileParams as CustomerProfileParams, type CustomerTopParams as CustomerTopParams };
+}

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

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Attribution, type AttributionByOriginParams, type AttributionByUtmParams } from './attribution';
+export { Conversion, type ConversionMetricsParams } from './conversion';
+export { Customers, type CustomerProfileParams, type CustomerTopParams } from './customers';
+export {
+  Revenue,
+  type AttributionByOriginResponse,
+  type AttributionByUtmResponse,
+  type ConversionMetricsResponse,
+  type CustomerProfileResponse,
+  type DashboardResponse,
+  type OriginAttributionDataPoint,
+  type Payment,
+  type RevenueOverTimeDataPoint,
+  type TimelineDataPoint,
+  type TimelineResponse,
+  type TopCustomer,
+  type TopCustomersResponse,
+  type UtmAttributionDataPoint,
+  type RevenueDashboardParams,
+  type RevenueTimelineParams,
+} from './revenue';