Class: CityPayApiClient::Batch

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Batch

Initializes the object



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/citypay_api_client/models/batch.rb', line 57

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

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

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

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

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

Instance Attribute Details

#batch_date ⇒ Object

The date that the file was created in ISO-8601 format.



18
19
20
 
# File 'lib/citypay_api_client/models/batch.rb', line 18

def batch_date
  @batch_date
end

#batch_id ⇒ Object

The batch id requested.



21
22
23
 
# File 'lib/citypay_api_client/models/batch.rb', line 21

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.



24
25
26
 
# File 'lib/citypay_api_client/models/batch.rb', line 24

def batch_status
  @batch_status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



36
37
38
 
# File 'lib/citypay_api_client/models/batch.rb', line 36

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
 
# File 'lib/citypay_api_client/models/batch.rb', line 27

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

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



146
147
148
 
# File 'lib/citypay_api_client/models/batch.rb', line 146

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
53
 
# File 'lib/citypay_api_client/models/batch.rb', line 50

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

.openapi_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
 
# File 'lib/citypay_api_client/models/batch.rb', line 41

def self.openapi_types
  {
    :'batch_date' => :'Date',
    :'batch_id' => :'Integer',
    :'batch_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



123
124
125
126
127
128
129
 
# File 'lib/citypay_api_client/models/batch.rb', line 123

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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
210
211
212
213
214
 
# File 'lib/citypay_api_client/models/batch.rb', line 177

def _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_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/citypay_api_client/models/batch.rb', line 248

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/citypay_api_client/models/batch.rb', line 153

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


133
134
135
 
# File 'lib/citypay_api_client/models/batch.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



139
140
141
 
# File 'lib/citypay_api_client/models/batch.rb', line 139

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

#list_invalid_properties ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/citypay_api_client/models/batch.rb', line 85

def list_invalid_properties
  invalid_properties = Array.new
  if @batch_date.nil?
    invalid_properties.push('invalid value for "batch_date", batch_date cannot be nil.')
  end

  if !@batch_id.nil? && @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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



224
225
226
 
# File 'lib/citypay_api_client/models/batch.rb', line 224

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/citypay_api_client/models/batch.rb', line 230

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



218
219
220
 
# File 'lib/citypay_api_client/models/batch.rb', line 218

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



104
105
106
107
108
109
 
# File 'lib/citypay_api_client/models/batch.rb', line 104

def valid?
  return false if @batch_date.nil?
  return false if !@batch_id.nil? && @batch_id < 1
  return false if @batch_status.nil?
  true
end