sms

README

Sms

A collection of phone number provider wrappers

Documentation

• API Reference
• Example

Installation

go get github.com/saucesteals/sms

Documentation

Index

• Variables
• type Client
• type Matcher
  • func NewMatcher(matcher MatcherFn, delay time.Duration, timeout time.Duration) *Matcher
  • func (m *Matcher) WaitForMessage(ctx context.Context, client Client, phoneNumber *PhoneNumber) (string, error)
• type MatcherFn
• type PhoneNumber
  • func (p *PhoneNumber) Cancelled() bool
  • func (p *PhoneNumber) Format(format phonenumbers.PhoneNumberFormat) string
  • func (p *PhoneNumber) MarkCancelled()
  • func (p *PhoneNumber) MarkUsed()
  • func (p *PhoneNumber) Reuse()
  • func (p *PhoneNumber) Used() bool
• type ReusableClient

Variables

var (
	ErrInvalidMetadata = errors.New("sms: invalid metadata type")
	ErrRatelimited     = errors.New("sms: ratelimited")
)

Types

type Client

type Client interface {
	GetPhoneNumber(ctx context.Context, service string, country string) (*PhoneNumber, error)
	GetMessages(ctx context.Context, phoneNumber *PhoneNumber) ([]string, error)
	CancelPhoneNumber(ctx context.Context, phoneNumber *PhoneNumber) error
	ReportPhoneNumber(ctx context.Context, phoneNumber *PhoneNumber) error
}

type Matcher

type Matcher struct {
	MatcherFn MatcherFn
	Delay     time.Duration
	Timeout   time.Duration
}

func NewMatcher

func NewMatcher(matcher MatcherFn, delay time.Duration, timeout time.Duration) *Matcher

func (*Matcher) WaitForMessage

func (m *Matcher) WaitForMessage(ctx context.Context, client Client, phoneNumber *PhoneNumber) (string, error)

type MatcherFn

type MatcherFn func(message string) (match string)

type PhoneNumber

type PhoneNumber struct {
	*phonenumbers.PhoneNumber
	Metadata any
	// contains filtered or unexported fields
}

func (*PhoneNumber) Cancelled

func (p *PhoneNumber) Cancelled() bool

func (*PhoneNumber) Format

func (p *PhoneNumber) Format(format phonenumbers.PhoneNumberFormat) string

func (*PhoneNumber) MarkCancelled

func (p *PhoneNumber) MarkCancelled()

func (*PhoneNumber) MarkUsed

func (p *PhoneNumber) MarkUsed()

func (*PhoneNumber) Reuse

func (p *PhoneNumber) Reuse()

func (*PhoneNumber) Used

func (p *PhoneNumber) Used() bool

type ReusableClient

type ReusableClient interface {
	Client
	ReusePhoneNumber(ctx context.Context, phoneNumber *PhoneNumber) (*PhoneNumber, error)
}