twilio-ruby 7.3.3 → 7.10.1

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [UsAppToPersonList] UsAppToPersonList
                     def initialize(version, messaging_service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { messaging_service_sid: messaging_service_sid }
                         @uri = "/Services/#{@solution[:messaging_service_sid]}/Compliance/Usa2p"
@@ -91,6 +92,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         UsAppToPersonInstance.new(
                             @version,
@@ -99,6 +104,83 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the UsAppToPersonInstanceMetadata
+                    # @param [String] brand_registration_sid A2P Brand Registration SID
+                    # @param [String] description A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
+                    # @param [String] message_flow Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.
+                    # @param [Array[String]] message_samples An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.
+                    # @param [String] us_app_to_person_usecase A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]
+                    # @param [Boolean] has_embedded_links Indicates that this SMS campaign will send messages that contain links.
+                    # @param [Boolean] has_embedded_phone Indicates that this SMS campaign will send messages that contain phone numbers.
+                    # @param [String] opt_in_message If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum.
+                    # @param [String] opt_out_message Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.
+                    # @param [String] help_message When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.
+                    # @param [Array[String]] opt_in_keywords If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum.
+                    # @param [Array[String]] opt_out_keywords End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.
+                    # @param [Array[String]] help_keywords End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.
+                    # @param [Boolean] subscriber_opt_in A boolean that specifies whether campaign has Subscriber Optin or not.
+                    # @param [Boolean] age_gated A boolean that specifies whether campaign is age gated or not.
+                    # @param [Boolean] direct_lending A boolean that specifies whether campaign allows direct lending or not.
+                    # @return [UsAppToPersonInstance] Created UsAppToPersonInstance
+                    def create_with_metadata(
+                      brand_registration_sid: nil, 
+                      description: nil, 
+                      message_flow: nil, 
+                      message_samples: nil, 
+                      us_app_to_person_usecase: nil, 
+                      has_embedded_links: nil, 
+                      has_embedded_phone: nil, 
+                      opt_in_message: :unset, 
+                      opt_out_message: :unset, 
+                      help_message: :unset, 
+                      opt_in_keywords: :unset, 
+                      opt_out_keywords: :unset, 
+                      help_keywords: :unset, 
+                      subscriber_opt_in: :unset, 
+                      age_gated: :unset, 
+                      direct_lending: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'BrandRegistrationSid' => brand_registration_sid,
+                            'Description' => description,
+                            'MessageFlow' => message_flow,
+                            'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
+                            'UsAppToPersonUsecase' => us_app_to_person_usecase,
+                            'HasEmbeddedLinks' => has_embedded_links,
+                            'HasEmbeddedPhone' => has_embedded_phone,
+                            'OptInMessage' => opt_in_message,
+                            'OptOutMessage' => opt_out_message,
+                            'HelpMessage' => help_message,
+                            'OptInKeywords' => Twilio.serialize_list(opt_in_keywords) { |e| e },
+                            'OptOutKeywords' => Twilio.serialize_list(opt_out_keywords) { |e| e },
+                            'HelpKeywords' => Twilio.serialize_list(help_keywords) { |e| e },
+                            'SubscriberOptIn' => subscriber_opt_in,
+                            'AgeGated' => age_gated,
+                            'DirectLending' => direct_lending,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        us_app_to_person_instance = UsAppToPersonInstance.new(
+                            @version,
+                            response.body,
+                            messaging_service_sid: @solution[:messaging_service_sid],
+                        )
+                        UsAppToPersonInstanceMetadata.new(
+                            @version,
+                            us_app_to_person_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists UsAppToPersonInstance records from the API as a list.
@@ -138,6 +220,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists UsAppToPersonPageMetadata records from the API as a list.
+                    # @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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        UsAppToPersonPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields UsAppToPersonInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -159,14 +263,17 @@ module Twilio
                     # @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 UsAppToPersonInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         UsAppToPersonPage.new(@version, response, @solution)
                     end
@@ -202,6 +309,7 @@ module Twilio
                     # @return [UsAppToPersonContext] UsAppToPersonContext
                     def initialize(version, messaging_service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { messaging_service_sid: messaging_service_sid, sid: sid,  }
@@ -216,9 +324,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the UsAppToPersonInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          usAppToPerson_instance = UsAppToPersonInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          UsAppToPersonInstanceMetadata.new(@version, usAppToPerson_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the UsAppToPersonInstance
                     # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
@@ -226,6 +356,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         UsAppToPersonInstance.new(
                             @version,
@@ -235,6 +369,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the UsAppToPersonInstanceMetadata
+                    # @return [UsAppToPersonInstance] Fetched UsAppToPersonInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        us_app_to_person_instance = UsAppToPersonInstance.new(
+                            @version,
+                            response.body,
+                            messaging_service_sid: @solution[:messaging_service_sid],
+                            sid: @solution[:sid],
+                        )
+                        UsAppToPersonInstanceMetadata.new(
+                            @version,
+                            us_app_to_person_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the UsAppToPersonInstance
                     # @param [Boolean] has_embedded_links Indicates that this SMS campaign will send messages that contain links.
@@ -267,6 +427,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         UsAppToPersonInstance.new(
                             @version,
@@ -276,6 +440,57 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the UsAppToPersonInstanceMetadata
+                    # @param [Boolean] has_embedded_links Indicates that this SMS campaign will send messages that contain links.
+                    # @param [Boolean] has_embedded_phone Indicates that this SMS campaign will send messages that contain phone numbers.
+                    # @param [Array[String]] message_samples An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.
+                    # @param [String] message_flow Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.
+                    # @param [String] description A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
+                    # @param [Boolean] age_gated A boolean that specifies whether campaign requires age gate for federally legal content.
+                    # @param [Boolean] direct_lending A boolean that specifies whether campaign allows direct lending or not.
+                    # @return [UsAppToPersonInstance] Updated UsAppToPersonInstance
+                    def update_with_metadata(
+                      has_embedded_links: nil, 
+                      has_embedded_phone: nil, 
+                      message_samples: nil, 
+                      message_flow: nil, 
+                      description: nil, 
+                      age_gated: nil, 
+                      direct_lending: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'HasEmbeddedLinks' => has_embedded_links,
+                            'HasEmbeddedPhone' => has_embedded_phone,
+                            'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
+                            'MessageFlow' => message_flow,
+                            'Description' => description,
+                            'AgeGated' => age_gated,
+                            'DirectLending' => direct_lending,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        us_app_to_person_instance = UsAppToPersonInstance.new(
+                            @version,
+                            response.body,
+                            messaging_service_sid: @solution[:messaging_service_sid],
+                            sid: @solution[:sid],
+                        )
+                        UsAppToPersonInstanceMetadata.new(
+                            @version,
+                            us_app_to_person_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -292,6 +507,53 @@ module Twilio
                     end
                 end
 
+                class UsAppToPersonInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new UsAppToPersonInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}UsAppToPersonInstance] us_app_to_person_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [UsAppToPersonInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, us_app_to_person_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @us_app_to_person_instance = us_app_to_person_instance
+                    end
+
+                    def us_app_to_person
+                        @us_app_to_person_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.UsAppToPersonInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class UsAppToPersonListResponse < InstanceListResource
+                    # @param [Array<UsAppToPersonInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @us_app_to_person_instance = payload.body[key].map do |data|
+                        UsAppToPersonInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def us_app_to_person_instance
+                          @instance
+                      end
+                  end
+
                 class UsAppToPersonPage < Page
                     ##
                     # Initialize the UsAppToPersonPage
@@ -301,6 +563,7 @@ module Twilio
                     # @return [UsAppToPersonPage] UsAppToPersonPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -320,6 +583,66 @@ module Twilio
                         '<Twilio.Messaging.V1.UsAppToPersonPage>'
                     end
                 end
+
+                class UsAppToPersonPageMetadata < PageMetadata
+                    attr_reader :us_app_to_person_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @us_app_to_person_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @us_app_to_person_page << UsAppToPersonListResponse.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
+                        @us_app_to_person_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class UsAppToPersonListResponse < InstanceListResource
+
+                    # @param [Array<UsAppToPersonInstance>] 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
+                      @us_app_to_person = data_list.map do |data|
+                        UsAppToPersonInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def us_app_to_person
+                        @us_app_to_person
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UsAppToPersonInstance < InstanceResource
                     ##
                     # Initialize the UsAppToPersonInstance
@@ -333,6 +656,7 @@ module Twilio
                     def initialize(version, payload , messaging_service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [UsAppToPersonUsecaseList] UsAppToPersonUsecaseList
                     def initialize(version, messaging_service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { messaging_service_sid: messaging_service_sid }
                         @uri = "/Services/#{@solution[:messaging_service_sid]}/Compliance/Usa2p/Usecases"
@@ -45,6 +46,10 @@ module Twilio
                         })
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         UsAppToPersonUsecaseInstance.new(
                             @version,
@@ -53,6 +58,37 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the UsAppToPersonUsecaseInstanceMetadata
+                    # @param [String] brand_registration_sid The unique string to identify the A2P brand.
+                    # @return [UsAppToPersonUsecaseInstance] Fetched UsAppToPersonUsecaseInstance
+                    def fetch_with_metadata(
+                      brand_registration_sid: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'BrandRegistrationSid' => brand_registration_sid,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        us_app_to_person_usecase_instance = UsAppToPersonUsecaseInstance.new(
+                            @version,
+                            response.body,
+                            messaging_service_sid: @solution[:messaging_service_sid],
+                        )
+                        UsAppToPersonUsecaseInstanceMetadata.new(
+                            @version,
+                            us_app_to_person_usecase_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -71,6 +107,7 @@ module Twilio
                     # @return [UsAppToPersonUsecasePage] UsAppToPersonUsecasePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -90,6 +127,66 @@ module Twilio
                         '<Twilio.Messaging.V1.UsAppToPersonUsecasePage>'
                     end
                 end
+
+                class UsAppToPersonUsecasePageMetadata < PageMetadata
+                    attr_reader :us_app_to_person_usecase_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @us_app_to_person_usecase_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @us_app_to_person_usecase_page << UsAppToPersonUsecaseListResponse.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
+                        @us_app_to_person_usecase_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class UsAppToPersonUsecaseListResponse < InstanceListResource
+
+                    # @param [Array<UsAppToPersonUsecaseInstance>] 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
+                      @us_app_to_person_usecase = data_list.map do |data|
+                        UsAppToPersonUsecaseInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def us_app_to_person_usecase
+                        @us_app_to_person_usecase
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UsAppToPersonUsecaseInstance < InstanceResource
                     ##
                     # Initialize the UsAppToPersonUsecaseInstance
@@ -103,6 +200,7 @@ module Twilio
                     def initialize(version, payload , messaging_service_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'us_app_to_person_usecases' => payload['us_app_to_person_usecases'],