twilio-ruby 5.46.0 → 5.50.0

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

@@ -17,7 +17,7 @@ module Twilio
             ##
             # Initialize the ParticipantList
             # @param [Version] version Version that contains the resource
-            # @param [String] room_sid The room_sid
+            # @param [String] room_sid Unique identifier for the room.
             # @return [ParticipantList] ParticipantList
             def initialize(version, room_sid: nil)
               super(version)
@@ -151,8 +151,8 @@ module Twilio
             ##
             # 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
+            # @param [String] room_sid The SID of the Room resource.
+            # @param [String] participant_sid The SID of the Participant resource.
             # @return [ParticipantContext] ParticipantContext
             def initialize(version, room_sid, participant_sid)
               super(version)
@@ -198,8 +198,8 @@ module Twilio
             # 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
+            # @param [String] room_sid Unique identifier for the room.
+            # @param [String] participant_sid The SID of the Participant resource.
             # @return [ParticipantInstance] ParticipantInstance
             def initialize(version, payload, room_sid: nil, participant_sid: nil)
               super(version)
@@ -249,103 +249,103 @@ module Twilio
             end
 
             ##
-            # @return [String] The participant_sid
+            # @return [String] Unique identifier for the participant.
             def participant_sid
               @properties['participant_sid']
             end
 
             ##
-            # @return [String] The participant_identity
+            # @return [String] The application-defined string that uniquely identifies the participant within a Room.
             def participant_identity
               @properties['participant_identity']
             end
 
             ##
-            # @return [Time] The join_time
+            # @return [Time] When the participant joined the room.
             def join_time
               @properties['join_time']
             end
 
             ##
-            # @return [Time] The leave_time
+            # @return [Time] When the participant left the room
             def leave_time
               @properties['leave_time']
             end
 
             ##
-            # @return [String] The duration_sec
+            # @return [String] Amount of time in seconds the participant was in the room.
             def duration_sec
               @properties['duration_sec']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] Account SID associated with the 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 [participant.RoomStatus] The status
+            # @return [participant.RoomStatus] Status of the room.
             def status
               @properties['status']
             end
 
             ##
-            # @return [Array[participant.Codec]] The codecs
+            # @return [Array[participant.Codec]] Codecs detected from the participant.
             def codecs
               @properties['codecs']
             end
 
             ##
-            # @return [String] The end_reason
+            # @return [String] Reason the participant left the room.
             def end_reason
               @properties['end_reason']
             end
 
             ##
-            # @return [String] The error_code
+            # @return [String] Errors encountered by the participant.
             def error_code
               @properties['error_code']
             end
 
             ##
-            # @return [String] The error_code_url
+            # @return [String] Twilio error code dictionary link.
             def error_code_url
               @properties['error_code_url']
             end
 
             ##
-            # @return [participant.TwilioRealm] The media_region
+            # @return [participant.TwilioRealm] Twilio media region the participant connected to.
             def media_region
               @properties['media_region']
             end
 
             ##
-            # @return [Hash] The properties
+            # @return [Hash] Object containing information about the participant's data from the room.
             def properties
               @properties['properties']
             end
 
             ##
-            # @return [participant.EdgeLocation] The edge_location
+            # @return [participant.EdgeLocation] Name of the edge location the participant connected to.
             def edge_location
               @properties['edge_location']
             end
 
             ##
-            # @return [Hash] The publisher_info
+            # @return [Hash] Object containing information about the SDK name and version.
             def publisher_info
               @properties['publisher_info']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] URL of the participant resource.
             def url
               @properties['url']
             end

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

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V1::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

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

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V2::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

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

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
         def phone_numbers(phone_number=:unset)
           if phone_number.nil?
-            raise ArgumentError, 'phone_number cannot be nil'
-          elsif phone_number == :unset
-            @phone_numbers ||= PhoneNumberList.new self
+              raise ArgumentError, 'phone_number cannot be nil'
+          end
+          if phone_number == :unset
+              @phone_numbers ||= PhoneNumberList.new self
           else
-            PhoneNumberContext.new(self, phone_number)
+              PhoneNumberContext.new(self, phone_number)
           end
         end
 

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

@@ -28,6 +28,14 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [String] sid The unique string to identify Brand Registration.
+      # @return [Twilio::REST::Messaging::V1::BrandRegistrationInstance] if sid was passed.
+      # @return [Twilio::REST::Messaging::V1::BrandRegistrationList]
+      def brand_registrations(sid=:unset)
+        self.v1.brand_registrations(sid)
+      end
+
       ##
       # @return [Twilio::REST::Messaging::V1::DeactivationsInstance]
       def deactivations

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

@@ -15,10 +15,26 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @brand_registrations = nil
           @deactivations = nil
           @services = nil
         end
 
+        ##
+        # @param [String] sid The SID of the Brand Registration resource to fetch.
+        # @return [Twilio::REST::Messaging::V1::BrandRegistrationContext] if sid was passed.
+        # @return [Twilio::REST::Messaging::V1::BrandRegistrationList]
+        def brand_registrations(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @brand_registrations ||= BrandRegistrationList.new self
+          else
+              BrandRegistrationContext.new(self, sid)
+          end
+        end
+
         ##
         # @return [Twilio::REST::Messaging::V1::DeactivationsContext]
         def deactivations
@@ -31,11 +47,12 @@ module Twilio
         # @return [Twilio::REST::Messaging::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb

@@ -0,0 +1,328 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationList < ListResource
+          ##
+          # Initialize the BrandRegistrationList
+          # @param [Version] version Version that contains the resource
+          # @return [BrandRegistrationList] BrandRegistrationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/a2p/BrandRegistrations"
+          end
+
+          ##
+          # Lists BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance
+          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)
+
+            BrandRegistrationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of BrandRegistrationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of BrandRegistrationInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            BrandRegistrationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Create the BrandRegistrationInstance
+          # @param [String] customer_profile_bundle_sid Customer Profile Bundle Sid.
+          # @param [String] a2p_profile_bundle_sid A2P Messaging Profile Bundle Sid.
+          # @return [BrandRegistrationInstance] Created BrandRegistrationInstance
+          def create(customer_profile_bundle_sid: nil, a2p_profile_bundle_sid: nil)
+            data = Twilio::Values.of({
+                'CustomerProfileBundleSid' => customer_profile_bundle_sid,
+                'A2PProfileBundleSid' => a2p_profile_bundle_sid,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            BrandRegistrationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.BrandRegistrationList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationPage < Page
+          ##
+          # Initialize the BrandRegistrationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BrandRegistrationPage] BrandRegistrationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandRegistrationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandRegistrationInstance] BrandRegistrationInstance
+          def get_instance(payload)
+            BrandRegistrationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.BrandRegistrationPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationContext < InstanceContext
+          ##
+          # Initialize the BrandRegistrationContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the Brand Registration resource to fetch.
+          # @return [BrandRegistrationContext] BrandRegistrationContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/a2p/BrandRegistrations/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            BrandRegistrationInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationInstance < InstanceResource
+          ##
+          # Initialize the BrandRegistrationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the Brand Registration resource to fetch.
+          # @return [BrandRegistrationInstance] BrandRegistrationInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'customer_profile_bundle_sid' => payload['customer_profile_bundle_sid'],
+                'a2p_profile_bundle_sid' => payload['a2p_profile_bundle_sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'status' => payload['status'],
+                'tcr_id' => payload['tcr_id'],
+                'failure_reason' => payload['failure_reason'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['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 [BrandRegistrationContext] BrandRegistrationContext for this BrandRegistrationInstance
+          def context
+            unless @instance_context
+              @instance_context = BrandRegistrationContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A2P BrandRegistration Sid
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] A2P Messaging Profile Bundle BundleSid
+          def customer_profile_bundle_sid
+            @properties['customer_profile_bundle_sid']
+          end
+
+          ##
+          # @return [String] A2P Messaging Profile Bundle BundleSid
+          def a2p_profile_bundle_sid
+            @properties['a2p_profile_bundle_sid']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [brand_registration.Status] Brand Registration status
+          def status
+            @properties['status']
+          end
+
+          ##
+          # @return [String] Campaign Registry (TCR) Brand ID
+          def tcr_id
+            @properties['tcr_id']
+          end
+
+          ##
+          # @return [String] A reason why brand registration has failed
+          def failure_reason
+            @properties['failure_reason']
+          end
+
+          ##
+          # @return [String] The absolute URL of the Brand Registration
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end