Class: Twilio::REST::Wireless::V1::CommandList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/wireless/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



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 18

def initialize(version)
  super(version)

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

Instance Method Details

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

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
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 143

def create(command: nil, sim: :unset, callback_method: :unset, callback_url: :unset, command_mode: :unset, include_sid: :unset)
  data = Twilio::Values.of({
      'Command' => command,
      '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.



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

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.



125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 125

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.



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

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.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 103

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
  )
  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.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 64

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



167
168
169
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 167

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