twilio-ruby 5.31.0 → 5.46.0

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

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

@@ -0,0 +1,60 @@
+##
+# 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'
+          elsif 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'
+          elsif 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/v1/export.rb

@@ -0,0 +1,251 @@
+##
+# 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 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
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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/day.rb

@@ -0,0 +1,294 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    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
+            # @param [Version] version Version that contains the resource
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
+            # @return [DayList] DayList
+            def initialize(version, resource_type: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {resource_type: resource_type}
+              @uri = "/Exports/#{@solution[:resource_type]}/Days"
+            end
+
+            ##
+            # Lists DayInstance 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()
+            #    guarantees to never return more than limit.  Default is no limit
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records.  If no page_size is defined
+            #    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
+            end
+
+            ##
+            # Streams DayInstance 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()
+            #    guarantees to never return more than limit. Default is no limit.
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records. If no page_size is defined
+            #    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)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields DayInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of DayInstance 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 DayInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              DayPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of DayInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of DayInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              DayPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Bulkexports.V1.DayList>'
+            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
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [DayPage] DayPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of DayInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [DayInstance] DayInstance
+            def get_instance(payload)
+              DayInstance.new(@version, payload, resource_type: @solution[:resource_type], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Bulkexports.V1.DayPage>'
+            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
+            # @param [Version] version Version that contains the resource
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
+            # @param [String] day The ISO 8601 format date of the resources in the file, for a
+            #   UTC day
+            # @return [DayContext] DayContext
+            def initialize(version, resource_type, day)
+              super(version)
+
+              # Path Solution
+              @solution = {resource_type: resource_type, day: day, }
+              @uri = "/Exports/#{@solution[:resource_type]}/Days/#{@solution[:day]}"
+            end
+
+            ##
+            # Fetch the DayInstance
+            # @return [DayInstance] Fetched DayInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              DayInstance.new(@version, payload, resource_type: @solution[:resource_type], day: @solution[:day], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Bulkexports.V1.DayContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Bulkexports.V1.DayContext #{context}>"
+            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
+            # @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
+            # @param [String] day The ISO 8601 format date of the resources in the file, for a
+            #   UTC day
+            # @return [DayInstance] DayInstance
+            def initialize(version, payload, resource_type: nil, day: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'redirect_to' => payload['redirect_to'],
+                  'day' => payload['day'],
+                  'size' => payload['size'].to_i,
+                  'create_date' => payload['create_date'],
+                  'friendly_name' => payload['friendly_name'],
+                  'resource_type' => payload['resource_type'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'resource_type' => resource_type, 'day' => day || @properties['day'], }
+            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 [DayContext] DayContext for this DayInstance
+            def context
+              unless @instance_context
+                @instance_context = DayContext.new(@version, @params['resource_type'], @params['day'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The redirect_to
+            def redirect_to
+              @properties['redirect_to']
+            end
+
+            ##
+            # @return [String] The date of the data in the file
+            def day
+              @properties['day']
+            end
+
+            ##
+            # @return [String] Size of the file in bytes
+            def size
+              @properties['size']
+            end
+
+            ##
+            # @return [String] The date when resource is created
+            def create_date
+              @properties['create_date']
+            end
+
+            ##
+            # @return [String] The friendly name specified when creating the job
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
+            def resource_type
+              @properties['resource_type']
+            end
+
+            ##
+            # Fetch the DayInstance
+            # @return [DayInstance] Fetched DayInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Bulkexports.V1.DayInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Bulkexports.V1.DayInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end