twilio-ruby 5.40.3 → 5.44.0

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

@@ -31,8 +31,6 @@ module Twilio
             # Lists DayInstance 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 next_token
-            # @param [String] previous_token The previous_token
             # @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
@@ -40,21 +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 DayInstance 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 next_token
-            # @param [String] previous_token The previous_token
             # @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
@@ -62,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
@@ -91,16 +78,12 @@ module Twilio
             ##
             # Retrieve a single page of DayInstance records from the API.
             # Request is executed immediately.
-            # @param [String] next_token The next_token
-            # @param [String] previous_token The previous_token
             # @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 DayInstance
-            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,

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/hosted_numbers/authorization_document.rb

@@ -33,8 +33,8 @@ module Twilio
           #   signing.
           # @param [authorization_document.Status] status Status of an instance resource. It
           #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
-          #   failed. See the section entitled [Status
-          #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
           #   for more information on each of these statuses.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit.  Default is no limit
@@ -55,8 +55,8 @@ module Twilio
           #   signing.
           # @param [authorization_document.Status] status Status of an instance resource. It
           #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
-          #   failed. See the section entitled [Status
-          #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
           #   for more information on each of these statuses.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit. Default is no limit.
@@ -94,8 +94,8 @@ module Twilio
           #   signing.
           # @param [authorization_document.Status] status Status of an instance resource. It
           #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
-          #   failed. See the section entitled [Status
-          #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
           #   for more information on each of these statuses.
           # @param [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
@@ -239,8 +239,8 @@ module Twilio
           #   Authorization Document has been sent and signed
           # @param [authorization_document.Status] status Status of an instance resource. It
           #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
-          #   failed. See the section entitled [Status
-          #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
           #   for more information on each of these statuses.
           # @param [String] contact_title The title of the person authorized to sign the
           #   Authorization Document for this phone number.
@@ -409,8 +409,8 @@ module Twilio
           #   Authorization Document has been sent and signed
           # @param [authorization_document.Status] status Status of an instance resource. It
           #   can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5.
-          #   failed. See the section entitled [Status
-          #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+          #   failed. See the section entitled {Status
+          #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
           #   for more information on each of these statuses.
           # @param [String] contact_title The title of the person authorized to sign the
           #   Authorization Document for this phone number.

data/lib/twilio-ruby/rest/preview/hosted_numbers/authorization_document/dependent_hosted_number_order.rb

@@ -34,8 +34,8 @@ module Twilio
             # memory before returning.
             # @param [dependent_hosted_number_order.Status] status Status of an instance
             #   resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4.
-            #   canceled, 5. failed. See the section entitled [Status
-            #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+            #   canceled, 5. failed. See the section entitled {Status
+            #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
             #   for more information on each of these statuses.
             # @param [String] phone_number An E164 formatted phone number hosted by this
             #   HostedNumberOrder.
@@ -71,8 +71,8 @@ module Twilio
             # is reached.
             # @param [dependent_hosted_number_order.Status] status Status of an instance
             #   resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4.
-            #   canceled, 5. failed. See the section entitled [Status
-            #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+            #   canceled, 5. failed. See the section entitled {Status
+            #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
             #   for more information on each of these statuses.
             # @param [String] phone_number An E164 formatted phone number hosted by this
             #   HostedNumberOrder.
@@ -124,8 +124,8 @@ module Twilio
             # Request is executed immediately.
             # @param [dependent_hosted_number_order.Status] status Status of an instance
             #   resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4.
-            #   canceled, 5. failed. See the section entitled [Status
-            #   Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values)
+            #   canceled, 5. failed. See the section entitled {Status
+            #   Values}[https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values]
             #   for more information on each of these statuses.
             # @param [String] phone_number An E164 formatted phone number hosted by this
             #   HostedNumberOrder.

data/lib/twilio-ruby/rest/preview/hosted_numbers/hosted_number_order.rb

@@ -164,7 +164,7 @@ module Twilio
           ##
           # Create the HostedNumberOrderInstance
           # @param [String] phone_number The number to host in
-          #   [+E.164](https://en.wikipedia.org/wiki/E.164) format
+          #   {+E.164}[https://en.wikipedia.org/wiki/E.164] format
           # @param [Boolean] sms_capability Used to specify that the SMS capability will be
           #   hosted on Twilio's platform.
           # @param [String] account_sid This defaults to the AccountSid of the authorization

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

@@ -16,6 +16,7 @@ module Twilio
           super
           @version = 'TrustedComms'
           @branded_calls = nil
+          @branded_channels = nil
           @brands_information = nil
           @businesses = nil
           @cps = nil
@@ -29,6 +30,20 @@ module Twilio
           @branded_calls ||= BrandedCallList.new self
         end
 
+        ##
+        # @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
+
         ##
         # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationContext]
         def brands_information

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

@@ -27,12 +27,12 @@ module Twilio
 
           ##
           # Create the BrandedCallInstance
-          # @param [String] from The phone number to use as the caller id, given in [E.164
-          #   format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio
+          # @param [String] from The phone number to use as the caller id, given in {E.164
+          #   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://www.twilio.com/docs/glossary/what-e164).
+          # @param [String] to The terminating Phone Number, given in {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.

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

@@ -0,0 +1,225 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      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 BrandedChannelList < ListResource
+          ##
+          # Initialize the BrandedChannelList
+          # @param [Version] version Version that contains the resource
+          # @return [BrandedChannelList] BrandedChannelList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<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 BrandedChannelPage < Page
+          ##
+          # 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 [BrandedChannelPage] BrandedChannelPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandedChannelInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandedChannelInstance] BrandedChannelInstance
+          def get_instance(payload)
+            BrandedChannelInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<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 BrandedChannelContext < InstanceContext
+          ##
+          # Initialize the BrandedChannelContext
+          # @param [Version] version Version that contains the resource
+          # @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 = "/BrandedChannels/#{@solution[:sid]}"
+
+            # Dependents
+            @channels = nil
+          end
+
+          ##
+          # Fetch the BrandedChannelInstance
+          # @return [BrandedChannelInstance] Fetched BrandedChannelInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            BrandedChannelInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the channels
+          # @return [ChannelList]
+          # @return [ChannelContext]
+          def channels
+            unless @channels
+              @channels = ChannelList.new(@version, branded_channel_sid: @solution[:sid], )
+            end
+
+            @channels
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<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.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 BrandedChannelInstance < InstanceResource
+          ##
+          # Initialize the BrandedChannelInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @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'],
+                'links' => payload['links'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['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 [BrandedChannelContext] BrandedChannelContext for this BrandedChannelInstance
+          def context
+            unless @instance_context
+              @instance_context = BrandedChannelContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Account Sid.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] Business Sid.
+          def business_sid
+            @properties['business_sid']
+          end
+
+          ##
+          # @return [String] Brand Sid.
+          def brand_sid
+            @properties['brand_sid']
+          end
+
+          ##
+          # @return [String] Branded Channel Sid.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Nested resource URLs.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # @return [String] The URL of this resource.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the BrandedChannelInstance
+          # @return [BrandedChannelInstance] Fetched BrandedChannelInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # 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.BrandedChannelInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Preview.TrustedComms.BrandedChannelInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end