Class: CryptoApis::CreateCoinsTransactionRequestFromAddressRI

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCoinsTransactionRequestFromAddressRI

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
166
167
168
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 114

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

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

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

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

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

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

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

Instance Attribute Details

#address_tag ⇒ Object

Defines a specific Tag that is an additional XRP address feature. It helps identify a transaction recipient beyond a wallet address. The tag that was encoded into the x-Address along with the Source Classic Address.



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

def address_tag
  @address_tag
end

#callback_secret_key ⇒ Object

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/create_coins_transaction_request_from_address_ri.rb', line 22

def callback_secret_key
  @callback_secret_key
end

#callback_url ⇒ Object

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/create_coins_transaction_request_from_address_ri.rb', line 25

def callback_url
  @callback_url
end

#classic_address ⇒ Object

Represents the public address, which is a compressed and shortened form of a public key. The classic address is shown when the source address is an x-Address.



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

def classic_address
  @classic_address
end

#fee_priority ⇒ Object

Represents the fee priority of the automation, whether it is "slow", "standard" or "fast".



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

def fee_priority
  @fee_priority
end

#note ⇒ Object

Represents an optional note to add a free text in, explaining or providing additional detail on the transaction request.



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

def note
  @note
end

#recipients ⇒ Object

Defines the destination for the transaction, i.e. the recipient(s).



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

def recipients
  @recipients
end

#senders ⇒ Object

Returns the value of attribute senders.



39
40
41
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 39

def senders
  @senders
end

#transaction_request_id ⇒ Object

Represents a unique identifier of the transaction request (the request sent to make a transaction), which helps in identifying which callback and which ‘referenceId` concern that specific transaction request.



42
43
44
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 42

def transaction_request_id
  @transaction_request_id
end

#transaction_request_status ⇒ Object

Defines the status of the transaction request, e.g. "created, "await_approval", "pending", "prepared", "signed", "broadcasted", "success", "failed", "rejected", mined".



45
46
47
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 45

def transaction_request_status
  @transaction_request_status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 70

def self.attribute_map
  {
    :'address_tag' => :'addressTag',
    :'callback_secret_key' => :'callbackSecretKey',
    :'callback_url' => :'callbackUrl',
    :'classic_address' => :'classicAddress',
    :'fee_priority' => :'feePriority',
    :'note' => :'note',
    :'recipients' => :'recipients',
    :'senders' => :'senders',
    :'transaction_request_id' => :'transactionRequestId',
    :'transaction_request_status' => :'transactionRequestStatus'
  }
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



264
265
266
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 264

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 107

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 91

def self.openapi_types
  {
    :'address_tag' => :'Integer',
    :'callback_secret_key' => :'String',
    :'callback_url' => :'String',
    :'classic_address' => :'String',
    :'fee_priority' => :'String',
    :'note' => :'String',
    :'recipients' => :'Array<CreateCoinsTransactionRequestFromAddressRIRecipientsInner>',
    :'senders' => :'CreateCoinsTransactionRequestFromAddressRISenders',
    :'transaction_request_id' => :'String',
    :'transaction_request_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_tag == o.address_tag &&
      callback_secret_key == o.callback_secret_key &&
      callback_url == o.callback_url &&
      classic_address == o.classic_address &&
      fee_priority == o.fee_priority &&
      note == o.note &&
      recipients == o.recipients &&
      senders == o.senders &&
      transaction_request_id == o.transaction_request_id &&
      transaction_request_status == o.transaction_request_status
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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 295

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 366

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 271

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


251
252
253
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 257

def hash
  [address_tag, callback_secret_key, callback_url, classic_address, fee_priority, note, recipients, senders, transaction_request_id, transaction_request_status].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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 172

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

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

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

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

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



342
343
344
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 342

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 348

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



336
337
338
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 336

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



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/crypto_apis/models/create_coins_transaction_request_from_address_ri.rb', line 199

def valid?
  return false if @fee_priority.nil?
  fee_priority_validator = EnumAttributeValidator.new('String', ["slow", "standard", "fast"])
  return false unless fee_priority_validator.valid?(@fee_priority)
  return false if @recipients.nil?
  return false if @senders.nil?
  return false if @transaction_request_id.nil?
  return false if @transaction_request_status.nil?
  transaction_request_status_validator = EnumAttributeValidator.new('String', ["created", "await-approval", "pending", "prepared", "signed", "broadcasted", "success", "failed", "rejected", "mined"])
  return false unless transaction_request_status_validator.valid?(@transaction_request_status)
  true
end