Class: Twilio::REST::Iam::V1

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/iam/v1.rb,
lib/twilio-ruby/rest/iam/v1/token.rb,
lib/twilio-ruby/rest/iam/v1/api_key.rb,
lib/twilio-ruby/rest/iam/v1/o_auth_app.rb,
lib/twilio-ruby/rest/iam/v1/new_api_key.rb,
lib/twilio-ruby/rest/iam/v1/get_api_keys.rb

Defined Under Namespace

Classes: ApiKeyContext, ApiKeyInstance, ApiKeyList, ApiKeyPage, GetApiKeysInstance, GetApiKeysList, GetApiKeysPage, NewApiKeyInstance, NewApiKeyList, NewApiKeyPage, OAuthAppContext, OAuthAppInstance, OAuthAppList, OAuthAppPage, TokenInstance, TokenList, TokenPage

Instance Attribute Summary

Attributes inherited from Version

#domain

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #delete, #exception, #fetch, #page, #patch, #read_limits, #relative_uri, #request, #stream, #update

Constructor Details

#initialize(domain) ⇒ V1

Initialize the V1 version of Iam



21
22
23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/iam/v1.rb', line 21

def initialize(domain)
    super
    @version = 'v1'
    @api_key = nil
    @get_api_keys = nil
    @new_api_key = nil
    @o_auth_apps = nil
    @token = nil
end

Instance Method Details

#api_key(sid = :unset) ⇒ Twilio::REST::Iam::V1::ApiKeyContext, Twilio::REST::Iam::V1::ApiKeyList

Parameters:

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

    The Twilio-provided string that uniquely identifies the Key resource to fetch.

Returns:



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/twilio-ruby/rest/iam/v1.rb', line 35

def api_key(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end
    if sid == :unset
        @api_key ||= ApiKeyList.new self
    else
        ApiKeyContext.new(self, sid)
    end
end

#get_api_keys ⇒ Twilio::REST::Iam::V1::GetApiKeysList

Returns:



47
48
49
 
# File 'lib/twilio-ruby/rest/iam/v1.rb', line 47

def get_api_keys
    @get_api_keys ||= GetApiKeysList.new self
end

#new_api_key ⇒ Twilio::REST::Iam::V1::NewApiKeyList

Returns:



52
53
54
 
# File 'lib/twilio-ruby/rest/iam/v1.rb', line 52

def new_api_key
    @new_api_key ||= NewApiKeyList.new self
end

#o_auth_apps(sid = :unset) ⇒ Twilio::REST::Iam::V1::OAuthAppContext, Twilio::REST::Iam::V1::OAuthAppList

Parameters:

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

    Unique ID (sid) of the OAuth app

Returns:



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/twilio-ruby/rest/iam/v1.rb', line 59

def o_auth_apps(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end
    if sid == :unset
        @o_auth_apps ||= OAuthAppList.new self
    else
        OAuthAppContext.new(self, sid)
    end
end

#to_s ⇒ Object

Provide a user friendly representation



76
77
78
 
# File 'lib/twilio-ruby/rest/iam/v1.rb', line 76

def to_s
    '<Twilio::REST::Iam::V1>';
end

#token ⇒ Twilio::REST::Iam::V1::TokenList

Returns:



71
72
73
 
# File 'lib/twilio-ruby/rest/iam/v1.rb', line 71

def token
    @token ||= TokenList.new self
end