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

Parameters:

  • version (Version) —

    Version that contains the resource



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.

Parameters:

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

    The command

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

    The sim

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

    The callback_method

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

    The callback_url

  • command_mode (command.CommandMode) (defaults to: :unset) —

    The command_mode

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

    The include_sid

Returns:



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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CommandInstance



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.

Parameters:

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

    The sim

  • status (command.Status) (defaults to: :unset) —

    The status

  • direction (command.Direction) (defaults to: :unset) —

    The direction

  • 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



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.

Parameters:

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

    The sim

  • status (command.Status) (defaults to: :unset) —

    The status

  • direction (command.Direction) (defaults to: :unset) —

    The direction

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



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.

Parameters:

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

    The sim

  • status (command.Status) (defaults to: :unset) —

    The status

  • direction (command.Direction) (defaults to: :unset) —

    The direction

  • 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



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