twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,254 +1,472 @@
 ##
-# 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 ConfigurationContext < InstanceContext
-          class WebhookList < ListResource
-            ##
-            # Initialize the WebhookList
-            # @param [Version] version Version that contains the resource
-            # @return [WebhookList] WebhookList
-            def initialize(version)
-              super(version)
-
-              # Path Solution
-              @solution = {}
-            end
+    module REST
+        class Conversations < ConversationsBase
+            class V1 < Version
+                class ConfigurationContext < InstanceContext
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '#<Twilio.Conversations.V1.WebhookList>'
-            end
-          end
-
-          class WebhookPage < Page
-            ##
-            # Initialize the WebhookPage
-            # @param [Version] version Version that contains the resource
-            # @param [Response] response Response from the API
-            # @param [Hash] solution Path solution for the resource
-            # @return [WebhookPage] WebhookPage
-            def initialize(version, response, solution)
-              super(version, response)
-
-              # Path Solution
-              @solution = solution
-            end
+                     class WebhookList < ListResource
+                
+                    ##
+                    # Initialize the WebhookList
+                    # @param [Version] version Version that contains the resource
+                    # @return [WebhookList] WebhookList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
 
-            ##
-            # Build an instance of WebhookInstance
-            # @param [Hash] payload Payload response from the API
-            # @return [WebhookInstance] WebhookInstance
-            def get_instance(payload)
-              WebhookInstance.new(@version, payload, )
-            end
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '<Twilio.Conversations.V1.WebhookPage>'
-            end
-          end
-
-          class WebhookContext < InstanceContext
-            ##
-            # Initialize the WebhookContext
-            # @param [Version] version Version that contains the resource
-            # @return [WebhookContext] WebhookContext
-            def initialize(version)
-              super(version)
-
-              # Path Solution
-              @solution = {}
-              @uri = "/Configuration/Webhooks"
-            end
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Conversations.V1.WebhookList>'
+                    end
+                end
 
-            ##
-            # Fetch the WebhookInstance
-            # @return [WebhookInstance] Fetched WebhookInstance
-            def fetch
-              payload = @version.fetch('GET', @uri)
 
-              WebhookInstance.new(@version, payload, )
-            end
+                class WebhookContext < InstanceContext
+                    ##
+                    # Initialize the WebhookContext
+                    # @param [Version] version Version that contains the resource
+                    # @return [WebhookContext] WebhookContext
+                    def initialize(version)
+                        super(version)
+                        
 
-            ##
-            # Update the WebhookInstance
-            # @param [String] method The HTTP method to be used when sending a webhook
-            #   request.
-            # @param [Array[String]] filters The list of webhook event triggers that are
-            #   enabled for this Service: `onMessageAdded`, `onMessageUpdated`,
-            #   `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`,
-            #   `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`
-            # @param [String] pre_webhook_url The absolute url the pre-event webhook request
-            #   should be sent to.
-            # @param [String] post_webhook_url The absolute url the post-event webhook request
-            #   should be sent to.
-            # @param [webhook.Target] target The routing target of the webhook.
-            # @return [WebhookInstance] Updated WebhookInstance
-            def update(method: :unset, filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, target: :unset)
-              data = Twilio::Values.of({
-                  'Method' => method,
-                  'Filters' => Twilio.serialize_list(filters) { |e| e },
-                  'PreWebhookUrl' => pre_webhook_url,
-                  'PostWebhookUrl' => post_webhook_url,
-                  'Target' => target,
-              })
-
-              payload = @version.update('POST', @uri, data: data)
-
-              WebhookInstance.new(@version, payload, )
-            end
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Configuration/Webhooks"
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Conversations.V1.WebhookContext #{context}>"
-            end
+                        
+                    end
+                    ##
+                    # Fetch the WebhookInstance
+                    # @return [WebhookInstance] Fetched WebhookInstance
+                    def fetch
 
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Conversations.V1.WebhookContext #{context}>"
-            end
-          end
-
-          class WebhookInstance < InstanceResource
-            ##
-            # Initialize the WebhookInstance
-            # @param [Version] version Version that contains the resource
-            # @param [Hash] payload payload that contains response from Twilio
-            # @return [WebhookInstance] WebhookInstance
-            def initialize(version, payload)
-              super(version)
-
-              # Marshaled Properties
-              @properties = {
-                  'account_sid' => payload['account_sid'],
-                  'method' => payload['method'],
-                  'filters' => payload['filters'],
-                  'pre_webhook_url' => payload['pre_webhook_url'],
-                  'post_webhook_url' => payload['post_webhook_url'],
-                  'target' => payload['target'],
-                  'url' => payload['url'],
-              }
-
-              # Context
-              @instance_context = nil
-              @params = {}
-            end
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        WebhookInstance.new(
+                            @version,
+                            payload,
+                        )
+                    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 [WebhookContext] WebhookContext for this WebhookInstance
-            def context
-              unless @instance_context
-                @instance_context = WebhookContext.new(@version, )
-              end
-              @instance_context
-            end
+                    ##
+                    # Fetch the WebhookInstanceMetadata
+                    # @return [WebhookInstance] Fetched WebhookInstance
+                    def fetch_with_metadata
 
-            ##
-            # @return [String] The unique ID of the Account responsible for this conversation.
-            def account_sid
-              @properties['account_sid']
-            end
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        webhook_instance = WebhookInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        WebhookInstanceMetadata.new(
+                            @version,
+                            webhook_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
 
-            ##
-            # @return [webhook.Method] The HTTP method to be used when sending a webhook request.
-            def method
-              @properties['method']
-            end
+                    ##
+                    # Update the WebhookInstance
+                    # @param [String] method The HTTP method to be used when sending a webhook request.
+                    # @param [Array[String]] filters The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onMessageAdd`, `onMessageUpdate`, `onMessageRemove`, `onConversationUpdated`, `onConversationRemoved`, `onConversationAdd`, `onConversationAdded`, `onConversationRemove`, `onConversationUpdate`, `onConversationStateUpdated`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onParticipantAdd`, `onParticipantRemove`, `onParticipantUpdate`, `onDeliveryUpdated`, `onUserAdded`, `onUserUpdate`, `onUserUpdated`
+                    # @param [String] pre_webhook_url The absolute url the pre-event webhook request should be sent to.
+                    # @param [String] post_webhook_url The absolute url the post-event webhook request should be sent to.
+                    # @param [Target] target 
+                    # @return [WebhookInstance] Updated WebhookInstance
+                    def update(
+                        method: :unset, 
+                        filters: :unset, 
+                        pre_webhook_url: :unset, 
+                        post_webhook_url: :unset, 
+                        target: :unset
+                    )
 
-            ##
-            # @return [Array[String]] The list of webhook event triggers that are enabled for this Service.
-            def filters
-              @properties['filters']
-            end
+                        data = Twilio::Values.of({
+                            'Method' => method,
+                            'Filters' => Twilio.serialize_list(filters) { |e| e },
+                            'PreWebhookUrl' => pre_webhook_url,
+                            'PostWebhookUrl' => post_webhook_url,
+                            'Target' => target,
+                        })
 
-            ##
-            # @return [String] The absolute url the pre-event webhook request should be sent to.
-            def pre_webhook_url
-              @properties['pre_webhook_url']
-            end
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        WebhookInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
 
-            ##
-            # @return [String] The absolute url the post-event webhook request should be sent to.
-            def post_webhook_url
-              @properties['post_webhook_url']
-            end
+                    ##
+                    # Update the WebhookInstanceMetadata
+                    # @param [String] method The HTTP method to be used when sending a webhook request.
+                    # @param [Array[String]] filters The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onMessageAdd`, `onMessageUpdate`, `onMessageRemove`, `onConversationUpdated`, `onConversationRemoved`, `onConversationAdd`, `onConversationAdded`, `onConversationRemove`, `onConversationUpdate`, `onConversationStateUpdated`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onParticipantAdd`, `onParticipantRemove`, `onParticipantUpdate`, `onDeliveryUpdated`, `onUserAdded`, `onUserUpdate`, `onUserUpdated`
+                    # @param [String] pre_webhook_url The absolute url the pre-event webhook request should be sent to.
+                    # @param [String] post_webhook_url The absolute url the post-event webhook request should be sent to.
+                    # @param [Target] target 
+                    # @return [WebhookInstance] Updated WebhookInstance
+                    def update_with_metadata(
+                      method: :unset, 
+                      filters: :unset, 
+                      pre_webhook_url: :unset, 
+                      post_webhook_url: :unset, 
+                      target: :unset
+                    )
 
-            ##
-            # @return [webhook.Target] The routing target of the webhook.
-            def target
-              @properties['target']
-            end
+                        data = Twilio::Values.of({
+                            'Method' => method,
+                            'Filters' => Twilio.serialize_list(filters) { |e| e },
+                            'PreWebhookUrl' => pre_webhook_url,
+                            'PostWebhookUrl' => post_webhook_url,
+                            'Target' => target,
+                        })
 
-            ##
-            # @return [String] An absolute URL for this webhook.
-            def url
-              @properties['url']
-            end
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        webhook_instance = WebhookInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        WebhookInstanceMetadata.new(
+                            @version,
+                            webhook_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
 
-            ##
-            # Fetch the WebhookInstance
-            # @return [WebhookInstance] Fetched WebhookInstance
-            def fetch
-              context.fetch
-            end
 
-            ##
-            # Update the WebhookInstance
-            # @param [String] method The HTTP method to be used when sending a webhook
-            #   request.
-            # @param [Array[String]] filters The list of webhook event triggers that are
-            #   enabled for this Service: `onMessageAdded`, `onMessageUpdated`,
-            #   `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`,
-            #   `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`
-            # @param [String] pre_webhook_url The absolute url the pre-event webhook request
-            #   should be sent to.
-            # @param [String] post_webhook_url The absolute url the post-event webhook request
-            #   should be sent to.
-            # @param [webhook.Target] target The routing target of the webhook.
-            # @return [WebhookInstance] Updated WebhookInstance
-            def update(method: :unset, filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, target: :unset)
-              context.update(
-                  method: method,
-                  filters: filters,
-                  pre_webhook_url: pre_webhook_url,
-                  post_webhook_url: post_webhook_url,
-                  target: target,
-              )
-            end
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+                    end
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Conversations.V1.WebhookInstance #{values}>"
-            end
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+                    end
+                end
+
+                class WebhookInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WebhookInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WebhookInstance] webhook_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 [WebhookInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, webhook_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @webhook_instance = webhook_instance
+                    end
+
+                    def webhook
+                        @webhook_instance
+                    end
 
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WebhookInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WebhookListResponse < InstanceListResource
+                    # @param [Array<WebhookInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @webhook_instance = payload.body[key].map do |data|
+                        WebhookInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def webhook_instance
+                          @instance
+                      end
+                  end
+
+                class WebhookPage < Page
+                    ##
+                    # Initialize the WebhookPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [WebhookPage] WebhookPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of WebhookInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [WebhookInstance] WebhookInstance
+                    def get_instance(payload)
+                        WebhookInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Conversations.V1.WebhookPage>'
+                    end
+                end
+
+                class WebhookPageMetadata < PageMetadata
+                    attr_reader :webhook_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @webhook_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @webhook_page << WebhookListResponse.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
+                        @webhook_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V1PageMetadata>';
+                    end
+                end
+                class WebhookListResponse < InstanceListResource
+
+                    # @param [Array<WebhookInstance>] 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
+                      @webhook = data_list.map do |data|
+                        WebhookInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def webhook
+                        @webhook
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class WebhookInstance < InstanceResource
+                    ##
+                    # Initialize the WebhookInstance
+                    # @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 Webhook
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [WebhookInstance] WebhookInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'method' => payload['method'],
+                            'filters' => payload['filters'],
+                            'pre_webhook_url' => payload['pre_webhook_url'],
+                            'post_webhook_url' => payload['post_webhook_url'],
+                            'target' => payload['target'],
+                            'url' => payload['url'],
+                        }
+
+                        # 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 [WebhookContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = WebhookContext.new(@version )
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Method] 
+                    def method
+                        @properties['method']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onMessageAdd`, `onMessageUpdate`, `onMessageRemove`, `onConversationUpdated`, `onConversationRemoved`, `onConversationAdd`, `onConversationAdded`, `onConversationRemove`, `onConversationUpdate`, `onConversationStateUpdated`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onParticipantAdd`, `onParticipantRemove`, `onParticipantUpdate`, `onDeliveryUpdated`, `onUserAdded`, `onUserUpdate`, `onUserUpdated`
+                    def filters
+                        @properties['filters']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute url the pre-event webhook request should be sent to.
+                    def pre_webhook_url
+                        @properties['pre_webhook_url']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute url the post-event webhook request should be sent to.
+                    def post_webhook_url
+                        @properties['post_webhook_url']
+                    end
+                    
+                    ##
+                    # @return [Target] 
+                    def target
+                        @properties['target']
+                    end
+                    
+                    ##
+                    # @return [String] An absolute API resource API resource URL for this webhook.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the WebhookInstance
+                    # @return [WebhookInstance] Fetched WebhookInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the WebhookInstance
+                    # @param [String] method The HTTP method to be used when sending a webhook request.
+                    # @param [Array[String]] filters The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onMessageAdd`, `onMessageUpdate`, `onMessageRemove`, `onConversationUpdated`, `onConversationRemoved`, `onConversationAdd`, `onConversationAdded`, `onConversationRemove`, `onConversationUpdate`, `onConversationStateUpdated`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onParticipantAdd`, `onParticipantRemove`, `onParticipantUpdate`, `onDeliveryUpdated`, `onUserAdded`, `onUserUpdate`, `onUserUpdated`
+                    # @param [String] pre_webhook_url The absolute url the pre-event webhook request should be sent to.
+                    # @param [String] post_webhook_url The absolute url the post-event webhook request should be sent to.
+                    # @param [Target] target 
+                    # @return [WebhookInstance] Updated WebhookInstance
+                    def update(
+                        method: :unset, 
+                        filters: :unset, 
+                        pre_webhook_url: :unset, 
+                        post_webhook_url: :unset, 
+                        target: :unset
+                    )
+
+                        context.update(
+                            method: method, 
+                            filters: filters, 
+                            pre_webhook_url: pre_webhook_url, 
+                            post_webhook_url: post_webhook_url, 
+                            target: target, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Conversations.V1.WebhookInstance #{values}>"
+                    end
+                end
+
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+