twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/supersim/v1/sms_command.rb

@@ -18,12 +18,14 @@ module Twilio
         class Supersim < SupersimBase
             class V1 < Version
                 class SmsCommandList < ListResource
+                
                     ##
                     # Initialize the SmsCommandList
                     # @param [Version] version Version that contains the resource
                     # @return [SmsCommandList] SmsCommandList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/SmsCommands"
@@ -37,10 +39,10 @@ module Twilio
                     # @param [String] callback_url The URL we should call using the `callback_method` after we have sent the command.
                     # @return [SmsCommandInstance] Created SmsCommandInstance
                     def create(
-                        sim: nil, 
-                        payload: nil, 
-                        callback_method: :unset, 
-                        callback_url: :unset
+                      sim: nil, 
+                      payload: nil, 
+                      callback_method: :unset, 
+                      callback_url: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -50,13 +52,59 @@ module Twilio
                             'CallbackUrl' => callback_url,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         SmsCommandInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the SmsCommandInstanceMetadata
+                    # @param [String] sim The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/iot/supersim/api/sim-resource) to send the SMS Command to.
+                    # @param [String] payload The message body of the SMS Command.
+                    # @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.
+                    # @param [String] callback_url The URL we should call using the `callback_method` after we have sent the command.
+                    # @return [SmsCommandInstance] Created SmsCommandInstance
+                    def create_with_metadata(
+                      sim: nil, 
+                      payload: nil, 
+                      callback_method: :unset, 
+                      callback_url: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Sim' => sim,
+                            'Payload' => payload,
+                            'CallbackMethod' => callback_method,
+                            'CallbackUrl' => callback_url,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        sms_command_instance = SmsCommandInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SmsCommandInstanceMetadata.new(
+                            @version,
+                            sms_command_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SmsCommandInstance records from the API as a list.
@@ -105,7 +153,39 @@ module Twilio
                             direction: direction,
                             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 SmsCommandPageMetadata records from the API as a list.
+                      # @param [String] sim The SID or unique name of the Sim resource that SMS Command was sent to or from.
+                      # @param [Status] status The status of the SMS Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [SMS Command Status Values](https://www.twilio.com/docs/iot/supersim/api/smscommand-resource#status-values) for a description of each.
+                      # @param [Direction] direction The direction of the SMS Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.
+                    # @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(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Sim' => sim,
+                            'Status' => status,
+                            'Direction' => direction,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SmsCommandPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -117,9 +197,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
 
                     ##
@@ -132,7 +216,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 SmsCommandInstance
-                    def page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Sim' => sim,
                             'Status' => status,
@@ -141,8 +225,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)
 
                         SmsCommandPage.new(@version, response, @solution)
                     end
@@ -169,8 +256,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class SmsCommandContext < InstanceContext
                     ##
                     # Initialize the SmsCommandContext
@@ -179,6 +264,7 @@ module Twilio
                     # @return [SmsCommandContext] SmsCommandContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -191,7 +277,13 @@ module Twilio
                     # @return [SmsCommandInstance] Fetched SmsCommandInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         SmsCommandInstance.new(
                             @version,
                             payload,
@@ -199,6 +291,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SmsCommandInstanceMetadata
+                    # @return [SmsCommandInstance] Fetched SmsCommandInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        sms_command_instance = SmsCommandInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        SmsCommandInstanceMetadata.new(
+                            @version,
+                            sms_command_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -215,6 +332,53 @@ module Twilio
                     end
                 end
 
+                class SmsCommandInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SmsCommandInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SmsCommandInstance] sms_command_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 [SmsCommandInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, sms_command_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @sms_command_instance = sms_command_instance
+                    end
+
+                    def sms_command
+                        @sms_command_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SmsCommandInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SmsCommandListResponse < InstanceListResource
+                    # @param [Array<SmsCommandInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @sms_command_instance = payload.body[key].map do |data|
+                        SmsCommandInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def sms_command_instance
+                          @instance
+                      end
+                  end
+
                 class SmsCommandPage < Page
                     ##
                     # Initialize the SmsCommandPage
@@ -224,6 +388,7 @@ module Twilio
                     # @return [SmsCommandPage] SmsCommandPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -243,6 +408,66 @@ module Twilio
                         '<Twilio.Supersim.V1.SmsCommandPage>'
                     end
                 end
+
+                class SmsCommandPageMetadata < PageMetadata
+                    attr_reader :sms_command_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @sms_command_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @sms_command_page << SmsCommandListResponse.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
+                        @sms_command_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Supersim::V1PageMetadata>';
+                    end
+                end
+                class SmsCommandListResponse < InstanceListResource
+
+                    # @param [Array<SmsCommandInstance>] 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
+                      @sms_command = data_list.map do |data|
+                        SmsCommandInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def sms_command
+                        @sms_command
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SmsCommandInstance < InstanceResource
                     ##
                     # Initialize the SmsCommandInstance
@@ -256,6 +481,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -18,12 +18,14 @@ module Twilio
         class Supersim < SupersimBase
             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"
@@ -97,7 +99,49 @@ module Twilio
                             end_time: end_time,
                             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 [String] sim SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.
+                      # @param [String] fleet SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.
+                      # @param [String] network SID of a Network resource. Only show UsageRecords representing usage on this network.
+                      # @param [String] iso_country Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.
+                      # @param [Group] group Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.
+                      # @param [Granularity] granularity Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.
+                      # @param [Time] start_time Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.
+                      # @param [Time] end_time Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.
+                    # @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(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Sim' => sim,
+                            'Fleet' => fleet,
+                            'Network' => network,
+                            'IsoCountry' => iso_country,
+                            'Group' => group,
+                            'Granularity' => granularity,
+                            'StartTime' =>  Twilio.serialize_iso8601_datetime(start_time),
+                            'EndTime' =>  Twilio.serialize_iso8601_datetime(end_time),
+                            
+                            '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
 
                     ##
@@ -109,9 +153,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
 
                     ##
@@ -129,7 +177,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(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(sim: :unset, fleet: :unset, network: :unset, iso_country: :unset, group: :unset, granularity: :unset, start_time: :unset, end_time: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Sim' => sim,
                             'Fleet' => fleet,
@@ -143,8 +191,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
@@ -179,6 +230,7 @@ module Twilio
                     # @return [UsageRecordPage] UsageRecordPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -198,6 +250,66 @@ module Twilio
                         '<Twilio.Supersim.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::Supersim::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
@@ -211,6 +323,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -40,6 +40,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @esim_profiles ||= EsimProfileList.new self
                     else
@@ -54,6 +55,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @fleets ||= FleetList.new self
                     else
@@ -68,6 +70,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @ip_commands ||= IpCommandList.new self
                     else
@@ -82,6 +85,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @networks ||= NetworkList.new self
                     else
@@ -96,6 +100,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @network_access_profiles ||= NetworkAccessProfileList.new self
                     else
@@ -115,6 +120,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @sims ||= SimList.new self
                     else
@@ -129,6 +135,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @sms_commands ||= SmsCommandList.new self
                     else