seam 1.1.3 → 2.0.0a2

data/lib/seam/clients/access_codes.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AccessCodes < BaseClient
+      def simulate
+        @simulate ||= Seam::Clients::AccessCodesSimulate.new(self)
+      end
+
+      def unmanaged
+        @unmanaged ||= Seam::Clients::AccessCodesUnmanaged.new(self)
+      end
+
+      def create(device_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, common_code_key: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, starts_at: nil, sync: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
+        request_seam_object(
+          :post,
+          "/access_codes/create",
+          Seam::AccessCode,
+          "access_code",
+          body: {device_id: device_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, common_code_key: common_code_key, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, starts_at: starts_at, sync: sync, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact
+        )
+      end
+
+      def create_multiple(device_ids:, allow_external_modification: nil, attempt_for_offline_device: nil, behavior_when_code_cannot_be_shared: nil, code: nil, ends_at: nil, is_external_modification_allowed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
+        request_seam_object(
+          :post,
+          "/access_codes/create_multiple",
+          Seam::AccessCode,
+          "access_codes",
+          body: {device_ids: device_ids, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, behavior_when_code_cannot_be_shared: behavior_when_code_cannot_be_shared, code: code, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact
+        )
+      end
+
+      def delete(access_code_id:, device_id: nil, sync: nil)
+        request_seam(
+          :post,
+          "/access_codes/delete",
+          body: {access_code_id: access_code_id, device_id: device_id, sync: sync}.compact
+        )
+
+        nil
+      end
+
+      def generate_code(device_id:)
+        request_seam_object(
+          :post,
+          "/access_codes/generate_code",
+          Seam::AccessCode,
+          "generated_code",
+          body: {device_id: device_id}.compact
+        )
+      end
+
+      def get(access_code_id: nil, code: nil, device_id: nil)
+        request_seam_object(
+          :post,
+          "/access_codes/get",
+          Seam::AccessCode,
+          "access_code",
+          body: {access_code_id: access_code_id, code: code, device_id: device_id}.compact
+        )
+      end
+
+      def list(access_code_ids: nil, device_id: nil, user_identifier_key: nil)
+        request_seam_object(
+          :post,
+          "/access_codes/list",
+          Seam::AccessCode,
+          "access_codes",
+          body: {access_code_ids: access_code_ids, device_id: device_id, user_identifier_key: user_identifier_key}.compact
+        )
+      end
+
+      def pull_backup_access_code(access_code_id:)
+        request_seam_object(
+          :post,
+          "/access_codes/pull_backup_access_code",
+          Seam::AccessCode,
+          "backup_access_code",
+          body: {access_code_id: access_code_id}.compact
+        )
+      end
+
+      def update(access_code_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, device_id: nil, ends_at: nil, is_external_modification_allowed: nil, is_managed: nil, is_offline_access_code: nil, is_one_time_use: nil, max_time_rounding: nil, name: nil, prefer_native_scheduling: nil, starts_at: nil, sync: nil, type: nil, use_backup_access_code_pool: nil, use_offline_access_code: nil)
+        request_seam(
+          :post,
+          "/access_codes/update",
+          body: {access_code_id: access_code_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, device_id: device_id, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_managed: is_managed, is_offline_access_code: is_offline_access_code, is_one_time_use: is_one_time_use, max_time_rounding: max_time_rounding, name: name, prefer_native_scheduling: prefer_native_scheduling, starts_at: starts_at, sync: sync, type: type, use_backup_access_code_pool: use_backup_access_code_pool, use_offline_access_code: use_offline_access_code}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/access_codes_simulate.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AccessCodesSimulate < BaseClient
+      def create_unmanaged_access_code(code:, device_id:, name:)
+        request_seam_object(
+          :post,
+          "/access_codes/simulate/create_unmanaged_access_code",
+          Seam::UnmanagedAccessCode,
+          "access_code",
+          body: {code: code, device_id: device_id, name: name}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/access_codes_unmanaged.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AccessCodesUnmanaged < BaseClient
+      def convert_to_managed(access_code_id:, allow_external_modification: nil, force: nil, is_external_modification_allowed: nil, sync: nil)
+        request_seam(
+          :post,
+          "/access_codes/unmanaged/convert_to_managed",
+          body: {access_code_id: access_code_id, allow_external_modification: allow_external_modification, force: force, is_external_modification_allowed: is_external_modification_allowed, sync: sync}.compact
+        )
+
+        nil
+      end
+
+      def delete(access_code_id:, sync: nil)
+        request_seam(
+          :post,
+          "/access_codes/unmanaged/delete",
+          body: {access_code_id: access_code_id, sync: sync}.compact
+        )
+
+        nil
+      end
+
+      def get(access_code_id: nil, code: nil, device_id: nil)
+        request_seam_object(
+          :post,
+          "/access_codes/unmanaged/get",
+          Seam::UnmanagedAccessCode,
+          "access_code",
+          body: {access_code_id: access_code_id, code: code, device_id: device_id}.compact
+        )
+      end
+
+      def list(device_id:, user_identifier_key: nil)
+        request_seam_object(
+          :post,
+          "/access_codes/unmanaged/list",
+          Seam::UnmanagedAccessCode,
+          "access_codes",
+          body: {device_id: device_id, user_identifier_key: user_identifier_key}.compact
+        )
+      end
+
+      def update(access_code_id:, is_managed:, allow_external_modification: nil, force: nil, is_external_modification_allowed: nil)
+        request_seam(
+          :post,
+          "/access_codes/unmanaged/update",
+          body: {access_code_id: access_code_id, is_managed: is_managed, allow_external_modification: allow_external_modification, force: force, is_external_modification_allowed: is_external_modification_allowed}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/acs.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class Acs < BaseClient
+      def access_groups
+        @access_groups ||= Seam::Clients::AcsAccessGroups.new(self)
+      end
+
+      def credential_pools
+        @credential_pools ||= Seam::Clients::AcsCredentialPools.new(self)
+      end
+
+      def credential_provisioning_automations
+        @credential_provisioning_automations ||= Seam::Clients::AcsCredentialProvisioningAutomations.new(self)
+      end
+
+      def credentials
+        @credentials ||= Seam::Clients::AcsCredentials.new(self)
+      end
+
+      def entrances
+        @entrances ||= Seam::Clients::AcsEntrances.new(self)
+      end
+
+      def systems
+        @systems ||= Seam::Clients::AcsSystems.new(self)
+      end
+
+      def users
+        @users ||= Seam::Clients::AcsUsers.new(self)
+      end
+    end
+  end
+end

data/lib/seam/clients/acs_access_groups.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsAccessGroups < BaseClient
+      def add_user(acs_access_group_id:, acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/access_groups/add_user",
+          body: {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def get(acs_access_group_id:)
+        request_seam_object(
+          :post,
+          "/acs/access_groups/get",
+          Seam::AcsAccessGroup,
+          "acs_access_group",
+          body: {acs_access_group_id: acs_access_group_id}.compact
+        )
+      end
+
+      def list(acs_system_id: nil, acs_user_id: nil)
+        request_seam_object(
+          :post,
+          "/acs/access_groups/list",
+          Seam::AcsAccessGroup,
+          "acs_access_groups",
+          body: {acs_system_id: acs_system_id, acs_user_id: acs_user_id}.compact
+        )
+      end
+
+      def list_users(acs_access_group_id:)
+        request_seam_object(
+          :post,
+          "/acs/access_groups/list_users",
+          Seam::AcsUser,
+          "acs_users",
+          body: {acs_access_group_id: acs_access_group_id}.compact
+        )
+      end
+
+      def remove_user(acs_access_group_id:, acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/access_groups/remove_user",
+          body: {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/acs_credential_pools.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsCredentialPools < BaseClient
+      def list(acs_system_id:)
+        request_seam_object(
+          :post,
+          "/acs/credential_pools/list",
+          Seam::AcsCredentialPool,
+          "acs_credential_pools",
+          body: {acs_system_id: acs_system_id}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/acs_credential_provisioning_automations.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsCredentialProvisioningAutomations < BaseClient
+      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_object(
+          :post,
+          "/acs/credential_provisioning_automations/launch",
+          Seam::AcsCredentialProvisioningAutomation,
+          "acs_credential_provisioning_automation",
+          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
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/acs_credentials.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsCredentials < BaseClient
+      def assign(acs_credential_id:, acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/credentials/assign",
+          body: {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def create(access_method:, acs_user_id:, allowed_acs_entrance_ids: nil, code: nil, credential_manager_acs_system_id: nil, ends_at: nil, is_multi_phone_sync_credential: nil, starts_at: nil, visionline_metadata: nil)
+        request_seam_object(
+          :post,
+          "/acs/credentials/create",
+          Seam::AcsCredential,
+          "acs_credential",
+          body: {access_method: access_method, acs_user_id: acs_user_id, allowed_acs_entrance_ids: allowed_acs_entrance_ids, code: code, credential_manager_acs_system_id: credential_manager_acs_system_id, ends_at: ends_at, is_multi_phone_sync_credential: is_multi_phone_sync_credential, starts_at: starts_at, visionline_metadata: visionline_metadata}.compact
+        )
+      end
+
+      def delete(acs_credential_id:)
+        request_seam(
+          :post,
+          "/acs/credentials/delete",
+          body: {acs_credential_id: acs_credential_id}.compact
+        )
+
+        nil
+      end
+
+      def get(acs_credential_id:)
+        request_seam_object(
+          :post,
+          "/acs/credentials/get",
+          Seam::AcsCredential,
+          "acs_credential",
+          body: {acs_credential_id: acs_credential_id}.compact
+        )
+      end
+
+      def list(acs_user_id: nil, acs_system_id: nil, user_identity_id: nil, is_multi_phone_sync_credential: nil)
+        request_seam_object(
+          :post,
+          "/acs/credentials/list",
+          Seam::AcsCredential,
+          "acs_credentials",
+          body: {acs_user_id: acs_user_id, acs_system_id: acs_system_id, user_identity_id: user_identity_id, is_multi_phone_sync_credential: is_multi_phone_sync_credential}.compact
+        )
+      end
+
+      def unassign(acs_credential_id:, acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/credentials/unassign",
+          body: {acs_credential_id: acs_credential_id, acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def update(acs_credential_id:, code:)
+        request_seam(
+          :post,
+          "/acs/credentials/update",
+          body: {acs_credential_id: acs_credential_id, code: code}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/acs_entrances.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsEntrances < BaseClient
+      def get(acs_entrance_id:)
+        request_seam_object(
+          :post,
+          "/acs/entrances/get",
+          Seam::AcsEntrance,
+          "acs_entrance",
+          body: {acs_entrance_id: acs_entrance_id}.compact
+        )
+      end
+
+      def grant_access(acs_entrance_id:, acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/entrances/grant_access",
+          body: {acs_entrance_id: acs_entrance_id, acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def list(acs_credential_id: nil, acs_system_id: nil)
+        request_seam_object(
+          :post,
+          "/acs/entrances/list",
+          Seam::AcsEntrance,
+          "acs_entrances",
+          body: {acs_credential_id: acs_credential_id, acs_system_id: acs_system_id}.compact
+        )
+      end
+
+      def list_credentials_with_access(acs_entrance_id:, include_if: nil)
+        request_seam_object(
+          :post,
+          "/acs/entrances/list_credentials_with_access",
+          Seam::AcsCredential,
+          "acs_credentials",
+          body: {acs_entrance_id: acs_entrance_id, include_if: include_if}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/acs_systems.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsSystems < BaseClient
+      def get(acs_system_id:)
+        request_seam_object(
+          :post,
+          "/acs/systems/get",
+          Seam::AcsSystem,
+          "acs_system",
+          body: {acs_system_id: acs_system_id}.compact
+        )
+      end
+
+      def list(connected_account_id: nil)
+        request_seam_object(
+          :post,
+          "/acs/systems/list",
+          Seam::AcsSystem,
+          "acs_systems",
+          body: {connected_account_id: connected_account_id}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/acs_users.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class AcsUsers < BaseClient
+      def add_to_access_group(acs_access_group_id:, acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/users/add_to_access_group",
+          body: {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def create(acs_system_id:, access_schedule: nil, acs_access_group_ids: nil, email: nil, email_address: nil, full_name: nil, phone_number: nil, user_identity_id: nil)
+        request_seam_object(
+          :post,
+          "/acs/users/create",
+          Seam::AcsUser,
+          "acs_user",
+          body: {acs_system_id: acs_system_id, access_schedule: access_schedule, acs_access_group_ids: acs_access_group_ids, email: email, email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_id: user_identity_id}.compact
+        )
+      end
+
+      def delete(acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/users/delete",
+          body: {acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def get(acs_user_id:)
+        request_seam_object(
+          :post,
+          "/acs/users/get",
+          Seam::AcsUser,
+          "acs_user",
+          body: {acs_user_id: acs_user_id}.compact
+        )
+      end
+
+      def list(acs_system_id: nil, user_identity_email_address: nil, user_identity_id: nil, user_identity_phone_number: nil)
+        request_seam_object(
+          :post,
+          "/acs/users/list",
+          Seam::AcsUser,
+          "acs_users",
+          body: {acs_system_id: acs_system_id, user_identity_email_address: user_identity_email_address, user_identity_id: user_identity_id, user_identity_phone_number: user_identity_phone_number}.compact
+        )
+      end
+
+      def list_accessible_entrances(acs_user_id:)
+        request_seam_object(
+          :post,
+          "/acs/users/list_accessible_entrances",
+          Seam::AcsEntrance,
+          "acs_entrances",
+          body: {acs_user_id: acs_user_id}.compact
+        )
+      end
+
+      def remove_from_access_group(acs_access_group_id:, acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/users/remove_from_access_group",
+          body: {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def revoke_access_to_all_entrances(acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/users/revoke_access_to_all_entrances",
+          body: {acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def suspend(acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/users/suspend",
+          body: {acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def unsuspend(acs_user_id:)
+        request_seam(
+          :post,
+          "/acs/users/unsuspend",
+          body: {acs_user_id: acs_user_id}.compact
+        )
+
+        nil
+      end
+
+      def update(acs_user_id:, access_schedule: nil, email: nil, email_address: nil, full_name: nil, hid_acs_system_id: nil, phone_number: nil)
+        request_seam(
+          :post,
+          "/acs/users/update",
+          body: {acs_user_id: acs_user_id, access_schedule: access_schedule, email: email, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number}.compact
+        )
+
+        nil
+      end
+    end
+  end
+end

data/lib/seam/clients/action_attempts.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class ActionAttempts < BaseClient
+      def get(action_attempt_id:, wait_for_action_attempt: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/action_attempts/get",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {action_attempt_id: action_attempt_id}.compact
+        )
+
+        action_attempt.decide_and_wait(wait_for_action_attempt)
+        action_attempt
+      end
+
+      def list(action_attempt_ids:)
+        request_seam_object(
+          :post,
+          "/action_attempts/list",
+          Seam::ActionAttempt,
+          "action_attempts",
+          body: {action_attempt_ids: action_attempt_ids}.compact
+        )
+      end
+    end
+  end
+end

data/lib/seam/clients/base_client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class BaseClient
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def request_seam_object(*attrs)
+        client.request_seam_object(*attrs)
+      end
+
+      def request_seam(*attrs)
+        client.request_seam(*attrs)
+      end
+    end
+  end
+end