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

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the InviteInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil)

    The service_sid

  • channel_sid (String) (defaults to: nil)

    The channel_sid

  • sid (String) (defaults to: nil)

    The sid


235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 235

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_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid


285
286
287
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 285

def 
  @properties['account_sid']
end

#channel_sidString

Returns The channel_sid.

Returns:

  • (String)

    The channel_sid


291
292
293
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 291

def channel_sid
  @properties['channel_sid']
end

#contextInviteContext

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

Returns:


265
266
267
268
269
270
271
272
273
274
275
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 265

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

#created_byString

Returns The created_by.

Returns:

  • (String)

    The created_by


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

def created_by
  @properties['created_by']
end

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created


309
310
311
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 309

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the InviteInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchInviteInstance

Fetch the InviteInstance

Returns:


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

def fetch
  context.fetch
end

#identityString

Returns The identity.

Returns:

  • (String)

    The identity


303
304
305
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 303

def identity
  @properties['identity']
end

#inspectObject

Provide a detailed, user friendly representation


360
361
362
363
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 360

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

#role_sidString

Returns The role_sid.

Returns:

  • (String)

    The role_sid


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

def role_sid
  @properties['role_sid']
end

#service_sidString

Returns The service_sid.

Returns:

  • (String)

    The service_sid


297
298
299
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 297

def service_sid
  @properties['service_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid


279
280
281
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 279

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


353
354
355
356
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb', line 353

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

#urlString

Returns The url.

Returns:

  • (String)

    The url


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

def url
  @properties['url']
end