feat: Add appearance and allow_external_modification to access code API + add unmanaged access code API (#65)

* Add appearance and allow_external_modification to access code API + add unmanaged access code API

* Fix UnmanagedAccessCode's attributes

* Rename allow_external_modification to is_external_modification_allowed

Author: andrii-balitskyi

lib/seam/client.rb

@@ -36,6 +36,10 @@ def access_codes
       @access_codes ||= Seam::Clients::AccessCodes.new(self)
     end
 
+    def unmanaged_access_codes
+      @unmanaged_access_codes ||= Seam::Clients::UnmanagedAccessCodes.new(self)
+    end
+
     def connect_webviews
       @connect_webviews ||= Seam::Clients::ConnectWebviews.new(self)
     end

lib/seam/clients/access_codes.rb

@@ -25,14 +25,14 @@ def list(device_or_id = nil, access_code_ids: nil)
         )
       end
 
-      def create(device_id: nil, name: nil, code: nil, starts_at: nil, ends_at: nil, use_backup_access_code_pool: nil)
+      def create(device_id: nil, name: nil, code: nil, starts_at: nil, ends_at: nil, use_backup_access_code_pool: nil, allow_external_modification: nil)
         action_attempt = request_seam_object(
           :post,
           "/access_codes/create",
           Seam::ActionAttempt,
           "action_attempt",
           body: {device_id: device_id, code: code, starts_at: starts_at, ends_at: ends_at, name: name,
-                 use_backup_access_code_pool: use_backup_access_code_pool}.compact
+                 use_backup_access_code_pool: use_backup_access_code_pool, allow_external_modification: allow_external_modification}.compact
         )
         action_attempt.wait_until_finished
         # TODO: check if failed
@@ -51,7 +51,7 @@ def delete(access_code_id)
         action_attempt
       end
 
-      def update(access_code_id: nil, name: nil, code: nil, starts_at: nil, ends_at: nil, type: nil)
+      def update(access_code_id: nil, name: nil, code: nil, starts_at: nil, ends_at: nil, type: nil, allow_external_modification: nil)
         action_attempt = request_seam_object(
           :post,
           "/access_codes/update",
@@ -63,7 +63,8 @@ def update(access_code_id: nil, name: nil, code: nil, starts_at: nil, ends_at: n
             code: code,
             starts_at: starts_at,
             ends_at: ends_at,
-            type: type
+            type: type,
+            allow_external_modification: allow_external_modification
           }.compact
         )
         action_attempt.wait_until_finished

lib/seam/clients/unmanaged_access_codes.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Seam
+  module Clients
+    class UnmanagedAccessCodes < BaseClient
+      def get(access_code_id = nil, device_id: nil, code: nil)
+        request_seam_object(
+          :get,
+          "/access_codes/unmanaged/get",
+          Seam::UnmanagedAccessCode,
+          "access_code",
+          params: {
+            device_id: device_id,
+            access_code_id: access_code_id,
+            code: code
+          }.compact
+        )
+      end
+
+      def list(device_id)
+        request_seam_object(
+          :get,
+          "/access_codes/unmanaged/list",
+          Seam::UnmanagedAccessCode,
+          "access_codes",
+          params: {device_id: device_id}
+        )
+      end
+
+      def convert_to_managed(access_code_id, allow_external_modification: nil)
+        action_attempt = request_seam_object(
+          :post,
+          "/access_codes/unmanaged/convert_to_managed",
+          Seam::ActionAttempt,
+          "action_attempt",
+          body: {
+            access_code_id: access_code_id,
+            allow_external_modification: allow_external_modification
+          }.compact
+        )
+        action_attempt.wait_until_finished
+        action_attempt
+      end
+    end
+  end
+end

lib/seam/resources/access_code.rb

@@ -2,7 +2,7 @@
 
 module Seam
   class AccessCode < BaseResource
-    attr_reader :access_code_id, :name, :type, :code, :is_managed, :status, :device_id, :is_scheduled_on_device, :is_waiting_for_code_assignment, :pulled_backup_access_code_id, :is_backup_access_code_available, :is_backup
+    attr_reader :access_code_id, :name, :type, :code, :is_managed, :status, :device_id, :is_scheduled_on_device, :is_waiting_for_code_assignment, :pulled_backup_access_code_id, :is_backup_access_code_available, :is_backup, :appearance, :is_external_modification_allowed
 
     date_accessor :starts_at, :ends_at, :created_at
 

lib/seam/resources/unmanaged_access_code.rb

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

lib/seamapi.rb

@@ -12,6 +12,7 @@
 require_relative "seam/clients/connect_webviews"
 require_relative "seam/clients/connected_accounts"
 require_relative "seam/clients/access_codes"
+require_relative "seam/clients/unmanaged_access_codes"
 require_relative "seam/clients/action_attempts"
 require_relative "seam/clients/events"
 require_relative "seam/resources/base_resource"
@@ -23,6 +24,7 @@
 require_relative "seam/resources/unmanaged_device"
 require_relative "seam/resources/device_provider"
 require_relative "seam/resources/access_code"
+require_relative "seam/resources/unmanaged_access_code"
 require_relative "seam/resources/action_attempt"
 require_relative "seam/resources/connect_webview"
 require_relative "seam/resources/connected_account"

spec/clients/unmanaged_access_codes_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+RSpec.describe Seam::Clients::UnmanagedAccessCodes do
+  let(:client) { Seam::Client.new(api_key: "some_api_key") }
+
+  describe "#get" do
+    let(:access_code_id) { "123" }
+    let(:unmanaged_access_code_hash) { {access_code_id: access_code_id} }
+
+    before do
+      stub_seam_request(
+        :get, "/access_codes/unmanaged/get", {access_code: unmanaged_access_code_hash}
+      ).with(
+        query: {access_code_id: access_code_id}
+      )
+    end
+
+    let(:result) { client.unmanaged_access_codes.get(access_code_id) }
+
+    it "returns an unmanaged Access Code" do
+      expect(result).to be_a(Seam::UnmanagedAccessCode)
+    end
+  end
+
+  describe "#list" do
+    let(:device_id) { "456" }
+    let(:unmanaged_access_code_hash) { {access_code_id: "123", device_id: device_id} }
+
+    before do
+      stub_seam_request(:get, "/access_codes/unmanaged/list", {access_codes: [unmanaged_access_code_hash]}).with(
+        query: {device_id: device_id}
+      )
+    end
+
+    let(:unmanaged_access_codes) { client.unmanaged_access_codes.list(device_id) }
+
+    it "returns a list of unmanaged Access Codes" do
+      expect(unmanaged_access_codes).to be_a(Array)
+      expect(unmanaged_access_codes.first).to be_a(Seam::UnmanagedAccessCode)
+      expect(unmanaged_access_codes.first.access_code_id).to be_a(String)
+    end
+  end
+
+  describe "#convert_to_managed" do
+    let(:access_code_id) { "access_code_1234" }
+    let(:action_attempt_hash) { {action_attempt_id: "1234", status: "pending"} }
+
+    before do
+      stub_seam_request(
+        :post, "/access_codes/unmanaged/convert_to_managed", {action_attempt: action_attempt_hash}
+      ).with do |req|
+        req.body.source == {access_code_id: access_code_id}.to_json
+      end
+
+      stub_seam_request(
+        :get,
+        "/action_attempts/get",
+        {
+          action_attempt: {
+            status: "success"
+          }
+        }
+      ).with(query: {action_attempt_id: action_attempt_hash[:action_attempt_id]})
+    end
+
+    let(:result) { client.unmanaged_access_codes.convert_to_managed(access_code_id) }
+
+    it "returns an Action Attempt" do
+      expect(result).to be_a(Seam::ActionAttempt)
+    end
+  end
+end