twilio-ruby 5.19.0 → 5.74.2

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -24,18 +24,13 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of ServiceInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] friendly_name Human-readable name for this service instance
-          # @return [ServiceInstance] Newly created ServiceInstance
+          # Create the ServiceInstance
+          # @param [String] friendly_name The friendly_name
+          # @return [ServiceInstance] Created ServiceInstance
           def create(friendly_name: nil)
             data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, )
           end
@@ -101,11 +96,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             ServicePage.new(@version, response, @solution)
           end
 
@@ -179,43 +172,31 @@ module Twilio
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
           # Update the ServiceInstance
-          # @param [String] friendly_name Human-readable name for this service instance
+          # @param [String] friendly_name The friendly_name
           # @param [String] default_service_role_sid The default_service_role_sid
-          # @param [String] default_channel_role_sid Channel role assigned on channel join
-          #   (see [Roles](https://www.twilio.com/docs/chat/api/roles) data model for the
-          #   details)
-          # @param [String] default_channel_creator_role_sid Channel role assigned to
-          #   creator of channel when joining for first time
-          # @param [Boolean] read_status_enabled `true` if the member read status feature is
-          #   enabled, `false` if not.  Defaults to `true`.
-          # @param [Boolean] reachability_enabled `true` if the reachability feature should
-          #   be enabled.  Defaults to `false`
-          # @param [String] typing_indicator_timeout The duration in seconds indicating the
-          #   timeout after "started typing" event when client should assume that user is not
-          #   typing anymore even if no "ended typing" message received
+          # @param [String] default_channel_role_sid The default_channel_role_sid
+          # @param [String] default_channel_creator_role_sid The
+          #   default_channel_creator_role_sid
+          # @param [Boolean] read_status_enabled The read_status_enabled
+          # @param [Boolean] reachability_enabled The reachability_enabled
+          # @param [String] typing_indicator_timeout The typing_indicator_timeout
           # @param [String] consumption_report_interval The consumption_report_interval
           # @param [Boolean] notifications_new_message_enabled The
           #   notifications.new_message.enabled
@@ -243,29 +224,15 @@ module Twilio
           #   notifications.invited_to_channel.template
           # @param [String] notifications_invited_to_channel_sound The
           #   notifications.invited_to_channel.sound
-          # @param [String] pre_webhook_url The webhook URL for PRE-Event webhooks. See
-          #   [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
-          #   details.
-          # @param [String] post_webhook_url The webhook URL for POST-Event webhooks. See
-          #   [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
-          #   details.
-          # @param [String] webhook_method The webhook request format to use.  Must be POST
-          #   or GET. 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.
-          # @param [String] limits_channel_members The maximum number of Members that can be
-          #   added to Channels within this Service.  The maximum allowed value is 1,000
-          # @param [String] limits_user_channels The maximum number of Channels Users can be
-          #   a Member of within this Service.  The maximum value allowed is 1,000
+          # @param [String] pre_webhook_url The pre_webhook_url
+          # @param [String] post_webhook_url The post_webhook_url
+          # @param [String] webhook_method The webhook_method
+          # @param [Array[String]] webhook_filters The webhook_filters
+          # @param [String] limits_channel_members The limits.channel_members
+          # @param [String] limits_user_channels The limits.user_channels
           # @param [String] media_compatibility_message The media.compatibility_message
-          # @param [String] pre_webhook_retry_count Count of times webhook will be retried
-          #   in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
-          #   count is 0 times.
-          # @param [String] post_webhook_retry_count Count of times webhook will be retried
-          #   in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
-          #   count is 0 times.
+          # @param [String] pre_webhook_retry_count The pre_webhook_retry_count
+          # @param [String] post_webhook_retry_count The post_webhook_retry_count
           # @param [Boolean] notifications_log_enabled The notifications.log_enabled
           # @return [ServiceInstance] Updated ServiceInstance
           def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset)
@@ -303,11 +270,7 @@ module Twilio
                 'Notifications.LogEnabled' => notifications_log_enabled,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
@@ -390,6 +353,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.IpMessaging.V2.ServiceContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.IpMessaging.V2.ServiceContext #{context}>"
+          end
         end
 
         class ServiceInstance < InstanceResource
@@ -414,15 +384,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'],
@@ -446,121 +416,121 @@ module Twilio
           end
 
           ##
-          # @return [String] A 34 character string that uniquely identifies this resource.
+          # @return [String] The sid
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The unique id of the Account responsible for this service.
+          # @return [String] The account_sid
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The human-readable name of this service.
+          # @return [String] The friendly_name
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [Time] The date that this resource was created
+          # @return [Time] The date_created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date that this resource was last updated
+          # @return [Time] The date_updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The service role assigned to users when they are added to the service.
+          # @return [String] The default_service_role_sid
           def default_service_role_sid
             @properties['default_service_role_sid']
           end
 
           ##
-          # @return [String] The channel role assigned to users when they are added to a channel.
+          # @return [String] The default_channel_role_sid
           def default_channel_role_sid
             @properties['default_channel_role_sid']
           end
 
           ##
-          # @return [String] The channel role assigned to a channel creator when joining a new channel.
+          # @return [String] The default_channel_creator_role_sid
           def default_channel_creator_role_sid
             @properties['default_channel_creator_role_sid']
           end
 
           ##
-          # @return [Boolean] Enable the Message Consumption Horizon feature.
+          # @return [Boolean] The read_status_enabled
           def read_status_enabled
             @properties['read_status_enabled']
           end
 
           ##
-          # @return [Boolean] Indicates whether the  the Reachability feature is enabled for this Service instance.
+          # @return [Boolean] The reachability_enabled
           def reachability_enabled
             @properties['reachability_enabled']
           end
 
           ##
-          # @return [String] The amount of time in seconds after a "started typing" event when clients should assume that user is no longer typing, even if no "ended typing" message was received.
+          # @return [String] The typing_indicator_timeout
           def typing_indicator_timeout
             @properties['typing_indicator_timeout']
           end
 
           ##
-          # @return [String] DEPRECATED.
+          # @return [String] The consumption_report_interval
           def consumption_report_interval
             @properties['consumption_report_interval']
           end
 
           ##
-          # @return [Hash] Configuration for service instance level limits.
+          # @return [Hash] The limits
           def limits
             @properties['limits']
           end
 
           ##
-          # @return [String] The webhook URL for PRE-Event webhooks.
+          # @return [String] The pre_webhook_url
           def pre_webhook_url
             @properties['pre_webhook_url']
           end
 
           ##
-          # @return [String] The webhook URL for POST-Event webhooks.
+          # @return [String] The post_webhook_url
           def post_webhook_url
             @properties['post_webhook_url']
           end
 
           ##
-          # @return [String] The webhook request format to use for both PRE and POST webhooks.
+          # @return [String] The webhook_method
           def webhook_method
             @properties['webhook_method']
           end
 
           ##
-          # @return [String] The list of WebHook events that are enabled for this Service instance.
+          # @return [Array[String]] The webhook_filters
           def webhook_filters
             @properties['webhook_filters']
           end
 
           ##
-          # @return [String] Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.
+          # @return [String] The pre_webhook_retry_count
           def pre_webhook_retry_count
             @properties['pre_webhook_retry_count']
           end
 
           ##
-          # @return [String] Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.
+          # @return [String] The post_webhook_retry_count
           def post_webhook_retry_count
             @properties['post_webhook_retry_count']
           end
 
           ##
-          # @return [Hash] Notification configuration for the Service instance.
+          # @return [Hash] The notifications
           def notifications
             @properties['notifications']
           end
@@ -572,47 +542,41 @@ module Twilio
           end
 
           ##
-          # @return [String] An absolute URL for this service.
+          # @return [String] The url
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] URLs to access the Channels, Roles, and Users for this service.
+          # @return [String] The links
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a ServiceInstance
+          # Fetch the ServiceInstance
           # @return [ServiceInstance] Fetched ServiceInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
 
           ##
           # Update the ServiceInstance
-          # @param [String] friendly_name Human-readable name for this service instance
+          # @param [String] friendly_name The friendly_name
           # @param [String] default_service_role_sid The default_service_role_sid
-          # @param [String] default_channel_role_sid Channel role assigned on channel join
-          #   (see [Roles](https://www.twilio.com/docs/chat/api/roles) data model for the
-          #   details)
-          # @param [String] default_channel_creator_role_sid Channel role assigned to
-          #   creator of channel when joining for first time
-          # @param [Boolean] read_status_enabled `true` if the member read status feature is
-          #   enabled, `false` if not.  Defaults to `true`.
-          # @param [Boolean] reachability_enabled `true` if the reachability feature should
-          #   be enabled.  Defaults to `false`
-          # @param [String] typing_indicator_timeout The duration in seconds indicating the
-          #   timeout after "started typing" event when client should assume that user is not
-          #   typing anymore even if no "ended typing" message received
+          # @param [String] default_channel_role_sid The default_channel_role_sid
+          # @param [String] default_channel_creator_role_sid The
+          #   default_channel_creator_role_sid
+          # @param [Boolean] read_status_enabled The read_status_enabled
+          # @param [Boolean] reachability_enabled The reachability_enabled
+          # @param [String] typing_indicator_timeout The typing_indicator_timeout
           # @param [String] consumption_report_interval The consumption_report_interval
           # @param [Boolean] notifications_new_message_enabled The
           #   notifications.new_message.enabled
@@ -640,29 +604,15 @@ module Twilio
           #   notifications.invited_to_channel.template
           # @param [String] notifications_invited_to_channel_sound The
           #   notifications.invited_to_channel.sound
-          # @param [String] pre_webhook_url The webhook URL for PRE-Event webhooks. See
-          #   [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
-          #   details.
-          # @param [String] post_webhook_url The webhook URL for POST-Event webhooks. See
-          #   [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more
-          #   details.
-          # @param [String] webhook_method The webhook request format to use.  Must be POST
-          #   or GET. 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.
-          # @param [String] limits_channel_members The maximum number of Members that can be
-          #   added to Channels within this Service.  The maximum allowed value is 1,000
-          # @param [String] limits_user_channels The maximum number of Channels Users can be
-          #   a Member of within this Service.  The maximum value allowed is 1,000
+          # @param [String] pre_webhook_url The pre_webhook_url
+          # @param [String] post_webhook_url The post_webhook_url
+          # @param [String] webhook_method The webhook_method
+          # @param [Array[String]] webhook_filters The webhook_filters
+          # @param [String] limits_channel_members The limits.channel_members
+          # @param [String] limits_user_channels The limits.user_channels
           # @param [String] media_compatibility_message The media.compatibility_message
-          # @param [String] pre_webhook_retry_count Count of times webhook will be retried
-          #   in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
-          #   count is 0 times.
-          # @param [String] post_webhook_retry_count Count of times webhook will be retried
-          #   in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry
-          #   count is 0 times.
+          # @param [String] pre_webhook_retry_count The pre_webhook_retry_count
+          # @param [String] post_webhook_retry_count The post_webhook_retry_count
           # @param [Boolean] notifications_log_enabled The notifications.log_enabled
           # @return [ServiceInstance] Updated ServiceInstance
           def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset)

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -21,29 +21,31 @@ module Twilio
 
         ##
         # @param [String] sid The sid
-        # @return [Twilio::REST::Chat::V2::CredentialContext] if sid was passed.
-        # @return [Twilio::REST::Chat::V2::CredentialList]
+        # @return [Twilio::REST::Ip_messaging::V2::CredentialContext] if sid was passed.
+        # @return [Twilio::REST::Ip_messaging::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
 
         ##
         # @param [String] sid The sid
-        # @return [Twilio::REST::Chat::V2::ServiceContext] if sid was passed.
-        # @return [Twilio::REST::Chat::V2::ServiceList]
+        # @return [Twilio::REST::Ip_messaging::V2::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Ip_messaging::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/ip_messaging.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -36,19 +36,17 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
-      # @return [Twilio::REST::Chat::V2::CredentialInstance] if sid was passed.
-      # @return [Twilio::REST::Chat::V2::CredentialList]
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Ip_messaging::V2::CredentialInstance] if sid was passed.
+      # @return [Twilio::REST::Ip_messaging::V2::CredentialList]
       def credentials(sid=:unset)
         self.v2.credentials(sid)
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
-      # @return [Twilio::REST::Chat::V2::ServiceInstance] if sid was passed.
-      # @return [Twilio::REST::Chat::V2::ServiceList]
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Ip_messaging::V2::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Ip_messaging::V2::ServiceList]
       def services(sid=:unset)
         self.v2.services(sid)
       end