twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/conversations/v2.rb

@@ -0,0 +1,142 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Conversation Orchestrator
+#    Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use conversations to group related communications.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+module Twilio
+    module REST
+        class Conversations
+            class V2 < Version
+                ##
+                # Initialize the V2 version of Conversations
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @actions = nil
+                    @communications = nil
+                    @configurations = nil
+                    @conversations = nil
+                    @operations = nil
+                    @participants = nil
+                end
+
+                ##
+                # @param [String] conversation_id 
+                # @return [Twilio::REST::Conversations::V2::ActionContext] if conversationId was passed.
+                # @return [Twilio::REST::Conversations::V2::ActionList]
+                def actions(conversation_id=:unset)
+                    if conversation_id.nil?
+                        raise ArgumentError, 'conversation_id cannot be nil'
+                    end
+
+                    if conversation_id == :unset
+                        @actions ||= ActionList.new self
+                    else
+                        ActionContext.new(self, conversation_id)
+                    end
+                end
+                ##
+                # @param [String] conversation_sid 
+                # @param [String] sid
+                # @return [Twilio::REST::Conversations::V2::CommunicationContext] if sid was passed.
+                # @return [Twilio::REST::Conversations::V2::CommunicationList]
+                def communications(conversation_sid=:unset, sid=:unset)
+                    if conversation_sid.nil?
+                        raise ArgumentError, 'conversation_sid cannot be nil'
+                    end
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if conversation_sid == :unset && sid == :unset
+                        @communications ||= CommunicationList.new self
+                    elsif conversation_sid != :unset && sid == :unset
+                        CommunicationList.new(self, conversation_sid: conversation_sid)
+                    else
+                        CommunicationContext.new(self, conversation_sid, sid)
+                    end
+                end
+                ##
+                # @param [String] sid 
+                # @return [Twilio::REST::Conversations::V2::ConfigurationContext] if sid was passed.
+                # @return [Twilio::REST::Conversations::V2::ConfigurationList]
+                def configurations(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @configurations ||= ConfigurationList.new self
+                    else
+                        ConfigurationContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid 
+                # @return [Twilio::REST::Conversations::V2::ConversationContext] if sid was passed.
+                # @return [Twilio::REST::Conversations::V2::ConversationList]
+                def conversations(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @conversations ||= ConversationList.new self
+                    else
+                        ConversationContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid 
+                # @return [Twilio::REST::Conversations::V2::OperationContext] if sid was passed.
+                # @return [Twilio::REST::Conversations::V2::OperationList]
+                def operations(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if sid == :unset
+                        @operations ||= OperationList.new self
+                    else
+                        OperationContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] conversation_sid 
+                # @param [String] sid
+                # @return [Twilio::REST::Conversations::V2::ParticipantContext] if sid was passed.
+                # @return [Twilio::REST::Conversations::V2::ParticipantList]
+                def participants(conversation_sid=:unset, sid=:unset)
+                    if conversation_sid.nil?
+                        raise ArgumentError, 'conversation_sid cannot be nil'
+                    end
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+
+                    if conversation_sid == :unset && sid == :unset
+                        @participants ||= ParticipantList.new self
+                    elsif conversation_sid != :unset && sid == :unset
+                        ParticipantList.new(self, conversation_sid: conversation_sid)
+                    else
+                        ParticipantContext.new(self, conversation_sid, sid)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Conversations::V2>';
+                end
+            end
+        end
+    end
+end

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

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

data/lib/twilio-ruby/rest/events/v1/event_type.rb

@@ -18,12 +18,14 @@ module Twilio
         class Events < EventsBase
             class V1 < Version
                 class EventTypeList < ListResource
+                
                     ##
                     # Initialize the EventTypeList
                     # @param [Version] version Version that contains the resource
                     # @return [EventTypeList] EventTypeList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Types"
@@ -69,7 +71,35 @@ module Twilio
                             schema_id: schema_id,
                             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 EventTypePageMetadata records from the API as a list.
+                      # @param [String] schema_id A string parameter filtering the results to return only the Event Types using a given schema.
+                    # @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(schema_id: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'SchemaId' => schema_id,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        EventTypePageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -81,9 +111,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
 
                     ##
@@ -94,15 +128,18 @@ 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 EventTypeInstance
-                    def page(schema_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(schema_id: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'SchemaId' => schema_id,
                             'PageToken' => page_token,
                             '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)
 
                         EventTypePage.new(@version, response, @solution)
                     end
@@ -129,8 +166,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class EventTypeContext < InstanceContext
                     ##
                     # Initialize the EventTypeContext
@@ -139,6 +174,7 @@ module Twilio
                     # @return [EventTypeContext] EventTypeContext
                     def initialize(version, type)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { type: type,  }
@@ -151,7 +187,13 @@ module Twilio
                     # @return [EventTypeInstance] Fetched EventTypeInstance
                     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)
                         EventTypeInstance.new(
                             @version,
                             payload,
@@ -159,6 +201,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the EventTypeInstanceMetadata
+                    # @return [EventTypeInstance] Fetched EventTypeInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        event_type_instance = EventTypeInstance.new(
+                            @version,
+                            response.body,
+                            type: @solution[:type],
+                        )
+                        EventTypeInstanceMetadata.new(
+                            @version,
+                            event_type_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -175,6 +242,53 @@ module Twilio
                     end
                 end
 
+                class EventTypeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new EventTypeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}EventTypeInstance] event_type_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 [EventTypeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, event_type_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @event_type_instance = event_type_instance
+                    end
+
+                    def event_type
+                        @event_type_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.EventTypeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class EventTypeListResponse < InstanceListResource
+                    # @param [Array<EventTypeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @event_type_instance = payload.body[key].map do |data|
+                        EventTypeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def event_type_instance
+                          @instance
+                      end
+                  end
+
                 class EventTypePage < Page
                     ##
                     # Initialize the EventTypePage
@@ -184,6 +298,7 @@ module Twilio
                     # @return [EventTypePage] EventTypePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -203,6 +318,66 @@ module Twilio
                         '<Twilio.Events.V1.EventTypePage>'
                     end
                 end
+
+                class EventTypePageMetadata < PageMetadata
+                    attr_reader :event_type_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @event_type_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @event_type_page << EventTypeListResponse.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
+                        @event_type_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Events::V1PageMetadata>';
+                    end
+                end
+                class EventTypeListResponse < InstanceListResource
+
+                    # @param [Array<EventTypeInstance>] 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
+                      @event_type = data_list.map do |data|
+                        EventTypeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def event_type
+                        @event_type
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class EventTypeInstance < InstanceResource
                     ##
                     # Initialize the EventTypeInstance
@@ -216,6 +391,7 @@ module Twilio
                     def initialize(version, payload , type: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'type' => payload['type'],
@@ -223,6 +399,8 @@ module Twilio
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                             'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                             'description' => payload['description'],
+                            'status' => payload['status'],
+                            'documentation_url' => payload['documentation_url'],
                             'url' => payload['url'],
                             'links' => payload['links'],
                         }
@@ -273,6 +451,18 @@ module Twilio
                         @properties['description']
                     end
                     
+                    ##
+                    # @return [String] A string that describes how this Event Type can be used. For example: `available`, `deprecated`, `restricted`, `discontinued`. When the status is `available`, the Event Type can be used normally.
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The URL to the documentation or to the most relevant Twilio Changelog entry of this Event Type.
+                    def documentation_url
+                        @properties['documentation_url']
+                    end
+                    
                     ##
                     # @return [String] The URL of this resource.
                     def url