twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/chat/v2/service/user/user_channel.rb

@@ -21,12 +21,14 @@ module Twilio
                 class UserContext < InstanceContext
 
                      class UserChannelList < ListResource
+                
                     ##
                     # Initialize the UserChannelList
                     # @param [Version] version Version that contains the resource
                     # @return [UserChannelList] UserChannelList
                     def initialize(version, service_sid: nil, user_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, user_sid: user_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Channels"
@@ -68,7 +70,33 @@ module Twilio
                         page = self.page(
                             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 UserChannelPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        UserChannelPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -80,9 +108,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
 
                     ##
@@ -92,14 +124,17 @@ 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 UserChannelInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             '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)
 
                         UserChannelPage.new(@version, response, @solution)
                     end
@@ -136,6 +171,7 @@ module Twilio
                     # @return [UserChannelContext] UserChannelContext
                     def initialize(version, service_sid, user_sid, channel_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, user_sid: user_sid, channel_sid: channel_sid,  }
@@ -148,19 +184,51 @@ module Twilio
                     # @param [UserChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete(
-                        x_twilio_webhook_enabled: :unset
+                      x_twilio_webhook_enabled: :unset
                     )
 
-                        headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the UserChannelInstanceMetadata
+                    # @param [UserChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata(
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          userChannel_instance = UserChannelInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          UserChannelInstanceMetadata.new(@version, userChannel_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the UserChannelInstance
                     # @return [UserChannelInstance] Fetched UserChannelInstance
                     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)
                         UserChannelInstance.new(
                             @version,
                             payload,
@@ -170,6 +238,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the UserChannelInstanceMetadata
+                    # @return [UserChannelInstance] Fetched UserChannelInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        user_channel_instance = UserChannelInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            user_sid: @solution[:user_sid],
+                            channel_sid: @solution[:channel_sid],
+                        )
+                        UserChannelInstanceMetadata.new(
+                            @version,
+                            user_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the UserChannelInstance
                     # @param [NotificationLevel] notification_level 
@@ -177,9 +272,9 @@ module Twilio
                     # @param [Time] last_consumption_timestamp The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
                     # @return [UserChannelInstance] Updated UserChannelInstance
                     def update(
-                        notification_level: :unset, 
-                        last_consumed_message_index: :unset, 
-                        last_consumption_timestamp: :unset
+                      notification_level: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -188,7 +283,13 @@ module Twilio
                             'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         UserChannelInstance.new(
                             @version,
                             payload,
@@ -198,6 +299,46 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the UserChannelInstanceMetadata
+                    # @param [NotificationLevel] notification_level 
+                    # @param [String] last_consumed_message_index The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.
+                    # @param [Time] last_consumption_timestamp The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
+                    # @return [UserChannelInstance] Updated UserChannelInstance
+                    def update_with_metadata(
+                      notification_level: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'NotificationLevel' => notification_level,
+                            'LastConsumedMessageIndex' => last_consumed_message_index,
+                            'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        user_channel_instance = UserChannelInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            user_sid: @solution[:user_sid],
+                            channel_sid: @solution[:channel_sid],
+                        )
+                        UserChannelInstanceMetadata.new(
+                            @version,
+                            user_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -214,6 +355,53 @@ module Twilio
                     end
                 end
 
+                class UserChannelInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new UserChannelInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}UserChannelInstance] user_channel_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 [UserChannelInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, user_channel_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @user_channel_instance = user_channel_instance
+                    end
+
+                    def user_channel
+                        @user_channel_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.UserChannelInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class UserChannelListResponse < InstanceListResource
+                    # @param [Array<UserChannelInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @user_channel_instance = payload.body[key].map do |data|
+                        UserChannelInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def user_channel_instance
+                          @instance
+                      end
+                  end
+
                 class UserChannelPage < Page
                     ##
                     # Initialize the UserChannelPage
@@ -223,6 +411,7 @@ module Twilio
                     # @return [UserChannelPage] UserChannelPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -242,6 +431,66 @@ module Twilio
                         '<Twilio.Chat.V2.UserChannelPage>'
                     end
                 end
+
+                class UserChannelPageMetadata < PageMetadata
+                    attr_reader :user_channel_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @user_channel_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @user_channel_page << UserChannelListResponse.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
+                        @user_channel_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Chat::V2PageMetadata>';
+                    end
+                end
+                class UserChannelListResponse < InstanceListResource
+
+                    # @param [Array<UserChannelInstance>] 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
+                      @user_channel = data_list.map do |data|
+                        UserChannelInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def user_channel
+                        @user_channel
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UserChannelInstance < InstanceResource
                     ##
                     # Initialize the UserChannelInstance
@@ -255,6 +504,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, user_sid: nil, channel_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -357,7 +607,7 @@ module Twilio
                     # @param [UserChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete(
-                        x_twilio_webhook_enabled: :unset
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         context.delete(
@@ -380,9 +630,9 @@ module Twilio
                     # @param [Time] last_consumption_timestamp The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).
                     # @return [UserChannelInstance] Updated UserChannelInstance
                     def update(
-                        notification_level: :unset, 
-                        last_consumed_message_index: :unset, 
-                        last_consumption_timestamp: :unset
+                      notification_level: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset
                     )
 
                         context.update(