rest

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

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

type Branch struct {
	ID   string `json:"@id"`
	Type string `json:"@type"`
	Name string `json:"name"`
	Head string `json:"head"`
}

type BranchApplyOptions struct {
	Message         string          `json:"-" default:"Default commit message"`
	Author          string          `json:"-" default:"defaultAuthor"`
	Keep            map[string]bool `json:"keep" default:"{\"@id\": true, \"@type\": true}"` // Fields to keep after apply
	MatchFinalState bool            `json:"match_final_state" default:"true"`
	Type            string          `json:"type,omitempty" default:"squash"`
}

type BranchCommitLogOptions struct {
	Count int `url:"count" default:"-1"`
	Start int `url:"start" default:"0"`
}

type BranchCreateOptions struct {
	// Origin is the thing we wish to create a branch out of. it can be any kind of branch descriptor or commit descriptor.
	Origin   string  `json:"origin,omitempty"`
	Schema   bool    `json:"schema,omitempty"`
	Prefixes *Prefix `json:"prefixes,omitempty"`
}

type BranchIntroducer BaseIntroducer

type BranchPath struct {
	Organization, Database, Repo, Branch string
}

type BranchPushOptions struct {
	PushPrefixes bool `json:"push_prefixes" default:"true"`
}

type BranchRebaseOptions struct {
	Author string `json:"author" default:"Default author"`
}

type BranchRequester BaseRequester

type BranchSchemaFrameOptions struct {
	CompressIDs    bool `url:"compress_ids" default:"true"`
	ExpandAbstract bool `url:"expand_abstract" default:"true"`
}

type BranchSquashOptions struct {
	Author  string `json:"author" default:"defaultAuthor"`
	Message string `json:"message" default:"Default commit message"`
}

type Client struct {
	C *sling.Sling
	// contains filtered or unexported fields
}

type ClientWOQLOptions struct {
	CommitAuthor  string
	CommitMessage string
	AllWitnesses  bool
}

type Commit struct {
	ID         string  `json:"@id"`
	Type       string  `json:"@type"`
	Author     string  `json:"author"`
	Identifier string  `json:"identifier"`
	Instance   string  `json:"instance"`
	Message    string  `json:"message"`
	Parent     string  `json:"parent"`
	Schema     string  `json:"schema"`
	Timestamp  float64 `json:"timestamp"`
}

type CommitPath struct {
	Organization, Database, Repo, Branch, Commit string
}

type ComponentVersion struct {
	Version string `json:"version"`
	GitHash string `json:"git_hash,omitempty"`
}

type Database struct {
	ID           string    `json:"@id"`
	Type         string    `json:"@type"`
	Name         string    `json:"name"`
	Comment      string    `json:"comment"`
	CreationDate time.Time `json:"creation_date"`
	Label        string    `json:"label"`
	State        string    `json:"state"`
	Path         string    `json:"path"`
	Branches     []string  `json:"branches"`
}

type DatabaseCloneOptions struct {
	Public    bool   `json:"public"`
	RemoteURL string `json:"remote_url" default:"http://example.com/user/test_db"`
	Comment   string `json:"comment" default:"Default comment"`
}

type DatabaseCommitLogOptions struct {
	Count int `url:"count" default:"-1"`
	Start int `url:"start,omitempty" default:"0"`
}

type DatabaseCreateOptions struct {
	Schema   bool    `json:"schema" default:"true"`
	Public   bool    `json:"public,omitempty"`
	Comment  string  `json:"comment,omitempty"`
	Prefixes *Prefix `json:"prefixes,omitempty"`
}

type DatabaseDeleteOptions struct {
	Force bool `url:"force,omitempty"`
}

type DatabaseIntroducer struct {
	BaseIntroducer
	// contains filtered or unexported fields
}

type DatabasePackOptions struct {
	RepositoryHead string `json:"repository_head,omitempty"`
}

type DatabasePath struct {
	Organization, Database string
}

type DatabaseRequester struct {
	BaseRequester
	// contains filtered or unexported fields
}

type DatabaseSchemaFrameOptions struct {
	CompressIDs    bool `url:"compress_ids" default:"true"`
	ExpandAbstract bool `url:"expand_abstract" default:"true"`
}

type DatabaseUpdateOptions struct {
	Schema   bool    `json:"schema,omitempty"`
	Public   bool    `json:"public,omitempty"`
	Label    string  `json:"label,omitempty"`
	Comment  string  `json:"comment,omitempty"`
	Prefixes *Prefix `json:"prefixes,omitempty"`
}

type DatabaseWOQLOptions struct {
	CommitAuthor  string
	CommitMessage string
	AllWitnesses  bool
}

type Diff map[string]any

type DiffOp string

type DiffOptions struct {
	DiffShortOptions
	Before            any    `json:"before,omitempty"`
	After             any    `json:"after,omitempty"`
	BeforeDataVersion string `json:"before_data_version,omitempty"`
	AfterDataVersion  string `json:"after_data_version,omitempty"`
	DocumentID        string `json:"document_id,omitempty"`
}

type DiffRequester BaseRequester

type DiffShortOptions struct {
	Keep      map[string]bool `json:"keep,omitempty"`
	CopyValue bool            `json:"copy_value,omitempty"`
}

type DocumentCreateOptions struct {
	GraphType   GraphTypes `url:"graph_type" default:"instance"`
	Message     string     `url:"message" default:"Default message"`
	Author      string     `url:"author" default:"Default author"`
	RawJSON     bool       `url:"raw_json,omitempty"`
	FullReplace bool       `url:"full_replace,omitempty"`
}

type DocumentDeleteOptions struct {
	GraphType GraphTypes `url:"graph_type" default:"instance"`
	Message   string     `url:"message" default:"Default message"`
	Author    string     `url:"author" default:"Default author"`
	Nuke      bool       `url:"nuke,omitempty"`
	ID        string     `url:"id,omitempty"`
}

type DocumentGetOptions struct {
	CompressIDs bool       `url:"compress_ids" default:"true"`
	Type        string     `url:"type,omitempty"`
	Unfold      bool       `url:"unfold" default:"true"`
	GraphType   GraphTypes `url:"graph_type" default:"instance"`
	Prefixed    bool       `url:"prefixed" default:"true"`
}

type DocumentIntroducer[DocumentT any] BaseIntroducer

type DocumentIsExistsOptions struct {
	GraphType GraphTypes `url:"graph_type" default:"instance"`
}

type DocumentListOptions struct {
	CompressIDs bool       `url:"compress_ids" default:"true"`
	Type        string     `url:"type,omitempty"`
	Unfold      bool       `url:"unfold" default:"true"`
	Count       int        `url:"count,omitempty"`
	Skip        int        `url:"skip" default:"0"`
	GraphType   GraphTypes `url:"graph_type" default:"instance"`
	Prefixed    bool       `url:"prefixed" default:"true"`
}

type DocumentRequester[DocumentT any] struct {
	BaseRequester
	// contains filtered or unexported fields
}

type DocumentUpdateOptions struct {
	GraphType GraphTypes `url:"graph_type" default:"instance"`
	Message   string     `url:"message" default:"Default message"`
	Author    string     `url:"author" default:"Default author"`
	RawJSON   bool       `url:"raw_json,omitempty"`
	Create    bool       `url:"create,omitempty"`
}

type FilesIntroducer struct {
	BaseIntroducer
	// contains filtered or unexported fields
}

type GenericDocument map[string]any

type GraphTypes string

type Organization struct {
	ID          string   `json:"@id"`
	Type        string   `json:"@type"`
	Name        string   `json:"name"`
	DatabaseIDs []string `json:"database"`
}

type OrganizationPath struct {
	Organization string
}

type OrganizationRequester BaseRequester

type Prefix struct {
	Base   string `json:"@base"`
	Schema string `json:"@schema"`
	Type   string `json:"@type"`
}

type Remote struct {
	Name     string `json:"remote_name"`
	Location string `json:"remote_location"`
}

type RemoteIntroducer BaseIntroducer

type RemoteRequester BaseRequester

type RepoIntroducer BaseIntroducer

type RepoPath struct {
	Organization, Database, Repo string
}

type RepoRequester struct {
	BaseRequester
}

type RepoSchemaFrameOptions struct {
	CompressIDs    bool `url:"compress_ids" default:"true"`
	ExpandAbstract bool `url:"expand_abstract" default:"true"`
}

type Role struct {
	ID     string       `json:"@id"`
	Type   string       `json:"@type"`
	Name   string       `json:"name"`
	Action []RoleAction `json:"action"`
}

type RoleAction string

type RoleCreateOptions struct {
	Action []RoleAction `json:"action"`
}

type RoleRequester BaseRequester

type RoleUpdateOptions struct {
	Action []RoleAction `json:"action"`
}

type TerminusObject any

type TerminusObjectPath interface {
	fmt.Stringer
	GetURL(action string) string
}

type TerminusResponse interface {
	fmt.Stringer
	IsOK() bool
}

type TerminusVersionInfo struct {
	Authority       string           `json:"authority"`
	Storage         ComponentVersion `json:"storage"`
	TerminusDB      ComponentVersion `json:"terminusdb"`
	TerminusDBStore ComponentVersion `json:"terminusdb_store"`
}

type TripleDumpOptions struct {
	GraphType GraphTypes `url:"-" default:"instance"`
	Format    string     `url:"format" default:"turtle"`
}

type TripleInsertOptions struct {
	GraphType GraphTypes `json:"-" default:"instance"`
	Author    string     `json:"author" default:"defaultAuthor"`
	Message   string     `json:"message" default:"Default commit message"`
}

type TripleIntroducer BaseIntroducer

type TripleRequester BaseRequester

type TripleUpdateOptions struct {
	GraphType GraphTypes `json:"-" default:"instance"`
	Author    string     `json:"author" default:"defaultAuthor"`
	Message   string     `json:"message" default:"Default commit message"`
}

type User struct {
	ID           string                                     `json:"@id"`
	Type         string                                     `json:"@type"`
	Name         string                                     `json:"name"`
	Capabilities []srverror.Union[UserCapability, []string] `json:"capability"`
}

type UserCapabilitiesOperation string

type UserCapability struct {
	ID    string         `json:"@id"`
	Type  string         `json:"@type"`
	Role  []Role         `json:"role"`
	Scope TerminusObject `json:"scope"`
}

type UserGetOptions struct {
	Capability bool `url:"capability" default:"false"` // True to expand `capability` into "Capability" schema item list, False to get them as string list
}

type UserIntroducer BaseIntroducer

type UserListAllOptions struct {
	Capability bool `url:"capability" default:"false"` // True to expand `capability` into "Capability" schema item list, False to get them as string list
}

type UserPath struct {
	Organization, User string
}

type UserRequester BaseRequester

type UserUpdateCapabilitiesOptions struct {
	Scope     TerminusObject
	Roles     []Role
	Operation UserCapabilitiesOperation `default:"revoke"`
}