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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the WebhookInstance

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


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 274

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'],
      'service_sid' => payload['service_sid'],
      'channel_sid' => payload['channel_sid'],
      'type' => payload['type'],
      'url' => payload['url'],
      'configuration' => payload['configuration'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
  }

  # 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


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

def 
  @properties['account_sid']
end

#channel_sidString

Returns The channel_sid.

Returns:

  • (String)

    The channel_sid


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

def channel_sid
  @properties['channel_sid']
end

#configurationHash

Returns The configuration.

Returns:

  • (Hash)

    The configuration


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

def configuration
  @properties['configuration']
end

#contextWebhookContext

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

Returns:


303
304
305
306
307
308
309
310
311
312
313
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 303

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

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the WebhookInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


399
400
401
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 399

def delete
  context.delete
end

#fetchWebhookInstance

Fetch the WebhookInstance

Returns:


372
373
374
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 372

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


412
413
414
415
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 412

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

#service_sidString

Returns The service_sid.

Returns:

  • (String)

    The service_sid


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

def service_sid
  @properties['service_sid']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


405
406
407
408
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 405

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

#typeString

Returns The type.

Returns:

  • (String)

    The type


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

def type
  @properties['type']
end

#update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

  • configuration_url (String) (defaults to: :unset)

    The configuration.url

  • configuration_method (webhook.Method) (defaults to: :unset)

    The configuration.method

  • configuration_filters (Array[String]) (defaults to: :unset)

    The configuration.filters

  • configuration_triggers (Array[String]) (defaults to: :unset)

    The configuration.triggers

  • configuration_flow_sid (String) (defaults to: :unset)

    The configuration.flow_sid

  • configuration_retry_count (String) (defaults to: :unset)

    The configuration.retry_count

Returns:


385
386
387
388
389
390
391
392
393
394
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/webhook.rb', line 385

def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
  context.update(
      configuration_url: configuration_url,
      configuration_method: configuration_method,
      configuration_filters: configuration_filters,
      configuration_triggers: configuration_triggers,
      configuration_flow_sid: configuration_flow_sid,
      configuration_retry_count: configuration_retry_count,
  )
end

#urlString

Returns The url.

Returns:

  • (String)

    The url


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

def url
  @properties['url']
end