Class: OrbipayPaymentsapiClient::RecordedPayments

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb

Instance Attribute Summary collapse

Attributes inherited from Base

#api_end_point, #http_status_code, #invocation_context, #live_mode

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#requested_by, #set_api_end_point, #with_context

Constructor Details

#initialize ⇒ RecordedPayments

Returns a new instance of RecordedPayments.



58
59
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 58

def initialize
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.



21
22
23
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 21

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.



13
14
15
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 13

def has_more_results
  @has_more_results
end

#list ⇒ Array<RecordedPayment> (readonly)

Returns The attribute list.

Returns:



5
6
7
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 5

def list
  @list
end

#query_id ⇒ String (readonly)

The query id of the object.

Returns:

  • (String) —

    The attribute query_id.



29
30
31
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 29

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.



25
26
27
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 25

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.



9
10
11
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 9

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.



17
18
19
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 17

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 33

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.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 46

def self.swagger_types
  {
    :'list' => :'Array<RecordedPayment>',	
    :'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.



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 111

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
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
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 158

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 237

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 137

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

Returns:

  • (Boolean)

See Also:

  • `==` method


124
125
126
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 124

def eql?(o)
  self == o
end

#find_by(filter_map) ⇒ RecordedPayments

Returns The Instance of RecordedPayments.

Parameters:

  • filter_map (Multimap) —

    attribute in the form of MultiMap with key and values as string.

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 78

def find_by(filter_map)
    		from_index_values = filter_map["from_index"]
if (from_index_values != nil && from_index_values.length() > 0)
@from_index = from_index_values[from_index_values.length() - 1]
end
    		to_index_values = filter_map["to_index"]
if (to_index_values != nil && to_index_values.length() > 0)
@to_index = to_index_values[to_index_values.length() - 1]
end
    		query_id_values = filter_map["query_id"]
if (query_id_values != nil && query_id_values.length() > 0)
@query_id = query_id_values[query_id_values.length() - 1]
end

    self 
end

#for_client(client_key: nil) ⇒ RecordedPayments

Returns The Instance of RecordedPayments.

Parameters:

  • client_key (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



64
65
66
67
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 64

def for_client(client_key: nil)
    super(client_key: client_key)
    self 
end

#for_customer ⇒ RecordedPayments

Returns The Instance of RecordedPayments.

Returns:



96
97
98
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 96

def for_customer()
    self 
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 130

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

#set_values(args) ⇒ Object 



102
103
104
105
106
107
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 102

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



216
217
218
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 216

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



222
223
224
225
226
227
228
229
230
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 222

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



210
211
212
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 210

def to_s
  to_hash.to_s
end

#vide_channel(channel: nil) ⇒ RecordedPayments

Returns The Instance of RecordedPayments.

Parameters:

  • channel (String) (defaults to: nil) —

    attribute in the form of String.

Returns:



71
72
73
74
 
# File 'lib/orbipay_paymentsapi_client/wrappers/recorded_payments.rb', line 71

def vide_channel(channel: nil)
    super(channel: channel)
    self 
end