Class: Api::Buyer

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

Overview

Buyer is a representation of a customer in your e-commerce site. We require this information to process the payment. 購入者とは、あなたのECサイトの顧客を表します。 この情報は決済を処理するために必要です。

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Buyer

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


98
99
100
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
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 98

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `Api::Buyer` 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::Buyer`. 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.phone = attributes[:phone] if attributes.key?(:phone)

  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)

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

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

  self.metadata = value
end

Instance Attribute Details

#address ⇒ Object

Address of the customer. You can update this value later through the UpdateCustomer endpoint. e.g. - 東京都港区六本木1-1-1 Customerの住所。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。



38
39
40
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 38

def address
  @address
end

#birth_date ⇒ Object

Birth date of the customer. You can update this value later through the UpdateCustomer endpoint. e.g. - 1990-01-01 Customerの生年月日。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。



41
42
43
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 41

def birth_date
  @birth_date
end

#email ⇒ Object

Email of the customer. You can update this value later through the UpdateCustomer endpoint. Customerのメールアドレス。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。



20
21
22
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 20

def email
  @email
end

#expires_at ⇒ Object

Merchant can optionally set the expiry date for the contract. Defaults to 90 minutes if not specified. 決済の有効期限。未指定の場合は90分後に自動失効します。



47
48
49
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 47

def expires_at
  @expires_at
end

#force_kyc ⇒ Object

A flag whether Jamm to force KYC for the customer. 初回購入時に購入者に対してKYCを強制するかどうかのフラグです。



23
24
25
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 23

def force_kyc
  @force_kyc
end

#gender ⇒ Object

Gender of the customer. Customerの性別。



44
45
46
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 44

def gender
  @gender
end

#katakana_first_name ⇒ Object

Katakana name of the customer. You can update this value later through the UpdateCustomer endpoint. e.g. タロウ Customerのカタカナ(名)。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。



35
36
37
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 35

def katakana_first_name
  @katakana_first_name
end

#katakana_last_name ⇒ Object

Katakana name of the customer. You can update this value later through the UpdateCustomer endpoint. e.g. ヤマダ Customerのカタカナ(姓)。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。



32
33
34
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 32

def katakana_last_name
  @katakana_last_name
end

#metadata ⇒ Object

Arbitrary key-value additional information about the customer. You can see this information in our merchant dashboard. Customerに関する任意のキーと値の追加情報。 加盟店ダッシュボードで確認できます。



50
51
52
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 50

def metadata
  @metadata
end

#name ⇒ Object

Name of the customer. You can update this value later through the UpdateCustomer endpoint. e.g. - John Appleseed - 山田太郎 購入者の氏名。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。



29
30
31
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 29

def name
  @name
end

#phone ⇒ Object

Phone number of the customer. You can update this value later through the UpdateCustomer endpoint. e.g. - 09012345678 Customerの電話番号。 この値は UpdateCustomer エンドポイントを通じて後で更新できます。



26
27
28
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 26

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



205
206
207
208
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
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 205

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



70
71
72
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 53

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 182

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



92
93
94
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 75

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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

  self.class == other.class &&
    email == other.email &&
    force_kyc == other.force_kyc &&
    phone == other.phone &&
    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 &&
    expires_at == other.expires_at &&
    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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 276

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


169
170
171
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 169

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 175

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



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

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



252
253
254
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 252

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 258

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



246
247
248
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 246

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



143
144
145
146
 
# File 'lib/jamm/api/models/v1_buyer.rb', line 143

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