spoo

package module

Go to main page

Versions in this module

v0

v0.6.0

Sep 4, 2026

Changes in this version

+ type BulkTagChange struct

+ Add []string

+ Remove []string

type Client

+ func (c *Client) BulkUpdateTags(ctx context.Context, ids []string, change BulkTagChange) (*BulkResult, error)

+ func (c *Client) CreateTag(ctx context.Context, params CreateTagParams) (*Tag, error)

+ func (c *Client) DeleteTag(ctx context.Context, id string) (*TagDeletion, error)

+ func (c *Client) ListTags(ctx context.Context) ([]Tag, error)

+ func (c *Client) UpdateTag(ctx context.Context, id string, params UpdateTagParams) (*Tag, error)

+ type CreateTagParams struct

+ Color string

+ Icon string

+ Name string

type ListURLsOptions

+ TagIDs []string

+ TagNames []string

+ TagsMatch string

type ShortURL

+ Tags []TagRef

type ShortenRequest

+ TagIDs []string

+ type Tag struct

+ Color string

+ CreatedAt Timestamp

+ ID string

+ Icon string

+ LinkCount int

+ Name string

+ UpdatedAt Timestamp

+ type TagDeletion struct

+ Deleted bool

+ LinksUpdated int

+ type TagRef struct

+ Color string

+ ID string

+ Icon string

+ Name string

type URLItem

+ Tags []TagRef

+ type UpdateTagParams struct

+ Color string

+ Icon string

+ Name string

type UpdateURLParams

+ TagIDs Opt[[]string]

type UpdatedURL

+ Tags []TagRef

v0.5.3

Aug 19, 2026

v0.5.2

Aug 19, 2026

v0.5.1

Aug 19, 2026

v0.5.0

Aug 19, 2026

Changes in this version

+ var ErrMissingLongURL = errors.New("spoo: ShortenRequest.LongURL is required")

type Client

+ func (c *Client) Delete(ctx context.Context, path string, out any) error

+ func (c *Client) Get(ctx context.Context, path string, query url.Values, out any) error

+ func (c *Client) Patch(ctx context.Context, path string, body, out any) error

+ func (c *Client) Post(ctx context.Context, path string, body, out any) error

+ func (c *Client) Put(ctx context.Context, path string, body, out any) error

v0.4.1

Aug 19, 2026

v0.4.0

Aug 19, 2026

Changes in this version

+ var ErrLinkBlocked = errors.New("link is blocked")

+ func IsBlocked(err error) bool

type ListURLsOptions

+ CreatedAfter time.Time

+ CreatedBefore time.Time

+ MaxClicksSet Opt[bool]

+ PasswordSet Opt[bool]

v0.3.0

Aug 19, 2026

v0.2.0

Aug 19, 2026

Changes in this version

type Client

+ func (c *Client) DeleteURLsByDomain(ctx context.Context, domain string) (*DomainDeletion, error)

+ func (c *Client) SetURLStatus(ctx context.Context, id, status string) (*UpdatedURL, error)

+ type DomainDeletion struct

+ Count int

+ Domain string

+ Message string

+ type PublicLinkFacts struct

+ Alias string

+ BlockBots bool

+ CreatedAt Timestamp

+ LongURL string

+ MaxClicks *int

+ PasswordProtected bool

+ ShortURL string

+ Status string

type PublicStatsQuery

+ Password string

+ type PublicStatsResult struct

+ Generation string

+ Link PublicLinkFacts

+ Stats StatsResponse

type URLItem

+ ShortURL string

v0.1.0

Aug 19, 2026

Changes in this version

+ const ClaimStatusAlreadyYours

+ const ClaimStatusClaimed

+ const ClaimStatusInvalid

+ const DefaultBaseURL

+ const MaxRangeDays

+ var ErrLinkPasswordProtected = errors.New("link is password protected")

+ var ErrSessionExpired = errors.New("session expired")

+ var ErrTokenSourceRequired = errors.New("no refresh-capable token source configured")

+ var Version = "dev"

+ func CodeChallengeS256(verifier string) string

+ func GenerateCodeVerifier() (string, error)

+ func GenerateState() (string, error)

+ func IsNotFound(err error) bool

+ func IsRateLimited(err error) bool

+ func ParseExpiry(raw string, now time.Time) (time.Time, error)

+ type AliasCheck struct

+ Available bool

+ Reason string

+ type BulkResult struct

+ Results []BulkRow

+ Summary BulkSummary

+ type BulkRow struct

+ Alias string

+ Error string

+ ErrorCode string

+ ID string

+ OK bool

+ type BulkSummary struct

+ Failed int

+ Succeeded int

+ Total int

+ type Claim struct

+ Token string

+ URLID string

+ type ClaimOutcome struct

+ Claimed int

+ Results []ClaimResult

+ type ClaimResult struct

+ Status string

+ URLID string

+ type Client struct

+ func NewClient(opts ...Option) *Client

+ func (c *Client) BulkDelete(ctx context.Context, ids []string) (*BulkResult, error)

+ func (c *Client) BulkMoveDomain(ctx context.Context, ids []string, domain string) (*BulkResult, error)

+ func (c *Client) BulkUpdateExpiry(ctx context.Context, ids []string, expireAfter time.Time) (*BulkResult, error)

+ func (c *Client) BulkUpdateStatus(ctx context.Context, ids []string, status string) (*BulkResult, error)

+ func (c *Client) CheckAlias(ctx context.Context, alias, domain string) (*AliasCheck, error)

+ func (c *Client) ClaimURLs(ctx context.Context, claims []Claim) (*ClaimOutcome, error)

+ func (c *Client) DeleteURL(ctx context.Context, id string) error

+ func (c *Client) DeviceAuthURL(p DeviceAuthParams) string

+ func (c *Client) EmojiSet(ctx context.Context) (*EmojiSet, error)

+ func (c *Client) ExchangeDeviceCode(ctx context.Context, appID, code, verifier string) (*DeviceTokens, error)

+ func (c *Client) Export(ctx context.Context, q StatsQuery, format string) (*ExportFile, error)

+ func (c *Client) ExportLink(ctx context.Context, urlID string, q StatsQuery, format string) (*ExportFile, error)

+ func (c *Client) ForceRefresh(ctx context.Context) (Credentials, error)

+ func (c *Client) GetURL(ctx context.Context, id string) (*URLItem, error)

+ func (c *Client) LinkStats(ctx context.Context, urlID string, q StatsQuery) (*StatsResponse, error)

+ func (c *Client) ListURLs(ctx context.Context, opts ListURLsOptions) (*URLPage, error)

+ func (c *Client) ListURLsAll(ctx context.Context, opts ListURLsOptions) iter.Seq2[URLItem, error]

+ func (c *Client) Me(ctx context.Context) (*User, error)

+ func (c *Client) PublicPreview(ctx context.Context, shortCode string) (*PublicPreview, error)

+ func (c *Client) PublicStats(ctx context.Context, shortCode string, q PublicStatsQuery) (*StatsResponse, error)

+ func (c *Client) RefreshTokens(ctx context.Context, appID, refreshToken string) (*TokenPair, error)

+ func (c *Client) ResolveAlias(ctx context.Context, alias, domain string) (*URLItem, error)

+ func (c *Client) Shorten(ctx context.Context, req ShortenRequest) (*ShortURL, error)

+ func (c *Client) Stats(ctx context.Context, q StatsQuery) (*StatsResponse, error)

+ func (c *Client) StatsByAlias(ctx context.Context, alias, domain string, q StatsQuery) (*StatsResponse, error)

+ func (c *Client) UpdateURL(ctx context.Context, id string, params UpdateURLParams) (*UpdatedURL, error)

+ type Credentials struct

+ APIKey string

+ AccessToken string

+ RefreshToken string

+ type DeviceAuthParams struct

+ AppID string

+ CodeChallenge string

+ RedirectURI string

+ State string

+ type DeviceTokens struct

+ User User

+ type EmojiEntry struct

+ Char string

+ Generated bool

+ Group string

+ Keywords []string

+ Name string

+ type EmojiSet struct

+ AcceptMaxVersion float64

+ Emoji []EmojiEntry

+ GenerateMaxVersion float64

+ MaxGraphemes int

+ type Error struct

+ Code string

+ Details any

+ Field string

+ Message string

+ RateLimit RateLimit

+ RequestID string

+ StatusCode int

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type ExportFile struct

+ Body io.ReadCloser

+ ContentType string

+ Filename string

+ type ListURLsOptions struct

+ Domain string

+ Page int

+ PageSize int

+ Search string

+ SortBy string

+ SortOrder string

+ Status string

+ type MetricPoint struct

+ Label string

+ Value float64

+ type Opt struct

+ func Null[T any]() Opt[T]

+ func Set[T any](v T) Opt[T]

+ func (o *Opt[T]) UnmarshalJSON(data []byte) error

+ func (o Opt[T]) IsNull() bool

+ func (o Opt[T]) IsZero() bool

+ func (o Opt[T]) MarshalJSON() ([]byte, error)

+ func (o Opt[T]) Value() (T, bool)

+ type Option func(*Client)

+ func WithAPIKey(key string) Option

+ func WithBaseURL(base string) Option

+ func WithClientTag(tag string) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithMaxRetries(n int) Option

+ func WithTokenSource(tokens TokenSource) Option

+ type PreviewDestination struct

+ Domain string

+ IsHTTPS bool

+ Path string

+ URL string

+ type PreviewGeoDestination struct

+ Countries []string

+ type PublicPreview struct

+ Alias string

+ CreatedAt Timestamp

+ Destination *PreviewDestination

+ Generation string

+ GeoDestinations []PreviewGeoDestination

+ PasswordProtected bool

+ ShortURL string

+ Status string

+ type PublicStatsQuery struct

+ EndDate time.Time

+ StartDate time.Time

+ Timezone string

+ type RateLimit struct

+ Limit int

+ Remaining int

+ Reset time.Time

+ RetryAfter time.Duration

+ type ShortURL struct

+ Alias string

+ ClaimToken string

+ CreatedAt Timestamp

+ ID string

+ LongURL string

+ OwnerID string

+ ShortURL string

+ Status string

+ type ShortenRequest struct

+ Alias string

+ BlockBots bool

+ Domain string

+ ExpireAfter time.Time

+ LongURL string

+ MaxClicks int

+ Password string

+ PrivateStats bool

+ type StatsQuery struct

+ EndDate time.Time

+ Filters map[string][]string

+ GroupBy []string

+ Metrics []string

+ StartDate time.Time

+ Timezone string

+ type StatsResponse struct

+ Alias string

+ ComputedMetrics map[string]float64

+ GeneratedAt Timestamp

+ Metrics map[string][]map[string]any

+ Summary StatsSummary

+ TimeRange StatsTimeRange

+ URLID string

+ func (r *StatsResponse) Points(dimension, metric string) []MetricPoint

+ type StatsSummary struct

+ AvgRedirectionTime float64

+ FirstClick Timestamp

+ LastClick Timestamp

+ TotalClicks int

+ UniqueClicks int

+ type StatsTimeRange struct

+ EndDate Timestamp

+ StartDate Timestamp

+ type Timestamp struct

+ func (t *Timestamp) UnmarshalJSON(data []byte) error

+ func (t Timestamp) MarshalJSON() ([]byte, error)

+ type TokenPair struct

+ AccessToken string

+ RefreshToken string

+ type TokenSource interface

+ Token func(ctx context.Context) (Credentials, error)

+ Update func(ctx context.Context, creds Credentials) error

+ func StaticAPIKey(key string) TokenSource

+ func StaticTokens(access, refresh string) TokenSource

+ type URLItem struct

+ Alias string

+ BlockBots bool

+ CreatedAt Timestamp

+ Domain string

+ ExpireAfter Timestamp

+ ID string

+ LastClick Timestamp

+ LongURL string

+ MaxClicks *int

+ PasswordSet bool

+ PrivateStats bool

+ Status string

+ TotalClicks int

+ type URLPage struct

+ HasNext bool

+ Items []URLItem

+ Page int

+ PageSize int

+ SortBy string

+ SortOrder string

+ Total int

+ type UpdateURLParams struct

+ Alias string

+ BlockBots Opt[bool]

+ Domain Opt[string]

+ ExpireAfter Opt[time.Time]

+ LongURL string

+ MaxClicks Opt[int]

+ Password Opt[string]

+ PrivateStats Opt[bool]

+ Status string

+ type UpdatedURL struct

+ Alias string

+ BlockBots bool

+ Domain string

+ ExpireAfter Timestamp

+ ID string

+ LongURL string

+ MaxClicks *int

+ PasswordSet bool

+ PrivateStats bool

+ Status string

+ UpdatedAt Timestamp

+ type User struct

+ Email string

+ EmailVerified bool

+ ID string

+ Name string

+ Plan string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL