twilio-ruby 7.4.4 → 7.10.4

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

@@ -0,0 +1,301 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Iam
+#    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 Iam < IamBase
+            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_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(
+                        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({
+                            '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, 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({
+                            '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, 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.Iam.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.Iam.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::Iam::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
+                    # @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.Iam.V1.TokenInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Iam.V1.TokenInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -24,6 +24,8 @@ module Twilio
                     @api_key = nil
                     @get_api_keys = nil
                     @new_api_key = nil
+                    @o_auth_apps = nil
+                    @token = nil
                 end
 
                 ##
@@ -51,6 +53,25 @@ module Twilio
                     @new_api_key ||= NewApiKeyList.new self
                 end
                 ##
+                # @param [String] sid Unique ID (sid) of the OAuth app
+                # @return [Twilio::REST::Iam::V1::OAuthAppContext] if sid was passed.
+                # @return [Twilio::REST::Iam::V1::OAuthAppList]
+                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
+                ##
+                # @return [Twilio::REST::Iam::V1::TokenList]
+                def token
+                    @token ||= TokenList.new self
+                end
+                ##
                 # Provide a user friendly representation
                 def to_s
                     '<Twilio::REST::Iam::V1>';

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

@@ -21,17 +21,12 @@ module Twilio
         @base_url =  "https://iam.twilio.com"
         @host = "iam.twilio.com"
         @port = 443
-        @v1 = nil
-      end
-
-      def v1
-        @v1 ||= Iam::V1.new self
       end
 
       ##
       # Provide a user friendly representation
       def to_s
-        '<Twilio::REST::Iam::V1>';
+        '<Twilio::REST::Iam>';
       end
     end
   end

data/lib/twilio-ruby/rest/insights/v1/call/annotation.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [AnnotationList] AnnotationList
                     def initialize(version, call_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { call_sid: call_sid }
                         
@@ -50,6 +51,7 @@ module Twilio
                     # @return [AnnotationContext] AnnotationContext
                     def initialize(version, call_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { call_sid: call_sid,  }
@@ -76,6 +78,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the AnnotationInstanceMetadata
+                    # @return [AnnotationInstance] Fetched AnnotationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        annotation_instance = AnnotationInstance.new(
+                            @version,
+                            response.body,
+                            call_sid: @solution[:call_sid],
+                        )
+                        AnnotationInstanceMetadata.new(
+                            @version,
+                            annotation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the AnnotationInstance
                     # @param [AnsweredBy] answered_by 
@@ -120,6 +147,56 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the AnnotationInstanceMetadata
+                    # @param [AnsweredBy] answered_by 
+                    # @param [ConnectivityIssue] connectivity_issue 
+                    # @param [String] quality_issues Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call.
+                    # @param [Boolean] spam A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call.
+                    # @param [String] call_score Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
+                    # @param [String] comment Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
+                    # @param [String] incident Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
+                    # @return [AnnotationInstance] Updated AnnotationInstance
+                    def update_with_metadata(
+                      answered_by: :unset, 
+                      connectivity_issue: :unset, 
+                      quality_issues: :unset, 
+                      spam: :unset, 
+                      call_score: :unset, 
+                      comment: :unset, 
+                      incident: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AnsweredBy' => answered_by,
+                            'ConnectivityIssue' => connectivity_issue,
+                            'QualityIssues' => quality_issues,
+                            'Spam' => spam,
+                            'CallScore' => call_score,
+                            'Comment' => comment,
+                            'Incident' => incident,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        annotation_instance = AnnotationInstance.new(
+                            @version,
+                            response.body,
+                            call_sid: @solution[:call_sid],
+                        )
+                        AnnotationInstanceMetadata.new(
+                            @version,
+                            annotation_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -136,6 +213,53 @@ module Twilio
                     end
                 end
 
+                class AnnotationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new AnnotationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}AnnotationInstance] annotation_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [AnnotationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, annotation_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @annotation_instance = annotation_instance
+                    end
+
+                    def annotation
+                        @annotation_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.AnnotationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class AnnotationListResponse < InstanceListResource
+                    # @param [Array<AnnotationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @annotation_instance = payload.body[key].map do |data|
+                        AnnotationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def annotation_instance
+                          @instance
+                      end
+                  end
+
                 class AnnotationPage < Page
                     ##
                     # Initialize the AnnotationPage
@@ -145,6 +269,7 @@ module Twilio
                     # @return [AnnotationPage] AnnotationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -164,6 +289,66 @@ module Twilio
                         '<Twilio.Insights.V1.AnnotationPage>'
                     end
                 end
+
+                class AnnotationPageMetadata < PageMetadata
+                    attr_reader :annotation_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @annotation_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @annotation_page << AnnotationListResponse.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
+                        @annotation_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class AnnotationListResponse < InstanceListResource
+
+                    # @param [Array<AnnotationInstance>] 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
+                      @annotation = data_list.map do |data|
+                        AnnotationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def annotation
+                        @annotation
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class AnnotationInstance < InstanceResource
                     ##
                     # Initialize the AnnotationInstance
@@ -177,6 +362,7 @@ module Twilio
                     def initialize(version, payload , call_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'call_sid' => payload['call_sid'],