class Twilio::REST::Preview::Sync::ServiceContext

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 help@twilio.com.

Public Class Methods

new(version, sid) click to toggle source

Initialize the ServiceContext @param [Version] version Version that contains the resource @param [String] sid The sid @return [ServiceContext] ServiceContext

Calls superclass method Twilio::REST::InstanceContext::new
    # File lib/twilio-ruby/rest/preview/sync/service.rb
174 def initialize(version, sid)
175   super(version)
176 
177   # Path Solution
178   @solution = {sid: sid, }
179   @uri = "/Services/#{@solution[:sid]}"
180 
181   # Dependents
182   @documents = nil
183   @sync_lists = nil
184   @sync_maps = nil
185 end

Public Instance Methods

delete() click to toggle source

Delete the ServiceInstance @return [Boolean] true if delete succeeds, false otherwise

    # File lib/twilio-ruby/rest/preview/sync/service.rb
199 def delete
200    @version.delete('DELETE', @uri)
201 end
documents(sid=:unset) click to toggle source

Access the documents @return [DocumentList] @return [DocumentContext] if sid was passed.

    # File lib/twilio-ruby/rest/preview/sync/service.rb
227 def documents(sid=:unset)
228   raise ArgumentError, 'sid cannot be nil' if sid.nil?
229 
230   if sid != :unset
231     return DocumentContext.new(@version, @solution[:sid], sid, )
232   end
233 
234   unless @documents
235     @documents = DocumentList.new(@version, service_sid: @solution[:sid], )
236   end
237 
238   @documents
239 end
fetch() click to toggle source

Fetch the ServiceInstance @return [ServiceInstance] Fetched ServiceInstance

    # File lib/twilio-ruby/rest/preview/sync/service.rb
190 def fetch
191   payload = @version.fetch('GET', @uri)
192 
193   ServiceInstance.new(@version, payload, sid: @solution[:sid], )
194 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/preview/sync/service.rb
286 def inspect
287   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
288   "#<Twilio.Preview.Sync.ServiceContext #{context}>"
289 end
sync_lists(sid=:unset) click to toggle source

Access the sync_lists @return [SyncListList] @return [SyncListContext] if sid was passed.

    # File lib/twilio-ruby/rest/preview/sync/service.rb
245 def sync_lists(sid=:unset)
246   raise ArgumentError, 'sid cannot be nil' if sid.nil?
247 
248   if sid != :unset
249     return SyncListContext.new(@version, @solution[:sid], sid, )
250   end
251 
252   unless @sync_lists
253     @sync_lists = SyncListList.new(@version, service_sid: @solution[:sid], )
254   end
255 
256   @sync_lists
257 end
sync_maps(sid=:unset) click to toggle source

Access the sync_maps @return [SyncMapList] @return [SyncMapContext] if sid was passed.

    # File lib/twilio-ruby/rest/preview/sync/service.rb
263 def sync_maps(sid=:unset)
264   raise ArgumentError, 'sid cannot be nil' if sid.nil?
265 
266   if sid != :unset
267     return SyncMapContext.new(@version, @solution[:sid], sid, )
268   end
269 
270   unless @sync_maps
271     @sync_maps = SyncMapList.new(@version, service_sid: @solution[:sid], )
272   end
273 
274   @sync_maps
275 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/sync/service.rb
279 def to_s
280   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
281   "#<Twilio.Preview.Sync.ServiceContext #{context}>"
282 end
update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset) click to toggle source

Update the ServiceInstance @param [String] webhook_url The webhook_url @param [String] friendly_name The friendly_name @param [Boolean] reachability_webhooks_enabled The reachability_webhooks_enabled @param [Boolean] acl_enabled The acl_enabled @return [ServiceInstance] Updated ServiceInstance

    # File lib/twilio-ruby/rest/preview/sync/service.rb
210 def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset)
211   data = Twilio::Values.of({
212       'WebhookUrl' => webhook_url,
213       'FriendlyName' => friendly_name,
214       'ReachabilityWebhooksEnabled' => reachability_webhooks_enabled,
215       'AclEnabled' => acl_enabled,
216   })
217 
218   payload = @version.update('POST', @uri, data: data)
219 
220   ServiceInstance.new(@version, payload, sid: @solution[:sid], )
221 end