Class: Twilio::REST::Notify::V1::ServiceInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Notify::V1::ServiceInstance
- Defined in:
- lib/twilio-ruby/rest/notify/v1/service.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Service resource.
-
#alexa_skill_id ⇒ String
Deprecated.
-
#apn_credential_sid ⇒ String
The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
-
#bindings ⇒ bindings
Access the bindings.
-
#context ⇒ ServiceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#default_alexa_notification_protocol_version ⇒ String
Deprecated.
-
#default_apn_notification_protocol_version ⇒ String
The protocol version to use for sending APNS notifications.
-
#default_fcm_notification_protocol_version ⇒ String
The protocol version to use for sending FCM notifications.
-
#default_gcm_notification_protocol_version ⇒ String
The protocol version to use for sending GCM notifications.
-
#delete ⇒ Boolean
Delete the ServiceInstance.
-
#delivery_callback_enabled ⇒ Boolean
Callback configuration that enables delivery callbacks, default false.
-
#delivery_callback_url ⇒ String
URL to send delivery status callback.
-
#facebook_messenger_page_id ⇒ String
Deprecated.
-
#fcm_credential_sid ⇒ String
The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
-
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#gcm_credential_sid ⇒ String
The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
-
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
constructor
Initialize the ServiceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of the Binding, Notification, Segment, and User resources related to the service.
-
#log_enabled ⇒ Boolean
Whether to log notifications.
-
#messaging_service_sid ⇒ String
The SID of the [Messaging Service](www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings.
-
#notifications ⇒ notifications
Access the notifications.
-
#sid ⇒ String
The unique string that we created to identify the Service resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :unset) ⇒ ServiceInstance
Update the ServiceInstance.
-
#url ⇒ String
The absolute URL of the Service resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
Initialize the ServiceInstance
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 375 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], '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']), 'apn_credential_sid' => payload['apn_credential_sid'], 'gcm_credential_sid' => payload['gcm_credential_sid'], 'fcm_credential_sid' => payload['fcm_credential_sid'], 'messaging_service_sid' => payload['messaging_service_sid'], 'facebook_messenger_page_id' => payload['facebook_messenger_page_id'], 'default_apn_notification_protocol_version' => payload['default_apn_notification_protocol_version'], 'default_gcm_notification_protocol_version' => payload['default_gcm_notification_protocol_version'], 'default_fcm_notification_protocol_version' => payload['default_fcm_notification_protocol_version'], 'log_enabled' => payload['log_enabled'], 'url' => payload['url'], 'links' => payload['links'], 'alexa_skill_id' => payload['alexa_skill_id'], 'default_alexa_notification_protocol_version' => payload['default_alexa_notification_protocol_version'], 'delivery_callback_url' => payload['delivery_callback_url'], 'delivery_callback_enabled' => payload['delivery_callback_enabled'], } # Context @instance_context = nil @params = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Service resource.
426 427 428 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 426 def account_sid @properties['account_sid'] end |
#alexa_skill_id ⇒ String
Returns Deprecated.
516 517 518 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 516 def alexa_skill_id @properties['alexa_skill_id'] end |
#apn_credential_sid ⇒ String
Returns The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
450 451 452 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 450 def apn_credential_sid @properties['apn_credential_sid'] end |
#bindings ⇒ bindings
Access the bindings
616 617 618 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 616 def bindings context.bindings 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
411 412 413 414 415 416 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 411 def context unless @instance_context @instance_context = ServiceContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
438 439 440 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 438 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
444 445 446 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 444 def date_updated @properties['date_updated'] end |
#default_alexa_notification_protocol_version ⇒ String
Returns Deprecated.
522 523 524 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 522 def default_alexa_notification_protocol_version @properties['default_alexa_notification_protocol_version'] end |
#default_apn_notification_protocol_version ⇒ String
Returns The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](www.twilio.com/docs/notify/api/binding-resource) resource.
480 481 482 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 480 def default_apn_notification_protocol_version @properties['default_apn_notification_protocol_version'] end |
#default_fcm_notification_protocol_version ⇒ String
Returns The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](www.twilio.com/docs/notify/api/binding-resource) resource.
492 493 494 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 492 def default_fcm_notification_protocol_version @properties['default_fcm_notification_protocol_version'] end |
#default_gcm_notification_protocol_version ⇒ String
Returns The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](www.twilio.com/docs/notify/api/binding-resource) resource.
486 487 488 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 486 def default_gcm_notification_protocol_version @properties['default_gcm_notification_protocol_version'] end |
#delete ⇒ Boolean
Delete the ServiceInstance
541 542 543 544 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 541 def delete context.delete end |
#delivery_callback_enabled ⇒ Boolean
Returns Callback configuration that enables delivery callbacks, default false.
534 535 536 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 534 def delivery_callback_enabled @properties['delivery_callback_enabled'] end |
#delivery_callback_url ⇒ String
Returns URL to send delivery status callback.
528 529 530 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 528 def delivery_callback_url @properties['delivery_callback_url'] end |
#facebook_messenger_page_id ⇒ String
Returns Deprecated.
474 475 476 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 474 def facebook_messenger_page_id @properties['facebook_messenger_page_id'] end |
#fcm_credential_sid ⇒ String
Returns The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
462 463 464 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 462 def fcm_credential_sid @properties['fcm_credential_sid'] end |
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance
549 550 551 552 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 549 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
432 433 434 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 432 def friendly_name @properties['friendly_name'] end |
#gcm_credential_sid ⇒ String
Returns The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
456 457 458 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 456 def gcm_credential_sid @properties['gcm_credential_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
629 630 631 632 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 629 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Notify.V1.ServiceInstance #{values}>" end |
#links ⇒ Hash
Returns The URLs of the Binding, Notification, Segment, and User resources related to the service.
510 511 512 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 510 def links @properties['links'] end |
#log_enabled ⇒ Boolean
Returns Whether to log notifications. Can be: ‘true` or `false` and the default is `true`.
498 499 500 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 498 def log_enabled @properties['log_enabled'] end |
#messaging_service_sid ⇒ String
Returns The SID of the [Messaging Service](www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set.
468 469 470 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 468 def messaging_service_sid @properties['messaging_service_sid'] end |
#notifications ⇒ notifications
Access the notifications
609 610 611 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 609 def notifications context.notifications end |
#sid ⇒ String
Returns The unique string that we created to identify the Service resource.
420 421 422 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 420 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
622 623 624 625 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 622 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Notify.V1.ServiceInstance #{values}>" end |
#update(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :unset) ⇒ ServiceInstance
Update the ServiceInstance
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 571 def update( friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :unset ) context.update( friendly_name: friendly_name, apn_credential_sid: apn_credential_sid, gcm_credential_sid: gcm_credential_sid, messaging_service_sid: messaging_service_sid, facebook_messenger_page_id: facebook_messenger_page_id, default_apn_notification_protocol_version: default_apn_notification_protocol_version, default_gcm_notification_protocol_version: default_gcm_notification_protocol_version, fcm_credential_sid: fcm_credential_sid, default_fcm_notification_protocol_version: default_fcm_notification_protocol_version, log_enabled: log_enabled, alexa_skill_id: alexa_skill_id, default_alexa_notification_protocol_version: default_alexa_notification_protocol_version, delivery_callback_url: delivery_callback_url, delivery_callback_enabled: delivery_callback_enabled, ) end |
#url ⇒ String
Returns The absolute URL of the Service resource.
504 505 506 |
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 504 def url @properties['url'] end |