Class: Twilio::REST::Conversations::V1::ServiceContext::RoleInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Conversations::V1::ServiceContext::RoleInstance

Defined in:

lib/twilio-ruby/rest/conversations/v1/service/role.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #chat_service_sid ⇒ String

  The SID of the Conversation Service that the resource is associated with.

• #context ⇒ RoleContext

  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 RoleInstance.

• #fetch ⇒ RoleInstance

  Fetch the RoleInstance.

• #friendly_name ⇒ String

  The string that you assigned to describe the resource.

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

  Initialize the RoleInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #permissions ⇒ Array[String]

  An array of the permissions the role has been granted.

• #sid ⇒ String

  The unique string that identifies the resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #type ⇒ role.RoleType

  The type of role.

• #update(permission: nil) ⇒ RoleInstance

  Update the RoleInstance.

• #url ⇒ String

  An absolute URL for this user role.

Constructor Details

#initialize(version, payload, chat_service_sid: nil, sid: nil) ⇒ RoleInstance

Initialize the RoleInstance

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 256

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'chat_service_sid' => payload['chat_service_sid'],
      'friendly_name' => payload['friendly_name'],
      'type' => payload['type'],
      'permissions' => payload['permissions'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 296

def account_sid
  @properties['account_sid']
end

#chat_service_sid ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 302

def chat_service_sid
  @properties['chat_service_sid']
end

#context ⇒ RoleContext

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/conversations/v1/service/role.rb', line 281

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 326

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 332

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the RoleInstance

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

def delete
  context.delete
end

#fetch ⇒ RoleInstance

Fetch the RoleInstance

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 365

def fetch
  context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 308

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 378

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

#permissions ⇒ Array[String]

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 320

def permissions
  @properties['permissions']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 290

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 371

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

#type ⇒ role.RoleType

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 314

def type
  @properties['type']
end

#update(permission: nil) ⇒ RoleInstance

Update the RoleInstance

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 351

def update(permission: nil)
  context.update(permission: permission, )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/conversations/v1/service/role.rb', line 338

def url
  @properties['url']
end