twilio-ruby 5.72.0 → 5.73.0

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

@@ -0,0 +1,242 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Oauth < Domain
+      class V1 < Version
+        class OpenidDiscoveryList < ListResource
+          ##
+          # Initialize the OpenidDiscoveryList
+          # @param [Version] version Version that contains the resource
+          # @return [OpenidDiscoveryList] OpenidDiscoveryList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Oauth.V1.OpenidDiscoveryList>'
+          end
+        end
+
+        class OpenidDiscoveryPage < Page
+          ##
+          # Initialize the OpenidDiscoveryPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [OpenidDiscoveryPage] OpenidDiscoveryPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of OpenidDiscoveryInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [OpenidDiscoveryInstance] OpenidDiscoveryInstance
+          def get_instance(payload)
+            OpenidDiscoveryInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Oauth.V1.OpenidDiscoveryPage>'
+          end
+        end
+
+        class OpenidDiscoveryContext < InstanceContext
+          ##
+          # Initialize the OpenidDiscoveryContext
+          # @param [Version] version Version that contains the resource
+          # @return [OpenidDiscoveryContext] OpenidDiscoveryContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/well-known/openid-configuration"
+          end
+
+          ##
+          # Fetch the OpenidDiscoveryInstance
+          # @return [OpenidDiscoveryInstance] Fetched OpenidDiscoveryInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            OpenidDiscoveryInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Oauth.V1.OpenidDiscoveryContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Oauth.V1.OpenidDiscoveryContext #{context}>"
+          end
+        end
+
+        class OpenidDiscoveryInstance < InstanceResource
+          ##
+          # Initialize the OpenidDiscoveryInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [OpenidDiscoveryInstance] OpenidDiscoveryInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'issuer' => payload['issuer'],
+                'authorization_endpoint' => payload['authorization_endpoint'],
+                'device_authorization_endpoint' => payload['device_authorization_endpoint'],
+                'token_endpoint' => payload['token_endpoint'],
+                'userinfo_endpoint' => payload['userinfo_endpoint'],
+                'revocation_endpoint' => payload['revocation_endpoint'],
+                'jwk_uri' => payload['jwk_uri'],
+                'response_type_supported' => payload['response_type_supported'],
+                'subject_type_supported' => payload['subject_type_supported'],
+                'id_token_signing_alg_values_supported' => payload['id_token_signing_alg_values_supported'],
+                'scopes_supported' => payload['scopes_supported'],
+                'claims_supported' => payload['claims_supported'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [OpenidDiscoveryContext] OpenidDiscoveryContext for this OpenidDiscoveryInstance
+          def context
+            unless @instance_context
+              @instance_context = OpenidDiscoveryContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The issuer URL
+          def issuer
+            @properties['issuer']
+          end
+
+          ##
+          # @return [String] The URL of authorization endpoint
+          def authorization_endpoint
+            @properties['authorization_endpoint']
+          end
+
+          ##
+          # @return [String] The URL of device code authorization endpoint
+          def device_authorization_endpoint
+            @properties['device_authorization_endpoint']
+          end
+
+          ##
+          # @return [String] The URL of token endpoint
+          def token_endpoint
+            @properties['token_endpoint']
+          end
+
+          ##
+          # @return [String] The URL of user info endpoint
+          def userinfo_endpoint
+            @properties['userinfo_endpoint']
+          end
+
+          ##
+          # @return [String] The URL of revocation endpoint
+          def revocation_endpoint
+            @properties['revocation_endpoint']
+          end
+
+          ##
+          # @return [String] The URL of public JWK endpoint
+          def jwk_uri
+            @properties['jwk_uri']
+          end
+
+          ##
+          # @return [Array[String]] List of response type supported for identity token
+          def response_type_supported
+            @properties['response_type_supported']
+          end
+
+          ##
+          # @return [Array[String]] List of subject supported for identity token
+          def subject_type_supported
+            @properties['subject_type_supported']
+          end
+
+          ##
+          # @return [Array[String]] List of JWS signing algorithms supported for identity token
+          def id_token_signing_alg_values_supported
+            @properties['id_token_signing_alg_values_supported']
+          end
+
+          ##
+          # @return [Array[String]] List of scopes supported identity token
+          def scopes_supported
+            @properties['scopes_supported']
+          end
+
+          ##
+          # @return [Array[String]] List of claims supported for identity token
+          def claims_supported
+            @properties['claims_supported']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the OpenidDiscoveryInstance
+          # @return [OpenidDiscoveryInstance] Fetched OpenidDiscoveryInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Oauth.V1.OpenidDiscoveryInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Oauth.V1.OpenidDiscoveryInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,157 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Oauth < Domain
+      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"
+          end
+
+          ##
+          # 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_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).
+          # @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)
+            data = Twilio::Values.of({
+                'GrantType' => grant_type,
+                'ClientSid' => client_sid,
+                'ClientSecret' => client_secret,
+                'Code' => code,
+                'CodeVerifier' => code_verifier,
+                'DeviceCode' => device_code,
+                'RefreshToken' => refresh_token,
+                'DeviceId' => device_id,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            TokenInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Oauth.V1.TokenList>'
+          end
+        end
+
+        class TokenPage < Page
+          ##
+          # Initialize the TokenPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [TokenPage] TokenPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of TokenInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [TokenInstance] TokenInstance
+          def get_instance(payload)
+            TokenInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Oauth.V1.TokenPage>'
+          end
+        end
+
+        class TokenInstance < InstanceResource
+          ##
+          # Initialize the TokenInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [TokenInstance] TokenInstance
+          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']),
+            }
+          end
+
+          ##
+          # @return [String] Token which carries the necessary information to access a Twilio resource directly
+          def access_token
+            @properties['access_token']
+          end
+
+          ##
+          # @return [String] Token which carries the information necessary to get a new access token
+          def refresh_token
+            @properties['refresh_token']
+          end
+
+          ##
+          # @return [String] The id_token
+          def id_token
+            @properties['id_token']
+          end
+
+          ##
+          # @return [Time] The RFC 2822 date and time in GMT when the refresh token expires
+          def refresh_token_expires_at
+            @properties['refresh_token_expires_at']
+          end
+
+          ##
+          # @return [Time] The RFC 2822 date and time in GMT when the access token expires
+          def access_token_expires_at
+            @properties['access_token_expires_at']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Oauth.V1.TokenInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Oauth.V1.TokenInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,193 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Oauth < Domain
+      class V1 < Version
+        class UserInfoList < ListResource
+          ##
+          # Initialize the UserInfoList
+          # @param [Version] version Version that contains the resource
+          # @return [UserInfoList] UserInfoList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Oauth.V1.UserInfoList>'
+          end
+        end
+
+        class UserInfoPage < Page
+          ##
+          # Initialize the UserInfoPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UserInfoPage] UserInfoPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UserInfoInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UserInfoInstance] UserInfoInstance
+          def get_instance(payload)
+            UserInfoInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Oauth.V1.UserInfoPage>'
+          end
+        end
+
+        class UserInfoContext < InstanceContext
+          ##
+          # Initialize the UserInfoContext
+          # @param [Version] version Version that contains the resource
+          # @return [UserInfoContext] UserInfoContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/userinfo"
+          end
+
+          ##
+          # Fetch the UserInfoInstance
+          # @return [UserInfoInstance] Fetched UserInfoInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            UserInfoInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Oauth.V1.UserInfoContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Oauth.V1.UserInfoContext #{context}>"
+          end
+        end
+
+        class UserInfoInstance < InstanceResource
+          ##
+          # Initialize the UserInfoInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [UserInfoInstance] UserInfoInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'user_sid' => payload['user_sid'],
+                'first_name' => payload['first_name'],
+                'last_name' => payload['last_name'],
+                'friendly_name' => payload['friendly_name'],
+                'email' => payload['email'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [UserInfoContext] UserInfoContext for this UserInfoInstance
+          def context
+            unless @instance_context
+              @instance_context = UserInfoContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The user sid
+          def user_sid
+            @properties['user_sid']
+          end
+
+          ##
+          # @return [String] The first name of the end-user
+          def first_name
+            @properties['first_name']
+          end
+
+          ##
+          # @return [String] The last name of the end-user
+          def last_name
+            @properties['last_name']
+          end
+
+          ##
+          # @return [String] The friendly name of the end-user
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] The end-user's preferred email address
+          def email
+            @properties['email']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the UserInfoInstance
+          # @return [UserInfoInstance] Fetched UserInfoInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Oauth.V1.UserInfoInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Oauth.V1.UserInfoInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Oauth
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Oauth
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @oauth = nil
+          @openid_discovery = nil
+          @token = nil
+          @user_info = nil
+        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
+        end
+
+        ##
+        # @return [Twilio::REST::Oauth::V1::TokenContext]
+        def token
+          @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>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Oauth < Domain
+      ##
+      # Initialize the Oauth Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://oauth.twilio.com'
+        @host = 'oauth.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of oauth
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @return [Twilio::REST::Oauth::V1::OauthInstance]
+      def oauth
+        self.v1.oauth()
+      end
+
+      ##
+      # @return [Twilio::REST::Oauth::V1::OpenidDiscoveryInstance]
+      def openid_discovery
+        self.v1.openid_discovery()
+      end
+
+      ##
+      # @return [Twilio::REST::Oauth::V1::TokenInstance]
+      def token
+        self.v1.token()
+      end
+
+      ##
+      # @return [Twilio::REST::Oauth::V1::UserInfoInstance]
+      def user_info
+        self.v1.user_info()
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Oauth>'
+      end
+    end
+  end
+end