twilio-ruby 5.12.4 → 5.13.0

data/lib/twilio-ruby/rest/preview/permissions/voice_permission/country/highrisk_special_prefix.rb

@@ -0,0 +1,192 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Permissions < Version
+        class VoicePermissionList < ListResource
+          class CountryContext < InstanceContext
+            ##
+            # 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 HighriskSpecialPrefixList < ListResource
+              ##
+              # Initialize the HighriskSpecialPrefixList
+              # @param [Version] version Version that contains the resource
+              # @param [String] parent_iso_code The [ISO country
+              #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+              # @return [HighriskSpecialPrefixList] HighriskSpecialPrefixList
+              def initialize(version, parent_iso_code: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {parent_iso_code: parent_iso_code}
+                @uri = "/VoicePermissions/Countries/#{@solution[:parent_iso_code]}/HighRiskSpecialPrefixes"
+              end
+
+              ##
+              # Lists HighriskSpecialPrefixInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @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
+              #    not set will use the default value of 50 records.  If no page_size is defined
+              #    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(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
+              end
+
+              ##
+              # Streams HighriskSpecialPrefixInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @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
+              #    not set will use the default value of 50 records. If no page_size is defined
+              #    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(limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields HighriskSpecialPrefixInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              def each
+                limits = @version.read_limits
+
+                page = self.page(page_size: limits[:page_size], )
+
+                @version.stream(page,
+                                limit: limits[:limit],
+                                page_limit: limits[:page_limit]).each {|x| yield x}
+              end
+
+              ##
+              # Retrieve a single page of HighriskSpecialPrefixInstance records from the API.
+              # Request is executed immediately.
+              # @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 HighriskSpecialPrefixInstance
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                params = Twilio::Values.of({
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                })
+                response = @version.page(
+                    'GET',
+                    @uri,
+                    params
+                )
+                HighriskSpecialPrefixPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of HighriskSpecialPrefixInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of HighriskSpecialPrefixInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                HighriskSpecialPrefixPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Preview.Permissions.HighriskSpecialPrefixList>'
+              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 HighriskSpecialPrefixPage < Page
+              ##
+              # Initialize the HighriskSpecialPrefixPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [HighriskSpecialPrefixPage] HighriskSpecialPrefixPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of HighriskSpecialPrefixInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [HighriskSpecialPrefixInstance] HighriskSpecialPrefixInstance
+              def get_instance(payload)
+                HighriskSpecialPrefixInstance.new(@version, payload, parent_iso_code: @solution[:parent_iso_code], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Preview.Permissions.HighriskSpecialPrefixPage>'
+              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 HighriskSpecialPrefixInstance < InstanceResource
+              ##
+              # Initialize the HighriskSpecialPrefixInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] parent_iso_code The [ISO country
+              #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+              # @return [HighriskSpecialPrefixInstance] HighriskSpecialPrefixInstance
+              def initialize(version, payload, parent_iso_code: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {'prefix' => payload['prefix'], }
+              end
+
+              ##
+              # @return [String] prefix string of phone number
+              def prefix
+                @properties['prefix']
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                "<Twilio.Preview.Permissions.HighriskSpecialPrefixInstance>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                "<Twilio.Preview.Permissions.HighriskSpecialPrefixInstance>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/permissions/voice_permission/settings.rb

@@ -0,0 +1,197 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Permissions < Version
+        class VoicePermissionList < 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 SettingsList < ListResource
+            ##
+            # Initialize the SettingsList
+            # @param [Version] version Version that contains the resource
+            # @return [SettingsList] SettingsList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Preview.Permissions.SettingsList>'
+            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 SettingsPage < Page
+            ##
+            # Initialize the SettingsPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SettingsPage] SettingsPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SettingsInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SettingsInstance] SettingsInstance
+            def get_instance(payload)
+              SettingsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Preview.Permissions.SettingsPage>'
+            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 SettingsContext < InstanceContext
+            ##
+            # Initialize the SettingsContext
+            # @param [Version] version Version that contains the resource
+            # @return [SettingsContext] SettingsContext
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/VoicePermissions/Settings"
+            end
+
+            ##
+            # Fetch a SettingsInstance
+            # @return [SettingsInstance] Fetched SettingsInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              SettingsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Update the SettingsInstance
+            # @param [Boolean] inheritance Set true to enable inheritance of outbound voice
+            #   permissions and blocklist, false to disable
+            # @return [SettingsInstance] Updated SettingsInstance
+            def update(inheritance: :unset)
+              data = Twilio::Values.of({'Inheritance' => inheritance, })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              SettingsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Preview.Permissions.SettingsContext #{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 SettingsInstance < InstanceResource
+            ##
+            # Initialize the SettingsInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @return [SettingsInstance] SettingsInstance
+            def initialize(version, payload)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {'inheritance' => payload['inheritance'], 'url' => payload['url'], }
+
+              # Context
+              @instance_context = nil
+              @params = {}
+            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 [SettingsContext] SettingsContext for this SettingsInstance
+            def context
+              unless @instance_context
+                @instance_context = SettingsContext.new(@version, )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [Boolean] The status of  inheritance of outbound voice permissions and blocklist
+            def inheritance
+              @properties['inheritance']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch a SettingsInstance
+            # @return [SettingsInstance] Fetched SettingsInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the SettingsInstance
+            # @param [Boolean] inheritance Set true to enable inheritance of outbound voice
+            #   permissions and blocklist, false to disable
+            # @return [SettingsInstance] Updated SettingsInstance
+            def update(inheritance: :unset)
+              context.update(inheritance: inheritance, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.Permissions.SettingsInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Preview.Permissions.SettingsInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview/understand/assistant.rb

@@ -120,8 +120,10 @@ module Twilio
           #   resource as an alternative to the sid. Unique up to 64 characters long.
           # @param [String] callback_url The callback_url
           # @param [String] callback_events The callback_events
-          # @param [Hash] fallback_actions The fallback_actions
-          # @param [Hash] initiation_actions The initiation_actions
+          # @param [Hash] fallback_actions The JSON actions to be executed when the user's
+          #   input is not recognized as matching any Intent.
+          # @param [Hash] initiation_actions The JSON actions to be executed on inbound
+          #   phone calls when the Assistant has to say something first.
           # @return [AssistantInstance] Newly created AssistantInstance
           def create(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset)
             data = Twilio::Values.of({
@@ -233,8 +235,10 @@ module Twilio
           #   resource as an alternative to the sid. Unique up to 64 characters long.
           # @param [String] callback_url The callback_url
           # @param [String] callback_events The callback_events
-          # @param [Hash] fallback_actions The fallback_actions
-          # @param [Hash] initiation_actions The initiation_actions
+          # @param [Hash] fallback_actions The JSON actions to be executed when the user's
+          #   input is not recognized as matching any Intent.
+          # @param [Hash] initiation_actions The JSON actions to be executed on inbound
+          #   phone calls when the Assistant has to say something first.
           # @return [AssistantInstance] Updated AssistantInstance
           def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset)
             data = Twilio::Values.of({
@@ -512,8 +516,10 @@ module Twilio
           #   resource as an alternative to the sid. Unique up to 64 characters long.
           # @param [String] callback_url The callback_url
           # @param [String] callback_events The callback_events
-          # @param [Hash] fallback_actions The fallback_actions
-          # @param [Hash] initiation_actions The initiation_actions
+          # @param [Hash] fallback_actions The JSON actions to be executed when the user's
+          #   input is not recognized as matching any Intent.
+          # @param [Hash] initiation_actions The JSON actions to be executed on inbound
+          #   phone calls when the Assistant has to say something first.
           # @return [AssistantInstance] Updated AssistantInstance
           def update(friendly_name: :unset, log_queries: :unset, unique_name: :unset, callback_url: :unset, callback_events: :unset, fallback_actions: :unset, initiation_actions: :unset)
             context.update(

data/lib/twilio-ruby/rest/preview/understand/assistant/intent/intent_actions.rb

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the IntentActionsList
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The assistant_sid
-              # @param [String] intent_sid The intent_sid
+              # @param [String] assistant_sid The unique ID of the parent Assistant.
+              # @param [String] intent_sid The unique ID of the Intent.
               # @return [IntentActionsList] IntentActionsList
               def initialize(version, assistant_sid: nil, intent_sid: nil)
                 super(version)
@@ -77,8 +77,8 @@ module Twilio
               ##
               # Initialize the IntentActionsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The assistant_sid
-              # @param [String] intent_sid The intent_sid
+              # @param [String] assistant_sid The unique ID of the parent Assistant.
+              # @param [String] intent_sid The unique ID of the Intent.
               # @return [IntentActionsContext] IntentActionsContext
               def initialize(version, assistant_sid, intent_sid)
                 super(version)
@@ -110,7 +110,8 @@ module Twilio
 
               ##
               # Update the IntentActionsInstance
-              # @param [Hash] actions The actions
+              # @param [Hash] actions The JSON actions that instruct the Assistant how to
+              #   perform this task.
               # @return [IntentActionsInstance] Updated IntentActionsInstance
               def update(actions: :unset)
                 data = Twilio::Values.of({'Actions' => Twilio.serialize_object(actions), })
@@ -144,8 +145,8 @@ module Twilio
               # Initialize the IntentActionsInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] assistant_sid The assistant_sid
-              # @param [String] intent_sid The intent_sid
+              # @param [String] assistant_sid The unique ID of the parent Assistant.
+              # @param [String] intent_sid The unique ID of the Intent.
               # @return [IntentActionsInstance] IntentActionsInstance
               def initialize(version, payload, assistant_sid: nil, intent_sid: nil)
                 super(version)
@@ -180,19 +181,19 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique ID of the Account that created this Field.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The assistant_sid
+              # @return [String] The unique ID of the parent Assistant.
               def assistant_sid
                 @properties['assistant_sid']
               end
 
               ##
-              # @return [String] The intent_sid
+              # @return [String] The unique ID of the Intent.
               def intent_sid
                 @properties['intent_sid']
               end
@@ -218,7 +219,8 @@ module Twilio
 
               ##
               # Update the IntentActionsInstance
-              # @param [Hash] actions The actions
+              # @param [Hash] actions The JSON actions that instruct the Assistant how to
+              #   perform this task.
               # @return [IntentActionsInstance] Updated IntentActionsInstance
               def update(actions: :unset)
                 context.update(actions: actions, )