Class: Api::CustomerServiceUpdateCustomerBody

Inherits:
Object
  • Object
show all
Defined in:
lib/jamm/api/models/customer_service_update_customer_body.rb

Overview

UpdateCustomerRequest is the request to update a customer. We strongly recommend to call this endpoint when you need to update the customer’s information for better experience on our dashboard and customer support. UpdateCustomerRequest はCustomerを更新するためのリクエストです。 加盟店の管理画面でより良い体験を提供し、カスタマーサポートを向上させるため、ストアの顧客情報が変更されたら 当エンドポイントを呼び出すことを推奨します。

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerServiceUpdateCustomerBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 66

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `Api::CustomerServiceUpdateCustomerBody` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `Api::CustomerServiceUpdateCustomerBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.email = attributes[:email] if attributes.key?(:email)

  self.force_kyc = attributes[:force_kyc] if attributes.key?(:force_kyc)

  self.name = attributes[:name] if attributes.key?(:name)

  self.katakana_last_name = attributes[:katakana_last_name] if attributes.key?(:katakana_last_name)

  self.katakana_first_name = attributes[:katakana_first_name] if attributes.key?(:katakana_first_name)

  self.address = attributes[:address] if attributes.key?(:address)

  self.birth_date = attributes[:birth_date] if attributes.key?(:birth_date)

  self.gender = attributes[:gender] if attributes.key?(:gender)

  return unless attributes.key?(:metadata)
  return unless (value = attributes[:metadata]).is_a?(Hash)

  self.metadata = value
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

def address
  @address
end

#birth_date ⇒ Object

Returns the value of attribute birth_date.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

def birth_date
  @birth_date
end

#email ⇒ Object

Returns the value of attribute email.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

def email
  @email
end

#force_kyc ⇒ Object

Returns the value of attribute force_kyc.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

def force_kyc
  @force_kyc
end

#gender ⇒ Object

Returns the value of attribute gender.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

def gender
  @gender
end

#katakana_first_name ⇒ Object

Returns the value of attribute katakana_first_name.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

def katakana_first_name
  @katakana_first_name
end

#katakana_last_name ⇒ Object

Returns the value of attribute katakana_last_name.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

def katakana_last_name
  @katakana_last_name
end

#metadata ⇒ Object

Arbitrary key-value additional information about the customer. All the existing metadata will be overwritten by the new metadata. Customerに関する任意のキーと値の追加情報。 すべての既存のメタデータは新しいメタデータで上書きされます。



22
23
24
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 22

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



19
20
21
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 19

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



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
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 167

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 = Api.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



40
41
42
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 40

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 25

def self.attribute_map
  {
    :email => :email,
    :force_kyc => :forceKyc,
    :name => :name,
    :katakana_last_name => :katakanaLastName,
    :katakana_first_name => :katakanaFirstName,
    :address => :address,
    :birth_date => :birthDate,
    :gender => :gender,
    :metadata => :metadata
  }
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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 144

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.to_s] = 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
      transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) } if attributes[attribute_map[key]].is_a?(Array)
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 60

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

.openapi_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 45

def self.openapi_types
  {
    :email => :String,
    :force_kyc => :Boolean,
    :name => :String,
    :katakana_last_name => :String,
    :katakana_first_name => :String,
    :address => :String,
    :birth_date => :String,
    :gender => :String,
    :metadata => :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 114

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    email == other.email &&
    force_kyc == other.force_kyc &&
    name == other.name &&
    katakana_last_name == other.katakana_last_name &&
    katakana_first_name == other.katakana_first_name &&
    address == other.address &&
    birth_date == other.birth_date &&
    gender == other.gender &&
    metadata == other.metadata
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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 238

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?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


131
132
133
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



137
138
139
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 137

def hash
  [email, force_kyc, name, katakana_last_name, katakana_first_name, address, birth_date, gender, metadata].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



100
101
102
103
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 100

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  []
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



214
215
216
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 214

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



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 220

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



208
209
210
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 208

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



107
108
109
110
 
# File 'lib/jamm/api/models/customer_service_update_customer_body.rb', line 107

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end