Class: Api::InitialCharge

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

Overview

InitialCharge is a charge object without id. Intended to be used when creating a contract with initial charge.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InitialCharge

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 63

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

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

  if attributes.key?(:metadata) && (value = attributes[:metadata]).is_a?(Hash)
    self.metadata = value
  end

  return unless attributes.key?(:expires_at)

  self.expires_at = attributes[:expires_at]
end

Instance Attribute Details

#description ⇒ Object

Description is an arbitrary string for merchant to track the charge. This information is displayed on Merchant Dashboard. 決済の説明。ショップが決済を追跡するための任意の文字列です。 @gotags: validate:"required"



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

def description
  @description
end

#expires_at ⇒ Object

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



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

def expires_at
  @expires_at
end

#metadata ⇒ Object

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



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

def metadata
  @metadata
end

#price ⇒ Object

Amount of the charge in Japanese Yen. The amount must be the total price of the product/service including tax. 決済金額。日本円で指定してください。 金額は商品/サービスの合計金額 (税込) を指定してください。 @gotags: validate:"gte=1,lte=500000"



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

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



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

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



42
43
44
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 32

def self.attribute_map
  {
    :price => :price,
    :description => :description,
    :metadata => :metadata,
    :expires_at => :expiresAt
  }
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 127

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



57
58
59
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 47

def self.openapi_types
  {
    :price => :Integer,
    :description => :String,
    :metadata => :'Hash<String, String>',
    :expires_at => :Time
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
110
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 102

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

  self.class == other.class &&
    price == other.price &&
    description == other.description &&
    metadata == other.metadata &&
    expires_at == other.expires_at
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



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

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


114
115
116
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



120
121
122
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 120

def hash
  [price, description, metadata, expires_at].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



88
89
90
91
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 88

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



197
198
199
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 197

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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 203

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



191
192
193
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 191

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



95
96
97
98
 
# File 'lib/jamm/api/models/v1_initial_charge.rb', line 95

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