Class: Twilio::REST::Preview::Sync::ServiceList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/sync/service.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) ⇒ ServiceList

Initialize the ServiceList



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

def initialize(version)
  super(version)

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

Instance Method Details

#create(friendly_name: :unset, webhook_url: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset) ⇒ ServiceInstance

Create the ServiceInstance



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 35

def create(friendly_name: :unset, webhook_url: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'WebhookUrl' => webhook_url,
      'ReachabilityWebhooksEnabled' => reachability_webhooks_enabled,
      'AclEnabled' => acl_enabled,
  })

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

  ServiceInstance.new(@version, payload, )
end

#each ⇒ Object

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



86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 86

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



120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 120

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

#list(limit: nil, page_size: nil) ⇒ Array

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



59
60
61
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 59

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

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

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



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 103

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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



74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 74

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

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



130
131
132
 
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 130

def to_s
  '#<Twilio.Preview.Sync.ServiceList>'
end