twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/chat/v2/service/channel/member.rb

@@ -21,12 +21,14 @@ module Twilio
                 class ChannelContext < InstanceContext
 
                      class MemberList < ListResource
+                
                     ##
                     # Initialize the MemberList
                     # @param [Version] version Version that contains the resource
                     # @return [MemberList] MemberList
                     def initialize(version, service_sid: nil, channel_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, channel_sid: channel_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Members"
@@ -44,14 +46,14 @@ module Twilio
                     # @param [MemberEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [MemberInstance] Created MemberInstance
                     def create(
-                        identity: nil, 
-                        role_sid: :unset, 
-                        last_consumed_message_index: :unset, 
-                        last_consumption_timestamp: :unset, 
-                        date_created: :unset, 
-                        date_updated: :unset, 
-                        attributes: :unset, 
-                        x_twilio_webhook_enabled: :unset
+                      identity: nil, 
+                      role_sid: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      attributes: :unset, 
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -64,7 +66,12 @@ module Twilio
                             'Attributes' => attributes,
                         })
 
-                        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, })
+                        
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         MemberInstance.new(
                             @version,
@@ -74,6 +81,59 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the MemberInstanceMetadata
+                    # @param [String] identity The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.
+                    # @param [String] role_sid The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).
+                    # @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. This parameter should only be used when recreating a Member from a backup/separate source.
+                    # @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).
+                    # @param [Time] date_created The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service.  Note that this parameter should only be used when a Member is being recreated from a backup/separate source.
+                    # @param [Time] date_updated The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated.
+                    # @param [String] attributes A valid JSON string that contains application-specific data.
+                    # @param [MemberEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [MemberInstance] Created MemberInstance
+                    def create_with_metadata(
+                      identity: nil, 
+                      role_sid: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      attributes: :unset, 
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Identity' => identity,
+                            'RoleSid' => role_sid,
+                            'LastConsumedMessageIndex' => last_consumed_message_index,
+                            'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
+                            'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                            'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                            'Attributes' => attributes,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        member_instance = MemberInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            channel_sid: @solution[:channel_sid],
+                        )
+                        MemberInstanceMetadata.new(
+                            @version,
+                            member_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists MemberInstance records from the API as a list.
@@ -114,7 +174,36 @@ module Twilio
                             identity: identity,
                             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 MemberPageMetadata records from the API as a list.
+                      # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.
+                    # @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(identity: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'Identity' =>  Twilio.serialize_list(identity) { |e| e },
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        MemberPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -126,9 +215,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
 
                     ##
@@ -139,7 +232,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 MemberInstance
-                    def page(identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(identity: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             
                             'Identity' =>  Twilio.serialize_list(identity) { |e| e },
@@ -147,8 +240,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)
 
                         MemberPage.new(@version, response, @solution)
                     end
@@ -185,6 +281,7 @@ module Twilio
                     # @return [MemberContext] MemberContext
                     def initialize(version, service_sid, channel_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, channel_sid: channel_sid, sid: sid,  }
@@ -197,19 +294,51 @@ module Twilio
                     # @param [MemberEnumWebhookEnabledType] 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 MemberInstanceMetadata
+                    # @param [MemberEnumWebhookEnabledType] 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)
+                          member_instance = MemberInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          MemberInstanceMetadata.new(@version, member_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the MemberInstance
                     # @return [MemberInstance] Fetched MemberInstance
                     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)
                         MemberInstance.new(
                             @version,
                             payload,
@@ -219,6 +348,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the MemberInstanceMetadata
+                    # @return [MemberInstance] Fetched MemberInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        member_instance = MemberInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            channel_sid: @solution[:channel_sid],
+                            sid: @solution[:sid],
+                        )
+                        MemberInstanceMetadata.new(
+                            @version,
+                            member_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the MemberInstance
                     # @param [String] role_sid The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).
@@ -230,13 +386,13 @@ module Twilio
                     # @param [MemberEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [MemberInstance] Updated MemberInstance
                     def update(
-                        role_sid: :unset, 
-                        last_consumed_message_index: :unset, 
-                        last_consumption_timestamp: :unset, 
-                        date_created: :unset, 
-                        date_updated: :unset, 
-                        attributes: :unset, 
-                        x_twilio_webhook_enabled: :unset
+                      role_sid: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      attributes: :unset, 
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -248,7 +404,12 @@ module Twilio
                             'Attributes' => attributes,
                         })
 
-                        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, })
+                        
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         MemberInstance.new(
                             @version,
@@ -259,6 +420,57 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the MemberInstanceMetadata
+                    # @param [String] role_sid The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).
+                    # @param [String] last_consumed_message_index The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels).
+                    # @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).
+                    # @param [Time] date_created The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service.  Note that this parameter should only be used when a Member is being recreated from a backup/separate source.
+                    # @param [Time] date_updated The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.
+                    # @param [String] attributes A valid JSON string that contains application-specific data.
+                    # @param [MemberEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [MemberInstance] Updated MemberInstance
+                    def update_with_metadata(
+                      role_sid: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      attributes: :unset, 
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'RoleSid' => role_sid,
+                            'LastConsumedMessageIndex' => last_consumed_message_index,
+                            'LastConsumptionTimestamp' => Twilio.serialize_iso8601_datetime(last_consumption_timestamp),
+                            'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                            'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                            'Attributes' => attributes,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        member_instance = MemberInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            channel_sid: @solution[:channel_sid],
+                            sid: @solution[:sid],
+                        )
+                        MemberInstanceMetadata.new(
+                            @version,
+                            member_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -275,6 +487,53 @@ module Twilio
                     end
                 end
 
+                class MemberInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new MemberInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}MemberInstance] member_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 [MemberInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, member_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @member_instance = member_instance
+                    end
+
+                    def member
+                        @member_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.MemberInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class MemberListResponse < InstanceListResource
+                    # @param [Array<MemberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @member_instance = payload.body[key].map do |data|
+                        MemberInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def member_instance
+                          @instance
+                      end
+                  end
+
                 class MemberPage < Page
                     ##
                     # Initialize the MemberPage
@@ -284,6 +543,7 @@ module Twilio
                     # @return [MemberPage] MemberPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -303,6 +563,66 @@ module Twilio
                         '<Twilio.Chat.V2.MemberPage>'
                     end
                 end
+
+                class MemberPageMetadata < PageMetadata
+                    attr_reader :member_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @member_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @member_page << MemberListResponse.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
+                        @member_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Chat::V2PageMetadata>';
+                    end
+                end
+                class MemberListResponse < InstanceListResource
+
+                    # @param [Array<MemberInstance>] 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
+                      @member = data_list.map do |data|
+                        MemberInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def member
+                        @member
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class MemberInstance < InstanceResource
                     ##
                     # Initialize the MemberInstance
@@ -316,6 +636,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -425,7 +746,7 @@ module Twilio
                     # @param [MemberEnumWebhookEnabledType] 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(
@@ -452,13 +773,13 @@ module Twilio
                     # @param [MemberEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [MemberInstance] Updated MemberInstance
                     def update(
-                        role_sid: :unset, 
-                        last_consumed_message_index: :unset, 
-                        last_consumption_timestamp: :unset, 
-                        date_created: :unset, 
-                        date_updated: :unset, 
-                        attributes: :unset, 
-                        x_twilio_webhook_enabled: :unset
+                      role_sid: :unset, 
+                      last_consumed_message_index: :unset, 
+                      last_consumption_timestamp: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      attributes: :unset, 
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         context.update(