twilio-ruby 3.11.5 → 5.71.0

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

@@ -0,0 +1,243 @@
+##
+# 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
+          ##
+          # Initialize the ExportList
+          # @param [Version] version Version that contains the resource
+          # @return [ExportList] ExportList
+          def initialize(version)
+            super(version)
+
+            # 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.Bulkexports.V1.ExportList>'
+          end
+        end
+
+        class ExportPage < Page
+          ##
+          # Initialize the ExportPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ExportPage] ExportPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ExportInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ExportInstance] ExportInstance
+          def get_instance(payload)
+            ExportInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Bulkexports.V1.ExportPage>'
+          end
+        end
+
+        class ExportContext < InstanceContext
+          ##
+          # Initialize the ExportContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
+          # @return [ExportContext] ExportContext
+          def initialize(version, resource_type)
+            super(version)
+
+            # Path Solution
+            @solution = {resource_type: resource_type, }
+            @uri = "/Exports/#{@solution[:resource_type]}"
+
+            # Dependents
+            @days = nil
+            @export_custom_jobs = nil
+          end
+
+          ##
+          # Fetch the ExportInstance
+          # @return [ExportInstance] Fetched ExportInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            ExportInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+          end
+
+          ##
+          # Access the days
+          # @return [DayList]
+          # @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
+
+            @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.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
+
+        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 type of communication – Messages, Calls,
+          #   Conferences, and Participants
+          # @return [ExportInstance] ExportInstance
+          def initialize(version, payload, resource_type: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'resource_type' => payload['resource_type'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # 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 [ExportContext] ExportContext for this ExportInstance
+          def context
+            unless @instance_context
+              @instance_context = ExportContext.new(@version, @params['resource_type'], )
+            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 URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Nested resource URLs.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch the ExportInstance
+          # @return [ExportInstance] Fetched ExportInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the days
+          # @return [days] days
+          def days
+            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.Bulkexports.V1.ExportInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Bulkexports.V1.ExportInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,226 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Bulkexports < Domain
+      class V1 < Version
+        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
+
+        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
+
+        class ExportConfigurationContext < InstanceContext
+          ##
+          # Initialize the ExportConfigurationContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
+          # @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 the ExportConfigurationInstance
+          # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            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
+
+        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,
+          #   Conferences, and Participants
+          # @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, Conferences, and Participants
+          def resource_type
+            @properties['resource_type']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the 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

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

@@ -0,0 +1,62 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Bulkexports
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Bulkexports
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @exports = nil
+          @export_configuration = nil
+        end
+
+        ##
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
+        # @return [Twilio::REST::Bulkexports::V1::ExportContext] if resource_type was passed.
+        # @return [Twilio::REST::Bulkexports::V1::ExportList]
+        def exports(resource_type=:unset)
+          if resource_type.nil?
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @exports ||= ExportList.new self
+          else
+              ExportContext.new(self, resource_type)
+          end
+        end
+
+        ##
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
+        # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationContext] if resource_type was passed.
+        # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationList]
+        def export_configuration(resource_type=:unset)
+          if resource_type.nil?
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @export_configuration ||= ExportConfigurationList.new self
+          else
+              ExportConfigurationContext.new(self, resource_type)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Bulkexports::V1>'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Bulkexports < Domain
+      ##
+      # Initialize the Bulkexports Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://bulkexports.twilio.com'
+        @host = 'bulkexports.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of bulkexports
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
+      # @return [Twilio::REST::Bulkexports::V1::ExportInstance] if resource_type was passed.
+      # @return [Twilio::REST::Bulkexports::V1::ExportList]
+      def exports(resource_type=:unset)
+        self.v1.exports(resource_type)
+      end
+
+      ##
+      # @param [String] resource_type The type of communication – Messages, Calls,
+      #   Conferences, and Participants
+      # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationInstance] if resource_type was passed.
+      # @return [Twilio::REST::Bulkexports::V1::ExportConfigurationList]
+      def export_configuration(resource_type=:unset)
+        self.v1.export_configuration(resource_type)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Bulkexports>'
+      end
+    end
+  end
+end