b24gosdk

package module

Go to main page

Versions in this module

v0

v0.2.0

Aug 7, 2026

Changes in this version

+ var ErrV3AccessDenied = Code(CodeV3AccessDenied)

+ var ErrV3BatchUnsupported = errors.New(...)

+ var ErrV3EntityNotFound = Code(CodeV3EntityNotFound)

+ var ErrV3Validation = Code(CodeV3Validation)

+ var ErrV3WalkUnsupported = errors.New(...)

type APIError

+ Validation []ValidationError

type BatchResult

+ func (r *BatchResult) IDs() ([]ID, error)

type CallOption

+ func WithTimeout(d time.Duration) CallOption

type ErrorCode

+ const CodeV3AccessDenied

+ const CodeV3EntityNotFound

+ const CodeV3InvalidFilter

+ const CodeV3InvalidJSON

+ const CodeV3InvalidSelect

+ const CodeV3MethodNotFound

+ const CodeV3UnknownDTOProperty

+ const CodeV3Validation

+ type Kind uint8

+ const KindArray

+ const KindBool

+ const KindInvalid

+ const KindNull

+ const KindNumber

+ const KindObject

+ const KindString

+ func (k Kind) String() string

type PageOption

+ func WithCallOptions(opts ...CallOption) PageOption

+ func WithDescending() PageOption

type Pager

+ func (p *Pager) Take(ctx context.Context, n int) ([]json.RawMessage, error)

+ type Params = map[string]any

+ type Result []byte

+ func (r Result) Kind() Kind

+ type ValidationError struct

+ Field string

+ Message string

v0.1.0

Aug 6, 2026

Changes in this version

+ const DefaultPageSize

+ const MaxBatchCommands

+ var ErrAccessDenied = Code(CodeAccessDenied)

+ var ErrBadRef = errors.New("b24gosdk: bad $result reference")

+ var ErrBatchLengthExceeded = errors.New("b24gosdk: batch is longer than the server accepts")

+ var ErrCursorStalled = errors.New("b24gosdk: the cursor did not move")

+ var ErrExpiredToken = Code(CodeExpiredToken)

+ var ErrInsufficientScope = Code(CodeInsufficientScope)

+ var ErrInvalidGrant = Code(CodeInvalidGrant)

+ var ErrInvalidToken = Code(CodeInvalidToken)

+ var ErrMethodNotFound = Code(CodeMethodNotFound)

+ var ErrNoRows = errors.New("b24gosdk: no row array in result")

+ var ErrOperationTimeLimit = Code(CodeOperationTimeLimit)

+ var ErrPaymentRequired = Code(CodePaymentRequired)

+ var ErrQueryLimitExceeded = Code(CodeQueryLimitExceeded)

+ func Code(c ErrorCode) error

+ func IsEmpty(raw json.RawMessage) bool

+ func Keys(raw json.RawMessage) ([]string, bool)

+ func MultifieldAdd(value, valueType string) map[string]any

+ func MultifieldDelete(id ID) map[string]any

+ func MultifieldSet(id ID, value string) map[string]any

+ func Ref(id CmdID, path ...string) (string, error)

+ func Unwrap(raw json.RawMessage, path ...string) (json.RawMessage, bool)

+ func UnwrapFold(raw json.RawMessage, path ...string) (json.RawMessage, bool)

+ type APIError struct

+ Code string

+ Description string

+ HTTPStatus int

+ RawBody string

+ func (e *APIError) Error() string

+ func (e *APIError) Is(target error) bool

+ type AppAuth struct

+ AccessToken string

+ ApplicationToken string

+ ClientEndpoint string

+ Domain string

+ Expires string

+ ExpiresIn string

+ MemberID string

+ RefreshToken string

+ Scope string

+ ServerEndpoint string

+ Status string

+ UserID string

+ func (a *AppAuth) VerifyApplicationToken(saved string) bool

+ type AppRequest struct

+ AppSID string

+ ApplicationScope string

+ ApplicationToken string

+ AuthExpires string

+ AuthID string

+ Domain string

+ Lang string

+ MemberID string

+ Placement string

+ PlacementOptions string

+ Protocol string

+ RefreshID string

+ ServerEndpoint string

+ Status string

+ func ParseAppRequest(r *http.Request) (*AppRequest, error)

+ func ParseAppRequestForm(values url.Values) (*AppRequest, error)

+ func (r *AppRequest) ClientEndpoint() string

+ type Batch struct

+ Halt bool

+ func NewBatch() *Batch

+ func (b *Batch) Add(method string, params any) (CmdID, error)

+ func (b *Batch) AddAs(id CmdID, method string, params any) error

+ func (b *Batch) Chunks() []*Batch

+ func (b *Batch) Cmds() []Cmd

+ func (b *Batch) Len() int

+ type BatchError struct

+ Failed map[CmdID]*APIError

+ Result *BatchResult

+ func (e *BatchError) Error() string

+ func (e *BatchError) Unwrap() []error

+ type BatchResult struct

+ Errors map[CmdID]*APIError

+ Next map[CmdID]int

+ Order []CmdID

+ Results map[CmdID]json.RawMessage

+ Total map[CmdID]int

+ func (r *BatchResult) Executed(id CmdID) bool

+ func (r *BatchResult) Get(id CmdID) (json.RawMessage, error)

+ type CallOption func(*callConfig)

+ func WithIdempotent() CallOption

+ type CallResult struct

+ Next *int

+ Result json.RawMessage

+ Time json.RawMessage

+ Total *int

+ type Client struct

+ func NewClient(webhookURL string, opts ...Option) *Client

+ func NewClientFromAppRequest(req *AppRequest, opts ...Option) (*Client, error)

+ func NewOAuthClient(clientEndpoint, accessToken string, opts ...Option) *Client

+ func (c *Client) Core() *Core

+ func (c *Client) SetAccessToken(token string)

+ type Cmd struct

+ ID CmdID

+ Method string

+ Params any

+ type CmdID string

+ type Core struct

+ func (c *Core) AccessToken() string

+ func (c *Core) BaseURL() string

+ func (c *Core) Call(ctx context.Context, method string, params any, opts ...CallOption) (*CallResult, error)

+ func (c *Core) CallBatch(ctx context.Context, b *Batch) (*BatchResult, error)

+ func (c *Core) CallBatchChunked(ctx context.Context, b *Batch) (*BatchResult, error)

+ func (c *Core) CallJSON(ctx context.Context, method string, params any, opts ...CallOption) (json.RawMessage, error)

+ func (c *Core) CallMultipart(ctx context.Context, method string, params map[string]string, ...) (json.RawMessage, error)

+ func (c *Core) Pages(method string, params any, opts ...PageOption) (*Pager, error)

+ func (c *Core) Scan(method string, params any, opts ...PageOption) (*Pager, error)

+ func (c *Core) SetAccessToken(token string)

+ type ErrorCode string

+ const CodeAccessDenied

+ const CodeBatchLengthExceeded

+ const CodeBatchMethodNotAllow

+ const CodeExpiredToken

+ const CodeInsufficientScope

+ const CodeInvalidGrant

+ const CodeInvalidToken

+ const CodeMethodNotFound

+ const CodeNoAuthFound

+ const CodeOperationTimeLimit

+ const CodeOverloadLimit

+ const CodePaymentRequired

+ const CodeQueryLimitExceeded

+ func CodeOf(err error) (ErrorCode, bool)

+ func (c ErrorCode) Normalize() ErrorCode

+ type ID int64

+ func (id *ID) UnmarshalJSON(b []byte) error

+ func (id ID) Int64() int64

+ func (id ID) IsZero() bool

+ func (id ID) MarshalJSON() ([]byte, error)

+ func (id ID) String() string

+ type OnAppInstallData struct

+ Active string

+ Installed string

+ LanguageID string

+ Version string

+ type OnAppInstallEvent struct

+ Auth AppAuth

+ Data OnAppInstallData

+ Event string

+ EventHandlerID string

+ TS string

+ func ParseOnAppInstall(payload []byte) (*OnAppInstallEvent, error)

+ func ParseOnAppInstallForm(values url.Values) (*OnAppInstallEvent, error)

+ func ParseOnAppInstallRequest(r *http.Request) (*OnAppInstallEvent, error)

+ type OnAppUninstallData struct

+ Clean int

+ LanguageID string

+ type OnAppUninstallEvent struct

+ Auth AppAuth

+ Data OnAppUninstallData

+ Event string

+ TS string

+ func ParseOnAppUninstall(payload []byte) (*OnAppUninstallEvent, error)

+ func ParseOnAppUninstallForm(values url.Values) (*OnAppUninstallEvent, error)

+ func ParseOnAppUninstallRequest(r *http.Request) (*OnAppUninstallEvent, error)

+ type Option func(*coreOptions)

+ func WithAccessToken(token string) Option

+ func WithHTTPClient(client *http.Client) Option

+ func WithRetry(cfg RetryConfig) Option

+ func WithTokenRefresher(refresh TokenRefresher) Option

+ type PageOption func(*Pager)

+ func WithCursorParam(name string) PageOption

+ func WithIDField(request, response string) PageOption

+ func WithPageSize(n int) PageOption

+ func WithRowPath(path ...string) PageOption

+ type Pager struct

+ func (p *Pager) Count() int

+ func (p *Pager) Err() error

+ func (p *Pager) Next(ctx context.Context) bool

+ func (p *Pager) Page() *CallResult

+ func (p *Pager) Rows() []json.RawMessage

+ type RetryConfig struct

+ BaseDelay time.Duration

+ MaxAttempts int

+ MaxDelay time.Duration

+ type TokenRefresher func(ctx context.Context) (accessToken string, err error)

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