twilio-ruby 5.28.0 → 5.29.0

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

@@ -0,0 +1,232 @@
+##
+# 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 job_sid
+            # @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 a JobInstance
+            # @return [JobInstance] Fetched JobInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              JobInstance.new(@version, payload, job_sid: @solution[:job_sid], )
+            end
+
+            ##
+            # Deletes 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 job_sid
+            # @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'],
+                  '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
+            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 url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch a JobInstance
+            # @return [JobInstance] Fetched JobInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Deletes 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

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

@@ -15,37 +15,37 @@ module Twilio
         def initialize(domain)
           super
           @version = 'marketplace'
-          @installed_add_ons = nil
           @available_add_ons = nil
+          @installed_add_ons = nil
         end
 
         ##
-        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
+        # @param [String] sid The Available Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
-        def installed_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+        def available_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @installed_add_ons ||= InstalledAddOnList.new self
+            @available_add_ons ||= AvailableAddOnList.new self
           else
-            InstalledAddOnContext.new(self, sid)
+            AvailableAddOnContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The Available Add-on Sid that uniquely identifies this
+        # @param [String] sid The Installed Add-on Sid that uniquely identifies this
         #   resource
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnContext] if sid was passed.
-        # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
-        def available_add_ons(sid=:unset)
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnContext] if sid was passed.
+        # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
+        def installed_add_ons(sid=:unset)
           if sid.nil?
             raise ArgumentError, 'sid cannot be nil'
           elsif sid == :unset
-            @available_add_ons ||= AvailableAddOnList.new self
+            @installed_add_ons ||= InstalledAddOnList.new self
           else
-            AvailableAddOnContext.new(self, sid)
+            InstalledAddOnContext.new(self, sid)
           end
         end
 

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

@@ -16,10 +16,10 @@ module Twilio
           super
           @version = 'TrustedComms'
           @branded_calls = nil
+          @cps = nil
+          @current_calls = nil
           @devices = nil
           @phone_calls = nil
-          @current_calls = nil
-          @cps = nil
         end
 
         ##
@@ -29,15 +29,9 @@ module Twilio
         end
 
         ##
-        # @return [Twilio::REST::Preview::TrustedComms::DeviceContext]
-        def devices
-          @devices ||= DeviceList.new self
-        end
-
-        ##
-        # @return [Twilio::REST::Preview::TrustedComms::PhoneCallContext]
-        def phone_calls
-          @phone_calls ||= PhoneCallList.new self
+        # @return [Twilio::REST::Preview::TrustedComms::CpsContext]
+        def cps
+          @cps ||= CpsContext.new self
         end
 
         ##
@@ -47,9 +41,15 @@ module Twilio
         end
 
         ##
-        # @return [Twilio::REST::Preview::TrustedComms::CpsContext]
-        def cps
-          @cps ||= CpsContext.new self
+        # @return [Twilio::REST::Preview::TrustedComms::DeviceContext]
+        def devices
+          @devices ||= DeviceList.new self
+        end
+
+        ##
+        # @return [Twilio::REST::Preview::TrustedComms::PhoneCallContext]
+        def phone_calls
+          @phone_calls ||= PhoneCallList.new self
         end
 
         ##

data/lib/twilio-ruby/rest/preview/trusted_comms/branded_call.rb

@@ -29,11 +29,11 @@ module Twilio
           # Retrieve a single page of BrandedCallInstance records from the API.
           # Request is executed immediately.
           # @param [String] from The phone number to use as the caller id, given in [E.164
-          #   format](https://en.wikipedia.org/wiki/E.164). It must be a Twilio number that
-          #   has been set up as a Branded Number in the Business Profile section for your
-          #   account.
+          #   format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio
+          #   number that has been set up as a Branded Number in the Business Profile section
+          #   for your account.
           # @param [String] to The terminating Phone Number, given in [E.164
-          #   format](https://en.wikipedia.org/wiki/E.164).
+          #   format](https://www.twilio.com/docs/glossary/what-e164).
           # @param [String] reason The business reason for this phone call that will appear
           #   in the terminating device's screen. Max 50 characters.
           # @param [String] call_sid The Call sid this Branded Call should link to.
@@ -103,11 +103,16 @@ module Twilio
             @properties = {
                 'account_sid' => payload['account_sid'],
                 'bg_color' => payload['bg_color'],
+                'brand_sid' => payload['brand_sid'],
+                'branded_channel_sid' => payload['branded_channel_sid'],
+                'business_sid' => payload['business_sid'],
+                'call_sid' => payload['call_sid'],
                 'caller' => payload['caller'],
                 'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
                 'font_color' => payload['font_color'],
                 'from' => payload['from'],
                 'logo' => payload['logo'],
+                'phone_number_sid' => payload['phone_number_sid'],
                 'reason' => payload['reason'],
                 'sid' => payload['sid'],
                 'status' => payload['status'],
@@ -129,6 +134,30 @@ module Twilio
             @properties['bg_color']
           end
 
+          ##
+          # @return [String] Brand Sid.
+          def brand_sid
+            @properties['brand_sid']
+          end
+
+          ##
+          # @return [String] Branded Channel Sid.
+          def branded_channel_sid
+            @properties['branded_channel_sid']
+          end
+
+          ##
+          # @return [String] Business Sid.
+          def business_sid
+            @properties['business_sid']
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this phone call.
+          def call_sid
+            @properties['call_sid']
+          end
+
           ##
           # @return [String] Caller name of the current phone call
           def caller
@@ -159,6 +188,12 @@ module Twilio
             @properties['logo']
           end
 
+          ##
+          # @return [String] Phone Number Sid.
+          def phone_number_sid
+            @properties['phone_number_sid']
+          end
+
           ##
           # @return [String] The business reason for this current phone call
           def reason
@@ -166,7 +201,7 @@ module Twilio
           end
 
           ##
-          # @return [String] A string that uniquely identifies this current phone call.
+          # @return [String] A string that uniquely identifies this current branded phone call.
           def sid
             @properties['sid']
           end

data/lib/twilio-ruby/rest/preview/trusted_comms/cps.rb

@@ -120,8 +120,8 @@ module Twilio
 
             # Marshaled Properties
             @properties = {
-                'phone_number' => payload['phone_number'],
                 'cps_url' => payload['cps_url'],
+                'phone_number' => payload['phone_number'],
                 'url' => payload['url'],
             }
 
@@ -141,18 +141,18 @@ module Twilio
             @instance_context
           end
 
-          ##
-          # @return [String] Phone number passed.
-          def phone_number
-            @properties['phone_number']
-          end
-
           ##
           # @return [String] CPS URL of the phone number.
           def cps_url
             @properties['cps_url']
           end
 
+          ##
+          # @return [String] Phone number passed.
+          def phone_number
+            @properties['phone_number']
+          end
+
           ##
           # @return [String] The URL of this resource.
           def url