twilio-ruby 5.46.1 → 5.51.0

data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb

@@ -12,7 +12,7 @@ module Twilio
       class V1 < Version
         class SubscriptionContext < InstanceContext
           ##
-          # 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.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SubscribedEventList < ListResource
             ##
             # Initialize the SubscribedEventList
@@ -107,6 +107,19 @@ module Twilio
               SubscribedEventPage.new(@version, response, @solution)
             end
 
+            ##
+            # Create the SubscribedEventInstance
+            # @param [String] type Type of event being subscribed to.
+            # @param [String] version The schema version that the subscription should use.
+            # @return [SubscribedEventInstance] Created SubscribedEventInstance
+            def create(type: nil, version: :unset)
+              data = Twilio::Values.of({'Type' => type, 'Version' => version, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -115,7 +128,7 @@ module Twilio
           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.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SubscribedEventPage < Page
             ##
             # Initialize the SubscribedEventPage
@@ -146,15 +159,86 @@ module Twilio
           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.
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class SubscribedEventContext < InstanceContext
+            ##
+            # Initialize the SubscribedEventContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @param [String] type Type of event being subscribed to.
+            # @return [SubscribedEventContext] SubscribedEventContext
+            def initialize(version, subscription_sid, type)
+              super(version)
+
+              # Path Solution
+              @solution = {subscription_sid: subscription_sid, type: type, }
+              @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents/#{@solution[:type]}"
+            end
+
+            ##
+            # Fetch the SubscribedEventInstance
+            # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              SubscribedEventInstance.new(
+                  @version,
+                  payload,
+                  subscription_sid: @solution[:subscription_sid],
+                  type: @solution[:type],
+              )
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] version The schema version that the subscription should use.
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(version: :unset)
+              data = Twilio::Values.of({'Version' => version, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(
+                  @version,
+                  payload,
+                  subscription_sid: @solution[:subscription_sid],
+                  type: @solution[:type],
+              )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class SubscribedEventInstance < InstanceResource
             ##
             # Initialize the SubscribedEventInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] subscription_sid The unique SID identifier of the Subscription.
+            # @param [String] type Type of event being subscribed to.
             # @return [SubscribedEventInstance] SubscribedEventInstance
-            def initialize(version, payload, subscription_sid: nil)
+            def initialize(version, payload, subscription_sid: nil, type: nil)
               super(version)
 
               # Marshaled Properties
@@ -165,6 +249,25 @@ module Twilio
                   'subscription_sid' => payload['subscription_sid'],
                   'url' => payload['url'],
               }
+
+              # Context
+              @instance_context = nil
+              @params = {'subscription_sid' => subscription_sid, 'type' => type || @properties['type'], }
+            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 [SubscribedEventContext] SubscribedEventContext for this SubscribedEventInstance
+            def context
+              unless @instance_context
+                @instance_context = SubscribedEventContext.new(
+                    @version,
+                    @params['subscription_sid'],
+                    @params['type'],
+                )
+              end
+              @instance_context
             end
 
             ##
@@ -197,16 +300,40 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # Fetch the SubscribedEventInstance
+            # @return [SubscribedEventInstance] Fetched SubscribedEventInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] version The schema version that the subscription should use.
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(version: :unset)
+              context.update(version: version, )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Events.V1.SubscribedEventInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Events.V1.SubscribedEventInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
             end
           end
         end

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

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Fax::V1::FaxList]
         def faxes(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @faxes ||= FaxList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @faxes ||= FaxList.new self
           else
-            FaxContext.new(self, sid)
+              FaxContext.new(self, sid)
           end
         end
 

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

@@ -27,11 +27,12 @@ module Twilio
         # @return [Twilio::REST::Flex_api::V1::ChannelList]
         def channel(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @channel ||= ChannelList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @channel ||= ChannelList.new self
           else
-            ChannelContext.new(self, sid)
+              ChannelContext.new(self, sid)
           end
         end
 
@@ -47,11 +48,12 @@ module Twilio
         # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
         def flex_flow(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @flex_flow ||= FlexFlowList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @flex_flow ||= FlexFlowList.new self
           else
-            FlexFlowContext.new(self, sid)
+              FlexFlowContext.new(self, sid)
           end
         end
 
@@ -61,11 +63,12 @@ module Twilio
         # @return [Twilio::REST::Flex_api::V1::WebChannelList]
         def web_channel(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @web_channel ||= WebChannelList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @web_channel ||= WebChannelList.new self
           else
-            WebChannelContext.new(self, sid)
+              WebChannelContext.new(self, sid)
           end
         end
 

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

@@ -164,6 +164,8 @@ module Twilio
                 'outbound_call_flows' => payload['outbound_call_flows'],
                 'serverless_service_sids' => payload['serverless_service_sids'],
                 'queue_stats_configuration' => payload['queue_stats_configuration'],
+                'notifications' => payload['notifications'],
+                'markdown' => payload['markdown'],
                 'url' => payload['url'],
             }
 
@@ -399,6 +401,18 @@ module Twilio
             @properties['queue_stats_configuration']
           end
 
+          ##
+          # @return [Hash] Configurable parameters for Notifications
+          def notifications
+            @properties['notifications']
+          end
+
+          ##
+          # @return [Hash] Configurable parameters for Markdown
+          def markdown
+            @properties['markdown']
+          end
+
           ##
           # @return [String] The absolute URL of the Configuration resource
           def url

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

@@ -37,7 +37,7 @@ module Twilio
       end
 
       ##
-      # @param [String] room_sid The room_sid
+      # @param [String] room_sid Unique identifier for the room.
       # @return [Twilio::REST::Insights::V1::RoomInstance] if room_sid was passed.
       # @return [Twilio::REST::Insights::V1::RoomList]
       def rooms(room_sid=:unset)

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

@@ -25,25 +25,27 @@ module Twilio
         # @return [Twilio::REST::Insights::V1::CallList]
         def calls(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @calls ||= CallList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @calls ||= CallList.new self
           else
-            CallContext.new(self, sid)
+              CallContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] room_sid The room_sid
+        # @param [String] room_sid The SID of the Room resource.
         # @return [Twilio::REST::Insights::V1::RoomContext] if room_sid was passed.
         # @return [Twilio::REST::Insights::V1::RoomList]
         def rooms(room_sid=:unset)
           if room_sid.nil?
-            raise ArgumentError, 'room_sid cannot be nil'
-          elsif room_sid == :unset
-            @rooms ||= RoomList.new self
+              raise ArgumentError, 'room_sid cannot be nil'
+          end
+          if room_sid == :unset
+              @rooms ||= RoomList.new self
           else
-            RoomContext.new(self, room_sid)
+              RoomContext.new(self, room_sid)
           end
         end
 

data/lib/twilio-ruby/rest/insights/v1/room.rb

@@ -29,11 +29,15 @@ module Twilio
           # Lists RoomInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [Array[room.RoomType]] room_type The room_type
-          # @param [Array[room.Codec]] codec The codec
-          # @param [String] room_name The room_name
-          # @param [Time] created_after The created_after
-          # @param [Time] created_before The created_before
+          # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
+          #   `peer_to_peer`, `group`, or `group_small`.
+          # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
+          #   `VP8`, `H264`, or `VP9`.
+          # @param [String] room_name Room friendly name.
+          # @param [Time] created_after Only read rooms that started on or after this ISO
+          #   8601 timestamp.
+          # @param [Time] created_before Only read rooms that started before this ISO 8601
+          #   timestamp.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit.  Default is no limit
           # @param [Integer] page_size Number of records to fetch per request, when
@@ -57,11 +61,15 @@ module Twilio
           # Streams RoomInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [Array[room.RoomType]] room_type The room_type
-          # @param [Array[room.Codec]] codec The codec
-          # @param [String] room_name The room_name
-          # @param [Time] created_after The created_after
-          # @param [Time] created_before The created_before
+          # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
+          #   `peer_to_peer`, `group`, or `group_small`.
+          # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
+          #   `VP8`, `H264`, or `VP9`.
+          # @param [String] room_name Room friendly name.
+          # @param [Time] created_after Only read rooms that started on or after this ISO
+          #   8601 timestamp.
+          # @param [Time] created_before Only read rooms that started before this ISO 8601
+          #   timestamp.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit. Default is no limit.
           # @param [Integer] page_size Number of records to fetch per request, when
@@ -101,11 +109,15 @@ module Twilio
           ##
           # Retrieve a single page of RoomInstance records from the API.
           # Request is executed immediately.
-          # @param [Array[room.RoomType]] room_type The room_type
-          # @param [Array[room.Codec]] codec The codec
-          # @param [String] room_name The room_name
-          # @param [Time] created_after The created_after
-          # @param [Time] created_before The created_before
+          # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
+          #   `peer_to_peer`, `group`, or `group_small`.
+          # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
+          #   `VP8`, `H264`, or `VP9`.
+          # @param [String] room_name Room friendly name.
+          # @param [Time] created_after Only read rooms that started on or after this ISO
+          #   8601 timestamp.
+          # @param [Time] created_before Only read rooms that started before this ISO 8601
+          #   timestamp.
           # @param [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
           # @param [Integer] page_size Number of records to return, defaults to 50
@@ -184,7 +196,7 @@ module Twilio
           ##
           # Initialize the RoomContext
           # @param [Version] version Version that contains the resource
-          # @param [String] room_sid The room_sid
+          # @param [String] room_sid The SID of the Room resource.
           # @return [RoomContext] RoomContext
           def initialize(version, room_sid)
             super(version)
@@ -246,7 +258,7 @@ module Twilio
           # Initialize the RoomInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] room_sid The room_sid
+          # @param [String] room_sid The SID of the Room resource.
           # @return [RoomInstance] RoomInstance
           def initialize(version, payload, room_sid: nil)
             super(version)
@@ -298,157 +310,157 @@ module Twilio
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] Account SID associated with this room.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The room_sid
+          # @return [String] Unique identifier for the room.
           def room_sid
             @properties['room_sid']
           end
 
           ##
-          # @return [String] The room_name
+          # @return [String] room friendly name.
           def room_name
             @properties['room_name']
           end
 
           ##
-          # @return [Time] The create_time
+          # @return [Time] Creation time of the room.
           def create_time
             @properties['create_time']
           end
 
           ##
-          # @return [Time] The end_time
+          # @return [Time] End time for the room.
           def end_time
             @properties['end_time']
           end
 
           ##
-          # @return [room.RoomType] The room_type
+          # @return [room.RoomType] Type of room.
           def room_type
             @properties['room_type']
           end
 
           ##
-          # @return [room.RoomStatus] The room_status
+          # @return [room.RoomStatus] Status of the room.
           def room_status
             @properties['room_status']
           end
 
           ##
-          # @return [String] The status_callback
+          # @return [String] Webhook provided for status callbacks.
           def status_callback
             @properties['status_callback']
           end
 
           ##
-          # @return [String] The status_callback_method
+          # @return [String] HTTP method provided for status callback URL.
           def status_callback_method
             @properties['status_callback_method']
           end
 
           ##
-          # @return [room.CreatedMethod] The created_method
+          # @return [room.CreatedMethod] How the room was created.
           def created_method
             @properties['created_method']
           end
 
           ##
-          # @return [room.EndReason] The end_reason
+          # @return [room.EndReason] Reason the room ended.
           def end_reason
             @properties['end_reason']
           end
 
           ##
-          # @return [String] The max_participants
+          # @return [String] Max number of total participants allowed by the application settings.
           def max_participants
             @properties['max_participants']
           end
 
           ##
-          # @return [String] The unique_participants
+          # @return [String] Number of participants. May include duplicate identities for participants who left and rejoined.
           def unique_participants
             @properties['unique_participants']
           end
 
           ##
-          # @return [String] The unique_participant_identities
+          # @return [String] Unique number of participant identities.
           def unique_participant_identities
             @properties['unique_participant_identities']
           end
 
           ##
-          # @return [String] The concurrent_participants
+          # @return [String] Actual number of concurrent participants.
           def concurrent_participants
             @properties['concurrent_participants']
           end
 
           ##
-          # @return [String] The max_concurrent_participants
+          # @return [String] Maximum number of participants allowed in the room at the same time allowed by the application settings.
           def max_concurrent_participants
             @properties['max_concurrent_participants']
           end
 
           ##
-          # @return [Array[room.Codec]] The codecs
+          # @return [Array[room.Codec]] Codecs used by participants in the room.
           def codecs
             @properties['codecs']
           end
 
           ##
-          # @return [room.TwilioRealm] The media_region
+          # @return [room.TwilioRealm] Region of Twilio media servers for the room.
           def media_region
             @properties['media_region']
           end
 
           ##
-          # @return [String] The duration_sec
+          # @return [String] Total room duration from create time to end time.
           def duration_sec
             @properties['duration_sec']
           end
 
           ##
-          # @return [String] The total_participant_duration_sec
+          # @return [String] Combined amount of participant time in the room.
           def total_participant_duration_sec
             @properties['total_participant_duration_sec']
           end
 
           ##
-          # @return [String] The total_recording_duration_sec
+          # @return [String] Combined amount of recorded seconds for participants in the room.
           def total_recording_duration_sec
             @properties['total_recording_duration_sec']
           end
 
           ##
-          # @return [room.ProcessingState] The processing_state
+          # @return [room.ProcessingState] Video Log Analyzer resource state. Will be either `in-progress` or `complete`.
           def processing_state
             @properties['processing_state']
           end
 
           ##
-          # @return [Boolean] The recording_enabled
+          # @return [Boolean] Boolean indicating if recording is enabled for the room.
           def recording_enabled
             @properties['recording_enabled']
           end
 
           ##
-          # @return [room.EdgeLocation] The edge_location
+          # @return [room.EdgeLocation] Edge location of Twilio media servers for the room.
           def edge_location
             @properties['edge_location']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] URL for the room resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Room subresources.
           def links
             @properties['links']
           end