twilio-ruby 5.22.3 → 5.23.0

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

@@ -0,0 +1,169 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class TrustedComms < 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 PhoneCallList < ListResource
+          ##
+          # Initialize the PhoneCallList
+          # @param [Version] version Version that contains the resource
+          # @return [PhoneCallList] PhoneCallList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Business/PhoneCalls"
+          end
+
+          ##
+          # Retrieve a single page of PhoneCallInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] from The originating Phone Number that belongs to the Account,
+          #   given in E.164 format (https://en.wikipedia.org/wiki/E.164).
+          # @param [String] to The terminating Phone Number, given in E.164 format
+          #   (https://en.wikipedia.org/wiki/E.164).
+          # @param [String] url The Twiml URL to manage this phone call.
+          # @param [String] reason The business reason for this phone call that will appear
+          #   in the terminating device's screen.
+          # @return [PhoneCallInstance] Newly created PhoneCallInstance
+          def create(from: nil, to: nil, url: nil, reason: :unset)
+            data = Twilio::Values.of({'From' => from, 'To' => to, 'Url' => url, 'Reason' => reason, })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            PhoneCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.PhoneCallList>'
+          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 PhoneCallPage < Page
+          ##
+          # Initialize the PhoneCallPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [PhoneCallPage] PhoneCallPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of PhoneCallInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [PhoneCallInstance] PhoneCallInstance
+          def get_instance(payload)
+            PhoneCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.PhoneCallPage>'
+          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 PhoneCallInstance < InstanceResource
+          ##
+          # Initialize the PhoneCallInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [PhoneCallInstance] PhoneCallInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'from' => payload['from'],
+                'to' => payload['to'],
+                'reason' => payload['reason'],
+                'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                'url' => payload['url'],
+            }
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Current Call.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Account Sid.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The originating Phone Number
+          def from
+            @properties['from']
+          end
+
+          ##
+          # @return [String] The terminating Phone Number
+          def to
+            @properties['to']
+          end
+
+          ##
+          # @return [String] The business reason for this phone call
+          def reason
+            @properties['reason']
+          end
+
+          ##
+          # @return [Time] The date this Current Call was created
+          def created_at
+            @properties['created_at']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Preview.TrustedComms.PhoneCallInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Preview.TrustedComms.PhoneCallInstance>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,8 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The unique SID identifier of this Service.
+        # @param [String] sid Identifier of the Serverless Service Instance. Either a SID
+        #   or UniqueName.
         # @return [Twilio::REST::Serverless::V1::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Serverless::V1::ServiceList]
         def services(sid=:unset)

data/lib/twilio-ruby/rest/serverless/v1/service.rb

@@ -178,7 +178,8 @@ module Twilio
           ##
           # Initialize the ServiceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The unique SID identifier of this Service.
+          # @param [String] sid Identifier of the Serverless Service Instance. Either a SID
+          #   or UniqueName.
           # @return [ServiceContext] ServiceContext
           def initialize(version, sid)
             super(version)
@@ -325,7 +326,8 @@ module Twilio
           # Initialize the ServiceInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The unique SID identifier of this Service.
+          # @param [String] sid Identifier of the Serverless Service Instance. Either a SID
+          #   or UniqueName.
           # @return [ServiceInstance] ServiceInstance
           def initialize(version, payload, sid: nil)
             super(version)

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_channel.rb

@@ -114,9 +114,15 @@ module Twilio
             # @param [String] friendly_name String representing user-friendly name for the
             #   TaskChannel
             # @param [String] unique_name String representing unique name for the TaskChannel
+            # @param [Boolean] channel_optimized_routing A boolean that if true; mean that the
+            #   channel will prioritize workers that have been idle
             # @return [TaskChannelInstance] Newly created TaskChannelInstance
-            def create(friendly_name: nil, unique_name: nil)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'UniqueName' => unique_name, })
+            def create(friendly_name: nil, unique_name: nil, channel_optimized_routing: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'UniqueName' => unique_name,
+                  'ChannelOptimizedRouting' => channel_optimized_routing,
+              })
 
               payload = @version.create(
                   'POST',
@@ -167,8 +173,9 @@ module Twilio
             ##
             # Initialize the TaskChannelContext
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
-            # @param [String] sid The sid
+            # @param [String] workspace_sid The unique ID of the Workspace that this
+            #   TaskChannel belongs to.
+            # @param [String] sid The unique ID for this TaskChannel.
             # @return [TaskChannelContext] TaskChannelContext
             def initialize(version, workspace_sid, sid)
               super(version)
@@ -201,9 +208,14 @@ module Twilio
             ##
             # Update the TaskChannelInstance
             # @param [String] friendly_name Toggle the FriendlyName for the TaskChannel
+            # @param [Boolean] channel_optimized_routing A boolean that if true; mean that the
+            #   channel will prioritize workers that have been idle
             # @return [TaskChannelInstance] Updated TaskChannelInstance
-            def update(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+            def update(friendly_name: :unset, channel_optimized_routing: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'ChannelOptimizedRouting' => channel_optimized_routing,
+              })
 
               payload = @version.update(
                   'POST',
@@ -248,7 +260,7 @@ module Twilio
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] workspace_sid The unique ID of the Workspace that this
             #   TaskChannel belongs to.
-            # @param [String] sid The sid
+            # @param [String] sid The unique ID for this TaskChannel.
             # @return [TaskChannelInstance] TaskChannelInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -262,6 +274,7 @@ module Twilio
                   'sid' => payload['sid'],
                   'unique_name' => payload['unique_name'],
                   'workspace_sid' => payload['workspace_sid'],
+                  'channel_optimized_routing' => payload['channel_optimized_routing'],
                   'url' => payload['url'],
                   'links' => payload['links'],
               }
@@ -324,6 +337,12 @@ module Twilio
               @properties['workspace_sid']
             end
 
+            ##
+            # @return [Boolean] If true then prioritize longest idle workers
+            def channel_optimized_routing
+              @properties['channel_optimized_routing']
+            end
+
             ##
             # @return [String] The url
             def url
@@ -346,9 +365,11 @@ module Twilio
             ##
             # Update the TaskChannelInstance
             # @param [String] friendly_name Toggle the FriendlyName for the TaskChannel
+            # @param [Boolean] channel_optimized_routing A boolean that if true; mean that the
+            #   channel will prioritize workers that have been idle
             # @return [TaskChannelInstance] Updated TaskChannelInstance
-            def update(friendly_name: :unset)
-              context.update(friendly_name: friendly_name, )
+            def update(friendly_name: :unset, channel_optimized_routing: :unset)
+              context.update(friendly_name: friendly_name, channel_optimized_routing: channel_optimized_routing, )
             end
 
             ##

data/lib/twilio-ruby/rest/verify/v2/service/verification.rb

@@ -40,7 +40,7 @@ module Twilio
             #   for example, to dial an extension. For more information, see the Programmable
             #   Voice documentation of
             #   [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
-            # @param [String] locale The local to use for the verification SMS or call. Can
+            # @param [String] locale The locale to use for the verification SMS or call. Can
             #   be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `es`, `fi`, `fr`, `he`,
             #   `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`, `pr-BR`,
             #   `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`

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

@@ -198,8 +198,10 @@ module Twilio
             ##
             # Initialize the ParticipantContext
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
-            # @param [String] sid The sid
+            # @param [String] room_sid A system-generated 34-character string that uniquely
+            #   identifies a Room.
+            # @param [String] sid A system-generated 34-character string that uniquely
+            #   identifies this Participant.
             # @return [ParticipantContext] ParticipantContext
             def initialize(version, room_sid, sid)
               super(version)
@@ -211,6 +213,7 @@ module Twilio
               # Dependents
               @published_tracks = nil
               @subscribed_tracks = nil
+              @subscribe_rules = nil
             end
 
             ##
@@ -269,19 +272,41 @@ module Twilio
             ##
             # Access the subscribed_tracks
             # @return [SubscribedTrackList]
-            # @return [SubscribedTrackContext]
-            def subscribed_tracks
+            # @return [SubscribedTrackContext] if sid was passed.
+            def subscribed_tracks(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return SubscribedTrackContext.new(@version, @solution[:room_sid], @solution[:sid], sid, )
+              end
+
               unless @subscribed_tracks
                 @subscribed_tracks = SubscribedTrackList.new(
                     @version,
                     room_sid: @solution[:room_sid],
-                    subscriber_sid: @solution[:sid],
+                    participant_sid: @solution[:sid],
                 )
               end
 
               @subscribed_tracks
             end
 
+            ##
+            # Access the subscribe_rules
+            # @return [SubscribeRulesList]
+            # @return [SubscribeRulesContext]
+            def subscribe_rules
+              unless @subscribe_rules
+                @subscribe_rules = SubscribeRulesList.new(
+                    @version,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:sid],
+                )
+              end
+
+              @subscribe_rules
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -304,7 +329,8 @@ module Twilio
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] room_sid A system-generated 34-character string that uniquely
             #   identifies. this room
-            # @param [String] sid The sid
+            # @param [String] sid A system-generated 34-character string that uniquely
+            #   identifies this Participant.
             # @return [ParticipantInstance] ParticipantInstance
             def initialize(version, payload, room_sid: nil, sid: nil)
               super(version)
@@ -442,6 +468,13 @@ module Twilio
               context.subscribed_tracks
             end
 
+            ##
+            # Access the subscribe_rules
+            # @return [subscribe_rules] subscribe_rules
+            def subscribe_rules
+              context.subscribe_rules
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/video/v1/room/room_participant/room_participant_subscribe_rule.rb

@@ -0,0 +1,191 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Video < Domain
+      class V1 < Version
+        class RoomContext < InstanceContext
+          class ParticipantContext < InstanceContext
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class SubscribeRulesList < ListResource
+              ##
+              # Initialize the SubscribeRulesList
+              # @param [Version] version Version that contains the resource
+              # @param [String] room_sid The unique Room identifier for the Subscribe Rules
+              # @param [String] participant_sid The unique Participant identifier for the
+              #   Subscribe Rules.
+              # @return [SubscribeRulesList] SubscribeRulesList
+              def initialize(version, room_sid: nil, participant_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {room_sid: room_sid, participant_sid: participant_sid}
+                @uri = "/Rooms/#{@solution[:room_sid]}/Participants/#{@solution[:participant_sid]}/SubscribeRules"
+              end
+
+              ##
+              # Fetch a SubscribeRulesInstance
+              # @return [SubscribeRulesInstance] Fetched SubscribeRulesInstance
+              def fetch
+                params = Twilio::Values.of({})
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                SubscribeRulesInstance.new(
+                    @version,
+                    payload,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:participant_sid],
+                )
+              end
+
+              ##
+              # Update the SubscribeRulesInstance
+              # @param [Hash] rules A JSON-encoded array of Subscribe Rules. See the [Subscribe
+              #   Rule
+              #   format](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr)
+              #   section for further information.
+              # @return [SubscribeRulesInstance] Updated SubscribeRulesInstance
+              def update(rules: :unset)
+                data = Twilio::Values.of({'Rules' => Twilio.serialize_object(rules), })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                SubscribeRulesInstance.new(
+                    @version,
+                    payload,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:participant_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Video.V1.SubscribeRulesList>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class SubscribeRulesPage < Page
+              ##
+              # Initialize the SubscribeRulesPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [SubscribeRulesPage] SubscribeRulesPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of SubscribeRulesInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [SubscribeRulesInstance] SubscribeRulesInstance
+              def get_instance(payload)
+                SubscribeRulesInstance.new(
+                    @version,
+                    payload,
+                    room_sid: @solution[:room_sid],
+                    participant_sid: @solution[:participant_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Video.V1.SubscribeRulesPage>'
+              end
+            end
+
+            ##
+            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+            class SubscribeRulesInstance < InstanceResource
+              ##
+              # Initialize the SubscribeRulesInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] room_sid The unique Room identifier for the Subscribe Rules
+              # @param [String] participant_sid The unique Participant identifier for the
+              #   Subscribe Rules.
+              # @return [SubscribeRulesInstance] SubscribeRulesInstance
+              def initialize(version, payload, room_sid: nil, participant_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'participant_sid' => payload['participant_sid'],
+                    'room_sid' => payload['room_sid'],
+                    'rules' => payload['rules'],
+                    'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                    'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                }
+              end
+
+              ##
+              # @return [String] The unique Participant identifier for the Subscribe Rules.
+              def participant_sid
+                @properties['participant_sid']
+              end
+
+              ##
+              # @return [String] The unique Room identifier for the Subscribe Rules
+              def room_sid
+                @properties['room_sid']
+              end
+
+              ##
+              # @return [Hash] A collection of Subscribe Rules to include or exclude matching Tracks.
+              def rules
+                @properties['rules']
+              end
+
+              ##
+              # @return [Time] The date that this resource was created.
+              def date_created
+                @properties['date_created']
+              end
+
+              ##
+              # @return [Time] The date that this resource was last updated.
+              def date_updated
+                @properties['date_updated']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Video.V1.SubscribeRulesInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Video.V1.SubscribeRulesInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end