twilio-ruby 7.4.4 → 7.10.4

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [ShortCodeList] ShortCodeList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/ShortCodes"
@@ -58,6 +59,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the ShortCodeInstanceMetadata
+                    # @param [String] short_code_sid The SID of the ShortCode resource being added to the Service.
+                    # @return [ShortCodeInstance] Created ShortCodeInstance
+                    def create_with_metadata(
+                      short_code_sid: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'ShortCodeSid' => short_code_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        short_code_instance = ShortCodeInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        ShortCodeInstanceMetadata.new(
+                            @version,
+                            short_code_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists ShortCodeInstance 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 ShortCodePageMetadata 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)
+
+                        ShortCodePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields ShortCodeInstance 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 ShortCodeInstance
-                    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 [ShortCodeContext] ShortCodeContext
                     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 ShortCodeInstanceMetadata
+                    # @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)
+                          shortCode_instance = ShortCodeInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ShortCodeInstanceMetadata.new(@version, shortCode_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the ShortCodeInstance
                     # @return [ShortCodeInstance] Fetched ShortCodeInstance
@@ -203,6 +279,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ShortCodeInstanceMetadata
+                    # @return [ShortCodeInstance] Fetched ShortCodeInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        short_code_instance = ShortCodeInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        ShortCodeInstanceMetadata.new(
+                            @version,
+                            short_code_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -219,6 +321,53 @@ module Twilio
                     end
                 end
 
+                class ShortCodeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ShortCodeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ShortCodeInstance] short_code_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 [ShortCodeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, short_code_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @short_code_instance = short_code_instance
+                    end
+
+                    def short_code
+                        @short_code_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ShortCodeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ShortCodeListResponse < InstanceListResource
+                    # @param [Array<ShortCodeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @short_code_instance = payload.body[key].map do |data|
+                        ShortCodeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def short_code_instance
+                          @instance
+                      end
+                  end
+
                 class ShortCodePage < Page
                     ##
                     # Initialize the ShortCodePage
@@ -228,6 +377,7 @@ module Twilio
                     # @return [ShortCodePage] ShortCodePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -247,6 +397,66 @@ module Twilio
                         '<Twilio.Messaging.V1.ShortCodePage>'
                     end
                 end
+
+                class ShortCodePageMetadata < PageMetadata
+                    attr_reader :short_code_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @short_code_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @short_code_page << ShortCodeListResponse.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
+                        @short_code_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Messaging::V1PageMetadata>';
+                    end
+                end
+                class ShortCodeListResponse < InstanceListResource
+
+                    # @param [Array<ShortCodeInstance>] 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
+                      @short_code = data_list.map do |data|
+                        ShortCodeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def short_code
+                        @short_code
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ShortCodeInstance < InstanceResource
                     ##
                     # Initialize the ShortCodeInstance
@@ -260,6 +470,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],