zorihq 0.8.0 → 0.10.0

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';

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

@@ -0,0 +1,382 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AttributionAPI from './attribution';
+import { Attribution, AttributionByOriginParams, AttributionByUtmParams } from './attribution';
+import * as ConversionAPI from './conversion';
+import { Conversion, ConversionMetricsParams } from './conversion';
+import * as CustomersAPI from './customers';
+import { CustomerProfileParams, CustomerTopParams, Customers } from './customers';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Revenue extends APIResource {
+  attribution: AttributionAPI.Attribution = new AttributionAPI.Attribution(this._client);
+  customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
+  conversion: ConversionAPI.Conversion = new ConversionAPI.Conversion(this._client);
+
+  /**
+   * Get key revenue metrics including total revenue, conversion rate, and average
+   * order value
+   *
+   * @example
+   * ```ts
+   * const dashboardResponse = await client.v1.revenue.dashboard(
+   *   { project_id: 'project_id', time_range: 'last_hour' },
+   * );
+   * ```
+   */
+  dashboard(query: RevenueDashboardParams, options?: RequestOptions): APIPromise<DashboardResponse> {
+    return this._client.get('/api/v1/revenue/dashboard', { query, ...options });
+  }
+
+  /**
+   * Get revenue metrics over time for chart visualization
+   *
+   * @example
+   * ```ts
+   * const timelineResponse = await client.v1.revenue.timeline({
+   *   project_id: 'project_id',
+   *   time_range: 'last_hour',
+   * });
+   * ```
+   */
+  timeline(query: RevenueTimelineParams, options?: RequestOptions): APIPromise<TimelineResponse> {
+    return this._client.get('/api/v1/revenue/timeline', { query, ...options });
+  }
+}
+
+export interface AttributionByOriginResponse {
+  data?: Array<OriginAttributionDataPoint>;
+}
+
+export interface AttributionByUtmResponse {
+  data?: Array<UtmAttributionDataPoint>;
+}
+
+export interface ConversionMetricsResponse {
+  avg_purchases_per_customer?: number;
+
+  /**
+   * Time to conversion
+   */
+  avg_time_to_first_purchase_hours?: number;
+
+  /**
+   * % of visitors who paid
+   */
+  conversion_rate?: number;
+
+  /**
+   * Customer value
+   */
+  customer_lifetime_value?: number;
+
+  median_time_to_first_purchase_hours?: number;
+
+  paying_customers?: number;
+
+  /**
+   * Repeat purchase metrics
+   */
+  repeat_purchase_rate?: number;
+
+  total_visitors?: number;
+}
+
+export interface CustomerProfileResponse {
+  avg_order_value?: number;
+
+  currency?: string;
+
+  email?: string;
+
+  external_id?: string;
+
+  first_payment_date?: string;
+
+  /**
+   * Attribution
+   */
+  first_traffic_origin?: string;
+
+  first_utm_campaign?: string;
+
+  first_utm_medium?: string;
+
+  first_utm_source?: string;
+
+  last_payment_date?: string;
+
+  name?: string;
+
+  payment_count?: number;
+
+  /**
+   * Payment history
+   */
+  payments?: Array<Payment>;
+
+  /**
+   * Revenue over time (last 90 days)
+   */
+  revenue_over_time?: Array<RevenueOverTimeDataPoint>;
+
+  /**
+   * Revenue summary
+   */
+  total_revenue?: number;
+
+  user_id?: string;
+
+  /**
+   * Identity
+   */
+  visitor_id?: string;
+}
+
+export interface DashboardResponse {
+  /**
+   * Average metrics
+   */
+  avg_order_value?: number;
+
+  /**
+   * Average revenue per paying customer
+   */
+  avg_revenue_per_customer?: number;
+
+  avg_revenue_per_identified_customer?: number;
+
+  /**
+   * Average revenue per session
+   */
+  avg_revenue_per_session?: number;
+
+  /**
+   * % of visitors who paid
+   */
+  conversion_rate?: number;
+
+  currency?: string;
+
+  identified_customer_revenue?: number;
+
+  /**
+   * Identified customers (have email/user_id)
+   */
+  identified_customers?: number;
+
+  /**
+   * Customer metrics
+   */
+  paying_customers?: number;
+
+  /**
+   * Count of successful payments
+   */
+  total_payments?: number;
+
+  /**
+   * Core revenue metrics
+   */
+  total_revenue?: number;
+}
+
+export interface OriginAttributionDataPoint {
+  /**
+   * Average revenue per paying customer
+   */
+  avg_revenue_per_customer?: number;
+
+  /**
+   * paying_customers / unique_visitors \* 100
+   */
+  conversion_rate?: number;
+
+  currency?: string;
+
+  origin?: string;
+
+  paying_customers?: number;
+
+  payment_count?: number;
+
+  revenue_percentage?: number;
+
+  /**
+   * Revenue in smallest currency unit (cents)
+   */
+  total_revenue?: number;
+
+  unique_visitors?: number;
+}
+
+export interface Payment {
+  amount?: number;
+
+  currency?: string;
+
+  payment_id?: string;
+
+  payment_timestamp?: string;
+
+  product_name?: string;
+
+  provider_type?: string;
+
+  status?: string;
+}
+
+export interface RevenueOverTimeDataPoint {
+  payment_count?: number;
+
+  timestamp?: string;
+
+  total_revenue?: number;
+}
+
+export interface TimelineDataPoint {
+  currency?: string;
+
+  payment_count?: number;
+
+  timestamp?: string;
+
+  /**
+   * Revenue in smallest currency unit (cents)
+   */
+  total_revenue?: number;
+}
+
+export interface TimelineResponse {
+  data?: Array<TimelineDataPoint>;
+}
+
+export interface TopCustomer {
+  avg_order_value?: number;
+
+  currency?: string;
+
+  email?: string;
+
+  external_id?: string;
+
+  first_payment_date?: string;
+
+  first_traffic_origin?: string;
+
+  last_payment_date?: string;
+
+  location_country_iso?: string;
+
+  name?: string;
+
+  payment_count?: number;
+
+  /**
+   * Total revenue in smallest currency unit (cents)
+   */
+  total_revenue?: number;
+
+  user_id?: string;
+
+  visitor_id?: string;
+}
+
+export interface TopCustomersResponse {
+  customers?: Array<TopCustomer>;
+
+  total?: number;
+}
+
+export interface UtmAttributionDataPoint {
+  /**
+   * Average revenue per paying customer
+   */
+  avg_revenue_per_customer?: number;
+
+  /**
+   * paying_customers / unique_visitors \* 100
+   */
+  conversion_rate?: number;
+
+  currency?: string;
+
+  paying_customers?: number;
+
+  payment_count?: number;
+
+  revenue_percentage?: number;
+
+  /**
+   * Revenue in smallest currency unit (cents)
+   */
+  total_revenue?: number;
+
+  unique_visitors?: number;
+
+  utm_value?: string;
+}
+
+export interface RevenueDashboardParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+
+export interface RevenueTimelineParams {
+  /**
+   * Project ID
+   */
+  project_id: string;
+
+  /**
+   * Time range
+   */
+  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
+}
+
+Revenue.Attribution = Attribution;
+Revenue.Customers = Customers;
+Revenue.Conversion = Conversion;
+
+export declare namespace Revenue {
+  export {
+    type AttributionByOriginResponse as AttributionByOriginResponse,
+    type AttributionByUtmResponse as AttributionByUtmResponse,
+    type ConversionMetricsResponse as ConversionMetricsResponse,
+    type CustomerProfileResponse as CustomerProfileResponse,
+    type DashboardResponse as DashboardResponse,
+    type OriginAttributionDataPoint as OriginAttributionDataPoint,
+    type Payment as Payment,
+    type RevenueOverTimeDataPoint as RevenueOverTimeDataPoint,
+    type TimelineDataPoint as TimelineDataPoint,
+    type TimelineResponse as TimelineResponse,
+    type TopCustomer as TopCustomer,
+    type TopCustomersResponse as TopCustomersResponse,
+    type UtmAttributionDataPoint as UtmAttributionDataPoint,
+    type RevenueDashboardParams as RevenueDashboardParams,
+    type RevenueTimelineParams as RevenueTimelineParams,
+  };
+
+  export {
+    Attribution as Attribution,
+    type AttributionByOriginParams as AttributionByOriginParams,
+    type AttributionByUtmParams as AttributionByUtmParams,
+  };
+
+  export {
+    Customers as Customers,
+    type CustomerProfileParams as CustomerProfileParams,
+    type CustomerTopParams as CustomerTopParams,
+  };
+
+  export { Conversion as Conversion, type ConversionMetricsParams as ConversionMetricsParams };
+}

package/src/resources/v1/revenue.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './revenue/index';