Class: Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::InviteInstance

Inherits:

Twilio::REST::InstanceResource

• Object
• Twilio::REST::InstanceResource
• Twilio::REST::IpMessaging::V2::ServiceContext::ChannelContext::InviteInstance

Defined in:

lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #channel_sid ⇒ String

  The SID of the Channel the new resource belongs to.

• #context ⇒ InviteContext

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

• #created_by ⇒ String

  The identity of the User that created the invite.

• #date_created ⇒ Time

  The RFC 2822 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The RFC 2822 date and time in GMT when the resource was last updated.

• #delete ⇒ Boolean

  Deletes the InviteInstance.

• #fetch ⇒ InviteInstance

  Fetch a InviteInstance.

• #identity ⇒ String

  The string that identifies the resource’s User.

• #initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ InviteInstance constructor

  Initialize the InviteInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #role_sid ⇒ String

  The SID of the Role assigned to the member.

• #service_sid ⇒ String

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

• #sid ⇒ String

  The unique string that identifies the resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the Invite resource.

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ InviteInstance

Initialize the InviteInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 273

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'channel_sid' => payload['channel_sid'],
      'service_sid' => payload['service_sid'],
      'identity' => payload['identity'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'role_sid' => payload['role_sid'],
      'created_by' => payload['created_by'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 323

def account_sid
  @properties['account_sid']
end

#channel_sid ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 329

def channel_sid
  @properties['channel_sid']
end

#context ⇒ InviteContext

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/ip_messaging/v2/service/channel/invite.rb', line 303

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

#created_by ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 365

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 347

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 353

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the InviteInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 385

def delete
  context.delete
end

#fetch ⇒ InviteInstance

Fetch a InviteInstance

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 378

def fetch
  context.fetch
end

#identity ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 341

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 398

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

#role_sid ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 359

def role_sid
  @properties['role_sid']
end

#service_sid ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 335

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 317

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 391

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

#url ⇒ String

# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/invite.rb', line 371

def url
  @properties['url']
end