Class: Twilio::REST::Preview::Wireless::CommandList

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CommandList

Initialize the CommandList



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

def initialize(version)
  super(version)

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

Instance Method Details

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

Create the CommandInstance



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

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

  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.



87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 87

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.



129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 129

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

#list(device: :unset, 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.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 43

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

#page(device: :unset, 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.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 108

def page(device: :unset, sim: :unset, status: :unset, direction: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Device' => device,
      '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(device: :unset, 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.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 69

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

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



165
166
167
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 165

def to_s
  '#<Twilio.Preview.Wireless.CommandList>'
end