twilio-ruby 5.74.0 → 7.10.1

data/lib/twilio-ruby/rest/preview/wireless/sim/usage.rb

@@ -1,233 +1,410 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
 #
-# frozen_string_literal: true
+#    Twilio - Preview
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
 
 module Twilio
-  module REST
-    class Preview < Domain
-      class Wireless < Version
-        class SimContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class UsageList < ListResource
-            ##
-            # Initialize the UsageList
-            # @param [Version] version Version that contains the resource
-            # @param [String] sim_sid The sim_sid
-            # @return [UsageList] UsageList
-            def initialize(version, sim_sid: nil)
-              super(version)
-
-              # Path Solution
-              @solution = {sim_sid: sim_sid}
-            end
+    module REST
+        class Preview < PreviewBase
+            class Wireless < Version
+                class SimContext < InstanceContext
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '#<Twilio.Preview.Wireless.UsageList>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class UsagePage < Page
-            ##
-            # Initialize the UsagePage
-            # @param [Version] version Version that contains the resource
-            # @param [Response] response Response from the API
-            # @param [Hash] solution Path solution for the resource
-            # @return [UsagePage] UsagePage
-            def initialize(version, response, solution)
-              super(version, response)
-
-              # Path Solution
-              @solution = solution
-            end
+                     class UsageList < ListResource
+                
+                    ##
+                    # Initialize the UsageList
+                    # @param [Version] version Version that contains the resource
+                    # @return [UsageList] UsageList
+                    def initialize(version, sim_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { sim_sid: sim_sid }
+                        
+                        
+                    end
+                
 
-            ##
-            # Build an instance of UsageInstance
-            # @param [Hash] payload Payload response from the API
-            # @return [UsageInstance] UsageInstance
-            def get_instance(payload)
-              UsageInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
-            end
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '<Twilio.Preview.Wireless.UsagePage>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class UsageContext < InstanceContext
-            ##
-            # Initialize the UsageContext
-            # @param [Version] version Version that contains the resource
-            # @param [String] sim_sid The sim_sid
-            # @return [UsageContext] UsageContext
-            def initialize(version, sim_sid)
-              super(version)
-
-              # Path Solution
-              @solution = {sim_sid: sim_sid, }
-              @uri = "/Sims/#{@solution[:sim_sid]}/Usage"
-            end
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Preview.Wireless.UsageList>'
+                    end
+                end
 
-            ##
-            # Fetch the UsageInstance
-            # @param [String] end_ The end
-            # @param [String] start The start
-            # @return [UsageInstance] Fetched UsageInstance
-            def fetch(end_: :unset, start: :unset)
-              params = Twilio::Values.of({'End' => end_, 'Start' => start, })
 
-              payload = @version.fetch('GET', @uri, params: params)
+                class UsageContext < InstanceContext
+                    ##
+                    # Initialize the UsageContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sim_sid 
+                    # @return [UsageContext] UsageContext
+                    def initialize(version, sim_sid)
+                        super(version)
+                        
 
-              UsageInstance.new(@version, payload, sim_sid: @solution[:sim_sid], )
-            end
+                        # Path Solution
+                        @solution = { sim_sid: sim_sid,  }
+                        @uri = "/Sims/#{@solution[:sim_sid]}/Usage"
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Preview.Wireless.UsageContext #{context}>"
-            end
+                        
+                    end
+                    ##
+                    # Fetch the UsageInstance
+                    # @param [String] end_ 
+                    # @param [String] start 
+                    # @return [UsageInstance] Fetched UsageInstance
+                    def fetch(
+                        end_: :unset, 
+                        start: :unset
+                    )
 
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Preview.Wireless.UsageContext #{context}>"
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class UsageInstance < InstanceResource
-            ##
-            # Initialize the UsageInstance
-            # @param [Version] version Version that contains the resource
-            # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] sim_sid The sim_sid
-            # @return [UsageInstance] UsageInstance
-            def initialize(version, payload, sim_sid: nil)
-              super(version)
-
-              # Marshaled Properties
-              @properties = {
-                  'sim_sid' => payload['sim_sid'],
-                  'sim_unique_name' => payload['sim_unique_name'],
-                  'account_sid' => payload['account_sid'],
-                  'period' => payload['period'],
-                  'commands_usage' => payload['commands_usage'],
-                  'commands_costs' => payload['commands_costs'],
-                  'data_usage' => payload['data_usage'],
-                  'data_costs' => payload['data_costs'],
-                  'url' => payload['url'],
-              }
-
-              # Context
-              @instance_context = nil
-              @params = {'sim_sid' => sim_sid, }
-            end
+                        params = Twilio::Values.of({
+                            'End' => end_,
+                            'Start' => start,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        UsageInstance.new(
+                            @version,
+                            payload,
+                            sim_sid: @solution[:sim_sid],
+                        )
+                    end
 
-            ##
-            # Generate an instance context for the instance, the context is capable of
-            # performing various actions.  All instance actions are proxied to the context
-            # @return [UsageContext] UsageContext for this UsageInstance
-            def context
-              unless @instance_context
-                @instance_context = UsageContext.new(@version, @params['sim_sid'], )
-              end
-              @instance_context
-            end
+                    ##
+                    # Fetch the UsageInstanceMetadata
+                    # @param [String] end_ 
+                    # @param [String] start 
+                    # @return [UsageInstance] Fetched UsageInstance
+                    def fetch_with_metadata(
+                      end_: :unset, 
+                      start: :unset
+                    )
 
-            ##
-            # @return [String] The sim_sid
-            def sim_sid
-              @properties['sim_sid']
-            end
+                        params = Twilio::Values.of({
+                            'End' => end_,
+                            'Start' => start,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        usage_instance = UsageInstance.new(
+                            @version,
+                            response.body,
+                            sim_sid: @solution[:sim_sid],
+                        )
+                        UsageInstanceMetadata.new(
+                            @version,
+                            usage_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
 
-            ##
-            # @return [String] The sim_unique_name
-            def sim_unique_name
-              @properties['sim_unique_name']
-            end
 
-            ##
-            # @return [String] The account_sid
-            def account_sid
-              @properties['account_sid']
-            end
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Preview.Wireless.UsageContext #{context}>"
+                    end
 
-            ##
-            # @return [Hash] The period
-            def period
-              @properties['period']
-            end
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Preview.Wireless.UsageContext #{context}>"
+                    end
+                end
 
-            ##
-            # @return [Hash] The commands_usage
-            def commands_usage
-              @properties['commands_usage']
-            end
+                class UsageInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new UsageInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}UsageInstance] usage_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 [UsageInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, usage_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @usage_instance = usage_instance
+                    end
 
-            ##
-            # @return [Hash] The commands_costs
-            def commands_costs
-              @properties['commands_costs']
-            end
+                    def usage
+                        @usage_instance
+                    end
 
-            ##
-            # @return [Hash] The data_usage
-            def data_usage
-              @properties['data_usage']
-            end
+                    def headers
+                        @headers
+                    end
 
-            ##
-            # @return [Hash] The data_costs
-            def data_costs
-              @properties['data_costs']
-            end
+                    def status_code
+                        @status_code
+                    end
 
-            ##
-            # @return [String] The url
-            def url
-              @properties['url']
-            end
+                    def to_s
+                      "<Twilio.Api.V2010.UsageInstanceMetadata status=#{@status_code}>"
+                    end
+                end
 
-            ##
-            # Fetch the UsageInstance
-            # @param [String] end_ The end
-            # @param [String] start The start
-            # @return [UsageInstance] Fetched UsageInstance
-            def fetch(end_: :unset, start: :unset)
-              context.fetch(end_: end_, start: start, )
-            end
+                class UsageListResponse < InstanceListResource
+                    # @param [Array<UsageInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @usage_instance = payload.body[key].map do |data|
+                        UsageInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Wireless.UsageInstance #{values}>"
-            end
+                      def usage_instance
+                          @instance
+                      end
+                  end
+
+                class UsagePage < Page
+                    ##
+                    # Initialize the UsagePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [UsagePage] UsagePage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of UsageInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [UsageInstance] UsageInstance
+                    def get_instance(payload)
+                        UsageInstance.new(@version, payload, sim_sid: @solution[:sim_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Preview.Wireless.UsagePage>'
+                    end
+                end
+
+                class UsagePageMetadata < PageMetadata
+                    attr_reader :usage_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @usage_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @usage_page << UsageListResponse.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_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Preview::WirelessPageMetadata>';
+                    end
+                end
+                class UsageListResponse < InstanceListResource
+
+                    # @param [Array<UsageInstance>] 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 = data_list.map do |data|
+                        UsageInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
 
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Wireless.UsageInstance #{values}>"
+                    def usage
+                        @usage
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class UsageInstance < InstanceResource
+                    ##
+                    # Initialize the UsageInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Usage
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [UsageInstance] UsageInstance
+                    def initialize(version, payload , sim_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sim_sid' => payload['sim_sid'],
+                            'sim_unique_name' => payload['sim_unique_name'],
+                            'account_sid' => payload['account_sid'],
+                            'period' => payload['period'],
+                            'commands_usage' => payload['commands_usage'],
+                            'commands_costs' => payload['commands_costs'],
+                            'data_usage' => payload['data_usage'],
+                            'data_costs' => payload['data_costs'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'sim_sid' => sim_sid  || @properties['sim_sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [UsageContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = UsageContext.new(@version , @params['sim_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def sim_sid
+                        @properties['sim_sid']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def sim_unique_name
+                        @properties['sim_unique_name']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def period
+                        @properties['period']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def commands_usage
+                        @properties['commands_usage']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def commands_costs
+                        @properties['commands_costs']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def data_usage
+                        @properties['data_usage']
+                    end
+                    
+                    ##
+                    # @return [Hash] 
+                    def data_costs
+                        @properties['data_costs']
+                    end
+                    
+                    ##
+                    # @return [String] 
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the UsageInstance
+                    # @param [String] end_ 
+                    # @param [String] start 
+                    # @return [UsageInstance] Fetched UsageInstance
+                    def fetch(
+                        end_: :unset, 
+                        start: :unset
+                    )
+
+                        context.fetch(
+                            end_: end_, 
+                            start: start, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Preview.Wireless.UsageInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Preview.Wireless.UsageInstance #{values}>"
+                    end
+                end
+
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+