Class: Stripe::Terminal::Reader::Action

Inherits:
StripeObject show all
Defined in:
lib/stripe/resources/terminal/reader.rb

Defined Under Namespace

Classes: ApiError, CollectInputs, CollectPaymentMethod, ConfirmPaymentIntent, PrintContent, ProcessPaymentIntent, ProcessSetupIntent, RefundPayment, SetReaderDisplay

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#api_error ⇒ Object (readonly)

The reader action failed due to an API error. Only present when status is failed and the underlying failure was an API error. Avoid parsing the message field for programmatic logic; use type or code instead. The message field is for display to humans only and may be updated at anytime. Requires reader version 2.42 or later. Readers on older versions always return null.



562
563
564
 
# File 'lib/stripe/resources/terminal/reader.rb', line 562

def api_error
  @api_error
end

#collect_inputs ⇒ Object (readonly)

Represents a reader action to collect customer inputs



564
565
566
 
# File 'lib/stripe/resources/terminal/reader.rb', line 564

def collect_inputs
  @collect_inputs
end

#collect_payment_method ⇒ Object (readonly)

Represents a reader action to collect a payment method



566
567
568
 
# File 'lib/stripe/resources/terminal/reader.rb', line 566

def collect_payment_method
  @collect_payment_method
end

#confirm_payment_intent ⇒ Object (readonly)

Represents a reader action to confirm a payment



568
569
570
 
# File 'lib/stripe/resources/terminal/reader.rb', line 568

def confirm_payment_intent
  @confirm_payment_intent
end

#failure_code ⇒ Object (readonly)

Failure code, only set if status is failed.



570
571
572
 
# File 'lib/stripe/resources/terminal/reader.rb', line 570

def failure_code
  @failure_code
end

#failure_message ⇒ Object (readonly)

Detailed failure message, only set if status is failed.



572
573
574
 
# File 'lib/stripe/resources/terminal/reader.rb', line 572

def failure_message
  @failure_message
end

#print_content ⇒ Object (readonly)

Represents a reader action to print content



574
575
576
 
# File 'lib/stripe/resources/terminal/reader.rb', line 574

def print_content
  @print_content
end

#process_payment_intent ⇒ Object (readonly)

Represents a reader action to process a payment intent



576
577
578
 
# File 'lib/stripe/resources/terminal/reader.rb', line 576

def process_payment_intent
  @process_payment_intent
end

#process_setup_intent ⇒ Object (readonly)

Represents a reader action to process a setup intent



578
579
580
 
# File 'lib/stripe/resources/terminal/reader.rb', line 578

def process_setup_intent
  @process_setup_intent
end

#refund_payment ⇒ Object (readonly)

Represents a reader action to refund a payment



580
581
582
 
# File 'lib/stripe/resources/terminal/reader.rb', line 580

def refund_payment
  @refund_payment
end

#set_reader_display ⇒ Object (readonly)

Represents a reader action to set the reader display



582
583
584
 
# File 'lib/stripe/resources/terminal/reader.rb', line 582

def set_reader_display
  @set_reader_display
end

#status ⇒ Object (readonly)

Status of the action performed by the reader.



584
585
586
 
# File 'lib/stripe/resources/terminal/reader.rb', line 584

def status
  @status
end

#type ⇒ Object (readonly)

Type of action performed by the reader.



586
587
588
 
# File 'lib/stripe/resources/terminal/reader.rb', line 586

def type
  @type
end

Class Method Details

.field_remappings ⇒ Object 



602
603
604
 
# File 'lib/stripe/resources/terminal/reader.rb', line 602

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/stripe/resources/terminal/reader.rb', line 588

def self.inner_class_types
  @inner_class_types = {
    api_error: ApiError,
    collect_inputs: CollectInputs,
    collect_payment_method: CollectPaymentMethod,
    confirm_payment_intent: ConfirmPaymentIntent,
    print_content: PrintContent,
    process_payment_intent: ProcessPaymentIntent,
    process_setup_intent: ProcessSetupIntent,
    refund_payment: RefundPayment,
    set_reader_display: SetReaderDisplay,
  }
end