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 (Version) —

    Version that contains the resource



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

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:

  • sim (String) (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.

  • payload (String) (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.

  • device_port (String) (defaults to: nil) —

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

  • payload_type (PayloadType) (defaults to: :unset)
  • callback_url (String) (defaults to: :unset) —

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

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

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

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 41

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,
    })

    payload = @version.create('POST', @uri, data: data)
    IpCommandInstance.new(
        @version,
        payload,
    )
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.



125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 125

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:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of IpCommandInstance



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

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:

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

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

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

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

  • status (Status) (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.

  • direction (Direction) (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`.

  • 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



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 82

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

#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:

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

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

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

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

  • status (Status) (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.

  • direction (Direction) (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`.

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 146

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,
    })

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

    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:

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

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

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

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

  • status (Status) (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.

  • direction (Direction) (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`.

  • 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



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 108

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



178
179
180
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 178

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