class Twilio::REST::Chat::V1::ServiceList

Public Class Methods

new(version) click to toggle source

Initialize the ServiceList @param [Version] version Version that contains the resource @return [ServiceList] ServiceList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/chat/v1/service.rb
18 def initialize(version)
19   super(version)
20 
21   # Path Solution
22   @solution = {}
23   @uri = "/Services"
24 end

Public Instance Methods

create(friendly_name: nil) click to toggle source

Create the ServiceInstance @param [String] friendly_name A descriptive string that you create to describe

the resource. It can be up to 64 characters long.

@return [ServiceInstance] Created ServiceInstance

   # File lib/twilio-ruby/rest/chat/v1/service.rb
31 def create(friendly_name: nil)
32   data = Twilio::Values.of({'FriendlyName' => friendly_name, })
33 
34   payload = @version.create('POST', @uri, data: data)
35 
36   ServiceInstance.new(@version, payload, )
37 end
each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/chat/v1/service.rb
77 def each
78   limits = @version.read_limits
79 
80   page = self.page(page_size: limits[:page_size], )
81 
82   @version.stream(page,
83                   limit: limits[:limit],
84                   page_limit: limits[:page_limit]).each {|x| yield x}
85 end
get_page(target_url) click to toggle source

Retrieve a single page of ServiceInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of ServiceInstance

    # File lib/twilio-ruby/rest/chat/v1/service.rb
111 def get_page(target_url)
112   response = @version.domain.request(
113       'GET',
114       target_url
115   )
116   ServicePage.new(@version, response, @solution)
117 end
list(limit: nil, page_size: nil) click to toggle source

Lists ServiceInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size 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)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/chat/v1/service.rb
50 def list(limit: nil, page_size: nil)
51   self.stream(limit: limit, page_size: page_size).entries
52 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of ServiceInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of ServiceInstance

    # File lib/twilio-ruby/rest/chat/v1/service.rb
 94 def page(page_token: :unset, page_number: :unset, page_size: :unset)
 95   params = Twilio::Values.of({
 96       'PageToken' => page_token,
 97       'Page' => page_number,
 98       'PageSize' => page_size,
 99   })
100 
101   response = @version.page('GET', @uri, params: params)
102 
103   ServicePage.new(@version, response, @solution)
104 end
stream(limit: nil, page_size: nil) click to toggle source

Streams ServiceInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size 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)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/chat/v1/service.rb
65 def stream(limit: nil, page_size: nil)
66   limits = @version.read_limits(limit, page_size)
67 
68   page = self.page(page_size: limits[:page_size], )
69 
70   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
71 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/chat/v1/service.rb
121 def to_s
122   '#<Twilio.Chat.V1.ServiceList>'
123 end