twilio-ruby 5.40.4 → 5.45.0

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

@@ -31,10 +31,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 +38,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 +53,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,18 +78,12 @@ 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,
@@ -132,18 +109,23 @@ module Twilio
 
             ##
             # Create the ExportCustomJobInstance
-            # @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
+            # @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(friendly_name: :unset, start_day: :unset, end_day: :unset, webhook_url: :unset, webhook_method: :unset, email: :unset)
+            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,
@@ -231,13 +213,13 @@ module Twilio
             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
@@ -261,7 +243,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/trusted_comms.rb

@@ -15,18 +15,24 @@ module Twilio
         def initialize(domain)
           super
           @version = 'TrustedComms'
-          @branded_calls = nil
+          @branded_channels = nil
           @brands_information = nil
-          @businesses = nil
           @cps = nil
           @current_calls = nil
-          @phone_calls = nil
         end
 
         ##
-        # @return [Twilio::REST::Preview::TrustedComms::BrandedCallContext]
-        def branded_calls
-          @branded_calls ||= BrandedCallList.new self
+        # @param [String] sid The unique SID identifier of the Branded Channel.
+        # @return [Twilio::REST::Preview::TrustedComms::BrandedChannelContext] if sid was passed.
+        # @return [Twilio::REST::Preview::TrustedComms::BrandedChannelList]
+        def branded_channels(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @branded_channels ||= BrandedChannelList.new self
+          else
+            BrandedChannelContext.new(self, sid)
+          end
         end
 
         ##
@@ -35,21 +41,6 @@ module Twilio
           @brands_information ||= BrandsInformationContext.new self
         end
 
-        ##
-        # @param [String] sid A 34 character string that uniquely identifies this
-        #   Business.
-        # @return [Twilio::REST::Preview::TrustedComms::BusinessContext] if sid was passed.
-        # @return [Twilio::REST::Preview::TrustedComms::BusinessList]
-        def businesses(sid=:unset)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @businesses ||= BusinessList.new self
-          else
-            BusinessContext.new(self, sid)
-          end
-        end
-
         ##
         # @return [Twilio::REST::Preview::TrustedComms::CpsContext]
         def cps
@@ -62,12 +53,6 @@ module Twilio
           @current_calls ||= CurrentCallContext.new self
         end
 
-        ##
-        # @return [Twilio::REST::Preview::TrustedComms::PhoneCallContext]
-        def phone_calls
-          @phone_calls ||= PhoneCallList.new self
-        end
-
         ##
         # Provide a user friendly representation
         def to_s

data/lib/twilio-ruby/rest/preview/trusted_comms/{business.rb → branded_channel.rb}

@@ -12,11 +12,11 @@ module Twilio
       class TrustedComms < Version
         ##
         # 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 BusinessList < ListResource
+        class BrandedChannelList < ListResource
           ##
-          # Initialize the BusinessList
+          # Initialize the BrandedChannelList
           # @param [Version] version Version that contains the resource
-          # @return [BusinessList] BusinessList
+          # @return [BrandedChannelList] BrandedChannelList
           def initialize(version)
             super(version)
 
@@ -27,19 +27,19 @@ module Twilio
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.TrustedComms.BusinessList>'
+            '#<Twilio.Preview.TrustedComms.BrandedChannelList>'
           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 BusinessPage < Page
+        class BrandedChannelPage < Page
           ##
-          # Initialize the BusinessPage
+          # Initialize the BrandedChannelPage
           # @param [Version] version Version that contains the resource
           # @param [Response] response Response from the API
           # @param [Hash] solution Path solution for the resource
-          # @return [BusinessPage] BusinessPage
+          # @return [BrandedChannelPage] BrandedChannelPage
           def initialize(version, response, solution)
             super(version, response)
 
@@ -48,114 +48,95 @@ module Twilio
           end
 
           ##
-          # Build an instance of BusinessInstance
+          # Build an instance of BrandedChannelInstance
           # @param [Hash] payload Payload response from the API
-          # @return [BusinessInstance] BusinessInstance
+          # @return [BrandedChannelInstance] BrandedChannelInstance
           def get_instance(payload)
-            BusinessInstance.new(@version, payload, )
+            BrandedChannelInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.TrustedComms.BusinessPage>'
+            '<Twilio.Preview.TrustedComms.BrandedChannelPage>'
           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 BusinessContext < InstanceContext
+        class BrandedChannelContext < InstanceContext
           ##
-          # Initialize the BusinessContext
+          # Initialize the BrandedChannelContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this
-          #   Business.
-          # @return [BusinessContext] BusinessContext
+          # @param [String] sid The unique SID identifier of the Branded Channel.
+          # @return [BrandedChannelContext] BrandedChannelContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
             @solution = {sid: sid, }
-            @uri = "/Businesses/#{@solution[:sid]}"
+            @uri = "/BrandedChannels/#{@solution[:sid]}"
 
             # Dependents
-            @brands = nil
-            @insights = nil
+            @channels = nil
           end
 
           ##
-          # Fetch the BusinessInstance
-          # @return [BusinessInstance] Fetched BusinessInstance
+          # Fetch the BrandedChannelInstance
+          # @return [BrandedChannelInstance] Fetched BrandedChannelInstance
           def fetch
             payload = @version.fetch('GET', @uri)
 
-            BusinessInstance.new(@version, payload, sid: @solution[:sid], )
+            BrandedChannelInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Access the brands
-          # @return [BrandList]
-          # @return [BrandContext] if sid was passed.
-          def brands(sid=:unset)
-            raise ArgumentError, 'sid cannot be nil' if sid.nil?
-
-            if sid != :unset
-              return BrandContext.new(@version, @solution[:sid], sid, )
-            end
-
-            unless @brands
-              @brands = BrandList.new(@version, business_sid: @solution[:sid], )
-            end
-
-            @brands
-          end
-
-          ##
-          # Access the insights
-          # @return [InsightsList]
-          # @return [InsightsContext]
-          def insights
-            unless @insights
-              @insights = InsightsList.new(@version, business_sid: @solution[:sid], )
+          # Access the channels
+          # @return [ChannelList]
+          # @return [ChannelContext]
+          def channels
+            unless @channels
+              @channels = ChannelList.new(@version, branded_channel_sid: @solution[:sid], )
             end
 
-            @insights
+            @channels
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.TrustedComms.BusinessContext #{context}>"
+            "#<Twilio.Preview.TrustedComms.BrandedChannelContext #{context}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.TrustedComms.BusinessContext #{context}>"
+            "#<Twilio.Preview.TrustedComms.BrandedChannelContext #{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 BusinessInstance < InstanceResource
+        class BrandedChannelInstance < InstanceResource
           ##
-          # Initialize the BusinessInstance
+          # Initialize the BrandedChannelInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid A 34 character string that uniquely identifies this
-          #   Business.
-          # @return [BusinessInstance] BusinessInstance
+          # @param [String] sid The unique SID identifier of the Branded Channel.
+          # @return [BrandedChannelInstance] BrandedChannelInstance
           def initialize(version, payload, sid: nil)
             super(version)
 
             # Marshaled Properties
             @properties = {
                 'account_sid' => payload['account_sid'],
+                'business_sid' => payload['business_sid'],
+                'brand_sid' => payload['brand_sid'],
                 'sid' => payload['sid'],
-                'url' => payload['url'],
                 'links' => payload['links'],
+                'url' => payload['url'],
             }
 
             # Context
@@ -166,10 +147,10 @@ module Twilio
           ##
           # Generate an instance context for the instance, the context is capable of
           # performing various actions.  All instance actions are proxied to the context
-          # @return [BusinessContext] BusinessContext for this BusinessInstance
+          # @return [BrandedChannelContext] BrandedChannelContext for this BrandedChannelInstance
           def context
             unless @instance_context
-              @instance_context = BusinessContext.new(@version, @params['sid'], )
+              @instance_context = BrandedChannelContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
@@ -181,15 +162,21 @@ module Twilio
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Business.
-          def sid
-            @properties['sid']
+          # @return [String] Business Sid.
+          def business_sid
+            @properties['business_sid']
           end
 
           ##
-          # @return [String] The URL of this resource.
-          def url
-            @properties['url']
+          # @return [String] Brand Sid.
+          def brand_sid
+            @properties['brand_sid']
+          end
+
+          ##
+          # @return [String] Branded Channel Sid.
+          def sid
+            @properties['sid']
           end
 
           ##
@@ -199,38 +186,37 @@ module Twilio
           end
 
           ##
-          # Fetch the BusinessInstance
-          # @return [BusinessInstance] Fetched BusinessInstance
-          def fetch
-            context.fetch
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
           end
 
           ##
-          # Access the brands
-          # @return [brands] brands
-          def brands
-            context.brands
+          # Fetch the BrandedChannelInstance
+          # @return [BrandedChannelInstance] Fetched BrandedChannelInstance
+          def fetch
+            context.fetch
           end
 
           ##
-          # Access the insights
-          # @return [insights] insights
-          def insights
-            context.insights
+          # Access the channels
+          # @return [channels] channels
+          def channels
+            context.channels
           end
 
           ##
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.TrustedComms.BusinessInstance #{values}>"
+            "<Twilio.Preview.TrustedComms.BrandedChannelInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.TrustedComms.BusinessInstance #{values}>"
+            "<Twilio.Preview.TrustedComms.BrandedChannelInstance #{values}>"
           end
         end
       end