lib/twilio-ruby/rest/insights/v1/call/event.rb in twilio-ruby-5.77.0 vs lib/twilio-ruby/rest/insights/v1/call/event.rb in twilio-ruby-6.0.0.pre.rc.1
- old
+ new
@@ -1,262 +1,278 @@
##
-# This code was generated by
-# \ / _ _ _| _ _
-# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# This code was generated by
+# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
+# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
+# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
#
-# frozen_string_literal: true
+# 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.
+#
+
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)
+ module REST
+ class Insights < InsightsBase
+ class V1 < Version
+ class CallContext < InstanceContext
- # Path Solution
- @solution = {call_sid: call_sid}
- @uri = "/Voice/#{@solution[:call_sid]}/Events"
- end
+ 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
+ # @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
- ##
- # 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 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
+ # @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)
- ##
- # 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], )
- page = self.page(edge: edge, page_size: limits[:page_size], )
+ @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+ end
- @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
- ##
- # 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], )
- page = self.page(page_size: limits[:page_size], )
+ @version.stream(page,
+ limit: limits[:limit],
+ page_limit: limits[:page_limit]).each {|x| yield x}
+ end
- @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
+ # @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,
+ })
- ##
- # 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)
- response = @version.page('GET', @uri, params: params)
+ EventPage.new(@version, response, @solution)
+ end
- 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
+
- ##
- # 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
+ # 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)
+ 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
+ # 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
+ ##
+ # 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
+ ##
+ # Provide a user friendly representation
+ def to_s
+ '<Twilio.Insights.V1.EventPage>'
+ 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
- ##
- # 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)
+
+ ##
+ # @return [String]
+ def timestamp
+ @properties['timestamp']
+ end
+
+ ##
+ # @return [String]
+ def call_sid
+ @properties['call_sid']
+ end
+
+ ##
+ # @return [String]
+ def account_sid
+ @properties['account_sid']
+ end
+
+ ##
+ # @return [TwilioEdge]
+ def edge
+ @properties['edge']
+ end
+
+ ##
+ # @return [String]
+ def group
+ @properties['group']
+ end
+
+ ##
+ # @return [Level]
+ def level
+ @properties['level']
+ end
+
+ ##
+ # @return [String]
+ def name
+ @properties['name']
+ end
+
+ ##
+ # @return [Hash]
+ def carrier_edge
+ @properties['carrier_edge']
+ end
+
+ ##
+ # @return [Hash]
+ def sip_edge
+ @properties['sip_edge']
+ end
+
+ ##
+ # @return [Hash]
+ def sdk_edge
+ @properties['sdk_edge']
+ end
+
+ ##
+ # @return [Hash]
+ def client_edge
+ @properties['client_edge']
+ end
+
+ ##
+ # Provide a user friendly representation
+ def to_s
+ "<Twilio.Insights.V1.EventInstance>"
+ end
- # 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
+ ##
+ # Provide a detailed, user friendly representation
+ def inspect
+ "<Twilio.Insights.V1.EventInstance>"
+ end
+ end
- ##
- # @return [String] The timestamp
- def timestamp
- @properties['timestamp']
+ end
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>"
- end
- end
end
- end
end
- end
-end
\ No newline at end of file
+end
+
+