Class: Twilio::REST::Supersim::V1::NetworkList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/network.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ NetworkList

Initialize the NetworkList

Parameters:

  • version (Version) —

    Version that contains the resource


20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Networks"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields NetworkInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 86

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of NetworkInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of NetworkInstance


130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 130

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  NetworkPage.new(@version, response, @solution)
end

#list(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) ⇒ Array

Lists NetworkInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • iso_country (String) (defaults to: :unset) —

    The ISO country code of the Network resources to read.

  • mcc (String) (defaults to: :unset) —

    The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read.

  • mnc (String) (defaults to: :unset) —

    The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results


46
47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 46

def list(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil)
  self.stream(
      iso_country: iso_country,
      mcc: mcc,
      mnc: mnc,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(iso_country: :unset, mcc: :unset, mnc: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of NetworkInstance records from the API. Request is executed immediately.

Parameters:

  • iso_country (String) (defaults to: :unset) —

    The ISO country code of the Network resources to read.

  • mcc (String) (defaults to: :unset) —

    The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read.

  • mnc (String) (defaults to: :unset) —

    The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of NetworkInstance


110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 110

def page(iso_country: :unset, mcc: :unset, mnc: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'IsoCountry' => iso_country,
      'Mcc' => mcc,
      'Mnc' => mnc,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  NetworkPage.new(@version, response, @solution)
end

#stream(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams NetworkInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • iso_country (String) (defaults to: :unset) —

    The ISO country code of the Network resources to read.

  • mcc (String) (defaults to: :unset) —

    The 'mobile country code' of a country. Network resources with this `mcc` in their `identifiers` will be read.

  • mnc (String) (defaults to: :unset) —

    The 'mobile network code' of a mobile operator network. Network resources with this `mnc` in their `identifiers` will be read.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results


74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 74

def stream(iso_country: :unset, mcc: :unset, mnc: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(iso_country: iso_country, mcc: mcc, mnc: mnc, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation


140
141
142
 
# File 'lib/twilio-ruby/rest/supersim/v1/network.rb', line 140

def to_s
  '#<Twilio.Supersim.V1.NetworkList>'
end