Class: CryptoApis::NewUnconfirmedCoinsTransactionsRI

Inherits:
Object
  • Object
show all
Defined in:
lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewUnconfirmedCoinsTransactionsRI

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
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
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 78

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

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

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

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

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

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

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

Instance Attribute Details

#addressObject

Represents the address of the transaction, per which the result is returned.



19
20
21
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 19

def address
  @address
end

#callback_secret_keyObject

Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our [Documentation](developers.cryptoapis.io/technical-documentation/general-information/callbacks#callback-security).



22
23
24
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 22

def callback_secret_key
  @callback_secret_key
end

#callback_urlObject

Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs. ‘We support ONLY httpS type of protocol`.



25
26
27
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 25

def callback_url
  @callback_url
end

#created_timestampObject

Defines the specific time/date when the subscription was created in Unix Timestamp.



28
29
30
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 28

def created_timestamp
  @created_timestamp
end

#event_typeObject

Defines the type of the specific event available for the customer to subscribe to for callback notification.



31
32
33
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 31

def event_type
  @event_type
end

#is_activeObject

Defines whether the subscription is active or not. Set as boolean.



34
35
36
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 34

def is_active
  @is_active
end

#reference_idObject

Represents a unique ID used to reference the specific callback subscription.



37
38
39
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 37

def reference_id
  @reference_id
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



53
54
55
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



40
41
42
43
44
45
46
47
48
49
50
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 40

def self.attribute_map
  {
    :'address' => :'address',
    :'callback_secret_key' => :'callbackSecretKey',
    :'callback_url' => :'callbackUrl',
    :'created_timestamp' => :'createdTimestamp',
    :'event_type' => :'eventType',
    :'is_active' => :'isActive',
    :'reference_id' => :'referenceId'
  }
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



197
198
199
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 197

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

.openapi_nullableObject

List of attributes with nullable: true



71
72
73
74
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 71

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

.openapi_typesObject

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 58

def self.openapi_types
  {
    :'address' => :'String',
    :'callback_secret_key' => :'String',
    :'callback_url' => :'String',
    :'created_timestamp' => :'Integer',
    :'event_type' => :'String',
    :'is_active' => :'Boolean',
    :'reference_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



170
171
172
173
174
175
176
177
178
179
180
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      callback_secret_key == o.callback_secret_key &&
      callback_url == o.callback_url &&
      created_timestamp == o.created_timestamp &&
      event_type == o.event_type &&
      is_active == o.is_active &&
      reference_id == o.reference_id
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 228

def _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 = CryptoApis.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 299

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 204

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


184
185
186
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 184

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



190
191
192
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 190

def hash
  [address, callback_secret_key, callback_url, created_timestamp, event_type, is_active, reference_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 122

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

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

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

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

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

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

  if @reference_id.nil?
    invalid_properties.push('invalid value for "reference_id", reference_id 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



275
276
277
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 275

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



281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 281

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



269
270
271
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 269

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



157
158
159
160
161
162
163
164
165
166
# File 'lib/crypto_apis/models/new_unconfirmed_coins_transactions_ri.rb', line 157

def valid?
  return false if @address.nil?
  return false if @callback_secret_key.nil?
  return false if @callback_url.nil?
  return false if @created_timestamp.nil?
  return false if @event_type.nil?
  return false if @is_active.nil?
  return false if @reference_id.nil?
  true
end