twilio-ruby 5.15.1 → 5.58.1

data/lib/twilio-ruby/rest/preview/bulk_exports/export/job.rb

@@ -0,0 +1,249 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class BulkExports < Version
+        class ExportList < ListResource
+          ##
+          # 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 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.Preview.BulkExports.JobList>'
+            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 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.Preview.BulkExports.JobPage>'
+            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 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.Preview.BulkExports.JobContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.BulkExports.JobContext #{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 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'],
+              }
+
+              # 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] 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
+            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
+
+            ##
+            # 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.Preview.BulkExports.JobInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.BulkExports.JobInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -22,6 +22,25 @@ 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
 
           ##
@@ -68,7 +87,8 @@ module Twilio
           ##
           # 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 +99,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 +114,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,12 +129,31 @@ 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}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.BulkExports.ExportContext #{context}>"
+          end
         end
 
         ##
@@ -123,7 +163,8 @@ module Twilio
           # 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 +193,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,6 +224,13 @@ 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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -68,7 +68,8 @@ module Twilio
           ##
           # 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 +80,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 +105,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
@@ -121,6 +116,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Preview.BulkExports.ExportConfigurationContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.BulkExports.ExportConfigurationContext #{context}>"
+          end
         end
 
         ##
@@ -130,7 +132,8 @@ module Twilio
           # 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 +164,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 +202,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, )