View Source ExTwilio.Notify.Service (ExTwilio v0.10.0)

Represents a Service resource in the Twilio Notify.

Twilio docs
friendly_name Human-readable name for this service instance
apn_credential_sid The SID of the ExTwilio.Notify.Credential to be used for APN Bindings.
gcm_credential_sid The SID of the ExTwilio.Notify.Credential to be used for GCM Bindings.
messaging_service_sid The SID of the [Messaging Service] (https://www.twilio.com/docs/api/rest/sending-messages#messaging-services) to be used for SMS Bindings. In order to send SMS notifications this parameter has to be set.
facebook_messenger_page_id The Page ID to be used to send for Facebook Messenger Bindings. It has to match the Page ID you configured when you enabled Facebook Messaging on your account.
default_apn_notification_protocol_version The version of the protocol to be used for sending APNS notifications. Can be overriden on a Binding by Binding basis when creating a ExTwilio.Notify.Bindings resource.
default_gcm_notification_protocol_version The version of the protocol to be used for sending GCM notifications. Can be overriden on a Binding by Binding basis when creating a ExTwilio.Notify.Bindings resource.
fcm_credential_sid The SID of the ExTwilio.Notify.Credential to be used for FCM Bindings.
default_fcm_notification_protocol_version The version of the protocol to be used for sending FCM notifications. Can be overriden on a Binding by Binding basis when creating a ExTwilio.Notify.Credential resource.
log_enabled The log_enabled
alexa_skill_id The alexa_skill_id
default_alexa_notification_protocol_version The default_alexa_notification_protocol_version

Summary

Functions

all(options \\ [])

children()

Children represent path segments that come after the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active "Active" is a child. Children may or may not have a key in the next segment.

create(data, options \\ [])

destroy(sid, options \\ [])

do_new(struct, list)

find(sid, options \\ [])

new()

new(attrs)

parents()

Parents represent path segments that precede the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users "Services" is a parent. Parents will always have a key in the next segment. If your parent is under a submodule of ExTwilio, specify your parent using the ExTwilio.Parent struct.

resource_collection_name()

Underscored and lowercased collection name for a given resource. Delegates the real work to ExTwilio.UrlGenerator.resource_collection_name/1 by default.

resource_name()

CamelCase resource name as it would be used in Twilio's API. Delegates the real work to ExTwilio.UrlGenerator.resource_name/1 by default.

stream(options \\ [])

update(sid, data, options \\ [])

Functions

all(options \\ [])

@spec all(list()) :: [map()]

children()

@spec children() :: list()

Children represent path segments that come after the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users/Active "Active" is a child. Children may or may not have a key in the next segment.

Override this method in your resource to specify children in the order that they will appear in the path.

create(data, options \\ [])

@spec create(ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()

destroy(sid, options \\ [])

@spec destroy(String.t(), list()) ::
  ExTwilio.Parser.success_delete() | ExTwilio.Parser.error()

do_new(struct, list)

@spec do_new(
  %ExTwilio.Notify.Service{
    account_sid: term(),
    alexa_skill_id: term(),
    apn_credential_sid: term(),
    date_created: term(),
    date_updated: term(),
    default_alexa_notification_protocol_version: term(),
    default_apn_notification_protocol_version: term(),
    default_fcm_notification_protocol_version: term(),
    default_gcm_notification_protocol_version: term(),
    facebook_messenger_page_id: term(),
    fcm_credential_sid: term(),
    friendly_name: term(),
    gcm_credential_sid: term(),
    links: term(),
    log_enabled: term(),
    messaging_service_sid: term(),
    sid: term(),
    url: term()
  },
  list()
) :: %ExTwilio.Notify.Service{
  account_sid: term(),
  alexa_skill_id: term(),
  apn_credential_sid: term(),
  date_created: term(),
  date_updated: term(),
  default_alexa_notification_protocol_version: term(),
  default_apn_notification_protocol_version: term(),
  default_fcm_notification_protocol_version: term(),
  default_gcm_notification_protocol_version: term(),
  facebook_messenger_page_id: term(),
  fcm_credential_sid: term(),
  friendly_name: term(),
  gcm_credential_sid: term(),
  links: term(),
  log_enabled: term(),
  messaging_service_sid: term(),
  sid: term(),
  url: term()
}

find(sid, options \\ [])

@spec find(String.t() | nil, list()) :: ExTwilio.Parser.parsed_list_response()

new()

@spec new() :: %ExTwilio.Notify.Service{
  account_sid: term(),
  alexa_skill_id: term(),
  apn_credential_sid: term(),
  date_created: term(),
  date_updated: term(),
  default_alexa_notification_protocol_version: term(),
  default_apn_notification_protocol_version: term(),
  default_fcm_notification_protocol_version: term(),
  default_gcm_notification_protocol_version: term(),
  facebook_messenger_page_id: term(),
  fcm_credential_sid: term(),
  friendly_name: term(),
  gcm_credential_sid: term(),
  links: term(),
  log_enabled: term(),
  messaging_service_sid: term(),
  sid: term(),
  url: term()
}

new(attrs)

@spec new(list()) :: %ExTwilio.Notify.Service{
  account_sid: term(),
  alexa_skill_id: term(),
  apn_credential_sid: term(),
  date_created: term(),
  date_updated: term(),
  default_alexa_notification_protocol_version: term(),
  default_apn_notification_protocol_version: term(),
  default_fcm_notification_protocol_version: term(),
  default_gcm_notification_protocol_version: term(),
  facebook_messenger_page_id: term(),
  fcm_credential_sid: term(),
  friendly_name: term(),
  gcm_credential_sid: term(),
  links: term(),
  log_enabled: term(),
  messaging_service_sid: term(),
  sid: term(),
  url: term()
}

parents()

@spec parents() :: list()

Parents represent path segments that precede the current resource. For example, in the path /v2/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Users "Services" is a parent. Parents will always have a key in the next segment. If your parent is under a submodule of ExTwilio, specify your parent using the ExTwilio.Parent struct.

Override this method in your resource to specify parents in the order that they will appear in the path.

resource_collection_name()

Underscored and lowercased collection name for a given resource. Delegates the real work to ExTwilio.UrlGenerator.resource_collection_name/1 by default.

Override in your module after use ExTwilio.Resource if you need something different.

resource_name()

CamelCase resource name as it would be used in Twilio's API. Delegates the real work to ExTwilio.UrlGenerator.resource_name/1 by default.

Override in your module after use ExTwilio.Resource if you need something different.

stream(options \\ [])

update(sid, data, options \\ [])

@spec update(String.t(), ExTwilio.Api.data(), list()) ::
  ExTwilio.Parser.parsed_response()