twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the MessageList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The unique id of the Account that sent this message.
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that sent the message
+            #   that created the resource.
             # @return [MessageList] MessageList
             def initialize(version, account_sid: nil)
               super(version)
@@ -26,29 +30,77 @@ module Twilio
             ##
             # Retrieve a single page of MessageInstance records from the API.
             # Request is executed immediately.
-            # @param [String] to The destination phone number. Format with a '+' and country
-            #   code
-            # @param [String] status_callback The URL that Twilio will POST to each time your
-            #   message status changes
-            # @param [String] application_sid Twilio the POST MessageSid as well as
-            #   MessageStatus to the URL in the MessageStatusCallback property of this
-            #   Application
-            # @param [String] max_price The max_price
-            # @param [Boolean] provide_feedback The provide_feedback
-            # @param [String] validity_period The validity_period
-            # @param [String] max_rate The max_rate
-            # @param [Boolean] force_delivery The force_delivery
-            # @param [String] provider_sid The provider_sid
-            # @param [message.ContentRetention] content_retention The content_retention
-            # @param [message.AddressRetention] address_retention The address_retention
-            # @param [Boolean] smart_encoded The smart_encoded
-            # @param [String] from A Twilio phone number or alphanumeric sender ID enabled for
-            #   the type of message you wish to send.
-            # @param [String] messaging_service_sid The messaging_service_sid
-            # @param [String] body The body
-            # @param [String] media_url The media_url
+            # @param [String] to The destination phone number in
+            #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or
+            #   [Channel user
+            #   address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other
+            #   3rd-party channels.
+            # @param [String] status_callback The URL we should call using the
+            #   `status_callback_method` to send status information to your application. If
+            #   specified, we POST these message status changes to the URL: `queued`, `failed`,
+            #   `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request
+            #   parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as
+            #   some additional parameters including `MessageSid`, `MessageStatus`, and
+            #   `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we
+            #   use this URL instead of the Status Callback URL of the [Messaging
+            #   Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a
+            #   valid hostname and underscores are not allowed.
+            # @param [String] application_sid The SID of the application that should receive
+            #   message status. We POST a `message_sid` parameter and a `message_status`
+            #   parameter with a value of `sent` or `failed` to the
+            #   [application](https://www.twilio.com/docs/usage/api/applications)'s
+            #   `message_status_callback`. If a `status_callback` parameter is also passed, it
+            #   will be ignored and the application's `message_status_callback` parameter will
+            #   be used.
+            # @param [String] max_price The maximum total price in US dollars that you will
+            #   pay for the message to be delivered. Can be a decimal value that has up to 4
+            #   decimal places. All messages are queued for delivery and the message cost is
+            #   checked before the message is sent. If the cost exceeds `max_price`, the message
+            #   will fail and a status of `Failed` is sent to the status callback. If `MaxPrice`
+            #   is not set, the message cost is not checked.
+            # @param [Boolean] provide_feedback Whether to confirm delivery of the message.
+            #   Set this value to `true` if you are sending messages that have a trackable user
+            #   action and you intend to confirm delivery of the message using the [Message
+            #   Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource).
+            #   This parameter is `false` by default.
+            # @param [String] validity_period How long in seconds the message can remain in
+            #   our outgoing message queue. After this period elapses, the message fails and we
+            #   call your status callback. Can be between 1 and the default value of 14,400
+            #   seconds. After a message has been accepted by a carrier, however, we cannot
+            #   guarantee that the message will not be queued after this period. We recommend
+            #   that this value be at least 5 seconds.
+            # @param [Boolean] force_delivery Reserved
+            # @param [message.ContentRetention] content_retention Determines if the message
+            #   content can be stored or redacted based on privacy settings
+            # @param [message.AddressRetention] address_retention Determines if the address
+            #   can be stored or obfuscated based on privacy settings
+            # @param [Boolean] smart_encoded Whether to detect Unicode characters that have a
+            #   similar GSM-7 character and replace them. Can be: `true` or `false`.
+            # @param [String] persistent_action Rich actions for Channels Messages.
+            # @param [String] from A Twilio phone number in
+            #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric
+            #   sender
+            #   ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty.
+            # @param [String] messaging_service_sid The SID of the [Messaging
+            #   Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot)
+            #   you want to associate with the Message. Set this parameter to use the [Messaging
+            #   Service Settings and Copilot
+            #   Features](https://www.twilio.com/console/sms/services) you have configured and
+            #   leave the `from` parameter empty. When only this parameter is set, Twilio will
+            #   use your enabled Copilot Features to select the `from` phone number for
+            #   delivery.
+            # @param [String] body The text of the message you want to send. Can be up to
+            #   1,600 characters in length.
+            # @param [String] media_url The URL of the media to send with the message. The
+            #   media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on
+            #   the recipient's device. The media size limit is 5MB for supported file types
+            #   (JPEG, PNG, GIF) and 500KB for [other
+            #   types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media.
+            #   To send more than one image in the message body, provide multiple `media_url`
+            #   parameters in the POST request. You can include up to 10 `media_url` parameters
+            #   per message. You can send images in an SMS message in only the US and Canada.
             # @return [MessageInstance] Newly created MessageInstance
-            def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, max_rate: :unset, force_delivery: :unset, provider_sid: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
+            def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, force_delivery: :unset, content_retention: :unset, address_retention: :unset, smart_encoded: :unset, persistent_action: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
               data = Twilio::Values.of({
                   'To' => to,
                   'From' => from,
@@ -60,12 +112,11 @@ module Twilio
                   'MaxPrice' => max_price,
                   'ProvideFeedback' => provide_feedback,
                   'ValidityPeriod' => validity_period,
-                  'MaxRate' => max_rate,
                   'ForceDelivery' => force_delivery,
-                  'ProviderSid' => provider_sid,
                   'ContentRetention' => content_retention,
                   'AddressRetention' => address_retention,
                   'SmartEncoded' => smart_encoded,
+                  'PersistentAction' => Twilio.serialize_list(persistent_action) { |e| e },
               })
 
               payload = @version.create(
@@ -74,15 +125,16 @@ module Twilio
                   data: data
               )
 
-              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
             # Lists MessageInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] to Filter by messages to this number
-            # @param [String] from Only show messages from this phone number
+            # @param [String] to Read messages sent to only this phone number.
+            # @param [String] from Read messages sent from only this phone number or
+            #   alphanumeric sender ID.
             # @param [Time] date_sent_before Filter by date sent
             # @param [Time] date_sent Filter by date sent
             # @param [Time] date_sent_after Filter by date sent
@@ -109,8 +161,9 @@ module Twilio
             # Streams MessageInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] to Filter by messages to this number
-            # @param [String] from Only show messages from this phone number
+            # @param [String] to Read messages sent to only this phone number.
+            # @param [String] from Read messages sent from only this phone number or
+            #   alphanumeric sender ID.
             # @param [Time] date_sent_before Filter by date sent
             # @param [Time] date_sent Filter by date sent
             # @param [Time] date_sent_after Filter by date sent
@@ -143,7 +196,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],
@@ -153,8 +206,9 @@ module Twilio
             ##
             # Retrieve a single page of MessageInstance records from the API.
             # Request is executed immediately.
-            # @param [String] to Filter by messages to this number
-            # @param [String] from Only show messages from this phone number
+            # @param [String] to Read messages sent to only this phone number.
+            # @param [String] from Read messages sent from only this phone number or
+            #   alphanumeric sender ID.
             # @param [Time] date_sent_before Filter by date sent
             # @param [Time] date_sent Filter by date sent
             # @param [Time] date_sent_after Filter by date sent
@@ -220,7 +274,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [MessageInstance] MessageInstance
             def get_instance(payload)
-              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -234,14 +288,17 @@ module Twilio
             ##
             # Initialize the MessageContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The message 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 Message
+            #   resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Message resource to fetch.
             # @return [MessageContext] MessageContext
             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]}/Messages/#{@solution[:sid]}.json"
 
               # Dependents
@@ -251,7 +308,7 @@ module Twilio
 
             ##
             # Deletes the MessageInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -268,15 +325,16 @@ module Twilio
                   params,
               )
 
-              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the MessageInstance
-            # @param [String] body The body
+            # @param [String] body The text of the message you want to send. Can be up to
+            #   1,600 characters long.
             # @return [MessageInstance] Updated MessageInstance
             def update(body: nil)
-              data = Twilio::Values.of({'Body' => body})
+              data = Twilio::Values.of({'Body' => body, })
 
               payload = @version.update(
                   'POST',
@@ -284,7 +342,7 @@ module Twilio
                   data: data,
               )
 
-              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -295,11 +353,11 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return MediaContext.new(@version, @solution[:account_sid], @solution[:sid], sid)
+                return MediaContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
               end
 
               unless @media
-                @media = MediaList.new(@version, account_sid: @solution[:account_sid], message_sid: @solution[:sid])
+                @media = MediaList.new(@version, account_sid: @solution[:account_sid], message_sid: @solution[:sid], )
               end
 
               @media
@@ -327,6 +385,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.MessageContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.MessageContext #{context}>"
+            end
           end
 
           class MessageInstance < InstanceResource
@@ -334,8 +399,11 @@ module Twilio
             # Initialize the MessageInstance
             # @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 sent this message.
-            # @param [String] sid The message Sid that uniquely identifies this resource
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that sent the message
+            #   that created the resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Message resource to fetch.
             # @return [MessageInstance] MessageInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -349,13 +417,13 @@ module Twilio
                   'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
                   'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']),
                   'direction' => payload['direction'],
-                  'error_code' => payload['error_code'].to_i,
+                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
                   'error_message' => payload['error_message'],
                   'from' => payload['from'],
                   'messaging_service_sid' => payload['messaging_service_sid'],
                   'num_media' => payload['num_media'],
                   'num_segments' => payload['num_segments'],
-                  'price' => payload['price'].to_f,
+                  'price' => payload['price'],
                   'price_unit' => payload['price_unit'],
                   'sid' => payload['sid'],
                   'status' => payload['status'],
@@ -366,7 +434,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
 
             ##
@@ -375,43 +443,43 @@ module Twilio
             # @return [MessageContext] MessageContext for this MessageInstance
             def context
               unless @instance_context
-                @instance_context = MessageContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = MessageContext.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 the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The version of the Twilio API used to process the message.
+            # @return [String] The API version used to process the message
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [String] The text body of the message. Up to 1600 characters long.
+            # @return [String] The message text
             def body
               @properties['body']
             end
 
             ##
-            # @return [Time] The date this resource was created
+            # @return [Time] The RFC 2822 date and time in GMT that the 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 the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [Time] The date the message was sent
+            # @return [Time] The RFC 2822 date and time in GMT when the message was sent
             def date_sent
               @properties['date_sent']
             end
@@ -429,7 +497,7 @@ module Twilio
             end
 
             ##
-            # @return [String] Human readable description of the ErrorCode
+            # @return [String] The description of the error_code
             def error_message
               @properties['error_message']
             end
@@ -441,19 +509,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The messaging_service_sid
+            # @return [String] The SID of the Messaging Service used with the message.
             def messaging_service_sid
               @properties['messaging_service_sid']
             end
 
             ##
-            # @return [String] Number of media files associated with the message
+            # @return [String] The number of media files associated with the message
             def num_media
               @properties['num_media']
             end
 
             ##
-            # @return [String] Indicates number of messages used to delivery the body
+            # @return [String] The number of messages used to deliver the message body
             def num_segments
               @properties['num_segments']
             end
@@ -465,25 +533,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The currency in which Price is measured
+            # @return [String] The currency in which price is measured
             def price_unit
               @properties['price_unit']
             end
 
             ##
-            # @return [String] A string that uniquely identifies this message
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [message.Status] The status of this message
+            # @return [message.Status] The status of the message
             def status
               @properties['status']
             end
 
             ##
-            # @return [String] The URI for any subresources
+            # @return [String] A list of related resources identified by their relative URIs
             def subresource_uris
               @properties['subresource_uris']
             end
@@ -495,14 +563,14 @@ module Twilio
             end
 
             ##
-            # @return [String] The URI for this resource
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
 
             ##
             # Deletes the MessageInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -516,10 +584,11 @@ module Twilio
 
             ##
             # Update the MessageInstance
-            # @param [String] body The body
+            # @param [String] body The text of the message you want to send. Can be up to
+            #   1,600 characters long.
             # @return [MessageInstance] Updated MessageInstance
             def update(body: nil)
-              context.update(body: body)
+              context.update(body: body, )
             end
 
             ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,10 +29,11 @@ module Twilio
             ##
             # Retrieve a single page of NewKeyInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [NewKeyInstance] Newly created NewKeyInstance
             def create(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
               payload = @version.create(
                   'POST',
@@ -38,7 +41,7 @@ module Twilio
                   data: data
               )
 
-              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -67,7 +70,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [NewKeyInstance] NewKeyInstance
             def get_instance(payload)
-              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -99,31 +102,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT that the 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 the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The secret
+            # @return [String] The secret your application uses to sign Access Tokens and to authenticate to the REST API.
             def secret
               @properties['secret']
             end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,10 +29,11 @@ module Twilio
             ##
             # Retrieve a single page of NewSigningKeyInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
             # @return [NewSigningKeyInstance] Newly created NewSigningKeyInstance
             def create(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
               payload = @version.create(
                   'POST',
@@ -38,7 +41,7 @@ module Twilio
                   data: data
               )
 
-              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -67,7 +70,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [NewSigningKeyInstance] NewSigningKeyInstance
             def get_instance(payload)
-              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              NewSigningKeyInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -99,31 +102,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT that the 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 the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The secret
+            # @return [String] The secret your application uses to sign Access Tokens and to authenticate to the REST API.
             def secret
               @properties['secret']
             end