twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/wireless/v1/usage_record.rb

@@ -18,12 +18,14 @@ module Twilio
         class Wireless < WirelessBase
             class V1 < Version
                 class UsageRecordList < ListResource
+                
                     ##
                     # Initialize the UsageRecordList
                     # @param [Version] version Version that contains the resource
                     # @return [UsageRecordList] UsageRecordList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/UsageRecords"
@@ -77,7 +79,39 @@ module Twilio
                             granularity: granularity,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists UsageRecordPageMetadata records from the API as a list.
+                      # @param [Time] end_ Only include usage that has occurred on or before this date. Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).
+                      # @param [Time] start Only include usage that has occurred on or after this date. Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).
+                      # @param [Granularity] granularity How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage Record that describes the usage for the entire period.
+                    # @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(end_: :unset, start: :unset, granularity: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'End' =>  Twilio.serialize_iso8601_datetime(end_),
+                            'Start' =>  Twilio.serialize_iso8601_datetime(start),
+                            'Granularity' => granularity,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        UsageRecordPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -89,9 +123,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -104,7 +142,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 UsageRecordInstance
-                    def page(end_: :unset, start: :unset, granularity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(end_: :unset, start: :unset, granularity: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'End' =>  Twilio.serialize_iso8601_datetime(end_),
                             'Start' =>  Twilio.serialize_iso8601_datetime(start),
@@ -113,8 +151,11 @@ module Twilio
                             '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)
 
                         UsageRecordPage.new(@version, response, @solution)
                     end
@@ -149,6 +190,7 @@ module Twilio
                     # @return [UsageRecordPage] UsageRecordPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -168,6 +210,66 @@ module Twilio
                         '<Twilio.Wireless.V1.UsageRecordPage>'
                     end
                 end
+
+                class UsageRecordPageMetadata < PageMetadata
+                    attr_reader :usage_record_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @usage_record_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @usage_record_page << UsageRecordListResponse.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
+                        @usage_record_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Wireless::V1PageMetadata>';
+                    end
+                end
+                class UsageRecordListResponse < InstanceListResource
+
+                    # @param [Array<UsageRecordInstance>] 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
+                      @usage_record = data_list.map do |data|
+                        UsageRecordInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def usage_record
+                        @usage_record
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UsageRecordInstance < InstanceResource
                     ##
                     # Initialize the UsageRecordInstance
@@ -181,6 +283,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

data/lib/twilio-ruby/rest/wireless/v1.rb

@@ -35,6 +35,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @commands ||= CommandList.new self
                     else
@@ -49,6 +50,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @rate_plans ||= RatePlanList.new self
                     else
@@ -63,6 +65,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @sims ||= SimList.new self
                     else

data/lib/twilio-ruby/twiml/messaging_response.rb

@@ -23,7 +23,7 @@ module Twilio
       # body:: Message Body
       # to:: Phone Number to send Message to
       # from:: Phone Number to send Message from
-      # action:: Action URL
+      # action:: A URL specifying where Twilio should send status callbacks for the created outbound message.
       # method:: Action URL Method
       # status_callback:: Status callback URL. Deprecated in favor of action.
       # keyword_args:: additional attributes