zorihq 0.8.0 → 0.10.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,38 +201,39 @@ export interface ManualIdentifyResponse {
 }
 
 export interface OriginDataPoint {
-  /**
-   * Average revenue per paying visitor
-   */
-  avg_revenue_per_visitor?: number;
+  origin?: string;
 
-  /**
-   * paying_visitors / unique_visitors \* 100
-   */
-  conversion_rate?: number;
+  percentage?: number;
 
-  currency?: string;
+  unique_visitors?: number;
+}
 
-  origin?: string;
+export interface RecentEvent {
+  browser_name?: string;
 
-  paying_visitors?: number;
+  click_element_category?: string;
 
-  payment_count?: number;
+  click_element_selector?: string;
 
-  percentage?: number;
+  /**
+   * Click element details
+   */
+  click_element_tag?: string;
 
-  revenue_percentage?: number;
+  click_element_text?: string;
 
   /**
-   * Revenue in smallest currency unit (cents)
+   * Click element classification
    */
-  total_revenue?: number;
+  click_element_type?: string;
 
-  unique_visitors?: number;
-}
+  click_position_x?: number;
 
-export interface RecentEvent {
-  browser_name?: string;
+  click_position_y?: number;
+
+  click_screen_height?: number;
+
+  click_screen_width?: number;
 
   client_timestamp_utc?: string;
 
@@ -292,6 +243,14 @@ export interface RecentEvent {
 
   external_id?: string;
 
+  is_cta_click?: boolean;
+
+  is_download_link?: boolean;
+
+  is_external_link?: boolean;
+
+  link_destination?: string;
+
   location_city?: string;
 
   location_country_iso?: string;
@@ -333,27 +292,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 +303,6 @@ export interface SessionMetricsResponse {
 export interface TopVisitor {
   browser_name?: string;
 
-  currency?: string;
-
   device_type?: string;
 
   event_count?: number;
@@ -381,13 +317,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,50 +340,42 @@ export interface UniqueVisitorsTimelineResponse {
   data?: Array<UniqueVisitorsDataPoint>;
 }
 
-export interface UtmRevenueDataPoint {
-  /**
-   * Average revenue per paying visitor
-   */
-  avg_revenue_per_visitor?: number;
+export interface VisitorDataPoint {
+  desktop?: number;
 
-  /**
-   * paying_visitors / unique_visitors \* 100
-   */
-  conversion_rate?: number;
+  mobile?: number;
 
-  currency?: string;
+  timestamp?: string;
 
-  paying_visitors?: number;
+  unknown?: number;
+}
+
+export interface VisitorEvent {
+  browser_name?: string;
 
-  payment_count?: number;
+  click_element_category?: string;
 
-  revenue_percentage?: number;
+  click_element_selector?: string;
 
   /**
-   * Revenue in smallest currency unit (cents)
+   * Click element details
    */
-  total_revenue?: number;
+  click_element_tag?: string;
 
-  unique_visitors?: number;
+  click_element_text?: string;
 
   /**
-   * The UTM parameter value
+   * Click element classification
    */
-  utm_value?: string;
-}
+  click_element_type?: string;
 
-export interface VisitorDataPoint {
-  desktop?: number;
-
-  mobile?: number;
+  click_position_x?: number;
 
-  timestamp?: string;
+  click_position_y?: number;
 
-  unknown?: number;
-}
+  click_screen_height?: number;
 
-export interface VisitorEvent {
-  browser_name?: string;
+  click_screen_width?: number;
 
   client_timestamp_utc?: string;
 
@@ -462,37 +383,22 @@ export interface VisitorEvent {
 
   event_name?: string;
 
-  page_path?: string;
+  is_cta_click?: boolean;
 
-  page_url?: string;
+  is_download_link?: boolean;
 
-  referrer_url?: string;
-}
-
-export interface VisitorPayment {
-  amount?: number;
-
-  currency?: string;
-
-  payment_id?: string;
+  is_external_link?: boolean;
 
-  payment_timestamp?: string;
+  link_destination?: string;
 
-  product_name?: string;
+  page_path?: string;
 
-  provider_type?: string;
+  page_url?: string;
 
-  status?: string;
+  referrer_url?: string;
 }
 
 export interface VisitorProfileResponse {
-  /**
-   * Average payment amount
-   */
-  avg_order_value?: number;
-
-  currency?: string;
-
   custom_traits?: { [key: string]: unknown };
 
   email?: string;
@@ -505,8 +411,6 @@ export interface VisitorProfileResponse {
 
   first_identified_at?: string;
 
-  first_payment_date?: string;
-
   first_referrer_url?: string;
 
   first_seen?: string;
@@ -517,8 +421,6 @@ export interface VisitorProfileResponse {
 
   last_identified_at?: string;
 
-  last_payment_date?: string;
-
   last_seen?: string;
 
   location_city?: string;
@@ -527,19 +429,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 +464,6 @@ export interface AnalyticsDashboardParams {
 
 Analytics.Visitors = Visitors;
 Analytics.Events = Events;
-Analytics.Revenue = Revenue;
 Analytics.Sessions = Sessions;
 Analytics.Users = Users;
 Analytics.Retention = Retention;
@@ -594,18 +486,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 +517,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,47 +18,32 @@ 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,
   type VisitorsByOriginResponse,
   type AnalyticsDashboardParams,
 } from './analytics/index';
-export {
-  Auth,
-  type Account,
-  type AuthResponse,
-  type MessageResponse,
-  type Organization,
-  type AuthConfirmPasswordRecoveryParams,
-  type AuthLoginParams,
-  type AuthLogoutParams,
-  type AuthRefreshAccessTokenParams,
-  type AuthRegisterAccountParams,
-  type AuthRequestPasswordRecoveryParams,
-} from './auth';
 export {
   PaymentProviders,
   type CreatePaymentProviderRequest,
   type ListPaymentProvidersResponse,
   type PaymentProviderResponse,
+  type ProviderField,
+  type ProviderInstructionsResponse,
   type UpdatePaymentProviderRequest,
   type PaymentProviderDeleteResponse,
   type PaymentProviderCreateParams,
   type PaymentProviderUpdateParams,
   type PaymentProviderListParams,
+  type PaymentProviderInstructionsParams,
 } from './payment-providers';
 export {
   Projects,
@@ -71,4 +56,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/payment-providers.ts

@@ -82,6 +82,25 @@ export class PaymentProviders extends APIResource {
   get(id: string, options?: RequestOptions): APIPromise<PaymentProviderResponse> {
     return this._client.get(path`/api/v1/payment-providers/${id}`, options);
   }
+
+  /**
+   * Get instructions for connecting a payment provider (OAuth URL or manual
+   * credentials)
+   *
+   * @example
+   * ```ts
+   * const providerInstructionsResponse =
+   *   await client.v1.paymentProviders.instructions({
+   *     provider_type: 'stripe',
+   *   });
+   * ```
+   */
+  instructions(
+    query: PaymentProviderInstructionsParams,
+    options?: RequestOptions,
+  ): APIPromise<ProviderInstructionsResponse> {
+    return this._client.get('/api/v1/payment-providers/instructions', { query, ...options });
+  }
 }
 
 export interface CreatePaymentProviderRequest {
@@ -118,6 +137,35 @@ export interface PaymentProviderResponse {
   updated_at?: string;
 }
 
+export interface ProviderField {
+  help_text?: string;
+
+  label?: string;
+
+  name?: string;
+
+  placeholder?: string;
+
+  required?: boolean;
+
+  type?: string;
+}
+
+export interface ProviderInstructionsResponse {
+  /**
+   * "oauth" or "manual"
+   */
+  connection_method?: string;
+
+  fields?: Array<ProviderField>;
+
+  instructions?: string;
+
+  oauth_url?: string;
+
+  provider_type?: 'stripe' | 'paddle' | 'paypal' | 'lemon_squeezy' | 'square';
+}
+
 export interface UpdatePaymentProviderRequest {
   api_key?: string;
 
@@ -153,15 +201,25 @@ export interface PaymentProviderListParams {
   project_id?: string;
 }
 
+export interface PaymentProviderInstructionsParams {
+  /**
+   * Provider type
+   */
+  provider_type: 'stripe' | 'paddle' | 'paypal' | 'lemon_squeezy' | 'square';
+}
+
 export declare namespace PaymentProviders {
   export {
     type CreatePaymentProviderRequest as CreatePaymentProviderRequest,
     type ListPaymentProvidersResponse as ListPaymentProvidersResponse,
     type PaymentProviderResponse as PaymentProviderResponse,
+    type ProviderField as ProviderField,
+    type ProviderInstructionsResponse as ProviderInstructionsResponse,
     type UpdatePaymentProviderRequest as UpdatePaymentProviderRequest,
     type PaymentProviderDeleteResponse as PaymentProviderDeleteResponse,
     type PaymentProviderCreateParams as PaymentProviderCreateParams,
     type PaymentProviderUpdateParams as PaymentProviderUpdateParams,
     type PaymentProviderListParams as PaymentProviderListParams,
+    type PaymentProviderInstructionsParams as PaymentProviderInstructionsParams,
   };
 }

package/src/resources/v1/projects.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as AuthAPI from './auth';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -101,8 +100,6 @@ export interface Project {
 
   name?: string;
 
-  organization?: AuthAPI.Organization;
-
   organization_id?: string;
 
   project_token?: string;
@@ -123,8 +120,6 @@ export interface ProjectResponse {
 
   name?: string;
 
-  organization?: AuthAPI.Organization;
-
   organization_id?: string;
 
   project_token?: string;