Class: Seam::Resources::ActionAttempt::AssignCredential::Result

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

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

#[], aliased_accessor, attribute_aliases, date_accessor, discriminated_by, #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) 


1027
1028
1029
 
# File 'lib/seam/resources/action_attempt.rb', line 1027

def access_method_id
  @access_method_id
end

#client_session_token ⇒ String?

Token of the client session associated with the access method.

Returns:

  • (String, nil) 


1030
1031
1032
 
# File 'lib/seam/resources/action_attempt.rb', line 1030

def client_session_token
  @client_session_token
end

#code ⇒ String?

The actual PIN code for code access methods.

Returns:

  • (String, nil) 


1033
1034
1035
 
# File 'lib/seam/resources/action_attempt.rb', line 1033

def code
  @code
end

#customization_profile_id ⇒ String?

ID of the customization profile associated with the access method.

Returns:

  • (String, nil) 


1036
1037
1038
 
# File 'lib/seam/resources/action_attempt.rb', line 1036

def customization_profile_id
  @customization_profile_id
end

#display_name ⇒ String

Display name of the access method.

Returns:

  • (String) 


1039
1040
1041
 
# File 'lib/seam/resources/action_attempt.rb', line 1039

def display_name
  @display_name
end

#display_status ⇒ String

Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example Awaiting encoding. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read is_issued, errors, and pending_mutations.

Returns:

  • (String) 


1042
1043
1044
 
# File 'lib/seam/resources/action_attempt.rb', line 1042

def display_status
  @display_status
end

#instant_key_url ⇒ String?

URL of the Instant Key for mobile key access methods.

Returns:

  • (String, nil) 


1045
1046
1047
 
# File 'lib/seam/resources/action_attempt.rb', line 1045

def instant_key_url
  @instant_key_url
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) 


1048
1049
1050
 
# File 'lib/seam/resources/action_attempt.rb', line 1048

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) 


1051
1052
1053
 
# File 'lib/seam/resources/action_attempt.rb', line 1051

def is_encoding_required
  @is_encoding_required
end

#is_issued ⇒ Boolean

Indicates whether the access method has been issued.

Returns:

  • (Boolean) 


1054
1055
1056
 
# File 'lib/seam/resources/action_attempt.rb', line 1054

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) 


1057
1058
1059
 
# File 'lib/seam/resources/action_attempt.rb', line 1057

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) 


1060
1061
1062
 
# File 'lib/seam/resources/action_attempt.rb', line 1060

def is_ready_for_encoding
  @is_ready_for_encoding
end

#mode ⇒ String

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

  • code
  • card
  • mobile_key
  • cloud_key

Returns:

  • (String) 


1068
1069
1070
 
# File 'lib/seam/resources/action_attempt.rb', line 1068

def mode
  @mode
end

#workspace_id ⇒ String

ID of the Seam workspace associated with the access method.

Returns:

  • (String) 


1071
1072
1073
 
# File 'lib/seam/resources/action_attempt.rb', line 1071

def workspace_id
  @workspace_id
end

Instance Method Details

#created_at ⇒ Time

Date and time at which the access method was created.

Returns:

  • (Time) 


1074
 
# File 'lib/seam/resources/action_attempt.rb', line 1074

date_accessor :created_at

#errors ⇒ Array<Errors>

Errors associated with the access method.

Returns:



1018
 
# File 'lib/seam/resources/action_attempt.rb', line 1018

resource_list_accessor :errors, Errors

#issued_at ⇒ Time?

Date and time at which the access method was issued.

Returns:

  • (Time, nil) 


1077
 
# File 'lib/seam/resources/action_attempt.rb', line 1077

date_accessor :issued_at

#pending_mutations ⇒ Array<PendingMutations>

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

Returns:



1021
 
# File 'lib/seam/resources/action_attempt.rb', line 1021

resource_list_accessor :pending_mutations, PendingMutations

#warnings ⇒ Array<Warnings>

Warnings associated with the access method.

Returns:



1024
 
# File 'lib/seam/resources/action_attempt.rb', line 1024

resource_list_accessor :warnings, Warnings