Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::RecordedPaymentsResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecordedPaymentsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 79

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'total_results_count')
    self.total_results_count = attributes[:'total_results_count']
  end

  if attributes.has_key?(:'has_more_results')
    self.has_more_results = attributes[:'has_more_results']
  end

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'from_index')
    self.from_index = attributes[:'from_index']
  end

  if attributes.has_key?(:'to_index')
    self.to_index = attributes[:'to_index']
  end

  if attributes.has_key?(:'query_id')
    self.query_id = attributes[:'query_id']
  end
end

Instance Attribute Details

#from_index ⇒ String (readonly)

The id of the object before which the previous set of objects are to be retrieved.

Returns:

  • (String) —

    The attribute from_index.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 41

def from_index
  @from_index
end

#has_more_results ⇒ String (readonly)

true if there are more results or pages

Returns:

  • (String) —

    The attribute has_more_results.



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 33

def has_more_results
  @has_more_results
end

#list ⇒ Array<GetRecordedPaymentResponse> (readonly)

Returns The attribute list.

Returns:



25
26
27
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 25

def list
  @list
end

#query_id ⇒ String (readonly)

The query id of the object.

Returns:

  • (String) —

    The attribute query_id.



49
50
51
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 49

def query_id
  @query_id
end

#to_index ⇒ String (readonly)

The id of the object after which the next set of objects are to be retrieved.

Returns:

  • (String) —

    The attribute to_index.



45
46
47
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 45

def to_index
  @to_index
end

#total_results_count ⇒ String (readonly)

total number of payments available with matching criteria

Returns:

  • (String) —

    The attribute total_results_count.



29
30
31
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 29

def total_results_count
  @total_results_count
end

#url ⇒ String (readonly)

This URL fetches the next or previous set of payments, based on the presence of after_object or before_object parameter.

Returns:

  • (String) —

    The attribute url.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 37

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'list' => :'list',
    :'total_results_count' => :'total_results_count',
    :'has_more_results' => :'has_more_results',
    :'url' => :'url',
    :'from_index' => :'from_index',
    :'to_index' => :'to_index',
    :'query_id' => :'query_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 65

def self.swagger_types
  {
    :'list' => :'Array<GetRecordedPaymentResponse>',
    :'total_results_count' => :'String',
    :'has_more_results' => :'String',
    :'url' => :'String',
    :'from_index' => :'String',
    :'to_index' => :'String',
    :'query_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      list == o.list &&
      total_results_count == o.total_results_count &&
      has_more_results == o.has_more_results &&
      url == o.url &&
      from_index == o.from_index &&
      to_index == o.to_index &&
      query_id == o.query_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 175

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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
    temp_model = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 254

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

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
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 154

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      set_values(key => _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • o (Object) —

    Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 147

def hash
  [list, total_results_count, has_more_results, url, from_index, to_index, query_id].hash
end

#set_values(args) ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 117

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



233
234
235
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 233

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



239
240
241
242
243
244
245
246
247
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 239

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



227
228
229
 
# File 'lib/orbipay_paymentsapi_client/models/recorded_payments_response.rb', line 227

def to_s
  to_hash.to_s
end