Class: Stripe::Terminal::ReaderService::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/terminal/reader_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(expand: nil, label: nil, location: nil, metadata: nil, registration_code: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 84

def initialize(
  expand: nil,
  label: nil,
  location: nil,
  metadata: nil,
  registration_code: nil
)
  @expand = expand
  @label = label
  @location = location
  @metadata = metadata
  @registration_code = registration_code
end

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.



74
75
76
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 74

def expand
  @expand
end

#label ⇒ Object

Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.



76
77
78
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 76

def label
  @label
end

#location ⇒ Object

The location to assign the reader to.



78
79
80
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 78

def location
  @location
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



80
81
82
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 80

def metadata
  @metadata
end

#registration_code ⇒ Object

A code generated by the reader used for registering to an account.



82
83
84
 
# File 'lib/stripe/services/terminal/reader_service.rb', line 82

def registration_code
  @registration_code
end