ranjit

package module

Go to main page

Versions in this module

v0

v0.4.0

Nov 8, 2026

Changes in this version

+ var ErrIdempotency = errors.New("idempotency key was already used with a different request")

+ var ErrInvalidResponse = errors.New("invalid response")

+ var ErrRateLimited = errors.New("rate limited")

+ var ErrResponseTooLarge = errors.New("response exceeds 1 MiB")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrWebhookState = errors.New("webhook is not failed or does not belong to the configured endpoint")

+ func ValidIdempotencyKey(key string) bool

type APIError

+ Cause error

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

+ func (e *APIError) Unwrap() error

+ type CertificateStatus struct

+ DaysRemaining int

+ ExpiresAt *time.Time

+ Level string

+ Profile string

type Client

+ ReadRetries RetryPolicy

+ func (c *Client) ConnectWithKey(ctx context.Context, input ConnectRequest, key string) (ConnectResponse, error)

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

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

+ func (c *Client) IterAccounts(ctx context.Context, connectionID string, limit int) iter.Seq2[Account, error]

+ func (c *Client) IterConnections(ctx context.Context, customer string, limit int) iter.Seq2[Connection, error]

+ func (c *Client) IterSearchTransactions(ctx context.Context, filter TransactionFilter) iter.Seq2[Transaction, error]

+ func (c *Client) IterTransactions(ctx context.Context, accountID string, limit int) iter.Seq2[Transaction, error]

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

+ func (c *Client) RetryWebhook(ctx context.Context, eventID string) error

+ func (c *Client) WebhookDeliveries(ctx context.Context, cursor string, limit int) (Page[WebhookDelivery], error)

+ type Diagnostics struct

+ Certificates []CertificateStatus

+ Operations *OperationsStatus

+ UnavailableProfiles []string

+ Version string

+ type OperationsStatus struct

+ Database string

+ ObservedAt time.Time

+ SyncQueue QueueStatus

+ WebhookQueue QueueStatus

+ Workers map[string]WorkerStatus

+ type QueueStatus struct

+ Counts map[string]int64

+ LastFailedAt *time.Time

+ LastSucceededAt *time.Time

+ OldestDueAt *time.Time

+ RecentFailed int64

+ RecentSucceeded int64

+ type RetryPolicy struct

+ BaseDelay time.Duration

+ MaxAttempts int

+ MaxDelay time.Duration

+ MaxElapsedTime time.Duration

+ type WebhookData struct

+ ConnectionID string

+ CustomerID string

+ ErrorCode string

+ JobID string

+ Status string

+ type WebhookDelivery struct

+ Attempts int

+ ErrorCode string

+ Event WebhookEvent

+ HTTPStatus int

+ NextAttemptAt *time.Time

+ Status string

+ UpdatedAt time.Time

+ type WebhookEvent struct

+ CreatedAt time.Time

+ Data WebhookData

+ ID string

+ Type string

+ func VerifyWebhook(body []byte, signature, secret string, now time.Time) (WebhookEvent, error)

+ type WorkerStatus struct

+ Errors uint64

+ Healthy bool

+ LastFinishedAt *time.Time

+ LastStartedAt *time.Time

+ LastSuccessAt *time.Time

+ State string

+ Steps uint64

v0.3.0

Nov 7, 2026

Changes in this version

type Client

+ func NewClientFromEnv() (*Client, error)

v0.2.0

Nov 7, 2026

Changes in this version

type Client

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

+ func (c *Client) PreviewImport(ctx context.Context, input io.Reader, opts ImportOptions) (ImportPreview, error)

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

+ func (c *Client) SearchTransactions(ctx context.Context, f TransactionFilter) (Page[Transaction], error)

type Connection

+ func (c Connection) HistoryAvailable() bool

type ImportOptions

+ Columns map[string]string

+ Delimiter string

+ type ImportPreview struct

+ From string

+ Result ImportResult

+ Sample []ImportSample

+ Through string

type ImportResult

+ New int

+ Unchanged int

+ Updated int

+ type ImportSample struct

+ Amount Money

+ Description string

+ PostedOn string

+ type TransactionFilter struct

+ AccountID string

+ Cursor string

+ CustomerID string

+ From string

+ Limit int

+ Query string

+ Through string

v0.1.0

Nov 7, 2026

Changes in this version

+ var ErrConflict = errors.New("connection is not active")

+ var ErrConsent = errors.New("authorization link is invalid, expired or already used")

+ var ErrInvalid = errors.New("invalid input")

+ var ErrLease = errors.New("job lease is no longer valid")

+ var ErrNotFound = errors.New("not found")

+ var ErrProviderCredentials = errors.New("provider credentials are invalid, missing required scopes or have changed")

+ var ErrProviderUnavailable = errors.New("provider is unavailable")

+ func NewID(prefix string) string

+ func StableID(prefix, owner, externalID string) string

+ type APIError struct

+ Code string

+ Message string

+ RequestID string

+ StatusCode int

+ func (e *APIError) Error() string

+ type Account struct

+ Balance *Money

+ BalanceAt *time.Time

+ ConnectionID string

+ ID string

+ Name string

+ Type string

+ UpdatedAt time.Time

+ type Client struct

+ HTTPClient *http.Client

+ func NewClient(baseURL, apiKey string) (*Client, error)

+ func (c *Client) Accounts(ctx context.Context, connectionID, cursor string, limit int) (Page[Account], error)

+ func (c *Client) Connect(ctx context.Context, input ConnectRequest) (ConnectResponse, error)

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

+ func (c *Client) Connections(ctx context.Context, customer, cursor string, limit int) (Page[Connection], error)

+ func (c *Client) Import(ctx context.Context, input io.Reader, opts ImportOptions) (ImportResult, error)

+ func (c *Client) Institutions(ctx context.Context) (Page[Institution], error)

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

+ func (c *Client) Revoke(ctx context.Context, connectionID string) error

+ func (c *Client) Status(ctx context.Context, connectionID string) (ConnectionStatus, error)

+ func (c *Client) Sync(ctx context.Context, connectionID string) (Job, error)

+ func (c *Client) Transactions(ctx context.Context, accountID, cursor string, limit int) (Page[Transaction], error)

+ type ConnectRequest struct

+ CustomerID string

+ InstitutionID string

+ type ConnectResponse struct

+ AuthorizationExpiresAt time.Time

+ AuthorizationURL string

+ Connection Connection

+ type Connection struct

+ AuthorizationMode string

+ ConsentExpiresAt time.Time

+ CreatedAt time.Time

+ CredentialID string

+ CustomerID string

+ ID string

+ InstitutionID string

+ LastSyncedAt *time.Time

+ Provider string

+ Status string

+ type ConnectionStatus struct

+ Accounts int

+ Connection Connection

+ DataFrom string

+ DataThrough string

+ LatestJob *Job

+ Transactions int

+ type ImportOptions struct

+ Account string

+ CustomerID string

+ DateFormat string

+ Decimal string

+ Format string

+ type ImportResult struct

+ Accounts int

+ ConnectionID string

+ Deduplication string

+ Duplicate bool

+ Transactions int

+ type Institution struct

+ ConnectionMode string

+ DataCoverage []string

+ ID string

+ Name string

+ Profile string

+ Provider string

+ Sandbox bool

+ Validation string

+ type Job struct

+ Attempts int

+ ConnectionID string

+ CreatedAt time.Time

+ ErrorCode string

+ ID string

+ LeaseToken string

+ RequestsCompleted int

+ Status string

+ UpdatedAt time.Time

+ type Money struct

+ AmountMinor int64

+ Currency string

+ func (m Money) Validate() error

+ type Page struct

+ Data []T

+ NextCursor string

+ type Transaction struct

+ AccountID string

+ Amount Money

+ Description string

+ ID string

+ PostedOn string

+ Status string

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