twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,255 +1,445 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Bulkexports
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
 #
-# 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}>"
+module Twilio
+    module REST
+        class Bulkexports < BulkexportsBase
+            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 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
+                    ##
+                    # Delete the JobInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the JobInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          job_instance = JobInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          JobInstanceMetadata.new(@version, job_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the JobInstance
+                    # @return [JobInstance] Fetched JobInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        JobInstance.new(
+                            @version,
+                            payload,
+                            job_sid: @solution[:job_sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the JobInstanceMetadata
+                    # @return [JobInstance] Fetched JobInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        job_instance = JobInstance.new(
+                            @version,
+                            response.body,
+                            job_sid: @solution[:job_sid],
+                        )
+                        JobInstanceMetadata.new(
+                            @version,
+                            job_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    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 JobInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new JobInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}JobInstance] job_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [JobInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, job_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @job_instance = job_instance
+                    end
+
+                    def job
+                        @job_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.JobInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class JobListResponse < InstanceListResource
+                    # @param [Array<JobInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @job_instance = payload.body[key].map do |data|
+                        JobInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def job_instance
+                          @instance
+                      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 JobPageMetadata < PageMetadata
+                    attr_reader :job_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @job_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @job_page << JobListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @job_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Bulkexports::V1PageMetadata>';
+                    end
+                end
+                class JobListResponse < InstanceListResource
+
+                    # @param [Array<JobInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @job = data_list.map do |data|
+                        JobInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def job
+                        @job
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    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] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Job
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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] CallContext for this CallInstance
+                    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 [Array<Hash>] The details of a job which is an object that contains an array of status grouped by `status` state.  Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.
+                    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] 
+                    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
+                    
+                    ##
+                    # Delete the JobInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the JobInstance
+                    # @return [JobInstance] Fetched JobInstance
+                    def fetch
+
+                        context.fetch
+                    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
     end
-  end
-end
+end
+
+