Class: ShellCardManagementApIs::CardRestrictionReq

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

Overview

CardRestrictionReq 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, cards = SKIP) ⇒ CardRestrictionReq

Returns a new instance of CardRestrictionReq.



79
80
81
82
83
84
85
86
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 79

def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
               payer_number = SKIP, cards = 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
  @cards = cards unless cards == SKIP
end

Instance Attribute Details

#cards ⇒ RestrictionCardsList

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

Returns:



45
46
47
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 45

def cards
  @cards
end

#col_co_code ⇒ Integer

Collecting Company 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 for Philippines 5 for UK

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 27

def col_co_code
  @col_co_code
end

#col_co_id ⇒ Integer

Collecting Company Id of the selected payer. Optional if ColCoCode is passed else Mandatory. Example: 1 for Philippines 5 for UK

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 18

def col_co_id
  @col_co_id
end

#payer_id ⇒ Integer

Payer Id of the selected payer. Optional if PayerNumber is passed else Mandatory Example: 123456

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 33

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) 


39
40
41
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 39

def payer_number
  @payer_number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 89

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
  cards = RestrictionCardsList.from_hash(hash['Cards']) if hash['Cards']

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

.names ⇒ Object

A mapping from model property names to API property names.



48
49
50
51
52
53
54
55
56
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 48

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['cards'] = 'Cards'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



70
71
72
73
74
75
76
77
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 70

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

.optionals ⇒ Object

An array for optional fields



59
60
61
62
63
64
65
66
67
 
# File 'lib/shell_card_management_ap_is/models/card_restriction_req.rb', line 59

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