Class: Io::Flow::V0::Models::CaptureStatus
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::CaptureStatus
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Attribute Summary collapse
-
#value ⇒ Object
readonly
Returns the value of attribute value.
Class Method Summary collapse
- .ALL ⇒ Object
-
.apply(value) ⇒ Object
Returns the instance of CaptureStatus for this value, creating a new instance for an unknown value.
-
.canceled ⇒ Object
The capture was canceled.
-
.failed ⇒ Object
The capture failed to process.
-
.from_string(value) ⇒ Object
Returns the instance of CaptureStatus for this value, or nil if not found.
-
.pending ⇒ Object
The capture has been initiated and requires time to complete.
-
.succeeded ⇒ Object
The capture has been processed successfully.
Instance Method Summary collapse
-
#initialize(value) ⇒ CaptureStatus
constructor
A new instance of CaptureStatus.
- #to_hash ⇒ Object
Constructor Details
#initialize(value) ⇒ CaptureStatus
Returns a new instance of CaptureStatus.
10124 10125 10126 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10124 def initialize(value) @value = HttpClient::Preconditions.assert_class('value', value, String) end |
Instance Attribute Details
#value ⇒ Object (readonly)
Returns the value of attribute value.
10122 10123 10124 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10122 def value @value end |
Class Method Details
.ALL ⇒ Object
10144 10145 10146 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10144 def CaptureStatus.ALL @@all ||= [CaptureStatus.pending, CaptureStatus.succeeded, CaptureStatus.failed, CaptureStatus.canceled] end |
.apply(value) ⇒ Object
Returns the instance of CaptureStatus for this value, creating a new instance for an unknown value
10129 10130 10131 10132 10133 10134 10135 10136 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10129 def CaptureStatus.apply(value) if value.instance_of?(CaptureStatus) value else HttpClient::Preconditions.assert_class_or_nil('value', value, String) value.nil? ? nil : (from_string(value) || CaptureStatus.new(value)) end end |
.canceled ⇒ Object
The capture was canceled.
10164 10165 10166 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10164 def CaptureStatus.canceled @@_canceled ||= CaptureStatus.new('canceled') end |
.failed ⇒ Object
The capture failed to process.
10159 10160 10161 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10159 def CaptureStatus.failed @@_failed ||= CaptureStatus.new('failed') end |
.from_string(value) ⇒ Object
Returns the instance of CaptureStatus for this value, or nil if not found
10139 10140 10141 10142 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10139 def CaptureStatus.from_string(value) HttpClient::Preconditions.assert_class('value', value, String) CaptureStatus.ALL.find { |v| v.value == value } end |
.pending ⇒ Object
The capture has been initiated and requires time to complete.
10149 10150 10151 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10149 def CaptureStatus.pending @@_pending ||= CaptureStatus.new('pending') end |
.succeeded ⇒ Object
The capture has been processed successfully.
10154 10155 10156 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10154 def CaptureStatus.succeeded @@_succeeded ||= CaptureStatus.new('succeeded') end |
Instance Method Details
#to_hash ⇒ Object
10168 10169 10170 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10168 def to_hash value end |