twilio-ruby 5.31.1 → 5.54.0

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

@@ -0,0 +1,260 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# 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
+
+        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

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

@@ -0,0 +1,254 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# 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
+
+            ##
+            # 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
+
+            ##
+            # 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
+
+            ##
+            # 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 [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
+
+            ##
+            # 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
+
+          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 [Array[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 [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
+              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