Class: Seam::Resources::ActionAttempt::EncodeCredential::Result

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

Defined Under Namespace

Classes: AkilesMetadata, AssaAbloyVostioMetadata, Errors, VisionlineMetadata, 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 ⇒ String

Access method for the credential. Supported values: code, card, mobile_key, cloud_key. Known values:

  • code
  • card
  • mobile_key
  • cloud_key

Returns:

  • (String) 


572
573
574
 
# File 'lib/seam/resources/action_attempt.rb', line 572

def access_method
  @access_method
end

#acs_credential_id ⇒ String

ID of the credential.

Returns:

  • (String) 


575
576
577
 
# File 'lib/seam/resources/action_attempt.rb', line 575

def acs_credential_id
  @acs_credential_id
end

#acs_credential_pool_id ⇒ String?

ID of the credential pool to which the credential belongs.

Returns:

  • (String, nil) 


578
579
580
 
# File 'lib/seam/resources/action_attempt.rb', line 578

def acs_credential_pool_id
  @acs_credential_pool_id
end

#acs_system_id ⇒ String

ID of the access control system that contains the credential.

Returns:

  • (String) 


581
582
583
 
# File 'lib/seam/resources/action_attempt.rb', line 581

def acs_system_id
  @acs_system_id
end

#acs_user_id ⇒ String?

ID of the ACS user to whom the credential belongs.

Returns:

  • (String, nil) 


584
585
586
 
# File 'lib/seam/resources/action_attempt.rb', line 584

def acs_user_id
  @acs_user_id
end

#card_number ⇒ String?

Number of the card associated with the credential.

Returns:

  • (String, nil) 


587
588
589
 
# File 'lib/seam/resources/action_attempt.rb', line 587

def card_number
  @card_number
end

#code ⇒ String?

Access (PIN) code for the credential.

Returns:

  • (String, nil) 


590
591
592
 
# File 'lib/seam/resources/action_attempt.rb', line 590

def code
  @code
end

#connected_account_id ⇒ String

ID of the connected account to which the credential belongs.

Returns:

  • (String) 


593
594
595
 
# File 'lib/seam/resources/action_attempt.rb', line 593

def 
  @connected_account_id
end

#display_name ⇒ String

Display name that corresponds to the credential type.

Returns:

  • (String) 


596
597
598
 
# File 'lib/seam/resources/action_attempt.rb', line 596

def display_name
  @display_name
end

#ends_at ⇒ String?

Date and time at which the credential validity ends, in ISO 8601 format. Must be a time in the future and after starts_at.

Returns:

  • (String, nil) 


599
600
601
 
# File 'lib/seam/resources/action_attempt.rb', line 599

def ends_at
  @ends_at
end

#external_type ⇒ String?

Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card. Known values:

  • pti_card
  • brivo_credential
  • hid_credential
  • visionline_card
  • salto_ks_credential
  • assa_abloy_vostio_key
  • salto_space_key
  • latch_access
  • dormakaba_ambiance_credential
  • hotek_card
  • salto_ks_tag
  • avigilon_alta_credential
  • kisi_credential
  • akiles_credential

Returns:

  • (String, nil) 


617
618
619
 
# File 'lib/seam/resources/action_attempt.rb', line 617

def external_type
  @external_type
end

#external_type_display_name ⇒ String?

Display name that corresponds to the brand-specific terminology for the credential type.

Returns:

  • (String, nil) 


620
621
622
 
# File 'lib/seam/resources/action_attempt.rb', line 620

def external_type_display_name
  @external_type_display_name
end

#is_issued ⇒ Boolean?

Indicates whether the credential has been encoded onto a card.

Returns:

  • (Boolean, nil) 


623
624
625
 
# File 'lib/seam/resources/action_attempt.rb', line 623

def is_issued
  @is_issued
end

#is_latest_desired_state_synced_with_provider ⇒ Boolean?

Indicates whether the latest state of the credential has been synced from Seam to the provider.

Returns:

  • (Boolean, nil) 


626
627
628
 
# File 'lib/seam/resources/action_attempt.rb', line 626

def is_latest_desired_state_synced_with_provider
  @is_latest_desired_state_synced_with_provider
end

#is_managed ⇒ Boolean

Returns:

  • (Boolean) 


628
629
630
 
# File 'lib/seam/resources/action_attempt.rb', line 628

def is_managed
  @is_managed
end

#is_multi_phone_sync_credential ⇒ Boolean?

Indicates whether the credential is a multi-phone sync credential.

Returns:

  • (Boolean, nil) 


631
632
633
 
# File 'lib/seam/resources/action_attempt.rb', line 631

def is_multi_phone_sync_credential
  @is_multi_phone_sync_credential
end

#is_one_time_use ⇒ Boolean?

Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.

Returns:

  • (Boolean, nil) 


634
635
636
 
# File 'lib/seam/resources/action_attempt.rb', line 634

def is_one_time_use
  @is_one_time_use
end

#parent_acs_credential_id ⇒ String?

ID of the parent credential.

Returns:

  • (String, nil) 


637
638
639
 
# File 'lib/seam/resources/action_attempt.rb', line 637

def parent_acs_credential_id
  @parent_acs_credential_id
end

#starts_at ⇒ String?

Date and time at which the credential validity starts, in ISO 8601 format.

Returns:

  • (String, nil) 


640
641
642
 
# File 'lib/seam/resources/action_attempt.rb', line 640

def starts_at
  @starts_at
end

#user_identity_id ⇒ String?

ID of the user identity to whom the credential belongs.

Returns:

  • (String, nil) 


643
644
645
 
# File 'lib/seam/resources/action_attempt.rb', line 643

def user_identity_id
  @user_identity_id
end

#workspace_id ⇒ String

ID of the workspace that contains the credential.

Returns:

  • (String) 


646
647
648
 
# File 'lib/seam/resources/action_attempt.rb', line 646

def workspace_id
  @workspace_id
end

Instance Method Details

#akiles_metadata ⇒ AkilesMetadata?

Akiles-specific metadata for the credential.

Returns:



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

resource_accessor :akiles_metadata, AkilesMetadata

#assa_abloy_vostio_metadata ⇒ AssaAbloyVostioMetadata?

Vostio-specific metadata for the credential.

Returns:



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

resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata

#created_at ⇒ Time

Date and time at which the credential was created.

Returns:

  • (Time) 


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

date_accessor :created_at

#errors ⇒ Array<Errors>

Errors associated with the credential.

Returns:



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

resource_list_accessor :errors, Errors

#issued_at ⇒ Time?

Date and time at which the credential was encoded onto a card.

Returns:

  • (Time, nil) 


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

date_accessor :issued_at

#latest_desired_state_synced_with_provider_at ⇒ Time?

Date and time at which the state of the credential was most recently synced from Seam to the provider.

Returns:

  • (Time, nil) 


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

date_accessor :latest_desired_state_synced_with_provider_at

#visionline_metadata ⇒ VisionlineMetadata?

Visionline-specific metadata for the credential.

Returns:



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

resource_accessor :visionline_metadata, VisionlineMetadata

#warnings ⇒ Array<Warnings>

Warnings associated with the credential.

Returns:



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

resource_list_accessor :warnings, Warnings