Class: ShellCardManagementApIs::AccountRestrictionRequest

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

Overview

AccountRestrictionRequest 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, reset_usage_restrictions = SKIP, usage_restrictions = SKIP) ⇒ AccountRestrictionRequest

Returns a new instance of AccountRestrictionRequest.



108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/shell_card_management_ap_is/models/account_restriction_request.rb', line 108

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

Instance Attribute Details

#account_id ⇒ Integer

Account ID of the customer on which the restrictions will be applied. Optional if AccountNumber is passed, else Mandatory. Example: 123456

Returns:

  • (Integer) 


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

def 
  @account_id
end

#account_number ⇒ String

Account Number of the customer on which the restrictions will be applied. Optional if AccountId is passed, else Mandatory. Example: GB000000123

Returns:

  • (String) 


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

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

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/shell_card_management_ap_is/models/account_restriction_request.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/account_restriction_request.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/account_restriction_request.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/account_restriction_request.rb', line 39

def payer_number
  @payer_number
end

#reset_usage_restrictions ⇒ TrueClass | FalseClass

True/False. If true, the usage restrictions applied on the account will be removed. Optional Default: False

Returns:

  • (TrueClass | FalseClass) 


58
59
60
 
# File 'lib/shell_card_management_ap_is/models/account_restriction_request.rb', line 58

def reset_usage_restrictions
  @reset_usage_restrictions
end

#usage_restrictions ⇒ Object

True/False. If true, the usage restrictions applied on the account will be removed. Optional Default: False

Returns:

  • (Object) 


65
66
67
 
# File 'lib/shell_card_management_ap_is/models/account_restriction_request.rb', line 65

def usage_restrictions
  @usage_restrictions
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/shell_card_management_ap_is/models/account_restriction_request.rb', line 123

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
  reset_usage_restrictions =
    hash.key?('ResetUsageRestrictions') ? hash['ResetUsageRestrictions'] : SKIP
  usage_restrictions =
    hash.key?('UsageRestrictions') ? hash['UsageRestrictions'] : SKIP

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

.names ⇒ Object

A mapping from model property names to API property names.



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

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['reset_usage_restrictions'] = 'ResetUsageRestrictions'
  @_hash['usage_restrictions'] = 'UsageRestrictions'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/shell_card_management_ap_is/models/account_restriction_request.rb', line 96

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

.optionals ⇒ Object

An array for optional fields



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/shell_card_management_ap_is/models/account_restriction_request.rb', line 82

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