twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/messaging/v3/typing_indicator.rb

@@ -0,0 +1,247 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Messaging
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Messaging < MessagingBase
+            class V3 < Version
+                class TypingIndicatorList < ListResource
+                
+                    class TypingIndicatorRequest
+                            # @param [channel]: [String] The messaging channel. Must be \"APPLE\".
+                            # @param [message_id]: [String] The SID of a recent inbound message from the recipient. Must be an SM or MM SID format. 
+                            # @param [from]: [String] The Apple Messages for Business identifier of the sender (business).
+                            # @param [to]: [String] The Apple Messages for Business identifier of the recipient (customer).
+                            # @param [event]: [String] The type of typing event. \"START\" indicates the agent began typing, \"END\" indicates the agent stopped typing. Defaults to \"START\". 
+                        attr_accessor :channel, :message_id, :from, :to, :event
+                        def initialize(payload)
+                                @channel = payload["channel"]
+                                @message_id = payload["message_id"]
+                                @from = payload["from"]
+                                @to = payload["to"]
+                                @event = payload["event"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "channel": @channel,
+                                "messageId": @message_id,
+                                "from": @from,
+                                "to": @to,
+                                "event": @event,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the TypingIndicatorList
+                    # @param [Version] version Version that contains the resource
+                    # @return [TypingIndicatorList] TypingIndicatorList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Indicators/Typing.json"
+                        
+                    end
+                    ##
+                    # Create the TypingIndicatorInstance
+                    # @param [TypingIndicatorRequest] typing_indicator_request 
+                    # @return [TypingIndicatorInstance] Created TypingIndicatorInstance
+                    def create(typing_indicator_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: typing_indicator_request.to_json)
+                        TypingIndicatorInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the TypingIndicatorInstanceMetadata
+                    # @param [TypingIndicatorRequest] typing_indicator_request 
+                    # @return [TypingIndicatorInstance] Created TypingIndicatorInstance
+                    def create_with_metadata(typing_indicator_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: typing_indicator_request.to_json)
+                        typing_indicator_instance = TypingIndicatorInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        TypingIndicatorInstanceMetadata.new(
+                            @version,
+                            typing_indicator_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Messaging.V3.TypingIndicatorList>'
+                    end
+                end
+
+                class TypingIndicatorPage < Page
+                    ##
+                    # Initialize the TypingIndicatorPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [TypingIndicatorPage] TypingIndicatorPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of TypingIndicatorInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [TypingIndicatorInstance] TypingIndicatorInstance
+                    def get_instance(payload)
+                        TypingIndicatorInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Messaging.V3.TypingIndicatorPage>'
+                    end
+                end
+
+                class TypingIndicatorPageMetadata < PageMetadata
+                    attr_reader :typing_indicator_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @typing_indicator_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @typing_indicator_page << TypingIndicatorListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @typing_indicator_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V3PageMetadata>';
+                    end
+                end
+                class TypingIndicatorListResponse < InstanceListResource
+
+                    # @param [Array<TypingIndicatorInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @typing_indicator = data_list.map do |data|
+                        TypingIndicatorInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def typing_indicator
+                        @typing_indicator
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class TypingIndicatorInstance < InstanceResource
+                    ##
+                    # Initialize the TypingIndicatorInstance
+                    # @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 TypingIndicator
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [TypingIndicatorInstance] TypingIndicatorInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'success' => payload['success'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [Boolean] Indicates if the typing indicator was sent successfully.
+                    def success
+                        @properties['success']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Messaging.V3.TypingIndicatorInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Messaging.V3.TypingIndicatorInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/messaging/v3.rb

@@ -0,0 +1,40 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Messaging
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+module Twilio
+    module REST
+        class Messaging
+            class V3 < Version
+                ##
+                # Initialize the V3 version of Messaging
+                def initialize(domain)
+                    super
+                    @version = 'v3'
+                    @typing_indicator = nil
+                end
+
+                ##
+                # @return [Twilio::REST::Messaging::V3::TypingIndicatorList]
+                def typing_indicator
+                    @typing_indicator ||= TypingIndicatorList.new self
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Messaging::V3>';
+                end
+            end
+        end
+    end
+end

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

@@ -22,16 +22,26 @@ module Twilio
         @host = "messaging.twilio.com"
         @port = 443
         @v1 = nil
+        @v2 = nil
+        @v3 = nil
       end
 
       def v1
         @v1 ||= Messaging::V1.new self
       end
 
+      def v2
+        @v2 ||= Messaging::V2.new self
+      end
+
+      def v3
+        @v3 ||= Messaging::V3.new self
+      end
+
       ##
       # Provide a user friendly representation
       def to_s
-        '<Twilio::REST::Messaging::V1>';
+        '<Twilio::REST::Messaging>';
       end
     end
   end

data/lib/twilio-ruby/rest/monitor/v1/alert.rb

@@ -18,12 +18,14 @@ module Twilio
         class Monitor < MonitorBase
             class V1 < Version
                 class AlertList < ListResource
+                
                     ##
                     # Initialize the AlertList
                     # @param [Version] version Version that contains the resource
                     # @return [AlertList] AlertList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Alerts"
@@ -77,7 +79,39 @@ module Twilio
                             end_date: end_date,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists AlertPageMetadata records from the API as a list.
+                      # @param [String] log_level Only show alerts for this log-level.  Can be: `error`, `warning`, `notice`, or `debug`.
+                      # @param [Time] start_date Only include alerts that occurred on or after this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
+                      # @param [Time] end_date Only include alerts that occurred on or before this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
+                    # @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_with_metadata(log_level: :unset, start_date: :unset, end_date: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'LogLevel' => log_level,
+                            'StartDate' =>  Twilio.serialize_iso8601_datetime(start_date),
+                            'EndDate' =>  Twilio.serialize_iso8601_datetime(end_date),
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        AlertPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -89,9 +123,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -104,7 +142,7 @@ module Twilio
                     # @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 AlertInstance
-                    def page(log_level: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(log_level: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'LogLevel' => log_level,
                             'StartDate' =>  Twilio.serialize_iso8601_datetime(start_date),
@@ -113,8 +151,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         AlertPage.new(@version, response, @solution)
                     end
@@ -149,6 +190,7 @@ module Twilio
                     # @return [AlertContext] AlertContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -161,7 +203,13 @@ module Twilio
                     # @return [AlertInstance] Fetched AlertInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         AlertInstance.new(
                             @version,
                             payload,
@@ -169,6 +217,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the AlertInstanceMetadata
+                    # @return [AlertInstance] Fetched AlertInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        alert_instance = AlertInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        AlertInstanceMetadata.new(
+                            @version,
+                            alert_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -185,6 +258,53 @@ module Twilio
                     end
                 end
 
+                class AlertInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new AlertInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}AlertInstance] alert_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [AlertInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, alert_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @alert_instance = alert_instance
+                    end
+
+                    def alert
+                        @alert_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.AlertInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class AlertListResponse < InstanceListResource
+                    # @param [Array<AlertInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @alert_instance = payload.body[key].map do |data|
+                        AlertInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def alert_instance
+                          @instance
+                      end
+                  end
+
                 class AlertPage < Page
                     ##
                     # Initialize the AlertPage
@@ -194,6 +314,7 @@ module Twilio
                     # @return [AlertPage] AlertPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -213,6 +334,66 @@ module Twilio
                         '<Twilio.Monitor.V1.AlertPage>'
                     end
                 end
+
+                class AlertPageMetadata < PageMetadata
+                    attr_reader :alert_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @alert_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @alert_page << AlertListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @alert_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Monitor::V1PageMetadata>';
+                    end
+                end
+                class AlertListResponse < InstanceListResource
+
+                    # @param [Array<AlertInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @alert = data_list.map do |data|
+                        AlertInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def alert
+                        @alert
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class AlertInstance < InstanceResource
                     ##
                     # Initialize the AlertInstance
@@ -226,6 +407,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],