twilio-ruby 5.18.0 → 5.19.0

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

@@ -16,9 +16,9 @@ module Twilio
               ##
               # Initialize the MediaList
               # @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
-              #   media.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this Media
+              #   resource.
               # @param [String] message_sid A 34 character string that uniquely identifies this
               #   resource.
               # @return [MediaList] MediaList
@@ -34,9 +34,9 @@ module Twilio
               # Lists MediaInstance 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 `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 [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 MediaInstance 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 `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 [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 MediaInstance 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 `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 [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,9 +180,13 @@ module Twilio
               ##
               # Initialize the MediaContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] message_sid The message_sid
-              # @param [String] sid The media 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 Media
+              #   resource(s) to fetch.
+              # @param [String] message_sid The SID of the Message resource that this Media
+              #   resource belongs to.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Media resource to fetch
               # @return [MediaContext] MediaContext
               def initialize(version, account_sid, message_sid, sid)
                 super(version)
@@ -233,12 +237,13 @@ module Twilio
               # Initialize the MediaInstance
               # @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
-              #   media.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this Media
+              #   resource.
               # @param [String] message_sid A 34 character string that uniquely identifies this
               #   resource.
-              # @param [String] sid The media Sid that uniquely identifies this resource
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Media resource to fetch
               # @return [MediaInstance] MediaInstance
               def initialize(version, payload, account_sid: nil, message_sid: nil, sid: nil)
                 super(version)
@@ -280,7 +285,7 @@ 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
@@ -292,31 +297,31 @@ module Twilio
               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 unique id of the resource that created the media.
+              # @return [String] The SID of the resource that created the media
               def parent_sid
                 @properties['parent_sid']
               end
 
               ##
-              # @return [String] A string that uniquely identifies this media
+              # @return [String] The unique string that identifies this resource
               def sid
                 @properties['sid']
               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

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

@@ -16,9 +16,11 @@ module Twilio
               ##
               # Initialize the MemberList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] queue_sid A 34 character string that uniquely identifies this
-              #   queue.
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this Queue
+              #   resource.
+              # @param [String] queue_sid The unique string that that we created to identify
+              #   this Queue resource.
               # @return [MemberList] MemberList
               def initialize(version, account_sid: nil, queue_sid: nil)
                 super(version)
@@ -155,9 +157,12 @@ module Twilio
               ##
               # Initialize the MemberContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] queue_sid The Queue in which to find the members
-              # @param [String] call_sid The call_sid
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created the Member
+              #   resource(s) to fetch.
+              # @param [String] queue_sid The Queue in which to find the members to fetch.
+              # @param [String] call_sid The [Call](https://www.twilio.com/docs/api/voice/call)
+              #   SID of the resource(s) to fetch.
               # @return [MemberContext] MemberContext
               def initialize(version, account_sid, queue_sid, call_sid)
                 super(version)
@@ -190,8 +195,10 @@ module Twilio
 
               ##
               # Update the MemberInstance
-              # @param [String] url The url
-              # @param [String] method The method
+              # @param [String] url The absolute URL of this Queue resource.
+              # @param [String] method How to pass the update request data. Can be `GET` or
+              #   `POST` and the default is `POST`. `POST` sends the data as encoded form data and
+              #   `GET` sends the data as query parameters.
               # @return [MemberInstance] Updated MemberInstance
               def update(url: nil, method: nil)
                 data = Twilio::Values.of({'Url' => url, 'Method' => method, })
@@ -224,10 +231,13 @@ module Twilio
               # Initialize the MemberInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The account_sid
-              # @param [String] queue_sid A 34 character string that uniquely identifies this
-              #   queue.
-              # @param [String] call_sid The call_sid
+              # @param [String] account_sid The SID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) that created this Queue
+              #   resource.
+              # @param [String] queue_sid The unique string that that we created to identify
+              #   this Queue resource.
+              # @param [String] call_sid The [Call](https://www.twilio.com/docs/api/voice/call)
+              #   SID of the resource(s) to fetch.
               # @return [MemberInstance] MemberInstance
               def initialize(version, payload, account_sid: nil, queue_sid: nil, call_sid: nil)
                 super(version)
@@ -267,7 +277,7 @@ module Twilio
               end
 
               ##
-              # @return [String] Unique string that identifies this resource
+              # @return [String] The SID of the Call this resource is associated with
               def call_sid
                 @properties['call_sid']
               end
@@ -285,7 +295,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The uri
+              # @return [String] The URI of this resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
@@ -305,8 +315,10 @@ module Twilio
 
               ##
               # Update the MemberInstance
-              # @param [String] url The url
-              # @param [String] method The method
+              # @param [String] url The absolute URL of this Queue resource.
+              # @param [String] method How to pass the update request data. Can be `GET` or
+              #   `POST` and the default is `POST`. `POST` sends the data as encoded form data and
+              #   `GET` sends the data as query parameters.
               # @return [MemberInstance] Updated MemberInstance
               def update(url: nil, method: nil)
                 context.update(url: url, method: method, )

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

@@ -15,7 +15,9 @@ module Twilio
             ##
             # Initialize the QueueList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) that created this Queue
+            #   resource.
             # @return [QueueList] QueueList
             def initialize(version, account_sid: nil)
               super(version)
@@ -110,8 +112,9 @@ module Twilio
             ##
             # Retrieve a single page of QueueInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name A user-provided string that identifies this queue.
-            # @param [String] max_size The upper limit of calls allowed to be in the queue.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long.
+            # @param [String] max_size The maximum number of calls allowed to be in the queue.
             #   The default is 100. The maximum is 5000.
             # @return [QueueInstance] Newly created QueueInstance
             def create(friendly_name: nil, max_size: :unset)
@@ -166,8 +169,11 @@ module Twilio
             ##
             # Initialize the QueueContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The queue 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 Queue
+            #   resource(s) to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Queue resource to fetch
             # @return [QueueContext] QueueContext
             def initialize(version, account_sid, sid)
               super(version)
@@ -197,9 +203,10 @@ module Twilio
 
             ##
             # Update the QueueInstance
-            # @param [String] friendly_name A human readable description of the queue
-            # @param [String] max_size The maximum number of members that can be in the queue
-            #   at a time
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long.
+            # @param [String] max_size The maximum number of calls allowed to be in the queue.
+            #   The default is 100. The maximum is 5000.
             # @return [QueueInstance] Updated QueueInstance
             def update(friendly_name: :unset, max_size: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, 'MaxSize' => max_size, })
@@ -255,8 +262,11 @@ module Twilio
             # Initialize the QueueInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The queue 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 Queue
+            #   resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Queue resource to fetch
             # @return [QueueInstance] QueueInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -291,7 +301,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created this resource
             def account_sid
               @properties['account_sid']
             end
@@ -303,25 +313,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The count of calls currently in the queue.
+            # @return [String] The number of calls currently in the queue.
             def current_size
               @properties['current_size']
             end
 
             ##
-            # @return [Time] The date_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_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] A user-provided string that identifies this queue.
+            # @return [String] A string that you assigned to describe this resource
             def friendly_name
               @properties['friendly_name']
             end
@@ -333,13 +343,13 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this queue
+            # @return [String] The unique string that identifies this resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The uri
+            # @return [String] The URI of this resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
@@ -353,9 +363,10 @@ module Twilio
 
             ##
             # Update the QueueInstance
-            # @param [String] friendly_name A human readable description of the queue
-            # @param [String] max_size The maximum number of members that can be in the queue
-            #   at a time
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long.
+            # @param [String] max_size The maximum number of calls allowed to be in the queue.
+            #   The default is 100. The maximum is 5000.
             # @return [QueueInstance] Updated QueueInstance
             def update(friendly_name: :unset, max_size: :unset)
               context.update(friendly_name: friendly_name, max_size: max_size, )

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

@@ -15,9 +15,9 @@ module Twilio
             ##
             # Initialize the ShortCodeList
             # @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) that owns this short
-            #   code.
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) that created this
+            #   ShortCode resource.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, account_sid: nil)
               super(version)
@@ -31,8 +31,8 @@ module Twilio
             # Lists ShortCodeInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] friendly_name Only show the ShortCode resources with friendly
-            #   names that exactly match this name.
+            # @param [String] friendly_name The string that identifies the ShortCode resources
+            #   to read.
             # @param [String] short_code Only show the ShortCode resources that match this
             #   pattern. You can specify partial numbers and use '*' as a wildcard for any
             #   digit.
@@ -56,8 +56,8 @@ module Twilio
             # Streams ShortCodeInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] friendly_name Only show the ShortCode resources with friendly
-            #   names that exactly match this name.
+            # @param [String] friendly_name The string that identifies the ShortCode resources
+            #   to read.
             # @param [String] short_code Only show the ShortCode resources that match this
             #   pattern. You can specify partial numbers and use '*' as a wildcard for any
             #   digit.
@@ -97,8 +97,8 @@ module Twilio
             ##
             # Retrieve a single page of ShortCodeInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name Only show the ShortCode resources with friendly
-            #   names that exactly match this name.
+            # @param [String] friendly_name The string that identifies the ShortCode resources
+            #   to read.
             # @param [String] short_code Only show the ShortCode resources that match this
             #   pattern. You can specify partial numbers and use '*' as a wildcard for any
             #   digit.
@@ -175,8 +175,11 @@ module Twilio
             ##
             # Initialize the ShortCodeContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The short-code 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
+            #   ShortCode resource(s) to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch
             # @return [ShortCodeContext] ShortCodeContext
             def initialize(version, account_sid, sid)
               super(version)
@@ -203,19 +206,19 @@ module Twilio
 
             ##
             # Update the ShortCodeInstance
-            # @param [String] friendly_name A human readable descriptive text for this
-            #   resource, up to 64 characters long. By default, the `FriendlyName` is just the
-            #   short code.
-            # @param [String] api_version SMSs to this short code will start a new TwiML
-            #   session with this API version. Either `2010-04-01` or `2008-08-01`.
-            # @param [String] sms_url The URL Twilio will request when receiving an incoming
-            #   SMS message to this short code.
-            # @param [String] sms_method The HTTP method Twilio will use when making requests
-            #   to the `SmsUrl`. Either `GET` or `POST`.
-            # @param [String] sms_fallback_url The URL that Twilio will request if an error
-            #   occurs retrieving or executing the TwiML from `SmsUrl`.
-            # @param [String] sms_fallback_method The HTTP method that should be used to
-            #   request the `SmsFallbackUrl`. Either `GET` or `POST`.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long. By default, the
+            #   `FriendlyName` is the short code.
+            # @param [String] api_version The API version to use to start a new TwiML session.
+            #   Can be: `2010-04-01` or `2008-08-01`.
+            # @param [String] sms_url The URL we should call when receiving an incoming SMS
+            #   message to this short code.
+            # @param [String] sms_method The HTTP method we should use when calling the
+            #   `sms_url`. Can be: `GET` or `POST`.
+            # @param [String] sms_fallback_url The URL that we should call if an error occurs
+            #   while retrieving or executing the TwiML from `sms_url`.
+            # @param [String] sms_fallback_method The HTTP method that we should use to call
+            #   the `sms_fallback_url`. Can be: `GET` or `POST`.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(friendly_name: :unset, api_version: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset)
               data = Twilio::Values.of({
@@ -249,10 +252,11 @@ module Twilio
             # Initialize the ShortCodeInstance
             # @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) that owns this short
-            #   code.
-            # @param [String] sid The short-code 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
+            #   ShortCode resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   ShortCode resource to fetch
             # @return [ShortCodeInstance] ShortCodeInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -290,31 +294,31 @@ 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 API version to use
+            # @return [String] The API version used to start a new TwiML session
             def api_version
               @properties['api_version']
             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] A human readable description of this resource
+            # @return [String] A string that you assigned to describe this resource
             def friendly_name
               @properties['friendly_name']
             end
@@ -326,13 +330,13 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this short-codes
+            # @return [String] The unique string that identifies this resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] HTTP method Twilio will use with sms fallback url
+            # @return [String] HTTP method we use to call the sms_fallback_url
             def sms_fallback_method
               @properties['sms_fallback_method']
             end
@@ -350,13 +354,13 @@ module Twilio
             end
 
             ##
-            # @return [String] URL Twilio will request when receiving an SMS
+            # @return [String] URL we call when receiving an incoming SMS message to this short code
             def sms_url
               @properties['sms_url']
             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
@@ -370,19 +374,19 @@ module Twilio
 
             ##
             # Update the ShortCodeInstance
-            # @param [String] friendly_name A human readable descriptive text for this
-            #   resource, up to 64 characters long. By default, the `FriendlyName` is just the
-            #   short code.
-            # @param [String] api_version SMSs to this short code will start a new TwiML
-            #   session with this API version. Either `2010-04-01` or `2008-08-01`.
-            # @param [String] sms_url The URL Twilio will request when receiving an incoming
-            #   SMS message to this short code.
-            # @param [String] sms_method The HTTP method Twilio will use when making requests
-            #   to the `SmsUrl`. Either `GET` or `POST`.
-            # @param [String] sms_fallback_url The URL that Twilio will request if an error
-            #   occurs retrieving or executing the TwiML from `SmsUrl`.
-            # @param [String] sms_fallback_method The HTTP method that should be used to
-            #   request the `SmsFallbackUrl`. Either `GET` or `POST`.
+            # @param [String] friendly_name A descriptive string that you created to describe
+            #   this resource. It can be up to 64 characters long. By default, the
+            #   `FriendlyName` is the short code.
+            # @param [String] api_version The API version to use to start a new TwiML session.
+            #   Can be: `2010-04-01` or `2008-08-01`.
+            # @param [String] sms_url The URL we should call when receiving an incoming SMS
+            #   message to this short code.
+            # @param [String] sms_method The HTTP method we should use when calling the
+            #   `sms_url`. Can be: `GET` or `POST`.
+            # @param [String] sms_fallback_url The URL that we should call if an error occurs
+            #   while retrieving or executing the TwiML from `sms_url`.
+            # @param [String] sms_fallback_method The HTTP method that we should use to call
+            #   the `sms_fallback_url`. Can be: `GET` or `POST`.
             # @return [ShortCodeInstance] Updated ShortCodeInstance
             def update(friendly_name: :unset, api_version: :unset, sms_url: :unset, sms_method: :unset, sms_fallback_url: :unset, sms_fallback_method: :unset)
               context.update(