smsapi

Documentation

Index

• Variables
• type Client
• type SendError
  • func (e *SendError) Error() string
• type SendOptions
• type TemplateVariables
  • func NewTemplateVariablesFromPreparedTemplateVariables(v *translation.PreparedTemplateVariables) *TemplateVariables

Variables

var ErrAmbiguousClient = errors.New("ambiguous SMS client")

var ErrKindAuthenticationFailed = apierrors.InternalError.WithReason("SMSGatewayAuthenticationFailed")

var ErrKindDeliveryRejected = apierrors.InternalError.WithReason("SMSGatewayDeliveryRejected")

var ErrKindInvalidPhoneNumber = apierrors.BadRequest.WithReason("SMSGatewayInvalidPhoneNumber")

var ErrKindRateLimited = apierrors.TooManyRequest.WithReason("SMSGatewayRateLimited")

var ErrNoAvailableClient = NoAvailableClient.
	New("no available SMS client")

var NoAvailableClient = apierrors.InternalError.
	WithReason("NoAvailableSMSClient")

Types

type Client

type Client interface {
	Send(ctx context.Context, opts SendOptions) error
}

type SendError

type SendError struct {
	DumpedResponse []byte `json:"dumped_response,omitempty"`
}

func (*SendError) Error

func (e *SendError) Error() string

type SendOptions

type SendOptions struct {
	Sender            string
	To                string
	Body              string
	AppID             string
	TemplateName      string
	LanguageTag       string
	TemplateVariables *TemplateVariables
}

type TemplateVariables

type TemplateVariables struct {
	AppName     string `json:"app_name,omitempty"`
	ClientID    string `json:"client_id,omitempty"`
	Code        string `json:"code,omitempty"`
	Email       string `json:"email,omitempty"`
	HasPassword bool   `json:"has_password,omitempty"`
	Host        string `json:"host,omitempty"`
	Link        string `json:"link,omitempty"`
	Password    string `json:"password,omitempty"`
	Phone       string `json:"phone,omitempty"`
	State       string `json:"state,omitempty"`
	UILocales   string `json:"ui_locales,omitempty"`
	URL         string `json:"url,omitempty"`
	XState      string `json:"x_state,omitempty"`
}

func NewTemplateVariablesFromPreparedTemplateVariables

func NewTemplateVariablesFromPreparedTemplateVariables(v *translation.PreparedTemplateVariables) *TemplateVariables