twilio-ruby 5.19.0 → 5.74.2

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

@@ -0,0 +1,255 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Bulkexports < Domain
+      class V1 < Version
+        class ExportList < ListResource
+          class JobList < ListResource
+            ##
+            # Initialize the JobList
+            # @param [Version] version Version that contains the resource
+            # @return [JobList] JobList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Bulkexports.V1.JobList>'
+            end
+          end
+
+          class JobPage < Page
+            ##
+            # Initialize the JobPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [JobPage] JobPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of JobInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [JobInstance] JobInstance
+            def get_instance(payload)
+              JobInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Bulkexports.V1.JobPage>'
+            end
+          end
+
+          class JobContext < InstanceContext
+            ##
+            # Initialize the JobContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] job_sid The unique string that that we created to identify the
+            #   Bulk Export job
+            # @return [JobContext] JobContext
+            def initialize(version, job_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {job_sid: job_sid, }
+              @uri = "/Exports/Jobs/#{@solution[:job_sid]}"
+            end
+
+            ##
+            # Fetch the JobInstance
+            # @return [JobInstance] Fetched JobInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              JobInstance.new(@version, payload, job_sid: @solution[:job_sid], )
+            end
+
+            ##
+            # Delete the JobInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Bulkexports.V1.JobContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Bulkexports.V1.JobContext #{context}>"
+            end
+          end
+
+          class JobInstance < InstanceResource
+            ##
+            # Initialize the JobInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] job_sid The unique string that that we created to identify the
+            #   Bulk Export job
+            # @return [JobInstance] JobInstance
+            def initialize(version, payload, job_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'resource_type' => payload['resource_type'],
+                  'friendly_name' => payload['friendly_name'],
+                  'details' => payload['details'],
+                  'start_day' => payload['start_day'],
+                  'end_day' => payload['end_day'],
+                  'job_sid' => payload['job_sid'],
+                  'webhook_url' => payload['webhook_url'],
+                  '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
+              @instance_context = nil
+              @params = {'job_sid' => job_sid || @properties['job_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 [JobContext] JobContext for this JobInstance
+            def context
+              unless @instance_context
+                @instance_context = JobContext.new(@version, @params['job_sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
+            def resource_type
+              @properties['resource_type']
+            end
+
+            ##
+            # @return [String] The friendly name specified when creating the job
+            def friendly_name
+              @properties['friendly_name']
+            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
+            def details
+              @properties['details']
+            end
+
+            ##
+            # @return [String] The start time for the export specified when creating the job
+            def start_day
+              @properties['start_day']
+            end
+
+            ##
+            # @return [String] The end time for the export specified when creating the job
+            def end_day
+              @properties['end_day']
+            end
+
+            ##
+            # @return [String] The job_sid returned when the export was created
+            def job_sid
+              @properties['job_sid']
+            end
+
+            ##
+            # @return [String] The optional webhook url called on completion
+            def webhook_url
+              @properties['webhook_url']
+            end
+
+            ##
+            # @return [String] This is the method used to call the webhook
+            def webhook_method
+              @properties['webhook_method']
+            end
+
+            ##
+            # @return [String] The optional email to send the completion notification to
+            def email
+              @properties['email']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @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
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Delete the JobInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Bulkexports.V1.JobInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Bulkexports.V1.JobInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/{preview/bulk_exports → bulkexports/v1}/export.rb

@@ -3,15 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class BulkExports < 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 Bulkexports < Domain
+      class V1 < Version
         class ExportList < ListResource
           ##
           # Initialize the ExportList
@@ -22,17 +20,34 @@ module Twilio
 
             # Path Solution
             @solution = {}
+
+            # Components
+            @jobs = nil
+          end
+
+          ##
+          # Access the jobs
+          # @param [String] job_sid The unique string that that we created to identify the
+          #   Bulk Export job
+          # @return [JobList]
+          # @return [JobContext] if job_sid was passed.
+          def jobs(job_sid=:unset)
+            raise ArgumentError, 'job_sid cannot be nil' if job_sid.nil?
+
+            if job_sid != :unset
+              return JobContext.new(@version, job_sid, )
+            end
+
+              @jobs ||= JobList.new(@version, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.BulkExports.ExportList>'
+            '#<Twilio.Bulkexports.V1.ExportList>'
           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 ExportPage < Page
           ##
           # Initialize the ExportPage
@@ -58,17 +73,16 @@ module Twilio
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.BulkExports.ExportPage>'
+            '<Twilio.Bulkexports.V1.ExportPage>'
           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 ExportContext < InstanceContext
           ##
           # Initialize the ExportContext
           # @param [Version] version Version that contains the resource
-          # @param [String] resource_type The resource_type
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportContext] ExportContext
           def initialize(version, resource_type)
             super(version)
@@ -79,19 +93,14 @@ module Twilio
 
             # Dependents
             @days = nil
+            @export_custom_jobs = nil
           end
 
           ##
-          # Fetch a ExportInstance
+          # Fetch the ExportInstance
           # @return [ExportInstance] Fetched ExportInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ExportInstance.new(@version, payload, resource_type: @solution[:resource_type], )
           end
@@ -99,8 +108,14 @@ module Twilio
           ##
           # Access the days
           # @return [DayList]
-          # @return [DayContext]
-          def days
+          # @return [DayContext] if day was passed.
+          def days(day=:unset)
+            raise ArgumentError, 'day cannot be nil' if day.nil?
+
+            if day != :unset
+              return DayContext.new(@version, @solution[:resource_type], day, )
+            end
+
             unless @days
               @days = DayList.new(@version, resource_type: @solution[:resource_type], )
             end
@@ -108,22 +123,40 @@ module Twilio
             @days
           end
 
+          ##
+          # Access the export_custom_jobs
+          # @return [ExportCustomJobList]
+          # @return [ExportCustomJobContext]
+          def export_custom_jobs
+            unless @export_custom_jobs
+              @export_custom_jobs = ExportCustomJobList.new(@version, resource_type: @solution[:resource_type], )
+            end
+
+            @export_custom_jobs
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.BulkExports.ExportContext #{context}>"
+            "#<Twilio.Bulkexports.V1.ExportContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Bulkexports.V1.ExportContext #{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 ExportInstance < InstanceResource
           ##
           # Initialize the ExportInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] resource_type The resource_type
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportInstance] ExportInstance
           def initialize(version, payload, resource_type: nil)
             super(version)
@@ -152,25 +185,25 @@ module Twilio
           end
 
           ##
-          # @return [String] The resource_type
+          # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
           def resource_type
             @properties['resource_type']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a ExportInstance
+          # Fetch the ExportInstance
           # @return [ExportInstance] Fetched ExportInstance
           def fetch
             context.fetch
@@ -183,18 +216,25 @@ module Twilio
             context.days
           end
 
+          ##
+          # Access the export_custom_jobs
+          # @return [export_custom_jobs] export_custom_jobs
+          def export_custom_jobs
+            context.export_custom_jobs
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.BulkExports.ExportInstance #{values}>"
+            "<Twilio.Bulkexports.V1.ExportInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.BulkExports.ExportInstance #{values}>"
+            "<Twilio.Bulkexports.V1.ExportInstance #{values}>"
           end
         end
       end

data/lib/twilio-ruby/rest/{preview/bulk_exports → bulkexports/v1}/export_configuration.rb

@@ -3,15 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class BulkExports < 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 Bulkexports < Domain
+      class V1 < Version
         class ExportConfigurationList < ListResource
           ##
           # Initialize the ExportConfigurationList
@@ -27,12 +25,10 @@ module Twilio
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.BulkExports.ExportConfigurationList>'
+            '#<Twilio.Bulkexports.V1.ExportConfigurationList>'
           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 ExportConfigurationPage < Page
           ##
           # Initialize the ExportConfigurationPage
@@ -58,17 +54,16 @@ module Twilio
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.BulkExports.ExportConfigurationPage>'
+            '<Twilio.Bulkexports.V1.ExportConfigurationPage>'
           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 ExportConfigurationContext < InstanceContext
           ##
           # Initialize the ExportConfigurationContext
           # @param [Version] version Version that contains the resource
-          # @param [String] resource_type The resource_type
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportConfigurationContext] ExportConfigurationContext
           def initialize(version, resource_type)
             super(version)
@@ -79,25 +74,23 @@ module Twilio
           end
 
           ##
-          # Fetch a ExportConfigurationInstance
+          # Fetch the ExportConfigurationInstance
           # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
           end
 
           ##
           # Update the ExportConfigurationInstance
-          # @param [Boolean] enabled The enabled
-          # @param [String] webhook_url The webhook_url
-          # @param [String] webhook_method The webhook_method
+          # @param [Boolean] enabled If true, Twilio will automatically generate every day's
+          #   file when the day is over.
+          # @param [String] webhook_url Stores the URL destination for the method specified
+          #   in webhook_method.
+          # @param [String] webhook_method Sets whether Twilio should call a webhook URL
+          #   when the automatic generation is complete, using GET or POST. The actual
+          #   destination is set in the webhook_url
           # @return [ExportConfigurationInstance] Updated ExportConfigurationInstance
           def update(enabled: :unset, webhook_url: :unset, webhook_method: :unset)
             data = Twilio::Values.of({
@@ -106,11 +99,7 @@ module Twilio
                 'WebhookMethod' => webhook_method,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
             ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
           end
@@ -119,18 +108,24 @@ module Twilio
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.BulkExports.ExportConfigurationContext #{context}>"
+            "#<Twilio.Bulkexports.V1.ExportConfigurationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Bulkexports.V1.ExportConfigurationContext #{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 ExportConfigurationInstance < InstanceResource
           ##
           # Initialize the ExportConfigurationInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] resource_type The resource_type
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportConfigurationInstance] ExportConfigurationInstance
           def initialize(version, payload, resource_type: nil)
             super(version)
@@ -161,37 +156,37 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] The enabled
+          # @return [Boolean] Whether files are automatically generated
           def enabled
             @properties['enabled']
           end
 
           ##
-          # @return [String] The webhook_url
+          # @return [String] URL targeted at export
           def webhook_url
             @properties['webhook_url']
           end
 
           ##
-          # @return [String] The webhook_method
+          # @return [String] Whether to GET or POST to the webhook url
           def webhook_method
             @properties['webhook_method']
           end
 
           ##
-          # @return [String] The resource_type
+          # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
           def resource_type
             @properties['resource_type']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a ExportConfigurationInstance
+          # Fetch the ExportConfigurationInstance
           # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
           def fetch
             context.fetch
@@ -199,9 +194,13 @@ module Twilio
 
           ##
           # Update the ExportConfigurationInstance
-          # @param [Boolean] enabled The enabled
-          # @param [String] webhook_url The webhook_url
-          # @param [String] webhook_method The webhook_method
+          # @param [Boolean] enabled If true, Twilio will automatically generate every day's
+          #   file when the day is over.
+          # @param [String] webhook_url Stores the URL destination for the method specified
+          #   in webhook_method.
+          # @param [String] webhook_method Sets whether Twilio should call a webhook URL
+          #   when the automatic generation is complete, using GET or POST. The actual
+          #   destination is set in the webhook_url
           # @return [ExportConfigurationInstance] Updated ExportConfigurationInstance
           def update(enabled: :unset, webhook_url: :unset, webhook_method: :unset)
             context.update(enabled: enabled, webhook_url: webhook_url, webhook_method: webhook_method, )
@@ -211,14 +210,14 @@ module Twilio
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.BulkExports.ExportConfigurationInstance #{values}>"
+            "<Twilio.Bulkexports.V1.ExportConfigurationInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.BulkExports.ExportConfigurationInstance #{values}>"
+            "<Twilio.Bulkexports.V1.ExportConfigurationInstance #{values}>"
           end
         end
       end