Class: Twilio::REST::Wireless::V1::RatePlanList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ RatePlanList

Initialize the RatePlanList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/RatePlans"
    
end

Instance Method Details

#create(unique_name: :unset, friendly_name: :unset, data_enabled: :unset, data_limit: :unset, data_metering: :unset, messaging_enabled: :unset, voice_enabled: :unset, national_roaming_enabled: :unset, international_roaming: :unset, national_roaming_data_limit: :unset, international_roaming_data_limit: :unset) ⇒ RatePlanInstance

Create the RatePlanInstance

Parameters:

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

    An application-defined string that uniquely identifies the resource. It can be used in place of the resource’s ‘sid` in the URL to address the resource.

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

    A descriptive string that you create to describe the resource. It does not have to be unique.

  • data_enabled (Boolean) (defaults to: :unset) —

    Whether SIMs can use GPRS/3G/4G/LTE data connectivity.

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

    The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB and the default value is ‘1000`.

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

    The model used to meter data usage. Can be: ‘payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](www.twilio.com/docs/iot/wireless/api/rateplan-resource#payg-vs-quota-data-plans).

  • messaging_enabled (Boolean) (defaults to: :unset) —

    Whether SIMs can make, send, and receive SMS using [Commands](www.twilio.com/docs/iot/wireless/api/command-resource).

  • voice_enabled (Boolean) (defaults to: :unset) —

    Deprecated.

  • national_roaming_enabled (Boolean) (defaults to: :unset) —

    Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming).

  • international_roaming (Array[String]) (defaults to: :unset) —

    The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can contain: ‘data` and `messaging`.

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

    The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](www.twilio.com/docs/iot/wireless/api/rateplan-resource#national-roaming) for more info.

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

    The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB.

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 47

def create(
    unique_name: :unset, 
    friendly_name: :unset, 
    data_enabled: :unset, 
    data_limit: :unset, 
    data_metering: :unset, 
    messaging_enabled: :unset, 
    voice_enabled: :unset, 
    national_roaming_enabled: :unset, 
    international_roaming: :unset, 
    national_roaming_data_limit: :unset, 
    international_roaming_data_limit: :unset
)

    data = Twilio::Values.of({
        'UniqueName' => unique_name,
        'FriendlyName' => friendly_name,
        'DataEnabled' => data_enabled,
        'DataLimit' => data_limit,
        'DataMetering' => data_metering,
        'MessagingEnabled' => messaging_enabled,
        'VoiceEnabled' => voice_enabled,
        'NationalRoamingEnabled' => national_roaming_enabled,
        'InternationalRoaming' => Twilio.serialize_list(international_roaming) { |e| e },
        'NationalRoamingDataLimit' => national_roaming_data_limit,
        'InternationalRoamingDataLimit' => international_roaming_data_limit,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    RatePlanInstance.new(
        @version,
        payload,
    )
end

#each ⇒ Object

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



131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 131

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 RatePlanInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of RatePlanInstance



168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 168

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

#list(limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • 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



100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 100

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

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

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

Parameters:

  • 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 RatePlanInstance



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 148

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • 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



118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 118

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        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



179
180
181
 
# File 'lib/twilio-ruby/rest/wireless/v1/rate_plan.rb', line 179

def to_s
    '#<Twilio.Wireless.V1.RatePlanList>'
end