Class: Seam::Resources::UnmanagedAccessMethod

Inherits:
BaseResource
  • Object
show all
Defined in:
lib/seam/resources/unmanaged_access_method.rb

Overview

Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.

Defined Under Namespace

Classes: Errors, PendingMutations, Warnings

Instance Attribute Summary collapse

Attributes inherited from BaseResource

#client, #data

Instance Method Summary collapse

Methods inherited from BaseResource

#[], date_accessor, #initialize, #inspect, load_from_response, resource_accessor, resource_accessors, resource_list_accessor, resource_list_accessors, #update_from_response

Constructor Details

This class inherits a constructor from Seam::Resources::BaseResource

Instance Attribute Details

#access_method_id ⇒ String

ID of the access method.

Returns:

  • (String) 


82
83
84
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 82

def access_method_id
  @access_method_id
end

#code ⇒ String?

The actual PIN code for code access methods.

Returns:

  • (String, nil) 


85
86
87
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 85

def code
  @code
end

#display_name ⇒ String

Display name of the access method.

Returns:

  • (String) 


88
89
90
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 88

def display_name
  @display_name
end

#is_assignment_required ⇒ Boolean?

Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.

Returns:

  • (Boolean, nil) 


91
92
93
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 91

def is_assignment_required
  @is_assignment_required
end

#is_encoding_required ⇒ Boolean?

Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.

Returns:

  • (Boolean, nil) 


94
95
96
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 94

def is_encoding_required
  @is_encoding_required
end

#is_issued ⇒ Boolean

Indicates whether the access method has been issued.

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 97

def is_issued
  @is_issued
end

#is_ready_for_assignment ⇒ Boolean?

Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.

Returns:

  • (Boolean, nil) 


100
101
102
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 100

def is_ready_for_assignment
  @is_ready_for_assignment
end

#is_ready_for_encoding ⇒ Boolean?

Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.

Returns:

  • (Boolean, nil) 


103
104
105
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 103

def is_ready_for_encoding
  @is_ready_for_encoding
end

#mode ⇒ String

Access method mode. Supported values: code, card, mobile_key, cloud_key.

Returns:

  • (String) 


106
107
108
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 106

def mode
  @mode
end

#workspace_id ⇒ String

ID of the Seam workspace associated with the access method.

Returns:

  • (String) 


109
110
111
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 109

def workspace_id
  @workspace_id
end

Instance Method Details

#created_at ⇒ Time

Date and time at which the access method was created.

Returns:

  • (Time) 


113
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 113

date_accessor :created_at

#errors ⇒ Array<Errors>

Errors associated with the access method.

Returns:



73
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 73

resource_list_accessor :errors, Errors

#issued_at ⇒ Time?

Date and time at which the access method was issued.

Returns:

  • (Time, nil) 


117
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 117

date_accessor :issued_at

#pending_mutations ⇒ Array<PendingMutations>

Pending mutations for the access method. Indicates operations that are in progress.

Returns:



76
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 76

resource_list_accessor :pending_mutations, PendingMutations

#warnings ⇒ Array<Warnings>

Warnings associated with the access method.

Returns:



79
 
# File 'lib/seam/resources/unmanaged_access_method.rb', line 79

resource_list_accessor :warnings, Warnings