Class: ShellCardManagementApIs::PINReminderRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_card_management_ap_is/models/pin_reminder_request.rb

Overview

This entity models the data that is received in the https request body of the PINReminder operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

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

Returns a new instance of PINReminderRequest.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 84

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

Instance Attribute Details

#account_id ⇒ Integer

Account Id of the customer.<br /> Optional if AccountNumber is passed, else Mandatory.<br /> This input is a search criterion, if given.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 17

def 
  @account_id
end

#account_number ⇒ String

Account Number of the customer.<br /> Optional if AccountId is passed, else Mandatory.<br /> This input is a search criterion, if given.

Returns:

  • (String) 


23
24
25
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 23

def 
  @account_number
end

#col_co_code ⇒ Integer

Collecting Company Code (Shell Code) of the selected payer. <br /> Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. <br /> It is optional for other countries if ColCoID is provided.

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 30

def col_co_code
  @col_co_code
end

#col_co_id ⇒ Integer

Collecting Company Id of the selected payer<br /> Optional if ColCoCode is passed else Mandatory.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 35

def col_co_id
  @col_co_id
end

#payer_id ⇒ Integer

Payer Id (i.e. Customer Id of the Payment Customer of the selected payer.<br /> Optional if PayerNumber is passed else Mandatory

Returns:

  • (Integer) 


41
42
43
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 41

def payer_id
  @payer_id
end

#payer_number ⇒ String

Payer Number (Ex: GB000000123) of the selected payer.<br /> Optional if PayerId is passed else Mandatory

Returns:

  • (String) 


46
47
48
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 46

def payer_number
  @payer_number
end

#pin_reminder_card_details ⇒ Array[PINReminderCardDetails]

List of PINReminderCardDetails entity. The fields of this entity are described below.

Returns:



51
52
53
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 51

def pin_reminder_card_details
  @pin_reminder_card_details
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
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 100

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   = hash.key?('AccountId') ? hash['AccountId'] : SKIP
   = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
  col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
  payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
  payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
  # Parameter is an array, so we need to iterate through it
  pin_reminder_card_details = nil
  unless hash['PINReminderCardDetails'].nil?
    pin_reminder_card_details = []
    hash['PINReminderCardDetails'].each do |structure|
      pin_reminder_card_details << (PINReminderCardDetails.from_hash(structure) if structure)
    end
  end

  pin_reminder_card_details = SKIP unless hash.key?('PINReminderCardDetails')

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

.names ⇒ Object

A mapping from model property names to API property names.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 54

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

.nullables ⇒ Object

An array for nullable fields



80
81
82
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 80

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/shell_card_management_ap_is/models/pin_reminder_request.rb', line 67

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