twilio-ruby 5.40.3 → 5.74.1

data/lib/twilio-ruby/rest/chat/v2/service.rb

@@ -193,22 +193,22 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to the service. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to a channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   channel creator when they join a new channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -251,18 +251,18 @@ module Twilio
           #   play when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
-          #   the default is `POST`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
-          # @param [String] webhook_filters The list of webhook events that are enabled for
-          #   this Service instance. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @param [Array[String]] webhook_filters The list of webhook events that are
+          #   enabled for this Service instance. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] limits_channel_members The maximum number of Members that can be
           #   added to Channels within this Service. Can be up to 1,000.
           # @param [String] limits_user_channels The maximum number of Channels Users can be
@@ -429,15 +429,15 @@ module Twilio
                 'default_channel_creator_role_sid' => payload['default_channel_creator_role_sid'],
                 'read_status_enabled' => payload['read_status_enabled'],
                 'reachability_enabled' => payload['reachability_enabled'],
-                'typing_indicator_timeout' => payload['typing_indicator_timeout'].to_i,
-                'consumption_report_interval' => payload['consumption_report_interval'].to_i,
+                'typing_indicator_timeout' => payload['typing_indicator_timeout'] == nil ? payload['typing_indicator_timeout'] : payload['typing_indicator_timeout'].to_i,
+                'consumption_report_interval' => payload['consumption_report_interval'] == nil ? payload['consumption_report_interval'] : payload['consumption_report_interval'].to_i,
                 'limits' => payload['limits'],
                 'pre_webhook_url' => payload['pre_webhook_url'],
                 'post_webhook_url' => payload['post_webhook_url'],
                 'webhook_method' => payload['webhook_method'],
                 'webhook_filters' => payload['webhook_filters'],
-                'pre_webhook_retry_count' => payload['pre_webhook_retry_count'].to_i,
-                'post_webhook_retry_count' => payload['post_webhook_retry_count'].to_i,
+                'pre_webhook_retry_count' => payload['pre_webhook_retry_count'] == nil ? payload['pre_webhook_retry_count'] : payload['pre_webhook_retry_count'].to_i,
+                'post_webhook_retry_count' => payload['post_webhook_retry_count'] == nil ? payload['post_webhook_retry_count'] : payload['post_webhook_retry_count'].to_i,
                 'notifications' => payload['notifications'],
                 'media' => payload['media'],
                 'url' => payload['url'],
@@ -557,7 +557,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The list of webhook events that are enabled for this Service instance
+          # @return [Array[String]] The list of webhook events that are enabled for this Service instance
           def webhook_filters
             @properties['webhook_filters']
           end
@@ -617,22 +617,22 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource.
           # @param [String] default_service_role_sid The service role assigned to users when
-          #   they are added to the service. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to the service. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_role_sid The channel role assigned to users when
-          #   they are added to a channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   they are added to a channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
           # @param [String] default_channel_creator_role_sid The channel role assigned to a
-          #   channel creator when they join a new channel. See the [Role
-          #   resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info
+          #   channel creator when they join a new channel. See the {Role
+          #   resource}[https://www.twilio.com/docs/chat/rest/role-resource] for more info
           #   about roles.
-          # @param [Boolean] read_status_enabled Whether to enable the [Message Consumption
-          #   Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The
+          # @param [Boolean] read_status_enabled Whether to enable the {Message Consumption
+          #   Horizon}[https://www.twilio.com/docs/chat/consumption-horizon] feature. The
           #   default is `true`.
-          # @param [Boolean] reachability_enabled Whether to enable the [Reachability
-          #   Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this
+          # @param [Boolean] reachability_enabled Whether to enable the {Reachability
+          #   Indicator}[https://www.twilio.com/docs/chat/reachability-indicator] for this
           #   Service instance. The default is `false`.
           # @param [String] typing_indicator_timeout How long in seconds after a `started
           #   typing` event until clients should assume that user is no longer typing, even if
@@ -675,18 +675,18 @@ module Twilio
           #   play when a user is invited to a channel and
           #   `notifications.invited_to_channel.enabled` is `true`.
           # @param [String] pre_webhook_url The URL for pre-event webhooks, which are called
-          #   by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] post_webhook_url The URL for post-event webhooks, which are
-          #   called by using the `webhook_method`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   called by using the `webhook_method`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] webhook_method The HTTP method to use for calls to the
           #   `pre_webhook_url` and `post_webhook_url` webhooks.  Can be: `POST` or `GET` and
-          #   the default is `POST`. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
-          # @param [String] webhook_filters The list of webhook events that are enabled for
-          #   this Service instance. See [Webhook
-          #   Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
+          #   the default is `POST`. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
+          # @param [Array[String]] webhook_filters The list of webhook events that are
+          #   enabled for this Service instance. See {Webhook
+          #   Events}[https://www.twilio.com/docs/chat/webhook-events] for more details.
           # @param [String] limits_channel_members The maximum number of Members that can be
           #   added to Channels within this Service. Can be up to 1,000.
           # @param [String] limits_user_channels The maximum number of Channels Users can be

data/lib/twilio-ruby/rest/chat/v2.rb

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V2::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Chat::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/chat/v3/channel.rb

@@ -0,0 +1,275 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Chat < Domain
+      class V3 < Version
+        class ChannelList < ListResource
+          ##
+          # Initialize the ChannelList
+          # @param [Version] version Version that contains the resource
+          # @return [ChannelList] ChannelList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Chat.V3.ChannelList>'
+          end
+        end
+
+        class ChannelPage < Page
+          ##
+          # Initialize the ChannelPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ChannelPage] ChannelPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ChannelInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ChannelInstance] ChannelInstance
+          def get_instance(payload)
+            ChannelInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Chat.V3.ChannelPage>'
+          end
+        end
+
+        class ChannelContext < InstanceContext
+          ##
+          # Initialize the ChannelContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] service_sid The unique SID identifier of the Service.
+          # @param [String] sid A 34 character string that uniquely identifies this Channel.
+          # @return [ChannelContext] ChannelContext
+          def initialize(version, service_sid, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {service_sid: service_sid, sid: sid, }
+            @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}"
+          end
+
+          ##
+          # Update the ChannelInstance
+          # @param [channel.ChannelType] type TThe Type for this Channel to migrate to. Can
+          #   only be `private`. Migration to 'public' is not allowed.
+          # @param [String] messaging_service_sid The unique ID of the {Messaging
+          #   Service}[https://www.twilio.com/docs/sms/services/api] this channel belongs to.
+          # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
+          #   X-Twilio-Webhook-Enabled HTTP request header
+          # @return [ChannelInstance] Updated ChannelInstance
+          def update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset)
+            data = Twilio::Values.of({'Type' => type, 'MessagingServiceSid' => messaging_service_sid, })
+            headers = Twilio::Values.of({'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+
+            payload = @version.update('POST', @uri, data: data, headers: headers)
+
+            ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Chat.V3.ChannelContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Chat.V3.ChannelContext #{context}>"
+          end
+        end
+
+        class ChannelInstance < InstanceResource
+          ##
+          # Initialize the ChannelInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] service_sid The unique SID identifier of the Service.
+          # @param [String] sid A 34 character string that uniquely identifies this Channel.
+          # @return [ChannelInstance] ChannelInstance
+          def initialize(version, payload, service_sid: nil, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'service_sid' => payload['service_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'unique_name' => payload['unique_name'],
+                'attributes' => payload['attributes'],
+                'type' => payload['type'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'created_by' => payload['created_by'],
+                'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i,
+                'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i,
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {
+                'service_sid' => service_sid || @properties['service_sid'],
+                'sid' => sid || @properties['sid'],
+            }
+          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 [ChannelContext] ChannelContext for this ChannelInstance
+          def context
+            unless @instance_context
+              @instance_context = ChannelContext.new(@version, @params['service_sid'], @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The SID of the Service that the resource is associated with
+          def service_sid
+            @properties['service_sid']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the resource
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] An application-defined string that uniquely identifies the resource
+          def unique_name
+            @properties['unique_name']
+          end
+
+          ##
+          # @return [String] The JSON string that stores application-specific data
+          def attributes
+            @properties['attributes']
+          end
+
+          ##
+          # @return [channel.ChannelType] The visibility of the channel. Can be: `public` or `private`
+          def type
+            @properties['type']
+          end
+
+          ##
+          # @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 ISO 8601 date and time in GMT when the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The identity of the User that created the channel
+          def created_by
+            @properties['created_by']
+          end
+
+          ##
+          # @return [String] The number of Members in the Channel
+          def members_count
+            @properties['members_count']
+          end
+
+          ##
+          # @return [String] The number of Messages that have been passed in the Channel
+          def messages_count
+            @properties['messages_count']
+          end
+
+          ##
+          # @return [String] The unique ID of the Messaging Service this channel belongs to.
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [String] The absolute URL of the Channel resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the ChannelInstance
+          # @param [channel.ChannelType] type TThe Type for this Channel to migrate to. Can
+          #   only be `private`. Migration to 'public' is not allowed.
+          # @param [String] messaging_service_sid The unique ID of the {Messaging
+          #   Service}[https://www.twilio.com/docs/sms/services/api] this channel belongs to.
+          # @param [channel.WebhookEnabledType] x_twilio_webhook_enabled The
+          #   X-Twilio-Webhook-Enabled HTTP request header
+          # @return [ChannelInstance] Updated ChannelInstance
+          def update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset)
+            context.update(
+                type: type,
+                messaging_service_sid: messaging_service_sid,
+                x_twilio_webhook_enabled: x_twilio_webhook_enabled,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Chat.V3.ChannelInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Chat.V3.ChannelInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/chat/v3.rb

@@ -0,0 +1,48 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Chat
+      class V3 < Version
+        ##
+        # Initialize the V3 version of Chat
+        def initialize(domain)
+          super
+          @version = 'v3'
+          @channels = nil
+        end
+
+        ##
+        # @param [String] service_sid The unique SID identifier of the Service.
+        # @param [String] sid A 34 character string that uniquely identifies this Channel.
+        # @return [Twilio::REST::Chat::V3::ChannelContext] if sid was passed.
+        # @return [Twilio::REST::Chat::V3::ChannelList]
+        def channels(service_sid=:unset, sid=:unset)
+          if service_sid.nil?
+              raise ArgumentError, 'service_sid cannot be nil'
+          end
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if service_sid == :unset && sid == :unset
+              @channels ||= ChannelList.new self
+          else
+              ChannelContext.new(self, service_sid, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Chat::V3>'
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,7 @@ module Twilio
         # Versions
         @v1 = nil
         @v2 = nil
+        @v3 = nil
       end
 
       ##
@@ -35,6 +36,12 @@ module Twilio
         @v2 ||= V2.new self
       end
 
+      ##
+      # Version v3 of chat
+      def v3
+        @v3 ||= V3.new self
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Credential
       #   resource.
@@ -53,6 +60,15 @@ module Twilio
         self.v2.services(sid)
       end
 
+      ##
+      # @param [String] sid The unique string that we created to identify the Channel
+      #   resource.
+      # @return [Twilio::REST::Chat::V3::ChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Chat::V3::ChannelList]
+      def channels(service_sid=:unset, sid=:unset)
+        self.v3.channels(service_sid, sid)
+      end
+
       ##
       # Provide a user friendly representation
       def to_s