twilio-ruby 5.19.0 → 5.20.0

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

@@ -0,0 +1,285 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # 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 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.Messaging.V1.WebhookList>'
+          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 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.Messaging.V1.WebhookPage>'
+          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 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 = "/Sessions/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] webhook_method The HTTP method to be used when sending a webhook
+          #   request.
+          # @param [String] webhook_filters The list of webhook event triggers that are
+          #   enabled for this Service.
+          # @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 [String] pre_webhook_retry_count The number of retries in case of
+          #   pre-event webhook request failures. Maximum 3 retries are allowed, the default
+          #   value is 0.
+          # @param [String] post_webhook_retry_count The number of retries in case of
+          #   post-event webhook request failures. Maximum 3 retries are allowed, the default
+          #   value is 0.
+          # @return [WebhookInstance] Updated WebhookInstance
+          def update(webhook_method: :unset, webhook_filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset)
+            data = Twilio::Values.of({
+                'WebhookMethod' => webhook_method,
+                'WebhookFilters' => Twilio.serialize_list(webhook_filters) { |e| e },
+                'PreWebhookUrl' => pre_webhook_url,
+                'PostWebhookUrl' => post_webhook_url,
+                'PreWebhookRetryCount' => pre_webhook_retry_count,
+                'PostWebhookRetryCount' => post_webhook_retry_count,
+            })
+
+            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.Messaging.V1.WebhookContext #{context}>"
+          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 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'],
+                'service_sid' => payload['service_sid'],
+                'webhook_method' => payload['webhook_method'],
+                'webhook_filters' => payload['webhook_filters'],
+                'pre_webhook_url' => payload['pre_webhook_url'],
+                'post_webhook_url' => payload['post_webhook_url'],
+                'pre_webhook_retry_count' => payload['pre_webhook_retry_count'].to_i,
+                'post_webhook_retry_count' => payload['post_webhook_retry_count'].to_i,
+                '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 session.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The unique id of the Chat Service this session belongs to.
+          def service_sid
+            @properties['service_sid']
+          end
+
+          ##
+          # @return [String] The HTTP method to be used when sending a webhook request.
+          def webhook_method
+            @properties['webhook_method']
+          end
+
+          ##
+          # @return [String] The list of webhook event triggers that are enabled for this Service.
+          def webhook_filters
+            @properties['webhook_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 [String] The number of retries in case of pre-event webhook request failures.
+          def pre_webhook_retry_count
+            @properties['pre_webhook_retry_count']
+          end
+
+          ##
+          # @return [String] The number of retries in case of post-event webhook request failures.
+          def post_webhook_retry_count
+            @properties['post_webhook_retry_count']
+          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] webhook_method The HTTP method to be used when sending a webhook
+          #   request.
+          # @param [String] webhook_filters The list of webhook event triggers that are
+          #   enabled for this Service.
+          # @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 [String] pre_webhook_retry_count The number of retries in case of
+          #   pre-event webhook request failures. Maximum 3 retries are allowed, the default
+          #   value is 0.
+          # @param [String] post_webhook_retry_count The number of retries in case of
+          #   post-event webhook request failures. Maximum 3 retries are allowed, the default
+          #   value is 0.
+          # @return [WebhookInstance] Updated WebhookInstance
+          def update(webhook_method: :unset, webhook_filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset)
+            context.update(
+                webhook_method: webhook_method,
+                webhook_filters: webhook_filters,
+                pre_webhook_url: pre_webhook_url,
+                post_webhook_url: post_webhook_url,
+                pre_webhook_retry_count: pre_webhook_retry_count,
+                post_webhook_retry_count: post_webhook_retry_count,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.WebhookInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.WebhookInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -120,14 +120,6 @@ module Twilio
         self.hosted_numbers.hosted_number_orders(sid)
       end
 
-      ##
-      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
-      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
-      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-      def available_add_ons(sid=:unset)
-        self.marketplace.available_add_ons(sid)
-      end
-
       ##
       # @param [String] sid 34 character string that uniquely identifies the Add-on.
       #   This Sid can also be found in the Console on that specific Add-ons page as the
@@ -138,6 +130,14 @@ module Twilio
         self.marketplace.installed_add_ons(sid)
       end
 
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Add-on.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+      def available_add_ons(sid=:unset)
+        self.marketplace.available_add_ons(sid)
+      end
+
       ##
       # @param [String] sid The sid
       # @return [Twilio::REST::Preview::Sync::ServiceInstance] if sid was passed.

data/lib/twilio-ruby/rest/preview/marketplace.rb

@@ -15,37 +15,37 @@ module Twilio
         def initialize(domain)
           super
           @version = 'marketplace'
-          @available_add_ons = nil
           @installed_add_ons = nil
+          @available_add_ons = nil
         end
 
         ##
-        # @param [String] sid The Available Add-on Sid that uniquely identifies this
+        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-        def available_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
+        def installed_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @available_add_ons ||= AvailableAddOnList.new self
+            @installed_add_ons ||= InstalledAddOnList.new self
           else
-            AvailableAddOnContext.new(self, sid)
+            InstalledAddOnContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
+        # @param [String] sid The Available Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
-        def installed_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+        def available_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @installed_add_ons ||= InstalledAddOnList.new self
+            @available_add_ons ||= AvailableAddOnList.new self
           else
-            InstalledAddOnContext.new(self, sid)
+            AvailableAddOnContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/proxy/v1/service/session.rb

@@ -114,8 +114,9 @@ module Twilio
             # Request is executed immediately.
             # @param [String] unique_name Your unique identifier for this Session such as a
             #   Job ID or conversation ID. *Should not contain PII.*
-            # @param [Time] date_expiry An absolute time (ISO 8601) at which this Session
-            #   should close. If this is populated, it takes precedence over TTL values.
+            # @param [Time] date_expiry An absolute time (ISO 8601) in the future at which
+            #   this Session should close. If this is populated, it takes precedence over TTL
+            #   values.
             # @param [String] ttl The time, in seconds, after the latest of Session create
             #   time or the Session's last Interaction time at which the session will expire.
             # @param [session.Mode] mode The type of communications mediums allowed on a

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

@@ -28,15 +28,6 @@ module Twilio
         @v1 ||= V1.new self
       end
 
-      ##
-      # @param [String] sid `CJxx…xx` A system-generated 34-character string that
-      #   uniquely identifies this Composition.
-      # @return [Twilio::REST::Video::V1::CompositionInstance] if sid was passed.
-      # @return [Twilio::REST::Video::V1::CompositionList]
-      def compositions(sid=:unset)
-        self.v1.compositions(sid)
-      end
-
       ##
       # @param [String] sid `HKxx…xx` A system-generated 34-character string that
       #   uniquely identifies this Composition Hook.
@@ -67,6 +58,15 @@ module Twilio
         self.v1.recording_settings()
       end
 
+      ##
+      # @param [String] sid `CJxx…xx` A system-generated 34-character string that
+      #   uniquely identifies this Composition.
+      # @return [Twilio::REST::Video::V1::CompositionInstance] if sid was passed.
+      # @return [Twilio::REST::Video::V1::CompositionList]
+      def compositions(sid=:unset)
+        self.v1.compositions(sid)
+      end
+
       ##
       # @param [String] sid A system-generated 34-character string that uniquely
       #   identifies this resource.

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

@@ -15,29 +15,14 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
-          @compositions = nil
           @composition_hooks = nil
           @composition_settings = nil
           @recordings = nil
           @recording_settings = nil
+          @compositions = nil
           @rooms = nil
         end
 
-        ##
-        # @param [String] sid The Composition Sid that uniquely identifies the Composition
-        #   to fetch.
-        # @return [Twilio::REST::Video::V1::CompositionContext] if sid was passed.
-        # @return [Twilio::REST::Video::V1::CompositionList]
-        def compositions(sid=:unset)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @compositions ||= CompositionList.new self
-          else
-            CompositionContext.new(self, sid)
-          end
-        end
-
         ##
         # @param [String] sid The Composition Hook Sid that uniquely identifies the
         #   Composition Hook to fetch.
@@ -80,6 +65,21 @@ module Twilio
           @recording_settings ||= RecordingSettingsContext.new self
         end
 
+        ##
+        # @param [String] sid The Composition Sid that uniquely identifies the Composition
+        #   to fetch.
+        # @return [Twilio::REST::Video::V1::CompositionContext] if sid was passed.
+        # @return [Twilio::REST::Video::V1::CompositionList]
+        def compositions(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @compositions ||= CompositionList.new self
+          else
+            CompositionContext.new(self, sid)
+          end
+        end
+
         ##
         # @param [String] sid The Room Sid or name that uniquely identifies this resource.
         # @return [Twilio::REST::Video::V1::RoomContext] if sid was passed.