twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/messaging/v1/brand_registration.rb

@@ -18,12 +18,14 @@ module Twilio
         class Messaging < MessagingBase
             class V1 < Version
                 class BrandRegistrationList < ListResource
+                
                     ##
                     # Initialize the BrandRegistrationList
                     # @param [Version] version Version that contains the resource
                     # @return [BrandRegistrationList] BrandRegistrationList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/a2p/BrandRegistrations"
@@ -38,11 +40,11 @@ module Twilio
                     # @param [Boolean] skip_automatic_sec_vet A flag to disable automatic secondary vetting for brands which it would otherwise be done.
                     # @return [BrandRegistrationInstance] Created BrandRegistrationInstance
                     def create(
-                        customer_profile_bundle_sid: nil, 
-                        a2p_profile_bundle_sid: nil, 
-                        brand_type: :unset, 
-                        mock: :unset, 
-                        skip_automatic_sec_vet: :unset
+                      customer_profile_bundle_sid: nil, 
+                      a2p_profile_bundle_sid: nil, 
+                      brand_type: :unset, 
+                      mock: :unset, 
+                      skip_automatic_sec_vet: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -53,13 +55,62 @@ module Twilio
                             'SkipAutomaticSecVet' => skip_automatic_sec_vet,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         BrandRegistrationInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the BrandRegistrationInstanceMetadata
+                    # @param [String] customer_profile_bundle_sid Customer Profile Bundle Sid.
+                    # @param [String] a2p_profile_bundle_sid A2P Messaging Profile Bundle Sid.
+                    # @param [String] brand_type Type of brand being created. One of: \\\"STANDARD\\\", \\\"SOLE_PROPRIETOR\\\". SOLE_PROPRIETOR is for low volume, SOLE_PROPRIETOR use cases. STANDARD is for all other use cases.
+                    # @param [Boolean] mock A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
+                    # @param [Boolean] skip_automatic_sec_vet A flag to disable automatic secondary vetting for brands which it would otherwise be done.
+                    # @return [BrandRegistrationInstance] Created BrandRegistrationInstance
+                    def create_with_metadata(
+                      customer_profile_bundle_sid: nil, 
+                      a2p_profile_bundle_sid: nil, 
+                      brand_type: :unset, 
+                      mock: :unset, 
+                      skip_automatic_sec_vet: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'CustomerProfileBundleSid' => customer_profile_bundle_sid,
+                            'A2PProfileBundleSid' => a2p_profile_bundle_sid,
+                            'BrandType' => brand_type,
+                            'Mock' => mock,
+                            'SkipAutomaticSecVet' => skip_automatic_sec_vet,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        brand_registration_instance = BrandRegistrationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        BrandRegistrationInstanceMetadata.new(
+                            @version,
+                            brand_registration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists BrandRegistrationInstance records from the API as a list.
@@ -96,7 +147,33 @@ module Twilio
                         page = self.page(
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists BrandRegistrationPageMetadata records from the API as a list.
+                    # @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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        BrandRegistrationPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -108,9 +185,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -120,14 +201,17 @@ module Twilio
                     # @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 BrandRegistrationInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         BrandRegistrationPage.new(@version, response, @solution)
                     end
@@ -154,8 +238,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class BrandRegistrationContext < InstanceContext
                     ##
                     # Initialize the BrandRegistrationContext
@@ -164,6 +246,7 @@ module Twilio
                     # @return [BrandRegistrationContext] BrandRegistrationContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -172,13 +255,20 @@ module Twilio
                         # Dependents
                         @brand_registration_otps = nil
                         @brand_vettings = nil
+                        @brand_registration2_fa = nil
                     end
                     ##
                     # Fetch the BrandRegistrationInstance
                     # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         BrandRegistrationInstance.new(
                             @version,
                             payload,
@@ -186,12 +276,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the BrandRegistrationInstanceMetadata
+                    # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        brand_registration_instance = BrandRegistrationInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        BrandRegistrationInstanceMetadata.new(
+                            @version,
+                            brand_registration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the BrandRegistrationInstance
                     # @return [BrandRegistrationInstance] Updated BrandRegistrationInstance
                     def update
 
-                        payload = @version.update('POST', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, headers: headers)
                         BrandRegistrationInstance.new(
                             @version,
                             payload,
@@ -199,6 +320,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the BrandRegistrationInstanceMetadata
+                    # @return [BrandRegistrationInstance] Updated BrandRegistrationInstance
+                    def update_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, headers: headers)
+                        brand_registration_instance = BrandRegistrationInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        BrandRegistrationInstanceMetadata.new(
+                            @version,
+                            brand_registration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the brand_registration_otps
                     # @return [BrandRegistrationOtpList]
@@ -229,6 +375,16 @@ module Twilio
 
                      @brand_vettings
                     end
+                    ##
+                    # Access the brand_registration2_fa
+                    # @return [BrandRegistration2FaList]
+                    # @return [BrandRegistration2FaContext]
+                    def brand_registration2_fa
+                        BrandRegistration2FaContext.new(
+                                @version,
+                                @solution[:sid]
+                                )
+                    end
 
                     ##
                     # Provide a user friendly representation
@@ -245,6 +401,53 @@ module Twilio
                     end
                 end
 
+                class BrandRegistrationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new BrandRegistrationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}BrandRegistrationInstance] brand_registration_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [BrandRegistrationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, brand_registration_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @brand_registration_instance = brand_registration_instance
+                    end
+
+                    def brand_registration
+                        @brand_registration_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.BrandRegistrationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class BrandRegistrationListResponse < InstanceListResource
+                    # @param [Array<BrandRegistrationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @brand_registration_instance = payload.body[key].map do |data|
+                        BrandRegistrationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def brand_registration_instance
+                          @instance
+                      end
+                  end
+
                 class BrandRegistrationPage < Page
                     ##
                     # Initialize the BrandRegistrationPage
@@ -254,6 +457,7 @@ module Twilio
                     # @return [BrandRegistrationPage] BrandRegistrationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -273,6 +477,66 @@ module Twilio
                         '<Twilio.Messaging.V1.BrandRegistrationPage>'
                     end
                 end
+
+                class BrandRegistrationPageMetadata < PageMetadata
+                    attr_reader :brand_registration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @brand_registration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @brand_registration_page << BrandRegistrationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @brand_registration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class BrandRegistrationListResponse < InstanceListResource
+
+                    # @param [Array<BrandRegistrationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @brand_registration = data_list.map do |data|
+                        BrandRegistrationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def brand_registration
+                        @brand_registration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class BrandRegistrationInstance < InstanceResource
                     ##
                     # Initialize the BrandRegistrationInstance
@@ -286,6 +550,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -298,6 +563,7 @@ module Twilio
                             'status' => payload['status'],
                             'tcr_id' => payload['tcr_id'],
                             'failure_reason' => payload['failure_reason'],
+                            'errors' => payload['errors'],
                             'url' => payload['url'],
                             'brand_score' => payload['brand_score'] == nil ? payload['brand_score'] : payload['brand_score'].to_i,
                             'brand_feedback' => payload['brand_feedback'],
@@ -381,11 +647,17 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] A reason why brand registration has failed. Only applicable when status is FAILED.
+                    # @return [String] DEPRECATED. A reason why brand registration has failed. Only applicable when status is FAILED.
                     def failure_reason
                         @properties['failure_reason']
                     end
                     
+                    ##
+                    # @return [Array<Hash>] A list of errors that occurred during the brand registration process.
+                    def errors
+                        @properties['errors']
+                    end
+                    
                     ##
                     # @return [String] The absolute URL of the Brand Registration resource.
                     def url
@@ -399,7 +671,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Array<BrandFeedback>] Feedback on how to improve brand score
+                    # @return [Array<BrandFeedback>] DEPRECATED. Feedback on how to improve brand score
                     def brand_feedback
                         @properties['brand_feedback']
                     end
@@ -476,6 +748,13 @@ module Twilio
                         context.brand_vettings
                     end
 
+                    ##
+                    # Access the brand_registration2_fa
+                    # @return [brand_registration2_fa] brand_registration2_fa
+                    def brand_registration2_fa
+                        context.brand_registration2_fa
+                    end
+
                     ##
                     # Provide a user friendly representation
                     def to_s