twilio-ruby 7.3.3 → 7.10.1

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

@@ -0,0 +1,311 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    User OAuth API
+#    User OAuth 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 V2 < 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] account_sid Optional Account SID to perform on behalf of requests.
+                    # @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(
+                        account_sid: :unset, 
+                        grant_type: :unset, 
+                        client_id: :unset, 
+                        client_secret: :unset, 
+                        code: :unset, 
+                        redirect_uri: :unset, 
+                        audience: :unset, 
+                        refresh_token: :unset, 
+                        scope: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'account_sid' => account_sid,
+                        })
+                        data = Twilio::Values.of({
+                            'grant_type' => grant_type,
+                            'client_id' => client_id,
+                            'client_secret' => client_secret,
+                            'code' => code,
+                            'redirect_uri' => redirect_uri,
+                            'audience' => audience,
+                            'refresh_token' => refresh_token,
+                            'scope' => scope,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, params: params, data: data, headers: headers)
+                        TokenInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the TokenInstanceMetadata
+                    # @param [String] account_sid Optional Account SID to perform on behalf of requests.
+                    # @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(
+                      account_sid: :unset, 
+                      grant_type: :unset, 
+                      client_id: :unset, 
+                      client_secret: :unset, 
+                      code: :unset, 
+                      redirect_uri: :unset, 
+                      audience: :unset, 
+                      refresh_token: :unset, 
+                      scope: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'account_sid' => account_sid,
+                        })
+                        data = Twilio::Values.of({
+                            'grant_type' => grant_type,
+                            'client_id' => client_id,
+                            'client_secret' => client_secret,
+                            'code' => code,
+                            'redirect_uri' => redirect_uri,
+                            'audience' => audience,
+                            'refresh_token' => refresh_token,
+                            'scope' => scope,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, params: params, data: data, headers: headers)
+                        token_instance = TokenInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        TokenInstanceMetadata.new(
+                            @version,
+                            token_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Oauth.V2.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.V2.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::V2PageMetadata>';
+                    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
+                    # @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 Token
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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'],
+                            'token_type' => payload['token_type'],
+                            'expires_in' => payload['expires_in'],
+                        }
+                    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] Token which carries the information necessary of user profile.
+                    def id_token
+                        @properties['id_token']
+                    end
+                    
+                    ##
+                    # @return [String] Token type
+                    def token_type
+                        @properties['token_type']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def expires_in
+                        @properties['expires_in']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Oauth.V2.TokenInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Oauth.V2.TokenInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,46 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    User OAuth API
+#    User OAuth 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
+            class V2 < Version
+                ##
+                # Initialize the V2 version of Oauth
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @authorize = nil
+                    @token = nil
+                end
+
+                ##
+                # @return [Twilio::REST::Oauth::V2::AuthorizeList]
+                def authorize
+                    @authorize ||= AuthorizeList.new self
+                end
+                ##
+                # @return [Twilio::REST::Oauth::V2::TokenList]
+                def token
+                    @token ||= TokenList.new self
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Oauth::V2>';
+                end
+            end
+        end
+    end
+end

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

@@ -22,16 +22,21 @@ module Twilio
         @host = "oauth.twilio.com"
         @port = 443
         @v1 = nil
+        @v2 = nil
       end
 
       def v1
         @v1 ||= Oauth::V1.new self
       end
 
+      def v2
+        @v2 ||= Oauth::V2.new self
+      end
+
       ##
       # Provide a user friendly representation
       def to_s
-        '<Twilio::REST::Oauth::V1>';
+        '<Twilio::REST::Oauth>';
       end
     end
   end

data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [DependentHostedNumberOrderList] DependentHostedNumberOrderList
                     def initialize(version, signing_document_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { signing_document_sid: signing_document_sid }
                         @uri = "/AuthorizationDocuments/#{@solution[:signing_document_sid]}/DependentHostedNumberOrders"
@@ -91,6 +92,38 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists DependentHostedNumberOrderPageMetadata records from the API as a list.
+                      # @param [Status] status Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/authorization-document-resource#status-values) for more information on each of these statuses.
+                      # @param [String] phone_number An E164 formatted phone number hosted by this HostedNumberOrder.
+                      # @param [String] incoming_phone_number_sid A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
+                      # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                      # @param [String] unique_name Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Status' => status,
+                            'PhoneNumber' => phone_number,
+                            'IncomingPhoneNumberSid' => incoming_phone_number_sid,
+                            'FriendlyName' => friendly_name,
+                            'UniqueName' => unique_name,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        DependentHostedNumberOrderPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields DependentHostedNumberOrderInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -117,7 +150,7 @@ module Twilio
                     # @param [Integer] page_number Page Number, this value is simply for client state
                     # @param [Integer] page_size Number of records to return, defaults to 50
                     # @return [Page] Page of DependentHostedNumberOrderInstance
-                    def page(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(status: :unset, phone_number: :unset, incoming_phone_number_sid: :unset, friendly_name: :unset, unique_name: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Status' => status,
                             'PhoneNumber' => phone_number,
@@ -128,8 +161,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         DependentHostedNumberOrderPage.new(@version, response, @solution)
                     end
@@ -164,6 +200,7 @@ module Twilio
                     # @return [DependentHostedNumberOrderPage] DependentHostedNumberOrderPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -183,6 +220,66 @@ module Twilio
                         '<Twilio.Preview.HostedNumbers.DependentHostedNumberOrderPage>'
                     end
                 end
+
+                class DependentHostedNumberOrderPageMetadata < PageMetadata
+                    attr_reader :dependent_hosted_number_order_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @dependent_hosted_number_order_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @dependent_hosted_number_order_page << DependentHostedNumberOrderListResponse.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
+                        @dependent_hosted_number_order_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Preview::HostedNumbersPageMetadata>';
+                    end
+                end
+                class DependentHostedNumberOrderListResponse < InstanceListResource
+
+                    # @param [Array<DependentHostedNumberOrderInstance>] 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
+                      @dependent_hosted_number_order = data_list.map do |data|
+                        DependentHostedNumberOrderInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def dependent_hosted_number_order
+                        @dependent_hosted_number_order
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class DependentHostedNumberOrderInstance < InstanceResource
                     ##
                     # Initialize the DependentHostedNumberOrderInstance
@@ -196,6 +293,7 @@ module Twilio
                     def initialize(version, payload , signing_document_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],