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

Represents a Credential resource in the Twilio Notify.

  • Twilio docs

  • type Credential type, one of "gcm", "fcm", or "apn"

  • friendly_name Friendly name for stored credential

  • certificate [APN only] URL encoded representation of the certificate. Strip everything outside of the headers, e.g. -----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----

  • private_key [APN only] URL encoded representation of the private key. Strip everything outside of the headers, e.g. -----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR .-----END RSA PRIVATE KEY-----

  • sandbox [APN only] use this credential for sending to production or sandbox APNs (string true or false)

  • api_key [GCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging. Yes, you can use the server key from the Firebase console for GCM.

  • secret [FCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging.

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

Link to this function

all(options \\ [])

View Source 
@spec all(list()) :: [map()]
Link to this function

children()

View Source 
@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.

Link to this function

create(data, options \\ [])

View Source 
@spec create(ExTwilio.Api.data(), list()) :: ExTwilio.Parser.parsed_response()
Link to this function

destroy(sid, options \\ [])

View Source 
@spec destroy(String.t(), list()) ::
  ExTwilio.Parser.success_delete() | ExTwilio.Parser.error()
Link to this function

do_new(struct, list)

View Source 
@spec do_new(
  %ExTwilio.Notify.Credential{
    account_sid: term(),
    api_key: term(),
    certificate: term(),
    date_created: term(),
    date_updated: term(),
    friendly_name: term(),
    private_key: term(),
    sandbox: term(),
    secret: term(),
    sid: term(),
    type: term(),
    url: term()
  },
  list()
) :: %ExTwilio.Notify.Credential{
  account_sid: term(),
  api_key: term(),
  certificate: term(),
  date_created: term(),
  date_updated: term(),
  friendly_name: term(),
  private_key: term(),
  sandbox: term(),
  secret: term(),
  sid: term(),
  type: term(),
  url: term()
}
Link to this function

find(sid, options \\ [])

View Source 
@spec find(String.t() | nil, list()) :: ExTwilio.Parser.parsed_list_response()
Link to this function

new()

View Source 
@spec new() :: %ExTwilio.Notify.Credential{
  account_sid: term(),
  api_key: term(),
  certificate: term(),
  date_created: term(),
  date_updated: term(),
  friendly_name: term(),
  private_key: term(),
  sandbox: term(),
  secret: term(),
  sid: term(),
  type: term(),
  url: term()
}
Link to this function

new(attrs)

View Source 
@spec new(list()) :: %ExTwilio.Notify.Credential{
  account_sid: term(),
  api_key: term(),
  certificate: term(),
  date_created: term(),
  date_updated: term(),
  friendly_name: term(),
  private_key: term(),
  sandbox: term(),
  secret: term(),
  sid: term(),
  type: term(),
  url: term()
}
Link to this function

parents()

View Source 
@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.

Link to this function

resource_collection_name()

View Source

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.

Link to this function

resource_name()

View Source

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.

Link to this function

stream(options \\ [])

View Source
Link to this function

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

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