twilio-ruby 5.5.1 → 5.58.3

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

@@ -0,0 +1,388 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        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"
+          end
+
+          ##
+          # Lists BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance 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 BrandRegistrationInstance
+          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)
+
+            BrandRegistrationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of BrandRegistrationInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of BrandRegistrationInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            BrandRegistrationPage.new(@version, response, @solution)
+          end
+
+          ##
+          # 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, 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)
+
+            BrandRegistrationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.BrandRegistrationList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationPage < Page
+          ##
+          # Initialize the BrandRegistrationPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [BrandRegistrationPage] BrandRegistrationPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of BrandRegistrationInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [BrandRegistrationInstance] BrandRegistrationInstance
+          def get_instance(payload)
+            BrandRegistrationInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.BrandRegistrationPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationContext < InstanceContext
+          ##
+          # Initialize the BrandRegistrationContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the Brand Registration resource to fetch.
+          # @return [BrandRegistrationContext] BrandRegistrationContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/a2p/BrandRegistrations/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            BrandRegistrationInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class BrandRegistrationInstance < InstanceResource
+          ##
+          # Initialize the BrandRegistrationInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the Brand Registration resource to fetch.
+          # @return [BrandRegistrationInstance] BrandRegistrationInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'customer_profile_bundle_sid' => payload['customer_profile_bundle_sid'],
+                '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,
+                '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'],
+            }
+
+            # 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 [BrandRegistrationContext] BrandRegistrationContext for this BrandRegistrationInstance
+          def context
+            unless @instance_context
+              @instance_context = BrandRegistrationContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A2P BrandRegistration Sid
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] A2P Messaging Profile Bundle BundleSid
+          def customer_profile_bundle_sid
+            @properties['customer_profile_bundle_sid']
+          end
+
+          ##
+          # @return [String] A2P Messaging Profile Bundle BundleSid
+          def a2p_profile_bundle_sid
+            @properties['a2p_profile_bundle_sid']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
+          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 [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
+
+          ##
+          # @return [String] Campaign Registry (TCR) Brand ID
+          def tcr_id
+            @properties['tcr_id']
+          end
+
+          ##
+          # @return [String] A reason why brand registration has failed
+          def failure_reason
+            @properties['failure_reason']
+          end
+
+          ##
+          # @return [String] The absolute URL of the Brand Registration
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Brand score
+          def brand_score
+            @properties['brand_score']
+          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
+
+          ##
+          # Fetch the BrandRegistrationInstance
+          # @return [BrandRegistrationInstance] Fetched BrandRegistrationInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.BrandRegistrationInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,164 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        class DeactivationsList < ListResource
+          ##
+          # Initialize the DeactivationsList
+          # @param [Version] version Version that contains the resource
+          # @return [DeactivationsList] DeactivationsList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.DeactivationsList>'
+          end
+        end
+
+        class DeactivationsPage < Page
+          ##
+          # Initialize the DeactivationsPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DeactivationsPage] DeactivationsPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DeactivationsInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DeactivationsInstance] DeactivationsInstance
+          def get_instance(payload)
+            DeactivationsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.DeactivationsPage>'
+          end
+        end
+
+        class DeactivationsContext < InstanceContext
+          ##
+          # Initialize the DeactivationsContext
+          # @param [Version] version Version that contains the resource
+          # @return [DeactivationsContext] DeactivationsContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Deactivations"
+          end
+
+          ##
+          # Fetch the DeactivationsInstance
+          # @param [Date] date The request will return a list of all United States Phone
+          #   Numbers that were deactivated on the day specified by this parameter. This date
+          #   should be specified in YYYY-MM-DD format.
+          # @return [DeactivationsInstance] Fetched DeactivationsInstance
+          def fetch(date: :unset)
+            params = Twilio::Values.of({'Date' => Twilio.serialize_iso8601_date(date), })
+
+            payload = @version.fetch('GET', @uri, params: params)
+
+            DeactivationsInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DeactivationsContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DeactivationsContext #{context}>"
+          end
+        end
+
+        class DeactivationsInstance < InstanceResource
+          ##
+          # Initialize the DeactivationsInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [DeactivationsInstance] DeactivationsInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'redirect_to' => payload['redirect_to'], }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          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 [DeactivationsContext] DeactivationsContext for this DeactivationsInstance
+          def context
+            unless @instance_context
+              @instance_context = DeactivationsContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] Redirect url to the list of deactivated numbers.
+          def redirect_to
+            @properties['redirect_to']
+          end
+
+          ##
+          # Fetch the DeactivationsInstance
+          # @param [Date] date The request will return a list of all United States Phone
+          #   Numbers that were deactivated on the day specified by this parameter. This date
+          #   should be specified in YYYY-MM-DD format.
+          # @return [DeactivationsInstance] Fetched DeactivationsInstance
+          def fetch(date: :unset)
+            context.fetch(date: date, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DeactivationsInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DeactivationsInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ExternalCampaignList < ListResource
+          ##
+          # Initialize the ExternalCampaignList
+          # @param [Version] version Version that contains the resource
+          # @return [ExternalCampaignList] ExternalCampaignList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Services/PreregisteredUsa2p"
+          end
+
+          ##
+          # Create the ExternalCampaignInstance
+          # @param [String] campaign_id ID of the preregistered campaign.
+          # @param [String] messaging_service_sid The SID of the {Messaging
+          #   Service}[https://www.twilio.com/docs/messaging/services/api] that the resource
+          #   is associated with.
+          # @return [ExternalCampaignInstance] Created ExternalCampaignInstance
+          def create(campaign_id: nil, messaging_service_sid: nil)
+            data = Twilio::Values.of({
+                'CampaignId' => campaign_id,
+                'MessagingServiceSid' => messaging_service_sid,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            ExternalCampaignInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.ExternalCampaignList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ExternalCampaignPage < Page
+          ##
+          # Initialize the ExternalCampaignPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ExternalCampaignPage] ExternalCampaignPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ExternalCampaignInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ExternalCampaignInstance] ExternalCampaignInstance
+          def get_instance(payload)
+            ExternalCampaignInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.ExternalCampaignPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ExternalCampaignInstance < InstanceResource
+          ##
+          # Initialize the ExternalCampaignInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [ExternalCampaignInstance] ExternalCampaignInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'campaign_id' => payload['campaign_id'],
+                'messaging_service_sid' => payload['messaging_service_sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+            }
+          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
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] ID of the preregistered campaign.
+          def campaign_id
+            @properties['campaign_id']
+          end
+
+          ##
+          # @return [String] The SID of the Messaging Service the resource is associated with
+          def messaging_service_sid
+            @properties['messaging_service_sid']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Messaging.V1.ExternalCampaignInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Messaging.V1.ExternalCampaignInstance>"
+          end
+        end
+      end
+    end
+  end
+end