twilio-ruby 5.31.0 → 5.46.0

data/lib/twilio-ruby/rest/api/v2010/account/call/event.rb

@@ -0,0 +1,201 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class CallContext < InstanceContext
+            class EventList < ListResource
+              ##
+              # Initialize the EventList
+              # @param [Version] version Version that contains the resource
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
+              #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
+              # @return [EventList] EventList
+              def initialize(version, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {account_sid: account_sid, call_sid: call_sid}
+                @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Events.json"
+              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 [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(limit: nil, page_size: nil)
+                self.stream(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 [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(limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(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 [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(page_token: :unset, page_number: :unset, page_size: :unset)
+                params = Twilio::Values.of({
+                    '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.Api.V2010.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,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Api.V2010.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 Call
+              #   resource.
+              # @param [String] call_sid The unique string that that we created to identify this
+              #   Call resource.
+              # @return [EventInstance] EventInstance
+              def initialize(version, payload, account_sid: nil, call_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {'request' => payload['request'], 'response' => payload['response'], }
+              end
+
+              ##
+              # @return [Hash] Call Request.
+              def request
+                @properties['request']
+              end
+
+              ##
+              # @return [Hash] Call Response with Events.
+              def response
+                @properties['response']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Api.V2010.EventInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Api.V2010.EventInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback.rb

@@ -17,7 +17,7 @@ module Twilio
               # Initialize the FeedbackList
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
               # @param [String] call_sid The unique string that that we created to identify this
               #   Call resource.
@@ -75,7 +75,7 @@ module Twilio
               # Initialize the FeedbackContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
               # @param [String] call_sid The call sid that uniquely identifies the call
               # @return [FeedbackContext] FeedbackContext
@@ -88,27 +88,22 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackInstance records from the API.
-              # Request is executed immediately.
+              # Create the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue A list of one or more issues experienced during
-              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
-              # @return [FeedbackInstance] Newly created FeedbackInstance
+              # @return [FeedbackInstance] Created FeedbackInstance
               def create(quality_score: nil, issue: :unset)
                 data = Twilio::Values.of({
                     'QualityScore' => quality_score,
                     'Issue' => Twilio.serialize_list(issue) { |e| e },
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FeedbackInstance.new(
                     @version,
@@ -119,16 +114,10 @@ module Twilio
               end
 
               ##
-              # Fetch a FeedbackInstance
+              # Fetch the FeedbackInstance
               # @return [FeedbackInstance] Fetched FeedbackInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FeedbackInstance.new(
                     @version,
@@ -143,10 +132,10 @@ module Twilio
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue One or more issues experienced during the call.
-              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
-              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
-              #   or `one-way-audio`.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
               def update(quality_score: nil, issue: :unset)
                 data = Twilio::Values.of({
@@ -154,11 +143,7 @@ module Twilio
                     'Issue' => Twilio.serialize_list(issue) { |e| e },
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 FeedbackInstance.new(
                     @version,
@@ -189,7 +174,7 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
               # @param [String] call_sid The unique string that that we created to identify this
               #   Call resource.
@@ -242,7 +227,7 @@ module Twilio
               end
 
               ##
-              # @return [feedback.Issues] Issues experienced during the call
+              # @return [Array[feedback.Issues]] Issues experienced during the call
               def issues
                 @properties['issues']
               end
@@ -260,22 +245,21 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackInstance records from the API.
-              # Request is executed immediately.
+              # Create the FeedbackInstance
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue A list of one or more issues experienced during
-              #   the call. Issues can be: `imperfect-audio`, `dropped-call`,
+              # @param [Array[feedback.Issues]] issue A list of one or more issues experienced
+              #   during the call. Issues can be: `imperfect-audio`, `dropped-call`,
               #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
               #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
-              # @return [FeedbackInstance] Newly created FeedbackInstance
+              # @return [FeedbackInstance] Created FeedbackInstance
               def create(quality_score: nil, issue: :unset)
                 context.create(quality_score: quality_score, issue: issue, )
               end
 
               ##
-              # Fetch a FeedbackInstance
+              # Fetch the FeedbackInstance
               # @return [FeedbackInstance] Fetched FeedbackInstance
               def fetch
                 context.fetch
@@ -286,10 +270,10 @@ module Twilio
               # @param [String] quality_score The call quality expressed as an integer from `1`
               #   to `5` where `1` represents very poor call quality and `5` represents a perfect
               #   call.
-              # @param [feedback.Issues] issue One or more issues experienced during the call.
-              #   The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`,
-              #   `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`,
-              #   or `one-way-audio`.
+              # @param [Array[feedback.Issues]] issue One or more issues experienced during the
+              #   call. The issues can be: `imperfect-audio`, `dropped-call`,
+              #   `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`,
+              #   `audio-latency`, `unsolicited-call`, or `one-way-audio`.
               # @return [FeedbackInstance] Updated FeedbackInstance
               def update(quality_score: nil, issue: :unset)
                 context.update(quality_score: quality_score, issue: issue, )

data/lib/twilio-ruby/rest/api/v2010/account/call/feedback_summary.rb

@@ -17,7 +17,7 @@ module Twilio
               # Initialize the FeedbackSummaryList
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The SID of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Call
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
               #   resource.
               # @return [FeedbackSummaryList] FeedbackSummaryList
               def initialize(version, account_sid: nil)
@@ -29,8 +29,7 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackSummaryInstance records from the API.
-              # Request is executed immediately.
+              # Create the FeedbackSummaryInstance
               # @param [Date] start_date Only include feedback given on or after this date.
               #   Format is `YYYY-MM-DD` and specified in UTC.
               # @param [Date] end_date Only include feedback given on or before this date.
@@ -42,7 +41,7 @@ module Twilio
               #   summary is complete.
               # @param [String] status_callback_method The HTTP method (`GET` or `POST`) we use
               #   to make the request to the `StatusCallback` URL.
-              # @return [FeedbackSummaryInstance] Newly created FeedbackSummaryInstance
+              # @return [FeedbackSummaryInstance] Created FeedbackSummaryInstance
               def create(start_date: nil, end_date: nil, include_subaccounts: :unset, status_callback: :unset, status_callback_method: :unset)
                 data = Twilio::Values.of({
                     'StartDate' => Twilio.serialize_iso8601_date(start_date),
@@ -52,11 +51,7 @@ module Twilio
                     'StatusCallbackMethod' => status_callback_method,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FeedbackSummaryInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
@@ -102,7 +97,7 @@ module Twilio
               # Initialize the FeedbackSummaryContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The unique id of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] responsible for this
               #   resource.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   resource.
@@ -116,16 +111,10 @@ module Twilio
               end
 
               ##
-              # Fetch a FeedbackSummaryInstance
+              # Fetch the FeedbackSummaryInstance
               # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FeedbackSummaryInstance.new(
                     @version,
@@ -136,10 +125,10 @@ module Twilio
               end
 
               ##
-              # Deletes the FeedbackSummaryInstance
+              # Delete the FeedbackSummaryInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -163,7 +152,7 @@ module Twilio
               # @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 Call
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Call
               #   resource.
               # @param [String] sid A 34 character string that uniquely identifies this
               #   resource.
@@ -248,7 +237,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Issues experienced during the call
+              # @return [Array[String]] Issues experienced during the call
               def issues
                 @properties['issues']
               end
@@ -290,14 +279,14 @@ module Twilio
               end
 
               ##
-              # Fetch a FeedbackSummaryInstance
+              # Fetch the FeedbackSummaryInstance
               # @return [FeedbackSummaryInstance] Fetched FeedbackSummaryInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the FeedbackSummaryInstance
+              # Delete the FeedbackSummaryInstance
               # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete