twilio-ruby 5.69.0 → 5.71.0

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

@@ -1,275 +0,0 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-#
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class Preview < Domain
-      class BulkExports < Version
-        class ExportContext < InstanceContext
-          ##
-          # 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 ExportCustomJobList < ListResource
-            ##
-            # Initialize the ExportCustomJobList
-            # @param [Version] version Version that contains the resource
-            # @param [String] resource_type The type of communication – Messages, Calls,
-            #   Conferences, and Participants
-            # @return [ExportCustomJobList] ExportCustomJobList
-            def initialize(version, resource_type: nil)
-              super(version)
-
-              # Path Solution
-              @solution = {resource_type: resource_type}
-              @uri = "/Exports/#{@solution[:resource_type]}/Jobs"
-            end
-
-            ##
-            # Lists ExportCustomJobInstance 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 ExportCustomJobInstance 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 ExportCustomJobInstance 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 ExportCustomJobInstance 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 ExportCustomJobInstance
-            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)
-
-              ExportCustomJobPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Retrieve a single page of ExportCustomJobInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of ExportCustomJobInstance
-            def get_page(target_url)
-              response = @version.domain.request(
-                  'GET',
-                  target_url
-              )
-              ExportCustomJobPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Create the ExportCustomJobInstance
-            # @param [String] start_day The start day for the custom export specified as a
-            #   string in the format of yyyy-mm-dd
-            # @param [String] end_day The end day for the custom export specified as a string
-            #   in the format of yyyy-mm-dd. End day is inclusive and must be 2 days earlier
-            #   than the current UTC day.
-            # @param [String] friendly_name The friendly name specified when creating the job
-            # @param [String] webhook_url The optional webhook url called on completion of the
-            #   job. If this is supplied, `WebhookMethod` must also be supplied.
-            # @param [String] webhook_method This is the method used to call the webhook on
-            #   completion of the job. If this is supplied, `WebhookUrl` must also be supplied.
-            # @param [String] email The optional email to send the completion notification to
-            # @return [ExportCustomJobInstance] Created ExportCustomJobInstance
-            def create(start_day: nil, end_day: nil, friendly_name: nil, webhook_url: :unset, webhook_method: :unset, email: :unset)
-              data = Twilio::Values.of({
-                  'StartDay' => start_day,
-                  'EndDay' => end_day,
-                  'FriendlyName' => friendly_name,
-                  'WebhookUrl' => webhook_url,
-                  'WebhookMethod' => webhook_method,
-                  'Email' => email,
-              })
-
-              payload = @version.create('POST', @uri, data: data)
-
-              ExportCustomJobInstance.new(@version, payload, resource_type: @solution[:resource_type], )
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '#<Twilio.Preview.BulkExports.ExportCustomJobList>'
-            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 ExportCustomJobPage < Page
-            ##
-            # Initialize the ExportCustomJobPage
-            # @param [Version] version Version that contains the resource
-            # @param [Response] response Response from the API
-            # @param [Hash] solution Path solution for the resource
-            # @return [ExportCustomJobPage] ExportCustomJobPage
-            def initialize(version, response, solution)
-              super(version, response)
-
-              # Path Solution
-              @solution = solution
-            end
-
-            ##
-            # Build an instance of ExportCustomJobInstance
-            # @param [Hash] payload Payload response from the API
-            # @return [ExportCustomJobInstance] ExportCustomJobInstance
-            def get_instance(payload)
-              ExportCustomJobInstance.new(@version, payload, resource_type: @solution[:resource_type], )
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '<Twilio.Preview.BulkExports.ExportCustomJobPage>'
-            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 ExportCustomJobInstance < InstanceResource
-            ##
-            # Initialize the ExportCustomJobInstance
-            # @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 [ExportCustomJobInstance] ExportCustomJobInstance
-            def initialize(version, payload, resource_type: nil)
-              super(version)
-
-              # Marshaled Properties
-              @properties = {
-                  'friendly_name' => payload['friendly_name'],
-                  'resource_type' => payload['resource_type'],
-                  'start_day' => payload['start_day'],
-                  'end_day' => payload['end_day'],
-                  'webhook_url' => payload['webhook_url'],
-                  'webhook_method' => payload['webhook_method'],
-                  'email' => payload['email'],
-                  'job_sid' => payload['job_sid'],
-                  'details' => payload['details'],
-              }
-            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
-
-            ##
-            # @return [String] The start day for the custom export specified as a string in the format of yyyy-MM-dd
-            def start_day
-              @properties['start_day']
-            end
-
-            ##
-            # @return [String] The end day for the custom export specified as a string in the format of yyyy-MM-dd
-            def end_day
-              @properties['end_day']
-            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 unique job_sid returned when the custom export was created. This can be used to look up the status of the job.
-            def job_sid
-              @properties['job_sid']
-            end
-
-            ##
-            # @return [Hash] The details
-            def details
-              @properties['details']
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              "<Twilio.Preview.BulkExports.ExportCustomJobInstance>"
-            end
-
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              "<Twilio.Preview.BulkExports.ExportCustomJobInstance>"
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,249 +0,0 @@
-##
-# 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