Class: Api::Contract

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

Overview

Contract represents a payment agreement between the Jamm customer and the merchant. Merchant must use the contract ID to further make a charge, therefore please persist this ID into your database. 契約はJammの顧客とショップの間の支払い契約を表します。 ショップは契約IDを使用して決済を行う必要がありますので、このIDはデータベースに保存してください。

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Contract

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/jamm/api/models/v1_contract.rb', line 83

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

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

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

  return unless attributes.key?(:updated_at)

  self.updated_at = attributes[:updated_at]
end

Instance Attribute Details

#created_at ⇒ Object

Created date of the contract. 契約の作成日時。



25
26
27
 
# File 'lib/jamm/api/models/v1_contract.rb', line 25

def created_at
  @created_at
end

#id ⇒ Object

契約ID (例: con-1234567890) @gotags: validate:"required"



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

def id
  @id
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#updated_at ⇒ Object

Updated date of the contract. 契約の更新日時。



28
29
30
 
# File 'lib/jamm/api/models/v1_contract.rb', line 28

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



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

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



62
63
64
 
# File 'lib/jamm/api/models/v1_contract.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
 
# File 'lib/jamm/api/models/v1_contract.rb', line 52

def self.attribute_map
  {
    :id => :id,
    :status => :status,
    :created_at => :createdAt,
    :updated_at => :updatedAt
  }
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



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

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



77
78
79
 
# File 'lib/jamm/api/models/v1_contract.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
 
# File 'lib/jamm/api/models/v1_contract.rb', line 67

def self.openapi_types
  {
    :id => :String,
    :status => :ContractStatus,
    :created_at => :Time,
    :updated_at => :Time
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
 
# File 'lib/jamm/api/models/v1_contract.rb', line 124

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

  self.class == other.class &&
    id == other.id &&
    status == other.status &&
    created_at == other.created_at &&
    updated_at == other.updated_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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/jamm/api/models/v1_contract.rb', line 243

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


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

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



142
143
144
 
# File 'lib/jamm/api/models/v1_contract.rb', line 142

def hash
  [id, status, created_at, updated_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



110
111
112
113
 
# File 'lib/jamm/api/models/v1_contract.rb', line 110

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



219
220
221
 
# File 'lib/jamm/api/models/v1_contract.rb', line 219

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/jamm/api/models/v1_contract.rb', line 225

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



213
214
215
 
# File 'lib/jamm/api/models/v1_contract.rb', line 213

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



117
118
119
120
 
# File 'lib/jamm/api/models/v1_contract.rb', line 117

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