twilio-ruby 5.31.1 → 5.46.1

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document_type.rb

@@ -0,0 +1,273 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Numbers < Domain
+      class V2 < Version
+        class RegulatoryComplianceList < ListResource
+          class SupportingDocumentTypeList < ListResource
+            ##
+            # Initialize the SupportingDocumentTypeList
+            # @param [Version] version Version that contains the resource
+            # @return [SupportingDocumentTypeList] SupportingDocumentTypeList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/RegulatoryCompliance/SupportingDocumentTypes"
+            end
+
+            ##
+            # Lists SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance 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 SupportingDocumentTypeInstance
+            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: params)
+
+              SupportingDocumentTypePage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SupportingDocumentTypeInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SupportingDocumentTypeInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SupportingDocumentTypePage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Numbers.V2.SupportingDocumentTypeList>'
+            end
+          end
+
+          class SupportingDocumentTypePage < Page
+            ##
+            # Initialize the SupportingDocumentTypePage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SupportingDocumentTypePage] SupportingDocumentTypePage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SupportingDocumentTypeInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SupportingDocumentTypeInstance] SupportingDocumentTypeInstance
+            def get_instance(payload)
+              SupportingDocumentTypeInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Numbers.V2.SupportingDocumentTypePage>'
+            end
+          end
+
+          class SupportingDocumentTypeContext < InstanceContext
+            ##
+            # Initialize the SupportingDocumentTypeContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid The unique string that identifies the Supporting Document
+            #   Type resource.
+            # @return [SupportingDocumentTypeContext] SupportingDocumentTypeContext
+            def initialize(version, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid, }
+              @uri = "/RegulatoryCompliance/SupportingDocumentTypes/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch the SupportingDocumentTypeInstance
+            # @return [SupportingDocumentTypeInstance] Fetched SupportingDocumentTypeInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              SupportingDocumentTypeInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.SupportingDocumentTypeContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.SupportingDocumentTypeContext #{context}>"
+            end
+          end
+
+          class SupportingDocumentTypeInstance < InstanceResource
+            ##
+            # Initialize the SupportingDocumentTypeInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid The unique string that identifies the Supporting Document
+            #   Type resource.
+            # @return [SupportingDocumentTypeInstance] SupportingDocumentTypeInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'machine_name' => payload['machine_name'],
+                  'fields' => payload['fields'],
+                  '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 [SupportingDocumentTypeContext] SupportingDocumentTypeContext for this SupportingDocumentTypeInstance
+            def context
+              unless @instance_context
+                @instance_context = SupportingDocumentTypeContext.new(@version, @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The unique string that identifies the Supporting Document Type resource
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] A human-readable description of the Supporting Document Type resource
+            def friendly_name
+              @properties['friendly_name']
+            end
+
+            ##
+            # @return [String] The machine-readable description of the Supporting Document Type resource
+            def machine_name
+              @properties['machine_name']
+            end
+
+            ##
+            # @return [Array[Hash]] The required information for creating a Supporting Document
+            def fields
+              @properties['fields']
+            end
+
+            ##
+            # @return [String] The absolute URL of the Supporting Document Type resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the SupportingDocumentTypeInstance
+            # @return [SupportingDocumentTypeInstance] Fetched SupportingDocumentTypeInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.SupportingDocumentTypeInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Numbers.V2.SupportingDocumentTypeInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -23,7 +23,6 @@ module Twilio
         @deployed_devices = nil
         @hosted_numbers = nil
         @marketplace = nil
-        @acc_security = nil
         @sync = nil
         @understand = nil
         @wireless = nil
@@ -54,12 +53,6 @@ module Twilio
         @marketplace ||= Marketplace.new self
       end
 
-      ##
-      # Version acc_security of preview
-      def acc_security
-        @acc_security ||= AccSecurity.new self
-      end
-
       ##
       # Version sync of preview
       def sync
@@ -85,7 +78,8 @@ 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::ExportInstance] if resource_type was passed.
       # @return [Twilio::REST::Preview::BulkExports::ExportList]
       def exports(resource_type=:unset)
@@ -93,7 +87,8 @@ 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::ExportConfigurationInstance] if resource_type was passed.
       # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationList]
       def export_configuration(resource_type=:unset)
@@ -188,18 +183,17 @@ module Twilio
       end
 
       ##
-      # @return [Twilio::REST::Preview::TrustedComms::BrandedCallInstance]
-      def branded_calls
-        self.trusted_comms.branded_calls()
+      # @param [String] sid The unique SID identifier of the Branded Channel.
+      # @return [Twilio::REST::Preview::TrustedComms::BrandedChannelInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::TrustedComms::BrandedChannelList]
+      def branded_channels(sid=:unset)
+        self.trusted_comms.branded_channels(sid)
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   Business.
-      # @return [Twilio::REST::Preview::TrustedComms::BusinessInstance] if sid was passed.
-      # @return [Twilio::REST::Preview::TrustedComms::BusinessList]
-      def businesses(sid=:unset)
-        self.trusted_comms.businesses(sid)
+      # @return [Twilio::REST::Preview::TrustedComms::BrandsInformationInstance]
+      def brands_information
+        self.trusted_comms.brands_information()
       end
 
       ##
@@ -214,18 +208,6 @@ module Twilio
         self.trusted_comms.current_calls()
       end
 
-      ##
-      # @return [Twilio::REST::Preview::TrustedComms::DeviceInstance]
-      def devices
-        self.trusted_comms.devices()
-      end
-
-      ##
-      # @return [Twilio::REST::Preview::TrustedComms::PhoneCallInstance]
-      def phone_calls
-        self.trusted_comms.phone_calls()
-      end
-
       ##
       # Provide a user friendly representation
       def to_s

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

@@ -20,7 +20,8 @@ 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)
@@ -34,7 +35,8 @@ 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::ExportConfigurationContext] if resource_type was passed.
         # @return [Twilio::REST::Preview::BulkExports::ExportConfigurationList]
         def export_configuration(resource_type=:unset)

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

@@ -29,7 +29,8 @@ module Twilio
 
           ##
           # Access the jobs
-          # @param [String] job_sid The job_sid
+          # @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)
@@ -86,7 +87,8 @@ 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)
@@ -101,16 +103,10 @@ module Twilio
           end
 
           ##
-          # Fetch a ExportInstance
+          # Fetch the ExportInstance
           # @return [ExportInstance] Fetched ExportInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             ExportInstance.new(@version, payload, resource_type: @solution[:resource_type], )
           end
@@ -118,8 +114,14 @@ module Twilio
           ##
           # 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], )
             end
@@ -161,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)
@@ -190,25 +193,25 @@ module Twilio
           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