twilio-ruby 5.22.3 → 5.23.0

data/lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb

@@ -16,8 +16,10 @@ module Twilio
               ##
               # Initialize the UserChannelList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid A 34 character string that uniquely identifies this
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] user_sid The unique string that we created to identify the User
               #   resource.
               # @return [UserChannelList] UserChannelList
               def initialize(version, service_sid: nil, user_sid: nil)
@@ -156,8 +158,10 @@ module Twilio
               # Initialize the UserChannelInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The service_sid
-              # @param [String] user_sid A 34 character string that uniquely identifies this
+              # @param [String] service_sid The SID of the
+              #   [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is
+              #   associated with.
+              # @param [String] user_sid The unique string that we created to identify the User
               #   resource.
               # @return [UserChannelInstance] UserChannelInstance
               def initialize(version, payload, service_sid: nil, user_sid: nil)
@@ -177,49 +181,49 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The service_sid
+              # @return [String] The SID of the Service that the resource is associated with
               def service_sid
                 @properties['service_sid']
               end
 
               ##
-              # @return [String] The channel_sid
+              # @return [String] The SID of the Channel the resource belongs to
               def channel_sid
                 @properties['channel_sid']
               end
 
               ##
-              # @return [String] The member_sid
+              # @return [String] The SID of the User as a Member in the Channel
               def member_sid
                 @properties['member_sid']
               end
 
               ##
-              # @return [user_channel.ChannelStatus] The status
+              # @return [user_channel.ChannelStatus] The status of the User on the Channel
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The last_consumed_message_index
+              # @return [String] The index of the last Message in the Channel the Member has read
               def last_consumed_message_index
                 @properties['last_consumed_message_index']
               end
 
               ##
-              # @return [String] The unread_messages_count
+              # @return [String] The number of unread Messages in the Channel for the User
               def unread_messages_count
                 @properties['unread_messages_count']
               end
 
               ##
-              # @return [String] The links
+              # @return [String] Absolute URLs to access the Members, Messages , Invites and, if it exists, the last Message for the Channel
               def links
                 @properties['links']
               end

data/lib/twilio-ruby/rest/notify/v1/service/notification.rb

@@ -34,7 +34,7 @@ module Twilio
             # Request is executed immediately.
             # @param [String] body The notification text. For FCM and GCM, translates to
             #   `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates
-            #   to `body`. SMS requires either this `body` value, or a `media_url` attribute
+            #   to `body`. SMS requires either this `body` value, or `media_urls` attribute
             #   defined in the `sms` parameter of the notification.
             # @param [notification.Priority] priority The priority of the notification. Can
             #   be: `low` or `high` and the default is `high`. A value of `low` optimizes the

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

@@ -27,6 +27,7 @@ module Twilio
         @sync = nil
         @understand = nil
         @wireless = nil
+        @trusted_comms = nil
       end
 
       ##
@@ -77,6 +78,12 @@ module Twilio
         @wireless ||= Wireless.new self
       end
 
+      ##
+      # Version trusted_comms of preview
+      def trusted_comms
+        @trusted_comms ||= TrustedComms.new self
+      end
+
       ##
       # @param [String] resource_type The resource_type
       # @return [Twilio::REST::Preview::BulkExports::ExportInstance] if resource_type was passed.
@@ -179,6 +186,24 @@ module Twilio
         self.wireless.sims(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Preview::TrustedComms::DeviceInstance]
+      def devices
+        self.trusted_comms.devices()
+      end
+
+      ##
+      # @return [Twilio::REST::Preview::TrustedComms::PhoneCallInstance]
+      def phone_calls
+        self.trusted_comms.phone_calls()
+      end
+
+      ##
+      # @return [Twilio::REST::Preview::TrustedComms::CurrentCallInstance]
+      def current_calls
+        self.trusted_comms.current_calls()
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -0,0 +1,49 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview
+      class TrustedComms < Version
+        ##
+        # Initialize the TrustedComms version of Preview
+        def initialize(domain)
+          super
+          @version = 'TrustedComms'
+          @devices = nil
+          @phone_calls = nil
+          @current_calls = nil
+        end
+
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::DeviceContext]
+        def devices
+          @devices ||= DeviceList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::PhoneCallContext]
+        def phone_calls
+          @phone_calls ||= PhoneCallList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::CurrentCallContext]
+        def current_calls
+          @current_calls ||= CurrentCallContext.new self
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Preview::TrustedComms>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,217 @@
+##
+# 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 CurrentCallList < ListResource
+          ##
+          # Initialize the CurrentCallList
+          # @param [Version] version Version that contains the resource
+          # @return [CurrentCallList] CurrentCallList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.CurrentCallList>'
+          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 CurrentCallPage < Page
+          ##
+          # Initialize the CurrentCallPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [CurrentCallPage] CurrentCallPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of CurrentCallInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [CurrentCallInstance] CurrentCallInstance
+          def get_instance(payload)
+            CurrentCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.CurrentCallPage>'
+          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 CurrentCallContext < InstanceContext
+          ##
+          # Initialize the CurrentCallContext
+          # @param [Version] version Version that contains the resource
+          # @return [CurrentCallContext] CurrentCallContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/CurrentCall"
+          end
+
+          ##
+          # Fetch a CurrentCallInstance
+          # @param [String] from The originating Phone Number, given in E.164 format
+          #   (https://en.wikipedia.org/wiki/E.164). This phone number should be a Twilio
+          #   number, otherwise it will return an error with HTTP Status Code 400.
+          # @param [String] to The terminating Phone Number, given in E.164 format
+          #   (https://en.wikipedia.org/wiki/E.164).
+          # @return [CurrentCallInstance] Fetched CurrentCallInstance
+          def fetch(from: :unset, to: :unset)
+            params = Twilio::Values.of({'From' => from, 'To' => to, })
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            CurrentCallInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.CurrentCallContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.TrustedComms.CurrentCallContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+        class CurrentCallInstance < InstanceResource
+          ##
+          # Initialize the CurrentCallInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [CurrentCallInstance] CurrentCallInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'from' => payload['from'],
+                'to' => payload['to'],
+                'reason' => payload['reason'],
+                'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [CurrentCallContext] CurrentCallContext for this CurrentCallInstance
+          def context
+            unless @instance_context
+              @instance_context = CurrentCallContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Current Call.
+          def sid
+            @properties['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
+
+          ##
+          # Fetch a CurrentCallInstance
+          # @param [String] from The originating Phone Number, given in E.164 format
+          #   (https://en.wikipedia.org/wiki/E.164). This phone number should be a Twilio
+          #   number, otherwise it will return an error with HTTP Status Code 400.
+          # @param [String] to The terminating Phone Number, given in E.164 format
+          #   (https://en.wikipedia.org/wiki/E.164).
+          # @return [CurrentCallInstance] Fetched CurrentCallInstance
+          def fetch(from: :unset, to: :unset)
+            context.fetch(from: from, to: to, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.CurrentCallInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.CurrentCallInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+##
+# 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 DeviceList < ListResource
+          ##
+          # Initialize the DeviceList
+          # @param [Version] version Version that contains the resource
+          # @return [DeviceList] DeviceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Devices"
+          end
+
+          ##
+          # Retrieve a single page of DeviceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] phone_number The end user Phone Number linked to the device,
+          #   given in E.164 format (https://en.wikipedia.org/wiki/E.164). The SDK or partner
+          #   app is responsible of verifying this phone number veracity.
+          # @param [String] push_token The Push Token for this Phone Number, linked to the
+          #   correct SDK's application, certificate and keys.
+          # @return [DeviceInstance] Newly created DeviceInstance
+          def create(phone_number: nil, push_token: nil)
+            data = Twilio::Values.of({'PhoneNumber' => phone_number, 'PushToken' => push_token, })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            DeviceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Preview.TrustedComms.DeviceList>'
+          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 DevicePage < Page
+          ##
+          # Initialize the DevicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DevicePage] DevicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DeviceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DeviceInstance] DeviceInstance
+          def get_instance(payload)
+            DeviceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Preview.TrustedComms.DevicePage>'
+          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 DeviceInstance < InstanceResource
+          ##
+          # Initialize the DeviceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [DeviceInstance] DeviceInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'phone_number' => payload['phone_number'],
+                'binding_sid' => payload['binding_sid'],
+                'url' => payload['url'],
+            }
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Device.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The end user Phone Number
+          def phone_number
+            @properties['phone_number']
+          end
+
+          ##
+          # @return [String] Binding Sid.
+          def binding_sid
+            @properties['binding_sid']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Preview.TrustedComms.DeviceInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Preview.TrustedComms.DeviceInstance>"
+          end
+        end
+      end
+    end
+  end
+end