seam 2.0.0a2 → 2.0.0b0

data/lib/seam/routes/clients/webhooks.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Webhooks
+      def initialize(client:, defaults:)
+        @client = client
+        @defaults = defaults
+      end
+
+      def create(url:, event_types: nil)
+        res = @client.post("/webhooks/create", {url: url, event_types: event_types}.compact)
+
+        Seam::Resources::Webhook.load_from_response(res.body["webhook"])
+      end
+
+      def delete(webhook_id:)
+        @client.post("/webhooks/delete", {webhook_id: webhook_id}.compact)
+
+        nil
+      end
+
+      def get(webhook_id:)
+        res = @client.post("/webhooks/get", {webhook_id: webhook_id}.compact)
+
+        Seam::Resources::Webhook.load_from_response(res.body["webhook"])
+      end
+
+      def list
+        res = @client.post("/webhooks/list")
+
+        Seam::Resources::Webhook.load_from_response(res.body["webhooks"])
+      end
+
+      def update(event_types:, webhook_id:)
+        @client.post("/webhooks/update", {event_types: event_types, webhook_id: webhook_id}.compact)
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/routes/clients/workspaces.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "seam/helpers/action_attempt"
+
+module Seam
+  module Clients
+    class Workspaces
+      def initialize(client:, defaults:)
+        @client = client
+        @defaults = defaults
+      end
+
+      def create(name:, company_name: nil, connect_partner_name: nil, is_sandbox: nil, webview_logo_shape: nil, webview_primary_button_color: nil, webview_primary_button_text_color: nil)
+        res = @client.post("/workspaces/create", {name: name, company_name: company_name, connect_partner_name: connect_partner_name, is_sandbox: is_sandbox, webview_logo_shape: webview_logo_shape, webview_primary_button_color: webview_primary_button_color, webview_primary_button_text_color: webview_primary_button_text_color}.compact)
+
+        Seam::Resources::Workspace.load_from_response(res.body["workspace"])
+      end
+
+      def get
+        res = @client.post("/workspaces/get")
+
+        Seam::Resources::Workspace.load_from_response(res.body["workspace"])
+      end
+
+      def list
+        res = @client.post("/workspaces/list")
+
+        Seam::Resources::Workspace.load_from_response(res.body["workspaces"])
+      end
+
+      def reset_sandbox(wait_for_action_attempt: nil)
+        res = @client.post("/workspaces/reset_sandbox")
+
+        wait_for_action_attempt = wait_for_action_attempt.nil? ? @defaults.wait_for_action_attempt : wait_for_action_attempt
+
+        Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
+      end
+    end
+  end
+end

data/lib/seam/routes/resources/access_code.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AccessCode < BaseResource
+      attr_accessor :access_code_id, :code, :common_code_key, :device_id, :is_backup, :is_backup_access_code_available, :is_external_modification_allowed, :is_managed, :is_offline_access_code, :is_one_time_use, :is_scheduled_on_device, :is_waiting_for_code_assignment, :name, :pulled_backup_access_code_id, :status, :type
+
+      date_accessor :created_at, :ends_at, :starts_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/acs_access_group.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AcsAccessGroup < BaseResource
+      attr_accessor :access_group_type, :access_group_type_display_name, :acs_access_group_id, :acs_system_id, :display_name, :external_type, :external_type_display_name, :is_managed, :name, :workspace_id
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/acs_credential.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AcsCredential < BaseResource
+      attr_accessor :access_method, :acs_credential_id, :acs_credential_pool_id, :acs_system_id, :acs_user_id, :card_number, :code, :display_name, :ends_at, :external_type, :external_type_display_name, :is_issued, :is_latest_desired_state_synced_with_provider, :is_managed, :is_multi_phone_sync_credential, :parent_acs_credential_id, :starts_at, :visionline_metadata, :workspace_id
+
+      date_accessor :created_at, :issued_at, :latest_desired_state_synced_with_provider_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/acs_credential_pool.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AcsCredentialPool < BaseResource
+      attr_accessor :acs_credential_pool_id, :acs_system_id, :display_name, :external_type, :external_type_display_name, :workspace_id
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/acs_credential_provisioning_automation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AcsCredentialProvisioningAutomation < BaseResource
+      attr_accessor :acs_credential_provisioning_automation_id, :credential_manager_acs_system_id, :user_identity_id, :workspace_id
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/acs_entrance.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AcsEntrance < BaseResource
+      attr_accessor :acs_entrance_id, :acs_system_id, :assa_abloy_vostio_metadata, :display_name, :dormakaba_community_metadata, :latch_metadata, :salto_ks_metadata, :visionline_metadata
+
+      date_accessor :created_at
+
+      include Seam::Resources::ResourceErrorsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/acs_system.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AcsSystem < BaseResource
+      attr_accessor :acs_system_id, :can_add_acs_users_to_acs_access_groups, :can_automate_enrollment, :can_create_acs_access_groups, :can_remove_acs_users_from_acs_access_groups, :connected_account_ids, :default_credential_manager_acs_system_id, :external_type, :external_type_display_name, :image_alt_text, :image_url, :is_credential_manager, :name, :system_type, :system_type_display_name, :visionline_metadata, :workspace_id
+
+      date_accessor :created_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/acs_user.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class AcsUser < BaseResource
+      attr_accessor :access_schedule, :acs_system_id, :acs_user_id, :display_name, :email, :email_address, :external_type, :external_type_display_name, :full_name, :hid_acs_system_id, :is_latest_desired_state_synced_with_provider, :is_managed, :is_suspended, :phone_number, :user_identity_email_address, :user_identity_full_name, :user_identity_id, :user_identity_phone_number, :workspace_id
+
+      date_accessor :created_at, :latest_desired_state_synced_with_provider_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/action_attempt.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ActionAttempt < BaseResource
+      attr_accessor :action_attempt_id, :action_type, :error, :result, :status
+    end
+  end
+end

data/lib/seam/routes/resources/client_session.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ClientSession < BaseResource
+      attr_accessor :client_session_id, :connect_webview_ids, :connected_account_ids, :device_count, :token, :user_identifier_key, :user_identity_ids, :workspace_id
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/connect_webview.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ConnectWebview < BaseResource
+      attr_accessor :accepted_devices, :accepted_providers, :any_device_allowed, :any_provider_allowed, :automatically_manage_new_devices, :connect_webview_id, :connected_account_id, :custom_metadata, :custom_redirect_failure_url, :custom_redirect_url, :device_selection_mode, :login_successful, :selected_provider, :status, :url, :wait_for_device_creation, :workspace_id
+
+      date_accessor :authorized_at, :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/connected_account.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ConnectedAccount < BaseResource
+      attr_accessor :account_type, :account_type_display_name, :automatically_manage_new_devices, :connected_account_id, :custom_metadata, :user_identifier
+
+      date_accessor :created_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/device.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class Device < BaseResource
+      attr_accessor :can_hvac_cool, :can_hvac_heat, :can_hvac_heat_cool, :can_program_offline_access_codes, :can_program_online_access_codes, :can_remotely_lock, :can_remotely_unlock, :can_simulate_connection, :can_simulate_disconnection, :can_simulate_removal, :can_turn_off_hvac, :capabilities_supported, :connected_account_id, :custom_metadata, :device_id, :device_type, :display_name, :is_managed, :location, :nickname, :properties, :workspace_id
+
+      date_accessor :created_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/device_provider.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class DeviceProvider < BaseResource
+      attr_accessor :can_hvac_cool, :can_hvac_heat, :can_hvac_heat_cool, :can_program_offline_access_codes, :can_program_online_access_codes, :can_remotely_lock, :can_remotely_unlock, :can_simulate_connection, :can_simulate_disconnection, :can_simulate_removal, :can_turn_off_hvac, :device_provider_name, :display_name, :image_url, :provider_categories
+    end
+  end
+end

data/lib/seam/routes/resources/enrollment_automation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class EnrollmentAutomation < BaseResource
+      attr_accessor :credential_manager_acs_system_id, :enrollment_automation_id, :user_identity_id, :workspace_id
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/event.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class SeamEvent < BaseResource
+      attr_accessor :acs_credential_id, :acs_system_id, :acs_user_id, :action_attempt_id, :client_session_id, :climate_preset_key, :cooling_set_point_celsius, :cooling_set_point_fahrenheit, :device_id, :enrollment_automation_id, :event_description, :event_id, :event_type, :fan_mode_setting, :heating_set_point_celsius, :heating_set_point_fahrenheit, :hvac_mode_setting, :is_fallback_climate_preset, :method, :thermostat_schedule_id, :workspace_id
+
+      date_accessor :created_at, :occurred_at
+    end
+  end
+end

data/lib/seam/routes/resources/index.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "seam/base_resource"
+require_relative "resource_error"
+require_relative "resource_warning"
+require_relative "resource_errors_support"
+require_relative "resource_warnings_support"
+require_relative "access_code"
+require_relative "acs_access_group"
+require_relative "acs_credential"
+require_relative "acs_credential_pool"
+require_relative "acs_credential_provisioning_automation"
+require_relative "acs_entrance"
+require_relative "acs_system"
+require_relative "acs_user"
+require_relative "action_attempt"
+require_relative "client_session"
+require_relative "connect_webview"
+require_relative "connected_account"
+require_relative "device"
+require_relative "device_provider"
+require_relative "enrollment_automation"
+require_relative "event"
+require_relative "network"
+require_relative "noise_threshold"
+require_relative "phone"
+require_relative "service_health"
+require_relative "thermostat_schedule"
+require_relative "unmanaged_access_code"
+require_relative "unmanaged_device"
+require_relative "user_identity"
+require_relative "webhook"
+require_relative "workspace"

data/lib/seam/routes/resources/network.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class Network < BaseResource
+      attr_accessor :display_name, :network_id, :workspace_id
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/noise_threshold.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class NoiseThreshold < BaseResource
+      attr_accessor :device_id, :ends_daily_at, :name, :noise_threshold_decibels, :noise_threshold_id, :noise_threshold_nrs, :starts_daily_at
+    end
+  end
+end

data/lib/seam/routes/resources/phone.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class Phone < BaseResource
+      attr_accessor :can_hvac_cool, :can_hvac_heat, :can_hvac_heat_cool, :can_program_offline_access_codes, :can_program_online_access_codes, :can_remotely_lock, :can_remotely_unlock, :can_simulate_connection, :can_simulate_disconnection, :can_simulate_removal, :can_turn_off_hvac, :capabilities_supported, :custom_metadata, :device_id, :device_type, :display_name, :is_managed, :location, :nickname, :properties, :workspace_id
+
+      date_accessor :created_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/resource_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ResourceError < BaseResource
+      attr_accessor :error_code, :message
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/resource_errors_support.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    module ResourceErrorsSupport
+      def errors
+        @errors_converted ||= @errors.is_a?(Array) ? Seam::Resources::ResourceError.load_from_response(@errors) : []
+      end
+    end
+  end
+end

data/lib/seam/routes/resources/resource_warning.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ResourceWarning < BaseResource
+      attr_accessor :warning_code, :message
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/resource_warnings_support.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    module ResourceWarningsSupport
+      def warnings
+        @warnings_converted ||= @warnings.is_a?(Array) ? Seam::Resources::ResourceWarning.load_from_response(@warnings) : []
+      end
+    end
+  end
+end

data/lib/seam/routes/resources/service_health.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ServiceHealth < BaseResource
+      attr_accessor :description, :service, :status
+    end
+  end
+end

data/lib/seam/routes/resources/thermostat_schedule.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class ThermostatSchedule < BaseResource
+      attr_accessor :climate_preset_key, :device_id, :max_override_period_minutes, :name, :thermostat_schedule_id
+
+      date_accessor :created_at, :ends_at, :starts_at
+
+      include Seam::Resources::ResourceErrorsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/unmanaged_access_code.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class UnmanagedAccessCode < BaseResource
+      attr_accessor :access_code_id, :code, :device_id, :is_managed, :name, :status, :type
+
+      date_accessor :created_at, :ends_at, :starts_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/unmanaged_device.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class UnmanagedDevice < BaseResource
+      attr_accessor :can_hvac_cool, :can_hvac_heat, :can_hvac_heat_cool, :can_program_offline_access_codes, :can_program_online_access_codes, :can_remotely_lock, :can_remotely_unlock, :can_simulate_connection, :can_simulate_disconnection, :can_simulate_removal, :can_turn_off_hvac, :capabilities_supported, :connected_account_id, :device_id, :device_type, :is_managed, :location, :properties, :workspace_id
+
+      date_accessor :created_at
+
+      include Seam::Resources::ResourceErrorsSupport
+      include Seam::Resources::ResourceWarningsSupport
+    end
+  end
+end

data/lib/seam/routes/resources/user_identity.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class UserIdentity < BaseResource
+      attr_accessor :display_name, :email_address, :full_name, :phone_number, :user_identity_id, :user_identity_key, :workspace_id
+
+      date_accessor :created_at
+    end
+  end
+end

data/lib/seam/routes/resources/webhook.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class Webhook < BaseResource
+      attr_accessor :event_types, :secret, :url, :webhook_id
+    end
+  end
+end

data/lib/seam/routes/resources/workspace.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  module Resources
+    class Workspace < BaseResource
+      attr_accessor :company_name, :connect_partner_name, :is_sandbox, :name, :workspace_id
+    end
+  end
+end

data/lib/seam/routes/routes.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Seam
+  module Routes
+    def access_codes
+      @access_codes ||= Seam::Clients::AccessCodes.new(client: @client, defaults: @defaults)
+    end
+
+    def acs
+      @acs ||= Seam::Clients::Acs.new(client: @client, defaults: @defaults)
+    end
+
+    def action_attempts
+      @action_attempts ||= Seam::Clients::ActionAttempts.new(client: @client, defaults: @defaults)
+    end
+
+    def client_sessions
+      @client_sessions ||= Seam::Clients::ClientSessions.new(client: @client, defaults: @defaults)
+    end
+
+    def connect_webviews
+      @connect_webviews ||= Seam::Clients::ConnectWebviews.new(client: @client, defaults: @defaults)
+    end
+
+    def connected_accounts
+      @connected_accounts ||= Seam::Clients::ConnectedAccounts.new(client: @client, defaults: @defaults)
+    end
+
+    def devices
+      @devices ||= Seam::Clients::Devices.new(client: @client, defaults: @defaults)
+    end
+
+    def events
+      @events ||= Seam::Clients::Events.new(client: @client, defaults: @defaults)
+    end
+
+    def locks
+      @locks ||= Seam::Clients::Locks.new(client: @client, defaults: @defaults)
+    end
+
+    def networks
+      @networks ||= Seam::Clients::Networks.new(client: @client, defaults: @defaults)
+    end
+
+    def noise_sensors
+      @noise_sensors ||= Seam::Clients::NoiseSensors.new(client: @client, defaults: @defaults)
+    end
+
+    def phones
+      @phones ||= Seam::Clients::Phones.new(client: @client, defaults: @defaults)
+    end
+
+    def thermostats
+      @thermostats ||= Seam::Clients::Thermostats.new(client: @client, defaults: @defaults)
+    end
+
+    def user_identities
+      @user_identities ||= Seam::Clients::UserIdentities.new(client: @client, defaults: @defaults)
+    end
+
+    def webhooks
+      @webhooks ||= Seam::Clients::Webhooks.new(client: @client, defaults: @defaults)
+    end
+
+    def workspaces
+      @workspaces ||= Seam::Clients::Workspaces.new(client: @client, defaults: @defaults)
+    end
+
+    def health
+      @client.get("/health")
+    end
+
+    # @deprecated Please use {#devices.unmanaged} instead.
+    def unmanaged_devices
+      warn "[DEPRECATION] 'unmanaged_devices' is deprecated. Please use 'devices.unmanaged' instead."
+
+      @unmanaged_devices ||= Seam::Clients::DevicesUnmanaged.new(client: @client, defaults: @defaults)
+    end
+
+    # @deprecated Please use {#access_codes.unmanaged} instead.
+    def unmanaged_access_codes
+      warn "[DEPRECATION] 'unmanaged_access_codes' is deprecated. Please use 'access_codes.unmanaged' instead."
+
+      @unmanaged_access_codes ||= Seam::Clients::AccessCodesUnmanaged.new(client: @client, defaults: @defaults)
+    end
+
+    private
+
+    def initialize_routes(client:, defaults:)
+      @client = client
+      @defaults = defaults
+    end
+  end
+end

data/lib/seam/token.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Seam
+  module Http
+    module Auth
+      TOKEN_PREFIX = "seam_"
+
+      ACCESS_TOKEN_PREFIX = "seam_at"
+
+      JWT_PREFIX = "ey"
+
+      CLIENT_SESSION_TOKEN_PREFIX = "seam_cst"
+
+      PUBLISHABLE_KEY_TOKEN_PREFIX = "seam_pk"
+
+      def self.access_token?(token)
+        token.start_with?(ACCESS_TOKEN_PREFIX)
+      end
+
+      def self.jwt?(token)
+        token.start_with?(JWT_PREFIX)
+      end
+
+      def self.seam_token?(token)
+        token.start_with?(TOKEN_PREFIX)
+      end
+
+      def self.api_key?(token)
+        !client_session_token?(token) &&
+          !jwt?(token) &&
+          !access_token?(token) &&
+          !publishable_key?(token) &&
+          seam_token?(token)
+      end
+
+      def self.client_session_token?(token)
+        token.start_with?(CLIENT_SESSION_TOKEN_PREFIX)
+      end
+
+      def self.publishable_key?(token)
+        token.start_with?(PUBLISHABLE_KEY_TOKEN_PREFIX)
+      end
+
+      def self.console_session_token?(token)
+        jwt?(token)
+      end
+
+      def self.personal_access_token?(token)
+        access_token?(token)
+      end
+    end
+  end
+end