Class: Twilio::REST::Notify::V1::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Service resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 717

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.

Returns:



769
770
771
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 769

def 
    @properties['account_sid']
end

#alexa_skill_id ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated.



859
860
861
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 859

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.

Returns:



793
794
795
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 793

def apn_credential_sid
    @properties['apn_credential_sid']
end

#bindings ⇒ bindings

Access the bindings

Returns:



959
960
961
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 959

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

Returns:



754
755
756
757
758
759
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 754

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.

Returns:



781
782
783
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 781

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.

Returns:



787
788
789
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 787

def date_updated
    @properties['date_updated']
end

#default_alexa_notification_protocol_version ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated.



865
866
867
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 865

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.

Returns:



823
824
825
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 823

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.

Returns:



835
836
837
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 835

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.

Returns:



829
830
831
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 829

def default_gcm_notification_protocol_version
    @properties['default_gcm_notification_protocol_version']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



884
885
886
887
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 884

def delete

    context.delete
end

#delivery_callback_enabled ⇒ Boolean

Returns Callback configuration that enables delivery callbacks, default false.

Returns:

  • (Boolean) —

    Callback configuration that enables delivery callbacks, default false



877
878
879
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 877

def delivery_callback_enabled
    @properties['delivery_callback_enabled']
end

#delivery_callback_url ⇒ String

Returns URL to send delivery status callback.

Returns:

  • (String) —

    URL to send delivery status callback.



871
872
873
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 871

def delivery_callback_url
    @properties['delivery_callback_url']
end

#facebook_messenger_page_id ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated.



817
818
819
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 817

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.

Returns:



805
806
807
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 805

def fcm_credential_sid
    @properties['fcm_credential_sid']
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



892
893
894
895
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 892

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



775
776
777
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 775

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.

Returns:



799
800
801
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 799

def gcm_credential_sid
    @properties['gcm_credential_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



972
973
974
975
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 972

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.

Returns:

  • (Hash) —

    The URLs of the Binding, Notification, Segment, and User resources related to the service.



853
854
855
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 853

def links
    @properties['links']
end

#log_enabled ⇒ Boolean

Returns Whether to log notifications. Can be: true or false and the default is true.

Returns:

  • (Boolean) —

    Whether to log notifications. Can be: true or false and the default is true.



841
842
843
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 841

def log_enabled
    @properties['log_enabled']
end

#messaging_service_sid ⇒ String

Returns The SID of the [Messaging Service](www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set.

Returns:



811
812
813
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 811

def messaging_service_sid
    @properties['messaging_service_sid']
end

#notifications ⇒ notifications

Access the notifications

Returns:



952
953
954
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 952

def notifications
    context.notifications
end

#sid ⇒ String

Returns The unique string that we created to identify the Service resource.

Returns:

  • (String) —

    The unique string that we created to identify the Service resource.



763
764
765
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 763

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



965
966
967
968
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 965

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

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • apn_credential_sid (String) (defaults to: :unset) —

    The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.

  • gcm_credential_sid (String) (defaults to: :unset) —

    The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.

  • messaging_service_sid (String) (defaults to: :unset) —

    The SID of the [Messaging Service](www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.

  • facebook_messenger_page_id (String) (defaults to: :unset) —

    Deprecated.

  • default_apn_notification_protocol_version (String) (defaults to: :unset) —

    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.

  • default_gcm_notification_protocol_version (String) (defaults to: :unset) —

    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.

  • fcm_credential_sid (String) (defaults to: :unset) —

    The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.

  • default_fcm_notification_protocol_version (String) (defaults to: :unset) —

    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.

  • log_enabled (Boolean) (defaults to: :unset) —

    Whether to log notifications. Can be: true or false and the default is true.

  • alexa_skill_id (String) (defaults to: :unset) —

    Deprecated.

  • default_alexa_notification_protocol_version (String) (defaults to: :unset) —

    Deprecated.

  • delivery_callback_url (String) (defaults to: :unset) —

    URL to send delivery status callback.

  • delivery_callback_enabled (Boolean) (defaults to: :unset) —

    Callback configuration that enables delivery callbacks, default false

Returns:



914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 914

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.

Returns:

  • (String) —

    The absolute URL of the Service resource.



847
848
849
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 847

def url
    @properties['url']
end