twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,262 +1,367 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Insights
+#    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.
 #
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class Insights < Domain
-      class V1 < Version
-        class CallContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class EventList < ListResource
-            ##
-            # Initialize the EventList
-            # @param [Version] version Version that contains the resource
-            # @param [String] call_sid The call_sid
-            # @return [EventList] EventList
-            def initialize(version, call_sid: nil)
-              super(version)
-
-              # Path Solution
-              @solution = {call_sid: call_sid}
-              @uri = "/Voice/#{@solution[:call_sid]}/Events"
-            end
-
-            ##
-            # Lists EventInstance records from the API as a list.
-            # Unlike stream(), this operation is eager and will load `limit` records into
-            # memory before returning.
-            # @param [event.TwilioEdge] edge The edge
-            # @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(edge: :unset, limit: nil, page_size: nil)
-              self.stream(edge: edge, limit: limit, page_size: page_size).entries
-            end
-
-            ##
-            # Streams EventInstance records from the API as an Enumerable.
-            # This operation lazily loads records as efficiently as possible until the limit
-            # is reached.
-            # @param [event.TwilioEdge] edge The edge
-            # @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 [Enumerable] Enumerable that will yield up to limit results
-            def stream(edge: :unset, limit: nil, page_size: nil)
-              limits = @version.read_limits(limit, page_size)
-
-              page = self.page(edge: edge, page_size: limits[:page_size], )
-
-              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-            end
-
-            ##
-            # When passed a block, yields EventInstance records from the API.
-            # This operation lazily loads records as efficiently as possible until the limit
-            # is reached.
-            def each
-              limits = @version.read_limits
-
-              page = self.page(page_size: limits[:page_size], )
-
-              @version.stream(page,
-                              limit: limits[:limit],
-                              page_limit: limits[:page_limit]).each {|x| yield x}
-            end
-
-            ##
-            # Retrieve a single page of EventInstance records from the API.
-            # Request is executed immediately.
-            # @param [event.TwilioEdge] edge The edge
-            # @param [String] page_token PageToken provided by the API
-            # @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 EventInstance
-            def page(edge: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
-              params = Twilio::Values.of({
-                  'Edge' => edge,
-                  'PageToken' => page_token,
-                  'Page' => page_number,
-                  'PageSize' => page_size,
-              })
-
-              response = @version.page('GET', @uri, params: params)
-
-              EventPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Retrieve a single page of EventInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of EventInstance
-            def get_page(target_url)
-              response = @version.domain.request(
-                  'GET',
-                  target_url
-              )
-              EventPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '#<Twilio.Insights.V1.EventList>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class EventPage < Page
-            ##
-            # Initialize the EventPage
-            # @param [Version] version Version that contains the resource
-            # @param [Response] response Response from the API
-            # @param [Hash] solution Path solution for the resource
-            # @return [EventPage] EventPage
-            def initialize(version, response, solution)
-              super(version, response)
-
-              # Path Solution
-              @solution = solution
-            end
-
-            ##
-            # Build an instance of EventInstance
-            # @param [Hash] payload Payload response from the API
-            # @return [EventInstance] EventInstance
-            def get_instance(payload)
-              EventInstance.new(@version, payload, call_sid: @solution[:call_sid], )
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '<Twilio.Insights.V1.EventPage>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class EventInstance < InstanceResource
-            ##
-            # Initialize the EventInstance
-            # @param [Version] version Version that contains the resource
-            # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] call_sid The call_sid
-            # @return [EventInstance] EventInstance
-            def initialize(version, payload, call_sid: nil)
-              super(version)
-
-              # Marshaled Properties
-              @properties = {
-                  'timestamp' => payload['timestamp'],
-                  'call_sid' => payload['call_sid'],
-                  'account_sid' => payload['account_sid'],
-                  'edge' => payload['edge'],
-                  'group' => payload['group'],
-                  'level' => payload['level'],
-                  'name' => payload['name'],
-                  'carrier_edge' => payload['carrier_edge'],
-                  'sip_edge' => payload['sip_edge'],
-                  'sdk_edge' => payload['sdk_edge'],
-                  'client_edge' => payload['client_edge'],
-              }
-            end
-
-            ##
-            # @return [String] The timestamp
-            def timestamp
-              @properties['timestamp']
-            end
-
-            ##
-            # @return [String] The call_sid
-            def call_sid
-              @properties['call_sid']
-            end
-
-            ##
-            # @return [String] The account_sid
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [event.TwilioEdge] The edge
-            def edge
-              @properties['edge']
-            end
-
-            ##
-            # @return [String] The group
-            def group
-              @properties['group']
-            end
-
-            ##
-            # @return [event.Level] The level
-            def level
-              @properties['level']
-            end
-
-            ##
-            # @return [String] The name
-            def name
-              @properties['name']
-            end
-
-            ##
-            # @return [Hash] The carrier_edge
-            def carrier_edge
-              @properties['carrier_edge']
-            end
-
-            ##
-            # @return [Hash] The sip_edge
-            def sip_edge
-              @properties['sip_edge']
-            end
-
-            ##
-            # @return [Hash] The sdk_edge
-            def sdk_edge
-              @properties['sdk_edge']
-            end
-
-            ##
-            # @return [Hash] The client_edge
-            def client_edge
-              @properties['client_edge']
-            end
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              "<Twilio.Insights.V1.EventInstance>"
-            end
 
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              "<Twilio.Insights.V1.EventInstance>"
+module Twilio
+    module REST
+        class Insights < InsightsBase
+            class V1 < Version
+                class CallContext < InstanceContext
+
+                     class EventList < ListResource
+                
+                    ##
+                    # Initialize the EventList
+                    # @param [Version] version Version that contains the resource
+                    # @return [EventList] EventList
+                    def initialize(version, call_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { call_sid: call_sid }
+                        @uri = "/Voice/#{@solution[:call_sid]}/Events"
+                        
+                    end
+                
+                    ##
+                    # Lists EventInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @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(edge: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            edge: edge,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @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 [Enumerable] Enumerable that will yield up to limit results
+                    def stream(edge: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            edge: edge,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # Lists EventPageMetadata records from the API as a list.
+                      # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @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(edge: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Edge' => edge,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        EventPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields EventInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of EventInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [TwilioEdge] edge The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
+                    # @param [String] page_token PageToken provided by the API
+                    # @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 EventInstance
+                    def page(edge: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
+                        params = Twilio::Values.of({
+                            'Edge' => edge,
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        EventPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of EventInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of EventInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    EventPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Insights.V1.EventList>'
+                    end
+                end
+
+                class EventPage < Page
+                    ##
+                    # Initialize the EventPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [EventPage] EventPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of EventInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [EventInstance] EventInstance
+                    def get_instance(payload)
+                        EventInstance.new(@version, payload, call_sid: @solution[:call_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Insights.V1.EventPage>'
+                    end
+                end
+
+                class EventPageMetadata < PageMetadata
+                    attr_reader :event_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @event_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @event_page << EventListResponse.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
+                        @event_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Insights::V1PageMetadata>';
+                    end
+                end
+                class EventListResponse < InstanceListResource
+
+                    # @param [Array<EventInstance>] 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
+                      @event = data_list.map do |data|
+                        EventInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def event
+                        @event
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class EventInstance < InstanceResource
+                    ##
+                    # Initialize the EventInstance
+                    # @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 Event
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [EventInstance] EventInstance
+                    def initialize(version, payload , call_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'timestamp' => payload['timestamp'],
+                            'call_sid' => payload['call_sid'],
+                            'account_sid' => payload['account_sid'],
+                            'edge' => payload['edge'],
+                            'group' => payload['group'],
+                            'level' => payload['level'],
+                            'name' => payload['name'],
+                            'carrier_edge' => payload['carrier_edge'],
+                            'sip_edge' => payload['sip_edge'],
+                            'sdk_edge' => payload['sdk_edge'],
+                            'client_edge' => payload['client_edge'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] Event time.
+                    def timestamp
+                        @properties['timestamp']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Call.
+                    def call_sid
+                        @properties['call_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Account.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [TwilioEdge] 
+                    def edge
+                        @properties['edge']
+                    end
+                    
+                    ##
+                    # @return [String] Event group.
+                    def group
+                        @properties['group']
+                    end
+                    
+                    ##
+                    # @return [Level] 
+                    def level
+                        @properties['level']
+                    end
+                    
+                    ##
+                    # @return [String] Event name.
+                    def name
+                        @properties['name']
+                    end
+                    
+                    ##
+                    # @return [Hash] Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways.
+                    def carrier_edge
+                        @properties['carrier_edge']
+                    end
+                    
+                    ##
+                    # @return [Hash] Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways.
+                    def sip_edge
+                        @properties['sip_edge']
+                    end
+                    
+                    ##
+                    # @return [Hash] Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions.
+                    def sdk_edge
+                        @properties['sdk_edge']
+                    end
+                    
+                    ##
+                    # @return [Hash] Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways.
+                    def client_edge
+                        @properties['client_edge']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Insights.V1.EventInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Insights.V1.EventInstance>"
+                    end
+                end
+
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+