twilio-ruby 3.11.5 → 5.0.0

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

@@ -0,0 +1,583 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Api < Domain
+      class V2010 < Version
+        class AccountContext < InstanceContext
+          class MessageList < ListResource
+            ##
+            # 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.
+            # @return [MessageList] MessageList
+            def initialize(version, account_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  account_sid: account_sid
+              }
+              @uri = "/Accounts/#{@solution[:account_sid]}/Messages.json"
+            end
+
+            ##
+            # 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] 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
+            # @return [MessageInstance] Newly created MessageInstance
+            def create(to: nil, status_callback: :unset, application_sid: :unset, max_price: :unset, provide_feedback: :unset, validity_period: :unset, from: :unset, messaging_service_sid: :unset, body: :unset, media_url: :unset)
+              data = Twilio::Values.of({
+                  'To' => to,
+                  'From' => from,
+                  'MessagingServiceSid' => messaging_service_sid,
+                  'Body' => body,
+                  'MediaUrl' => media_url,
+                  'StatusCallback' => status_callback,
+                  'ApplicationSid' => application_sid,
+                  'MaxPrice' => max_price,
+                  'ProvideFeedback' => provide_feedback,
+                  'ValidityPeriod' => validity_period,
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              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 [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
+            # @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 not set will                      use
+            #  the default value of 50 records.  If no page_size is                      defined
+            #  but a limit is defined, stream() will attempt to read                      the
+            #  limit with the most efficient page size,                      i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, limit: nil, page_size: nil)
+              self.stream(
+                  to: to,
+                  from: from,
+                  date_sent_before: date_sent_before,
+                  date_sent: date_sent,
+                  date_sent_after: date_sent_after,
+                  limit: limit,
+                  page_size: page_size
+              ).entries
+            end
+
+            ##
+            # 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 [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
+            # @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                      not set will use
+            #  the default value of 50 records.                      If no page_size is defined
+            #                       but a limit is defined, stream() will attempt to                      read the
+            #  limit with the most efficient page size,                       i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(
+                  to: to,
+                  from: from,
+                  date_sent_before: date_sent_before,
+                  date_sent: date_sent,
+                  date_sent_after: date_sent_after,
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields MessageInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(
+                  page_size: limits[:page_size],
+              )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # 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 [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
+            # @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
+            # @return [Page] Page of MessageInstance
+            def page(to: :unset, from: :unset, date_sent_before: :unset, date_sent: :unset, date_sent_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'To' => to,
+                  'From' => from,
+                  'DateSent<' => Twilio.serialize_iso8601_datetime(date_sent_before),
+                  'DateSent' => Twilio.serialize_iso8601_datetime(date_sent),
+                  'DateSent>' => Twilio.serialize_iso8601_datetime(date_sent_after),
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              MessagePage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of MessageInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of MessageInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              MessagePage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Api.V2010.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,
+                  account_sid: @solution[:account_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Api.V2010.MessagePage>'
+            end
+          end
+
+          class MessageContext < InstanceContext
+            ##
+            # 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
+            # @return [MessageContext] MessageContext
+            def initialize(version, account_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  account_sid: account_sid,
+                  sid: sid,
+              }
+              @uri = "/Accounts/#{@solution[:account_sid]}/Messages/#{@solution[:sid]}.json"
+
+              # Dependents
+              @media = nil
+              @feedback = nil
+            end
+
+            ##
+            # Deletes the MessageInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              @version.delete('delete', @uri)
+            end
+
+            ##
+            # Fetch a MessageInstance
+            # @return [MessageInstance] Fetched MessageInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              MessageInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Update the MessageInstance
+            # @param [String] body The body
+            # @return [MessageInstance] Updated MessageInstance
+            def update(body: nil)
+              data = Twilio::Values.of({
+                  'Body' => body,
+              })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              MessageInstance.new(
+                  @version,
+                  payload,
+                  account_sid: @solution[:account_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Access the media
+            # @return [MediaList]
+            # @return [MediaContext] if sid was passed.
+            def media(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                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],
+                )
+              end
+
+              @media
+            end
+
+            ##
+            # Access the feedback
+            # @return [FeedbackList]
+            # @return [FeedbackContext]
+            def feedback
+              unless @feedback
+                @feedback = FeedbackList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    message_sid: @solution[:sid],
+                )
+              end
+
+              @feedback
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.MessageContext #{context}>"
+            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 unique id of the Account that sent this message.
+            # @param [String] sid The message Sid that uniquely identifies this resource
+            # @return [MessageInstance] MessageInstance
+            def initialize(version, payload, account_sid: nil, sid: nil)
+              super(version)
+
+              # 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']),
+                  'direction' => payload['direction'],
+                  '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_unit' => payload['price_unit'],
+                  'sid' => payload['sid'],
+                  'status' => payload['status'],
+                  'subresource_uris' => payload['subresource_uris'],
+                  'to' => payload['to'],
+                  'uri' => payload['uri'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {
+                  'account_sid' => account_sid,
+                  'sid' => sid || @properties['sid'],
+              }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [MessageContext] MessageContext for this MessageInstance
+            def context
+              unless @instance_context
+                @instance_context = MessageContext.new(
+                    @version,
+                    @params['account_sid'],
+                    @params['sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique sid that identifies this account
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The version of the Twilio API 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.
+            def body
+              @properties['body']
+            end
+
+            ##
+            # @return [Time] The date this resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date this resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [Time] The date the message was sent
+            def date_sent
+              @properties['date_sent']
+            end
+
+            ##
+            # @return [message.Direction] The direction of the message
+            def direction
+              @properties['direction']
+            end
+
+            ##
+            # @return [String] The error code associated with the message
+            def error_code
+              @properties['error_code']
+            end
+
+            ##
+            # @return [String] Human readable description of the ErrorCode
+            def error_message
+              @properties['error_message']
+            end
+
+            ##
+            # @return [String] The phone number that initiated the message
+            def from
+              @properties['from']
+            end
+
+            ##
+            # @return [String] The messaging_service_sid
+            def messaging_service_sid
+              @properties['messaging_service_sid']
+            end
+
+            ##
+            # @return [String] 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
+            def num_segments
+              @properties['num_segments']
+            end
+
+            ##
+            # @return [String] The amount billed for the message
+            def price
+              @properties['price']
+            end
+
+            ##
+            # @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
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [message.Status] The status of this message
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [String] The URI for any subresources
+            def subresource_uris
+              @properties['subresource_uris']
+            end
+
+            ##
+            # @return [String] The phone number that received the message
+            def to
+              @properties['to']
+            end
+
+            ##
+            # @return [String] The URI for this resource
+            def uri
+              @properties['uri']
+            end
+
+            ##
+            # Deletes the MessageInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Fetch a MessageInstance
+            # @return [MessageInstance] Fetched MessageInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the MessageInstance
+            # @param [String] body The body
+            # @return [MessageInstance] Updated MessageInstance
+            def update(body: nil)
+              context.update(
+                  body: body,
+              )
+            end
+
+            ##
+            # Access the media
+            # @return [media] media
+            def media
+              context.media
+            end
+
+            ##
+            # Access the feedback
+            # @return [feedback] feedback
+            def feedback
+              context.feedback
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Api.V2010.MessageInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end