twilio-ruby 7.0.2 → 7.1.0

data/lib/twilio-ruby/rest/preview_messaging/v1/broadcast.rb

@@ -1,164 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Bulk Messaging and Broadcast
-#    Bulk Sending is a public Twilio REST API for 1:Many Message creation up to 100 recipients. Broadcast is a public Twilio REST API for 1:Many Message creation up to 10,000 recipients via file upload.
-#
-#    NOTE: This class is auto generated by OpenAPI Generator.
-#    https://openapi-generator.tech
-#    Do not edit the class manually.
-#
-
-
-module Twilio
-    module REST
-        class PreviewMessaging < PreviewMessagingBase
-            class V1 < Version
-                class BroadcastList < ListResource
-                
-                    ##
-                    # Initialize the BroadcastList
-                    # @param [Version] version Version that contains the resource
-                    # @return [BroadcastList] BroadcastList
-                    def initialize(version)
-                        super(version)
-                        # Path Solution
-                        @solution = {  }
-                        @uri = "/Broadcasts"
-                        
-                    end
-                    ##
-                    # Create the BroadcastInstance
-                    # @param [String] x_twilio_request_key Idempotency key provided by the client
-                    # @return [BroadcastInstance] Created BroadcastInstance
-                    def create(
-                        x_twilio_request_key: :unset
-                    )
-
-                        
-                        headers = Twilio::Values.of({ 'X-Twilio-Request-Key' => x_twilio_request_key, })
-                        payload = @version.create('POST', @uri, headers: headers)
-                        BroadcastInstance.new(
-                            @version,
-                            payload,
-                        )
-                    end
-
-                
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.PreviewMessaging.V1.BroadcastList>'
-                    end
-                end
-
-                class BroadcastPage < Page
-                    ##
-                    # Initialize the BroadcastPage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [BroadcastPage] BroadcastPage
-                    def initialize(version, response, solution)
-                        super(version, response)
-
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    ##
-                    # Build an instance of BroadcastInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [BroadcastInstance] BroadcastInstance
-                    def get_instance(payload)
-                        BroadcastInstance.new(@version, payload)
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        '<Twilio.PreviewMessaging.V1.BroadcastPage>'
-                    end
-                end
-                class BroadcastInstance < InstanceResource
-                    ##
-                    # Initialize the BroadcastInstance
-                    # @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 this Broadcast
-                    #   resource.
-                    # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [BroadcastInstance] BroadcastInstance
-                    def initialize(version, payload )
-                        super(version)
-                        
-                        # Marshaled Properties
-                        @properties = { 
-                            'broadcast_sid' => payload['broadcast_sid'],
-                            'created_date' => Twilio.deserialize_iso8601_datetime(payload['created_date']),
-                            'updated_date' => Twilio.deserialize_iso8601_datetime(payload['updated_date']),
-                            'broadcast_status' => payload['broadcast_status'],
-                            'execution_details' => payload['execution_details'],
-                            'results_file' => payload['results_file'],
-                        }
-                    end
-
-                    
-                    ##
-                    # @return [String] Numeric ID indentifying individual Broadcast requests
-                    def broadcast_sid
-                        @properties['broadcast_sid']
-                    end
-                    
-                    ##
-                    # @return [Time] Timestamp of when the Broadcast was created
-                    def created_date
-                        @properties['created_date']
-                    end
-                    
-                    ##
-                    # @return [Time] Timestamp of when the Broadcast was last updated
-                    def updated_date
-                        @properties['updated_date']
-                    end
-                    
-                    ##
-                    # @return [String] Status of the Broadcast request. Valid values are None, Pending-Upload, Uploaded, Queued, Executing, Execution-Failure, Execution-Completed, Cancelation-Requested, and Canceled
-                    def broadcast_status
-                        @properties['broadcast_status']
-                    end
-                    
-                    ##
-                    # @return [MessagingV1BroadcastExecutionDetails] 
-                    def execution_details
-                        @properties['execution_details']
-                    end
-                    
-                    ##
-                    # @return [String] Path to a file detailing successful requests and errors from Broadcast execution
-                    def results_file
-                        @properties['results_file']
-                    end
-                    
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        "<Twilio.PreviewMessaging.V1.BroadcastInstance>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        "<Twilio.PreviewMessaging.V1.BroadcastInstance>"
-                    end
-                end
-
-            end
-        end
-    end
-end

data/lib/twilio-ruby/rest/preview_messaging/v1/message.rb

@@ -1,235 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Bulk Messaging and Broadcast
-#    Bulk Sending is a public Twilio REST API for 1:Many Message creation up to 100 recipients. Broadcast is a public Twilio REST API for 1:Many Message creation up to 10,000 recipients via file upload.
-#
-#    NOTE: This class is auto generated by OpenAPI Generator.
-#    https://openapi-generator.tech
-#    Do not edit the class manually.
-#
-
-
-module Twilio
-    module REST
-        class PreviewMessaging < PreviewMessagingBase
-            class V1 < Version
-                class MessageList < ListResource
-                
-                    class CreateMessagesRequest
-                            # @param [messages]: [Array<MessageList.MessagingV1Message>] 
-                            # @param [from]: [String] 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 [messaging_service_sid]: [String] 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 [body]: [String] The text of the message you want to send. Can be up to 1,600 characters in length.
-                            # @param [content_sid]: [String] The SID of the preconfigured [Content Template](https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template) you want to associate with the Message. Must be used in conjuction with a preconfigured [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) When this parameter is set, Twilio will use your configured content template and the provided `ContentVariables`. This Twilio product is currently in Private Beta.
-                            # @param [media_url]: [Array<String>] 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.
-                            # @param [status_callback]: [String] 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/messaging/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/messaging/services/api). URLs must contain a valid hostname and underscores are not allowed.
-                            # @param [validity_period]: [String] 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 [send_at]: [String] The time at which Twilio will send the message. This parameter can be used to schedule a message to be sent at a particular time. Must be in ISO 8601 format.
-                            # @param [schedule_type]: [String] This parameter indicates your intent to schedule a message. Pass the value `fixed` to schedule a message at a fixed time. This parameter works in conjuction with the `SendAt` parameter.
-                            # @param [shorten_urls]: [Boolean] Determines the usage of Click Tracking. Setting it to `true` will instruct Twilio to replace all links in the Message with a shortened version based on the associated Domain Sid and track clicks on them. If this parameter is not set on an API call, we will use the value set on the Messaging Service. If this parameter is not set and the value is not configured on the Messaging Service used this will default to `false`.
-                            # @param [send_as_mms]: [Boolean] If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media.
-                            # @param [max_price]: [Float] 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 [attempt]: [String] Total number of attempts made ( including this ) to send out the message regardless of the provider used
-                            # @param [smart_encoded]: [Boolean] This parameter indicates whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be true or false.
-                            # @param [force_delivery]: [Boolean] This parameter allows Twilio to send SMS traffic to carriers without checking/caring whether the destination number is a mobile or a landline.
-                            # @param [application_sid]: [String] 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'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.
-                        attr_accessor :messages, :from, :messaging_service_sid, :body, :content_sid, :media_url, :status_callback, :validity_period, :send_at, :schedule_type, :shorten_urls, :send_as_mms, :max_price, :attempt, :smart_encoded, :force_delivery, :application_sid
-                        def initialize(payload)
-                                @messages = payload["messages"]
-                                @from = payload["from"]
-                                @messaging_service_sid = payload["messaging_service_sid"]
-                                @body = payload["body"]
-                                @content_sid = payload["content_sid"]
-                                @media_url = payload["media_url"]
-                                @status_callback = payload["status_callback"]
-                                @validity_period = payload["validity_period"]
-                                @send_at = payload["send_at"]
-                                @schedule_type = payload["schedule_type"]
-                                @shorten_urls = payload["shorten_urls"]
-                                @send_as_mms = payload["send_as_mms"]
-                                @max_price = payload["max_price"]
-                                @attempt = payload["attempt"]
-                                @smart_encoded = payload["smart_encoded"]
-                                @force_delivery = payload["force_delivery"]
-                                @application_sid = payload["application_sid"]
-                        end
-                        def to_json(options = {})
-                        {
-                                messages: @messages,
-                                from: @from,
-                                messaging_service_sid: @messaging_service_sid,
-                                body: @body,
-                                content_sid: @content_sid,
-                                media_url: @media_url,
-                                status_callback: @status_callback,
-                                validity_period: @validity_period,
-                                send_at: @send_at,
-                                schedule_type: @schedule_type,
-                                shorten_urls: @shorten_urls,
-                                send_as_mms: @send_as_mms,
-                                max_price: @max_price,
-                                attempt: @attempt,
-                                smart_encoded: @smart_encoded,
-                                force_delivery: @force_delivery,
-                                application_sid: @application_sid,
-                        }.to_json(options)
-                        end
-                    end
-
-                    class MessagingV1Message
-                            # @param [to]: [String] 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 [body]: [String] The text of the message you want to send. Can be up to 1,600 characters in length. Overrides the request-level body and content template if provided.
-                            # @param [content_variables]: [Hash<String, String>] Key-value pairs of variable names to substitution values. Refer to the [Twilio Content API Resources](https://www.twilio.com/docs/content-api/content-api-resources#send-a-message-with-preconfigured-content) for more details.
-                        attr_accessor :to, :body, :content_variables
-                        def initialize(payload)
-                                @to = payload["to"]
-                                @body = payload["body"]
-                                @content_variables = payload["content_variables"]
-                        end
-                        def to_json(options = {})
-                        {
-                                to: @to,
-                                body: @body,
-                                content_variables: @content_variables,
-                        }.to_json(options)
-                        end
-                    end
-
-                    ##
-                    # Initialize the MessageList
-                    # @param [Version] version Version that contains the resource
-                    # @return [MessageList] MessageList
-                    def initialize(version)
-                        super(version)
-                        # Path Solution
-                        @solution = {  }
-                        @uri = "/Messages"
-                        
-                    end
-                    ##
-                    # Create the MessageInstance
-                    # @param [CreateMessagesRequest] create_messages_request 
-                    # @return [MessageInstance] Created MessageInstance
-                    def create(create_messages_request: nil
-                    )
-
-                        headers = Twilio::Values.of({"Content-Type"=> "application/json"})
-                        payload = @version.create('POST', @uri, data: create_messages_request.to_json, headers: headers)
-                        MessageInstance.new(
-                            @version,
-                            payload,
-                        )
-                    end
-
-                
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.PreviewMessaging.V1.MessageList>'
-                    end
-                end
-
-                class MessagePage < Page
-                    ##
-                    # Initialize the MessagePage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [MessagePage] MessagePage
-                    def initialize(version, response, solution)
-                        super(version, response)
-
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    ##
-                    # Build an instance of MessageInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [MessageInstance] MessageInstance
-                    def get_instance(payload)
-                        MessageInstance.new(@version, payload)
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        '<Twilio.PreviewMessaging.V1.MessagePage>'
-                    end
-                end
-                class MessageInstance < InstanceResource
-                    ##
-                    # 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 SID of the
-                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Message
-                    #   resource.
-                    # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [MessageInstance] MessageInstance
-                    def initialize(version, payload )
-                        super(version)
-                        
-                        # Marshaled Properties
-                        @properties = { 
-                            'total_message_count' => payload['total_message_count'] == nil ? payload['total_message_count'] : payload['total_message_count'].to_i,
-                            'success_count' => payload['success_count'] == nil ? payload['success_count'] : payload['success_count'].to_i,
-                            'error_count' => payload['error_count'] == nil ? payload['error_count'] : payload['error_count'].to_i,
-                            'message_receipts' => payload['message_receipts'],
-                            'failed_message_receipts' => payload['failed_message_receipts'],
-                        }
-                    end
-
-                    
-                    ##
-                    # @return [String] The number of Messages processed in the request, equal to the sum of success_count and error_count.
-                    def total_message_count
-                        @properties['total_message_count']
-                    end
-                    
-                    ##
-                    # @return [String] The number of Messages successfully created.
-                    def success_count
-                        @properties['success_count']
-                    end
-                    
-                    ##
-                    # @return [String] The number of Messages unsuccessfully processed in the request.
-                    def error_count
-                        @properties['error_count']
-                    end
-                    
-                    ##
-                    # @return [Array<MessagingV1MessageReceipt>] 
-                    def message_receipts
-                        @properties['message_receipts']
-                    end
-                    
-                    ##
-                    # @return [Array<MessagingV1FailedMessageReceipt>] 
-                    def failed_message_receipts
-                        @properties['failed_message_receipts']
-                    end
-                    
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        "<Twilio.PreviewMessaging.V1.MessageInstance>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        "<Twilio.PreviewMessaging.V1.MessageInstance>"
-                    end
-                end
-
-            end
-        end
-    end
-end

data/lib/twilio-ruby/rest/preview_messaging/v1.rb

@@ -1,46 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Bulk Messaging and Broadcast
-#    Bulk Sending is a public Twilio REST API for 1:Many Message creation up to 100 recipients. Broadcast is a public Twilio REST API for 1:Many Message creation up to 10,000 recipients via file upload.
-#
-#    NOTE: This class is auto generated by OpenAPI Generator.
-#    https://openapi-generator.tech
-#    Do not edit the class manually.
-#
-
-module Twilio
-    module REST
-        class PreviewMessaging
-            class V1 < Version
-                ##
-                # Initialize the V1 version of PreviewMessaging
-                def initialize(domain)
-                    super
-                    @version = 'v1'
-                    @broadcasts = nil
-                    @messages = nil
-                end
-
-                ##
-                # @return [Twilio::REST::PreviewMessaging::V1::BroadcastList]
-                def broadcasts
-                    @broadcasts ||= BroadcastList.new self
-                end
-                ##
-                # @return [Twilio::REST::PreviewMessaging::V1::MessageList]
-                def messages
-                    @messages ||= MessageList.new self
-                end
-                ##
-                # Provide a user friendly representation
-                def to_s
-                    '<Twilio::REST::PreviewMessaging::V1>';
-                end
-            end
-        end
-    end
-end

data/lib/twilio-ruby/rest/preview_messaging.rb

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class PreviewMessaging < PreviewMessagingBase
-      def message
-        self.v1.messages
-      end
-      def broadcast
-        self.v1.broadcasts
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/preview_messaging_base.rb

@@ -1,38 +0,0 @@
-##
- # This code was generated by
- # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
- #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
- #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
- #
- # NOTE: This class is auto generated by OpenAPI Generator.
- # https://openapi-generator.tech
- # Do not edit the class manually.
-# frozen_string_literal: true
-module Twilio
-  module REST
-    class PreviewMessagingBase < Domain
-      ##
-      # Initialize previewMessaging domain
-      #
-      # @param twilio - The twilio client
-      #
-      def initialize(twilio)
-        super(twilio)
-        @base_url =  "https://preview.messaging.twilio.com"
-        @host = "preview.messaging.twilio.com"
-        @port = 443
-        @v1 = nil
-      end
-
-      def v1
-        @v1 ||= PreviewMessaging::V1.new self
-      end
-
-      ##
-      # Provide a user friendly representation
-      def to_s
-        '<Twilio::REST::PreviewMessaging::V1>';
-      end
-    end
-  end
-end