seam 2.0.0a1 → 2.0.0a2

data/lib/seam/clients/noise_sensors_simulate.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class NoiseSensorsSimulate < BaseClient
+      def trigger_noise_threshold(device_id:)
+        request_seam(
+          :post,
+          "/noise_sensors/simulate/trigger_noise_threshold",
+          body: {device_id: device_id}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/phones.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Phones < BaseClient
+      def simulate
+        @simulate ||= Seam::Clients::PhonesSimulate.new(self)
+      end
+
+      def deactivate(device_id:)
+        request_seam(
+          :post,
+          "/phones/deactivate",
+          body: {device_id: device_id}.compact
+        )
+
+        nil
+      end
+
+      def list(owner_user_identity_id: nil)
+        request_seam_object(
+          :post,
+          "/phones/list",
+          Seam::Phone,
+          "phones",
+          body: {owner_user_identity_id: owner_user_identity_id}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/phones_simulate.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class PhonesSimulate < BaseClient
+      def create_sandbox_phone(user_identity_id:, assa_abloy_metadata: nil, custom_sdk_installation_id: nil, phone_metadata: nil)
+        request_seam_object(
+          :post,
+          "/phones/simulate/create_sandbox_phone",
+          Seam::Phone,
+          "phone",
+          body: {user_identity_id: user_identity_id, assa_abloy_metadata: assa_abloy_metadata, custom_sdk_installation_id: custom_sdk_installation_id, phone_metadata: phone_metadata}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/thermostats.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Thermostats < BaseClient
+      def climate_setting_schedules
+        @climate_setting_schedules ||= Seam::Clients::ThermostatsClimateSettingSchedules.new(self)
+      end
+
+      def cool(device_id:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, sync: nil, wait_for_action_attempt: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/thermostats/cool",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {device_id: device_id, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, sync: sync}.compact
+        )
+
+        action_attempt.decide_and_wait(wait_for_action_attempt)
+        action_attempt
+      end
+
+      def get(device_id: nil, name: nil)
+        request_seam_object(
+          :post,
+          "/thermostats/get",
+          Seam::Device,
+          "thermostat",
+          body: {device_id: device_id, name: name}.compact
+        )
+      end
+
+      def heat(device_id:, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, sync: nil, wait_for_action_attempt: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/thermostats/heat",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {device_id: device_id, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, sync: sync}.compact
+        )
+
+        action_attempt.decide_and_wait(wait_for_action_attempt)
+        action_attempt
+      end
+
+      def heat_cool(device_id:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, sync: nil, wait_for_action_attempt: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/thermostats/heat_cool",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {device_id: device_id, 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, sync: sync}.compact
+        )
+
+        action_attempt.decide_and_wait(wait_for_action_attempt)
+        action_attempt
+      end
+
+      def list(connect_webview_id: nil, connected_account_id: nil, connected_account_ids: nil, created_before: nil, custom_metadata_has: nil, device_ids: nil, device_types: nil, exclude_if: nil, include_if: nil, limit: nil, manufacturer: nil, user_identifier_key: nil)
+        request_seam_object(
+          :post,
+          "/thermostats/list",
+          Seam::Device,
+          "thermostats",
+          body: {connect_webview_id: connect_webview_id, connected_account_id: connected_account_id, connected_account_ids: connected_account_ids, created_before: created_before, custom_metadata_has: custom_metadata_has, device_ids: device_ids, device_types: device_types, exclude_if: exclude_if, include_if: include_if, limit: limit, manufacturer: manufacturer, user_identifier_key: user_identifier_key}.compact
+        )
+      end
+
+      def off(device_id:, sync: nil, wait_for_action_attempt: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/thermostats/off",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {device_id: device_id, sync: sync}.compact
+        )
+
+        action_attempt.decide_and_wait(wait_for_action_attempt)
+        action_attempt
+      end
+
+      def set_fan_mode(device_id:, fan_mode: nil, fan_mode_setting: nil, sync: nil, wait_for_action_attempt: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/thermostats/set_fan_mode",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {device_id: device_id, fan_mode: fan_mode, fan_mode_setting: fan_mode_setting, sync: sync}.compact
+        )
+
+        action_attempt.decide_and_wait(wait_for_action_attempt)
+        action_attempt
+      end
+
+      def update(default_climate_setting:, device_id:)
+        request_seam(
+          :post,
+          "/thermostats/update",
+          body: {default_climate_setting: default_climate_setting, device_id: device_id}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

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