twilio-ruby 5.49.0 → 5.54.0

data/lib/twilio-ruby/rest/bulkexports/v1/export.rb

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Bulkexports < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportList < ListResource
           ##
           # Initialize the ExportList
@@ -50,8 +48,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportPage < Page
           ##
           # Initialize the ExportPage
@@ -81,8 +77,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportContext < InstanceContext
           ##
           # Initialize the ExportContext
@@ -156,8 +150,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportInstance < InstanceResource
           ##
           # Initialize the ExportInstance

data/lib/twilio-ruby/rest/bulkexports/v1/export/day.rb

@@ -11,8 +11,6 @@ module Twilio
     class Bulkexports < Domain
       class V1 < Version
         class ExportContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DayList < ListResource
             ##
             # Initialize the DayList
@@ -115,8 +113,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DayPage < Page
             ##
             # Initialize the DayPage
@@ -146,8 +142,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DayContext < InstanceContext
             ##
             # Initialize the DayContext
@@ -189,8 +183,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class DayInstance < InstanceResource
             ##
             # Initialize the DayInstance

data/lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb

@@ -11,8 +11,6 @@ module Twilio
     class Bulkexports < Domain
       class V1 < Version
         class ExportContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ExportCustomJobList < ListResource
             ##
             # Initialize the ExportCustomJobList
@@ -147,8 +145,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ExportCustomJobPage < Page
             ##
             # Initialize the ExportCustomJobPage
@@ -178,8 +174,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class ExportCustomJobInstance < InstanceResource
             ##
             # Initialize the ExportCustomJobInstance
@@ -202,6 +196,8 @@ module Twilio
                   'email' => payload['email'],
                   'job_sid' => payload['job_sid'],
                   'details' => payload['details'],
+                  'job_queue_position' => payload['job_queue_position'],
+                  'estimated_completion_time' => payload['estimated_completion_time'],
               }
             end
 
@@ -254,11 +250,23 @@ module Twilio
             end
 
             ##
-            # @return [Hash] The details of a job state which is an object that contains a status string, a day count integer, and list of days in the job
+            # @return [Hash] The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job
             def details
               @properties['details']
             end
 
+            ##
+            # @return [String] This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
+            def job_queue_position
+              @properties['job_queue_position']
+            end
+
+            ##
+            # @return [String] this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
+            def estimated_completion_time
+              @properties['estimated_completion_time']
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/bulkexports/v1/export/job.rb

@@ -11,8 +11,6 @@ module Twilio
     class Bulkexports < Domain
       class V1 < Version
         class ExportList < ListResource
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class JobList < ListResource
             ##
             # Initialize the JobList
@@ -32,8 +30,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class JobPage < Page
             ##
             # Initialize the JobPage
@@ -63,8 +59,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class JobContext < InstanceContext
             ##
             # Initialize the JobContext
@@ -111,8 +105,6 @@ module Twilio
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
           class JobInstance < InstanceResource
             ##
             # Initialize the JobInstance
@@ -136,6 +128,8 @@ module Twilio
                   'webhook_method' => payload['webhook_method'],
                   'email' => payload['email'],
                   'url' => payload['url'],
+                  'job_queue_position' => payload['job_queue_position'],
+                  'estimated_completion_time' => payload['estimated_completion_time'],
               }
 
               # Context
@@ -167,7 +161,7 @@ module Twilio
             end
 
             ##
-            # @return [Hash] This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status
+            # @return [Hash] The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job
             def details
               @properties['details']
             end
@@ -214,6 +208,18 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [String] This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease
+            def job_queue_position
+              @properties['job_queue_position']
+            end
+
+            ##
+            # @return [String] this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position
+            def estimated_completion_time
+              @properties['estimated_completion_time']
+            end
+
             ##
             # Fetch the JobInstance
             # @return [JobInstance] Fetched JobInstance

data/lib/twilio-ruby/rest/bulkexports/v1/export_configuration.rb

@@ -10,8 +10,6 @@ module Twilio
   module REST
     class Bulkexports < Domain
       class V1 < Version
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportConfigurationList < ListResource
           ##
           # Initialize the ExportConfigurationList
@@ -31,8 +29,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportConfigurationPage < Page
           ##
           # Initialize the ExportConfigurationPage
@@ -62,8 +58,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportConfigurationContext < InstanceContext
           ##
           # Initialize the ExportConfigurationContext
@@ -125,8 +119,6 @@ module Twilio
           end
         end
 
-        ##
-        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
         class ExportConfigurationInstance < InstanceResource
           ##
           # Initialize the ExportConfigurationInstance

data/lib/twilio-ruby/rest/events/v1/event_type.rb

@@ -29,6 +29,8 @@ module Twilio
           # Lists EventTypeInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
+          # @param [String] schema_id A string parameter filtering the results to return
+          #   only the Event Types using a given schema.
           # @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
@@ -36,14 +38,16 @@ module Twilio
           #    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
+          def list(schema_id: :unset, limit: nil, page_size: nil)
+            self.stream(schema_id: schema_id, limit: limit, page_size: page_size).entries
           end
 
           ##
           # Streams EventTypeInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
+          # @param [String] schema_id A string parameter filtering the results to return
+          #   only the Event Types using a given schema.
           # @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
@@ -51,10 +55,10 @@ module Twilio
           #    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)
+          def stream(schema_id: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size], )
+            page = self.page(schema_id: schema_id, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -76,12 +80,15 @@ module Twilio
           ##
           # Retrieve a single page of EventTypeInstance records from the API.
           # Request is executed immediately.
+          # @param [String] schema_id A string parameter filtering the results to return
+          #   only the Event Types using a given schema.
           # @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 EventTypeInstance
-          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+          def page(schema_id: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
+                'SchemaId' => schema_id,
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,

data/lib/twilio-ruby/rest/events/v1/schema.rb

@@ -93,17 +93,17 @@ module Twilio
 
           ##
           # Access the versions
-          # @return [VersionList]
-          # @return [VersionContext] if schema_version was passed.
+          # @return [SchemaVersionList]
+          # @return [SchemaVersionContext] if schema_version was passed.
           def versions(schema_version=:unset)
             raise ArgumentError, 'schema_version cannot be nil' if schema_version.nil?
 
             if schema_version != :unset
-              return VersionContext.new(@version, @solution[:id], schema_version, )
+              return SchemaVersionContext.new(@version, @solution[:id], schema_version, )
             end
 
             unless @versions
-              @versions = VersionList.new(@version, id: @solution[:id], )
+              @versions = SchemaVersionList.new(@version, id: @solution[:id], )
             end
 
             @versions
@@ -142,8 +142,8 @@ module Twilio
                 'id' => payload['id'],
                 'url' => payload['url'],
                 'links' => payload['links'],
-                'last_created' => Twilio.deserialize_iso8601_datetime(payload['last_created']),
-                'last_version' => payload['last_version'].to_i,
+                'latest_version_date_created' => Twilio.deserialize_iso8601_datetime(payload['latest_version_date_created']),
+                'latest_version' => payload['latest_version'].to_i,
             }
 
             # Context
@@ -181,15 +181,15 @@ module Twilio
           end
 
           ##
-          # @return [Time] The date that the last schema version was created.
-          def last_created
-            @properties['last_created']
+          # @return [Time] The date that the latest schema version was created.
+          def latest_version_date_created
+            @properties['latest_version_date_created']
           end
 
           ##
-          # @return [String] Last schema version.
-          def last_version
-            @properties['last_version']
+          # @return [String] Latest schema version.
+          def latest_version
+            @properties['latest_version']
           end
 
           ##

data/lib/twilio-ruby/rest/events/v1/schema/{schema_version.rb → version.rb}

@@ -13,13 +13,13 @@ module Twilio
         class SchemaContext < InstanceContext
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class VersionList < ListResource
+          class SchemaVersionList < ListResource
             ##
-            # Initialize the VersionList
+            # Initialize the SchemaVersionList
             # @param [Version] version Version that contains the resource
             # @param [String] id The unique identifier of the schema. Each schema can have
             #   multiple versions, that share the same id.
-            # @return [VersionList] VersionList
+            # @return [SchemaVersionList] SchemaVersionList
             def initialize(version, id: nil)
               super(version)
 
@@ -29,7 +29,7 @@ module Twilio
             end
 
             ##
-            # Lists VersionInstance records from the API as a list.
+            # Lists SchemaVersionInstance 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()
@@ -44,7 +44,7 @@ module Twilio
             end
 
             ##
-            # Streams VersionInstance records from the API as an Enumerable.
+            # Streams SchemaVersionInstance 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()
@@ -63,7 +63,7 @@ module Twilio
             end
 
             ##
-            # When passed a block, yields VersionInstance records from the API.
+            # When passed a block, yields SchemaVersionInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             def each
@@ -77,12 +77,12 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of VersionInstance records from the API.
+            # Retrieve a single page of SchemaVersionInstance 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 VersionInstance
+            # @return [Page] Page of SchemaVersionInstance
             def page(page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'PageToken' => page_token,
@@ -92,38 +92,38 @@ module Twilio
 
               response = @version.page('GET', @uri, params: params)
 
-              VersionPage.new(@version, response, @solution)
+              SchemaVersionPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of VersionInstance records from the API.
+            # Retrieve a single page of SchemaVersionInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of VersionInstance
+            # @return [Page] Page of SchemaVersionInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              VersionPage.new(@version, response, @solution)
+              SchemaVersionPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Events.V1.VersionList>'
+              '#<Twilio.Events.V1.SchemaVersionList>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class VersionPage < Page
+          class SchemaVersionPage < Page
             ##
-            # Initialize the VersionPage
+            # Initialize the SchemaVersionPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [VersionPage] VersionPage
+            # @return [SchemaVersionPage] SchemaVersionPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -132,30 +132,30 @@ module Twilio
             end
 
             ##
-            # Build an instance of VersionInstance
+            # Build an instance of SchemaVersionInstance
             # @param [Hash] payload Payload response from the API
-            # @return [VersionInstance] VersionInstance
+            # @return [SchemaVersionInstance] SchemaVersionInstance
             def get_instance(payload)
-              VersionInstance.new(@version, payload, id: @solution[:id], )
+              SchemaVersionInstance.new(@version, payload, id: @solution[:id], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Events.V1.VersionPage>'
+              '<Twilio.Events.V1.SchemaVersionPage>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class VersionContext < InstanceContext
+          class SchemaVersionContext < InstanceContext
             ##
-            # Initialize the VersionContext
+            # Initialize the SchemaVersionContext
             # @param [Version] version Version that contains the resource
             # @param [String] id The unique identifier of the schema. Each schema can have
             #   multiple versions, that share the same id.
             # @param [String] schema_version The version of the schema
-            # @return [VersionContext] VersionContext
+            # @return [SchemaVersionContext] SchemaVersionContext
             def initialize(version, id, schema_version)
               super(version)
 
@@ -165,12 +165,12 @@ module Twilio
             end
 
             ##
-            # Fetch the VersionInstance
-            # @return [VersionInstance] Fetched VersionInstance
+            # Fetch the SchemaVersionInstance
+            # @return [SchemaVersionInstance] Fetched SchemaVersionInstance
             def fetch
               payload = @version.fetch('GET', @uri)
 
-              VersionInstance.new(
+              SchemaVersionInstance.new(
                   @version,
                   payload,
                   id: @solution[:id],
@@ -182,28 +182,28 @@ module Twilio
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Events.V1.VersionContext #{context}>"
+              "#<Twilio.Events.V1.SchemaVersionContext #{context}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Events.V1.VersionContext #{context}>"
+              "#<Twilio.Events.V1.SchemaVersionContext #{context}>"
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class VersionInstance < InstanceResource
+          class SchemaVersionInstance < InstanceResource
             ##
-            # Initialize the VersionInstance
+            # Initialize the SchemaVersionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] id The unique identifier of the schema. Each schema can have
             #   multiple versions, that share the same id.
             # @param [String] schema_version The version of the schema
-            # @return [VersionInstance] VersionInstance
+            # @return [SchemaVersionInstance] SchemaVersionInstance
             def initialize(version, payload, id: nil, schema_version: nil)
               super(version)
 
@@ -224,10 +224,10 @@ module Twilio
             ##
             # Generate an instance context for the instance, the context is capable of
             # performing various actions.  All instance actions are proxied to the context
-            # @return [VersionContext] VersionContext for this VersionInstance
+            # @return [SchemaVersionContext] SchemaVersionContext for this SchemaVersionInstance
             def context
               unless @instance_context
-                @instance_context = VersionContext.new(@version, @params['id'], @params['schema_version'], )
+                @instance_context = SchemaVersionContext.new(@version, @params['id'], @params['schema_version'], )
               end
               @instance_context
             end
@@ -263,8 +263,8 @@ module Twilio
             end
 
             ##
-            # Fetch the VersionInstance
-            # @return [VersionInstance] Fetched VersionInstance
+            # Fetch the SchemaVersionInstance
+            # @return [SchemaVersionInstance] Fetched SchemaVersionInstance
             def fetch
               context.fetch
             end
@@ -273,14 +273,14 @@ module Twilio
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Events.V1.VersionInstance #{values}>"
+              "<Twilio.Events.V1.SchemaVersionInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Events.V1.VersionInstance #{values}>"
+              "<Twilio.Events.V1.SchemaVersionInstance #{values}>"
             end
           end
         end