twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -20,6 +22,25 @@ module Twilio
 
             # 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
 
           ##
@@ -50,7 +71,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [ExportInstance] ExportInstance
           def get_instance(payload)
-            ExportInstance.new(@version, payload)
+            ExportInstance.new(@version, payload, )
           end
 
           ##
@@ -66,52 +87,73 @@ module Twilio
           ##
           # Initialize the ExportContext
           # @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 [ExportContext] ExportContext
           def initialize(version, resource_type)
             super(version)
 
             # Path Solution
-            @solution = {resource_type: resource_type}
+            @solution = {resource_type: resource_type, }
             @uri = "/Exports/#{@solution[:resource_type]}"
 
             # Dependents
             @days = nil
+            @export_custom_jobs = nil
           end
 
           ##
-          # Fetch a ExportInstance
+          # Fetch the ExportInstance
           # @return [ExportInstance] Fetched ExportInstance
           def fetch
-            params = Twilio::Values.of({})
+            payload = @version.fetch('GET', @uri)
 
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            ExportInstance.new(@version, payload, resource_type: @solution[:resource_type])
+            ExportInstance.new(@version, payload, resource_type: @solution[:resource_type], )
           end
 
           ##
           # Access the days
           # @return [DayList]
-          # @return [DayContext]
-          def days
+          # @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])
+              @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.Preview.BulkExports.ExportContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.BulkExports.ExportContext #{context}>"
+          end
         end
 
         ##
@@ -121,7 +163,8 @@ module Twilio
           # 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 resource_type
+          # @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)
@@ -135,7 +178,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'resource_type' => resource_type || @properties['resource_type']}
+            @params = {'resource_type' => resource_type || @properties['resource_type'], }
           end
 
           ##
@@ -144,31 +187,31 @@ module Twilio
           # @return [ExportContext] ExportContext for this ExportInstance
           def context
             unless @instance_context
-              @instance_context = ExportContext.new(@version, @params['resource_type'])
+              @instance_context = ExportContext.new(@version, @params['resource_type'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The resource_type
+          # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
           def resource_type
             @properties['resource_type']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a ExportInstance
+          # Fetch the ExportInstance
           # @return [ExportInstance] Fetched ExportInstance
           def fetch
             context.fetch
@@ -181,6 +224,13 @@ module Twilio
             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

data/lib/twilio-ruby/rest/preview/bulk_exports/export_configuration.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -50,7 +52,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [ExportConfigurationInstance] ExportConfigurationInstance
           def get_instance(payload)
-            ExportConfigurationInstance.new(@version, payload)
+            ExportConfigurationInstance.new(@version, payload, )
           end
 
           ##
@@ -66,36 +68,35 @@ module Twilio
           ##
           # Initialize the ExportConfigurationContext
           # @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 [ExportConfigurationContext] ExportConfigurationContext
           def initialize(version, resource_type)
             super(version)
 
             # Path Solution
-            @solution = {resource_type: resource_type}
+            @solution = {resource_type: resource_type, }
             @uri = "/Exports/#{@solution[:resource_type]}/Configuration"
           end
 
           ##
-          # Fetch a ExportConfigurationInstance
+          # Fetch the ExportConfigurationInstance
           # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
           def fetch
-            params = Twilio::Values.of({})
+            payload = @version.fetch('GET', @uri)
 
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type])
+            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
           end
 
           ##
           # Update the ExportConfigurationInstance
-          # @param [Boolean] enabled The enabled
-          # @param [String] webhook_url The webhook_url
-          # @param [String] webhook_method The webhook_method
+          # @param [Boolean] enabled If true, Twilio will automatically generate every day's
+          #   file when the day is over.
+          # @param [String] webhook_url Stores the URL destination for the method specified
+          #   in webhook_method.
+          # @param [String] webhook_method Sets whether Twilio should call a webhook URL
+          #   when the automatic generation is complete, using GET or POST. The actual
+          #   destination is set in the webhook_url
           # @return [ExportConfigurationInstance] Updated ExportConfigurationInstance
           def update(enabled: :unset, webhook_url: :unset, webhook_method: :unset)
             data = Twilio::Values.of({
@@ -104,13 +105,9 @@ module Twilio
                 'WebhookMethod' => webhook_method,
             })
 
-            payload = @version.update(
-                'POST',
-                @uri,
-                data: data,
-            )
+            payload = @version.update('POST', @uri, data: data)
 
-            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type])
+            ExportConfigurationInstance.new(@version, payload, resource_type: @solution[:resource_type], )
           end
 
           ##
@@ -119,6 +116,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Preview.BulkExports.ExportConfigurationContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Preview.BulkExports.ExportConfigurationContext #{context}>"
+          end
         end
 
         ##
@@ -128,7 +132,8 @@ module Twilio
           # Initialize the ExportConfigurationInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] resource_type The resource_type
+          # @param [String] resource_type The type of communication – Messages, Calls,
+          #   Conferences, and Participants
           # @return [ExportConfigurationInstance] ExportConfigurationInstance
           def initialize(version, payload, resource_type: nil)
             super(version)
@@ -144,7 +149,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'resource_type' => resource_type || @properties['resource_type']}
+            @params = {'resource_type' => resource_type || @properties['resource_type'], }
           end
 
           ##
@@ -153,43 +158,43 @@ module Twilio
           # @return [ExportConfigurationContext] ExportConfigurationContext for this ExportConfigurationInstance
           def context
             unless @instance_context
-              @instance_context = ExportConfigurationContext.new(@version, @params['resource_type'])
+              @instance_context = ExportConfigurationContext.new(@version, @params['resource_type'], )
             end
             @instance_context
           end
 
           ##
-          # @return [Boolean] The enabled
+          # @return [Boolean] Whether files are automatically generated
           def enabled
             @properties['enabled']
           end
 
           ##
-          # @return [String] The webhook_url
+          # @return [String] URL targeted at export
           def webhook_url
             @properties['webhook_url']
           end
 
           ##
-          # @return [String] The webhook_method
+          # @return [String] Whether to GET or POST to the webhook url
           def webhook_method
             @properties['webhook_method']
           end
 
           ##
-          # @return [String] The resource_type
+          # @return [String] The type of communication – Messages, Calls, Conferences, and Participants
           def resource_type
             @properties['resource_type']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a ExportConfigurationInstance
+          # Fetch the ExportConfigurationInstance
           # @return [ExportConfigurationInstance] Fetched ExportConfigurationInstance
           def fetch
             context.fetch
@@ -197,12 +202,16 @@ module Twilio
 
           ##
           # Update the ExportConfigurationInstance
-          # @param [Boolean] enabled The enabled
-          # @param [String] webhook_url The webhook_url
-          # @param [String] webhook_method The webhook_method
+          # @param [Boolean] enabled If true, Twilio will automatically generate every day's
+          #   file when the day is over.
+          # @param [String] webhook_url Stores the URL destination for the method specified
+          #   in webhook_method.
+          # @param [String] webhook_method Sets whether Twilio should call a webhook URL
+          #   when the automatic generation is complete, using GET or POST. The actual
+          #   destination is set in the webhook_url
           # @return [ExportConfigurationInstance] Updated ExportConfigurationInstance
           def update(enabled: :unset, webhook_url: :unset, webhook_method: :unset)
-            context.update(enabled: enabled, webhook_url: webhook_url, webhook_method: webhook_method)
+            context.update(enabled: enabled, webhook_url: webhook_url, webhook_method: webhook_method, )
           end
 
           ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -18,30 +20,34 @@ module Twilio
         end
 
         ##
-        # @param [String] resource_type The resource_type
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
         # @return [Twilio::REST::Preview::BulkExports::ExportContext] if resource_type was passed.
         # @return [Twilio::REST::Preview::BulkExports::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
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @exports ||= ExportList.new self
           else
-            ExportContext.new(self, resource_type)
+              ExportContext.new(self, resource_type)
           end
         end
 
         ##
-        # @param [String] resource_type The resource_type
+        # @param [String] resource_type The type of communication – Messages, Calls,
+        #   Conferences, and Participants
         # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationContext] if resource_type was passed.
         # @return [Twilio::REST::Preview::BulkExports::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
+              raise ArgumentError, 'resource_type cannot be nil'
+          end
+          if resource_type == :unset
+              @export_configuration ||= ExportConfigurationList.new self
           else
-            ExportConfigurationContext.new(self, resource_type)
+              ExportConfigurationContext.new(self, resource_type)
           end
         end
 

data/lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,15 +29,14 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of CertificateInstance records from the API.
-            # Request is executed immediately.
+            # Create the CertificateInstance
             # @param [String] certificate_data Provides a URL encoded representation of the
             #   public certificate in PEM format.
             # @param [String] friendly_name Provides a human readable descriptive text for
             #   this Certificate credential, up to 256 characters long.
             # @param [String] device_sid Provides the unique string identifier of an existing
             #   Device to become authenticated with this Certificate credential.
-            # @return [CertificateInstance] Newly created CertificateInstance
+            # @return [CertificateInstance] Created CertificateInstance
             def create(certificate_data: nil, friendly_name: :unset, device_sid: :unset)
               data = Twilio::Values.of({
                   'CertificateData' => certificate_data,
@@ -43,13 +44,9 @@ module Twilio
                   'DeviceSid' => device_sid,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid])
+              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], )
             end
 
             ##
@@ -85,7 +82,7 @@ module Twilio
             def stream(device_sid: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(device_sid: device_sid, page_size: limits[:page_size])
+              page = self.page(device_sid: device_sid, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -97,7 +94,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -120,11 +117,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               CertificatePage.new(@version, response, @solution)
             end
 
@@ -169,7 +164,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [CertificateInstance] CertificateInstance
             def get_instance(payload)
-              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid])
+              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], )
             end
 
             ##
@@ -193,30 +188,24 @@ module Twilio
               super(version)
 
               # Path Solution
-              @solution = {fleet_sid: fleet_sid, sid: sid}
+              @solution = {fleet_sid: fleet_sid, sid: sid, }
               @uri = "/Fleets/#{@solution[:fleet_sid]}/Certificates/#{@solution[:sid]}"
             end
 
             ##
-            # Fetch a CertificateInstance
+            # Fetch the CertificateInstance
             # @return [CertificateInstance] Fetched CertificateInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
-              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], sid: @solution[:sid])
+              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the CertificateInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the CertificateInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -227,15 +216,11 @@ module Twilio
             #   Device to become authenticated with this Certificate credential.
             # @return [CertificateInstance] Updated CertificateInstance
             def update(friendly_name: :unset, device_sid: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'DeviceSid' => device_sid})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'DeviceSid' => device_sid, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], sid: @solution[:sid])
+              CertificateInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -244,6 +229,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Preview.DeployedDevices.CertificateContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.DeployedDevices.CertificateContext #{context}>"
+            end
           end
 
           ##
@@ -276,7 +268,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'fleet_sid' => fleet_sid, 'sid' => sid || @properties['sid']}
+              @params = {'fleet_sid' => fleet_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -285,7 +277,7 @@ module Twilio
             # @return [CertificateContext] CertificateContext for this CertificateInstance
             def context
               unless @instance_context
-                @instance_context = CertificateContext.new(@version, @params['fleet_sid'], @params['sid'])
+                @instance_context = CertificateContext.new(@version, @params['fleet_sid'], @params['sid'], )
               end
               @instance_context
             end
@@ -345,15 +337,15 @@ module Twilio
             end
 
             ##
-            # Fetch a CertificateInstance
+            # Fetch the CertificateInstance
             # @return [CertificateInstance] Fetched CertificateInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the CertificateInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the CertificateInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -366,7 +358,7 @@ module Twilio
             #   Device to become authenticated with this Certificate credential.
             # @return [CertificateInstance] Updated CertificateInstance
             def update(friendly_name: :unset, device_sid: :unset)
-              context.update(friendly_name: friendly_name, device_sid: device_sid)
+              context.update(friendly_name: friendly_name, device_sid: device_sid, )
             end
 
             ##