twilio-ruby 3.11.5 → 5.71.0

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

@@ -0,0 +1,353 @@
+##
+# 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 BrandVettingContext < InstanceContext
+            ##
+            # Initialize the BrandVettingContext
+            # @param [Version] version Version that contains the resource
+            # @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 = {brand_sid: brand_sid, brand_vetting_sid: brand_vetting_sid, }
+              @uri = "/a2p/BrandRegistrations/#{@solution[:brand_sid]}/Vettings/#{@solution[:brand_vetting_sid]}"
+            end
+
+            ##
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
+            def fetch
+              payload = @version.fetch('GET', @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.Messaging.V1.BrandVettingContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<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 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.
+            # @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 = {
+                  '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'],
+              }
+
+              # Context
+              @instance_context = nil
+              @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 [BrandVettingContext] BrandVettingContext for this BrandVettingInstance
+            def context
+              unless @instance_context
+                @instance_context = BrandVettingContext.new(
+                    @version,
+                    @params['brand_sid'],
+                    @params['brand_vetting_sid'],
+                )
+              end
+              @instance_context
+            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
+
+            ##
+            # Fetch the BrandVettingInstance
+            # @return [BrandVettingInstance] Fetched BrandVettingInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end