twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/oauth/v1/authorize.rb

@@ -0,0 +1,253 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Oauth
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Oauth < OauthBase
+            class V1 < Version
+                class AuthorizeList < ListResource
+                
+                    ##
+                    # Initialize the AuthorizeList
+                    # @param [Version] version Version that contains the resource
+                    # @return [AuthorizeList] AuthorizeList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/authorize"
+                        
+                    end
+                    ##
+                    # Fetch the AuthorizeInstance
+                    # @param [String] response_type Response Type
+                    # @param [String] client_id The Client Identifier
+                    # @param [String] redirect_uri The url to which response will be redirected to
+                    # @param [String] scope The scope of the access request
+                    # @param [String] state An opaque value which can be used to maintain state between the request and callback
+                    # @return [AuthorizeInstance] Fetched AuthorizeInstance
+                    def fetch(
+                      response_type: :unset, 
+                      client_id: :unset, 
+                      redirect_uri: :unset, 
+                      scope: :unset, 
+                      state: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'ResponseType' => response_type,
+                            'ClientId' => client_id,
+                            'RedirectUri' => redirect_uri,
+                            'Scope' => scope,
+                            'State' => state,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        AuthorizeInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the AuthorizeInstanceMetadata
+                    # @param [String] response_type Response Type
+                    # @param [String] client_id The Client Identifier
+                    # @param [String] redirect_uri The url to which response will be redirected to
+                    # @param [String] scope The scope of the access request
+                    # @param [String] state An opaque value which can be used to maintain state between the request and callback
+                    # @return [AuthorizeInstance] Fetched AuthorizeInstance
+                    def fetch_with_metadata(
+                      response_type: :unset, 
+                      client_id: :unset, 
+                      redirect_uri: :unset, 
+                      scope: :unset, 
+                      state: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'ResponseType' => response_type,
+                            'ClientId' => client_id,
+                            'RedirectUri' => redirect_uri,
+                            'Scope' => scope,
+                            'State' => state,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        authorize_instance = AuthorizeInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        AuthorizeInstanceMetadata.new(
+                            @version,
+                            authorize_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Oauth.V1.AuthorizeList>'
+                    end
+                end
+
+                class AuthorizePage < Page
+                    ##
+                    # Initialize the AuthorizePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [AuthorizePage] AuthorizePage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of AuthorizeInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [AuthorizeInstance] AuthorizeInstance
+                    def get_instance(payload)
+                        AuthorizeInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Oauth.V1.AuthorizePage>'
+                    end
+                end
+
+                class AuthorizePageMetadata < PageMetadata
+                    attr_reader :authorize_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @authorize_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @authorize_page << AuthorizeListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @authorize_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Oauth::V1PageMetadata>';
+                    end
+                end
+                class AuthorizeListResponse < InstanceListResource
+
+                    # @param [Array<AuthorizeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @authorize = data_list.map do |data|
+                        AuthorizeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def authorize
+                        @authorize
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class AuthorizeInstance < InstanceResource
+                    ##
+                    # Initialize the AuthorizeInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Authorize
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [AuthorizeInstance] AuthorizeInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'redirect_to' => payload['redirect_to'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The callback URL
+                    def redirect_to
+                        @properties['redirect_to']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Oauth.V1.AuthorizeInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Oauth.V1.AuthorizeInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/oauth/v1/token.rb

@@ -18,12 +18,14 @@ module Twilio
         class Oauth < OauthBase
             class V1 < Version
                 class TokenList < ListResource
+                
                     ##
                     # Initialize the TokenList
                     # @param [Version] version Version that contains the resource
                     # @return [TokenList] TokenList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/token"
@@ -32,43 +34,101 @@ module Twilio
                     ##
                     # Create the TokenInstance
                     # @param [String] grant_type Grant type is a credential representing resource owner's authorization which can be used by client to obtain access token.
-                    # @param [String] client_sid A 34 character string that uniquely identifies this OAuth App.
+                    # @param [String] client_id A 34 character string that uniquely identifies this OAuth App.
                     # @param [String] client_secret The credential for confidential OAuth App.
                     # @param [String] code JWT token related to the authorization code grant type.
-                    # @param [String] code_verifier A code which is generation cryptographically.
-                    # @param [String] device_code JWT token related to the device code grant type.
-                    # @param [String] refresh_token JWT token related to the refresh token grant type.
-                    # @param [String] device_id The Id of the device associated with the token (refresh token).
+                    # @param [String] redirect_uri The redirect uri
+                    # @param [String] audience The targeted audience uri
+                    # @param [String] refresh_token JWT token related to refresh access token.
+                    # @param [String] scope The scope of token
                     # @return [TokenInstance] Created TokenInstance
                     def create(
-                        grant_type: nil, 
-                        client_sid: nil, 
-                        client_secret: :unset, 
-                        code: :unset, 
-                        code_verifier: :unset, 
-                        device_code: :unset, 
-                        refresh_token: :unset, 
-                        device_id: :unset
+                      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,
-                            'ClientSid' => client_sid,
+                            'ClientId' => client_id,
                             'ClientSecret' => client_secret,
                             'Code' => code,
-                            'CodeVerifier' => code_verifier,
-                            'DeviceCode' => device_code,
+                            'RedirectUri' => redirect_uri,
+                            'Audience' => audience,
                             'RefreshToken' => refresh_token,
-                            'DeviceId' => device_id,
+                            'Scope' => scope,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        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 the TokenInstanceMetadata
+                    # @param [String] grant_type Grant type is a credential representing resource owner's authorization which can be used by client to obtain access token.
+                    # @param [String] client_id A 34 character string that uniquely identifies this OAuth App.
+                    # @param [String] client_secret The credential for confidential OAuth App.
+                    # @param [String] code JWT token related to the authorization code grant type.
+                    # @param [String] redirect_uri The redirect uri
+                    # @param [String] audience The targeted audience uri
+                    # @param [String] refresh_token JWT token related to refresh access token.
+                    # @param [String] scope The scope of token
+                    # @return [TokenInstance] Created TokenInstance
+                    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
+
                 
 
 
@@ -87,6 +147,7 @@ module Twilio
                     # @return [TokenPage] TokenPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -106,6 +167,66 @@ module Twilio
                         '<Twilio.Oauth.V1.TokenPage>'
                     end
                 end
+
+                class TokenPageMetadata < PageMetadata
+                    attr_reader :token_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @token_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @token_page << TokenListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @token_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Oauth::V1PageMetadata>';
+                    end
+                end
+                class TokenListResponse < InstanceListResource
+
+                    # @param [Array<TokenInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @token = data_list.map do |data|
+                        TokenInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def token
+                        @token
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TokenInstance < InstanceResource
                     ##
                     # Initialize the TokenInstance
@@ -119,13 +240,14 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'access_token' => payload['access_token'],
                             'refresh_token' => payload['refresh_token'],
                             'id_token' => payload['id_token'],
-                            'refresh_token_expires_at' => Twilio.deserialize_iso8601_datetime(payload['refresh_token_expires_at']),
-                            'access_token_expires_at' => Twilio.deserialize_iso8601_datetime(payload['access_token_expires_at']),
+                            'token_type' => payload['token_type'],
+                            'expires_in' => payload['expires_in'],
                         }
                     end
 
@@ -143,21 +265,21 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] 
+                    # @return [String] Token which carries the information necessary of user profile.
                     def id_token
                         @properties['id_token']
                     end
                     
                     ##
-                    # @return [Time] The date and time in GMT when the refresh token expires in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
-                    def refresh_token_expires_at
-                        @properties['refresh_token_expires_at']
+                    # @return [String] Token type
+                    def token_type
+                        @properties['token_type']
                     end
                     
                     ##
-                    # @return [Time] The date and time in GMT when the refresh token expires in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
-                    def access_token_expires_at
-                        @properties['access_token_expires_at']
+                    # @return [String] 
+                    def expires_in
+                        @properties['expires_in']
                     end
                     
                     ##

data/lib/twilio-ruby/rest/oauth/v1.rb

@@ -21,27 +21,14 @@ module Twilio
                 def initialize(domain)
                     super
                     @version = 'v1'
-                    @device_code = nil
-                    @oauth = nil
-                    @openid_discovery = nil
+                    @authorize = nil
                     @token = nil
-                    @user_info = nil
                 end
 
                 ##
-                # @return [Twilio::REST::Oauth::V1::DeviceCodeList]
-                def device_code
-                    @device_code ||= DeviceCodeList.new self
-                end
-                ##
-                # @return [Twilio::REST::Oauth::V1::oauthContext]
-                def oauth
-                    @oauth ||= OauthContext.new self
-                end
-                ##
-                # @return [Twilio::REST::Oauth::V1::openidDiscoveryContext]
-                def openid_discovery
-                    @openid_discovery ||= OpenidDiscoveryContext.new self
+                # @return [Twilio::REST::Oauth::V1::AuthorizeList]
+                def authorize
+                    @authorize ||= AuthorizeList.new self
                 end
                 ##
                 # @return [Twilio::REST::Oauth::V1::TokenList]
@@ -49,11 +36,6 @@ module Twilio
                     @token ||= TokenList.new self
                 end
                 ##
-                # @return [Twilio::REST::Oauth::V1::userInfoContext]
-                def user_info
-                    @user_info ||= UserInfoContext.new self
-                end
-                ##
                 # Provide a user friendly representation
                 def to_s
                     '<Twilio::REST::Oauth::V1>';