Class: Reach::REST::Api::Authentix

Inherits:
Version
  • Object
show all
Defined in:
lib/reach-ruby/rest/api/authentix.rb,
lib/reach-ruby/rest/api/authentix/configuration_item.rb,
lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb,
lib/reach-ruby/rest/api/authentix/authentication_trial_stat_item.rb,
lib/reach-ruby/rest/api/authentix/configuration_item/authentication_item.rb,
lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb

Defined Under Namespace

Classes: AuthenticationTrialItemContext, AuthenticationTrialItemInstance, AuthenticationTrialItemList, AuthenticationTrialItemPage, AuthenticationTrialStatItemContext, AuthenticationTrialStatItemInstance, AuthenticationTrialStatItemList, AuthenticationTrialStatItemPage, ConfigurationItemContext, ConfigurationItemInstance, ConfigurationItemList, ConfigurationItemPage

Instance Attribute Summary

Attributes inherited from Version

#domain

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #check, #create, #delete, #dispatch, #exception, #fetch, #page, #read_limits, #relative_uri, #request, #start, #stream, #unschedule, #update, #url_without_pagination_info

Constructor Details

#initialize(domain) ⇒ Authentix

Initialize the Authentix version of Api



22
23
24
25
26
27
28
 
# File 'lib/reach-ruby/rest/api/authentix.rb', line 22

def initialize(domain)
    super
    @version = 'rest'
    @authentication_trial_items = nil
    @authentication_trial_stat_items = nil
    @configuration_items = nil
end

Instance Method Details

#authentication_trial_items(trial_id = :unset) ⇒ Reach::REST::Api::Authentix::AuthenticationTrialItemContext, Reach::REST::Api::Authentix::AuthenticationTrialItemList

Parameters:

  • trial_id (String) (defaults to: :unset) —

    The identifier of the authentication trial to be fetched.

Returns:



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/reach-ruby/rest/api/authentix.rb', line 35

def authentication_trial_items(trial_id=:unset)
    if trial_id.nil?
        raise ArgumentError, 'trial_id cannot be nil'
    end
    if trial_id == :unset
        @authentication_trial_items ||= AuthenticationTrialItemList.new self
    else
        AuthenticationTrialItemContext.new(self, trial_id)
    end
end

#authentication_trial_stat_items ⇒ Reach::REST::Api::Authentix::authenticationTrialStatItemsContext

Returns:

  • (Reach::REST::Api::Authentix::authenticationTrialStatItemsContext) 


47
48
49
 
# File 'lib/reach-ruby/rest/api/authentix.rb', line 47

def authentication_trial_stat_items
    @authentication_trial_stat_items ||= AuthenticationTrialStatItemContext.new self
end

#configuration_items(configuration_id = :unset) ⇒ Reach::REST::Api::Authentix::ConfigurationItemContext, Reach::REST::Api::Authentix::ConfigurationItemList

Parameters:

  • configuration_id (String) (defaults to: :unset) —

    The identifier of the configuration to be fetched.

Returns:



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/reach-ruby/rest/api/authentix.rb', line 54

def configuration_items(configuration_id=:unset)
    if configuration_id.nil?
        raise ArgumentError, 'configuration_id cannot be nil'
    end
    if configuration_id == :unset
        @configuration_items ||= ConfigurationItemList.new self
    else
        ConfigurationItemContext.new(self, configuration_id)
    end
end

#to_s ⇒ Object

Provide a user friendly representation



66
67
68
 
# File 'lib/reach-ruby/rest/api/authentix.rb', line 66

def to_s
    '<Reach::REST::Api::Authentix>';
end