Class: OpenapiClient::PaymentCardPaymentTokenUpdateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/payment_card_payment_token_update_request.rb

Overview

Request to update payment token for one or more cards.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentCardPaymentTokenUpdateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 52

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

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

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

Instance Attribute Details

#payment_tokensObject

List of payment tokens to be updated in the request.



25
26
27
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 25

def payment_tokens
  @payment_tokens
end

#request_typeObject

Object name of tokenization request.



19
20
21
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 19

def request_type
  @request_type
end

#store_idObject

An optional outlet ID for clients that support multiple stores in the same app.



22
23
24
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 22

def store_id
  @store_id
end

Class Method Details

.attribute_mapObject

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



28
29
30
31
32
33
34
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 28

def self.attribute_map
  {
    :'request_type' => :'requestType',
    :'store_id' => :'storeId',
    :'payment_tokens' => :'paymentTokens'
  }
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



143
144
145
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 143

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

.openapi_discriminator_nameObject

discriminator’s property name in OpenAPI v3



46
47
48
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 46

def self.openapi_discriminator_name
  :'request_type'
end

.openapi_typesObject

Attribute type mapping.



37
38
39
40
41
42
43
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 37

def self.openapi_types
  {
    :'request_type' => :'String',
    :'store_id' => :'String',
    :'payment_tokens' => :'Array<UpdatePaymentToken>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



120
121
122
123
124
125
126
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 120

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_type == o.request_type &&
      store_id == o.store_id &&
      payment_tokens == o.payment_tokens
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



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
206
207
208
209
210
211
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 171

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    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



245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 245

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 150

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_types.each_pair do |key, type|
    if 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)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


130
131
132
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 130

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



136
137
138
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 136

def hash
  [request_type, store_id, payment_tokens].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 82

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

  if !@store_id.nil? && @store_id.to_s.length > 20
    invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.')
  end

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



221
222
223
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 221

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 227

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = 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



215
216
217
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 215

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



101
102
103
104
105
106
# File 'lib/openapi_client/models/payment_card_payment_token_update_request.rb', line 101

def valid?
  return false if @request_type.nil?
  return false if !@store_id.nil? && @store_id.to_s.length > 20
  return false if @payment_tokens.nil?
  true
end