twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/chat/v3/channel.rb

@@ -1,275 +1,452 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Chat
+#    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.
 #
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class Chat < Domain
-      class V3 < Version
-        class ChannelList < ListResource
-          ##
-          # Initialize the ChannelList
-          # @param [Version] version Version that contains the resource
-          # @return [ChannelList] ChannelList
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '#<Twilio.Chat.V3.ChannelList>'
-          end
-        end
 
-        class ChannelPage < Page
-          ##
-          # Initialize the ChannelPage
-          # @param [Version] version Version that contains the resource
-          # @param [Response] response Response from the API
-          # @param [Hash] solution Path solution for the resource
-          # @return [ChannelPage] ChannelPage
-          def initialize(version, response, solution)
-            super(version, response)
-
-            # Path Solution
-            @solution = solution
-          end
-
-          ##
-          # Build an instance of ChannelInstance
-          # @param [Hash] payload Payload response from the API
-          # @return [ChannelInstance] ChannelInstance
-          def get_instance(payload)
-            ChannelInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '<Twilio.Chat.V3.ChannelPage>'
-          end
-        end
 
-        class ChannelContext < InstanceContext
-          ##
-          # Initialize the ChannelContext
-          # @param [Version] version Version that contains the resource
-          # @param [String] service_sid The unique SID identifier of the Service.
-          # @param [String] sid A 34 character string that uniquely identifies this Channel.
-          # @return [ChannelContext] ChannelContext
-          def initialize(version, service_sid, sid)
-            super(version)
-
-            # Path Solution
-            @solution = {service_sid: service_sid, sid: sid, }
-            @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}"
-          end
-
-          ##
-          # Update the ChannelInstance
-          # @param [channel.ChannelType] type TThe Type for this Channel to migrate to. Can
-          #   only be `private`. Migration to 'public' is not allowed.
-          # @param [String] messaging_service_sid The unique ID of the {Messaging
-          #   Service}[https://www.twilio.com/docs/sms/services/api] this channel belongs to.
-          # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
-          #   X-Twilio-Webhook-Enabled HTTP request header
-          # @return [ChannelInstance] Updated ChannelInstance
-          def update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset)
-            data = Twilio::Values.of({'Type' => type, 'MessagingServiceSid' => messaging_service_sid, })
-            headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
-
-            payload = @version.update('POST', @uri, data: data, headers: headers)
-
-            ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Chat.V3.ChannelContext #{context}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Chat.V3.ChannelContext #{context}>"
-          end
-        end
+module Twilio
+    module REST
+        class Chat < ChatBase
+            class V3 < Version
+                class ChannelList < ListResource
+                
+                    ##
+                    # Initialize the ChannelList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ChannelList] ChannelList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Chat.V3.ChannelList>'
+                    end
+                end
+
+
+                class ChannelContext < InstanceContext
+                    ##
+                    # Initialize the ChannelContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] service_sid The unique SID identifier of the Service.
+                    # @param [String] sid A 34 character string that uniquely identifies this Channel.
+                    # @return [ChannelContext] ChannelContext
+                    def initialize(version, service_sid, sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { service_sid: service_sid, sid: sid,  }
+                        @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Update the ChannelInstance
+                    # @param [ChannelType] type 
+                    # @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
+                    # @param [ChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [ChannelInstance] Updated ChannelInstance
+                    def update(
+                        type: :unset, 
+                        messaging_service_sid: :unset, 
+                        x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Type' => type,
+                            'MessagingServiceSid' => messaging_service_sid,
+                        })
+
+                        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)
+                        ChannelInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the ChannelInstanceMetadata
+                    # @param [ChannelType] type 
+                    # @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
+                    # @param [ChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [ChannelInstance] Updated ChannelInstance
+                    def update_with_metadata(
+                      type: :unset, 
+                      messaging_service_sid: :unset, 
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Type' => type,
+                            'MessagingServiceSid' => messaging_service_sid,
+                        })
+
+                        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)
+                        channel_instance = ChannelInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        ChannelInstanceMetadata.new(
+                            @version,
+                            channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Chat.V3.ChannelContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Chat.V3.ChannelContext #{context}>"
+                    end
+                end
+
+                class ChannelInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ChannelInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ChannelInstance] 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 [ChannelInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, channel_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @channel_instance = channel_instance
+                    end
+
+                    def channel
+                        @channel_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ChannelInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ChannelListResponse < InstanceListResource
+                    # @param [Array<ChannelInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @channel_instance = payload.body[key].map do |data|
+                        ChannelInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def channel_instance
+                          @instance
+                      end
+                  end
+
+                class ChannelPage < Page
+                    ##
+                    # Initialize the ChannelPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ChannelPage] ChannelPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ChannelInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ChannelInstance] ChannelInstance
+                    def get_instance(payload)
+                        ChannelInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Chat.V3.ChannelPage>'
+                    end
+                end
+
+                class ChannelPageMetadata < PageMetadata
+                    attr_reader :channel_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @channel_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @channel_page << ChannelListResponse.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
+                        @channel_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Chat::V3PageMetadata>';
+                    end
+                end
+                class ChannelListResponse < InstanceListResource
+
+                    # @param [Array<ChannelInstance>] 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
+                      @channel = data_list.map do |data|
+                        ChannelInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def channel
+                        @channel
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ChannelInstance < InstanceResource
+                    ##
+                    # Initialize the ChannelInstance
+                    # @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 Channel
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ChannelInstance] ChannelInstance
+                    def initialize(version, payload , service_sid: nil, sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'service_sid' => payload['service_sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'unique_name' => payload['unique_name'],
+                            'attributes' => payload['attributes'],
+                            'type' => payload['type'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'created_by' => payload['created_by'],
+                            'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i,
+                            'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i,
+                            'messaging_service_sid' => payload['messaging_service_sid'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [ChannelContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ChannelContext.new(@version , @params['service_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Channel resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the Channel resource is associated with.
+                    def service_sid
+                        @properties['service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The string that you assigned to describe the resource.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.
+                    def unique_name
+                        @properties['unique_name']
+                    end
+                    
+                    ##
+                    # @return [String] The JSON string that stores application-specific data. If attributes have not been set, `{}` is returned.
+                    def attributes
+                        @properties['attributes']
+                    end
+                    
+                    ##
+                    # @return [ChannelType] 
+                    def type
+                        @properties['type']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] The `identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.
+                    def created_by
+                        @properties['created_by']
+                    end
+                    
+                    ##
+                    # @return [String] The number of Members in the Channel.
+                    def members_count
+                        @properties['members_count']
+                    end
+                    
+                    ##
+                    # @return [String] The number of Messages that have been passed in the Channel.
+                    def messages_count
+                        @properties['messages_count']
+                    end
+                    
+                    ##
+                    # @return [String] The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
+                    def messaging_service_sid
+                        @properties['messaging_service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Channel resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Update the ChannelInstance
+                    # @param [ChannelType] type 
+                    # @param [String] messaging_service_sid The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this channel belongs to.
+                    # @param [ChannelEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [ChannelInstance] Updated ChannelInstance
+                    def update(
+                        type: :unset, 
+                        messaging_service_sid: :unset, 
+                        x_twilio_webhook_enabled: :unset
+                    )
+
+                        context.update(
+                            type: type, 
+                            messaging_service_sid: messaging_service_sid, 
+                            x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Chat.V3.ChannelInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Chat.V3.ChannelInstance #{values}>"
+                    end
+                end
 
-        class ChannelInstance < InstanceResource
-          ##
-          # Initialize the ChannelInstance
-          # @param [Version] version Version that contains the resource
-          # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] service_sid The unique SID identifier of the Service.
-          # @param [String] sid A 34 character string that uniquely identifies this Channel.
-          # @return [ChannelInstance] ChannelInstance
-          def initialize(version, payload, service_sid: nil, sid: nil)
-            super(version)
-
-            # Marshaled Properties
-            @properties = {
-                'sid' => payload['sid'],
-                'account_sid' => payload['account_sid'],
-                'service_sid' => payload['service_sid'],
-                'friendly_name' => payload['friendly_name'],
-                'unique_name' => payload['unique_name'],
-                'attributes' => payload['attributes'],
-                'type' => payload['type'],
-                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                'created_by' => payload['created_by'],
-                'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i,
-                'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i,
-                'messaging_service_sid' => payload['messaging_service_sid'],
-                'url' => payload['url'],
-            }
-
-            # Context
-            @instance_context = nil
-            @params = {
-                'service_sid' => service_sid || @properties['service_sid'],
-                'sid' => sid || @properties['sid'],
-            }
-          end
-
-          ##
-          # Generate an instance context for the instance, the context is capable of
-          # performing various actions.  All instance actions are proxied to the context
-          # @return [ChannelContext] ChannelContext for this ChannelInstance
-          def context
-            unless @instance_context
-              @instance_context = ChannelContext.new(@version, @params['service_sid'], @params['sid'], )
             end
-            @instance_context
-          end
-
-          ##
-          # @return [String] The unique string that identifies the resource
-          def sid
-            @properties['sid']
-          end
-
-          ##
-          # @return [String] The SID of the Account that created the resource
-          def account_sid
-            @properties['account_sid']
-          end
-
-          ##
-          # @return [String] The SID of the Service that the resource is associated with
-          def service_sid
-            @properties['service_sid']
-          end
-
-          ##
-          # @return [String] The string that you assigned to describe the resource
-          def friendly_name
-            @properties['friendly_name']
-          end
-
-          ##
-          # @return [String] An application-defined string that uniquely identifies the resource
-          def unique_name
-            @properties['unique_name']
-          end
-
-          ##
-          # @return [String] The JSON string that stores application-specific data
-          def attributes
-            @properties['attributes']
-          end
-
-          ##
-          # @return [channel.ChannelType] The visibility of the channel. Can be: `public` or `private`
-          def type
-            @properties['type']
-          end
-
-          ##
-          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
-          def date_created
-            @properties['date_created']
-          end
-
-          ##
-          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
-          def date_updated
-            @properties['date_updated']
-          end
-
-          ##
-          # @return [String] The identity of the User that created the channel
-          def created_by
-            @properties['created_by']
-          end
-
-          ##
-          # @return [String] The number of Members in the Channel
-          def members_count
-            @properties['members_count']
-          end
-
-          ##
-          # @return [String] The number of Messages that have been passed in the Channel
-          def messages_count
-            @properties['messages_count']
-          end
-
-          ##
-          # @return [String] The unique ID of the Messaging Service this channel belongs to.
-          def messaging_service_sid
-            @properties['messaging_service_sid']
-          end
-
-          ##
-          # @return [String] The absolute URL of the Channel resource
-          def url
-            @properties['url']
-          end
-
-          ##
-          # Update the ChannelInstance
-          # @param [channel.ChannelType] type TThe Type for this Channel to migrate to. Can
-          #   only be `private`. Migration to 'public' is not allowed.
-          # @param [String] messaging_service_sid The unique ID of the {Messaging
-          #   Service}[https://www.twilio.com/docs/sms/services/api] this channel belongs to.
-          # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
-          #   X-Twilio-Webhook-Enabled HTTP request header
-          # @return [ChannelInstance] Updated ChannelInstance
-          def update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset)
-            context.update(
-                type: type,
-                messaging_service_sid: messaging_service_sid,
-                x_twilio_webhook_enabled: x_twilio_webhook_enabled,
-            )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Chat.V3.ChannelInstance #{values}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Chat.V3.ChannelInstance #{values}>"
-          end
         end
-      end
     end
-  end
-end
+end