Class: Twilio::REST::Supersim::V1::IpCommandList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ IpCommandList

Initialize the IpCommandList

Parameters:

  • Version that contains the resource



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

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

Instance Method Details

#create(sim: nil, payload: nil, device_port: nil, payload_type: :unset, callback_url: :unset, callback_method: :unset) ⇒ IpCommandInstance

Create the IpCommandInstance

Parameters:

  • (defaults to: nil)

    The sid or unique_name of the [Super SIM](www.twilio.com/docs/iot/supersim/api/sim-resource) to send the IP Command to.

  • (defaults to: nil)

    The data that will be sent to the device. The payload cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in Base64.

  • (defaults to: nil)

    The device port to which the IP Command will be sent.

  • (defaults to: :unset)
  • (defaults to: :unset)

    The URL we should call using the callback_method after we have sent the IP Command.

  • (defaults to: :unset)

    The HTTP method we should use to call callback_url. Can be GET or POST, and the default is POST.

Returns:

  • Created IpCommandInstance



43
44
45
46
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
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 43

def create(
    sim: nil, 
    payload: nil, 
    device_port: nil, 
    payload_type: :unset, 
    callback_url: :unset, 
    callback_method: :unset
)

    data = Twilio::Values.of({
        'Sim' => sim,
        'Payload' => payload,
        'DevicePort' => device_port,
        'PayloadType' => payload_type,
        'CallbackUrl' => callback_url,
        'CallbackMethod' => callback_method,
    })

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

#create_with_metadata(sim: nil, payload: nil, device_port: nil, payload_type: :unset, callback_url: :unset, callback_method: :unset) ⇒ IpCommandInstance

Create the IpCommandInstanceMetadata

Parameters:

  • (defaults to: nil)

    The sid or unique_name of the [Super SIM](www.twilio.com/docs/iot/supersim/api/sim-resource) to send the IP Command to.

  • (defaults to: nil)

    The data that will be sent to the device. The payload cannot exceed 1300 bytes. If the PayloadType is set to text, the payload is encoded in UTF-8. If PayloadType is set to binary, the payload is encoded in Base64.

  • (defaults to: nil)

    The device port to which the IP Command will be sent.

  • (defaults to: :unset)
  • (defaults to: :unset)

    The URL we should call using the callback_method after we have sent the IP Command.

  • (defaults to: :unset)

    The HTTP method we should use to call callback_url. Can be GET or POST, and the default is POST.

Returns:

  • Created IpCommandInstance



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 83

def create_with_metadata(
  sim: nil, 
  payload: nil, 
  device_port: nil, 
  payload_type: :unset, 
  callback_url: :unset, 
  callback_method: :unset
)

    data = Twilio::Values.of({
        'Sim' => sim,
        'Payload' => payload,
        'DevicePort' => device_port,
        'PayloadType' => payload_type,
        'CallbackUrl' => callback_url,
        'CallbackMethod' => callback_method,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    ip_command_instance = IpCommandInstance.new(
        @version,
        response.body,
    )
    IpCommandInstanceMetadata.new(
        @version,
        ip_command_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 209

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

Parameters:

  • API-generated URL for the requested results page

Returns:

  • Page of IpCommandInstance



254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 254

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

#list(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • (defaults to: :unset)

    The SID or unique name of the Sim resource that IP Command was sent to or from.

  • (defaults to: :unset)

    The ICCID of the Sim resource that IP Command was sent to or from.

  • (defaults to: :unset)

    The status of the IP Command. Can be: queued, sent, received or failed. See the [IP Command Status Values](www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.

  • (defaults to: :unset)

    The direction of the IP 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`.

  • (defaults to: nil)

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

  • (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 of up to limit results



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 136

def list(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
    self.stream(
        sim: sim,
        sim_iccid: sim_iccid,
        status: status,
        direction: direction,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

Parameters:

  • (defaults to: nil)

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

  • (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 of up to limit results



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 188

def list_with_metadata(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Sim' => sim,
        'SimIccid' => sim_iccid,
        'Status' => status,
        'Direction' => direction,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    IpCommandPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • (defaults to: :unset)

    The SID or unique name of the Sim resource that IP Command was sent to or from.

  • (defaults to: :unset)

    The ICCID of the Sim resource that IP Command was sent to or from.

  • (defaults to: :unset)

    The status of the IP Command. Can be: queued, sent, received or failed. See the [IP Command Status Values](www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.

  • (defaults to: :unset)

    The direction of the IP 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`.

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of IpCommandInstance



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 230

def page(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'Sim' => sim,
        'SimIccid' => sim_iccid,
        'Status' => status,
        'Direction' => direction,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, 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:

  • (defaults to: :unset)

    The SID or unique name of the Sim resource that IP Command was sent to or from.

  • (defaults to: :unset)

    The ICCID of the Sim resource that IP Command was sent to or from.

  • (defaults to: :unset)

    The status of the IP Command. Can be: queued, sent, received or failed. See the [IP Command Status Values](www.twilio.com/docs/iot/supersim/api/ipcommand-resource#status-values) for a description of each.

  • (defaults to: :unset)

    The direction of the IP 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`.

  • (defaults to: nil)

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

  • (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 that will yield up to limit results



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 162

def stream(sim: :unset, sim_iccid: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        sim: sim,
        sim_iccid: sim_iccid,
        status: status,
        direction: direction,
        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



265
266
267
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 265

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