Class: Coinbase::Client::SignatureCreationEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/coinbase/client/models/signature_creation_event.rb

Overview

An event representing a signature creation.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignatureCreationEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Coinbase::Client::SignatureCreationEvent` 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 `Coinbase::Client::SignatureCreationEvent`. 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?(:'seed_id')
    self.seed_id = attributes[:'seed_id']
  else
    self.seed_id = nil
  end

  if attributes.key?(:'wallet_id')
    self.wallet_id = attributes[:'wallet_id']
  else
    self.wallet_id = nil
  end

  if attributes.key?(:'wallet_user_id')
    self.wallet_user_id = attributes[:'wallet_user_id']
  else
    self.wallet_user_id = nil
  end

  if attributes.key?(:'address_id')
    self.address_id = attributes[:'address_id']
  else
    self.address_id = nil
  end

  if attributes.key?(:'address_index')
    self.address_index = attributes[:'address_index']
  else
    self.address_index = nil
  end

  if attributes.key?(:'signing_payload')
    self.signing_payload = attributes[:'signing_payload']
  else
    self.signing_payload = nil
  end

  if attributes.key?(:'transaction_type')
    self.transaction_type = attributes[:'transaction_type']
  else
    self.transaction_type = nil
  end

  if attributes.key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  else
    self.transaction_id = nil
  end
end

Instance Attribute Details

#address_id ⇒ Object

The ID of the address the transfer belongs to



29
30
31
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 29

def address_id
  @address_id
end

#address_index ⇒ Object

The index of the address that the server-signer should sign with



32
33
34
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 32

def address_index
  @address_index
end

#seed_id ⇒ Object

The ID of the seed that the server-signer should create the signature for



20
21
22
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 20

def seed_id
  @seed_id
end

#signing_payload ⇒ Object

The payload that the server-signer should sign



35
36
37
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 35

def signing_payload
  @signing_payload
end

#transaction_id ⇒ Object

The ID of the transaction that the server-signer should sign



40
41
42
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 40

def transaction_id
  @transaction_id
end

#transaction_type ⇒ Object

Returns the value of attribute transaction_type.



37
38
39
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 37

def transaction_type
  @transaction_type
end

#wallet_id ⇒ Object

The ID of the wallet the signature is for



23
24
25
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 23

def wallet_id
  @wallet_id
end

#wallet_user_id ⇒ Object

The ID of the user that the wallet belongs to



26
27
28
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 26

def wallet_user_id
  @wallet_user_id
end

Class Method Details

._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



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
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 276

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Coinbase::Client.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 65

def self.attribute_map
  {
    :'seed_id' => :'seed_id',
    :'wallet_id' => :'wallet_id',
    :'wallet_user_id' => :'wallet_user_id',
    :'address_id' => :'address_id',
    :'address_index' => :'address_index',
    :'signing_payload' => :'signing_payload',
    :'transaction_type' => :'transaction_type',
    :'transaction_id' => :'transaction_id'
  }
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 252

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 84

def self.openapi_types
  {
    :'seed_id' => :'String',
    :'wallet_id' => :'String',
    :'wallet_user_id' => :'String',
    :'address_id' => :'String',
    :'address_index' => :'Integer',
    :'signing_payload' => :'String',
    :'transaction_type' => :'TransactionType',
    :'transaction_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seed_id == o.seed_id &&
      wallet_id == o.wallet_id &&
      wallet_user_id == o.wallet_user_id &&
      address_id == o.address_id &&
      address_index == o.address_index &&
      signing_payload == o.signing_payload &&
      transaction_type == o.transaction_type &&
      transaction_id == o.transaction_id
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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 347

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


239
240
241
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 245

def hash
  [seed_id, wallet_id, wallet_user_id, address_id, address_index, signing_payload, transaction_type, transaction_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 169

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @seed_id.nil?
    invalid_properties.push('invalid value for "seed_id", seed_id cannot be nil.')
  end

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



323
324
325
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 323

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 329

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



317
318
319
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 317

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



209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/coinbase/client/models/signature_creation_event.rb', line 209

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @seed_id.nil?
  return false if @wallet_id.nil?
  return false if @wallet_user_id.nil?
  return false if @address_id.nil?
  return false if @address_index.nil?
  return false if @signing_payload.nil?
  return false if @transaction_type.nil?
  return false if @transaction_id.nil?
  true
end