custom

Documentation

Index

• type CustomClient
  • func NewCustomClient(c *config.CustomSMSProviderConfig, d SMSDenoHook, w SMSWebHook) *CustomClient
  • func (c *CustomClient) Send(ctx context.Context, opts smsapi.SendOptions) error
• type DenoHook
• type HookDenoClient
  • func NewHookDenoClient(endpoint config.DenoEndpoint, logger hook.Logger, timeout SMSHookTimeout) HookDenoClient
• type HookDenoClientImpl
• type HookHTTPClient
  • func NewHookHTTPClient(timeout SMSHookTimeout) HookHTTPClient
• type HookHTTPClientImpl
• type ResponseBody
  • func ParseResponseBody(jsonData []byte) (*ResponseBody, error)
• type SMSDenoHook
  • func NewSMSDenoHookForTest(lf *log.Factory, denoEndpoint config.DenoEndpoint, ...) *SMSDenoHook
  • func (d *SMSDenoHook) Call(ctx context.Context, u *url.URL, payload SendOptions) error
  • func (d *SMSDenoHook) Test(ctx context.Context, script string, payload SendOptions) error
• type SMSHookTimeout
  • func NewSMSHookTimeout(smsCfg *config.CustomSMSProviderConfig) SMSHookTimeout
• type SMSWebHook
  • func NewSMSWebHook(hook hook.WebHook, smsCfg *config.CustomSMSProviderConfig) *SMSWebHook
  • func (w *SMSWebHook) Call(ctx context.Context, u *url.URL, payload SendOptions) error
• type SendOptions

Types

type CustomClient

type CustomClient struct {
	Config      *config.CustomSMSProviderConfig
	SMSDenoHook SMSDenoHook
	SMSWebHook  SMSWebHook
}

func NewCustomClient

func NewCustomClient(c *config.CustomSMSProviderConfig, d SMSDenoHook, w SMSWebHook) *CustomClient

func (*CustomClient) Send

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

type DenoHook

type DenoHook interface {
	RunSync(ctx context.Context, client hook.DenoClient, u *url.URL, input interface{}) (out interface{}, err error)
	SupportURL(u *url.URL) bool
}

type HookDenoClient

type HookDenoClient interface {
	Run(ctx context.Context, script string, input interface{}) (out interface{}, err error)
}

func NewHookDenoClient

func NewHookDenoClient(endpoint config.DenoEndpoint, logger hook.Logger, timeout SMSHookTimeout) HookDenoClient

type HookDenoClientImpl

type HookDenoClientImpl struct {
	hook.DenoClient
}

type HookHTTPClient

type HookHTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

func NewHookHTTPClient

func NewHookHTTPClient(timeout SMSHookTimeout) HookHTTPClient

type HookHTTPClientImpl

type HookHTTPClientImpl struct {
	*http.Client
}

type ResponseBody

type ResponseBody struct {
	Code              string `json:"code"`
	ProviderName      string `json:"provider_name,omitempty"`
	ProviderErrorCode string `json:"provider_error_code,omitempty"`
	GoError           string `json:"go_error,omitempty"`
	DumpedResponse    []byte `json:"dumped_response,omitempty"`
}

See https://github.com/authgear/authgear-sms-gateway/blob/main/pkg/handler/api.go

func ParseResponseBody

func ParseResponseBody(jsonData []byte) (*ResponseBody, error)

type SMSDenoHook

type SMSDenoHook struct {
	DenoHook
	Client HookDenoClient
}

func NewSMSDenoHookForTest

func NewSMSDenoHookForTest(lf *log.Factory, denoEndpoint config.DenoEndpoint, smsCfg *config.CustomSMSProviderConfig) *SMSDenoHook

func (*SMSDenoHook) Call

func (d *SMSDenoHook) Call(ctx context.Context, u *url.URL, payload SendOptions) error

func (*SMSDenoHook) Test

func (d *SMSDenoHook) Test(ctx context.Context, script string, payload SendOptions) error

type SMSHookTimeout

type SMSHookTimeout struct {
	Timeout time.Duration
}

func NewSMSHookTimeout

func NewSMSHookTimeout(smsCfg *config.CustomSMSProviderConfig) SMSHookTimeout

type SMSWebHook

type SMSWebHook struct {
	hook.WebHook
	Client HookHTTPClient
}

func NewSMSWebHook

func NewSMSWebHook(hook hook.WebHook, smsCfg *config.CustomSMSProviderConfig) *SMSWebHook

func (*SMSWebHook) Call

func (w *SMSWebHook) Call(ctx context.Context, u *url.URL, payload SendOptions) error

type SendOptions

type SendOptions struct {
	To                string                    `json:"to"`
	Body              string                    `json:"body"`
	AppID             string                    `json:"app_id"`
	TemplateName      string                    `json:"template_name"`
	LanguageTag       string                    `json:"language_tag"`
	TemplateVariables *smsapi.TemplateVariables `json:"template_variables"`
}