Class: Twilio::REST::Sync::V1::ServiceInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Sync::V1::ServiceInstance

Defined in:

lib/twilio-ruby/rest/sync/v1/service.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #acl_enabled ⇒ Boolean

  Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.

• #context ⇒ ServiceContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The ISO 8601 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The ISO 8601 date and time in GMT when the resource was last updated.

• #delete ⇒ Boolean

  Delete the ServiceInstance.

• #documents ⇒ documents

  Access the documents.

• #fetch ⇒ ServiceInstance

  Fetch the ServiceInstance.

• #friendly_name ⇒ String

  The string that you assigned to describe the resource.

• #initialize(version, payload, sid: nil) ⇒ ServiceInstance constructor

  Initialize the ServiceInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  The URLs of related resources.

• #reachability_debouncing_enabled ⇒ Boolean

  Whether every endpoint_disconnected event occurs after a configurable delay.

• #reachability_debouncing_window ⇒ String

  The reachability event delay in milliseconds.

• #reachability_webhooks_enabled ⇒ Boolean

  Whether the service instance calls webhook_url when client endpoints connect to Sync.

• #sid ⇒ String

  The unique string that identifies the resource.

• #sync_lists ⇒ sync_lists

  Access the sync_lists.

• #sync_maps ⇒ sync_maps

  Access the sync_maps.

• #sync_streams ⇒ sync_streams

  Access the sync_streams.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #unique_name ⇒ String

  An application-defined string that uniquely identifies the resource.

• #update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset) ⇒ ServiceInstance

  Update the ServiceInstance.

• #url ⇒ String

  The absolute URL of the Service resource.

• #webhook_url ⇒ String

  The URL we call when Sync objects are manipulated.

• #webhooks_from_rest_enabled ⇒ Boolean

  Whether the Service instance should call webhook_url when the REST API is used to update Sync objects.

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 358

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'webhook_url' => payload['webhook_url'],
      'webhooks_from_rest_enabled' => payload['webhooks_from_rest_enabled'],
      'reachability_webhooks_enabled' => payload['reachability_webhooks_enabled'],
      'acl_enabled' => payload['acl_enabled'],
      'reachability_debouncing_enabled' => payload['reachability_debouncing_enabled'],
      'reachability_debouncing_window' => payload['reachability_debouncing_window'].to_i,
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 409

def account_sid
  @properties['account_sid']
end

#acl_enabled ⇒ Boolean

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 457

def acl_enabled
  @properties['acl_enabled']
end

#context ⇒ ServiceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 388

def context
  unless @instance_context
    @instance_context = ServiceContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 421

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 427

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 489

def delete
  context.delete
end

#documents ⇒ documents

Access the documents

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 535

def documents
  context.documents
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 482

def fetch
  context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 415

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 569

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Sync.V1.ServiceInstance #{values}>"
end

#links ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 475

def links
  @properties['links']
end

#reachability_debouncing_enabled ⇒ Boolean

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 463

def reachability_debouncing_enabled
  @properties['reachability_debouncing_enabled']
end

#reachability_debouncing_window ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 469

def reachability_debouncing_window
  @properties['reachability_debouncing_window']
end

#reachability_webhooks_enabled ⇒ Boolean

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 451

def reachability_webhooks_enabled
  @properties['reachability_webhooks_enabled']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 397

def sid
  @properties['sid']
end

#sync_lists ⇒ sync_lists

Access the sync_lists

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 542

def sync_lists
  context.sync_lists
end

#sync_maps ⇒ sync_maps

Access the sync_maps

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 549

def sync_maps
  context.sync_maps
end

#sync_streams ⇒ sync_streams

Access the sync_streams

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 556

def sync_streams
  context.sync_streams
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 562

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Sync.V1.ServiceInstance #{values}>"
end

#unique_name ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 403

def unique_name
  @properties['unique_name']
end

#update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 520

def update(webhook_url: :unset, friendly_name: :unset, reachability_webhooks_enabled: :unset, acl_enabled: :unset, reachability_debouncing_enabled: :unset, reachability_debouncing_window: :unset, webhooks_from_rest_enabled: :unset)
  context.update(
      webhook_url: webhook_url,
      friendly_name: friendly_name,
      reachability_webhooks_enabled: reachability_webhooks_enabled,
      acl_enabled: acl_enabled,
      reachability_debouncing_enabled: reachability_debouncing_enabled,
      reachability_debouncing_window: reachability_debouncing_window,
      webhooks_from_rest_enabled: webhooks_from_rest_enabled,
  )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 433

def url
  @properties['url']
end

#webhook_url ⇒ String

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 439

def webhook_url
  @properties['webhook_url']
end

#webhooks_from_rest_enabled ⇒ Boolean

# File 'lib/twilio-ruby/rest/sync/v1/service.rb', line 445

def webhooks_from_rest_enabled
  @properties['webhooks_from_rest_enabled']
end