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:



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

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) 


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

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) 


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

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

#amend_issuing_dispute(dispute_id, amend_dispute_request = nil) ⇒ Object

Amend an Issuing dispute. POST /issuing/disputes/disputeId/amend. Submit an amendment to a dispute that is currently blocked from proceeding. Handles both chargeback-stage and escalation-stage amendments using the same payload.

Parameters:



319
320
321
322
323
324
325
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 319

def amend_issuing_dispute(dispute_id, amend_dispute_request = nil)
  api_client.invoke_post(
    build_path(ISSUING, DISPUTES, dispute_id, AMEND),
    sdk_authorization,
    amend_dispute_request
  )
end

#cancel_issuing_dispute(dispute_id) ⇒ Object

Parameters:

  • dispute_id (String) 


284
285
286
287
288
289
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 284

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

#create_card(card_request) ⇒ Object

Parameters:

  • card_request (Hash) 


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

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) 


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

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) 


152
153
154
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 152

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:



180
181
182
183
184
185
186
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 180

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:



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

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:



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

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) 


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

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) 


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

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) 


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

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:



293
294
295
296
297
298
299
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 293

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) 


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

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) 


157
158
159
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 157

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


193
194
195
196
197
198
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 193

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 



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

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) 


224
225
226
227
228
229
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 224

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 



219
220
221
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 219

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) 


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

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) 


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

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) 


339
340
341
342
343
344
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 339

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) 


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

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) 


173
174
175
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 173

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) 


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

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) 


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

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:



407
408
409
410
411
412
413
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 407

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) 


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

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

#simulate_authorization(authorization_request) ⇒ Object

Parameters:

  • authorization_request (Hash) 


359
360
361
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 359

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) 


375
376
377
378
379
380
381
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 375

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) 


365
366
367
368
369
370
371
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 365

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:



417
418
419
420
421
422
423
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 417

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:



396
397
398
399
400
401
402
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 396

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) 


385
386
387
388
389
390
391
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 385

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

#submit_issuing_dispute(dispute_id, submit_dispute_request = nil) ⇒ Object

Deprecated.

Use #create_issuing_dispute to create and submit a dispute in one step, or #amend_issuing_dispute when the dispute status is action_required.

Submit an Issuing dispute. POST /issuing/disputes/disputeId/submit.

Parameters:



306
307
308
309
310
311
312
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 306

def submit_issuing_dispute(dispute_id, submit_dispute_request = nil)
  api_client.invoke_post(
    build_path(ISSUING, DISPUTES, dispute_id, SUBMIT),
    sdk_authorization,
    submit_dispute_request
  )
end

#suspend_card(card_id, suspend_request) ⇒ Object

Parameters:

  • card_id (String)
  • suspend_request (Hash) 


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

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:



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

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) 


168
169
170
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 168

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:



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

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:



233
234
235
236
237
238
239
 
# File 'lib/checkout_sdk/issuing/issuing_client.rb', line 233

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) 


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

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