twilio-ruby 5.58.1 → 5.60.0

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

@@ -0,0 +1,272 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        class BrandRegistrationContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class BrandVettingList < ListResource
+            ##
+            # Initialize the BrandVettingList
+            # @param [Version] version Version that contains the resource
+            # @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 = {brand_sid: brand_sid}
+              @uri = "/a2p/BrandRegistrations/#{@solution[:brand_sid]}/Vettings"
+            end
+
+            ##
+            # 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
+            #    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(vetting_provider: :unset, limit: nil, page_size: nil)
+              self.stream(vetting_provider: vetting_provider, limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # 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
+            #    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(vetting_provider: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, 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 BrandVettingInstance 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 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 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,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              BrandVettingPage.new(@version, response, @solution)
+            end
+
+            ##
+            # 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 BrandVettingInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              BrandVettingPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Messaging.V1.BrandVettingList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class BrandVettingPage < Page
+            ##
+            # 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 [BrandVettingPage] BrandVettingPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of BrandVettingInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [BrandVettingInstance] BrandVettingInstance
+            def get_instance(payload)
+              BrandVettingInstance.new(@version, payload, brand_sid: @solution[:brand_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Messaging.V1.BrandVettingPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class BrandVettingInstance < InstanceResource
+            ##
+            # Initialize the BrandVettingInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] brand_sid The unique string to identify Brand Registration.
+            # @return [BrandVettingInstance] BrandVettingInstance
+            def initialize(version, payload, brand_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  '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'],
+              }
+            end
+
+            ##
+            # @return [String] The SID of the Account that created the vetting
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] A2P BrandRegistration Sid
+            def brand_sid
+              @properties['brand_sid']
+            end
+
+            ##
+            # @return [String] SID for third-party vetting record
+            def brand_vetting_sid
+              @properties['brand_vetting_sid']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [String] The unique ID of the vetting
+            def vetting_id
+              @properties['vetting_id']
+            end
+
+            ##
+            # @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
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Messaging.V1.BrandVettingInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Messaging.V1.BrandVettingInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -112,12 +112,19 @@ module Twilio
           # @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, brand_type: :unset)
+          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)
@@ -177,6 +184,9 @@ module Twilio
             # Path Solution
             @solution = {sid: sid, }
             @uri = "/a2p/BrandRegistrations/#{@solution[:sid]}"
+
+            # Dependents
+            @brand_vettings = nil
           end
 
           ##
@@ -188,6 +198,18 @@ module Twilio
             BrandRegistrationInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
+          ##
+          # Access the brand_vettings
+          # @return [BrandVettingList]
+          # @return [BrandVettingContext]
+          def brand_vettings
+            unless @brand_vettings
+              @brand_vettings = BrandVettingList.new(@version, brand_sid: @solution[:sid], )
+            end
+
+            @brand_vettings
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -229,6 +251,13 @@ module Twilio
                 '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'],
+                'tax_exempt_status' => payload['tax_exempt_status'],
+                'skip_automatic_sec_vet' => payload['skip_automatic_sec_vet'],
+                'mock' => payload['mock'],
+                'links' => payload['links'],
             }
 
             # Context
@@ -319,6 +348,48 @@ module Twilio
             @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 [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
@@ -326,6 +397,13 @@ module Twilio
             context.fetch
           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/service/us_app_to_person.rb

@@ -33,8 +33,8 @@ module Twilio
             # Create the UsAppToPersonInstance
             # @param [String] brand_registration_sid A2P Brand Registration SID
             # @param [String] description A short description of what this SMS campaign does.
-            # @param [Array[String]] message_samples Message samples, up to 5 sample messages,
-            #   <=1024 chars each.
+            # @param [Array[String]] message_samples Message samples, at least 2 and up to 5
+            #   sample messages, <=1024 chars each.
             # @param [String] us_app_to_person_usecase A2P Campaign Use Case. Examples: [ 2FA,
             #   EMERGENCY, MARKETING..]
             # @param [Boolean] has_embedded_links Indicates that this SMS campaign will send
@@ -273,6 +273,7 @@ module Twilio
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
+                  'mock' => payload['mock'],
               }
 
               # Context
@@ -391,6 +392,12 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [Boolean] A boolean that specifies whether campaign is a mock or not.
+            def mock
+              @properties['mock']
+            end
+
             ##
             # Delete the UsAppToPersonInstance
             # @return [Boolean] true if delete succeeds, false otherwise

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

@@ -67,6 +67,9 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..].
           # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
           #   either the webhook url configured on the phone number will be used or
           #   `inbound_request_url`/`fallback_url` url will be called when a message is
@@ -74,7 +77,7 @@ module Twilio
           #   defined on the phone number will override the
           #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Created ServiceInstance
-          def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset)
+          def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'InboundRequestUrl' => inbound_request_url,
@@ -90,6 +93,7 @@ module Twilio
                 'AreaCodeGeomatch' => area_code_geomatch,
                 'ValidityPeriod' => validity_period,
                 'SynchronousValidation' => synchronous_validation,
+                'Usecase' => usecase,
                 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
             })
 
@@ -281,6 +285,9 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..]
           # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
           #   either the webhook url configured on the phone number will be used or
           #   `inbound_request_url`/`fallback_url` url will be called when a message is
@@ -288,7 +295,7 @@ module Twilio
           #   defined on the phone number will override the
           #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset)
+          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'InboundRequestUrl' => inbound_request_url,
@@ -304,6 +311,7 @@ module Twilio
                 'AreaCodeGeomatch' => area_code_geomatch,
                 'ValidityPeriod' => validity_period,
                 'SynchronousValidation' => synchronous_validation,
+                'Usecase' => usecase,
                 'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
             })
 
@@ -464,6 +472,8 @@ module Twilio
                 'validity_period' => payload['validity_period'].to_i,
                 'url' => payload['url'],
                 'links' => payload['links'],
+                'usecase' => payload['usecase'],
+                'us_app_to_person_registered' => payload['us_app_to_person_registered'],
                 'use_inbound_webhook_on_number' => payload['use_inbound_webhook_on_number'],
             }
 
@@ -603,6 +613,18 @@ module Twilio
             @properties['links']
           end
 
+          ##
+          # @return [String] A string describing the scenario in which the Messaging Service will be used
+          def usecase
+            @properties['usecase']
+          end
+
+          ##
+          # @return [Boolean] Whether US A2P campaign is registered for this Service.
+          def us_app_to_person_registered
+            @properties['us_app_to_person_registered']
+          end
+
           ##
           # @return [Boolean] If enabled, the webhook url configured on the phone number will be used and will override the `inbound_request_url`/`fallback_url` url called when an inbound message is received.
           def use_inbound_webhook_on_number
@@ -651,6 +673,9 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..]
           # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
           #   either the webhook url configured on the phone number will be used or
           #   `inbound_request_url`/`fallback_url` url will be called when a message is
@@ -658,7 +683,7 @@ module Twilio
           #   defined on the phone number will override the
           #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset)
+          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             context.update(
                 friendly_name: friendly_name,
                 inbound_request_url: inbound_request_url,
@@ -674,6 +699,7 @@ module Twilio
                 area_code_geomatch: area_code_geomatch,
                 validity_period: validity_period,
                 synchronous_validation: synchronous_validation,
+                usecase: usecase,
                 use_inbound_webhook_on_number: use_inbound_webhook_on_number,
             )
           end