twilio-ruby 5.18.0 → 5.19.0

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

@@ -16,11 +16,11 @@ module Twilio
               ##
               # Initialize the RecordingList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The unique ID of the
-              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
-              #   recording.
-              # @param [String] conference_sid The unique id for the conference associated with
-              #   the recording.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+              #   ConferenceRecording resource.
+              # @param [String] conference_sid The Conference SID that identifies the conference
+              #   associated with the recording.
               # @return [RecordingList] RecordingList
               def initialize(version, account_sid: nil, conference_sid: nil)
                 super(version)
@@ -34,9 +34,9 @@ module Twilio
               # Lists RecordingInstance 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_created_before The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
+              # @param [Time] date_created The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
+              # @param [Time] date_created_after The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
               # @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
@@ -58,9 +58,9 @@ module Twilio
               # Streams RecordingInstance 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_created_before The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
+              # @param [Time] date_created The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
+              # @param [Time] date_created_after The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
               # @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
@@ -98,9 +98,9 @@ module Twilio
               ##
               # Retrieve a single page of RecordingInstance 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_created_before The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
+              # @param [Time] date_created The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
+              # @param [Time] date_created_after The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read
               # @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
@@ -180,10 +180,13 @@ module Twilio
               ##
               # Initialize the RecordingContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] conference_sid The conference Sid that uniquely identifies this
-              #   resource
-              # @param [String] sid The recording Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created the
+              #   ConferenceRecording resource(s) to fetch.
+              # @param [String] conference_sid The Conference SID that identifies the conference
+              #   associated with the recording to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   ConferenceRecording resource to fetch
               # @return [RecordingContext] RecordingContext
               def initialize(version, account_sid, conference_sid, sid)
                 super(version)
@@ -195,12 +198,13 @@ module Twilio
 
               ##
               # Update the RecordingInstance
-              # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values: `stopped`, `paused`, `in-progress`
-              # @param [String] pause_behavior Only applicable when setting Status parameter to
-              #   `paused`. Possible values: `skip` or `silence`. `skip` will result in no
-              #   recording at all during the pause period. `silence` will replace the actual
-              #   audio of the call with silence during the pause period.  Defaults to `silence`
+              # @param [recording.Status] status The new status of the resource. Can be:
+              #   `stopped`, `paused`, or `in-progress`
+              # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
+              #   or `silence` and the default is `silence`.  `skip` does not record during the
+              #   pause period, while `silence` will replace the actual audio of the call with
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
               # @return [RecordingInstance] Updated RecordingInstance
               def update(status: nil, pause_behavior: :unset)
                 data = Twilio::Values.of({'Status' => status, 'PauseBehavior' => pause_behavior, })
@@ -261,12 +265,13 @@ module Twilio
               # Initialize the RecordingInstance
               # @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/api/rest/account) responsible for this
-              #   recording.
-              # @param [String] conference_sid The unique id for the conference associated with
-              #   the recording.
-              # @param [String] sid The recording Sid that uniquely identifies this resource
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+              #   ConferenceRecording resource.
+              # @param [String] conference_sid The Conference SID that identifies the conference
+              #   associated with the recording.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   ConferenceRecording resource to fetch
               # @return [RecordingInstance] RecordingInstance
               def initialize(version, payload, account_sid: nil, conference_sid: nil, sid: nil)
                 super(version)
@@ -318,115 +323,116 @@ module Twilio
               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 [String] The version of the API in use during the recording.
+              # @return [String] The API version used to create the recording
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [String] The unique id for the call leg that corresponds to the recording.
+              # @return [String] The SID of the Call this resource is associated with
               def call_sid
                 @properties['call_sid']
               end
 
               ##
-              # @return [String] The unique id for the conference associated with the recording.
+              # @return [String] The Conference SID that identifies the conference associated with the recording
               def conference_sid
                 @properties['conference_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 [Time] The start time of the recording, given in RFC 2822 format.
+              # @return [Time] The start time of the recording, given in RFC 2822 format
               def start_time
                 @properties['start_time']
               end
 
               ##
-              # @return [String] The length of the recording, in seconds.
+              # @return [String] The length of the recording, in seconds
               def duration
                 @properties['duration']
               end
 
               ##
-              # @return [String] A string that uniquely identifies this recording
+              # @return [String] The unique string that identifies this resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The one-time cost of creating this recording.
+              # @return [String] The one-time cost of creating this recording
               def price
                 @properties['price']
               end
 
               ##
-              # @return [String] The currency used in the Price property.
+              # @return [String] The currency used in the price property
               def price_unit
                 @properties['price_unit']
               end
 
               ##
-              # @return [recording.Status] The status of the recording.
+              # @return [recording.Status] The status of this recording
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The number of channels in the final recording file as an integer.
+              # @return [String] The number of channels in the final recording file as an integer
               def channels
                 @properties['channels']
               end
 
               ##
-              # @return [recording.Source] The way in which this recording was created.
+              # @return [recording.Source] How this recording was created
               def source
                 @properties['source']
               end
 
               ##
-              # @return [String] More information about why the recording is missing, if Status is `absent`.
+              # @return [String] More information about why the recording is missing, if Status is `absent`
               def error_code
                 @properties['error_code']
               end
 
               ##
-              # @return [Hash] Details for how to decrypt the recording.
+              # @return [Hash] Details about how to decrypt the recording
               def encryption_details
                 @properties['encryption_details']
               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
 
               ##
               # Update the RecordingInstance
-              # @param [recording.Status] status The status to change the recording to. 
-              #   Possible values: `stopped`, `paused`, `in-progress`
-              # @param [String] pause_behavior Only applicable when setting Status parameter to
-              #   `paused`. Possible values: `skip` or `silence`. `skip` will result in no
-              #   recording at all during the pause period. `silence` will replace the actual
-              #   audio of the call with silence during the pause period.  Defaults to `silence`
+              # @param [recording.Status] status The new status of the resource. Can be:
+              #   `stopped`, `paused`, or `in-progress`
+              # @param [String] pause_behavior Whether to record during a pause. Can be: `skip`
+              #   or `silence` and the default is `silence`.  `skip` does not record during the
+              #   pause period, while `silence` will replace the actual audio of the call with
+              #   silence during the pause period. This parameter only applies when setting
+              #   `status` is set to `paused`.
               # @return [RecordingInstance] Updated RecordingInstance
               def update(status: nil, pause_behavior: :unset)
                 context.update(status: status, pause_behavior: pause_behavior, )

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

@@ -15,9 +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](https://www.twilio.com/docs/api/rest/account) responsible for creating
-            #   this conference.
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+            #   Conference resource.
             # @return [ConferenceList] ConferenceList
             def initialize(version, account_sid: nil)
               super(version)
@@ -31,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
@@ -67,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
@@ -119,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
@@ -208,8 +208,11 @@ 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/api/rest/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)
@@ -245,12 +248,14 @@ module Twilio
 
             ##
             # Update the ConferenceInstance
-            # @param [conference.UpdateStatus] status Specifying `completed` will end the
-            #   conference and kick all participants
-            # @param [String] announce_url The 'AnnounceUrl' attribute lets you specify a URL
-            #   for announcing something into a conference. The URL may return an MP3, a WAV or
-            #   a TwiML document with `<Play>` or `<Say>`.
-            # @param [String] announce_method Specify GET or POST, defaults to POST
+            # @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, announce_url: :unset, announce_method: :unset)
               data = Twilio::Values.of({
@@ -330,10 +335,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](https://www.twilio.com/docs/api/rest/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/api/rest/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)
@@ -369,61 +375,61 @@ module Twilio
             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] A string representing the Twilio Region where the conference was mixed.
+            # @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 [conference.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
@@ -437,12 +443,14 @@ module Twilio
 
             ##
             # Update the ConferenceInstance
-            # @param [conference.UpdateStatus] status Specifying `completed` will end the
-            #   conference and kick all participants
-            # @param [String] announce_url The 'AnnounceUrl' attribute lets you specify a URL
-            #   for announcing something into a conference. The URL may return an MP3, a WAV or
-            #   a TwiML document with `<Play>` or `<Say>`.
-            # @param [String] announce_method Specify GET or POST, defaults to POST
+            # @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, announce_url: :unset, announce_method: :unset)
               context.update(status: status, announce_url: announce_url, announce_method: announce_method, )