twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,8 +15,9 @@ module Twilio
             ##
             # Initialize the ConferenceList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account] responsible for
-            #   creating this conference.
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this
+            #   Conference resource.
             # @return [ConferenceList] ConferenceList
             def initialize(version, account_sid: nil)
               super(version)
@@ -28,16 +31,16 @@ module Twilio
             # Lists ConferenceInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [Time] date_updated_before Filter by date updated
-            # @param [Time] date_updated Filter by date updated
-            # @param [Time] date_updated_after Filter by date updated
-            # @param [String] friendly_name Only show results who's friendly name exactly
-            #   matches the string
-            # @param [conference.Status] status A string representing the status of the
-            #   conference. May be `init`, `in-progress`, or `completed`.
+            # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated_before The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated_after The `YYYY-MM-DD` value of the resources to read
+            # @param [String] friendly_name The string that identifies the Conference
+            #   resources to read.
+            # @param [conference.Status] status The status of the resources to read. Can be:
+            #   `init`, `in-progress`, or `completed`.
             # @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
@@ -64,16 +67,16 @@ module Twilio
             # Streams ConferenceInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [Time] date_updated_before Filter by date updated
-            # @param [Time] date_updated Filter by date updated
-            # @param [Time] date_updated_after Filter by date updated
-            # @param [String] friendly_name Only show results who's friendly name exactly
-            #   matches the string
-            # @param [conference.Status] status A string representing the status of the
-            #   conference. May be `init`, `in-progress`, or `completed`.
+            # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated_before The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated_after The `YYYY-MM-DD` value of the resources to read
+            # @param [String] friendly_name The string that identifies the Conference
+            #   resources to read.
+            # @param [conference.Status] status The status of the resources to read. Can be:
+            #   `init`, `in-progress`, or `completed`.
             # @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
@@ -106,7 +109,7 @@ module Twilio
             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],
@@ -116,16 +119,16 @@ module Twilio
             ##
             # Retrieve a single page of ConferenceInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] date_created_before Filter by date created
-            # @param [Time] date_created Filter by date created
-            # @param [Time] date_created_after Filter by date created
-            # @param [Time] date_updated_before Filter by date updated
-            # @param [Time] date_updated Filter by date updated
-            # @param [Time] date_updated_after Filter by date updated
-            # @param [String] friendly_name Only show results who's friendly name exactly
-            #   matches the string
-            # @param [conference.Status] status A string representing the status of the
-            #   conference. May be `init`, `in-progress`, or `completed`.
+            # @param [Time] date_created_before The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_created The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_created_after The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated_before The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated The `YYYY-MM-DD` value of the resources to read
+            # @param [Time] date_updated_after The `YYYY-MM-DD` value of the resources to read
+            # @param [String] friendly_name The string that identifies the Conference
+            #   resources to read.
+            # @param [conference.Status] status The status of the resources to read. Can be:
+            #   `init`, `in-progress`, or `completed`.
             # @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
@@ -191,7 +194,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ConferenceInstance] ConferenceInstance
             def get_instance(payload)
-              ConferenceInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              ConferenceInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -205,18 +208,22 @@ module Twilio
             ##
             # Initialize the ConferenceContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The conference Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+            #   Conference resource(s) to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Conference resource to fetch
             # @return [ConferenceContext] ConferenceContext
             def initialize(version, account_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {account_sid: account_sid, sid: sid}
+              @solution = {account_sid: account_sid, sid: sid, }
               @uri = "/Accounts/#{@solution[:account_sid]}/Conferences/#{@solution[:sid]}.json"
 
               # Dependents
               @participants = nil
+              @recordings = nil
             end
 
             ##
@@ -231,15 +238,31 @@ module Twilio
                   params,
               )
 
-              ConferenceInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              ConferenceInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Update the ConferenceInstance
-            # @param [conference.UpdateStatus] status The status
+            # @param [conference.UpdateStatus] status The new status of the resource. Can be:
+            #   Can be: `init`, `in-progress`, or `completed`. Specifying `completed` will end
+            #   the conference and hang up all participants
+            # @param [String] announce_url The URL we should call to announce something into
+            #   the conference. The URL can return an MP3, a WAV, or a TwiML document with
+            #   `<Play>` or `<Say>`.
+            # @param [String] announce_method The HTTP method used to call `announce_url`. Can
+            #   be: `GET` or `POST` and the default is `POST`
             # @return [ConferenceInstance] Updated ConferenceInstance
-            def update(status: :unset)
-              data = Twilio::Values.of({'Status' => status})
+            def update(status: :unset, announce_url: :unset, announce_method: :unset)
+              data = Twilio::Values.of({
+                  'Status' => status,
+                  'AnnounceUrl' => announce_url,
+                  'AnnounceMethod' => announce_method,
+              })
 
               payload = @version.update(
                   'POST',
@@ -247,7 +270,12 @@ module Twilio
                   data: data,
               )
 
-              ConferenceInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              ConferenceInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
@@ -258,7 +286,7 @@ module Twilio
               raise ArgumentError, 'call_sid cannot be nil' if call_sid.nil?
 
               if call_sid != :unset
-                return ParticipantContext.new(@version, @solution[:account_sid], @solution[:sid], call_sid)
+                return ParticipantContext.new(@version, @solution[:account_sid], @solution[:sid], call_sid, )
               end
 
               unless @participants
@@ -272,12 +300,41 @@ module Twilio
               @participants
             end
 
+            ##
+            # Access the recordings
+            # @return [RecordingList]
+            # @return [RecordingContext] if sid was passed.
+            def recordings(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return RecordingContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
+              end
+
+              unless @recordings
+                @recordings = RecordingList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    conference_sid: @solution[:sid],
+                )
+              end
+
+              @recordings
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.ConferenceContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.ConferenceContext #{context}>"
+            end
           end
 
           class ConferenceInstance < InstanceResource
@@ -285,9 +342,11 @@ module Twilio
             # Initialize the ConferenceInstance
             # @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] responsible for
-            #   creating this conference.
-            # @param [String] sid The conference Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this
+            #   Conference resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Conference resource to fetch
             # @return [ConferenceInstance] ConferenceInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -308,7 +367,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -317,67 +376,67 @@ module Twilio
             # @return [ConferenceContext] ConferenceContext for this ConferenceInstance
             def context
               unless @instance_context
-                @instance_context = ConferenceContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = ConferenceContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The unique sid that identifies this account
+            # @return [String] The SID of the Account that created this resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT that this resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
+            # @return [Time] The RFC 2822 date and time in GMT that this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The api_version
+            # @return [String] The API version used to create this conference
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [String] A human readable description of this resource
+            # @return [String] A string that you assigned to describe this conference room
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The region
+            # @return [String] A string that represents the Twilio Region where the conference was mixed
             def region
               @properties['region']
             end
 
             ##
-            # @return [String] A string that uniquely identifies this conference
+            # @return [String] The unique string that identifies this resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [recording.Status] The status of the conference
+            # @return [conference.Status] The status of this conference
             def status
               @properties['status']
             end
 
             ##
-            # @return [String] The URI for this resource
+            # @return [String] The URI of this resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
 
             ##
-            # @return [String] The subresource_uris
+            # @return [String] A list of related resources identified by their relative URIs
             def subresource_uris
               @properties['subresource_uris']
             end
@@ -391,10 +450,17 @@ module Twilio
 
             ##
             # Update the ConferenceInstance
-            # @param [conference.UpdateStatus] status The status
+            # @param [conference.UpdateStatus] status The new status of the resource. Can be:
+            #   Can be: `init`, `in-progress`, or `completed`. Specifying `completed` will end
+            #   the conference and hang up all participants
+            # @param [String] announce_url The URL we should call to announce something into
+            #   the conference. The URL can return an MP3, a WAV, or a TwiML document with
+            #   `<Play>` or `<Say>`.
+            # @param [String] announce_method The HTTP method used to call `announce_url`. Can
+            #   be: `GET` or `POST` and the default is `POST`
             # @return [ConferenceInstance] Updated ConferenceInstance
-            def update(status: :unset)
-              context.update(status: status)
+            def update(status: :unset, announce_url: :unset, announce_method: :unset)
+              context.update(status: status, announce_url: announce_url, announce_method: announce_method, )
             end
 
             ##
@@ -404,6 +470,13 @@ module Twilio
               context.participants
             end
 
+            ##
+            # Access the recordings
+            # @return [recordings] recordings
+            def recordings
+              context.recordings
+            end
+
             ##
             # Provide a user friendly representation
             def to_s