twilio-ruby 7.10.6 → 7.11.1

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

@@ -0,0 +1,321 @@
+##
+#    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 A2PCampaignRegistrationList < ListResource
+                
+                    class TrusthubV1A2pCampaignRegistrationRequest
+                            # @param [a2p_brand_registration_sid]: [String] The legacy Twilio A2P Brand SID (BN-prefixed) for the brand this campaign is registered under. This is a different identifier from the `id` returned by the Initialize Brand endpoint (which is formatted as `tri1.us1.account.AC.../registration.BU...`). Retrieve the BN brand SID via [GET /v1/a2p/BrandRegistrations/{Sid}](https://www.twilio.com/docs/messaging/api/brand-registration-resource) on `messaging.twilio.com`.
+                            # @param [messaging_service_sid]: [String] The SID of the Messaging Service.
+                            # @param [theme_set_id]: [String] Theme ID for styling the inquiry form.
+                            # @param [use_case_categories]: [Array<String>] The categories of the messaging use case.
+                            # @param [use_case_description]: [String] A description of the messaging use case.
+                            # @param [use_case_sample_message1]: [String] A sample message for the use case.
+                            # @param [use_case_sample_message2]: [String] A second sample message for the use case.
+                            # @param [use_case_sample_message3]: [String] A third sample message for the use case.
+                            # @param [use_case_sample_message4]: [String] A fourth sample message for the use case.
+                            # @param [use_case_sample_message5]: [String] A fifth sample message for the use case.
+                            # @param [use_case_opt_in_types]: [Array<String>] The opt-in methods for the use case.
+                            # @param [use_case_opt_in_description]: [String] A description of the opt-in process.
+                            # @param [has_embedded_links]: [Boolean] Whether messages will contain embedded links.
+                            # @param [has_embedded_phone]: [Boolean] Whether messages will contain embedded phone numbers.
+                            # @param [embedded_url_sample]: [String] A sample URL that will be embedded in messages (must use https://).
+                            # @param [direct_lending]: [Boolean] Whether the campaign involves direct lending.
+                            # @param [age_gated]: [Boolean] Whether the content is age-gated.
+                            # @param [privacy_policy_url]: [String] The URL to the privacy policy.
+                            # @param [terms_and_conditions_url]: [String] The URL to the terms and conditions.
+                            # @param [opt_in_keywords]: [Array<String>] Keywords users can text to opt in.
+                            # @param [opt_in_message_sample]: [String] A sample opt-in confirmation message.
+                            # @param [opt_out_keywords]: [Array<String>] Keywords users can text to opt out.
+                            # @param [opt_out_message_sample]: [String] A sample opt-out confirmation message.
+                            # @param [help_keywords]: [Array<String>] Keywords users can text for help.
+                            # @param [help_message_sample]: [String] A sample help message.
+                        attr_accessor :a2p_brand_registration_sid, :messaging_service_sid, :theme_set_id, :use_case_categories, :use_case_description, :use_case_sample_message1, :use_case_sample_message2, :use_case_sample_message3, :use_case_sample_message4, :use_case_sample_message5, :use_case_opt_in_types, :use_case_opt_in_description, :has_embedded_links, :has_embedded_phone, :embedded_url_sample, :direct_lending, :age_gated, :privacy_policy_url, :terms_and_conditions_url, :opt_in_keywords, :opt_in_message_sample, :opt_out_keywords, :opt_out_message_sample, :help_keywords, :help_message_sample
+                        def initialize(payload)
+                                @a2p_brand_registration_sid = payload["a2p_brand_registration_sid"]
+                                @messaging_service_sid = payload["messaging_service_sid"]
+                                @theme_set_id = payload["theme_set_id"]
+                                @use_case_categories = payload["use_case_categories"]
+                                @use_case_description = payload["use_case_description"]
+                                @use_case_sample_message1 = payload["use_case_sample_message1"]
+                                @use_case_sample_message2 = payload["use_case_sample_message2"]
+                                @use_case_sample_message3 = payload["use_case_sample_message3"]
+                                @use_case_sample_message4 = payload["use_case_sample_message4"]
+                                @use_case_sample_message5 = payload["use_case_sample_message5"]
+                                @use_case_opt_in_types = payload["use_case_opt_in_types"]
+                                @use_case_opt_in_description = payload["use_case_opt_in_description"]
+                                @has_embedded_links = payload["has_embedded_links"]
+                                @has_embedded_phone = payload["has_embedded_phone"]
+                                @embedded_url_sample = payload["embedded_url_sample"]
+                                @direct_lending = payload["direct_lending"]
+                                @age_gated = payload["age_gated"]
+                                @privacy_policy_url = payload["privacy_policy_url"]
+                                @terms_and_conditions_url = payload["terms_and_conditions_url"]
+                                @opt_in_keywords = payload["opt_in_keywords"]
+                                @opt_in_message_sample = payload["opt_in_message_sample"]
+                                @opt_out_keywords = payload["opt_out_keywords"]
+                                @opt_out_message_sample = payload["opt_out_message_sample"]
+                                @help_keywords = payload["help_keywords"]
+                                @help_message_sample = payload["help_message_sample"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "a2pBrandRegistrationSid": @a2p_brand_registration_sid,
+                                "messagingServiceSid": @messaging_service_sid,
+                                "themeSetId": @theme_set_id,
+                                "useCaseCategories": @use_case_categories,
+                                "useCaseDescription": @use_case_description,
+                                "useCaseSampleMessage1": @use_case_sample_message1,
+                                "useCaseSampleMessage2": @use_case_sample_message2,
+                                "useCaseSampleMessage3": @use_case_sample_message3,
+                                "useCaseSampleMessage4": @use_case_sample_message4,
+                                "useCaseSampleMessage5": @use_case_sample_message5,
+                                "useCaseOptInTypes": @use_case_opt_in_types,
+                                "useCaseOptInDescription": @use_case_opt_in_description,
+                                "hasEmbeddedLinks": @has_embedded_links,
+                                "hasEmbeddedPhone": @has_embedded_phone,
+                                "embeddedUrlSample": @embedded_url_sample,
+                                "directLending": @direct_lending,
+                                "ageGated": @age_gated,
+                                "privacyPolicyUrl": @privacy_policy_url,
+                                "termsAndConditionsUrl": @terms_and_conditions_url,
+                                "optInKeywords": @opt_in_keywords,
+                                "optInMessageSample": @opt_in_message_sample,
+                                "optOutKeywords": @opt_out_keywords,
+                                "optOutMessageSample": @opt_out_message_sample,
+                                "helpKeywords": @help_keywords,
+                                "helpMessageSample": @help_message_sample,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the A2PCampaignRegistrationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [A2PCampaignRegistrationList] A2PCampaignRegistrationList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/A2PCampaignRegistrations"
+                        
+                    end
+                    ##
+                    # Create the A2PCampaignRegistrationInstance
+                    # @param [TrusthubV1A2pCampaignRegistrationRequest] trusthub_v1_a2p_campaign_registration_request 
+                    # @return [A2PCampaignRegistrationInstance] Created A2PCampaignRegistrationInstance
+                    def create(trusthub_v1_a2p_campaign_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_campaign_registration_request.to_json)
+                        A2PCampaignRegistrationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the A2PCampaignRegistrationInstanceMetadata
+                    # @param [TrusthubV1A2pCampaignRegistrationRequest] trusthub_v1_a2p_campaign_registration_request 
+                    # @return [A2PCampaignRegistrationInstance] Created A2PCampaignRegistrationInstance
+                    def create_with_metadata(trusthub_v1_a2p_campaign_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_campaign_registration_request.to_json)
+                        a2_p_campaign_registration_instance = A2PCampaignRegistrationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        A2PCampaignRegistrationInstanceMetadata.new(
+                            @version,
+                            a2_p_campaign_registration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Trusthub.V1.A2PCampaignRegistrationList>'
+                    end
+                end
+
+                class A2PCampaignRegistrationPage < Page
+                    ##
+                    # Initialize the A2PCampaignRegistrationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [A2PCampaignRegistrationPage] A2PCampaignRegistrationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of A2PCampaignRegistrationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [A2PCampaignRegistrationInstance] A2PCampaignRegistrationInstance
+                    def get_instance(payload)
+                        A2PCampaignRegistrationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Trusthub.V1.A2PCampaignRegistrationPage>'
+                    end
+                end
+
+                class A2PCampaignRegistrationPageMetadata < PageMetadata
+                    attr_reader :a2_p_campaign_registration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @a2_p_campaign_registration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @a2_p_campaign_registration_page << A2PCampaignRegistrationListResponse.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_campaign_registration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Trusthub::V1PageMetadata>';
+                    end
+                end
+                class A2PCampaignRegistrationListResponse < InstanceListResource
+
+                    # @param [Array<A2PCampaignRegistrationInstance>] 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_campaign_registration = data_list.map do |data|
+                        A2PCampaignRegistrationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def a2_p_campaign_registration
+                        @a2_p_campaign_registration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class A2PCampaignRegistrationInstance < InstanceResource
+                    ##
+                    # Initialize the A2PCampaignRegistrationInstance
+                    # @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 A2PCampaignRegistration
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [A2PCampaignRegistrationInstance] A2PCampaignRegistrationInstance
+                    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.A2PCampaignRegistrationInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Trusthub.V1.A2PCampaignRegistrationInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/trusthub/v1/a2p_campaign_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 A2PCampaignRegistrationEmbeddedSessionList < ListResource
+                
+                    ##
+                    # Initialize the A2PCampaignRegistrationEmbeddedSessionList
+                    # @param [Version] version Version that contains the resource
+                    # @return [A2PCampaignRegistrationEmbeddedSessionList] A2PCampaignRegistrationEmbeddedSessionList
+                    def initialize(version, id: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { id: id }
+                        @uri = "/A2PCampaignRegistrations/#{@solution[:id]}/EmbeddedSessions"
+                        
+                    end
+                    ##
+                    # Create the A2PCampaignRegistrationEmbeddedSessionInstance
+                    # @return [A2PCampaignRegistrationEmbeddedSessionInstance] Created A2PCampaignRegistrationEmbeddedSessionInstance
+                    def create
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers)
+                        A2PCampaignRegistrationEmbeddedSessionInstance.new(
+                            @version,
+                            payload,
+                            id: @solution[:id],
+                        )
+                    end
+
+                    ##
+                    # Create the A2PCampaignRegistrationEmbeddedSessionInstanceMetadata
+                    # @return [A2PCampaignRegistrationEmbeddedSessionInstance] Created A2PCampaignRegistrationEmbeddedSessionInstance
+                    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_campaign_registration_embedded_session_instance = A2PCampaignRegistrationEmbeddedSessionInstance.new(
+                            @version,
+                            response.body,
+                            id: @solution[:id],
+                        )
+                        A2PCampaignRegistrationEmbeddedSessionInstanceMetadata.new(
+                            @version,
+                            a2_p_campaign_registration_embedded_session_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Trusthub.V1.A2PCampaignRegistrationEmbeddedSessionList>'
+                    end
+                end
+
+                class A2PCampaignRegistrationEmbeddedSessionPage < Page
+                    ##
+                    # Initialize the A2PCampaignRegistrationEmbeddedSessionPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [A2PCampaignRegistrationEmbeddedSessionPage] A2PCampaignRegistrationEmbeddedSessionPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of A2PCampaignRegistrationEmbeddedSessionInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [A2PCampaignRegistrationEmbeddedSessionInstance] A2PCampaignRegistrationEmbeddedSessionInstance
+                    def get_instance(payload)
+                        A2PCampaignRegistrationEmbeddedSessionInstance.new(@version, payload, id: @solution[:id])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Trusthub.V1.A2PCampaignRegistrationEmbeddedSessionPage>'
+                    end
+                end
+
+                class A2PCampaignRegistrationEmbeddedSessionPageMetadata < PageMetadata
+                    attr_reader :a2_p_campaign_registration_embedded_session_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @a2_p_campaign_registration_embedded_session_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @a2_p_campaign_registration_embedded_session_page << A2PCampaignRegistrationEmbeddedSessionListResponse.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_campaign_registration_embedded_session_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Trusthub::V1PageMetadata>';
+                    end
+                end
+                class A2PCampaignRegistrationEmbeddedSessionListResponse < InstanceListResource
+
+                    # @param [Array<A2PCampaignRegistrationEmbeddedSessionInstance>] 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_campaign_registration_embedded_session = data_list.map do |data|
+                        A2PCampaignRegistrationEmbeddedSessionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def a2_p_campaign_registration_embedded_session
+                        @a2_p_campaign_registration_embedded_session
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class A2PCampaignRegistrationEmbeddedSessionInstance < InstanceResource
+                    ##
+                    # Initialize the A2PCampaignRegistrationEmbeddedSessionInstance
+                    # @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 A2PCampaignRegistrationEmbeddedSession
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [A2PCampaignRegistrationEmbeddedSessionInstance] A2PCampaignRegistrationEmbeddedSessionInstance
+                    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.A2PCampaignRegistrationEmbeddedSessionInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Trusthub.V1.A2PCampaignRegistrationEmbeddedSessionInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end