twilio-ruby 7.10.7 → 7.11.1

data/lib/twilio-ruby/rest/trusthub/v1/a2p_brand_registration.rb

@@ -0,0 +1,330 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Trusthub
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Trusthub < TrusthubBase
+            class V1 < Version
+                class A2PBrandRegistrationList < ListResource
+                
+                    class TrusthubV1A2pBrandRegistrationRequest
+                            # @param [brand_type]: [String] The type of brand being registered.
+                            # @param [theme_set_id]: [String] Theme ID for styling the inquiry form.
+                            # @param [friendly_name]: [String] A human-readable name for the brand registration.
+                            # @param [notification_email]: [String] The email address to receive notifications about the registration.
+                            # @param [business_name]: [String] The legal name of the business.
+                            # @param [business_registration_authority]: [String] The authority with which the business is registered.
+                            # @param [business_registration_number]: [String] The business registration number (e.g., EIN, CBN, ACN). Maximum 21 characters.
+                            # @param [business_industry]: [String] The industry of the business.
+                            # @param [business_website]: [String] The business website URL (must use https://).
+                            # @param [business_type]: [String] The type of business entity.
+                            # @param [business_stock_symbol]: [String] The stock symbol for publicly traded companies.
+                            # @param [business_stock_exchange]: [String] The stock exchange where the business is listed.
+                            # @param [business_tax_exempt_status]: [String] Nonprofit/political organization tax-exempt status per the U.S. tax code (e.g. 501c3, 501c1, 527). A value of 527 (political organization) requires a Campaign Verify token in brandExternalVettingToken.
+                            # @param [brand_external_vetting_token]: [String] Campaign Verify token for externally vetted brands.
+                            # @param [business_street_address]: [String] The street address of the business.
+                            # @param [business_street_address2]: [String] Additional street address information.
+                            # @param [business_city]: [String] The city of the business.
+                            # @param [business_state_province_region]: [String] The state, province, or region of the business.
+                            # @param [business_postal_code]: [String] The postal code of the business.
+                            # @param [business_country]: [String] The two-letter ISO country code of the business.
+                            # @param [business_contact_first_name]: [String] The first name of the business contact.
+                            # @param [business_contact_last_name]: [String] The last name of the business contact.
+                            # @param [business_contact_email]: [String] The email address of the business contact.
+                            # @param [business_contact_phone]: [String] The phone number of the business contact in E.164 format.
+                            # @param [authorized_contact_verification_email]: [String] The email address for authorized contact verification.
+                            # @param [authorized_contact_mobile_phone_number_e164]: [String] The mobile phone number for authorized contact in E.164 format.
+                            # @param [is_test]: [Boolean] Whether this is a test brand registration.
+                            # @param [skip_automatic_sec_vet]: [Boolean] Whether to skip automatic secondary vetting.
+                        attr_accessor :brand_type, :theme_set_id, :friendly_name, :notification_email, :business_name, :business_registration_authority, :business_registration_number, :business_industry, :business_website, :business_type, :business_stock_symbol, :business_stock_exchange, :business_tax_exempt_status, :brand_external_vetting_token, :business_street_address, :business_street_address2, :business_city, :business_state_province_region, :business_postal_code, :business_country, :business_contact_first_name, :business_contact_last_name, :business_contact_email, :business_contact_phone, :authorized_contact_verification_email, :authorized_contact_mobile_phone_number_e164, :is_test, :skip_automatic_sec_vet
+                        def initialize(payload)
+                                @brand_type = payload["brand_type"]
+                                @theme_set_id = payload["theme_set_id"]
+                                @friendly_name = payload["friendly_name"]
+                                @notification_email = payload["notification_email"]
+                                @business_name = payload["business_name"]
+                                @business_registration_authority = payload["business_registration_authority"]
+                                @business_registration_number = payload["business_registration_number"]
+                                @business_industry = payload["business_industry"]
+                                @business_website = payload["business_website"]
+                                @business_type = payload["business_type"]
+                                @business_stock_symbol = payload["business_stock_symbol"]
+                                @business_stock_exchange = payload["business_stock_exchange"]
+                                @business_tax_exempt_status = payload["business_tax_exempt_status"]
+                                @brand_external_vetting_token = payload["brand_external_vetting_token"]
+                                @business_street_address = payload["business_street_address"]
+                                @business_street_address2 = payload["business_street_address2"]
+                                @business_city = payload["business_city"]
+                                @business_state_province_region = payload["business_state_province_region"]
+                                @business_postal_code = payload["business_postal_code"]
+                                @business_country = payload["business_country"]
+                                @business_contact_first_name = payload["business_contact_first_name"]
+                                @business_contact_last_name = payload["business_contact_last_name"]
+                                @business_contact_email = payload["business_contact_email"]
+                                @business_contact_phone = payload["business_contact_phone"]
+                                @authorized_contact_verification_email = payload["authorized_contact_verification_email"]
+                                @authorized_contact_mobile_phone_number_e164 = payload["authorized_contact_mobile_phone_number_e164"]
+                                @is_test = payload["is_test"]
+                                @skip_automatic_sec_vet = payload["skip_automatic_sec_vet"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "brandType": @brand_type,
+                                "themeSetId": @theme_set_id,
+                                "friendlyName": @friendly_name,
+                                "notificationEmail": @notification_email,
+                                "businessName": @business_name,
+                                "businessRegistrationAuthority": @business_registration_authority,
+                                "businessRegistrationNumber": @business_registration_number,
+                                "businessIndustry": @business_industry,
+                                "businessWebsite": @business_website,
+                                "businessType": @business_type,
+                                "businessStockSymbol": @business_stock_symbol,
+                                "businessStockExchange": @business_stock_exchange,
+                                "businessTaxExemptStatus": @business_tax_exempt_status,
+                                "brandExternalVettingToken": @brand_external_vetting_token,
+                                "businessStreetAddress": @business_street_address,
+                                "businessStreetAddress2": @business_street_address2,
+                                "businessCity": @business_city,
+                                "businessStateProvinceRegion": @business_state_province_region,
+                                "businessPostalCode": @business_postal_code,
+                                "businessCountry": @business_country,
+                                "businessContactFirstName": @business_contact_first_name,
+                                "businessContactLastName": @business_contact_last_name,
+                                "businessContactEmail": @business_contact_email,
+                                "businessContactPhone": @business_contact_phone,
+                                "authorizedContactVerificationEmail": @authorized_contact_verification_email,
+                                "authorizedContactMobilePhoneNumberE164": @authorized_contact_mobile_phone_number_e164,
+                                "isTest": @is_test,
+                                "skipAutomaticSecVet": @skip_automatic_sec_vet,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the A2PBrandRegistrationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [A2PBrandRegistrationList] A2PBrandRegistrationList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/A2PBrandRegistrations"
+                        
+                    end
+                    ##
+                    # Create the A2PBrandRegistrationInstance
+                    # @param [TrusthubV1A2pBrandRegistrationRequest] trusthub_v1_a2p_brand_registration_request 
+                    # @return [A2PBrandRegistrationInstance] Created A2PBrandRegistrationInstance
+                    def create(trusthub_v1_a2p_brand_registration_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: trusthub_v1_a2p_brand_registration_request.to_json)
+                        A2PBrandRegistrationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the A2PBrandRegistrationInstanceMetadata
+                    # @param [TrusthubV1A2pBrandRegistrationRequest] trusthub_v1_a2p_brand_registration_request 
+                    # @return [A2PBrandRegistrationInstance] Created A2PBrandRegistrationInstance
+                    def create_with_metadata(trusthub_v1_a2p_brand_registration_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: trusthub_v1_a2p_brand_registration_request.to_json)
+                        a2_p_brand_registration_instance = A2PBrandRegistrationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        A2PBrandRegistrationInstanceMetadata.new(
+                            @version,
+                            a2_p_brand_registration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Trusthub.V1.A2PBrandRegistrationList>'
+                    end
+                end
+
+                class A2PBrandRegistrationPage < Page
+                    ##
+                    # Initialize the A2PBrandRegistrationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [A2PBrandRegistrationPage] A2PBrandRegistrationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of A2PBrandRegistrationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [A2PBrandRegistrationInstance] A2PBrandRegistrationInstance
+                    def get_instance(payload)
+                        A2PBrandRegistrationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Trusthub.V1.A2PBrandRegistrationPage>'
+                    end
+                end
+
+                class A2PBrandRegistrationPageMetadata < PageMetadata
+                    attr_reader :a2_p_brand_registration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @a2_p_brand_registration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @a2_p_brand_registration_page << A2PBrandRegistrationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @a2_p_brand_registration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Trusthub::V1PageMetadata>';
+                    end
+                end
+                class A2PBrandRegistrationListResponse < InstanceListResource
+
+                    # @param [Array<A2PBrandRegistrationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @a2_p_brand_registration = data_list.map do |data|
+                        A2PBrandRegistrationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def a2_p_brand_registration
+                        @a2_p_brand_registration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class A2PBrandRegistrationInstance < InstanceResource
+                    ##
+                    # Initialize the A2PBrandRegistrationInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this A2PBrandRegistration
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [A2PBrandRegistrationInstance] A2PBrandRegistrationInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'session_id' => payload['session_id'],
+                            'session_token' => payload['session_token'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The unique A2P Brand or Campaign Registration identifier, formatted as `tri1.us1.account.AC.../registration.BU...`.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The Persona inquiry ID used to start the embedded compliance session.
+                    def session_id
+                        @properties['session_id']
+                    end
+                    
+                    ##
+                    # @return [String] The Persona session token for embedding the compliance UI. Expires in 24 hours.
+                    def session_token
+                        @properties['session_token']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Trusthub.V1.A2PBrandRegistrationInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Trusthub.V1.A2PBrandRegistrationInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/trusthub/v1/a2p_brand_registration_embedded_session.rb

@@ -0,0 +1,233 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Trusthub
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Trusthub < TrusthubBase
+            class V1 < Version
+                class A2PBrandRegistrationEmbeddedSessionList < ListResource
+                
+                    ##
+                    # Initialize the A2PBrandRegistrationEmbeddedSessionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [A2PBrandRegistrationEmbeddedSessionList] A2PBrandRegistrationEmbeddedSessionList
+                    def initialize(version, id: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { id: id }
+                        @uri = "/A2PBrandRegistrations/#{@solution[:id]}/EmbeddedSessions"
+                        
+                    end
+                    ##
+                    # Create the A2PBrandRegistrationEmbeddedSessionInstance
+                    # @return [A2PBrandRegistrationEmbeddedSessionInstance] Created A2PBrandRegistrationEmbeddedSessionInstance
+                    def create
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers)
+                        A2PBrandRegistrationEmbeddedSessionInstance.new(
+                            @version,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Create the A2PBrandRegistrationEmbeddedSessionInstanceMetadata
+                    # @return [A2PBrandRegistrationEmbeddedSessionInstance] Created A2PBrandRegistrationEmbeddedSessionInstance
+                    def create_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers)
+                        a2_p_brand_registration_embedded_session_instance = A2PBrandRegistrationEmbeddedSessionInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        A2PBrandRegistrationEmbeddedSessionInstanceMetadata.new(
+                            @version,
+                            a2_p_brand_registration_embedded_session_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Trusthub.V1.A2PBrandRegistrationEmbeddedSessionList>'
+                    end
+                end
+
+                class A2PBrandRegistrationEmbeddedSessionPage < Page
+                    ##
+                    # Initialize the A2PBrandRegistrationEmbeddedSessionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [A2PBrandRegistrationEmbeddedSessionPage] A2PBrandRegistrationEmbeddedSessionPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of A2PBrandRegistrationEmbeddedSessionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [A2PBrandRegistrationEmbeddedSessionInstance] A2PBrandRegistrationEmbeddedSessionInstance
+                    def get_instance(payload)
+                        A2PBrandRegistrationEmbeddedSessionInstance.new(@version, payload, id: @solution[:id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Trusthub.V1.A2PBrandRegistrationEmbeddedSessionPage>'
+                    end
+                end
+
+                class A2PBrandRegistrationEmbeddedSessionPageMetadata < PageMetadata
+                    attr_reader :a2_p_brand_registration_embedded_session_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @a2_p_brand_registration_embedded_session_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @a2_p_brand_registration_embedded_session_page << A2PBrandRegistrationEmbeddedSessionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @a2_p_brand_registration_embedded_session_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Trusthub::V1PageMetadata>';
+                    end
+                end
+                class A2PBrandRegistrationEmbeddedSessionListResponse < InstanceListResource
+
+                    # @param [Array<A2PBrandRegistrationEmbeddedSessionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @a2_p_brand_registration_embedded_session = data_list.map do |data|
+                        A2PBrandRegistrationEmbeddedSessionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def a2_p_brand_registration_embedded_session
+                        @a2_p_brand_registration_embedded_session
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class A2PBrandRegistrationEmbeddedSessionInstance < InstanceResource
+                    ##
+                    # Initialize the A2PBrandRegistrationEmbeddedSessionInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this A2PBrandRegistrationEmbeddedSession
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [A2PBrandRegistrationEmbeddedSessionInstance] A2PBrandRegistrationEmbeddedSessionInstance
+                    def initialize(version, payload , id: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'session_id' => payload['session_id'],
+                            'session_token' => payload['session_token'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The unique A2P Brand or Campaign Registration identifier, formatted as `tri1.us1.account.AC.../registration.BU...`.
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The Persona inquiry ID used to start the embedded compliance session.
+                    def session_id
+                        @properties['session_id']
+                    end
+                    
+                    ##
+                    # @return [String] The Persona session token for embedding the compliance UI. Expires in 24 hours.
+                    def session_token
+                        @properties['session_token']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Trusthub.V1.A2PBrandRegistrationEmbeddedSessionInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Trusthub.V1.A2PBrandRegistrationEmbeddedSessionInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end