Class: Io::Flow::V0::Models::AuthenticationTechnique
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::AuthenticationTechnique
- 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
-
.anonymous ⇒ Object
No authentication necessary.
-
.apply(value) ⇒ Object
Returns the instance of AuthenticationTechnique for this value, creating a new instance for an unknown value.
-
.from_string(value) ⇒ Object
Returns the instance of AuthenticationTechnique for this value, or nil if not found.
-
.partner_token ⇒ Object
A partner token.
-
.session ⇒ Object
A browser has been assigned an identifier by Flow to track their use of our service for an organization.
-
.token ⇒ Object
A token.
-
.user ⇒ Object
A user logs into Flow.
Instance Method Summary collapse
-
#initialize(value) ⇒ AuthenticationTechnique
constructor
A new instance of AuthenticationTechnique.
- #to_hash ⇒ Object
Constructor Details
#initialize(value) ⇒ AuthenticationTechnique
Returns a new instance of AuthenticationTechnique.
15608 15609 15610 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15608 def initialize(value) @value = HttpClient::Preconditions.assert_class('value', value, String) end |
Instance Attribute Details
#value ⇒ Object (readonly)
Returns the value of attribute value.
15606 15607 15608 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15606 def value @value end |
Class Method Details
.ALL ⇒ Object
15628 15629 15630 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15628 def AuthenticationTechnique.ALL @@all ||= [AuthenticationTechnique.anonymous, AuthenticationTechnique.session, AuthenticationTechnique.token, AuthenticationTechnique.partner_token, AuthenticationTechnique.user] end |
.anonymous ⇒ Object
No authentication necessary.
15633 15634 15635 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15633 def AuthenticationTechnique.anonymous @@_anonymous ||= AuthenticationTechnique.new('anonymous') end |
.apply(value) ⇒ Object
Returns the instance of AuthenticationTechnique for this value, creating a new instance for an unknown value
15613 15614 15615 15616 15617 15618 15619 15620 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15613 def AuthenticationTechnique.apply(value) if value.instance_of?(AuthenticationTechnique) value else HttpClient::Preconditions.assert_class_or_nil('value', value, String) value.nil? ? nil : (from_string(value) || AuthenticationTechnique.new(value)) end end |
.from_string(value) ⇒ Object
Returns the instance of AuthenticationTechnique for this value, or nil if not found
15623 15624 15625 15626 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15623 def AuthenticationTechnique.from_string(value) HttpClient::Preconditions.assert_class('value', value, String) AuthenticationTechnique.ALL.find { |v| v.value == value } end |
.partner_token ⇒ Object
A partner token. Partner Tokens can only access anonymous endpoints and the endpoints of the partner api.
15651 15652 15653 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15651 def AuthenticationTechnique.partner_token @@_partner_token ||= AuthenticationTechnique.new('partner_token') end |
.session ⇒ Object
A browser has been assigned an identifier by Flow to track their use of our service for an organization.
15639 15640 15641 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15639 def AuthenticationTechnique.session @@_session ||= AuthenticationTechnique.new('session') end |
.token ⇒ Object
A token. Tokens carry the same permissions as the user who originally created them.
15645 15646 15647 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15645 def AuthenticationTechnique.token @@_token ||= AuthenticationTechnique.new('token') end |
.user ⇒ Object
A user logs into Flow.
15656 15657 15658 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15656 def AuthenticationTechnique.user @@_user ||= AuthenticationTechnique.new('user') end |
Instance Method Details
#to_hash ⇒ Object
15660 15661 15662 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 15660 def to_hash value end |