Class: Twilio::REST::Preview::Sync::ServiceContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Preview::Sync::ServiceContext
- Defined in:
- lib/twilio-ruby/rest/preview/sync/service.rb,
lib/twilio-ruby/rest/preview/sync/service/document.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_item.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_item.rb,
lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb,
lib/twilio-ruby/rest/preview/sync/service/sync_list/sync_list_permission.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]
Defined Under Namespace
Classes: DocumentContext, DocumentInstance, DocumentList, DocumentPage, SyncListContext, SyncListInstance, SyncListList, SyncListPage, SyncMapContext, SyncMapInstance, SyncMapList, SyncMapPage
Instance Method Summary collapse
-
#delete ⇒ Boolean
Delete the ServiceInstance.
-
#documents(sid = :unset) ⇒ DocumentList, DocumentContext
Access the documents.
-
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance.
-
#initialize(version, sid) ⇒ ServiceContext
constructor
Initialize the ServiceContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#sync_lists(sid = :unset) ⇒ SyncListList, SyncListContext
Access the sync_lists.
-
#sync_maps(sid = :unset) ⇒ SyncMapList, SyncMapContext
Access the sync_maps.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset) ⇒ ServiceInstance
Update the ServiceInstance.
Constructor Details
#initialize(version, sid) ⇒ ServiceContext
Initialize the ServiceContext
174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 174 def initialize(version, sid) super(version) # Path Solution @solution = {sid: sid, } @uri = "/Services/#{@solution[:sid]}" # Dependents @documents = nil @sync_lists = nil @sync_maps = nil end |
Instance Method Details
#delete ⇒ Boolean
Delete the ServiceInstance
199 200 201 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 199 def delete @version.delete('DELETE', @uri) end |
#documents(sid = :unset) ⇒ DocumentList, DocumentContext
Access the documents
227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 227 def documents(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return DocumentContext.new(@version, @solution[:sid], sid, ) end unless @documents @documents = DocumentList.new(@version, service_sid: @solution[:sid], ) end @documents end |
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance
190 191 192 193 194 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 190 def fetch payload = @version.fetch('GET', @uri) ServiceInstance.new(@version, payload, sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
286 287 288 289 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 286 def inspect context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Preview.Sync.ServiceContext #{context}>" end |
#sync_lists(sid = :unset) ⇒ SyncListList, SyncListContext
Access the sync_lists
245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 245 def sync_lists(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return SyncListContext.new(@version, @solution[:sid], sid, ) end unless @sync_lists @sync_lists = SyncListList.new(@version, service_sid: @solution[:sid], ) end @sync_lists end |
#sync_maps(sid = :unset) ⇒ SyncMapList, SyncMapContext
Access the sync_maps
263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 263 def sync_maps(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return SyncMapContext.new(@version, @solution[:sid], sid, ) end unless @sync_maps @sync_maps = SyncMapList.new(@version, service_sid: @solution[:sid], ) end @sync_maps end |
#to_s ⇒ Object
Provide a user friendly representation
279 280 281 282 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 279 def to_s context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Preview.Sync.ServiceContext #{context}>" end |
#update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset) ⇒ ServiceInstance
Update the ServiceInstance
210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/twilio-ruby/rest/preview/sync/service.rb', line 210 def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset) data = Twilio::Values.of({ 'WebhookUrl' => webhook_url, 'FriendlyName' => friendly_name, 'ReachabilityWebhooksEnabled' => reachability_webhooks_enabled, 'AclEnabled' => acl_enabled, }) payload = @version.update('POST', @uri, data: data) ServiceInstance.new(@version, payload, sid: @solution[:sid], ) end |