Class: Twilio::REST::Supersim::V1::CommandList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/command.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) ⇒ CommandList

Initialize the CommandList



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

def initialize(version)
  super(version)

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

Instance Method Details

#create(sim: nil, command: nil, callback_method: :unset, callback_url: :unset) ⇒ CommandInstance

Create the CommandInstance



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/supersim/v1/command.rb', line 39

def create(sim: nil, command: nil, callback_method: :unset, callback_url: :unset)
  data = Twilio::Values.of({
      'Sim' => sim,
      'Command' => command,
      'CallbackMethod' => callback_method,
      'CallbackUrl' => callback_url,
  })

  payload = @version.create('POST', @uri, data: data)

  CommandInstance.new(@version, payload, )
end

#each ⇒ Object

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



116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/supersim/v1/command.rb', line 116

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



163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/supersim/v1/command.rb', line 163

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

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

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



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

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

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

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/supersim/v1/command.rb', line 143

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,
      'Direction' => direction,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(sim: :unset, status: :unset, direction: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/supersim/v1/command.rb', line 104

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

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



173
174
175
 
# File 'lib/twilio-ruby/rest/supersim/v1/command.rb', line 173

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