Class: CityPayApiClient::RemittanceReportRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RemittanceReportRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 71

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::RemittanceReportRequest` 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::RemittanceReportRequest`. 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?(:'date_from')
    self.date_from = attributes[:'date_from']
  end

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

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

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

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

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

Instance Attribute Details

#date_from ⇒ Object

Start date (YYYY-MM-DD) for batch Retrieval range, inclusive. Maximum value is 3 years ago.



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

def date_from
  @date_from
end

#date_until ⇒ Object

End date (YYYY-MM-DD) for batch Retrieval range, inclusive.



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

def date_until
  @date_until
end

#max_results ⇒ Object

The maximum number of results to return in a single response. This value is used to limit the size of data returned by the API, enhancing performance and manageability. Values should be between 5 and 250.



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

def max_results
  @max_results
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



26
27
28
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 26

def merchant_id
  @merchant_id
end

#next_token ⇒ Object

A token that identifies the starting point of the page of results to be returned. An empty value indicates the start of the dataset. When supplied, it is validated and used to fetch the subsequent page of results. This token is typically obtained from the response of a previous pagination request.



29
30
31
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 29

def next_token
  @next_token
end

#order_by ⇒ Object

Specifies the field by which results are ordered. Available fields are [trans_no,date_when,amount]. By default, fields are ordered by OrderByExpression(trans_no,ASC). To order in descending order, prefix with ‘-’ or suffix with ‘ DESC’.



32
33
34
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 32

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



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
215
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 178

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



47
48
49
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 47

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'date_from' => :'date_from',
    :'date_until' => :'date_until',
    :'max_results' => :'maxResults',
    :'merchant_id' => :'merchant_id',
    :'next_token' => :'nextToken',
    :'order_by' => :'orderBy'
  }
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



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/remittance_report_request.rb', line 154

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



64
65
66
67
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 52

def self.openapi_types
  {
    :'date_from' => :'Date',
    :'date_until' => :'Date',
    :'max_results' => :'Integer',
    :'merchant_id' => :'Array<Integer>',
    :'next_token' => :'String',
    :'order_by' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_from == o.date_from &&
      date_until == o.date_until &&
      max_results == o.max_results &&
      merchant_id == o.merchant_id &&
      next_token == o.next_token &&
      order_by == o.order_by
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



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

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



147
148
149
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 147

def hash
  [date_from, date_until, max_results, merchant_id, next_token, order_by].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



113
114
115
116
117
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 113

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 225

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



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

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

Returns:

  • (String) —

    String presentation of the object



219
220
221
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 219

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



121
122
123
124
 
# File 'lib/citypay_api_client/models/remittance_report_request.rb', line 121

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