Class: ShellDataReportingApIs::CustomerDetailRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/customer_detail_request.rb

Overview

CustomerDetailRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP, payer_number = SKIP, account_id = SKIP, account_number = SKIP) ⇒ CustomerDetailRequest

Returns a new instance of CustomerDetailRequest.



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 88

def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
               payer_number = SKIP,  = SKIP,
                = SKIP)
  @col_co_id = col_co_id unless col_co_id == SKIP
  @col_co_code = col_co_code unless col_co_code == SKIP
  @payer_id = payer_id unless payer_id == SKIP
  @payer_number = payer_number unless payer_number == SKIP
  @account_id =  unless  == SKIP
  @account_number =  unless  == SKIP
end

Instance Attribute Details

#account_id ⇒ Integer

Account ID of the customer. Optional if AccountNumber is passed else Mandatory.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 45

def 
  @account_id
end

#account_number ⇒ String

Account Number of the customer. Optional if AccountId is passed else Mandatory.

Returns:

  • (String) 


50
51
52
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 50

def 
  @account_number
end

#col_co_code ⇒ Integer

Collecting Company Code (Shell Code) of the selected payer. Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided. Example: 86-Philippines 5-UK

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 27

def col_co_code
  @col_co_code
end

#col_co_id ⇒ Integer

Collecting Company Id (in GFN) of the selected payer. Optional if ColCoCode is passed else Mandatory. Example: 1-Philippines 5-UK

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 18

def col_co_id
  @col_co_id
end

#payer_id ⇒ Integer

Payer Id (i.e., Customer Id of the Payment Customer in H3 Cards Platform) of the selected payer. Optional if PayerNumber is passed else Mandatory Example: 123456

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 34

def payer_id
  @payer_id
end

#payer_number ⇒ String

Payer Number of the selected payer. Optional if PayerId is passed else Mandatory Example: GB000000123

Returns:

  • (String) 


40
41
42
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 40

def payer_number
  @payer_number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 100

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
  col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
  payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
  payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
   = hash.key?('AccountId') ? hash['AccountId'] : SKIP
   = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP

  # Create object from extracted values.
  CustomerDetailRequest.new(col_co_id,
                            col_co_code,
                            payer_id,
                            payer_number,
                            ,
                            )
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['col_co_id'] = 'ColCoId'
  @_hash['col_co_code'] = 'ColCoCode'
  @_hash['payer_id'] = 'PayerId'
  @_hash['payer_number'] = 'PayerNumber'
  @_hash['account_id'] = 'AccountId'
  @_hash['account_number'] = 'AccountNumber'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/shell_data_reporting_ap_is/models/customer_detail_request.rb', line 77

def self.nullables
  %w[
    col_co_id
    col_co_code
    payer_id
    payer_number
    account_id
    account_number
  ]
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    col_co_id
    col_co_code
    payer_id
    payer_number
    account_id
    account_number
  ]
end