Class: TurnkeyClient::PrivateKey

Inherits:
Object
  • Object
show all
Defined in:
lib/turnkey_client/models/private_key.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivateKey

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/turnkey_client/models/private_key.rb', line 82

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TurnkeyClient::PrivateKey` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TurnkeyClient::PrivateKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'private_key_id')
    self.private_key_id = attributes[:'private_key_id']
  end

  if attributes.key?(:'public_key')
    self.public_key = attributes[:'public_key']
  end

  if attributes.key?(:'private_key_name')
    self.private_key_name = attributes[:'private_key_name']
  end

  if attributes.key?(:'curve')
    self.curve = attributes[:'curve']
  end

  if attributes.key?(:'addresses')
    if (value = attributes[:'addresses']).is_a?(Array)
      self.addresses = value
    end
  end

  if attributes.key?(:'private_key_tags')
    if (value = attributes[:'private_key_tags']).is_a?(Array)
      self.private_key_tags = value
    end
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.key?(:'exported')
    self.exported = attributes[:'exported']
  end

  if attributes.key?(:'imported')
    self.imported = attributes[:'imported']
  end
end

Instance Attribute Details

#addressesObject

Derived cryptocurrency addresses for a given Private Key.



27
28
29
# File 'lib/turnkey_client/models/private_key.rb', line 27

def addresses
  @addresses
end

#created_atObject

Returns the value of attribute created_at.



32
33
34
# File 'lib/turnkey_client/models/private_key.rb', line 32

def created_at
  @created_at
end

#curveObject

Returns the value of attribute curve.



24
25
26
# File 'lib/turnkey_client/models/private_key.rb', line 24

def curve
  @curve
end

#exportedObject

True when a given Private Key is exported, false otherwise.



37
38
39
# File 'lib/turnkey_client/models/private_key.rb', line 37

def exported
  @exported
end

#importedObject

True when a given Private Key is imported, false otherwise.



40
41
42
# File 'lib/turnkey_client/models/private_key.rb', line 40

def imported
  @imported
end

#private_key_idObject

Unique identifier for a given Private Key.



16
17
18
# File 'lib/turnkey_client/models/private_key.rb', line 16

def private_key_id
  @private_key_id
end

#private_key_nameObject

Human-readable name for a Private Key.



22
23
24
# File 'lib/turnkey_client/models/private_key.rb', line 22

def private_key_name
  @private_key_name
end

#private_key_tagsObject

A list of Private Key Tag IDs.



30
31
32
# File 'lib/turnkey_client/models/private_key.rb', line 30

def private_key_tags
  @private_key_tags
end

#public_keyObject

The public component of a cryptographic key pair used to sign messages and transactions.



19
20
21
# File 'lib/turnkey_client/models/private_key.rb', line 19

def public_key
  @public_key
end

#updated_atObject

Returns the value of attribute updated_at.



34
35
36
# File 'lib/turnkey_client/models/private_key.rb', line 34

def updated_at
  @updated_at
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/turnkey_client/models/private_key.rb', line 43

def self.attribute_map
  {
    :'private_key_id' => :'privateKeyId',
    :'public_key' => :'publicKey',
    :'private_key_name' => :'privateKeyName',
    :'curve' => :'curve',
    :'addresses' => :'addresses',
    :'private_key_tags' => :'privateKeyTags',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'exported' => :'exported',
    :'imported' => :'imported'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



235
236
237
# File 'lib/turnkey_client/models/private_key.rb', line 235

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



75
76
77
78
# File 'lib/turnkey_client/models/private_key.rb', line 75

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/turnkey_client/models/private_key.rb', line 59

def self.openapi_types
  {
    :'private_key_id' => :'Object',
    :'public_key' => :'Object',
    :'private_key_name' => :'Object',
    :'curve' => :'Object',
    :'addresses' => :'Object',
    :'private_key_tags' => :'Object',
    :'created_at' => :'Object',
    :'updated_at' => :'Object',
    :'exported' => :'Object',
    :'imported' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/turnkey_client/models/private_key.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      private_key_id == o.private_key_id &&
      public_key == o.public_key &&
      private_key_name == o.private_key_name &&
      curve == o.curve &&
      addresses == o.addresses &&
      private_key_tags == o.private_key_tags &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      exported == o.exported &&
      imported == o.imported
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/turnkey_client/models/private_key.rb', line 265

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    TurnkeyClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



334
335
336
337
338
339
340
341
342
343
344
345
346
# File 'lib/turnkey_client/models/private_key.rb', line 334

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/turnkey_client/models/private_key.rb', line 242

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


222
223
224
# File 'lib/turnkey_client/models/private_key.rb', line 222

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



228
229
230
# File 'lib/turnkey_client/models/private_key.rb', line 228

def hash
  [private_key_id, public_key, private_key_name, curve, addresses, private_key_tags, created_at, updated_at, exported, imported].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/turnkey_client/models/private_key.rb', line 142

def list_invalid_properties
  invalid_properties = Array.new
  if @private_key_id.nil?
    invalid_properties.push('invalid value for "private_key_id", private_key_id cannot be nil.')
  end

  if @public_key.nil?
    invalid_properties.push('invalid value for "public_key", public_key cannot be nil.')
  end

  if @private_key_name.nil?
    invalid_properties.push('invalid value for "private_key_name", private_key_name cannot be nil.')
  end

  if @curve.nil?
    invalid_properties.push('invalid value for "curve", curve cannot be nil.')
  end

  if @addresses.nil?
    invalid_properties.push('invalid value for "addresses", addresses cannot be nil.')
  end

  if @private_key_tags.nil?
    invalid_properties.push('invalid value for "private_key_tags", private_key_tags cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  if @exported.nil?
    invalid_properties.push('invalid value for "exported", exported cannot be nil.')
  end

  if @imported.nil?
    invalid_properties.push('invalid value for "imported", imported cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



310
311
312
# File 'lib/turnkey_client/models/private_key.rb', line 310

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/turnkey_client/models/private_key.rb', line 316

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



304
305
306
# File 'lib/turnkey_client/models/private_key.rb', line 304

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/turnkey_client/models/private_key.rb', line 189

def valid?
  return false if @private_key_id.nil?
  return false if @public_key.nil?
  return false if @private_key_name.nil?
  return false if @curve.nil?
  return false if @addresses.nil?
  return false if @private_key_tags.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @exported.nil?
  return false if @imported.nil?
  true
end