Class: Stripe::Terminal::ReaderService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/terminal/reader_service.rb

Defined Under Namespace

Classes: CancelActionParams, CollectInputsParams, CreateParams, DeleteParams, ListParams, ProcessPaymentIntentParams, ProcessSetupIntentParams, RefundPaymentParams, RetrieveParams, SetReaderDisplayParams, UpdateParams

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#cancel_action(reader, params = {}, opts = {}) ⇒ Object

Cancels the current reader action.



367
368
369
370
371
372
373
374
375
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 367

def cancel_action(reader, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#collect_inputs(reader, params = {}, opts = {}) ⇒ Object

Initiates an input collection flow on a Reader.



378
379
380
381
382
383
384
385
386
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 378

def collect_inputs(reader, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#create(params = {}, opts = {}) ⇒ Object

Creates a new Reader object.



389
390
391
392
393
394
395
396
397
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 389

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v1/terminal/readers",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#delete(reader, params = {}, opts = {}) ⇒ Object

Deletes a Reader object.



400
401
402
403
404
405
406
407
408
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 400

def delete(reader, params = {}, opts = {})
  request(
    method: :delete,
    path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

Returns a list of Reader objects.



411
412
413
414
415
416
417
418
419
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 411

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v1/terminal/readers",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#process_payment_intent(reader, params = {}, opts = {}) ⇒ Object

Initiates a payment flow on a Reader.



422
423
424
425
426
427
428
429
430
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 422

def process_payment_intent(reader, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#process_setup_intent(reader, params = {}, opts = {}) ⇒ Object

Initiates a setup intent flow on a Reader.



433
434
435
436
437
438
439
440
441
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 433

def process_setup_intent(reader, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#refund_payment(reader, params = {}, opts = {}) ⇒ Object

Initiates a refund on a Reader



444
445
446
447
448
449
450
451
452
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 444

def refund_payment(reader, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(reader, params = {}, opts = {}) ⇒ Object

Retrieves a Reader object.



455
456
457
458
459
460
461
462
463
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 455

def retrieve(reader, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#set_reader_display(reader, params = {}, opts = {}) ⇒ Object

Sets reader display to show cart details.



466
467
468
469
470
471
472
473
474
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 466

def set_reader_display(reader, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#update(reader, params = {}, opts = {}) ⇒ Object

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.



477
478
479
480
481
482
483
484
485
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 477

def update(reader, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/terminal/readers/%<reader>s", { reader: CGI.escape(reader) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end