Class: Coinbase::Client::SponsoredSend

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

Overview

An onchain sponsored gasless send.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SponsoredSend

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 101

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

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

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

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

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

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

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

Instance Attribute Details

#raw_typed_data ⇒ Object

The raw typed data for the sponsored send



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

def raw_typed_data
  @raw_typed_data
end

#signature ⇒ Object

The signed hash of the sponsored send typed data.



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

def signature
  @signature
end

#status ⇒ Object

The status of the sponsored send



38
39
40
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 38

def status
  @status
end

#to_address_id ⇒ Object

The onchain address of the recipient



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

def to_address_id
  @to_address_id
end

#transaction_hash ⇒ Object

The hash of the onchain sponsored send transaction



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

def transaction_hash
  @transaction_hash
end

#transaction_link ⇒ Object

The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.



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

def transaction_link
  @transaction_link
end

#typed_data_hash ⇒ Object

The typed data hash for the sponsored send. This is the typed data hash that needs to be signed by the sender.



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

def typed_data_hash
  @typed_data_hash
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 251

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



76
77
78
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 63

def self.attribute_map
  {
    :'to_address_id' => :'to_address_id',
    :'raw_typed_data' => :'raw_typed_data',
    :'typed_data_hash' => :'typed_data_hash',
    :'signature' => :'signature',
    :'transaction_hash' => :'transaction_hash',
    :'transaction_link' => :'transaction_link',
    :'status' => :'status'
  }
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 227

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



94
95
96
97
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 81

def self.openapi_types
  {
    :'to_address_id' => :'String',
    :'raw_typed_data' => :'String',
    :'typed_data_hash' => :'String',
    :'signature' => :'String',
    :'transaction_hash' => :'String',
    :'transaction_link' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      to_address_id == o.to_address_id &&
      raw_typed_data == o.raw_typed_data &&
      typed_data_hash == o.typed_data_hash &&
      signature == o.signature &&
      transaction_hash == o.transaction_hash &&
      transaction_link == o.transaction_link &&
      status == o.status
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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 322

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


214
215
216
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 220

def hash
  [to_address_id, raw_typed_data, typed_data_hash, signature, transaction_hash, transaction_link, 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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 153

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

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

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

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



298
299
300
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 298

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 304

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



292
293
294
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 292

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



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/coinbase/client/models/sponsored_send.rb', line 177

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @to_address_id.nil?
  return false if @raw_typed_data.nil?
  return false if @typed_data_hash.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["pending", "signed", "submitted", "complete", "failed", "unknown_default_open_api"])
  return false unless status_validator.valid?(@status)
  true
end