twilio-ruby 5.31.1 → 5.54.0

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

@@ -16,7 +16,7 @@ module Twilio
             # Initialize the MessageList
             # @param [Version] version Version that contains the resource
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/iam/api/account) that sent the message
+            #   {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)
@@ -28,27 +28,26 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of MessageInstance records from the API.
-            # Request is executed immediately.
+            # Create the MessageInstance
             # @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
+            #   {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
+            #   `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
+            #   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
+            #   {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.
@@ -60,9 +59,11 @@ module Twilio
             #   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).
+            #   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] attempt Total number of attempts made ( including this ) to send
+            #   out the message regardless of the provider used
             # @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
@@ -70,33 +71,44 @@ module Twilio
             #   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 [Array[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
+            #   {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
+            #   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
+            #   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.
+            # @param [Array[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, force_delivery: :unset, smart_encoded: :unset, persistent_action: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
+            # @return [MessageInstance] Created MessageInstance
+            def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, attempt: :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,
@@ -107,17 +119,16 @@ module Twilio
                   'ApplicationSid' => application_sid,
                   'MaxPrice' => max_price,
                   'ProvideFeedback' => provide_feedback,
+                  'Attempt' => attempt,
                   'ValidityPeriod' => validity_period,
                   'ForceDelivery' => force_delivery,
+                  'ContentRetention' => content_retention,
+                  'AddressRetention' => address_retention,
                   'SmartEncoded' => smart_encoded,
                   'PersistentAction' => Twilio.serialize_list(persistent_action) { |e| e },
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
@@ -221,11 +232,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               MessagePage.new(@version, response, @solution)
             end
 
@@ -283,7 +292,7 @@ module Twilio
             # Initialize the MessageContext
             # @param [Version] version Version that contains the resource
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/iam/api/account) that created the Message
+            #   {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.
@@ -301,23 +310,17 @@ module Twilio
             end
 
             ##
-            # Deletes the MessageInstance
+            # Delete the MessageInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a MessageInstance
+            # Fetch the MessageInstance
             # @return [MessageInstance] Fetched MessageInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
@@ -330,11 +333,7 @@ module Twilio
             def update(body: nil)
               data = Twilio::Values.of({'Body' => body, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               MessageInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
@@ -394,7 +393,7 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] account_sid The SID of the
-            #   [Account](https://www.twilio.com/docs/iam/api/account) that sent the message
+            #   {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.
@@ -404,26 +403,26 @@ module Twilio
 
               # Marshaled Properties
               @properties = {
-                  'account_sid' => payload['account_sid'],
-                  'api_version' => payload['api_version'],
                   'body' => payload['body'],
-                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
-                  'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']),
+                  'num_segments' => payload['num_segments'],
                   'direction' => payload['direction'],
-                  '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'],
+                  'to' => payload['to'],
+                  'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
                   'price' => payload['price'],
-                  'price_unit' => payload['price_unit'],
-                  'sid' => payload['sid'],
+                  'error_message' => payload['error_message'],
+                  'uri' => payload['uri'],
+                  'account_sid' => payload['account_sid'],
+                  'num_media' => payload['num_media'],
                   'status' => payload['status'],
+                  'messaging_service_sid' => payload['messaging_service_sid'],
+                  'sid' => payload['sid'],
+                  'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']),
+                  'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
+                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                  'price_unit' => payload['price_unit'],
+                  'api_version' => payload['api_version'],
                   'subresource_uris' => payload['subresource_uris'],
-                  'to' => payload['to'],
-                  'uri' => payload['uri'],
               }
 
               # Context
@@ -442,18 +441,6 @@ module Twilio
               @instance_context
             end
 
-            ##
-            # @return [String] The SID of the Account that created the resource
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [String] The API version used to process the message
-            def api_version
-              @properties['api_version']
-            end
-
             ##
             # @return [String] The message text
             def body
@@ -461,33 +448,39 @@ module Twilio
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
-            def date_created
-              @properties['date_created']
+            # @return [String] The number of messages used to deliver the message body
+            def num_segments
+              @properties['num_segments']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
-            def date_updated
-              @properties['date_updated']
+            # @return [message.Direction] The direction of the message
+            def direction
+              @properties['direction']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT when the message was sent
-            def date_sent
-              @properties['date_sent']
+            # @return [String] The phone number that initiated the message
+            def from
+              @properties['from']
             end
 
             ##
-            # @return [message.Direction] The direction of the message
-            def direction
-              @properties['direction']
+            # @return [String] The phone number that received the message
+            def to
+              @properties['to']
             end
 
             ##
-            # @return [String] The error code associated with the message
-            def error_code
-              @properties['error_code']
+            # @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 amount billed for the message
+            def price
+              @properties['price']
             end
 
             ##
@@ -497,15 +490,15 @@ module Twilio
             end
 
             ##
-            # @return [String] The phone number that initiated the message
-            def from
-              @properties['from']
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
+            def uri
+              @properties['uri']
             end
 
             ##
-            # @return [String] The SID of the Messaging Service used with the message.
-            def messaging_service_sid
-              @properties['messaging_service_sid']
+            # @return [String] The SID of the Account that created the resource
+            def account_sid
+              @properties['account_sid']
             end
 
             ##
@@ -515,21 +508,15 @@ module Twilio
             end
 
             ##
-            # @return [String] The number of messages used to deliver the message body
-            def num_segments
-              @properties['num_segments']
-            end
-
-            ##
-            # @return [String] The amount billed for the message
-            def price
-              @properties['price']
+            # @return [message.Status] The status of the message
+            def status
+              @properties['status']
             end
 
             ##
-            # @return [String] The currency in which price is measured
-            def price_unit
-              @properties['price_unit']
+            # @return [String] The SID of the Messaging Service used with the message.
+            def messaging_service_sid
+              @properties['messaging_service_sid']
             end
 
             ##
@@ -539,38 +526,50 @@ module Twilio
             end
 
             ##
-            # @return [message.Status] The status of the message
-            def status
-              @properties['status']
+            # @return [Time] The RFC 2822 date and time in GMT when the message was sent
+            def date_sent
+              @properties['date_sent']
             end
 
             ##
-            # @return [String] A list of related resources identified by their relative URIs
-            def subresource_uris
-              @properties['subresource_uris']
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
+            def date_created
+              @properties['date_created']
             end
 
             ##
-            # @return [String] The phone number that received the message
-            def to
-              @properties['to']
+            # @return [String] The error code associated with the message
+            def error_code
+              @properties['error_code']
             end
 
             ##
-            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
-            def uri
-              @properties['uri']
+            # @return [String] The currency in which price is measured
+            def price_unit
+              @properties['price_unit']
+            end
+
+            ##
+            # @return [String] The API version used to process the message
+            def api_version
+              @properties['api_version']
+            end
+
+            ##
+            # @return [String] A list of related resources identified by their relative URIs
+            def subresource_uris
+              @properties['subresource_uris']
             end
 
             ##
-            # Deletes the MessageInstance
+            # Delete the MessageInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a MessageInstance
+            # Fetch the MessageInstance
             # @return [MessageInstance] Fetched MessageInstance
             def fetch
               context.fetch

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

@@ -17,7 +17,7 @@ module Twilio
               # Initialize the FeedbackList
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The SID of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
               #   MessageFeedback resource.
               # @param [String] message_sid The SID of the Message resource for which the
               #   feedback was provided.
@@ -31,20 +31,17 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FeedbackInstance records from the API.
-              # Request is executed immediately.
+              # Create the FeedbackInstance
               # @param [feedback.Outcome] outcome Whether the feedback has arrived. Can be:
-              #   `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP
-              #   POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`.
-              # @return [FeedbackInstance] Newly created FeedbackInstance
+              #   `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in {the initial HTTP
+              #   POST}[https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource],
+              #   the initial value of this property is `unconfirmed`. After the message arrives,
+              #   update the value to `confirmed`.
+              # @return [FeedbackInstance] Created FeedbackInstance
               def create(outcome: :unset)
                 data = Twilio::Values.of({'Outcome' => outcome, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FeedbackInstance.new(
                     @version,
@@ -101,7 +98,7 @@ module Twilio
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid The SID of the
-              #   [Account](https://www.twilio.com/docs/iam/api/account) that created the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
               #   MessageFeedback resource.
               # @param [String] message_sid The SID of the Message resource for which the
               #   feedback was provided.