twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/verify/v2/service/entity.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [EntityList] EntityList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Entities"
@@ -58,6 +59,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the EntityInstanceMetadata
+                    # @param [String] identity The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
+                    # @return [EntityInstance] Created EntityInstance
+                    def create_with_metadata(
+                      identity: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Identity' => identity,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        entity_instance = EntityInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        EntityInstanceMetadata.new(
+                            @version,
+                            entity_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists EntityInstance records from the API as a list.
@@ -97,6 +130,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists EntityPageMetadata 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)
+
+                        EntityPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields EntityInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -118,7 +173,7 @@ 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 EntityInstance
-                    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,
@@ -164,6 +219,7 @@ module Twilio
                     # @return [EntityContext] EntityContext
                     def initialize(version, service_sid, identity)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, identity: identity,  }
@@ -183,9 +239,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the EntityInstanceMetadata
+                    # @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)
+                          entity_instance = EntityInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          EntityInstanceMetadata.new(@version, entity_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the EntityInstance
                     # @return [EntityInstance] Fetched EntityInstance
@@ -206,6 +282,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the EntityInstanceMetadata
+                    # @return [EntityInstance] Fetched EntityInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        entity_instance = EntityInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            identity: @solution[:identity],
+                        )
+                        EntityInstanceMetadata.new(
+                            @version,
+                            entity_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the new_factors
                     # @return [NewFactorList]
@@ -271,6 +373,53 @@ module Twilio
                     end
                 end
 
+                class EntityInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new EntityInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}EntityInstance] entity_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 [EntityInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, entity_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @entity_instance = entity_instance
+                    end
+
+                    def entity
+                        @entity_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.EntityInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class EntityListResponse < InstanceListResource
+                    # @param [Array<EntityInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @entity_instance = payload.body[key].map do |data|
+                        EntityInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def entity_instance
+                          @instance
+                      end
+                  end
+
                 class EntityPage < Page
                     ##
                     # Initialize the EntityPage
@@ -280,6 +429,7 @@ module Twilio
                     # @return [EntityPage] EntityPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -299,6 +449,66 @@ module Twilio
                         '<Twilio.Verify.V2.EntityPage>'
                     end
                 end
+
+                class EntityPageMetadata < PageMetadata
+                    attr_reader :entity_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @entity_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @entity_page << EntityListResponse.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
+                        @entity_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class EntityListResponse < InstanceListResource
+
+                    # @param [Array<EntityInstance>] 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
+                      @entity = data_list.map do |data|
+                        EntityInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def entity
+                        @entity
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class EntityInstance < InstanceResource
                     ##
                     # Initialize the EntityInstance
@@ -312,6 +522,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, identity: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [MessagingConfigurationList] MessagingConfigurationList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/MessagingConfigurations"
@@ -61,6 +62,41 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the MessagingConfigurationInstanceMetadata
+                    # @param [String] country The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
+                    # @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
+                    # @return [MessagingConfigurationInstance] Created MessagingConfigurationInstance
+                    def create_with_metadata(
+                      country: nil, 
+                      messaging_service_sid: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Country' => country,
+                            'MessagingServiceSid' => messaging_service_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        messaging_configuration_instance = MessagingConfigurationInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        MessagingConfigurationInstanceMetadata.new(
+                            @version,
+                            messaging_configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists MessagingConfigurationInstance records from the API as a list.
@@ -100,6 +136,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists MessagingConfigurationPageMetadata 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)
+
+                        MessagingConfigurationPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields MessagingConfigurationInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -121,7 +179,7 @@ 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 MessagingConfigurationInstance
-                    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,
@@ -167,6 +225,7 @@ module Twilio
                     # @return [MessagingConfigurationContext] MessagingConfigurationContext
                     def initialize(version, service_sid, country)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, country: country,  }
@@ -183,9 +242,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the MessagingConfigurationInstanceMetadata
+                    # @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)
+                          messagingConfiguration_instance = MessagingConfigurationInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          MessagingConfigurationInstanceMetadata.new(@version, messagingConfiguration_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the MessagingConfigurationInstance
                     # @return [MessagingConfigurationInstance] Fetched MessagingConfigurationInstance
@@ -206,6 +285,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the MessagingConfigurationInstanceMetadata
+                    # @return [MessagingConfigurationInstance] Fetched MessagingConfigurationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        messaging_configuration_instance = MessagingConfigurationInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            country: @solution[:country],
+                        )
+                        MessagingConfigurationInstanceMetadata.new(
+                            @version,
+                            messaging_configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the MessagingConfigurationInstance
                     # @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
@@ -233,6 +338,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the MessagingConfigurationInstanceMetadata
+                    # @param [String] messaging_service_sid The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
+                    # @return [MessagingConfigurationInstance] Updated MessagingConfigurationInstance
+                    def update_with_metadata(
+                      messaging_service_sid: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'MessagingServiceSid' => messaging_service_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        messaging_configuration_instance = MessagingConfigurationInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            country: @solution[:country],
+                        )
+                        MessagingConfigurationInstanceMetadata.new(
+                            @version,
+                            messaging_configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -249,6 +387,53 @@ module Twilio
                     end
                 end
 
+                class MessagingConfigurationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new MessagingConfigurationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}MessagingConfigurationInstance] messaging_configuration_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 [MessagingConfigurationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, messaging_configuration_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @messaging_configuration_instance = messaging_configuration_instance
+                    end
+
+                    def messaging_configuration
+                        @messaging_configuration_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.MessagingConfigurationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class MessagingConfigurationListResponse < InstanceListResource
+                    # @param [Array<MessagingConfigurationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @messaging_configuration_instance = payload.body[key].map do |data|
+                        MessagingConfigurationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def messaging_configuration_instance
+                          @instance
+                      end
+                  end
+
                 class MessagingConfigurationPage < Page
                     ##
                     # Initialize the MessagingConfigurationPage
@@ -258,6 +443,7 @@ module Twilio
                     # @return [MessagingConfigurationPage] MessagingConfigurationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -277,6 +463,66 @@ module Twilio
                         '<Twilio.Verify.V2.MessagingConfigurationPage>'
                     end
                 end
+
+                class MessagingConfigurationPageMetadata < PageMetadata
+                    attr_reader :messaging_configuration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @messaging_configuration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @messaging_configuration_page << MessagingConfigurationListResponse.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
+                        @messaging_configuration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Verify::V2PageMetadata>';
+                    end
+                end
+                class MessagingConfigurationListResponse < InstanceListResource
+
+                    # @param [Array<MessagingConfigurationInstance>] 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
+                      @messaging_configuration = data_list.map do |data|
+                        MessagingConfigurationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def messaging_configuration
+                        @messaging_configuration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class MessagingConfigurationInstance < InstanceResource
                     ##
                     # Initialize the MessagingConfigurationInstance
@@ -290,6 +536,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, country: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],