analytics_ops 0.2.0 → 0.3.0

data/sig/analytics_ops.rbs

@@ -4,6 +4,16 @@ module AnalyticsOps
   type record = Hash[String, untyped]
 
   class Error < StandardError
+    attr_reader remote_reason: String?
+    attr_reader remote_metadata: record
+    attr_reader remote_code: String?
+
+    def initialize: (
+      ?String? message,
+      ?remote_reason: untyped,
+      ?remote_metadata: untyped,
+      ?remote_code: untyped
+    ) -> void
   end
 
   class ConfigurationError < Error
@@ -58,23 +68,50 @@ module AnalyticsOps
     MAX_KEY_BYTES: Integer
     READ_SCOPE: String
     EDIT_SCOPE: String
+    BIGQUERY_SCOPE: String
     ACCESS_SCOPES: Hash[Symbol, Array[String]]
 
     attr_reader path: String
+    attr_reader security_warnings: Array[String]
 
-    def self.load: (?path: String?, ?store: Store) -> ServiceAccount
+    def self.load: (
+      ?path: String?,
+      ?store: Store,
+      ?connection: String?,
+      ?config: String?,
+      ?profile: String?
+    ) -> ServiceAccount
     def initialize: (String path) -> void
 
     class Store
       VERSION: Integer
+      LEGACY_VERSION: Integer
       MAX_BYTES: Integer
 
       attr_reader path: String
 
       def self.default_path: () -> String
       def initialize: (?path: String?) -> void
-      def read: () -> String
-      def write: (String service_account_path) -> String
+      def read: (?name: String?, ?config: String?, ?profile: String?) -> String
+      def resolve_connection_name: (?name: String?, ?config: String?, ?profile: String?) -> String
+      def connection_name_for: (
+        String service_account_path,
+        preferred: String,
+        config: String,
+        profile: String
+      ) -> String
+      def write: (
+        String service_account_path,
+        ?name: String,
+        ?config: String?,
+        ?profile: String?,
+        ?select: bool
+      ) -> String
+      def select: (config: String, profile: String, ?connection: String?) -> record
+      def selection: (config: String) -> record?
+      def selected_profile: (config: String) -> String?
+      def profile_connection: (config: String, profile: String) -> String?
+      def summaries: () -> Array[record]
     end
   end
 
@@ -161,8 +198,10 @@ module AnalyticsOps
       class Result
         attr_reader path: String
 
-        def initialize: (path: String, created: bool) -> void
+        def initialize: (path: String, created: bool, ?updated: bool) -> void
         def created?: () -> bool
+        def updated?: () -> bool
+        def changed?: () -> bool
         def to_h: () -> record
       end
 
@@ -180,6 +219,12 @@ module AnalyticsOps
     attr_reader custom_metrics: Array[record]
     attr_reader manual_requirements: Array[String]
     attr_reader google_signals: record?
+    attr_reader labels: record
+    attr_reader reports: Hash[String, Reports::Definition]
+    attr_reader health: record?
+    attr_reader funnels: Hash[String, Funnels::Definition]
+    attr_reader bigquery: record?
+    attr_reader governance: record?
 
     def initialize: (
       profile: String,
@@ -190,7 +235,13 @@ module AnalyticsOps
       custom_dimensions: Array[record],
       custom_metrics: Array[record],
       manual_requirements: Array[String],
-      google_signals: record?
+      google_signals: record?,
+      ?labels: record,
+      ?reports: Hash[String, Reports::Definition],
+      ?health: record?,
+      ?funnels: Hash[String, Funnels::Definition],
+      ?bigquery: record?,
+      ?governance: record?
     ) -> void
     def to_h: () -> record
   end
@@ -308,9 +359,104 @@ module AnalyticsOps
         ?limit: Integer
       ) -> void
       def realtime?: () -> bool
+      def with_date_ranges: (Array[record] value) -> Definition
+      def with_pagination: (offset: Integer, limit: Integer) -> Definition
+      def to_h: () -> record
+    end
+
+    class Field < Resources::Value
+      attr_reader api_name: String
+      attr_reader ui_name: String?
+      attr_reader description: String?
+      attr_reader category: String?
+      attr_reader kind: String
+      attr_reader custom_definition: bool
+      attr_reader deprecated_api_names: Array[String]
+      attr_reader data_type: String?
+      attr_reader expression: String?
+      attr_reader blocked_reasons: Array[String]
+    end
+
+    class Metadata
+      attr_reader property_id: String
+      attr_reader dimensions: Array[Field]
+      attr_reader metrics: Array[Field]
+
+      def initialize: (
+        property_id: String,
+        dimensions: Array[Field],
+        metrics: Array[Field]
+      ) -> void
+      def search: (?String? query, ?kind: String?) -> Array[Field]
       def to_h: () -> record
     end
 
+    class FieldList
+      attr_reader property_id: String
+      attr_reader query: String?
+      attr_reader kind: String?
+      attr_reader fields: Array[Field]
+
+      def initialize: (
+        property_id: String,
+        query: String?,
+        kind: String?,
+        fields: Array[Field]
+      ) -> void
+      def to_h: () -> record
+    end
+
+    class Recipe < Resources::Value
+      attr_reader name: String
+      attr_reader kind: String
+      attr_reader source: String
+      attr_reader dimensions: Array[String]
+      attr_reader metrics: Array[String]
+    end
+
+    class RecipeList
+      attr_reader recipes: Array[Recipe]
+
+      def initialize: (recipes: Array[Recipe]) -> void
+      def to_h: () -> record
+    end
+
+    class Compatibility
+      attr_reader report_name: String
+      attr_reader compatible: bool
+      attr_reader dimensions: Array[record]
+      attr_reader metrics: Array[record]
+
+      def initialize: (
+        report_name: String,
+        dimensions: Array[record],
+        metrics: Array[record]
+      ) -> void
+      def to_h: () -> record
+    end
+
+    class ExportResult < Resources::Value
+      attr_reader path: String
+      attr_reader rows: Integer
+      attr_reader headers: Array[String]
+    end
+
+    module CSVExport
+      def self.write: (String path, Enumerable[Result] pages) -> ExportResult
+    end
+
+    module Period
+      DEFAULT_DAYS: Integer
+      MAX_DAYS: Integer
+
+      def self.resolve: (
+        ?last_days: Integer?,
+        ?start_date: String?,
+        ?end_date: String?,
+        ?compare: bool
+      ) -> Array[record]?
+    end
+
     module Catalog
       def self.fetch: (String | Symbol name, ?kind: String?) -> Definition
       def self.names: () -> Array[String]
@@ -319,6 +465,9 @@ module AnalyticsOps
     end
 
     class Result
+      MAX_ROWS: Integer
+      MAX_CELL_BYTES: Integer
+
       attr_reader name: String
       attr_reader kind: String
       attr_reader dimension_headers: Array[String]
@@ -353,6 +502,187 @@ module AnalyticsOps
     end
   end
 
+  module Funnels
+    class Step < Resources::Value
+      attr_reader name: String
+      attr_reader event_name: String
+    end
+
+    class Definition
+      attr_reader name: String
+      attr_reader steps: Array[Step]
+
+      def initialize: (name: String, steps: Array[record]) -> void
+      def to_h: () -> record
+    end
+  end
+
+  module BigQuery
+    RECIPE_NAMES: Array[String]
+
+    class Definition
+      attr_reader name: String
+      attr_reader start_suffix: String
+      attr_reader end_suffix: String
+      attr_reader limit: Integer
+
+      def initialize: (
+        name: String,
+        start_date: untyped,
+        end_date: untyped,
+        ?limit: Integer
+      ) -> void
+      def self.from_date_ranges: (
+        String name,
+        Array[record] date_ranges,
+        ?limit: Integer,
+        ?today: untyped
+      ) -> Definition
+      def to_h: () -> record
+    end
+
+    class Result
+      attr_reader name: String
+      attr_reader headers: Array[String]
+      attr_reader rows: Array[record]
+      attr_reader bytes_processed: Integer
+      attr_reader maximum_bytes_billed: Integer
+
+      def initialize: (
+        name: String,
+        headers: Array[String],
+        rows: Array[record],
+        bytes_processed: Integer,
+        maximum_bytes_billed: Integer
+      ) -> void
+      def to_h: () -> record
+    end
+  end
+
+  module Health
+    DEFAULTS: record
+
+    def self.validate_date_ranges!: (Array[record] value) -> Array[record]
+
+    class Finding < Resources::Value
+      attr_reader severity: String
+      attr_reader code: String
+      attr_reader message: String
+      attr_reader actual: String?
+      attr_reader expected: String?
+    end
+
+    class Result
+      attr_reader profile: String
+      attr_reader property_id: String
+      attr_reader date_ranges: Array[record]
+      attr_reader findings: Array[Finding]
+      attr_reader summary: record
+
+      def initialize: (
+        profile: String,
+        property_id: String,
+        date_ranges: Array[record],
+        findings: Array[Finding],
+        summary: record
+      ) -> void
+      def healthy?: () -> bool
+      def to_h: () -> record
+    end
+
+    class Runner
+      def initialize: (
+        desired_state: DesiredState,
+        reports: Array[Reports::Result],
+        plan: Plan,
+        date_ranges: Array[record]
+      ) -> void
+      def call: () -> Result
+    end
+  end
+
+  module Governance
+    class StreamSettings < Resources::Value
+      attr_reader stream_id: String
+      attr_reader stream_name: String
+      attr_reader enhanced_measurement: record
+      attr_reader data_redaction: record
+    end
+
+    class Snapshot
+      attr_reader property_id: String
+      attr_reader stream_settings: Array[StreamSettings]
+      attr_reader reporting_identity: record
+      attr_reader attribution: record
+      attr_reader channel_groups: Array[record]
+      attr_reader calculated_metrics: Array[record]
+      attr_reader event_create_rules: Array[record]
+      attr_reader event_edit_rules: Array[record]
+      attr_reader bigquery_links: Array[record]
+
+      def initialize: (
+        property_id: String,
+        stream_settings: Array[StreamSettings],
+        reporting_identity: record,
+        attribution: record,
+        channel_groups: Array[record],
+        calculated_metrics: Array[record],
+        event_create_rules: Array[record],
+        event_edit_rules: Array[record],
+        bigquery_links: Array[record]
+      ) -> void
+      def to_h: () -> record
+    end
+
+    class Finding < Resources::Value
+      attr_reader severity: String
+      attr_reader code: String
+      attr_reader resource: String
+      attr_reader message: String
+    end
+
+    class Result
+      attr_reader snapshot: Snapshot
+      attr_reader findings: Array[Finding]
+
+      def initialize: (snapshot: Snapshot, findings: Array[Finding]) -> void
+      def compliant?: () -> bool
+      def to_h: () -> record
+    end
+
+    class ChangeHistory
+      attr_reader property_id: String
+      attr_reader events: Array[record]
+
+      def initialize: (property_id: String, events: Array[record]) -> void
+      def to_h: () -> record
+    end
+
+    class AccessReport
+      attr_reader property_id: String
+      attr_reader dimension_headers: Array[String]
+      attr_reader metric_headers: Array[String]
+      attr_reader rows: Array[record]
+      attr_reader row_count: Integer
+      attr_reader quota: record
+
+      def initialize: (
+        property_id: String,
+        dimension_headers: Array[String],
+        metric_headers: Array[String],
+        rows: Array[record],
+        row_count: Integer,
+        quota: record
+      ) -> void
+      def to_h: () -> record
+    end
+
+    class Auditor
+      def initialize: (snapshot: Snapshot, settings: record?) -> void
+      def call: () -> Result
+    end
+  end
+
   module Clients
     class Admin
       def initialize: (
@@ -366,6 +696,17 @@ module AnalyticsOps
       def discover: (?include_streams: bool) -> Array[Resources::Account]
       def property_access: (String property_id) -> Resources::Property
       def snapshot: (String property_id) -> Snapshot
+      def governance_snapshot: (String property_id) -> Governance::Snapshot
+      def change_history: (
+        String property_id,
+        ?limit: Integer,
+        ?days: Integer
+      ) -> Governance::ChangeHistory
+      def access_report: (
+        String property_id,
+        date_ranges: Array[record],
+        ?limit: Integer
+      ) -> Governance::AccessReport
       def capabilities: () -> Hash[String, bool]
       def compatibility: () -> record
       def apply_change: (Plan::Change change, property_id: String) -> Plan::Change
@@ -381,9 +722,30 @@ module AnalyticsOps
       ) -> void
       def run: (String property_id, Reports::Definition definition) -> Reports::Result
       def batch: (String property_id, Array[Reports::Definition] definitions) -> Array[Reports::Result]
+      def metadata: (String property_id) -> Reports::Metadata
+      def check_compatibility: (
+        String property_id,
+        Reports::Definition definition
+      ) -> Reports::Compatibility
       def available?: () -> bool
       def compatibility: () -> record
     end
+
+    class BigQuery
+      def initialize: (
+        settings: record,
+        ?service_account: ServiceAccount?,
+        ?client: untyped,
+        ?timeout: (Integer | Float)?,
+        ?logger: untyped
+      ) -> void
+      def run: (AnalyticsOps::BigQuery::Definition definition) -> AnalyticsOps::BigQuery::Result
+      def run_funnel: (
+        Funnels::Definition definition,
+        start_suffix: String,
+        end_suffix: String
+      ) -> AnalyticsOps::BigQuery::Result
+    end
   end
 
   class Connection
@@ -412,14 +774,18 @@ module AnalyticsOps
       attr_reader config_path: String
       attr_reader profile: String
       attr_reader property: Resources::Property
+      attr_reader warnings: Array[String]
 
       def initialize: (
         config_path: String,
         profile: String | Symbol,
         property: Resources::Property,
-        created: bool
+        created: bool,
+        ?updated: bool,
+        ?warnings: Array[String]
       ) -> void
       def created?: () -> bool
+      def updated?: () -> bool
       def status: () -> String
       def to_h: () -> record
     end
@@ -430,6 +796,7 @@ module AnalyticsOps
       profile: String | Symbol,
       ?property_id: String?,
       ?noninteractive: bool,
+      ?warnings: Array[String],
       ?input: untyped,
       ?out: untyped
     ) -> void
@@ -461,6 +828,7 @@ module AnalyticsOps
       ?environment: Hash[String, String],
       ?admin: Clients::Admin?,
       ?data: Clients::Data?,
+      ?bigquery: Clients::BigQuery?,
       ?service_account: ServiceAccount?,
       ?transport: Symbol,
       ?timeout: (Integer | Float)?,
@@ -470,6 +838,7 @@ module AnalyticsOps
       desired_state: DesiredState,
       ?admin: Clients::Admin?,
       ?data: Clients::Data?,
+      ?bigquery: Clients::BigQuery?,
       ?service_account: ServiceAccount?,
       ?transport: Symbol,
       ?timeout: (Integer | Float)?,
@@ -481,12 +850,126 @@ module AnalyticsOps
     def plan: () -> Plan
     def apply: (Plan | String plan_or_path, ?confirm: bool) -> Applier::Result
     def verify: () -> Verification
-    def report: (String | Reports::Definition name_or_definition) -> Reports::Result
+    def report: (
+      String | Reports::Definition name_or_definition,
+      ?date_ranges: Array[record]?
+    ) -> Reports::Result
     def realtime: (?String | Reports::Definition name_or_definition) -> Reports::Result
-    def overview: () -> Reports::OverviewResult
+    def overview: (?date_ranges: Array[record]?) -> Reports::OverviewResult
+    def report_metadata: (?query: String?, ?kind: String?) -> Reports::FieldList
+    def report_recipes: () -> Reports::RecipeList
+    def report_compatibility: (
+      String | Reports::Definition name_or_definition
+    ) -> Reports::Compatibility
+    def each_report_page: (
+      String | Reports::Definition name_or_definition,
+      ?date_ranges: Array[record]?,
+      ?page_size: Integer,
+      ?max_rows: Integer
+    ) ?{ (Reports::Result) -> void } -> untyped
+    def export_report: (
+      String | Reports::Definition name_or_definition,
+      path: String,
+      ?date_ranges: Array[record]?,
+      ?page_size: Integer,
+      ?max_rows: Integer
+    ) -> Reports::ExportResult
+    def health: (?date_ranges: Array[record]?) -> Health::Result
+    def governance: () -> Governance::Result
+    def change_history: (?limit: Integer, ?days: Integer) -> Governance::ChangeHistory
+    def access_report: (
+      ?date_ranges: Array[record]?,
+      ?limit: Integer
+    ) -> Governance::AccessReport
+    def raw_report: (
+      String name,
+      ?date_ranges: Array[record]?,
+      ?limit: Integer
+    ) -> BigQuery::Result
+    def funnel: (String name, ?date_ranges: Array[record]?) -> BigQuery::Result
     def doctor: () -> DoctorResult
   end
 
+  class Portfolio
+    class Entry < Resources::Value
+      attr_reader profile: String
+      attr_reader property_id: String
+      attr_reader period: String
+      attr_reader active_users: String
+      attr_reader sessions: String
+      attr_reader key_events: String
+    end
+
+    class Result
+      attr_reader entries: Array[Entry]
+      attr_reader date_ranges: Array[record]
+
+      def initialize: (entries: Array[Entry], date_ranges: Array[record]) -> void
+      def to_h: () -> record
+    end
+
+    class ProfileResult < Resources::Value
+      attr_reader profile: String
+      attr_reader property_id: String
+      attr_reader labels: record
+      attr_reader status: String
+      attr_reader result: record?
+      attr_reader error: record?
+    end
+
+    class Collection
+      attr_reader kind: String
+      attr_reader name: String
+      attr_reader entries: Array[ProfileResult]
+      attr_reader date_ranges: Array[record]
+
+      def initialize: (
+        kind: String,
+        name: String,
+        entries: Array[ProfileResult],
+        date_ranges: Array[record]
+      ) -> void
+      def success?: () -> bool
+      def to_h: () -> record
+    end
+
+    def initialize: (
+      config: String,
+      ?store: ServiceAccount::Store,
+      ?workspace_loader: untyped,
+      ?service_account_loader: untyped,
+      ?transport: Symbol,
+      ?timeout: (Integer | Float)?,
+      ?logger: untyped
+    ) -> void
+    def overview: (?date_ranges: Array[record]?) -> Result
+    def report: (
+      String name,
+      ?date_ranges: Array[record]?,
+      ?concurrency: Integer
+    ) -> Collection
+    def health: (?date_ranges: Array[record]?, ?concurrency: Integer) -> Collection
+  end
+
+  class MCPServer
+    attr_reader server: untyped
+
+    def initialize: (
+      ?config: String,
+      ?profile: String?,
+      ?connection: String?,
+      ?store: ServiceAccount::Store,
+      ?workspace_loader: untyped,
+      ?connection_loader: untyped,
+      ?service_account_loader: untyped,
+      ?portfolio_loader: untyped,
+      ?transport: Symbol,
+      ?timeout: (Integer | Float)?,
+      ?logger: untyped
+    ) -> void
+    def start: () -> untyped
+  end
+
   class CLI
     def self.start: (
       Array[String] arguments,
@@ -496,7 +979,9 @@ module AnalyticsOps
       ?workspace_loader: untyped,
       ?connection_loader: untyped,
       ?service_account_loader: untyped,
-      ?service_account_store: ServiceAccount::Store?
+      ?service_account_store: ServiceAccount::Store?,
+      ?mcp_server_loader: untyped,
+      ?portfolio_loader: untyped
     ) -> Integer
   end
 end