sms

Documentation

Index

• Variables
• type Client
  • func (c *Client) Send(ctx context.Context, opts smsapi.SendOptions) error
• type ClientResolver
  • func (r *ClientResolver) ResolveClient() (smsapi.Client, SMSClientCredentials, error)
• type CustomClientCredentials
• type Logger
  • func NewLogger(lf *log.Factory) Logger
• type NexmoClientCredentials
• type SMSClientCredentials
• type SendOptions
• type TwilioClientCredentials

Variables

var DependencySet = wire.NewSet(
	NewLogger,
	custom.NewSMSHookTimeout,
	custom.NewHookHTTPClient,
	custom.NewHookDenoClient,
	wire.Struct(new(ClientResolver), "*"),
	wire.Struct(new(Client), "*"),
	wire.Struct(new(custom.SMSWebHook), "*"),
	wire.Struct(new(custom.SMSDenoHook), "*"),
)

var NewTemplateVariablesFromPreparedTemplateVariables = smsapi.NewTemplateVariablesFromPreparedTemplateVariables

Types

type Client

type Client struct {
	Logger         Logger
	ClientResolver *ClientResolver
}

func (*Client) Send

func (c *Client) Send(ctx context.Context, opts smsapi.SendOptions) error

type ClientResolver

type ClientResolver struct {
	AuthgearYAMLSMSProvider config.SMSProvider
	AuthgearYAMLSMSGateway  *config.SMSGatewayConfig

	AuthgearSecretsYAMLNexmoCredentials        *config.NexmoCredentials
	AuthgearSecretsYAMLTwilioCredentials       *config.TwilioCredentials
	AuthgearSecretsYAMLCustomSMSProviderConfig *config.CustomSMSProviderConfig

	EnvironmentDefaultProvider      config.SMSGatewayEnvironmentDefaultProvider
	EnvironmentDefaultUseConfigFrom config.SMSGatewayEnvironmentDefaultUseConfigFrom

	EnvironmentNexmoCredentials        config.SMSGatewayEnvironmentNexmoCredentials
	EnvironmentTwilioCredentials       config.SMSGatewayEnvironmentTwilioCredentials
	EnvironmentCustomSMSProviderConfig config.SMSGatewayEnvironmentCustomSMSProviderConfig

	SMSDenoHook custom.SMSDenoHook
	SMSWebHook  custom.SMSWebHook
}

func (*ClientResolver) ResolveClient

func (r *ClientResolver) ResolveClient() (smsapi.Client, SMSClientCredentials, error)

type CustomClientCredentials

type CustomClientCredentials struct {
	URL     string
	Timeout *config.DurationSeconds
}

type Logger

type Logger struct{ *log.Logger }

func NewLogger

func NewLogger(lf *log.Factory) Logger

type NexmoClientCredentials

type NexmoClientCredentials struct {
	APIKey    string
	APISecret string
}

type SMSClientCredentials

type SMSClientCredentials interface {
	// contains filtered or unexported methods
}

type SendOptions

type SendOptions = smsapi.SendOptions

type TwilioClientCredentials

type TwilioClientCredentials struct {
	AccountSID          string
	AuthToken           string
	MessagingServiceSID string
}