administrate-sdk 0.1.0

data/lib/administrate/cursor_iterator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Administrate
+  class CursorIterator
+    include Enumerable
+
+    def initialize(transport:, path:, model:, params: {})
+      @transport = transport
+      @path = path
+      @model = model
+      @params = params.dup
+      @start_page = @params.delete(:page) || 1
+    end
+
+    def each(&block)
+      page_num = @start_page
+      loop do
+        page = fetch_page(page_num)
+        page.data.each(&block)
+        break unless page.more?
+
+        page_num += 1
+      end
+    end
+
+    def first_page
+      fetch_page(@start_page)
+    end
+
+    private
+
+    def fetch_page(page_num)
+      params = @params.merge(page: page_num)
+      response = @transport.get(@path, params)
+      body = response.body
+      data = (body['data'] || []).map { |item| @model.new(item) }
+      meta = Models::PaginationMeta.new(body['meta'] || {})
+      Page.new(data: data, meta: meta)
+    end
+  end
+end

data/lib/administrate/errors.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Administrate
+  class Error < StandardError; end
+
+  class APIError < Error
+    attr_reader :status_code, :response, :body
+
+    def initialize(message, status_code:, response:, body:)
+      @status_code = status_code
+      @response = response
+      @body = body
+      super(message)
+    end
+  end
+
+  class AuthenticationError < APIError; end
+  class PermissionDeniedError < APIError; end
+  class NotFoundError < APIError; end
+  class ValidationError < APIError; end
+
+  class RateLimitError < APIError
+    attr_reader :retry_after
+
+    def initialize(message, status_code:, response:, body:, retry_after: nil)
+      @retry_after = retry_after
+      super(message, status_code: status_code, response: response, body: body)
+    end
+  end
+
+  class InternalServerError < APIError; end
+  class ConnectionError < Error; end
+  class TimeoutError < Error; end
+
+  STATUS_CODE_MAP = {
+    401 => AuthenticationError,
+    403 => PermissionDeniedError,
+    404 => NotFoundError,
+    422 => ValidationError,
+    429 => RateLimitError
+  }.freeze
+end

data/lib/administrate/models/account.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class TokenInfo < BaseModel
+      attribute :name, :permission, :expires_at
+    end
+
+    class AccountInfo < BaseModel
+      attribute :id, :name, :plan
+    end
+
+    class MeResponse < BaseModel
+      nested :token, TokenInfo
+      nested :account, AccountInfo
+    end
+
+    class Account < BaseModel
+      attribute :id, :name, :slug, :billing_email, :phone, :timezone,
+                :logo_url, :plan, :plan_name, :on_trial, :trial_ends_at,
+                :usage, :created_at, :updated_at
+    end
+  end
+end

data/lib/administrate/models/api_token.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class ApiTokenCreatedBy < BaseModel
+      attribute :id, :name
+    end
+
+    class ApiToken < BaseModel
+      attribute :id, :name, :permission, :permission_label, :token_hint,
+                :ip_allowlist, :last_used_at, :expires_at, :revoked, :active,
+                :token, :created_at, :updated_at
+      nested :created_by, ApiTokenCreatedBy
+    end
+  end
+end

data/lib/administrate/models/client_model.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class ClientMetrics < BaseModel
+      attribute :executions_count, :success_rate, :failure_count, :time_saved_minutes
+    end
+
+    class Client < BaseModel
+      attribute :id, :name, :code, :notes, :timezone, :effective_timezone,
+                :contact_first_name, :contact_last_name, :contact_email,
+                :contact_phone, :n8n_instances_count, :created_at, :updated_at
+      nested :metrics, ClientMetrics
+    end
+  end
+end

data/lib/administrate/models/execution.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class Execution < BaseModel
+      attribute :id, :workflow_id, :workflow_name, :instance_id, :instance_name,
+                :client_id, :client_name, :external_execution_id, :status,
+                :started_at, :finished_at, :duration_ms, :duration_seconds,
+                :error_category, :error_message, :error_payload, :created_at
+    end
+  end
+end

data/lib/administrate/models/instance.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class InstanceMetrics < BaseModel
+      attribute :executions_count, :success_rate
+    end
+
+    class Instance < BaseModel
+      attribute :id, :service_type, :company_id, :company_name, :name, :base_url,
+                :workflows_count, :sync_status, :last_synced_at,
+                :last_workflows_synced_at, :last_executions_synced_at,
+                :last_sync_error, :created_at, :updated_at
+      nested :metrics, InstanceMetrics
+    end
+  end
+end

data/lib/administrate/models/llm_cost.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class LlmCostSummary < BaseModel
+      attribute :total_cost_cents, :total_tokens, :total_input_tokens,
+                :total_output_tokens, :total_requests, :providers_count
+    end
+
+    class LlmCostByProvider < BaseModel
+      attribute :id, :name, :provider_type, :cost_cents, :tokens, :requests
+    end
+
+    class LlmCostByClient < BaseModel
+      attribute :id, :name, :cost_cents, :tokens
+    end
+
+    class LlmCostModel < BaseModel
+      attribute :model, :cost_cents, :tokens, :requests
+    end
+
+    class LlmCostDaily < BaseModel
+      attribute :date, :cost_cents, :tokens
+    end
+
+    class LlmCostSummaryData < BaseModel
+      nested :summary, LlmCostSummary
+      nested :providers, LlmCostByProvider, array: true
+      nested :models, LlmCostModel, array: true
+      nested :daily, LlmCostDaily, array: true
+    end
+
+    class LlmCostSummaryMeta < BaseModel
+      attribute :start_date, :end_date
+    end
+  end
+end

data/lib/administrate/models/llm_project.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class LlmProject < BaseModel
+      attribute :id, :external_id, :name, :client_id, :client_name,
+                :total_cost_cents, :total_tokens, :created_at, :updated_at
+    end
+  end
+end

data/lib/administrate/models/llm_provider.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class LlmProviderMetrics < BaseModel
+      attribute :total_cost_cents, :total_tokens, :total_requests
+    end
+
+    class LlmProvider < BaseModel
+      attribute :id, :name, :provider_type, :organization_id,
+                :projects_count, :sync_status, :last_synced_at,
+                :last_sync_error, :created_at, :updated_at
+      nested :metrics, LlmProviderMetrics
+    end
+  end
+end

data/lib/administrate/models/pagination_meta.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class PaginationMeta < BaseModel
+      attribute :page, :per_page, :total, :total_pages, :has_more
+    end
+  end
+end

data/lib/administrate/models/sync_run.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class SyncRun < BaseModel
+      attribute :id, :instance_id, :instance_name, :sync_type, :status,
+                :started_at, :finished_at, :duration_seconds,
+                :records_created, :records_updated, :error_message, :created_at
+    end
+
+    class SyncHealthSyncInfo < BaseModel
+      attribute :last_synced_at
+      nested :last_run, SyncRun
+    end
+
+    class SyncHealthEntry < BaseModel
+      attribute :instance_id, :instance_name, :client_id, :client_name,
+                :sync_status, :last_sync_error
+      nested :workflows, SyncHealthSyncInfo
+      nested :executions, SyncHealthSyncInfo
+    end
+  end
+end

data/lib/administrate/models/user.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class User < BaseModel
+      attribute :id, :email, :name, :first_name, :last_name,
+                :phone, :timezone, :avatar_url, :role, :joined_at
+    end
+
+    class Invitation < BaseModel
+      attribute :id, :email, :role, :expires_at, :created_at
+    end
+  end
+end

data/lib/administrate/models/webhook.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class Webhook < BaseModel
+      attribute :id, :url, :description, :events, :enabled,
+                :consecutive_failures, :last_triggered_at, :secret,
+                :created_at, :updated_at
+    end
+  end
+end

data/lib/administrate/models/workflow.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Models
+    class WorkflowMetrics < BaseModel
+      attribute :executions_count, :success_count, :failure_count,
+                :success_rate, :time_saved_minutes
+    end
+
+    class Workflow < BaseModel
+      attribute :id, :instance_id, :instance_name, :company_id, :company_name,
+                :external_workflow_id, :name, :is_active,
+                :minutes_saved_per_success, :minutes_saved_per_failure,
+                :created_at, :updated_at
+      nested :metrics, WorkflowMetrics
+    end
+  end
+end

data/lib/administrate/page.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Administrate
+  class Page
+    attr_reader :data, :meta
+
+    def initialize(data:, meta:)
+      @data = data
+      @meta = meta
+    end
+
+    def each(&)
+      @data.each(&)
+    end
+
+    def size
+      @data.size
+    end
+    alias length size
+
+    def more?
+      @meta.has_more
+    end
+  end
+end

data/lib/administrate/resources/account.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class Account < BaseResource
+      def me
+        response = @transport.get('me')
+        Models::MeResponse.new(response.body)
+      end
+
+      def get
+        get_resource('account', Models::Account)
+      end
+
+      def update(name: nil, billing_email: nil, timezone: nil)
+        body = {}
+        body[:name] = name unless name.nil?
+        body[:billing_email] = billing_email unless billing_email.nil?
+        body[:timezone] = timezone unless timezone.nil?
+        update_resource('account', Models::Account, body)
+      end
+    end
+  end
+end

data/lib/administrate/resources/api_tokens.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class ApiTokens < BaseResource
+      def list(page: nil, per_page: nil)
+        params = {}
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'api_tokens', model: Models::ApiToken, params: params)
+      end
+
+      def get(token_id)
+        get_resource("api_tokens/#{token_id}", Models::ApiToken)
+      end
+
+      def create(name:, permission: nil, ip_allowlist: nil, expires_in: nil)
+        body = { name: name }
+        body[:permission] = permission unless permission.nil?
+        body[:ip_allowlist] = ip_allowlist unless ip_allowlist.nil?
+        body[:expires_in] = expires_in unless expires_in.nil?
+        create_resource('api_tokens', Models::ApiToken, body)
+      end
+
+      def update(token_id, name: nil, ip_allowlist: nil)
+        body = {}
+        body[:name] = name unless name.nil?
+        body[:ip_allowlist] = ip_allowlist unless ip_allowlist.nil?
+        update_resource("api_tokens/#{token_id}", Models::ApiToken, body)
+      end
+
+      def delete(token_id)
+        delete_resource("api_tokens/#{token_id}")
+      end
+    end
+  end
+end

data/lib/administrate/resources/base_resource.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class BaseResource
+      def initialize(transport)
+        @transport = transport
+      end
+
+      private
+
+      def list_resource(path:, model:, params: {})
+        CursorIterator.new(transport: @transport, path: path, model: model, params: params)
+      end
+
+      def get_resource(path, model)
+        response = @transport.get(path)
+        model.new(response.body['data'])
+      end
+
+      def create_resource(path, model, body)
+        response = @transport.post(path, body)
+        model.new(response.body['data'])
+      end
+
+      def update_resource(path, model, body)
+        response = @transport.patch(path, body)
+        model.new(response.body['data'])
+      end
+
+      def delete_resource(path)
+        @transport.delete(path)
+        nil
+      end
+    end
+  end
+end

data/lib/administrate/resources/clients.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class Clients < BaseResource
+      def list(page: nil, per_page: nil)
+        params = {}
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'clients', model: Models::Client, params: params)
+      end
+
+      def get(client_id)
+        get_resource("clients/#{client_id}", Models::Client)
+      end
+
+      def create(name:, code: nil, notes: nil, timezone: nil, contact_first_name: nil,
+                 contact_last_name: nil, contact_email: nil, contact_phone: nil)
+        body = { name: name }
+        body[:code] = code unless code.nil?
+        body[:notes] = notes unless notes.nil?
+        body[:timezone] = timezone unless timezone.nil?
+        body[:contact_first_name] = contact_first_name unless contact_first_name.nil?
+        body[:contact_last_name] = contact_last_name unless contact_last_name.nil?
+        body[:contact_email] = contact_email unless contact_email.nil?
+        body[:contact_phone] = contact_phone unless contact_phone.nil?
+        create_resource('clients', Models::Client, body)
+      end
+
+      def update(client_id, name: nil, code: nil, notes: nil, timezone: nil,
+                 contact_first_name: nil, contact_last_name: nil, contact_email: nil, contact_phone: nil)
+        body = {}
+        body[:name] = name unless name.nil?
+        body[:code] = code unless code.nil?
+        body[:notes] = notes unless notes.nil?
+        body[:timezone] = timezone unless timezone.nil?
+        body[:contact_first_name] = contact_first_name unless contact_first_name.nil?
+        body[:contact_last_name] = contact_last_name unless contact_last_name.nil?
+        body[:contact_email] = contact_email unless contact_email.nil?
+        body[:contact_phone] = contact_phone unless contact_phone.nil?
+        update_resource("clients/#{client_id}", Models::Client, body)
+      end
+
+      def delete(client_id)
+        delete_resource("clients/#{client_id}")
+      end
+    end
+  end
+end

data/lib/administrate/resources/executions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class Executions < BaseResource
+      def list(client_id: nil, instance_id: nil, workflow_id: nil, status: nil,
+               error_category: nil, start_date: nil, end_date: nil, errors_only: nil,
+               page: nil, per_page: nil)
+        params = {}
+        params[:client_id] = client_id unless client_id.nil?
+        params[:instance_id] = instance_id unless instance_id.nil?
+        params[:workflow_id] = workflow_id unless workflow_id.nil?
+        params[:status] = status unless status.nil?
+        params[:error_category] = error_category unless error_category.nil?
+        params[:start_date] = start_date unless start_date.nil?
+        params[:end_date] = end_date unless end_date.nil?
+        params[:errors_only] = errors_only.to_s unless errors_only.nil?
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'executions', model: Models::Execution, params: params)
+      end
+
+      def get(execution_id)
+        get_resource("executions/#{execution_id}", Models::Execution)
+      end
+    end
+  end
+end

data/lib/administrate/resources/instances.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class Instances < BaseResource
+      def list(client_id: nil, service_type: nil, sync_status: nil, page: nil, per_page: nil)
+        params = {}
+        params[:company_id] = client_id unless client_id.nil?
+        params[:service_type] = service_type unless service_type.nil?
+        params[:sync_status] = sync_status unless sync_status.nil?
+        params[:page] = page unless page.nil?
+        params[:per_page] = per_page unless per_page.nil?
+        list_resource(path: 'instances', model: Models::Instance, params: params)
+      end
+
+      def get(instance_id)
+        get_resource("instances/#{instance_id}", Models::Instance)
+      end
+
+      def create(client_id:, name:, base_url:, api_key:, service_type: nil)
+        body = {
+          company_id: client_id,
+          name: name,
+          base_url: base_url,
+          api_key: api_key
+        }
+        body[:service_type] = service_type unless service_type.nil?
+        create_resource('instances', Models::Instance, body)
+      end
+
+      def update(instance_id, name: nil, base_url: nil, api_key: nil, service_type: nil)
+        body = {}
+        body[:name] = name unless name.nil?
+        body[:base_url] = base_url unless base_url.nil?
+        body[:api_key] = api_key unless api_key.nil?
+        body[:service_type] = service_type unless service_type.nil?
+        update_resource("instances/#{instance_id}", Models::Instance, body)
+      end
+
+      def delete(instance_id)
+        delete_resource("instances/#{instance_id}")
+      end
+
+      def sync(instance_id, sync_type: nil)
+        body = {}
+        body[:sync_type] = sync_type unless sync_type.nil?
+        response = @transport.post("instances/#{instance_id}/sync", body)
+        response.body
+      end
+
+      def sync_all(sync_type: nil, client_id: nil, service_type: nil)
+        body = {}
+        body[:sync_type] = sync_type unless sync_type.nil?
+        body[:company_id] = client_id unless client_id.nil?
+        body[:service_type] = service_type unless service_type.nil?
+        response = @transport.post('instances/sync_all', body)
+        response.body
+      end
+    end
+  end
+end

data/lib/administrate/resources/llm_costs.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Administrate
+  module Resources
+    class LlmCosts < BaseResource
+      def summary(start_date: nil, end_date: nil)
+        response = @transport.get('llm_costs', date_params(start_date, end_date))
+        body = response.body
+        LlmCostSummaryResponse.new(
+          data: Models::LlmCostSummaryData.new(body['data']),
+          meta: Models::LlmCostSummaryMeta.new(body['meta'])
+        )
+      end
+
+      def by_client(start_date: nil, end_date: nil)
+        response = @transport.get('llm_costs/by_client', date_params(start_date, end_date))
+        body = response.body
+        LlmCostByClientResponse.new(
+          data: (body['data'] || []).map { |item| Models::LlmCostByClient.new(item) },
+          meta: Models::LlmCostSummaryMeta.new(body['meta'])
+        )
+      end
+
+      def by_provider(start_date: nil, end_date: nil)
+        response = @transport.get('llm_costs/by_provider', date_params(start_date, end_date))
+        body = response.body
+        LlmCostByProviderResponse.new(
+          data: (body['data'] || []).map { |item| Models::LlmCostByProvider.new(item) },
+          meta: Models::LlmCostSummaryMeta.new(body['meta'])
+        )
+      end
+
+      private
+
+      def date_params(start_date, end_date)
+        params = {}
+        params[:start_date] = start_date unless start_date.nil?
+        params[:end_date] = end_date unless end_date.nil?
+        params
+      end
+    end
+
+    class LlmCostSummaryResponse
+      attr_reader :data, :meta
+
+      def initialize(data:, meta:)
+        @data = data
+        @meta = meta
+      end
+    end
+
+    class LlmCostByClientResponse
+      attr_reader :data, :meta
+
+      def initialize(data:, meta:)
+        @data = data
+        @meta = meta
+      end
+    end
+
+    class LlmCostByProviderResponse
+      attr_reader :data, :meta
+
+      def initialize(data:, meta:)
+        @data = data
+        @meta = meta
+      end
+    end
+  end
+end