Class: Twilio::REST::Oauth::V1::TokenList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/oauth/v1/token.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ TokenList

Initialize the TokenList

Parameters:

  • Version that contains the resource



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/oauth/v1/token.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/token"
    
end

Instance Method Details

#create(grant_type: nil, client_id: nil, client_secret: :unset, code: :unset, redirect_uri: :unset, audience: :unset, refresh_token: :unset, scope: :unset) ⇒ TokenInstance

Create the TokenInstance

Parameters:

  • (defaults to: nil)

    Grant type is a credential representing resource owner’s authorization which can be used by client to obtain access token.

  • (defaults to: nil)

    A 34 character string that uniquely identifies this OAuth App.

  • (defaults to: :unset)

    The credential for confidential OAuth App.

  • (defaults to: :unset)

    JWT token related to the authorization code grant type.

  • (defaults to: :unset)

    The redirect uri

  • (defaults to: :unset)

    The targeted audience uri

  • (defaults to: :unset)

    JWT token related to refresh access token.

  • (defaults to: :unset)

    The scope of token

Returns:

  • Created TokenInstance



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/oauth/v1/token.rb', line 45

def create(
    grant_type: nil, 
    client_id: nil, 
    client_secret: :unset, 
    code: :unset, 
    redirect_uri: :unset, 
    audience: :unset, 
    refresh_token: :unset, 
    scope: :unset
)

    data = Twilio::Values.of({
        'GrantType' => grant_type,
        'ClientId' => client_id,
        'ClientSecret' => client_secret,
        'Code' => code,
        'RedirectUri' => redirect_uri,
        'Audience' => audience,
        'RefreshToken' => refresh_token,
        'Scope' => scope,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    TokenInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(grant_type: nil, client_id: nil, client_secret: :unset, code: :unset, redirect_uri: :unset, audience: :unset, refresh_token: :unset, scope: :unset) ⇒ TokenInstance

Create the TokenInstanceMetadata

Parameters:

  • (defaults to: nil)

    Grant type is a credential representing resource owner’s authorization which can be used by client to obtain access token.

  • (defaults to: nil)

    A 34 character string that uniquely identifies this OAuth App.

  • (defaults to: :unset)

    The credential for confidential OAuth App.

  • (defaults to: :unset)

    JWT token related to the authorization code grant type.

  • (defaults to: :unset)

    The redirect uri

  • (defaults to: :unset)

    The targeted audience uri

  • (defaults to: :unset)

    JWT token related to refresh access token.

  • (defaults to: :unset)

    The scope of token

Returns:

  • Created TokenInstance



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/oauth/v1/token.rb', line 91

def create_with_metadata(
  grant_type: nil, 
  client_id: nil, 
  client_secret: :unset, 
  code: :unset, 
  redirect_uri: :unset, 
  audience: :unset, 
  refresh_token: :unset, 
  scope: :unset
)

    data = Twilio::Values.of({
        'GrantType' => grant_type,
        'ClientId' => client_id,
        'ClientSecret' => client_secret,
        'Code' => code,
        'RedirectUri' => redirect_uri,
        'Audience' => audience,
        'RefreshToken' => refresh_token,
        'Scope' => scope,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    token_instance = TokenInstance.new(
        @version,
        response.body,
    )
    TokenInstanceMetadata.new(
        @version,
        token_instance,
        response.headers,
        response.status_code
    )
end

#to_s ⇒ Object

Provide a user friendly representation



136
137
138
 
# File 'lib/twilio-ruby/rest/oauth/v1/token.rb', line 136

def to_s
    '#<Twilio.Oauth.V1.TokenList>'
end