twilio-ruby 7.4.4 → 7.10.4

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [DestinationAlphaSenderList] DestinationAlphaSenderList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/DestinationAlphaSenders"
@@ -61,11 +62,47 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the DestinationAlphaSenderInstanceMetadata
+                    # @param [String] alpha_sender The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen `-`, plus `+`, underscore `_` and ampersand `&`. This value cannot contain only numbers.
+                    # @param [String] iso_country_code The Optional Two Character ISO Country Code the Alphanumeric Sender ID will be used for. If the IsoCountryCode is not provided, a default Alpha Sender will be created that can be used across all countries.
+                    # @return [DestinationAlphaSenderInstance] Created DestinationAlphaSenderInstance
+                    def create_with_metadata(
+                      alpha_sender: nil, 
+                      iso_country_code: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'AlphaSender' => alpha_sender,
+                            'IsoCountryCode' => iso_country_code,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        destination_alpha_sender_instance = DestinationAlphaSenderInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        DestinationAlphaSenderInstanceMetadata.new(
+                            @version,
+                            destination_alpha_sender_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists DestinationAlphaSenderInstance records from the API as a list.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
+                    # @param [String] iso_country_code Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code.
                     # @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
@@ -73,8 +110,9 @@ module Twilio
                     #    but a limit is defined, stream() will attempt to read the limit with the most
                     #    efficient page size, i.e. min(limit, 1000)
                     # @return [Array] Array of up to limit results
-                    def list(limit: nil, page_size: nil)
+                    def list(iso_country_code: :unset, limit: nil, page_size: nil)
                         self.stream(
+                            iso_country_code: iso_country_code,
                             limit: limit,
                             page_size: page_size
                         ).entries
@@ -84,6 +122,7 @@ module Twilio
                     # Streams Instance records from the API as an Enumerable.
                     # This operation lazily loads records as efficiently as possible until the limit
                     # is reached.
+                    # @param [String] iso_country_code Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code.
                     # @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
@@ -91,15 +130,40 @@ module Twilio
                     #    but a limit is defined, stream() will attempt to read the limit with the most
                     #    efficient page size, i.e. min(limit, 1000)
                     # @return [Enumerable] Enumerable that will yield up to limit results
-                    def stream(limit: nil, page_size: nil)
+                    def stream(iso_country_code: :unset, limit: nil, page_size: nil)
                         limits = @version.read_limits(limit, page_size)
 
                         page = self.page(
+                            iso_country_code: iso_country_code,
                             page_size: limits[:page_size], )
 
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists DestinationAlphaSenderPageMetadata records from the API as a list.
+                      # @param [String] iso_country_code Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code.
+                    # @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(iso_country_code: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'IsoCountryCode' => iso_country_code,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        DestinationAlphaSenderPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields DestinationAlphaSenderInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -117,12 +181,14 @@ module Twilio
                     ##
                     # Retrieve a single page of DestinationAlphaSenderInstance records from the API.
                     # Request is executed immediately.
+                    # @param [String] iso_country_code Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code.
                     # @param [String] page_token PageToken provided by the API
                     # @param [Integer] page_number Page Number, this value is simply for client state
                     # @param [Integer] page_size Number of records to return, defaults to 50
                     # @return [Page] Page of DestinationAlphaSenderInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(iso_country_code: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
+                            'IsoCountryCode' => iso_country_code,
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
@@ -167,6 +233,7 @@ module Twilio
                     # @return [DestinationAlphaSenderContext] DestinationAlphaSenderContext
                     def initialize(version, service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, sid: sid,  }
@@ -183,9 +250,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the DestinationAlphaSenderInstanceMetadata
+                    # @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)
+                          destinationAlphaSender_instance = DestinationAlphaSenderInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          DestinationAlphaSenderInstanceMetadata.new(@version, destinationAlphaSender_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the DestinationAlphaSenderInstance
                     # @return [DestinationAlphaSenderInstance] Fetched DestinationAlphaSenderInstance
@@ -206,6 +293,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the DestinationAlphaSenderInstanceMetadata
+                    # @return [DestinationAlphaSenderInstance] Fetched DestinationAlphaSenderInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        destination_alpha_sender_instance = DestinationAlphaSenderInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        DestinationAlphaSenderInstanceMetadata.new(
+                            @version,
+                            destination_alpha_sender_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -222,6 +335,53 @@ module Twilio
                     end
                 end
 
+                class DestinationAlphaSenderInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new DestinationAlphaSenderInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}DestinationAlphaSenderInstance] destination_alpha_sender_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 [DestinationAlphaSenderInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, destination_alpha_sender_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @destination_alpha_sender_instance = destination_alpha_sender_instance
+                    end
+
+                    def destination_alpha_sender
+                        @destination_alpha_sender_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.DestinationAlphaSenderInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class DestinationAlphaSenderListResponse < InstanceListResource
+                    # @param [Array<DestinationAlphaSenderInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @destination_alpha_sender_instance = payload.body[key].map do |data|
+                        DestinationAlphaSenderInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def destination_alpha_sender_instance
+                          @instance
+                      end
+                  end
+
                 class DestinationAlphaSenderPage < Page
                     ##
                     # Initialize the DestinationAlphaSenderPage
@@ -231,6 +391,7 @@ module Twilio
                     # @return [DestinationAlphaSenderPage] DestinationAlphaSenderPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -250,6 +411,66 @@ module Twilio
                         '<Twilio.Messaging.V1.DestinationAlphaSenderPage>'
                     end
                 end
+
+                class DestinationAlphaSenderPageMetadata < PageMetadata
+                    attr_reader :destination_alpha_sender_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @destination_alpha_sender_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @destination_alpha_sender_page << DestinationAlphaSenderListResponse.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
+                        @destination_alpha_sender_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class DestinationAlphaSenderListResponse < InstanceListResource
+
+                    # @param [Array<DestinationAlphaSenderInstance>] 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
+                      @destination_alpha_sender = data_list.map do |data|
+                        DestinationAlphaSenderInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def destination_alpha_sender
+                        @destination_alpha_sender
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class DestinationAlphaSenderInstance < InstanceResource
                     ##
                     # Initialize the DestinationAlphaSenderInstance
@@ -263,6 +484,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [PhoneNumberList] PhoneNumberList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers"
@@ -58,6 +59,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the PhoneNumberInstanceMetadata
+                    # @param [String] phone_number_sid The SID of the Phone Number being added to the Service.
+                    # @return [PhoneNumberInstance] Created PhoneNumberInstance
+                    def create_with_metadata(
+                      phone_number_sid: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'PhoneNumberSid' => phone_number_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        phone_number_instance = PhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        PhoneNumberInstanceMetadata.new(
+                            @version,
+                            phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists PhoneNumberInstance 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 PhoneNumberPageMetadata 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)
+
+                        PhoneNumberPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields PhoneNumberInstance 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 PhoneNumberInstance
-                    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 [PhoneNumberContext] PhoneNumberContext
                     def initialize(version, service_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, sid: sid,  }
@@ -180,9 +236,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the PhoneNumberInstanceMetadata
+                    # @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)
+                          phoneNumber_instance = PhoneNumberInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          PhoneNumberInstanceMetadata.new(@version, phoneNumber_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the PhoneNumberInstance
                     # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
@@ -203,6 +279,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the PhoneNumberInstanceMetadata
+                    # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        phone_number_instance = PhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        PhoneNumberInstanceMetadata.new(
+                            @version,
+                            phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -219,6 +321,53 @@ module Twilio
                     end
                 end
 
+                class PhoneNumberInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PhoneNumberInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PhoneNumberInstance] phone_number_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 [PhoneNumberInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, phone_number_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @phone_number_instance = phone_number_instance
+                    end
+
+                    def phone_number
+                        @phone_number_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PhoneNumberInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PhoneNumberListResponse < InstanceListResource
+                    # @param [Array<PhoneNumberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @phone_number_instance = payload.body[key].map do |data|
+                        PhoneNumberInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def phone_number_instance
+                          @instance
+                      end
+                  end
+
                 class PhoneNumberPage < Page
                     ##
                     # Initialize the PhoneNumberPage
@@ -228,6 +377,7 @@ module Twilio
                     # @return [PhoneNumberPage] PhoneNumberPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -247,6 +397,66 @@ module Twilio
                         '<Twilio.Messaging.V1.PhoneNumberPage>'
                     end
                 end
+
+                class PhoneNumberPageMetadata < PageMetadata
+                    attr_reader :phone_number_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @phone_number_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @phone_number_page << PhoneNumberListResponse.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
+                        @phone_number_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class PhoneNumberListResponse < InstanceListResource
+
+                    # @param [Array<PhoneNumberInstance>] 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
+                      @phone_number = data_list.map do |data|
+                        PhoneNumberInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def phone_number
+                        @phone_number
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class PhoneNumberInstance < InstanceResource
                     ##
                     # Initialize the PhoneNumberInstance
@@ -260,6 +470,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],