Class: E3DB::ClientDetails

Inherits:
Dry::Struct
  • Object
show all
Defined in:
lib/e3db/client.rb

Overview

Information about a newly-created E3DB client

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_id ⇒ String

Returns:

  • (String) 


94
95
96
97
98
99
100
 
# File 'lib/e3db/client.rb', line 94

class ClientDetails < Dry::Struct
  attribute :client_id, Types::Strict::String
  attribute :api_key_id, Types::Strict::String
  attribute :api_secret, Types::Strict::String
  attribute :public_key, PublicKey
  attribute :name, Types::Strict::String
end

#api_secret ⇒ String

Returns:

  • (String) 


94
95
96
97
98
99
100
 
# File 'lib/e3db/client.rb', line 94

class ClientDetails < Dry::Struct
  attribute :client_id, Types::Strict::String
  attribute :api_key_id, Types::Strict::String
  attribute :api_secret, Types::Strict::String
  attribute :public_key, PublicKey
  attribute :name, Types::Strict::String
end

#client_id ⇒ String

Returns the client's unique ID string.

Returns:

  • (String) —

    the client's unique ID string



94
95
96
97
98
99
100
 
# File 'lib/e3db/client.rb', line 94

class ClientDetails < Dry::Struct
  attribute :client_id, Types::Strict::String
  attribute :api_key_id, Types::Strict::String
  attribute :api_secret, Types::Strict::String
  attribute :public_key, PublicKey
  attribute :name, Types::Strict::String
end

#name ⇒ String

Returns the client's name.

Returns:

  • (String) —

    the client's name.



94
95
96
97
98
99
100
 
# File 'lib/e3db/client.rb', line 94

class ClientDetails < Dry::Struct
  attribute :client_id, Types::Strict::String
  attribute :api_key_id, Types::Strict::String
  attribute :api_secret, Types::Strict::String
  attribute :public_key, PublicKey
  attribute :name, Types::Strict::String
end

#public_key ⇒ PublicKey

Returns the client's public key information.

Returns:

  • (PublicKey) —

    the client's public key information



94
95
96
97
98
99
100
 
# File 'lib/e3db/client.rb', line 94

class ClientDetails < Dry::Struct
  attribute :client_id, Types::Strict::String
  attribute :api_key_id, Types::Strict::String
  attribute :api_secret, Types::Strict::String
  attribute :public_key, PublicKey
  attribute :name, Types::Strict::String
end