RubyGems - twilio-ruby - Versions diffs - 5.8.1 → 5.9.0 - Mend

twilio-ruby 5.8.1 → 5.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (572) hide show

data/lib/twilio-ruby/rest/api/v2010/account/new_key.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/new_signing_key.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/notification.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the NotificationList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
+            # @param [String] account_sid The unique id of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
             #   notification.
             # @return [NotificationList] NotificationList
             def initialize(version, account_sid: nil)
@@ -28,7 +31,8 @@ module Twilio
             # Lists NotificationInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] log Only show notifications for this log level
+            # @param [String] log Only show notifications for this log, using the integer log
+            #   values shown above.
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
             # @param [Time] message_date_after Filter by date
@@ -54,7 +58,8 @@ module Twilio
             # Streams NotificationInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] log Only show notifications for this log level
+            # @param [String] log Only show notifications for this log, using the integer log
+            #   values shown above.
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
             # @param [Time] message_date_after Filter by date
@@ -96,7 +101,8 @@ module Twilio
             ##
             # Retrieve a single page of NotificationInstance records from the API.
             # Request is executed immediately.
-            # @param [String] log Only show notifications for this log level
+            # @param [String] log Only show notifications for this log, using the integer log
+            #   values shown above.
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
             # @param [Time] message_date_after Filter by date
@@ -226,7 +232,8 @@ module Twilio
             # Initialize the NotificationInstance
             # @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 this
+            # @param [String] account_sid The unique id of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) responsible for this
             #   notification.
             # @param [String] sid The notification Sid that uniquely identifies this resource
             # @return [NotificationInstance] NotificationInstance

data/lib/twilio-ruby/rest/api/v2010/account/outgoing_caller_id.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the OutgoingCallerIdList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
+            # @param [String] account_sid The unique ID of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
             #   Caller Id.
             # @return [OutgoingCallerIdList] OutgoingCallerIdList
             def initialize(version, account_sid: nil)
@@ -29,9 +32,9 @@ module Twilio
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number
+            #   matches this phone number.
             # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name
+            #   matches this name.
             # @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
@@ -53,9 +56,9 @@ module Twilio
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number
+            #   matches this phone number.
             # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name
+            #   matches this name.
             # @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
@@ -93,9 +96,9 @@ module Twilio
             # Retrieve a single page of OutgoingCallerIdInstance records from the API.
             # Request is executed immediately.
             # @param [String] phone_number Only show the caller id resource that exactly
-            #   matches this phone number
+            #   matches this phone number.
             # @param [String] friendly_name Only show the caller id resource that exactly
-            #   matches this name
+            #   matches this name.
             # @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
@@ -203,7 +206,9 @@ module Twilio
             ##
             # Update the OutgoingCallerIdInstance
-            # @param [String] friendly_name A human readable description of the caller ID
+            # @param [String] friendly_name A human readable description of a Caller ID, with
+            #   maximum length of 64 characters. Defaults to a nicely formatted version of the
+            #   phone number.
             # @return [OutgoingCallerIdInstance] Updated OutgoingCallerIdInstance
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
@@ -242,7 +247,8 @@ module Twilio
             # Initialize the OutgoingCallerIdInstance
             # @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 this
+            # @param [String] account_sid The unique ID of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
             #   Caller Id.
             # @param [String] sid The outgoing-caller-id Sid that uniquely identifies this
             #   resource
@@ -328,7 +334,9 @@ module Twilio
             ##
             # Update the OutgoingCallerIdInstance
-            # @param [String] friendly_name A human readable description of the caller ID
+            # @param [String] friendly_name A human readable description of a Caller ID, with
+            #   maximum length of 64 characters. Defaults to a nicely formatted version of the
+            #   phone number.
             # @return [OutgoingCallerIdInstance] Updated OutgoingCallerIdInstance
             def update(friendly_name: :unset)
               context.update(friendly_name: friendly_name, )

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result/payload.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/recording/transcription.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the RecordingList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
+            # @param [String] account_sid The unique ID of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
             #   recording.
             # @return [RecordingList] RecordingList
             def initialize(version, account_sid: nil)
@@ -278,7 +281,8 @@ 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 responsible for this
+            # @param [String] account_sid The unique ID of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
             #   recording.
             # @param [String] sid The recording Sid that uniquely identifies this resource
             # @return [RecordingInstance] RecordingInstance
@@ -413,7 +417,7 @@ module Twilio
             end
             ##
-            # @return [Hash] The encryption_details
+            # @return [Hash] Details for how to decrypt the recording.
             def encryption_details
               @properties['encryption_details']
             end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the ShortCodeList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account that owns this short
+            # @param [String] account_sid The unique id of the
+            #   [Account](https://www.twilio.com/docs/api/rest/account) that owns this short
             #   code.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, account_sid: nil)
@@ -29,9 +32,10 @@ module Twilio
             # 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
+            #   names that exactly match this name.
             # @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
+            #   pattern. You can specify partial numbers and use '*' as a wildcard for any
+            #   digit.
             # @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
@@ -53,9 +57,10 @@ module Twilio
             # 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
+            #   names that exactly match this name.
             # @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
+            #   pattern. You can specify partial numbers and use '*' as a wildcard for any
+            #   digit.
             # @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
@@ -93,9 +98,10 @@ 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
+            #   names that exactly match this name.
             # @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
+            #   pattern. You can specify partial numbers and use '*' as a wildcard for any
+            #   digit.
             # @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
@@ -201,15 +207,15 @@ module Twilio
             #   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.
+            #   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 Twilio will use when
-            #   requesting the above URL. Either `GET` or `POST`.
+            # @param [String] sms_fallback_method The HTTP method that should be used to
+            #   request the `SmsFallbackUrl`. Either `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({
@@ -243,7 +249,8 @@ 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 that owns this short
+            # @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
             # @return [ShortCodeInstance] ShortCodeInstance
@@ -367,15 +374,15 @@ module Twilio
             #   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.
+            #   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 Twilio will use when
-            #   requesting the above URL. Either `GET` or `POST`.
+            # @param [String] sms_fallback_method The HTTP method that should be used to
+            #   request the `SmsFallbackUrl`. Either `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(

data/lib/twilio-ruby/rest/api/v2010/account/signing_key.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list/credential.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain/ip_access_control_list_mapping.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list/ip_address.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/sip.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST

data/lib/twilio-ruby/rest/api/v2010/account/token.rb CHANGED Viewed

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 module Twilio
   module REST
@@ -13,8 +15,8 @@ module Twilio
             ##
             # Initialize the TokenList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account that created this
-            #   Token.
+            # @param [String] account_sid The unique id of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Token.
             # @return [TokenList] TokenList
             def initialize(version, account_sid: nil)
               super(version)
@@ -28,7 +30,7 @@ module Twilio
             # Retrieve a single page of TokenInstance records from the API.
             # Request is executed immediately.
             # @param [String] ttl The duration in seconds for which the generated credentials
-            #   are valid
+            #   are valid, the default value is 86400 (24 hours).
             # @return [TokenInstance] Newly created TokenInstance
             def create(ttl: :unset)
               data = Twilio::Values.of({'Ttl' => ttl, })
@@ -83,8 +85,8 @@ module Twilio
             # Initialize the TokenInstance
             # @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 that created this
-            #   Token.
+            # @param [String] account_sid The unique id of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that created this Token.
             # @return [TokenInstance] TokenInstance
             def initialize(version, payload, account_sid: nil)
               super(version)