twilio-ruby 5.31.1 → 5.54.0

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

@@ -17,7 +17,8 @@ module Twilio
             ##
             # Initialize the DayList
             # @param [Version] version Version that contains the resource
-            # @param [String] resource_type The resource_type
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
             # @return [DayList] DayList
             def initialize(version, resource_type: nil)
               super(version)
@@ -88,11 +89,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               DayPage.new(@version, response, @solution)
             end
 
@@ -147,6 +146,49 @@ module Twilio
             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 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.Preview.BulkExports.DayContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.BulkExports.DayContext #{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 DayInstance < InstanceResource
@@ -154,9 +196,12 @@ module Twilio
             # 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 resource_type
+            # @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)
+            def initialize(version, payload, resource_type: nil, day: nil)
               super(version)
 
               # Marshaled Properties
@@ -164,8 +209,25 @@ module Twilio
                   '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
 
             ##
@@ -175,33 +237,54 @@ module Twilio
             end
 
             ##
-            # @return [String] The day
+            # @return [String] The date of the data in the file
             def day
               @properties['day']
             end
 
             ##
-            # @return [String] The size
+            # @return [String] Size of the file in bytes
             def size
               @properties['size']
             end
 
             ##
-            # @return [String] The resource_type
+            # @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
-              "<Twilio.Preview.BulkExports.DayInstance>"
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.BulkExports.DayInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Preview.BulkExports.DayInstance>"
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.BulkExports.DayInstance #{values}>"
             end
           end
         end

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

@@ -17,7 +17,8 @@ module Twilio
             ##
             # Initialize the ExportCustomJobList
             # @param [Version] version Version that contains the resource
-            # @param [String] resource_type The type of communication – Messages, Calls
+            # @param [String] resource_type The type of communication – Messages, Calls,
+            #   Conferences, and Participants
             # @return [ExportCustomJobList] ExportCustomJobList
             def initialize(version, resource_type: nil)
               super(version)
@@ -31,10 +32,6 @@ module Twilio
             # 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 [String] next_token The token for the next page of job results, and may
-            #   be null if there are no more pages
-            # @param [String] previous_token The token for the previous page of results, and
-            #   may be null if this is the first page
             # @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
@@ -42,23 +39,14 @@ module Twilio
             #    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(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
-              self.stream(
-                  next_token: next_token,
-                  previous_token: previous_token,
-                  limit: limit,
-                  page_size: page_size
-              ).entries
+            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 [String] next_token The token for the next page of job results, and may
-            #   be null if there are no more pages
-            # @param [String] previous_token The token for the previous page of results, and
-            #   may be null if this is the first page
             # @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
@@ -66,14 +54,10 @@ module Twilio
             #    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(next_token: :unset, previous_token: :unset, limit: nil, page_size: nil)
+            def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(
-                  next_token: next_token,
-                  previous_token: previous_token,
-                  page_size: limits[:page_size],
-              )
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -95,27 +79,19 @@ module Twilio
             ##
             # Retrieve a single page of ExportCustomJobInstance records from the API.
             # Request is executed immediately.
-            # @param [String] next_token The token for the next page of job results, and may
-            #   be null if there are no more pages
-            # @param [String] previous_token The token for the previous page of results, and
-            #   may be null if this is the first page
             # @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(next_token: :unset, previous_token: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
-                  'NextToken' => next_token,
-                  'PreviousToken' => previous_token,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ExportCustomJobPage.new(@version, response, @solution)
             end
 
@@ -133,30 +109,30 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ExportCustomJobInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] start_day The start_day
-            # @param [String] end_day The end_day
-            # @param [String] webhook_url The webhook_url
-            # @param [String] webhook_method The webhook_method
-            # @param [String] email The email
-            # @return [ExportCustomJobInstance] Newly created ExportCustomJobInstance
-            def create(friendly_name: :unset, start_day: :unset, end_day: :unset, webhook_url: :unset, webhook_method: :unset, email: :unset)
+            # 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({
-                  'FriendlyName' => friendly_name,
                   'StartDay' => start_day,
                   'EndDay' => end_day,
+                  'FriendlyName' => friendly_name,
                   'WebhookUrl' => webhook_url,
                   'WebhookMethod' => webhook_method,
                   'Email' => email,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ExportCustomJobInstance.new(@version, payload, resource_type: @solution[:resource_type], )
             end
@@ -206,7 +182,8 @@ module Twilio
             # 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
+            # @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)
@@ -232,19 +209,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The type of communication – Messages, Calls
+            # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
             def resource_type
               @properties['resource_type']
             end
 
             ##
-            # @return [String] The start time for the export specified when creating the job
+            # @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 time for the export specified when creating the job
+            # @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
@@ -268,7 +245,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The job_sid returned when the export was created
+            # @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

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

@@ -69,7 +69,8 @@ module Twilio
             ##
             # Initialize the JobContext
             # @param [Version] version Version that contains the resource
-            # @param [String] job_sid The job_sid
+            # @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)
@@ -80,25 +81,19 @@ module Twilio
             end
 
             ##
-            # Fetch a JobInstance
+            # Fetch the JobInstance
             # @return [JobInstance] Fetched JobInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               JobInstance.new(@version, payload, job_sid: @solution[:job_sid], )
             end
 
             ##
-            # Deletes the JobInstance
+            # Delete the JobInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -123,7 +118,8 @@ module Twilio
             # Initialize the JobInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] job_sid The job_sid
+            # @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)
@@ -136,6 +132,9 @@ module Twilio
                   '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'],
               }
 
@@ -156,7 +155,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The type of communication – Messages, Calls
+            # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
             def resource_type
               @properties['resource_type']
             end
@@ -191,6 +190,24 @@ module Twilio
               @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
@@ -198,14 +215,14 @@ module Twilio
             end
 
             ##
-            # Fetch a JobInstance
+            # Fetch the JobInstance
             # @return [JobInstance] Fetched JobInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the JobInstance
+            # Delete the JobInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete