abraflexi

package
v0.11.751 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 9, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(c Config) (*Client, error)

func (*Client) GetIngestrURI

func (c *Client) GetIngestrURI() (string, error)

type Config

type Config struct {
	// Host is the Flexi account host, e.g. example.flexibee.eu. Required.
	Host string
	// Path is an optional URL path prefix in front of the REST API, used by
	// self-hosted installs mounted under a sub-path (e.g. /flexi). Cloud Flexi
	// leaves it empty.
	Path string
	// Username is the Flexi API user. Required.
	Username string
	// Password is that user's password. Required.
	Password string
	// Company is the company database code as it appears in the REST path, e.g.
	// acme_s_r_o_. It selects which set of books to read and is never defaulted.
	// Required.
	Company string
	// Scheme is the transport used to reach the account, https or http. Optional,
	// defaults to https (http is only accepted by ingestr for loopback hosts).
	Scheme string
	// PageSize is the number of rows per request. Optional, defaults to 1000.
	PageSize *int
	// RateLimit is the number of requests per second. Optional, defaults to 4.
	RateLimit *float64
	// IncludeExpensive controls whether properties Flexi flags as expensive to
	// compute are included. Optional, defaults to true.
	IncludeExpensive *bool
}

Config holds the settings required to connect to an ABRA Flexi (Flexibee) account through its REST API.

func (*Config) GetIngestrURI

func (c *Config) GetIngestrURI() (string, error)

GetIngestrURI builds the ingestr source URI for ABRA Flexi. Format: abra://<host>?username=<user>&password=<password>&company=<company>[&scheme=&page_size=&rate_limit=&include_expensive=]

Jump to

Keyboard shortcuts

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