Class: ShellCardManagementApIs::UpdateCardGroupRequest

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

Overview

UpdateCardGroupRequest 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_code = SKIP, col_co_id = SKIP, payer_number = SKIP, payer_id = SKIP, account_id = SKIP, account_number = SKIP, card_group_id = SKIP, card_group_name = SKIP, print_on_card = SKIP, card_type_id = SKIP, terminate_card_group = SKIP, move_cards = SKIP, target_account_id = SKIP, target_account_number = SKIP, target_new_card_group_name = SKIP, target_card_group_id = SKIP) ⇒ UpdateCardGroupRequest

Returns a new instance of UpdateCardGroupRequest.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 174

def initialize(col_co_code = SKIP, col_co_id = SKIP, payer_number = SKIP,
               payer_id = SKIP,  = SKIP,  = SKIP,
               card_group_id = SKIP, card_group_name = SKIP,
               print_on_card = SKIP, card_type_id = SKIP,
               terminate_card_group = SKIP, move_cards = SKIP,
                = SKIP,  = SKIP,
               target_new_card_group_name = SKIP,
               target_card_group_id = SKIP)
  @col_co_code = col_co_code unless col_co_code == SKIP
  @col_co_id = col_co_id unless col_co_id == SKIP
  @payer_number = payer_number unless payer_number == SKIP
  @payer_id = payer_id unless payer_id == SKIP
  @account_id =  unless  == SKIP
  @account_number =  unless  == SKIP
  @card_group_id = card_group_id unless card_group_id == SKIP
  @card_group_name = card_group_name unless card_group_name == SKIP
  @print_on_card = print_on_card unless print_on_card == SKIP
  @card_type_id = card_type_id unless card_type_id == SKIP
  @terminate_card_group = terminate_card_group unless terminate_card_group == SKIP
  @move_cards = move_cards unless move_cards == SKIP
  @target_account_id =  unless  == SKIP
  @target_account_number =  unless  == SKIP
  unless target_new_card_group_name == SKIP
    @target_new_card_group_name =
      target_new_card_group_name
  end
  @target_card_group_id = target_card_group_id unless target_card_group_id == SKIP
end

Instance Attribute Details

#account_id ⇒ Integer

Account ID of the card-group to be updated/terminated.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 43

def 
  @account_id
end

#account_number ⇒ String

Account Number of the card-group to be updated/terminated.

Returns:

  • (String) 


47
48
49
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 47

def 
  @account_number
end

#card_group_id ⇒ Integer

Unique Id of the card group that needs to be updated or terminated.

Returns:

  • (Integer) 


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

def card_group_id
  @card_group_id
end

#card_group_name ⇒ String

New name for the card group if it needs to be updated. Set this field to ‘null’ if no change required to the current card group name. Optional Minimum length: 1 (Configurable) Maximum length: 40 (Configurable) Allowed characters (Configurable) are: - A-Z 0-9, / ‘. & Ä Ö Ü Å Æ É Ø Note: The card group name has to be unique for customer. Else an error with error code 9015 is returned.

Returns:

  • (String) 


62
63
64
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 62

def card_group_name
  @card_group_name
end

#card_type_id ⇒ Integer

Card Type ID of the card group. Populate this field if the value needs to be updated. Otherwise set to ‘null’. Optional Note: 1) If a card type is passed, the cardgorup will allow cards with same card type to be moved in to the card group. 2) Pass ‘-1’ to remove the card type from the card group.

Returns:

  • (Integer) 


79
80
81
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 79

def card_type_id
  @card_type_id
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) 


19
20
21
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 19

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

Returns:

  • (Integer) 


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

def col_co_id
  @col_co_id
end

#move_cards ⇒ TrueClass | FalseClass

Whether to move the cards from this CardGroup in to a different or a new CardGroup. Optional When the value is set to ‘False’ or ‘null’, the cards that are currently in the card-group will remain under the same card-group.

Returns:

  • (TrueClass | FalseClass) 


94
95
96
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 94

def move_cards
  @move_cards
end

#payer_id ⇒ Integer

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

Returns:

  • (Integer) 


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

def payer_id
  @payer_id
end

#payer_number ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 32

def payer_number
  @payer_number
end

#print_on_card ⇒ TrueClass | FalseClass

Whether to emboss the card group name on the cards. Populate this field only if the value needs to be updated. Otherwise set to ‘null’.

Returns:

  • (TrueClass | FalseClass) 


68
69
70
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 68

def print_on_card
  @print_on_card
end

#target_account_id ⇒ Integer

Account ID of the new/target card-group. Either TargetAccountId or TargetAccountNumber is mandatory when MoveCards is set to True.

Returns:

  • (Integer) 


100
101
102
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 100

def 
  @target_account_id
end

#target_account_number ⇒ String

Account Number of the new/target card-group. Either TargetAccountId or TargetAccountNumber is mandatory when MoveCards is set to True.

Returns:

  • (String) 


106
107
108
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 106

def 
  @target_account_number
end

#target_card_group_id ⇒ Integer

ID of the card group if the cards in the existing card-group have to be moved to another existing card-group. Mandatory when MoveCards parameter is True and TargetNewCardGroupName is null. If the value is “-1” then the cards will be moved out of the current CardGroup.

Returns:

  • (Integer) 


123
124
125
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 123

def target_card_group_id
  @target_card_group_id
end

#target_new_card_group_name ⇒ String

Name of the new card group if the cards in the existing card-group have to be moved to a new card-group. Mandatory when MoveCards parameter is True and TargetCardGroupId is null. Minimum length: 1 (Configurable) Maximum length: 30 (Configurable)

Returns:

  • (String) 


114
115
116
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 114

def target_new_card_group_name
  @target_new_card_group_name
end

#terminate_card_group ⇒ TrueClass | FalseClass

Whether to terminate the card group. When set to true, the card group will be terminated by setting current date as it’s termination date. Optional, False by default .

Returns:

  • (TrueClass | FalseClass) 


86
87
88
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 86

def terminate_card_group
  @terminate_card_group
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 204

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
  payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
  payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
   = hash.key?('AccountId') ? hash['AccountId'] : SKIP
   = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
  card_group_id = hash.key?('CardGroupId') ? hash['CardGroupId'] : SKIP
  card_group_name =
    hash.key?('CardGroupName') ? hash['CardGroupName'] : SKIP
  print_on_card = hash.key?('PrintOnCard') ? hash['PrintOnCard'] : SKIP
  card_type_id = hash.key?('CardTypeId') ? hash['CardTypeId'] : SKIP
  terminate_card_group =
    hash.key?('TerminateCardGroup') ? hash['TerminateCardGroup'] : SKIP
  move_cards = hash.key?('MoveCards') ? hash['MoveCards'] : SKIP
   =
    hash.key?('TargetAccountId') ? hash['TargetAccountId'] : SKIP
   =
    hash.key?('TargetAccountNumber') ? hash['TargetAccountNumber'] : SKIP
  target_new_card_group_name =
    hash.key?('TargetNewCardGroupName') ? hash['TargetNewCardGroupName'] : SKIP
  target_card_group_id =
    hash.key?('TargetCardGroupId') ? hash['TargetCardGroupId'] : SKIP

  # Create object from extracted values.
  UpdateCardGroupRequest.new(col_co_code,
                             col_co_id,
                             payer_number,
                             payer_id,
                             ,
                             ,
                             card_group_id,
                             card_group_name,
                             print_on_card,
                             card_type_id,
                             terminate_card_group,
                             move_cards,
                             ,
                             ,
                             target_new_card_group_name,
                             target_card_group_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['col_co_code'] = 'ColCoCode'
  @_hash['col_co_id'] = 'ColCoId'
  @_hash['payer_number'] = 'PayerNumber'
  @_hash['payer_id'] = 'PayerId'
  @_hash['account_id'] = 'AccountId'
  @_hash['account_number'] = 'AccountNumber'
  @_hash['card_group_id'] = 'CardGroupId'
  @_hash['card_group_name'] = 'CardGroupName'
  @_hash['print_on_card'] = 'PrintOnCard'
  @_hash['card_type_id'] = 'CardTypeId'
  @_hash['terminate_card_group'] = 'TerminateCardGroup'
  @_hash['move_cards'] = 'MoveCards'
  @_hash['target_account_id'] = 'TargetAccountId'
  @_hash['target_account_number'] = 'TargetAccountNumber'
  @_hash['target_new_card_group_name'] = 'TargetNewCardGroupName'
  @_hash['target_card_group_id'] = 'TargetCardGroupId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



170
171
172
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 170

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/shell_card_management_ap_is/models/update_card_group_request.rb', line 148

def self.optionals
  %w[
    col_co_code
    col_co_id
    payer_number
    payer_id
    account_id
    account_number
    card_group_id
    card_group_name
    print_on_card
    card_type_id
    terminate_card_group
    move_cards
    target_account_id
    target_account_number
    target_new_card_group_name
    target_card_group_id
  ]
end