twilio-ruby 5.52.0 → 5.67.3

data/lib/twilio-ruby/rest/{fax/v1/fax/fax_media.rb → messaging/v1/brand_registration/brand_vetting.rb}

@@ -8,30 +8,45 @@
 
 module Twilio
   module REST
-    class Fax < Domain
+    class Messaging < Domain
       class V1 < Version
-        class FaxContext < InstanceContext
+        class BrandRegistrationContext < InstanceContext
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaList < ListResource
+          class BrandVettingList < ListResource
             ##
-            # Initialize the FaxMediaList
+            # Initialize the BrandVettingList
             # @param [Version] version Version that contains the resource
-            # @param [String] fax_sid The SID of the fax the FaxMedia resource is associated
-            #   with.
-            # @return [FaxMediaList] FaxMediaList
-            def initialize(version, fax_sid: nil)
+            # @param [String] brand_sid The unique string to identify Brand Registration.
+            # @return [BrandVettingList] BrandVettingList
+            def initialize(version, brand_sid: nil)
               super(version)
 
               # Path Solution
-              @solution = {fax_sid: fax_sid}
-              @uri = "/Faxes/#{@solution[:fax_sid]}/Media"
+              @solution = {brand_sid: brand_sid}
+              @uri = "/a2p/BrandRegistrations/#{@solution[:brand_sid]}/Vettings"
             end
 
             ##
-            # Lists FaxMediaInstance records from the API as a list.
+            # Create the BrandVettingInstance
+            # @param [brand_vetting.VettingProvider] vetting_provider The third-party provider
+            #   of the vettings to create .
+            # @param [String] vetting_id The unique ID of the vetting
+            # @return [BrandVettingInstance] Created BrandVettingInstance
+            def create(vetting_provider: nil, vetting_id: :unset)
+              data = Twilio::Values.of({'VettingProvider' => vetting_provider, 'VettingId' => vetting_id, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              BrandVettingInstance.new(@version, payload, brand_sid: @solution[:brand_sid], )
+            end
+
+            ##
+            # Lists BrandVettingInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
+            # @param [brand_vetting.VettingProvider] vetting_provider The third-party provider
+            #   of the vettings to read
             # @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
@@ -39,14 +54,16 @@ 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(limit: nil, page_size: nil)
-              self.stream(limit: limit, page_size: page_size).entries
+            def list(vetting_provider: :unset, limit: nil, page_size: nil)
+              self.stream(vetting_provider: vetting_provider, limit: limit, page_size: page_size).entries
             end
 
             ##
-            # Streams FaxMediaInstance records from the API as an Enumerable.
+            # Streams BrandVettingInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
+            # @param [brand_vetting.VettingProvider] vetting_provider The third-party provider
+            #   of the vettings to read
             # @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
@@ -54,16 +71,16 @@ 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(limit: nil, page_size: nil)
+            def stream(vetting_provider: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size], )
+              page = self.page(vetting_provider: vetting_provider, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
 
             ##
-            # When passed a block, yields FaxMediaInstance records from the API.
+            # When passed a block, yields BrandVettingInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             def each
@@ -77,14 +94,17 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of FaxMediaInstance records from the API.
+            # Retrieve a single page of BrandVettingInstance records from the API.
             # Request is executed immediately.
+            # @param [brand_vetting.VettingProvider] vetting_provider The third-party provider
+            #   of the vettings to read
             # @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 FaxMediaInstance
-            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            # @return [Page] Page of BrandVettingInstance
+            def page(vetting_provider: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
+                  'VettingProvider' => vetting_provider,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
@@ -92,38 +112,38 @@ module Twilio
 
               response = @version.page('GET', @uri, params: params)
 
-              FaxMediaPage.new(@version, response, @solution)
+              BrandVettingPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of FaxMediaInstance records from the API.
+            # Retrieve a single page of BrandVettingInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of FaxMediaInstance
+            # @return [Page] Page of BrandVettingInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              FaxMediaPage.new(@version, response, @solution)
+              BrandVettingPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Fax.V1.FaxMediaList>'
+              '#<Twilio.Messaging.V1.BrandVettingList>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaPage < Page
+          class BrandVettingPage < Page
             ##
-            # Initialize the FaxMediaPage
+            # Initialize the BrandVettingPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [FaxMediaPage] FaxMediaPage
+            # @return [BrandVettingPage] BrandVettingPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -132,133 +152,141 @@ module Twilio
             end
 
             ##
-            # Build an instance of FaxMediaInstance
+            # Build an instance of BrandVettingInstance
             # @param [Hash] payload Payload response from the API
-            # @return [FaxMediaInstance] FaxMediaInstance
+            # @return [BrandVettingInstance] BrandVettingInstance
             def get_instance(payload)
-              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid], )
+              BrandVettingInstance.new(@version, payload, brand_sid: @solution[:brand_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Fax.V1.FaxMediaPage>'
+              '<Twilio.Messaging.V1.BrandVettingPage>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaContext < InstanceContext
+          class BrandVettingContext < InstanceContext
             ##
-            # Initialize the FaxMediaContext
+            # Initialize the BrandVettingContext
             # @param [Version] version Version that contains the resource
-            # @param [String] fax_sid The SID of the fax with the FaxMedia resource to fetch.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the
-            #   FaxMedia resource to fetch.
-            # @return [FaxMediaContext] FaxMediaContext
-            def initialize(version, fax_sid, sid)
+            # @param [String] brand_sid The SID of the Brand Registration resource of the
+            #   vettings to read .
+            # @param [String] brand_vetting_sid The Twilio SID of the third-party vetting
+            #   record.
+            # @return [BrandVettingContext] BrandVettingContext
+            def initialize(version, brand_sid, brand_vetting_sid)
               super(version)
 
               # Path Solution
-              @solution = {fax_sid: fax_sid, sid: sid, }
-              @uri = "/Faxes/#{@solution[:fax_sid]}/Media/#{@solution[:sid]}"
+              @solution = {brand_sid: brand_sid, brand_vetting_sid: brand_vetting_sid, }
+              @uri = "/a2p/BrandRegistrations/#{@solution[:brand_sid]}/Vettings/#{@solution[:brand_vetting_sid]}"
             end
 
             ##
-            # Fetch the FaxMediaInstance
-            # @return [FaxMediaInstance] Fetched FaxMediaInstance
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
             def fetch
               payload = @version.fetch('GET', @uri)
 
-              FaxMediaInstance.new(@version, payload, fax_sid: @solution[:fax_sid], sid: @solution[:sid], )
-            end
-
-            ##
-            # Delete the FaxMediaInstance
-            # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-               @version.delete('DELETE', @uri)
+              BrandVettingInstance.new(
+                  @version,
+                  payload,
+                  brand_sid: @solution[:brand_sid],
+                  brand_vetting_sid: @solution[:brand_vetting_sid],
+              )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Fax.V1.FaxMediaContext #{context}>"
+              "#<Twilio.Messaging.V1.BrandVettingContext #{context}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Fax.V1.FaxMediaContext #{context}>"
+              "#<Twilio.Messaging.V1.BrandVettingContext #{context}>"
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class FaxMediaInstance < InstanceResource
+          class BrandVettingInstance < InstanceResource
             ##
-            # Initialize the FaxMediaInstance
+            # Initialize the BrandVettingInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] fax_sid The SID of the fax the FaxMedia resource is associated
-            #   with.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the
-            #   FaxMedia resource to fetch.
-            # @return [FaxMediaInstance] FaxMediaInstance
-            def initialize(version, payload, fax_sid: nil, sid: nil)
+            # @param [String] brand_sid The unique string to identify Brand Registration.
+            # @param [String] brand_vetting_sid The Twilio SID of the third-party vetting
+            #   record.
+            # @return [BrandVettingInstance] BrandVettingInstance
+            def initialize(version, payload, brand_sid: nil, brand_vetting_sid: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
-                  'sid' => payload['sid'],
                   'account_sid' => payload['account_sid'],
-                  'fax_sid' => payload['fax_sid'],
-                  'content_type' => payload['content_type'],
-                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'brand_sid' => payload['brand_sid'],
+                  'brand_vetting_sid' => payload['brand_vetting_sid'],
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'vetting_id' => payload['vetting_id'],
+                  'vetting_class' => payload['vetting_class'],
+                  'vetting_status' => payload['vetting_status'],
+                  'vetting_provider' => payload['vetting_provider'],
                   'url' => payload['url'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'fax_sid' => fax_sid, 'sid' => sid || @properties['sid'], }
+              @params = {
+                  'brand_sid' => brand_sid,
+                  'brand_vetting_sid' => brand_vetting_sid || @properties['brand_vetting_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 [FaxMediaContext] FaxMediaContext for this FaxMediaInstance
+            # @return [BrandVettingContext] BrandVettingContext for this BrandVettingInstance
             def context
               unless @instance_context
-                @instance_context = FaxMediaContext.new(@version, @params['fax_sid'], @params['sid'], )
+                @instance_context = BrandVettingContext.new(
+                    @version,
+                    @params['brand_sid'],
+                    @params['brand_vetting_sid'],
+                )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The unique string that identifies the resource
-            def sid
-              @properties['sid']
+            # @return [String] The SID of the Account that created the vetting
+            def account_sid
+              @properties['account_sid']
             end
 
             ##
-            # @return [String] The SID of the Account that created the resource
-            def account_sid
-              @properties['account_sid']
+            # @return [String] A2P BrandRegistration Sid
+            def brand_sid
+              @properties['brand_sid']
             end
 
             ##
-            # @return [String] The SID of the fax the FaxMedia resource is associated with
-            def fax_sid
-              @properties['fax_sid']
+            # @return [String] SID for third-party vetting record
+            def brand_vetting_sid
+              @properties['brand_vetting_sid']
             end
 
             ##
-            # @return [String] The content type of the stored fax media
-            def content_type
-              @properties['content_type']
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
             end
 
             ##
@@ -268,43 +296,54 @@ module Twilio
             end
 
             ##
-            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
-            def date_updated
-              @properties['date_updated']
+            # @return [String] The unique ID of the vetting
+            def vetting_id
+              @properties['vetting_id']
             end
 
             ##
-            # @return [String] The absolute URL of the FaxMedia resource
+            # @return [String] The type of vetting
+            def vetting_class
+              @properties['vetting_class']
+            end
+
+            ##
+            # @return [String] Status of vetting attempt
+            def vetting_status
+              @properties['vetting_status']
+            end
+
+            ##
+            # @return [brand_vetting.VettingProvider] Third-party provider that has conducted the vetting
+            def vetting_provider
+              @properties['vetting_provider']
+            end
+
+            ##
+            # @return [String] The absolute URL of the Brand Vetting
             def url
               @properties['url']
             end
 
             ##
-            # Fetch the FaxMediaInstance
-            # @return [FaxMediaInstance] Fetched FaxMediaInstance
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
             def fetch
               context.fetch
             end
 
-            ##
-            # Delete the FaxMediaInstance
-            # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              context.delete
-            end
-
             ##
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Fax.V1.FaxMediaInstance #{values}>"
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Fax.V1.FaxMediaInstance #{values}>"
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
             end
           end
         end

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

@@ -109,11 +109,22 @@ module Twilio
           # Create the BrandRegistrationInstance
           # @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",
+          #   "STARTER". STARTER is for low volume, starter 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(customer_profile_bundle_sid: nil, a2p_profile_bundle_sid: nil)
+          def create(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,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -173,6 +184,9 @@ module Twilio
             # Path Solution
             @solution = {sid: sid, }
             @uri = "/a2p/BrandRegistrations/#{@solution[:sid]}"
+
+            # Dependents
+            @brand_vettings = nil
           end
 
           ##
@@ -184,6 +198,33 @@ module Twilio
             BrandRegistrationInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
+          ##
+          # Update the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Updated BrandRegistrationInstance
+          def update
+            payload = @version.update('POST', @uri)
+
+            BrandRegistrationInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the brand_vettings
+          # @return [BrandVettingList]
+          # @return [BrandVettingContext] if brand_vetting_sid was passed.
+          def brand_vettings(brand_vetting_sid=:unset)
+            raise ArgumentError, 'brand_vetting_sid cannot be nil' if brand_vetting_sid.nil?
+
+            if brand_vetting_sid != :unset
+              return BrandVettingContext.new(@version, @solution[:sid], brand_vetting_sid, )
+            end
+
+            unless @brand_vettings
+              @brand_vettings = BrandVettingList.new(@version, brand_sid: @solution[:sid], )
+            end
+
+            @brand_vettings
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -219,10 +260,20 @@ module Twilio
                 'a2p_profile_bundle_sid' => payload['a2p_profile_bundle_sid'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'brand_type' => payload['brand_type'],
                 'status' => payload['status'],
                 'tcr_id' => payload['tcr_id'],
                 'failure_reason' => payload['failure_reason'],
                 'url' => payload['url'],
+                'brand_score' => payload['brand_score'] == nil ? payload['brand_score'] : payload['brand_score'].to_i,
+                'brand_feedback' => payload['brand_feedback'],
+                'identity_status' => payload['identity_status'],
+                'russell_3000' => payload['russell_3000'],
+                'government_entity' => payload['government_entity'],
+                'tax_exempt_status' => payload['tax_exempt_status'],
+                'skip_automatic_sec_vet' => payload['skip_automatic_sec_vet'],
+                'mock' => payload['mock'],
+                'links' => payload['links'],
             }
 
             # Context
@@ -278,7 +329,13 @@ module Twilio
           end
 
           ##
-          # @return [brand_registration.Status] Brand Registration status
+          # @return [String] Type of brand. One of: "STANDARD", "STARTER".
+          def brand_type
+            @properties['brand_type']
+          end
+
+          ##
+          # @return [brand_registration.Status] Brand Registration status.
           def status
             @properties['status']
           end
@@ -301,6 +358,60 @@ module Twilio
             @properties['url']
           end
 
+          ##
+          # @return [String] Brand score
+          def brand_score
+            @properties['brand_score']
+          end
+
+          ##
+          # @return [Array[brand_registration.BrandFeedback]] Brand feedback
+          def brand_feedback
+            @properties['brand_feedback']
+          end
+
+          ##
+          # @return [brand_registration.IdentityStatus] Identity Status
+          def identity_status
+            @properties['identity_status']
+          end
+
+          ##
+          # @return [Boolean] Russell 3000
+          def russell_3000
+            @properties['russell_3000']
+          end
+
+          ##
+          # @return [Boolean] Government Entity
+          def government_entity
+            @properties['government_entity']
+          end
+
+          ##
+          # @return [String] Tax Exempt Status
+          def tax_exempt_status
+            @properties['tax_exempt_status']
+          end
+
+          ##
+          # @return [Boolean] Skip Automatic Secondary Vetting
+          def skip_automatic_sec_vet
+            @properties['skip_automatic_sec_vet']
+          end
+
+          ##
+          # @return [Boolean] 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.
+          def mock
+            @properties['mock']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
           ##
           # Fetch the BrandRegistrationInstance
           # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
@@ -308,6 +419,20 @@ module Twilio
             context.fetch
           end
 
+          ##
+          # Update the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Updated BrandRegistrationInstance
+          def update
+            context.update
+          end
+
+          ##
+          # Access the brand_vettings
+          # @return [brand_vettings] brand_vettings
+          def brand_vettings
+            context.brand_vettings
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

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

@@ -94,6 +94,7 @@ module Twilio
 
             # Marshaled Properties
             @properties = {
+                'sid' => payload['sid'],
                 'account_sid' => payload['account_sid'],
                 'campaign_id' => payload['campaign_id'],
                 'messaging_service_sid' => payload['messaging_service_sid'],
@@ -101,6 +102,12 @@ module Twilio
             }
           end
 
+          ##
+          # @return [String] The unique string that identifies a US A2P Compliance resource
+          def sid
+            @properties['sid']
+          end
+
           ##
           # @return [String] The SID of the Account that created the resource
           def account_sid