seam 1.1.3 → 2.0.0a2

data/lib/seam/clients/thermostats_climate_setting_schedules.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ThermostatsClimateSettingSchedules < BaseClient
+      def create(device_id:, schedule_ends_at:, schedule_starts_at:, automatic_cooling_enabled: nil, automatic_heating_enabled: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, manual_override_allowed: nil, name: nil, schedule_type: nil)
+        request_seam_object(
+          :post,
+          "/thermostats/climate_setting_schedules/create",
+          Seam::ClimateSettingSchedule,
+          "climate_setting_schedule",
+          body: {device_id: device_id, schedule_ends_at: schedule_ends_at, schedule_starts_at: schedule_starts_at, automatic_cooling_enabled: automatic_cooling_enabled, automatic_heating_enabled: automatic_heating_enabled, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, manual_override_allowed: manual_override_allowed, name: name, schedule_type: schedule_type}.compact
+        )
+      end
+
+      def delete(climate_setting_schedule_id:)
+        request_seam(
+          :post,
+          "/thermostats/climate_setting_schedules/delete",
+          body: {climate_setting_schedule_id: climate_setting_schedule_id}.compact
+        )
+
+        nil
+      end
+
+      def get(climate_setting_schedule_id: nil, device_id: nil)
+        request_seam_object(
+          :post,
+          "/thermostats/climate_setting_schedules/get",
+          Seam::ClimateSettingSchedule,
+          "climate_setting_schedule",
+          body: {climate_setting_schedule_id: climate_setting_schedule_id, device_id: device_id}.compact
+        )
+      end
+
+      def list(device_id:, user_identifier_key: nil)
+        request_seam_object(
+          :post,
+          "/thermostats/climate_setting_schedules/list",
+          Seam::ClimateSettingSchedule,
+          "climate_setting_schedules",
+          body: {device_id: device_id, user_identifier_key: user_identifier_key}.compact
+        )
+      end
+
+      def update(climate_setting_schedule_id:, automatic_cooling_enabled: nil, automatic_heating_enabled: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, manual_override_allowed: nil, name: nil, schedule_ends_at: nil, schedule_starts_at: nil, schedule_type: nil)
+        request_seam(
+          :post,
+          "/thermostats/climate_setting_schedules/update",
+          body: {climate_setting_schedule_id: climate_setting_schedule_id, automatic_cooling_enabled: automatic_cooling_enabled, automatic_heating_enabled: automatic_heating_enabled, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, manual_override_allowed: manual_override_allowed, name: name, schedule_ends_at: schedule_ends_at, schedule_starts_at: schedule_starts_at, schedule_type: schedule_type}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/user_identities.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class UserIdentities < BaseClient
+      def enrollment_automations
+        @enrollment_automations ||= Seam::Clients::UserIdentitiesEnrollmentAutomations.new(self)
+      end
+
+      def add_acs_user(acs_user_id:, user_identity_id:)
+        request_seam(
+          :post,
+          "/user_identities/add_acs_user",
+          body: {acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact
+        )
+
+        nil
+      end
+
+      def create(email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil)
+        request_seam_object(
+          :post,
+          "/user_identities/create",
+          Seam::UserIdentity,
+          "user_identity",
+          body: {email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_key: user_identity_key}.compact
+        )
+      end
+
+      def delete(user_identity_id:)
+        request_seam(
+          :post,
+          "/user_identities/delete",
+          body: {user_identity_id: user_identity_id}.compact
+        )
+
+        nil
+      end
+
+      def get(user_identity_id: nil, user_identity_key: nil)
+        request_seam_object(
+          :post,
+          "/user_identities/get",
+          Seam::UserIdentity,
+          "user_identity",
+          body: {user_identity_id: user_identity_id, user_identity_key: user_identity_key}.compact
+        )
+      end
+
+      def grant_access_to_device(device_id:, user_identity_id:)
+        request_seam(
+          :post,
+          "/user_identities/grant_access_to_device",
+          body: {device_id: device_id, user_identity_id: user_identity_id}.compact
+        )
+
+        nil
+      end
+
+      def list(credential_manager_acs_system_id: nil)
+        request_seam_object(
+          :post,
+          "/user_identities/list",
+          Seam::UserIdentity,
+          "user_identities",
+          body: {credential_manager_acs_system_id: credential_manager_acs_system_id}.compact
+        )
+      end
+
+      def list_accessible_devices(user_identity_id:)
+        request_seam_object(
+          :post,
+          "/user_identities/list_accessible_devices",
+          Seam::Device,
+          "devices",
+          body: {user_identity_id: user_identity_id}.compact
+        )
+      end
+
+      def list_acs_systems(user_identity_id:)
+        request_seam_object(
+          :post,
+          "/user_identities/list_acs_systems",
+          Seam::AcsSystem,
+          "acs_systems",
+          body: {user_identity_id: user_identity_id}.compact
+        )
+      end
+
+      def list_acs_users(user_identity_id:)
+        request_seam_object(
+          :post,
+          "/user_identities/list_acs_users",
+          Seam::AcsUser,
+          "acs_users",
+          body: {user_identity_id: user_identity_id}.compact
+        )
+      end
+
+      def remove_acs_user(acs_user_id:, user_identity_id:)
+        request_seam(
+          :post,
+          "/user_identities/remove_acs_user",
+          body: {acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact
+        )
+
+        nil
+      end
+
+      def revoke_access_to_device(device_id:, user_identity_id:)
+        request_seam(
+          :post,
+          "/user_identities/revoke_access_to_device",
+          body: {device_id: device_id, user_identity_id: user_identity_id}.compact
+        )
+
+        nil
+      end
+
+      def update(user_identity_id:, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil)
+        request_seam(
+          :post,
+          "/user_identities/update",
+          body: {user_identity_id: user_identity_id, email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_key: user_identity_key}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/user_identities_enrollment_automations.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class UserIdentitiesEnrollmentAutomations < BaseClient
+      def delete(enrollment_automation_id:)
+        request_seam(
+          :post,
+          "/user_identities/enrollment_automations/delete",
+          body: {enrollment_automation_id: enrollment_automation_id}.compact
+        )
+
+        nil
+      end
+
+      def get(enrollment_automation_id:)
+        request_seam_object(
+          :post,
+          "/user_identities/enrollment_automations/get",
+          Seam::EnrollmentAutomation,
+          "enrollment_automation",
+          body: {enrollment_automation_id: enrollment_automation_id}.compact
+        )
+      end
+
+      def launch(credential_manager_acs_system_id:, user_identity_id:, acs_credential_pool_id: nil, create_credential_manager_user: nil, credential_manager_acs_user_id: nil)
+        request_seam(
+          :post,
+          "/user_identities/enrollment_automations/launch",
+          body: {credential_manager_acs_system_id: credential_manager_acs_system_id, user_identity_id: user_identity_id, acs_credential_pool_id: acs_credential_pool_id, create_credential_manager_user: create_credential_manager_user, credential_manager_acs_user_id: credential_manager_acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def list(user_identity_id:)
+        request_seam_object(
+          :post,
+          "/user_identities/enrollment_automations/list",
+          Seam::EnrollmentAutomation,
+          "enrollment_automations",
+          body: {user_identity_id: user_identity_id}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/webhooks.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Webhooks < BaseClient
+      def create(url:, event_types: nil)
+        request_seam_object(
+          :post,
+          "/webhooks/create",
+          Seam::Webhook,
+          "webhook",
+          body: {url: url, event_types: event_types}.compact
+        )
+      end
+
+      def delete(webhook_id:)
+        request_seam(
+          :post,
+          "/webhooks/delete",
+          body: {webhook_id: webhook_id}.compact
+        )
+
+        nil
+      end
+
+      def get(webhook_id:)
+        request_seam_object(
+          :post,
+          "/webhooks/get",
+          Seam::Webhook,
+          "webhook",
+          body: {webhook_id: webhook_id}.compact
+        )
+      end
+
+      def list
+        request_seam_object(
+          :post,
+          "/webhooks/list",
+          Seam::Webhook,
+          "webhooks",
+          body: {}.compact
+        )
+      end
+
+      def update(event_types:, webhook_id:)
+        request_seam(
+          :post,
+          "/webhooks/update",
+          body: {event_types: event_types, webhook_id: webhook_id}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/workspaces.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Workspaces < BaseClient
+      def create(connect_partner_name:, name:, is_sandbox: nil, webview_logo_shape: nil, webview_primary_button_color: nil)
+        request_seam_object(
+          :post,
+          "/workspaces/create",
+          Seam::Workspace,
+          "workspace",
+          body: {connect_partner_name: connect_partner_name, name: name, is_sandbox: is_sandbox, webview_logo_shape: webview_logo_shape, webview_primary_button_color: webview_primary_button_color}.compact
+        )
+      end
+
+      def get
+        request_seam_object(
+          :post,
+          "/workspaces/get",
+          Seam::Workspace,
+          "workspace",
+          body: {}.compact
+        )
+      end
+
+      def list
+        request_seam_object(
+          :post,
+          "/workspaces/list",
+          Seam::Workspace,
+          "workspaces",
+          body: {}.compact
+        )
+      end
+
+      def reset_sandbox(wait_for_action_attempt: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/workspaces/reset_sandbox",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {}.compact
+        )
+
+        action_attempt.decide_and_wait(wait_for_action_attempt)
+        action_attempt
+      end
+    end
+  end
+end

data/lib/seam/logger.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Seam
+  class Logger
+    def self.info(message)
+      logger = ::Logger.new($stdout)
+      logger.info(message)
+    end
+  end
+end

data/lib/seam/lts_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Seam
+  LTS_VERSION = "1.0.0"
+end

data/lib/seam/request.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "http"
+
+module Seam
+  class Request
+    attr_reader :base_uri, :api_key, :debug
+
+    class Error < StandardError
+      attr_reader :status, :response
+
+      def initialize(message, status, response)
+        super(message)
+        @status = status
+        @response = response
+      end
+    end
+
+    def initialize(api_key:, base_uri:, debug: false)
+      @api_key = api_key
+      @base_uri = base_uri
+      @debug = debug
+    end
+
+    def perform(method, uri, config = {})
+      Logger.info("Request: #{method} #{uri} #{config}") if debug
+
+      config[:body] = config[:body].to_json if config[:body]
+
+      response = HTTP.request(
+        method,
+        build_url(uri),
+        {headers: headers}.merge(config)
+      )
+
+      return response.parse if response.status.success?
+
+      handle_error_response(response, method, uri)
+    end
+
+    protected
+
+    def handle_error_response(response, method, uri)
+      msg = "Api Error #{response.status.code} #{method} #{uri}"
+      code = response.status.code
+
+      if code >= 400 && code < 500 && (err = response.parse["error"])
+        msg = "Api Error #{err["type"]}\nrequest_id: #{err["request_id"]}\n#{err["message"]}"
+      end
+
+      raise Error.new(msg, code, response)
+    end
+
+    def build_url(uri)
+      "#{base_uri}#{uri}"
+    end
+
+    def headers
+      {
+        "User-Agent" => user_agent,
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{api_key}",
+        :"seam-sdk-name" => "seamapi/ruby",
+        :"seam-sdk-version" => Seam::VERSION,
+        :"seam-lts-version" => Seam::LTS_VERSION
+      }
+    end
+
+    def user_agent
+      "seam-ruby/#{Seam::VERSION}"
+    end
+  end
+end

data/lib/seam/resources/access_code.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Seam
+  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::ResourceErrorsSupport
+    include Seam::ResourceWarningsSupport
+  end
+end

data/lib/seam/resources/acs_access_group.rb

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

data/lib/seam/resources/acs_credential.rb

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

data/lib/seam/resources/acs_credential_pool.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  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

data/lib/seam/resources/acs_credential_provisioning_automation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  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

data/lib/seam/resources/acs_entrance.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  class AcsEntrance < BaseResource
+    attr_accessor :acs_entrance_id, :acs_system_id, :display_name, :latch_metadata, :visionline_metadata
+
+    date_accessor :created_at
+  end
+end

data/lib/seam/resources/acs_system.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  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, :external_type, :external_type_display_name, :image_alt_text, :image_url, :name, :system_type, :system_type_display_name, :workspace_id
+
+    date_accessor :created_at
+  end
+end

data/lib/seam/resources/acs_user.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  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_suspended, :phone_number, :user_identity_email_address, :user_identity_full_name, :user_identity_id, :user_identity_phone_number, :workspace_id
+
+    date_accessor :created_at
+  end
+end

data/lib/seam/resources/action_attempt.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Seam
+  class ActionAttempt < BaseResource
+    attr_accessor :action_attempt_id, :action_type, :error, :result, :status
+
+    def decide_and_wait(wait_for_action_attempt)
+      wait_decision = wait_for_action_attempt.nil? ? @client.wait_for_action_attempt : wait_for_action_attempt
+
+      if wait_decision == true
+        wait_until_finished
+      elsif wait_decision.is_a?(Hash)
+        wait_until_finished(timeout: wait_decision[:timeout], polling_interval: wait_decision[:polling_interval])
+      end
+    end
+
+    def wait_until_finished(timeout: 5.0, polling_interval: 0.5)
+      time_waiting = 0.0
+
+      while @status == "pending"
+        sleep(polling_interval)
+        time_waiting += polling_interval
+
+        raise "Timed out waiting for action attempt to be finished" if time_waiting > timeout
+
+        update!
+
+        raise "Action Attempt failed: #{error["message"]}" if @status == "failed"
+      end
+
+      self
+    end
+
+    def update!
+      response = @client.request_seam(
+        :post,
+        "/action_attempts/get",
+        body: {
+          action_attempt_id: action_attempt_id
+        }
+      )
+
+      update_from_response(response["action_attempt"])
+    end
+  end
+end

data/lib/seam/resources/base_resource.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Seam
+  class BaseResource
+    attr_accessor :data, :client
+
+    def initialize(data, client = nil)
+      @data = data
+      @client = client
+
+      @data.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    def update_from_response(data)
+      @data = data
+      @data.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    def self.load_from_response(data, client = nil)
+      if data.is_a?(Array)
+        data.map { |d| new(d, client) }
+      else
+        new(data, client)
+      end
+    end
+
+    def inspect
+      "<#{self.class.name}:#{"0x00%x" % (object_id << 1)}\n" + # rubocop:disable Style/StringConcatenation, Style/FormatString
+        instance_variables
+          .map { |k| k.to_s.sub("@", "") }
+          .filter { |k| k != "data" and k != "client" and respond_to? k }
+          .map { |k| "  #{k}=#{send(k).inspect}" }
+          .join("\n") + ">"
+    end
+
+    def self.date_accessor(*attrs)
+      attrs.each do |attr|
+        define_method(attr) do
+          value = instance_variable_get(:"@#{attr}")
+
+          raise "No value for #{attr} set" if value.nil?
+
+          parse_datetime(value)
+        end
+      end
+    end
+
+    protected
+
+    def parse_datetime(value)
+      Time.parse(value)
+    end
+  end
+end

data/lib/seam/resources/client_session.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  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

data/lib/seam/resources/climate_setting_schedule.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Seam
+  class ClimateSettingSchedule < BaseResource
+    attr_accessor :automatic_cooling_enabled, :automatic_heating_enabled, :climate_setting_schedule_id, :cooling_set_point_celsius, :cooling_set_point_fahrenheit, :device_id, :heating_set_point_celsius, :heating_set_point_fahrenheit, :hvac_mode_setting, :manual_override_allowed, :name, :schedule_ends_at, :schedule_starts_at, :schedule_type
+
+    date_accessor :created_at
+
+    include Seam::ResourceErrorsSupport
+  end
+end

data/lib/seam/resources/connect_webview.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Seam
+  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

data/lib/seam/resources/connected_account.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Seam
+  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::ResourceErrorsSupport
+    include Seam::ResourceWarningsSupport
+  end
+end