twilio-ruby 5.32.0 → 5.33.0

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

@@ -0,0 +1,253 @@
+##
+# 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
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          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
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          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
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class JobContext < InstanceContext
+            ##
+            # Initialize the JobContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] job_sid The job_sid
+            # @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 a JobInstance
+            # @return [JobInstance] Fetched JobInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              JobInstance.new(@version, payload, job_sid: @solution[:job_sid], )
+            end
+
+            ##
+            # Deletes 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
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          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 job_sid
+            # @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
+            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 a JobInstance
+            # @return [JobInstance] Fetched JobInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Deletes 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/bulkexports/v1/export_configuration.rb

@@ -0,0 +1,242 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+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
+          # @param [Version] version Version that contains the resource
+          # @return [ExportConfigurationList] ExportConfigurationList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Bulkexports.V1.ExportConfigurationList>'
+          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
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ExportConfigurationPage] ExportConfigurationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ExportConfigurationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ExportConfigurationInstance] ExportConfigurationInstance
+          def get_instance(payload)
+            ExportConfigurationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Bulkexports.V1.ExportConfigurationPage>'
+          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
+          # @param [Version] version Version that contains the resource
+          # @param [String] resource_type The type of communication – Messages, Calls
+          # @return [ExportConfigurationContext] ExportConfigurationContext
+          def initialize(version, resource_type)
+            super(version)
+
+            # Path Solution
+            @solution = {resource_type: resource_type, }
+            @uri = "/Exports/#{@solution[:resource_type]}/Configuration"
+          end
+
+          ##
+          # Fetch a ExportConfigurationInstance
+          # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+          end
+
+          ##
+          # Update the ExportConfigurationInstance
+          # @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({
+                'Enabled' => enabled,
+                'WebhookUrl' => webhook_url,
+                'WebhookMethod' => webhook_method,
+            })
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<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 beta products that are subject to change. Use them with caution.
+        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 type of communication – Messages, Calls
+          # @return [ExportConfigurationInstance] ExportConfigurationInstance
+          def initialize(version, payload, resource_type: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'enabled' => payload['enabled'],
+                'webhook_url' => payload['webhook_url'],
+                'webhook_method' => payload['webhook_method'],
+                'resource_type' => payload['resource_type'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'resource_type' => resource_type || @properties['resource_type'], }
+          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 [ExportConfigurationContext] ExportConfigurationContext for this ExportConfigurationInstance
+          def context
+            unless @instance_context
+              @instance_context = ExportConfigurationContext.new(@version, @params['resource_type'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [Boolean] Whether files are automatically generated
+          def enabled
+            @properties['enabled']
+          end
+
+          ##
+          # @return [String] URL targeted at export
+          def webhook_url
+            @properties['webhook_url']
+          end
+
+          ##
+          # @return [String] Whether to GET or POST to the webhook url
+          def webhook_method
+            @properties['webhook_method']
+          end
+
+          ##
+          # @return [String] The type of communication – Messages, Calls
+          def resource_type
+            @properties['resource_type']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch a ExportConfigurationInstance
+          # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the ExportConfigurationInstance
+          # @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, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Bulkexports.V1.ExportConfigurationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Bulkexports.V1.ExportConfigurationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end