twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/conversations/v1/configuration.rb

@@ -1,260 +1,475 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Conversations
+#    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 Conversations < Domain
-      class V1 < Version
-        class ConfigurationList < ListResource
-          ##
-          # Initialize the ConfigurationList
-          # @param [Version] version Version that contains the resource
-          # @return [ConfigurationList] ConfigurationList
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '#<Twilio.Conversations.V1.ConfigurationList>'
-          end
-        end
 
-        class ConfigurationPage < Page
-          ##
-          # Initialize the ConfigurationPage
-          # @param [Version] version Version that contains the resource
-          # @param [Response] response Response from the API
-          # @param [Hash] solution Path solution for the resource
-          # @return [ConfigurationPage] ConfigurationPage
-          def initialize(version, response, solution)
-            super(version, response)
-
-            # Path Solution
-            @solution = solution
-          end
-
-          ##
-          # Build an instance of ConfigurationInstance
-          # @param [Hash] payload Payload response from the API
-          # @return [ConfigurationInstance] ConfigurationInstance
-          def get_instance(payload)
-            ConfigurationInstance.new(@version, payload, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            '<Twilio.Conversations.V1.ConfigurationPage>'
-          end
-        end
 
-        class ConfigurationContext < InstanceContext
-          ##
-          # Initialize the ConfigurationContext
-          # @param [Version] version Version that contains the resource
-          # @return [ConfigurationContext] ConfigurationContext
-          def initialize(version)
-            super(version)
-
-            # Path Solution
-            @solution = {}
-            @uri = "/Configuration"
-
-            # Components
-            @webhooks = nil
-          end
-
-          ##
-          # Fetch the ConfigurationInstance
-          # @return [ConfigurationInstance] Fetched ConfigurationInstance
-          def fetch
-            payload = @version.fetch('GET', @uri)
-
-            ConfigurationInstance.new(@version, payload, )
-          end
-
-          ##
-          # Update the ConfigurationInstance
-          # @param [String] default_chat_service_sid The SID of the default {Conversation
-          #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] to use
-          #   when creating a conversation.
-          # @param [String] default_messaging_service_sid The SID of the default {Messaging
-          #   Service}[https://www.twilio.com/docs/sms/services/api] to use when creating a
-          #   conversation.
-          # @param [String] default_inactive_timer Default ISO8601 duration when
-          #   conversation will be switched to `inactive` state. Minimum value for this timer
-          #   is 1 minute.
-          # @param [String] default_closed_timer Default ISO8601 duration when conversation
-          #   will be switched to `closed` state. Minimum value for this timer is 10 minutes.
-          # @return [ConfigurationInstance] Updated ConfigurationInstance
-          def update(default_chat_service_sid: :unset, default_messaging_service_sid: :unset, default_inactive_timer: :unset, default_closed_timer: :unset)
-            data = Twilio::Values.of({
-                'DefaultChatServiceSid' => default_chat_service_sid,
-                'DefaultMessagingServiceSid' => default_messaging_service_sid,
-                'DefaultInactiveTimer' => default_inactive_timer,
-                'DefaultClosedTimer' => default_closed_timer,
-            })
-
-            payload = @version.update('POST', @uri, data: data)
-
-            ConfigurationInstance.new(@version, payload, )
-          end
-
-          ##
-          # Access the webhooks
-          # @return [WebhookContext] WebhookContext
-          def webhooks
-            return WebhookContext.new(@version, )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
-          end
-        end
+module Twilio
+    module REST
+        class Conversations < ConversationsBase
+            class V1 < Version
+                class ConfigurationList < ListResource
+                
+                    ##
+                    # Initialize the ConfigurationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ConfigurationList] ConfigurationList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Conversations.V1.ConfigurationList>'
+                    end
+                end
+
+
+                class ConfigurationContext < InstanceContext
+                    ##
+                    # Initialize the ConfigurationContext
+                    # @param [Version] version Version that contains the resource
+                    # @return [ConfigurationContext] ConfigurationContext
+                    def initialize(version)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Configuration"
+
+                        # Dependents
+                        @webhooks = nil
+                    end
+                    ##
+                    # Fetch the ConfigurationInstance
+                    # @return [ConfigurationInstance] Fetched ConfigurationInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ConfigurationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Fetch the ConfigurationInstanceMetadata
+                    # @return [ConfigurationInstance] Fetched ConfigurationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        configuration_instance = ConfigurationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        ConfigurationInstanceMetadata.new(
+                            @version,
+                            configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the ConfigurationInstance
+                    # @param [String] default_chat_service_sid The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
+                    # @param [String] default_messaging_service_sid The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.
+                    # @param [String] default_inactive_timer Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
+                    # @param [String] default_closed_timer Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
+                    # @return [ConfigurationInstance] Updated ConfigurationInstance
+                    def update(
+                        default_chat_service_sid: :unset, 
+                        default_messaging_service_sid: :unset, 
+                        default_inactive_timer: :unset, 
+                        default_closed_timer: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'DefaultChatServiceSid' => default_chat_service_sid,
+                            'DefaultMessagingServiceSid' => default_messaging_service_sid,
+                            'DefaultInactiveTimer' => default_inactive_timer,
+                            'DefaultClosedTimer' => default_closed_timer,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        ConfigurationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Update the ConfigurationInstanceMetadata
+                    # @param [String] default_chat_service_sid The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
+                    # @param [String] default_messaging_service_sid The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.
+                    # @param [String] default_inactive_timer Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
+                    # @param [String] default_closed_timer Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
+                    # @return [ConfigurationInstance] Updated ConfigurationInstance
+                    def update_with_metadata(
+                      default_chat_service_sid: :unset, 
+                      default_messaging_service_sid: :unset, 
+                      default_inactive_timer: :unset, 
+                      default_closed_timer: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'DefaultChatServiceSid' => default_chat_service_sid,
+                            'DefaultMessagingServiceSid' => default_messaging_service_sid,
+                            'DefaultInactiveTimer' => default_inactive_timer,
+                            'DefaultClosedTimer' => default_closed_timer,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        configuration_instance = ConfigurationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        ConfigurationInstanceMetadata.new(
+                            @version,
+                            configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Access the webhooks
+                    # @return [WebhookList]
+                    # @return [WebhookContext]
+                    def webhooks
+                        WebhookContext.new(
+                                @version
+                                )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V1.ConfigurationContext #{context}>"
+                    end
+                end
+
+                class ConfigurationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ConfigurationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ConfigurationInstance] configuration_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 [ConfigurationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, configuration_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @configuration_instance = configuration_instance
+                    end
+
+                    def configuration
+                        @configuration_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ConfigurationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ConfigurationListResponse < InstanceListResource
+                    # @param [Array<ConfigurationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @configuration_instance = payload.body[key].map do |data|
+                        ConfigurationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def configuration_instance
+                          @instance
+                      end
+                  end
+
+                class ConfigurationPage < Page
+                    ##
+                    # Initialize the ConfigurationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ConfigurationPage] ConfigurationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ConfigurationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ConfigurationInstance] ConfigurationInstance
+                    def get_instance(payload)
+                        ConfigurationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Conversations.V1.ConfigurationPage>'
+                    end
+                end
+
+                class ConfigurationPageMetadata < PageMetadata
+                    attr_reader :configuration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @configuration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @configuration_page << ConfigurationListResponse.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
+                        @configuration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V1PageMetadata>';
+                    end
+                end
+                class ConfigurationListResponse < InstanceListResource
+
+                    # @param [Array<ConfigurationInstance>] 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
+                      @configuration = data_list.map do |data|
+                        ConfigurationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def configuration
+                        @configuration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ConfigurationInstance < InstanceResource
+                    ##
+                    # Initialize the ConfigurationInstance
+                    # @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 Configuration
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ConfigurationInstance] ConfigurationInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'default_chat_service_sid' => payload['default_chat_service_sid'],
+                            'default_messaging_service_sid' => payload['default_messaging_service_sid'],
+                            'default_inactive_timer' => payload['default_inactive_timer'],
+                            'default_closed_timer' => payload['default_closed_timer'],
+                            'url' => payload['url'],
+                            'links' => payload['links'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = {  }
+                    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 [ConfigurationContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ConfigurationContext.new(@version )
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) used when creating a conversation.
+                    def default_chat_service_sid
+                        @properties['default_chat_service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation.
+                    def default_messaging_service_sid
+                        @properties['default_messaging_service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
+                    def default_inactive_timer
+                        @properties['default_inactive_timer']
+                    end
+                    
+                    ##
+                    # @return [String] Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
+                    def default_closed_timer
+                        @properties['default_closed_timer']
+                    end
+                    
+                    ##
+                    # @return [String] An absolute API resource URL for this global configuration.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] Contains absolute API resource URLs to access the webhook and default service configurations.
+                    def links
+                        @properties['links']
+                    end
+                    
+                    ##
+                    # Fetch the ConfigurationInstance
+                    # @return [ConfigurationInstance] Fetched ConfigurationInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the ConfigurationInstance
+                    # @param [String] default_chat_service_sid The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.
+                    # @param [String] default_messaging_service_sid The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.
+                    # @param [String] default_inactive_timer Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.
+                    # @param [String] default_closed_timer Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.
+                    # @return [ConfigurationInstance] Updated ConfigurationInstance
+                    def update(
+                        default_chat_service_sid: :unset, 
+                        default_messaging_service_sid: :unset, 
+                        default_inactive_timer: :unset, 
+                        default_closed_timer: :unset
+                    )
+
+                        context.update(
+                            default_chat_service_sid: default_chat_service_sid, 
+                            default_messaging_service_sid: default_messaging_service_sid, 
+                            default_inactive_timer: default_inactive_timer, 
+                            default_closed_timer: default_closed_timer, 
+                        )
+                    end
+
+                    ##
+                    # Access the webhooks
+                    # @return [webhooks] webhooks
+                    def webhooks
+                        context.webhooks
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V1.ConfigurationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V1.ConfigurationInstance #{values}>"
+                    end
+                end
 
-        class ConfigurationInstance < InstanceResource
-          ##
-          # Initialize the ConfigurationInstance
-          # @param [Version] version Version that contains the resource
-          # @param [Hash] payload payload that contains response from Twilio
-          # @return [ConfigurationInstance] ConfigurationInstance
-          def initialize(version, payload)
-            super(version)
-
-            # Marshaled Properties
-            @properties = {
-                'account_sid' => payload['account_sid'],
-                'default_chat_service_sid' => payload['default_chat_service_sid'],
-                'default_messaging_service_sid' => payload['default_messaging_service_sid'],
-                'default_inactive_timer' => payload['default_inactive_timer'],
-                'default_closed_timer' => payload['default_closed_timer'],
-                'url' => payload['url'],
-                'links' => payload['links'],
-            }
-
-            # Context
-            @instance_context = nil
-            @params = {}
-          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 [ConfigurationContext] ConfigurationContext for this ConfigurationInstance
-          def context
-            unless @instance_context
-              @instance_context = ConfigurationContext.new(@version, )
             end
-            @instance_context
-          end
-
-          ##
-          # @return [String] The SID of the Account responsible for this configuration.
-          def account_sid
-            @properties['account_sid']
-          end
-
-          ##
-          # @return [String] The SID of the default Conversation Service that every new conversation is associated with.
-          def default_chat_service_sid
-            @properties['default_chat_service_sid']
-          end
-
-          ##
-          # @return [String] The SID of the default Messaging Service that every new conversation is associated with.
-          def default_messaging_service_sid
-            @properties['default_messaging_service_sid']
-          end
-
-          ##
-          # @return [String] Default ISO8601 duration when conversation will be switched to `inactive` state.
-          def default_inactive_timer
-            @properties['default_inactive_timer']
-          end
-
-          ##
-          # @return [String] Default ISO8601 duration when conversation will be switched to `closed` state.
-          def default_closed_timer
-            @properties['default_closed_timer']
-          end
-
-          ##
-          # @return [String] An absolute URL for this global configuration.
-          def url
-            @properties['url']
-          end
-
-          ##
-          # @return [String] Absolute URLs to access the webhook and default service configurations.
-          def links
-            @properties['links']
-          end
-
-          ##
-          # Fetch the ConfigurationInstance
-          # @return [ConfigurationInstance] Fetched ConfigurationInstance
-          def fetch
-            context.fetch
-          end
-
-          ##
-          # Update the ConfigurationInstance
-          # @param [String] default_chat_service_sid The SID of the default {Conversation
-          #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] to use
-          #   when creating a conversation.
-          # @param [String] default_messaging_service_sid The SID of the default {Messaging
-          #   Service}[https://www.twilio.com/docs/sms/services/api] to use when creating a
-          #   conversation.
-          # @param [String] default_inactive_timer Default ISO8601 duration when
-          #   conversation will be switched to `inactive` state. Minimum value for this timer
-          #   is 1 minute.
-          # @param [String] default_closed_timer Default ISO8601 duration when conversation
-          #   will be switched to `closed` state. Minimum value for this timer is 10 minutes.
-          # @return [ConfigurationInstance] Updated ConfigurationInstance
-          def update(default_chat_service_sid: :unset, default_messaging_service_sid: :unset, default_inactive_timer: :unset, default_closed_timer: :unset)
-            context.update(
-                default_chat_service_sid: default_chat_service_sid,
-                default_messaging_service_sid: default_messaging_service_sid,
-                default_inactive_timer: default_inactive_timer,
-                default_closed_timer: default_closed_timer,
-            )
-          end
-
-          ##
-          # Provide a user friendly representation
-          def to_s
-            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Conversations.V1.ConfigurationInstance #{values}>"
-          end
-
-          ##
-          # Provide a detailed, user friendly representation
-          def inspect
-            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Conversations.V1.ConfigurationInstance #{values}>"
-          end
         end
-      end
     end
-  end
-end
+end