Class: OrbipayPaymentsapiClient::Customers

Inherits:
Base
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/customers.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 ⇒ Customers

Returns a new instance of Customers.



88
89
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 88

def initialize
end

Instance Attribute Details

#account_number ⇒ String (readonly)

Customer Account Number of the customer to get details of.

Returns:

  • (String) —

    The attribute account_number.



49
50
51
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 49

def 
  @account_number
end

#customer_reference ⇒ String (readonly)

Unique ID assigned by the biller/client system for a given customer.

Returns:

  • (String) —

    The attribute customer_reference.



37
38
39
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 37

def customer_reference
  @customer_reference
end

#email ⇒ String (readonly)

This field contains the customer’s email address within EBPP.

Returns:

  • (String) —

    The attribute email.



45
46
47
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 45

def email
  @email
end

#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/customers.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/customers.rb', line 13

def has_more_results
  @has_more_results
end

#list ⇒ Array<Customer> (readonly)

Returns The attribute list.

Returns:

  • (Array<Customer>) —

    The attribute list.



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

def list
  @list
end

#page_size ⇒ String (readonly)

The maximum number of objects returned in the query.

Returns:

  • (String) —

    The attribute page_size.



33
34
35
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 33

def page_size
  @page_size
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/customers.rb', line 29

def query_id
  @query_id
end

#ssn ⇒ String (readonly)

The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

Returns:

  • (String) —

    The attribute ssn.



41
42
43
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 41

def ssn
  @ssn
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/customers.rb', line 25

def to_index
  @to_index
end

#total_results_count ⇒ String (readonly)

The total number of customers available matching the search criteria.

Returns:

  • (String) —

    The attribute total_results_count.



9
10
11
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.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/customers.rb', line 17

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 53

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', 
    :'page_size' => :'page_size', 
    :'customer_reference' => :'customer_reference', 
    :'ssn' => :'ssn', 
    :'email' => :'email', 
    :'account_number' => :'account_number' 
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 71

def self.swagger_types
  {
    :'list' => :'Array<Customer>',	
    :'total_results_count' => :'String',	
    :'has_more_results' => :'String',	
    :'url' => :'String',	
    :'from_index' => :'String',	
    :'to_index' => :'String',	
    :'query_id' => :'String',	
    :'page_size' => :'String',	
    :'customer_reference' => :'String',	
    :'ssn' => :'String',	
    :'email' => :'String',	
    :'account_number' => :'String'	
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 190

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 &&
      page_size == o.page_size &&
      customer_reference == o.customer_reference &&
      ssn == o.ssn &&
      email == o.email &&
       == o.
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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 242

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 321

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 221

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


208
209
210
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 208

def eql?(o)
  self == o
end

#find_by(filter_map) ⇒ Customers

Returns The Instance of Customers.

Parameters:

  • filter_map (Multimap) —

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

Returns:



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 108

def find_by(filter_map)
    		customer_reference_values = filter_map["customer_reference"]
if (customer_reference_values != nil && customer_reference_values.length() > 0)
@customer_reference = customer_reference_values[customer_reference_values.length() - 1]
end
    		ssn_values = filter_map["ssn"]
if (ssn_values != nil && ssn_values.length() > 0)
@ssn = ssn_values[ssn_values.length() - 1]
end
    		email_values = filter_map["email"]
if (email_values != nil && email_values.length() > 0)
@email = email_values[email_values.length() - 1]
end
    		 = filter_map["account_number"]
if ( != nil && .length() > 0)
@account_number = [.length() - 1]
end
    		page_size_values = filter_map["page_size"]
if (page_size_values != nil && page_size_values.length() > 0)
@page_size = page_size_values[page_size_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
    		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

    self 
end

#for_client(client_key: nil) ⇒ Customers

Returns The Instance of Customers.

Parameters:

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

    attribute in the form of String.

Returns:



94
95
96
97
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 94

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

#get(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Customers

Returns The Instance of Customers.

Returns:



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 154

def get(invocation_context: nil, live_mode: nil, api_end_point: nil)
	begin
		Base.instance_method(:with_context).bind(self).call(invocation_context, live_mode: live_mode, api_end_point: api_end_point)
    	OrbipayPaymentsapiClientHandlers::RetrieveCustomersHandler.new.process(self)
		rescue ApiError => e
			raise OrbipayApiError.new(http_status_code: e.code, response_headers: e.response_headers, timed_out:e.timed_out, response_body: e.response_body, message: e.message,  masked_authorization_string: e.masked_authorization_string, http_request_body: e.request_body, http_request_headers: e.request_headers),nil, e.backtrace
		rescue StandardError => e
			raise OrbipayApiError.new(message: e.message),nil, e.backtrace
		end
end

#get_page(invocation_context: nil, live_mode: nil, api_end_point: nil) ⇒ Customers

Returns The Instance of Customers.

Returns:



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 167

def get_page(invocation_context: nil, live_mode: nil, api_end_point: nil)
	begin
		Base.instance_method(:with_context).bind(self).call(invocation_context, live_mode: live_mode, api_end_point: api_end_point)
    	OrbipayPaymentsapiClientHandlers::RetrieveCustomersPageHandler.new.process(self)
		rescue ApiError => e
			raise OrbipayApiError.new(http_status_code: e.code, response_headers: e.response_headers, timed_out:e.timed_out, response_body: e.response_body, message: e.message,  masked_authorization_string: e.masked_authorization_string, http_request_body: e.request_body, http_request_headers: e.request_headers),nil, e.backtrace
		rescue StandardError => e
			raise OrbipayApiError.new(message: e.message),nil, e.backtrace
		end
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



214
215
216
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 214

def hash
  [list, total_results_count, has_more_results, url, from_index, to_index, query_id, page_size, customer_reference, ssn, email, ].hash
end

#retrieved_by(requestor: nil, requestor_type: nil) ⇒ Customers

Returns The Instance of Customers.

Parameters:

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

    attribute in the form of String.

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

    attribute in the form of String.

Returns:



148
149
150
151
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 148

def retrieved_by(requestor: nil, requestor_type: nil)
    Base.instance_method(:requested_by).bind(self).call(requestor: requestor, requestor_type: requestor_type)
    self
end

#set_values(args) ⇒ Object 



181
182
183
184
185
186
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 181

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



300
301
302
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 300

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



306
307
308
309
310
311
312
313
314
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 306

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



294
295
296
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 294

def to_s
  to_hash.to_s
end

#vide_channel(channel: nil) ⇒ Customers

Returns The Instance of Customers.

Parameters:

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

    attribute in the form of String.

Returns:



101
102
103
104
 
# File 'lib/orbipay_paymentsapi_client/wrappers/customers.rb', line 101

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