twilio-ruby 5.6.0 → 5.33.1

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

@@ -0,0 +1,272 @@
+##
+# 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 a WebhookInstance
+          # @return [WebhookInstance] Fetched WebhookInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            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 a 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/fax/v1/fax/fax_media.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,8 +17,8 @@ module Twilio
             ##
             # Initialize the FaxMediaList
             # @param [Version] version Version that contains the resource
-            # @param [String] fax_sid The unique SID identifier of the fax for which this
-            #   media is associated.
+            # @param [String] fax_sid The SID of the fax the FaxMedia resource is associated
+            #   with.
             # @return [FaxMediaList] FaxMediaList
             def initialize(version, fax_sid: nil)
               super(version)
@@ -55,7 +57,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -67,7 +69,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -136,7 +138,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [FaxMediaInstance] FaxMediaInstance
             def get_instance(payload)
-              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid])
+              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid], )
             end
 
             ##
@@ -152,15 +154,15 @@ module Twilio
             ##
             # Initialize the FaxMediaContext
             # @param [Version] version Version that contains the resource
-            # @param [String] fax_sid The unique SID identifier of the fax.
-            # @param [String] sid A 34 character string that uniquely identifies this fax
-            #   media.
+            # @param [String] fax_sid The SID of the fax with the FaxMedia resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   FaxMedia resource to fetch.
             # @return [FaxMediaContext] FaxMediaContext
             def initialize(version, fax_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {fax_sid: fax_sid, sid: sid}
+              @solution = {fax_sid: fax_sid, sid: sid, }
               @uri = "/Faxes/#{@solution[:fax_sid]}/Media/#{@solution[:sid]}"
             end
 
@@ -176,12 +178,12 @@ module Twilio
                   params,
               )
 
-              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid], sid: @solution[:sid])
+              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the FaxMediaInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -192,6 +194,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Fax.V1.FaxMediaContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Fax.V1.FaxMediaContext #{context}>"
+            end
           end
 
           ##
@@ -201,10 +210,10 @@ module Twilio
             # Initialize the FaxMediaInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] fax_sid The unique SID identifier of the fax for which this
-            #   media is associated.
-            # @param [String] sid A 34 character string that uniquely identifies this fax
-            #   media.
+            # @param [String] fax_sid The SID of the fax the FaxMedia resource is associated
+            #   with.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   FaxMedia resource to fetch.
             # @return [FaxMediaInstance] FaxMediaInstance
             def initialize(version, payload, fax_sid: nil, sid: nil)
               super(version)
@@ -222,7 +231,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'fax_sid' => fax_sid, 'sid' => sid || @properties['sid']}
+              @params = {'fax_sid' => fax_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -231,49 +240,49 @@ module Twilio
             # @return [FaxMediaContext] FaxMediaContext for this FaxMediaInstance
             def context
               unless @instance_context
-                @instance_context = FaxMediaContext.new(@version, @params['fax_sid'], @params['sid'])
+                @instance_context = FaxMediaContext.new(@version, @params['fax_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this fax media
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Account SID
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] Fax SID
+            # @return [String] The SID of the fax the FaxMedia resource is associated with
             def fax_sid
               @properties['fax_sid']
             end
 
             ##
-            # @return [String] Media content type
+            # @return [String] The content type of the stored fax media
             def content_type
               @properties['content_type']
             end
 
             ##
-            # @return [Time] The date this fax media was created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this fax media was updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The URL of this resource
+            # @return [String] The absolute URL of the FaxMedia resource
             def url
               @properties['url']
             end
@@ -287,7 +296,7 @@ module Twilio
 
             ##
             # Deletes the FaxMediaInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end