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.
12836 12837 12838 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12836 def initialize(value) @value = HttpClient::Preconditions.assert_class('value', value, String) end |
Instance Attribute Details
#value ⇒ Object (readonly)
Returns the value of attribute value.
12834 12835 12836 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12834 def value @value end |
Class Method Details
.ALL ⇒ Object
12856 12857 12858 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12856 def AuthenticationTechnique.ALL @@all ||= [AuthenticationTechnique.anonymous, AuthenticationTechnique.session, AuthenticationTechnique.token, AuthenticationTechnique.partner_token, AuthenticationTechnique.user] end |
.anonymous ⇒ Object
No authentication necessary.
12861 12862 12863 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12861 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
12841 12842 12843 12844 12845 12846 12847 12848 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12841 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
12851 12852 12853 12854 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12851 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.
12879 12880 12881 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12879 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.
12867 12868 12869 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12867 def AuthenticationTechnique.session @@_session ||= AuthenticationTechnique.new('session') end |
.token ⇒ Object
A token. Tokens carry the same permissions as the user who originally created them.
12873 12874 12875 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12873 def AuthenticationTechnique.token @@_token ||= AuthenticationTechnique.new('token') end |
.user ⇒ Object
A user logs into Flow.
12884 12885 12886 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12884 def AuthenticationTechnique.user @@_user ||= AuthenticationTechnique.new('user') end |
Instance Method Details
#to_hash ⇒ Object
12888 12889 12890 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12888 def to_hash value end |