Class: CityPayApiClient::ProcessBatchRequest
- Inherits:
-
Object
- Object
- CityPayApiClient::ProcessBatchRequest
- Defined in:
- lib/citypay_api_client/models/process_batch_request.rb
Instance Attribute Summary collapse
-
#batch_date ⇒ Object
The date and time that the file was created in ISO-8601 format.
-
#batch_id ⇒ Object
The id is a referencable id for the batch that should be generated by your integration.
-
#client_account_id ⇒ Object
The batch account id to process the batch for.
-
#transactions ⇒ Object
Returns the value of attribute transactions.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ProcessBatchRequest
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ProcessBatchRequest
Initializes the object
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 61 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::ProcessBatchRequest` 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::ProcessBatchRequest`. 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'] 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?(:'client_account_id') self.client_account_id = attributes[:'client_account_id'] 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
#batch_date ⇒ Object
The date and time that the file was created in ISO-8601 format.
18 19 20 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 18 def batch_date @batch_date end |
#batch_id ⇒ Object
The id is a referencable id for the batch that should be generated by your integration. Its recommended to use an incremental id to help determine if a batch has been skipped or missed. The id is used by reporting systems to reference the unique batch alongside your client id.
21 22 23 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 21 def batch_id @batch_id end |
#client_account_id ⇒ Object
The batch account id to process the batch for. Defaults to your client id if not provided.
24 25 26 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 24 def client_account_id @client_account_id end |
#transactions ⇒ Object
Returns the value of attribute transactions.
26 27 28 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 26 def transactions @transactions end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 226 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_attributes ⇒ Object
Returns all the JSON keys this model knows about
39 40 41 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 39 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
29 30 31 32 33 34 35 36 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 29 def self.attribute_map { :'batch_date' => :'batch_date', :'batch_id' => :'batch_id', :'client_account_id' => :'client_account_id', :'transactions' => :'transactions' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 202 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
54 55 56 57 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 54 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
44 45 46 47 48 49 50 51 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 44 def self.openapi_types { :'batch_date' => :'Date', :'batch_id' => :'Integer', :'client_account_id' => :'String', :'transactions' => :'Array<BatchTransaction>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
178 179 180 181 182 183 184 185 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 178 def ==(o) return true if self.equal?(o) self.class == o.class && batch_date == o.batch_date && batch_id == o.batch_id && client_account_id == o.client_account_id && 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
297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 297 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
189 190 191 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 189 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
195 196 197 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 195 def hash [batch_date, batch_id, client_account_id, transactions].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 101 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' 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? 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 !@client_account_id.nil? && @client_account_id.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 !@client_account_id.nil? && @client_account_id.to_s.length < 3 invalid_properties.push('invalid value for "client_account_id", the character length must be great 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)
273 274 275 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 273 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 279 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
267 268 269 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 267 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
133 134 135 136 137 138 139 140 141 142 |
# File 'lib/citypay_api_client/models/process_batch_request.rb', line 133 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @batch_date.nil? return false if @batch_id.nil? return false if @batch_id < 1 return false if !@client_account_id.nil? && @client_account_id.to_s.length > 20 return false if !@client_account_id.nil? && @client_account_id.to_s.length < 3 return false if @transactions.nil? true end |