Class: Coinbase::Client::Transfer
- Inherits:
-
Object
- Object
- Coinbase::Client::Transfer
- Defined in:
- lib/coinbase/client/models/transfer.rb
Overview
A transfer of an asset from one address to another
Instance Attribute Summary collapse
-
#address_id ⇒ Object
The onchain address of the sender.
-
#amount ⇒ Object
The amount in the atomic units of the asset.
-
#asset ⇒ Object
Returns the value of attribute asset.
-
#asset_id ⇒ Object
The ID of the asset being transferred.
-
#destination ⇒ Object
The onchain address of the recipient.
-
#gasless ⇒ Object
Whether the transfer uses sponsored gas.
-
#network_id ⇒ Object
The ID of the blockchain network.
-
#signed_payload ⇒ Object
The signed payload of the transfer.
-
#sponsored_send ⇒ Object
Returns the value of attribute sponsored_send.
-
#status ⇒ Object
Returns the value of attribute status.
-
#transaction ⇒ Object
Returns the value of attribute transaction.
-
#transaction_hash ⇒ Object
The hash of the transfer transaction.
-
#transfer_id ⇒ Object
The ID of the transfer.
-
#unsigned_payload ⇒ Object
The unsigned payload of the transfer.
-
#wallet_id ⇒ Object
The ID of the wallet that owns the from address.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Transfer
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Transfer
Initializes the object
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 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/transfer.rb', line 115 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Coinbase::Client::Transfer` 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::Transfer`. 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?(:'network_id') self.network_id = attributes[:'network_id'] else self.network_id = nil end if attributes.key?(:'wallet_id') self.wallet_id = attributes[:'wallet_id'] else self.wallet_id = nil end if attributes.key?(:'address_id') self.address_id = attributes[:'address_id'] else self.address_id = nil end if attributes.key?(:'destination') self.destination = attributes[:'destination'] else self.destination = nil end if attributes.key?(:'amount') self.amount = attributes[:'amount'] else self.amount = nil end if attributes.key?(:'asset_id') self.asset_id = attributes[:'asset_id'] else self.asset_id = nil end if attributes.key?(:'asset') self.asset = attributes[:'asset'] else self.asset = nil end if attributes.key?(:'transfer_id') self.transfer_id = attributes[:'transfer_id'] else self.transfer_id = nil end if attributes.key?(:'transaction') self.transaction = attributes[:'transaction'] end if attributes.key?(:'sponsored_send') self.sponsored_send = attributes[:'sponsored_send'] end if attributes.key?(:'unsigned_payload') self.unsigned_payload = attributes[:'unsigned_payload'] end if attributes.key?(:'signed_payload') self.signed_payload = attributes[:'signed_payload'] end if attributes.key?(:'transaction_hash') self.transaction_hash = attributes[:'transaction_hash'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'gasless') self.gasless = attributes[:'gasless'] else self.gasless = nil end end |
Instance Attribute Details
#address_id ⇒ Object
The onchain address of the sender
26 27 28 |
# File 'lib/coinbase/client/models/transfer.rb', line 26 def address_id @address_id end |
#amount ⇒ Object
The amount in the atomic units of the asset
32 33 34 |
# File 'lib/coinbase/client/models/transfer.rb', line 32 def amount @amount end |
#asset ⇒ Object
Returns the value of attribute asset.
37 38 39 |
# File 'lib/coinbase/client/models/transfer.rb', line 37 def asset @asset end |
#asset_id ⇒ Object
The ID of the asset being transferred. Use ‘asset.asset_id` instead.
35 36 37 |
# File 'lib/coinbase/client/models/transfer.rb', line 35 def asset_id @asset_id end |
#destination ⇒ Object
The onchain address of the recipient
29 30 31 |
# File 'lib/coinbase/client/models/transfer.rb', line 29 def destination @destination end |
#gasless ⇒ Object
Whether the transfer uses sponsored gas
58 59 60 |
# File 'lib/coinbase/client/models/transfer.rb', line 58 def gasless @gasless end |
#network_id ⇒ Object
The ID of the blockchain network
20 21 22 |
# File 'lib/coinbase/client/models/transfer.rb', line 20 def network_id @network_id end |
#signed_payload ⇒ Object
The signed payload of the transfer. This is the payload that has been signed by the sender.
50 51 52 |
# File 'lib/coinbase/client/models/transfer.rb', line 50 def signed_payload @signed_payload end |
#sponsored_send ⇒ Object
Returns the value of attribute sponsored_send.
44 45 46 |
# File 'lib/coinbase/client/models/transfer.rb', line 44 def sponsored_send @sponsored_send end |
#status ⇒ Object
Returns the value of attribute status.
55 56 57 |
# File 'lib/coinbase/client/models/transfer.rb', line 55 def status @status end |
#transaction ⇒ Object
Returns the value of attribute transaction.
42 43 44 |
# File 'lib/coinbase/client/models/transfer.rb', line 42 def transaction @transaction end |
#transaction_hash ⇒ Object
The hash of the transfer transaction
53 54 55 |
# File 'lib/coinbase/client/models/transfer.rb', line 53 def transaction_hash @transaction_hash end |
#transfer_id ⇒ Object
The ID of the transfer
40 41 42 |
# File 'lib/coinbase/client/models/transfer.rb', line 40 def transfer_id @transfer_id end |
#unsigned_payload ⇒ Object
The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.
47 48 49 |
# File 'lib/coinbase/client/models/transfer.rb', line 47 def unsigned_payload @unsigned_payload end |
#wallet_id ⇒ Object
The ID of the wallet that owns the from address
23 24 25 |
# File 'lib/coinbase/client/models/transfer.rb', line 23 def wallet_id @wallet_id end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/coinbase/client/models/transfer.rb', line 328 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
82 83 84 |
# File 'lib/coinbase/client/models/transfer.rb', line 82 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/coinbase/client/models/transfer.rb', line 61 def self.attribute_map { :'network_id' => :'network_id', :'wallet_id' => :'wallet_id', :'address_id' => :'address_id', :'destination' => :'destination', :'amount' => :'amount', :'asset_id' => :'asset_id', :'asset' => :'asset', :'transfer_id' => :'transfer_id', :'transaction' => :'transaction', :'sponsored_send' => :'sponsored_send', :'unsigned_payload' => :'unsigned_payload', :'signed_payload' => :'signed_payload', :'transaction_hash' => :'transaction_hash', :'status' => :'status', :'gasless' => :'gasless' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/coinbase/client/models/transfer.rb', line 304 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
108 109 110 111 |
# File 'lib/coinbase/client/models/transfer.rb', line 108 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/coinbase/client/models/transfer.rb', line 87 def self.openapi_types { :'network_id' => :'String', :'wallet_id' => :'String', :'address_id' => :'String', :'destination' => :'String', :'amount' => :'String', :'asset_id' => :'String', :'asset' => :'Asset', :'transfer_id' => :'String', :'transaction' => :'Transaction', :'sponsored_send' => :'SponsoredSend', :'unsigned_payload' => :'String', :'signed_payload' => :'String', :'transaction_hash' => :'String', :'status' => :'String', :'gasless' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/coinbase/client/models/transfer.rb', line 269 def ==(o) return true if self.equal?(o) self.class == o.class && network_id == o.network_id && wallet_id == o.wallet_id && address_id == o.address_id && destination == o.destination && amount == o.amount && asset_id == o.asset_id && asset == o.asset && transfer_id == o.transfer_id && transaction == o.transaction && sponsored_send == o.sponsored_send && unsigned_payload == o.unsigned_payload && signed_payload == o.signed_payload && transaction_hash == o.transaction_hash && status == o.status && gasless == o.gasless end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
399 400 401 402 403 404 405 406 407 408 409 410 411 |
# File 'lib/coinbase/client/models/transfer.rb', line 399 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
291 292 293 |
# File 'lib/coinbase/client/models/transfer.rb', line 291 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
297 298 299 |
# File 'lib/coinbase/client/models/transfer.rb', line 297 def hash [network_id, wallet_id, address_id, destination, amount, asset_id, asset, transfer_id, transaction, sponsored_send, unsigned_payload, signed_payload, transaction_hash, status, gasless].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/coinbase/client/models/transfer.rb', line 209 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @network_id.nil? invalid_properties.push('invalid value for "network_id", network_id cannot be nil.') end if @wallet_id.nil? invalid_properties.push('invalid value for "wallet_id", wallet_id cannot be nil.') end if @address_id.nil? invalid_properties.push('invalid value for "address_id", address_id cannot be nil.') end if @destination.nil? invalid_properties.push('invalid value for "destination", destination cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @asset_id.nil? invalid_properties.push('invalid value for "asset_id", asset_id cannot be nil.') end if @asset.nil? invalid_properties.push('invalid value for "asset", asset cannot be nil.') end if @transfer_id.nil? invalid_properties.push('invalid value for "transfer_id", transfer_id cannot be nil.') end if @gasless.nil? invalid_properties.push('invalid value for "gasless", gasless cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
375 376 377 |
# File 'lib/coinbase/client/models/transfer.rb', line 375 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/coinbase/client/models/transfer.rb', line 381 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
369 370 371 |
# File 'lib/coinbase/client/models/transfer.rb', line 369 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/coinbase/client/models/transfer.rb', line 253 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @network_id.nil? return false if @wallet_id.nil? return false if @address_id.nil? return false if @destination.nil? return false if @amount.nil? return false if @asset_id.nil? return false if @asset.nil? return false if @transfer_id.nil? return false if @gasless.nil? true end |