Class: CityPayApiClient::BatchReportResponseModel

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/batch_report_response_model.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchReportResponseModel

Initializes the object



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 77

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::BatchReportResponseModel` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::BatchReportResponseModel`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  else
    self.amount = nil
  end

  if attributes.key?(:'batch_date')
    self.batch_date = attributes[:'batch_date']
  else
    self.batch_date = nil
  end

  if attributes.key?(:'batch_id')
    self.batch_id = attributes[:'batch_id']
  else
    self.batch_id = nil
  end

  if attributes.key?(:'batch_status')
    self.batch_status = attributes[:'batch_status']
  else
    self.batch_status = nil
  end

  if attributes.key?(:'client_account_id')
    self. = attributes[:'client_account_id']
  else
    self. = nil
  end

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

Instance Attribute Details

#amount ⇒ Object

The total amount that the batch contains.



19
20
21
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 19

def amount
  @amount
end

#batch_date ⇒ Object

The date and time of the batch in ISO-8601 format.



22
23
24
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 22

def batch_date
  @batch_date
end

#batch_id ⇒ Object

The batch id specified in the batch processing request.



25
26
27
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 25

def batch_id
  @batch_id
end

#batch_status ⇒ Object

The status of the batch. Possible values are: - CANCELLED. The file has been cancelled by an administrator or server process. - COMPLETE. The file has passed through the processing cycle and is determined as being complete further information should be obtained on the results of the processing - ERROR_IN_PROCESSING. Errors have occurred in the processing that has deemed that processing can not continue. - INITIALISED. The file has been initialised and no action has yet been performed - LOCKED. The file has been locked for processing - QUEUED. The file has been queued for processing yet no processing has yet been performed - UNKNOWN. The file is of an unknown status, that is the file can either not be determined by the information requested of the file has not yet been received.



28
29
30
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 28

def batch_status
  @batch_status
end

#client_account_id ⇒ Object

The batch account id that the batch was processed with.



31
32
33
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 31

def 
  
end

#transactions ⇒ Object

Returns the value of attribute transactions.



33
34
35
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 33

def transactions
  @transactions
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 272

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 = CityPayApiClient.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



48
49
50
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 48

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 53

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 36

def self.attribute_map
  {
    :'amount' => :'amount',
    :'batch_date' => :'batch_date',
    :'batch_id' => :'batch_id',
    :'batch_status' => :'batch_status',
    :'client_account_id' => :'client_account_id',
    :'transactions' => :'transactions'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 248

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 58

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'batch_date' => :'Date',
    :'batch_id' => :'Integer',
    :'batch_status' => :'String',
    :'client_account_id' => :'String',
    :'transactions' => :'Array<BatchTransactionResultModel>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



222
223
224
225
226
227
228
229
230
231
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      batch_date == o.batch_date &&
      batch_id == o.batch_id &&
      batch_status == o.batch_status &&
       == o. &&
      transactions == o.transactions
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 343

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

See Also:

  • `==` method


235
236
237
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



241
242
243
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 241

def hash
  [amount, batch_date, batch_id, batch_status, , transactions].hash
end

#list_invalid_properties ⇒ Object

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 132

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @batch_date.nil?
    invalid_properties.push('invalid value for "batch_date", batch_date cannot be nil.')
  end

  if @batch_id.nil?
    invalid_properties.push('invalid value for "batch_id", batch_id cannot be nil.')
  end

  if @batch_id < 1
    invalid_properties.push('invalid value for "batch_id", must be greater than or equal to 1.')
  end

  if @batch_status.nil?
    invalid_properties.push('invalid value for "batch_status", batch_status cannot be nil.')
  end

  if .nil?
    invalid_properties.push('invalid value for "client_account_id", client_account_id cannot be nil.')
  end

  if .to_s.length > 20
    invalid_properties.push('invalid value for "client_account_id", the character length must be smaller than or equal to 20.')
  end

  if .to_s.length < 3
    invalid_properties.push('invalid value for "client_account_id", the character length must be greater than or equal to 3.')
  end

  if @transactions.nil?
    invalid_properties.push('invalid value for "transactions", transactions cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



319
320
321
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 319

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 325

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



313
314
315
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 313

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/citypay_api_client/models/batch_report_response_model.rb', line 176

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @amount.nil?
  return false if @batch_date.nil?
  return false if @batch_id.nil?
  return false if @batch_id < 1
  return false if @batch_status.nil?
  return false if .nil?
  return false if .to_s.length > 20
  return false if .to_s.length < 3
  return false if @transactions.nil?
  true
end