Class: CheckoutSdk::Issuing::IssuingClient

Inherits:
Client
  • Object
show all
Defined in:
lib/checkout_sdk/issuing/issuing_client.rb

Constant Summary collapse

ACCESS = 
'access'
CONNECT = 
'connect'
TOKEN = 
'token'
OOB = 
'oob'
AUTHENTICATION = 
'authentication'

Instance Attribute Summary

Attributes inherited from Client

#api_client, #authorization_type, #configuration

Instance Method Summary collapse

Constructor Details

#initialize(api_client, configuration) ⇒ IssuingClient

Returns a new instance of IssuingClient.

Parameters:



44
45
46
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 44

def initialize(api_client, configuration)
  super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
end

Instance Method Details

#activate_card(card_id) ⇒ Object

Parameters:

  • card_id (String) 


115
116
117
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 115

def activate_card(card_id)
  api_client.invoke_post(build_path(ISSUING, CARDS, card_id, ACTIVATE), sdk_authorization)
end

#add_target_to_control_profile(control_profile_id, target_id) ⇒ Object

Parameters:

  • control_profile_id (String)
  • target_id (String) 


270
271
272
273
274
275
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 270

def add_target_to_control_profile(control_profile_id, target_id)
  api_client.invoke_post(
    build_path(ISSUING, CONTROLS, CONTROL_PROFILES, control_profile_id, ADD, target_id),
    sdk_authorization
  )
end

#cancel_issuing_dispute(dispute_id) ⇒ Object

Parameters:

  • dispute_id (String) 


303
304
305
306
307
308
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 303

def cancel_issuing_dispute(dispute_id)
  api_client.invoke_post(
    build_path(ISSUING, DISPUTES, dispute_id, CANCEL),
    sdk_authorization
  )
end

#cancel_scheduled_card_revocation(card_id) ⇒ Object

Cancel a scheduled card revocation. DELETE /issuing/cards/cardId/schedule-revocation.

Parameters:

  • card_id (String) 


161
162
163
164
165
166
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 161

def cancel_scheduled_card_revocation(card_id)
  api_client.invoke_delete(
    build_path(ISSUING, CARDS, card_id, SCHEDULE_REVOCATION),
    sdk_authorization
  )
end

#create_card(card_request) ⇒ Object

Parameters:

  • card_request (Hash) 


78
79
80
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 78

def create_card(card_request)
  api_client.invoke_post(build_path(ISSUING, CARDS), sdk_authorization, card_request)
end

#create_cardholder(cardholder_request) ⇒ Object

Parameters:

  • cardholder_request (Hash) 


51
52
53
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 51

def create_cardholder(cardholder_request)
  api_client.invoke_post(build_path(ISSUING, CARDHOLDERS), sdk_authorization, cardholder_request)
end

#create_control(control_request) ⇒ Object

Parameters:

  • control_request (Hash) 


171
172
173
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 171

def create_control(control_request)
  api_client.invoke_post(build_path(ISSUING, CONTROLS), sdk_authorization, control_request)
end

#create_control_group(control_group_request) ⇒ Object

Parameters:



199
200
201
202
203
204
205
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 199

def create_control_group(control_group_request)
  api_client.invoke_post(
    build_path(ISSUING, CONTROLS, CONTROL_GROUPS),
    sdk_authorization,
    control_group_request
  )
end

#create_control_profile(control_profile_request) ⇒ Object

Parameters:



230
231
232
233
234
235
236
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 230

def create_control_profile(control_profile_request)
  api_client.invoke_post(
    build_path(ISSUING, CONTROLS, CONTROL_PROFILES),
    sdk_authorization,
    control_profile_request
  )
end

#create_issuing_dispute(create_dispute_request) ⇒ Object

Parameters:



289
290
291
292
293
294
295
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 289

def create_issuing_dispute(create_dispute_request)
  api_client.invoke_post(
    build_path(ISSUING, DISPUTES),
    sdk_authorization,
    create_dispute_request
  )
end

#delete_control_group(control_group_id) ⇒ Object

Parameters:

  • control_group_id (String) 


220
221
222
223
224
225
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 220

def delete_control_group(control_group_id)
  api_client.invoke_delete(
    build_path(ISSUING, CONTROLS, CONTROL_GROUPS, control_group_id),
    sdk_authorization
  )
end

#delete_control_profile(control_profile_id) ⇒ Object

Parameters:

  • control_profile_id (String) 


261
262
263
264
265
266
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 261

def delete_control_profile(control_profile_id)
  api_client.invoke_delete(
    build_path(ISSUING, CONTROLS, CONTROL_PROFILES, control_profile_id),
    sdk_authorization
  )
end

#enroll_three_ds(card_id, three_ds_request) ⇒ Object

Parameters:

  • card_id (String)
  • three_ds_request (Hash) 


99
100
101
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 99

def enroll_three_ds(card_id, three_ds_request)
  api_client.invoke_post(build_path(ISSUING, CARDS, card_id, THREE_DS), sdk_authorization, three_ds_request)
end

#escalate_issuing_dispute(dispute_id, escalate_dispute_request) ⇒ Object

Parameters:



312
313
314
315
316
317
318
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 312

def escalate_issuing_dispute(dispute_id, escalate_dispute_request)
  api_client.invoke_post(
    build_path(ISSUING, DISPUTES, dispute_id, ESCALATE),
    sdk_authorization,
    escalate_dispute_request
  )
end

#get_card_control_details(control_id) ⇒ Object

Parameters:

  • control_id (String) 


181
182
183
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 181

def get_card_control_details(control_id)
  api_client.invoke_get(build_path(ISSUING, CONTROLS, control_id), sdk_authorization)
end

#get_card_controls(controls_query) ⇒ Object

Parameters:

  • controls_query (Hash) 


176
177
178
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 176

def get_card_controls(controls_query)
  api_client.invoke_get(build_path(ISSUING, CONTROLS), sdk_authorization, controls_query)
end

#get_card_credentials(card_id, query) ⇒ Object

Parameters:

  • card_id (String)
  • query (Hash) 


121
122
123
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 121

def get_card_credentials(card_id, query)
  api_client.invoke_get(build_path(ISSUING, CARDS, card_id, CREDENTIALS), sdk_authorization, query)
end

#get_card_details(card_id) ⇒ Object

Parameters:

  • card_id (String) 


83
84
85
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 83

def get_card_details(card_id)
  api_client.invoke_get(build_path(ISSUING, CARDS, card_id), sdk_authorization)
end

#get_card_three_ds_details(card_id) ⇒ Object

Parameters:

  • card_id (String) 


110
111
112
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 110

def get_card_three_ds_details(card_id)
  api_client.invoke_get(build_path(ISSUING, CARDS, card_id, THREE_DS), sdk_authorization)
end

#get_cardholder(cardholder_id) ⇒ Object

Parameters:

  • cardholder_id (String) 


56
57
58
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 56

def get_cardholder(cardholder_id)
  api_client.invoke_get(build_path(ISSUING, CARDHOLDERS, cardholder_id), sdk_authorization)
end

#get_cardholder_cards(cardholder_id) ⇒ Object

Parameters:

  • cardholder_id (String) 


71
72
73
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 71

def get_cardholder_cards(cardholder_id)
  api_client.invoke_get(build_path(ISSUING, CARDHOLDERS, cardholder_id, CARDS), sdk_authorization)
end

#get_control_group(control_group_id) ⇒ Object

Parameters:

  • control_group_id (String) 


212
213
214
215
216
217
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 212

def get_control_group(control_group_id)
  api_client.invoke_get(
    build_path(ISSUING, CONTROLS, CONTROL_GROUPS, control_group_id),
    sdk_authorization
  )
end

#get_control_groups ⇒ Object 



207
208
209
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 207

def get_control_groups
  api_client.invoke_get(build_path(ISSUING, CONTROLS, CONTROL_GROUPS), sdk_authorization)
end

#get_control_profile(control_profile_id) ⇒ Object

Parameters:

  • control_profile_id (String) 


243
244
245
246
247
248
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 243

def get_control_profile(control_profile_id)
  api_client.invoke_get(
    build_path(ISSUING, CONTROLS, CONTROL_PROFILES, control_profile_id),
    sdk_authorization
  )
end

#get_control_profiles ⇒ Object 



238
239
240
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 238

def get_control_profiles
  api_client.invoke_get(build_path(ISSUING, CONTROLS, CONTROL_PROFILES), sdk_authorization)
end

#get_digital_card(digital_card_id) ⇒ Object

Parameters:

  • digital_card_id (String) 


342
343
344
345
346
347
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 342

def get_digital_card(digital_card_id)
  api_client.invoke_get(
    build_path(ISSUING, DIGITAL_CARDS, digital_card_id),
    sdk_authorization
  )
end

#get_issuing_dispute(dispute_id) ⇒ Object

Parameters:

  • dispute_id (String) 


298
299
300
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 298

def get_issuing_dispute(dispute_id)
  api_client.invoke_get(build_path(ISSUING, DISPUTES, dispute_id), sdk_authorization)
end

#get_transaction(transaction_id) ⇒ Object

Parameters:

  • transaction_id (String) 


332
333
334
335
336
337
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 332

def get_transaction(transaction_id)
  api_client.invoke_get(
    build_path(ISSUING, TRANSACTIONS, transaction_id),
    sdk_authorization
  )
end

#get_transactions(transactions_query = nil) ⇒ Object

Parameters:

  • transactions_query (Hash) (defaults to: nil) 


323
324
325
326
327
328
329
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 323

def get_transactions(transactions_query = nil)
  api_client.invoke_get(
    build_path(ISSUING, TRANSACTIONS),
    sdk_authorization,
    transactions_query
  )
end

#remove_card_control(control_id) ⇒ Object

Parameters:

  • control_id (String) 


192
193
194
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 192

def remove_card_control(control_id)
  api_client.invoke_delete(build_path(ISSUING, CONTROLS, control_id), sdk_authorization)
end

#remove_target_from_control_profile(control_profile_id, target_id) ⇒ Object

Parameters:

  • control_profile_id (String)
  • target_id (String) 


279
280
281
282
283
284
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 279

def remove_target_from_control_profile(control_profile_id, target_id)
  api_client.invoke_post(
    build_path(ISSUING, CONTROLS, CONTROL_PROFILES, control_profile_id, REMOVE, target_id),
    sdk_authorization
  )
end

#renew_card(card_id, renew_request = nil) ⇒ Object

Renew a card. POST /issuing/cards/cardId/renew.

Parameters:

  • card_id (String)
  • renew_request (Hash) (defaults to: nil) 


140
141
142
143
144
145
146
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 140

def renew_card(card_id, renew_request = nil)
  api_client.invoke_post(
    build_path(ISSUING, CARDS, card_id, RENEW),
    sdk_authorization,
    renew_request
  )
end

#request_cardholder_access_token(cardholder_token_request) ⇒ Object

Request a Cardholder access token. The api_client serializes the body as application/x-www-form-urlencoded.

Parameters:



400
401
402
403
404
405
406
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 400

def request_cardholder_access_token(cardholder_token_request)
  api_client.invoke_post(
    build_path(ISSUING, ACCESS, CONNECT, TOKEN),
    sdk_authorization(CheckoutSdk::AuthorizationType::OAUTH),
    cardholder_token_request
  )
end

#revoke_card(card_id, revoke_request) ⇒ Object

Parameters:

  • card_id (String)
  • revoke_request (Hash) 


127
128
129
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 127

def revoke_card(card_id, revoke_request)
  api_client.invoke_post(build_path(ISSUING, CARDS, card_id, REVOKE), sdk_authorization, revoke_request)
end

#schedule_card_revocation(card_id, schedule_revocation_request) ⇒ Object

Schedule a card revocation. POST /issuing/cards/cardId/schedule-revocation.

Parameters:



151
152
153
154
155
156
157
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 151

def schedule_card_revocation(card_id, schedule_revocation_request)
  api_client.invoke_post(
    build_path(ISSUING, CARDS, card_id, SCHEDULE_REVOCATION),
    sdk_authorization,
    schedule_revocation_request
  )
end

#simulate_authorization(authorization_request) ⇒ Object

Parameters:

  • authorization_request (Hash) 


352
353
354
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 352

def simulate_authorization(authorization_request)
  api_client.invoke_post(build_path(ISSUING, SIMULATE, AUTHORIZATIONS), sdk_authorization, authorization_request)
end

#simulate_clearing(transaction_id, clearing_request) ⇒ Object

Parameters:

  • transaction_id (String)
  • clearing_request (Hash) 


368
369
370
371
372
373
374
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 368

def simulate_clearing(transaction_id, clearing_request)
  api_client.invoke_post(
    build_path(ISSUING, SIMULATE, AUTHORIZATIONS, transaction_id, PRESENTMENTS),
    sdk_authorization,
    clearing_request
  )
end

#simulate_increment(transaction_id, increment_request) ⇒ Object

Parameters:

  • transaction_id (String)
  • increment_request (Hash) 


358
359
360
361
362
363
364
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 358

def simulate_increment(transaction_id, increment_request)
  api_client.invoke_post(
    build_path(ISSUING, SIMULATE, AUTHORIZATIONS, transaction_id, AUTHORIZATIONS),
    sdk_authorization,
    increment_request
  )
end

#simulate_oob_authentication(oob_authentication_request) ⇒ Object

Simulate an out-of-band (OOB) authentication request.

Parameters:



410
411
412
413
414
415
416
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 410

def simulate_oob_authentication(oob_authentication_request)
  api_client.invoke_post(
    build_path(ISSUING, SIMULATE, OOB, AUTHENTICATION),
    sdk_authorization(CheckoutSdk::AuthorizationType::OAUTH),
    oob_authentication_request
  )
end

#simulate_refund(transaction_id, refund_request) ⇒ Object

Simulate a refund for an authorization.

Parameters:



389
390
391
392
393
394
395
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 389

def simulate_refund(transaction_id, refund_request)
  api_client.invoke_post(
    build_path(ISSUING, SIMULATE, AUTHORIZATIONS, transaction_id, REFUNDS),
    sdk_authorization,
    refund_request
  )
end

#simulate_reversal(transaction_id, reversal_request) ⇒ Object

Parameters:

  • transaction_id (String)
  • reversal_request (Hash) 


378
379
380
381
382
383
384
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 378

def simulate_reversal(transaction_id, reversal_request)
  api_client.invoke_post(
    build_path(ISSUING, SIMULATE, AUTHORIZATIONS, transaction_id, REVERSALS),
    sdk_authorization,
    reversal_request
  )
end

#suspend_card(card_id, suspend_request) ⇒ Object

Parameters:

  • card_id (String)
  • suspend_request (Hash) 


133
134
135
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 133

def suspend_card(card_id, suspend_request)
  api_client.invoke_post(build_path(ISSUING, CARDS, card_id, SUSPEND), sdk_authorization, suspend_request)
end

#update_card(card_id, update_card_request) ⇒ Object

Parameters:



89
90
91
92
93
94
95
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 89

def update_card(card_id, update_card_request)
  api_client.invoke_patch(
    build_path(ISSUING, CARDS, card_id),
    sdk_authorization,
    update_card_request
  )
end

#update_card_control(control_id, update_control_request) ⇒ Object

Parameters:

  • control_id (String)
  • update_control_request (Hash) 


187
188
189
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 187

def update_card_control(control_id, update_control_request)
  api_client.invoke_put(build_path(ISSUING, CONTROLS, control_id), sdk_authorization, update_control_request)
end

#update_cardholder(cardholder_id, update_cardholder_request) ⇒ Object

Parameters:



62
63
64
65
66
67
68
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 62

def update_cardholder(cardholder_id, update_cardholder_request)
  api_client.invoke_patch(
    build_path(ISSUING, CARDHOLDERS, cardholder_id),
    sdk_authorization,
    update_cardholder_request
  )
end

#update_control_profile(control_profile_id, update_control_profile_request) ⇒ Object

Parameters:



252
253
254
255
256
257
258
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 252

def update_control_profile(control_profile_id, update_control_profile_request)
  api_client.invoke_patch(
    build_path(ISSUING, CONTROLS, CONTROL_PROFILES, control_profile_id),
    sdk_authorization,
    update_control_profile_request
  )
end

#update_three_ds_enrollment(card_id, three_ds_request) ⇒ Object

Parameters:

  • card_id (String)
  • three_ds_request (Hash) 


105
106
107
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 105

def update_three_ds_enrollment(card_id, three_ds_request)
  api_client.invoke_patch(build_path(ISSUING, CARDS, card_id, THREE_DS), sdk_authorization, three_ds_request)
end