twilio-ruby 5.20.0 → 5.47.0

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

@@ -0,0 +1,378 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Insights < Domain
+      class V1 < Version
+        class RoomContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class ParticipantList < ListResource
+            ##
+            # Initialize the ParticipantList
+            # @param [Version] version Version that contains the resource
+            # @param [String] room_sid The room_sid
+            # @return [ParticipantList] ParticipantList
+            def initialize(version, room_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {room_sid: room_sid}
+              @uri = "/Video/Rooms/#{@solution[:room_sid]}/Participants"
+            end
+
+            ##
+            # Lists ParticipantInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @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
+            #    not set will use the default value of 50 records.  If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams ParticipantInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @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
+            #    not set will use the default value of 50 records. If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields ParticipantInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of ParticipantInstance records from the API.
+            # Request is executed immediately.
+            # @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
+            # @return [Page] Page of ParticipantInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              ParticipantPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of ParticipantInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of ParticipantInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              ParticipantPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Insights.V1.ParticipantList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class ParticipantPage < Page
+            ##
+            # Initialize the ParticipantPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [ParticipantPage] ParticipantPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of ParticipantInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [ParticipantInstance] ParticipantInstance
+            def get_instance(payload)
+              ParticipantInstance.new(@version, payload, room_sid: @solution[:room_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Insights.V1.ParticipantPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class ParticipantContext < InstanceContext
+            ##
+            # Initialize the ParticipantContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] room_sid The room_sid
+            # @param [String] participant_sid The participant_sid
+            # @return [ParticipantContext] ParticipantContext
+            def initialize(version, room_sid, participant_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {room_sid: room_sid, participant_sid: participant_sid, }
+              @uri = "/Video/Rooms/#{@solution[:room_sid]}/Participants/#{@solution[:participant_sid]}"
+            end
+
+            ##
+            # Fetch the ParticipantInstance
+            # @return [ParticipantInstance] Fetched ParticipantInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              ParticipantInstance.new(
+                  @version,
+                  payload,
+                  room_sid: @solution[:room_sid],
+                  participant_sid: @solution[:participant_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.ParticipantContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Insights.V1.ParticipantContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class ParticipantInstance < InstanceResource
+            ##
+            # Initialize the ParticipantInstance
+            # @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] participant_sid The participant_sid
+            # @return [ParticipantInstance] ParticipantInstance
+            def initialize(version, payload, room_sid: nil, participant_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'participant_sid' => payload['participant_sid'],
+                  'participant_identity' => payload['participant_identity'],
+                  'join_time' => Twilio.deserialize_iso8601_datetime(payload['join_time']),
+                  'leave_time' => Twilio.deserialize_iso8601_datetime(payload['leave_time']),
+                  'duration_sec' => payload['duration_sec'].to_i,
+                  'account_sid' => payload['account_sid'],
+                  'room_sid' => payload['room_sid'],
+                  'status' => payload['status'],
+                  'codecs' => payload['codecs'],
+                  'end_reason' => payload['end_reason'],
+                  'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
+                  'error_code_url' => payload['error_code_url'],
+                  'media_region' => payload['media_region'],
+                  'properties' => payload['properties'],
+                  'edge_location' => payload['edge_location'],
+                  'publisher_info' => payload['publisher_info'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {
+                  'room_sid' => room_sid,
+                  'participant_sid' => participant_sid || @properties['participant_sid'],
+              }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [ParticipantContext] ParticipantContext for this ParticipantInstance
+            def context
+              unless @instance_context
+                @instance_context = ParticipantContext.new(
+                    @version,
+                    @params['room_sid'],
+                    @params['participant_sid'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The participant_sid
+            def participant_sid
+              @properties['participant_sid']
+            end
+
+            ##
+            # @return [String] The participant_identity
+            def participant_identity
+              @properties['participant_identity']
+            end
+
+            ##
+            # @return [Time] The join_time
+            def join_time
+              @properties['join_time']
+            end
+
+            ##
+            # @return [Time] The leave_time
+            def leave_time
+              @properties['leave_time']
+            end
+
+            ##
+            # @return [String] The duration_sec
+            def duration_sec
+              @properties['duration_sec']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The room_sid
+            def room_sid
+              @properties['room_sid']
+            end
+
+            ##
+            # @return [participant.RoomStatus] The status
+            def status
+              @properties['status']
+            end
+
+            ##
+            # @return [Array[participant.Codec]] The codecs
+            def codecs
+              @properties['codecs']
+            end
+
+            ##
+            # @return [String] The end_reason
+            def end_reason
+              @properties['end_reason']
+            end
+
+            ##
+            # @return [String] The error_code
+            def error_code
+              @properties['error_code']
+            end
+
+            ##
+            # @return [String] The error_code_url
+            def error_code_url
+              @properties['error_code_url']
+            end
+
+            ##
+            # @return [participant.TwilioRealm] The media_region
+            def media_region
+              @properties['media_region']
+            end
+
+            ##
+            # @return [Hash] The properties
+            def properties
+              @properties['properties']
+            end
+
+            ##
+            # @return [participant.EdgeLocation] The edge_location
+            def edge_location
+              @properties['edge_location']
+            end
+
+            ##
+            # @return [Hash] The publisher_info
+            def publisher_info
+              @properties['publisher_info']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the ParticipantInstance
+            # @return [ParticipantInstance] Fetched ParticipantInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.ParticipantInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Insights.V1.ParticipantInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -21,8 +21,8 @@ module Twilio
 
         ##
         # @param [String] sid The sid
-        # @return [Twilio::REST::Chat::V1::CredentialContext] if sid was passed.
-        # @return [Twilio::REST::Chat::V1::CredentialList]
+        # @return [Twilio::REST::Ip_messaging::V1::CredentialContext] if sid was passed.
+        # @return [Twilio::REST::Ip_messaging::V1::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
@@ -35,8 +35,8 @@ module Twilio
 
         ##
         # @param [String] sid The sid
-        # @return [Twilio::REST::Chat::V1::ServiceContext] if sid was passed.
-        # @return [Twilio::REST::Chat::V1::ServiceList]
+        # @return [Twilio::REST::Ip_messaging::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Ip_messaging::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'

data/lib/twilio-ruby/rest/ip_messaging/v1/credential.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -84,11 +84,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             CredentialPage.new(@version, response, @solution)
           end
 
@@ -106,22 +104,15 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CredentialInstance records from the API.
-          # Request is executed immediately.
-          # @param [credential.PushService] type Credential type, one of "gcm" or "apn"
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
-          #   certificate, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "API key" for project from Google
-          #   Developer console for your GCM Service application credential
+          # Create the CredentialInstance
+          # @param [credential.PushService] type The type
+          # @param [String] friendly_name The friendly_name
+          # @param [String] certificate The certificate
+          # @param [String] private_key The private_key
+          # @param [Boolean] sandbox The sandbox
+          # @param [String] api_key The api_key
           # @param [String] secret The secret
-          # @return [CredentialInstance] Newly created CredentialInstance
+          # @return [CredentialInstance] Created CredentialInstance
           def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
             data = Twilio::Values.of({
                 'Type' => type,
@@ -133,11 +124,7 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, )
           end
@@ -193,33 +180,21 @@ module Twilio
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
-          #   certificate, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "API key" for project from Google
-          #   Developer console for your GCM Service application credential
+          # @param [String] friendly_name The friendly_name
+          # @param [String] certificate The certificate
+          # @param [String] private_key The private_key
+          # @param [Boolean] sandbox The sandbox
+          # @param [String] api_key The api_key
           # @param [String] secret The secret
           # @return [CredentialInstance] Updated CredentialInstance
           def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -232,20 +207,16 @@ module Twilio
                 'Secret' => secret,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             CredentialInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CredentialInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -254,6 +225,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.IpMessaging.V1.CredentialContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.IpMessaging.V1.CredentialContext #{context}>"
+          end
         end
 
         class CredentialInstance < InstanceResource
@@ -295,55 +273,55 @@ 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[/console] responsible for this resource.
+          # @return [String] The account_sid
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The human-readable name of this resource.
+          # @return [String] The friendly_name
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [credential.PushService] Indicates which push notifications service this credential is for - either gcm or apn
+          # @return [credential.PushService] The type
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] [APN only] true when this resource should use the sandbox APN service.
+          # @return [String] The sandbox
           def sandbox
             @properties['sandbox']
           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] An absolute URL for this credential resource.
+          # @return [String] The url
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a CredentialInstance
+          # Fetch the CredentialInstance
           # @return [CredentialInstance] Fetched CredentialInstance
           def fetch
             context.fetch
@@ -351,17 +329,11 @@ module Twilio
 
           ##
           # Update the CredentialInstance
-          # @param [String] friendly_name Friendly name for stored credential
-          # @param [String] certificate [APN only] URL encoded representation of the
-          #   certificate, e.g. `-----BEGIN
-          #   CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
-          # @param [String] private_key [APN only] URL encoded representation of the private
-          #   key, e.g. `-----BEGIN RSA PRIVATE
-          #   KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\n.-----END RSA PRIVATE KEY-----`
-          # @param [Boolean] sandbox [APN only] use this credential for sending to
-          #   production or sandbox APNs (string `true` or `false`)
-          # @param [String] api_key [GCM only] This is the "API key" for project from Google
-          #   Developer console for your GCM Service application credential
+          # @param [String] friendly_name The friendly_name
+          # @param [String] certificate The certificate
+          # @param [String] private_key The private_key
+          # @param [Boolean] sandbox The sandbox
+          # @param [String] api_key The api_key
           # @param [String] secret The secret
           # @return [CredentialInstance] Updated CredentialInstance
           def update(friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
@@ -376,8 +348,8 @@ module Twilio
           end
 
           ##
-          # Deletes the CredentialInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CredentialInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end