credentials

Documentation

Index

• type APIKey
  • func (apiKey APIKey) AccountSid() string
  • func (apiKey APIKey) Validate() error
• type Account
  • func (account Account) AccountSid() string
  • func (account Account) Validate() error
• type Credentials
  • func New(creds TwilioCredentials) (*Credentials, error)
  • func NewWithNoValidation(creds TwilioCredentials) *Credentials
• type TwilioCredentials

Types

type APIKey

type APIKey struct {
	Account string
	Sid     string
	Value   string
}

APIKey represents a Twilio API Key which can be used to authenticate against the Twilio APIs

func (APIKey) AccountSid

func (apiKey APIKey) AccountSid() string

func (APIKey) Validate

func (apiKey APIKey) Validate() error

Validate ensures the API Keys is valid

type Account

type Account struct {
	Sid       string
	AuthToken string
}

Account represents Twilio Account Credentials which can be used to authenticate against the Twilio APIs

func (Account) AccountSid

func (account Account) AccountSid() string

func (Account) Validate

func (account Account) Validate() error

Validate ensures the account credentials are valid

type Credentials

type Credentials struct {
	AccountSid string
	Username   string
	Password   string
}

Credentials represents the field necessary to authenticate against the Twilio APIs

func New

func New(creds TwilioCredentials) (*Credentials, error)

New creates a new instance of credentials using the supplied twilio credentials. If the credentials are invalid then an error will be returned

func NewWithNoValidation

func NewWithNoValidation(creds TwilioCredentials) *Credentials

NewWithNoValidation creates a new instance of credentials using the supplied twilio credentials. This skips validation as some tools may initialise the client before credentials are supplied

type TwilioCredentials

type TwilioCredentials interface {
	Validate() error
	AccountSid() string
	// contains filtered or unexported methods
}

TwilioCredentials respresents the structure of twilio credentials