twilio-ruby 4.13.0 → 5.40.0

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

@@ -0,0 +1,262 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.WebhookList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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 = "/Conversations/Webhooks"
+          end
+
+          ##
+          # Fetch the WebhookInstance
+          # @return [WebhookInstance] Fetched WebhookInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            WebhookInstance.new(@version, payload, )
+          end
+
+          ##
+          # Update the WebhookInstance
+          # @param [String] method The HTTP method to be used when sending a webhook
+          #   request.
+          # @param [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. Can be
+          #   ordinary or route internally to Flex
+          # @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
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.WebhookContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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
+
+          ##
+          # 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
+
+          ##
+          # @return [String] The unique id of the Account responsible for this conversation.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [webhook.Method] The HTTP method to be used when sending a webhook request.
+          def method
+            @properties['method']
+          end
+
+          ##
+          # @return [String] The list of webhook event triggers that are enabled for this Service.
+          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 [webhook.Target] The routing target of the webhook.
+          def target
+            @properties['target']
+          end
+
+          ##
+          # @return [String] An absolute 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 [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. Can be
+          #   ordinary or route internally to Flex
+          # @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

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

@@ -0,0 +1,51 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Conversations
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @conversations = nil
+          @webhooks = nil
+        end
+
+        ##
+        # @param [String] sid A 34 character string that uniquely identifies this
+        #   resource.
+        # @return [Twilio::REST::Conversations::V1::ConversationContext] if sid was passed.
+        # @return [Twilio::REST::Conversations::V1::ConversationList]
+        def conversations(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @conversations ||= ConversationList.new self
+          else
+            ConversationContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Conversations::V1::WebhookContext]
+        def webhooks
+          @webhooks ||= WebhookContext.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Conversations::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      ##
+      # Initialize the Conversations Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://conversations.twilio.com'
+        @host = 'conversations.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of conversations
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Conversations::V1::ConversationInstance] if sid was passed.
+      # @return [Twilio::REST::Conversations::V1::ConversationList]
+      def conversations(sid=:unset)
+        self.v1.conversations(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Conversations::V1::WebhookInstance]
+      def webhooks
+        self.v1.webhooks()
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Conversations>'
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/events/v1/sink/sink_test.rb

@@ -0,0 +1,115 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Events < Domain
+      class V1 < Version
+        class SinkContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SinkTestList < ListResource
+            ##
+            # Initialize the SinkTestList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The sid
+            # @return [SinkTestList] SinkTestList
+            def initialize(version, sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid}
+              @uri = "/Sinks/#{@solution[:sid]}/Test"
+            end
+
+            ##
+            # Create the SinkTestInstance
+            # @return [SinkTestInstance] Created SinkTestInstance
+            def create
+              payload = @version.create('POST', @uri)
+
+              SinkTestInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Events.V1.SinkTestList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SinkTestPage < Page
+            ##
+            # Initialize the SinkTestPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SinkTestPage] SinkTestPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SinkTestInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SinkTestInstance] SinkTestInstance
+            def get_instance(payload)
+              SinkTestInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Events.V1.SinkTestPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SinkTestInstance < InstanceResource
+            ##
+            # Initialize the SinkTestInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid The sid
+            # @return [SinkTestInstance] SinkTestInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {'result' => payload['result'], }
+            end
+
+            ##
+            # @return [String] The result
+            def result
+              @properties['result']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Events.V1.SinkTestInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Events.V1.SinkTestInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/events/v1/sink/sink_validate.rb

@@ -0,0 +1,118 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Events < Domain
+      class V1 < Version
+        class SinkContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SinkValidateList < ListResource
+            ##
+            # Initialize the SinkValidateList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The sid
+            # @return [SinkValidateList] SinkValidateList
+            def initialize(version, sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid}
+              @uri = "/Sinks/#{@solution[:sid]}/Validate"
+            end
+
+            ##
+            # Create the SinkValidateInstance
+            # @param [String] test_id The test_id
+            # @return [SinkValidateInstance] Created SinkValidateInstance
+            def create(test_id: nil)
+              data = Twilio::Values.of({'TestId' => test_id, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              SinkValidateInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Events.V1.SinkValidateList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SinkValidatePage < Page
+            ##
+            # Initialize the SinkValidatePage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SinkValidatePage] SinkValidatePage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SinkValidateInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SinkValidateInstance] SinkValidateInstance
+            def get_instance(payload)
+              SinkValidateInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Events.V1.SinkValidatePage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SinkValidateInstance < InstanceResource
+            ##
+            # Initialize the SinkValidateInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid The sid
+            # @return [SinkValidateInstance] SinkValidateInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {'result' => payload['result'], }
+            end
+
+            ##
+            # @return [String] The result
+            def result
+              @properties['result']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Events.V1.SinkValidateInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Events.V1.SinkValidateInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end