client

package

Go to main page

Versions in this module

v0

v0.0.11

May 8, 2024

Changes in this version

type DocumentUploadOptions

+ StoragePath *int64

v0.0.10

Feb 18, 2024

Changes in this version

type Flags

+ MaxConcurrentRequests int

type Options

+ MaxConcurrentRequests int

v0.0.9

Jan 19, 2024

Changes in this version

type Flags

+ AuthGCPServiceAccountKeyFile string

+ AuthOIDCIDTokenAudience string

+ type GCPServiceAccountKeyAuth struct

+ Audience string

+ HTTPClient *http.Client

+ Key []byte

+ KeyFile string

+ func (a GCPServiceAccountKeyAuth) Build() (AuthMechanism, error)

v0.0.8

Jan 5, 2024

v0.0.7

Dec 31, 2023

v0.0.6

Dec 19, 2023

Changes in this version

type Client

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

+ func (c *Client) GetGroup(ctx context.Context, id int64) (*Group, *Response, error)

+ func (c *Client) GetUser(ctx context.Context, id int64) (*User, *Response, error)

+ func (c *Client) ListAllGroups(ctx context.Context, opts ListGroupsOptions, ...) error

+ func (c *Client) ListAllUsers(ctx context.Context, opts ListUsersOptions, ...) error

+ func (c *Client) ListGroups(ctx context.Context, opts ListGroupsOptions) ([]Group, *Response, error)

+ func (c *Client) ListUsers(ctx context.Context, opts ListUsersOptions) ([]User, *Response, error)

+ func (c *Client) PatchDocument(ctx context.Context, id int64, data *DocumentFields) (*Document, *Response, error)

type Correspondent

+ Owner *int64

type CorrespondentFields

+ func (f *CorrespondentFields) SetIsInsensitive(isInsensitive bool) *CorrespondentFields

+ func (f *CorrespondentFields) SetMatch(match string) *CorrespondentFields

+ func (f *CorrespondentFields) SetMatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *CorrespondentFields

+ func (f *CorrespondentFields) SetName(name string) *CorrespondentFields

+ func (f *CorrespondentFields) SetOwner(owner *int64) *CorrespondentFields

+ func (f *CorrespondentFields) SetSetPermissions(setPermissions *ObjectPermissions) *CorrespondentFields

+ func (f CorrespondentFields) AsMap() map[string]any

type CustomField

+ Owner *int64

type CustomFieldFields

+ func (f *CustomFieldFields) SetDataType(dataType string) *CustomFieldFields

+ func (f *CustomFieldFields) SetName(name string) *CustomFieldFields

+ func (f *CustomFieldFields) SetOwner(owner *int64) *CustomFieldFields

+ func (f *CustomFieldFields) SetSetPermissions(setPermissions *ObjectPermissions) *CustomFieldFields

+ func (f CustomFieldFields) AsMap() map[string]any

type Document

+ Owner *int64

+ type DocumentFields struct

+ func NewDocumentFields() *DocumentFields

+ func (f *DocumentFields) SetArchiveSerialNumber(archiveSerialNumber *int64) *DocumentFields

+ func (f *DocumentFields) SetContent(content string) *DocumentFields

+ func (f *DocumentFields) SetCorrespondent(correspondent *int64) *DocumentFields

+ func (f *DocumentFields) SetCreated(created time.Time) *DocumentFields

+ func (f *DocumentFields) SetCustomFields(customFields []CustomFieldInstance) *DocumentFields

+ func (f *DocumentFields) SetDocumentType(documentType *int64) *DocumentFields

+ func (f *DocumentFields) SetOwner(owner *int64) *DocumentFields

+ func (f *DocumentFields) SetSetPermissions(setPermissions *ObjectPermissions) *DocumentFields

+ func (f *DocumentFields) SetStoragePath(storagePath *int64) *DocumentFields

+ func (f *DocumentFields) SetTags(tags []int64) *DocumentFields

+ func (f *DocumentFields) SetTitle(title string) *DocumentFields

+ func (f DocumentFields) AsMap() map[string]any

+ func (f DocumentFields) MarshalJSON() ([]byte, error)

type DocumentType

+ Owner *int64

type DocumentTypeFields

+ func (f *DocumentTypeFields) SetIsInsensitive(isInsensitive bool) *DocumentTypeFields

+ func (f *DocumentTypeFields) SetMatch(match string) *DocumentTypeFields

+ func (f *DocumentTypeFields) SetMatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *DocumentTypeFields

+ func (f *DocumentTypeFields) SetName(name string) *DocumentTypeFields

+ func (f *DocumentTypeFields) SetOwner(owner *int64) *DocumentTypeFields

+ func (f *DocumentTypeFields) SetSetPermissions(setPermissions *ObjectPermissions) *DocumentTypeFields

+ func (f DocumentTypeFields) AsMap() map[string]any

+ type Group struct

+ ID int64

+ Name string

+ type GroupFields struct

+ func NewGroupFields() *GroupFields

+ func (f *GroupFields) SetName(name string) *GroupFields

+ func (f GroupFields) AsMap() map[string]any

+ func (f GroupFields) MarshalJSON() ([]byte, error)

+ type ListGroupsOptions struct

+ Name CharFilterSpec

+ Ordering OrderingSpec

+ type ListUsersOptions struct

+ Ordering OrderingSpec

+ Username CharFilterSpec

type MatchingAlgorithm

+ const MatchNone

+ type ObjectPermissionPrincipals struct

+ Groups []int64

+ Users []int64

+ type ObjectPermissions struct

+ Change ObjectPermissionPrincipals

+ View ObjectPermissionPrincipals

type StoragePath

+ Owner *int64

type StoragePathFields

+ func (f *StoragePathFields) SetIsInsensitive(isInsensitive bool) *StoragePathFields

+ func (f *StoragePathFields) SetMatch(match string) *StoragePathFields

+ func (f *StoragePathFields) SetMatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *StoragePathFields

+ func (f *StoragePathFields) SetName(name string) *StoragePathFields

+ func (f *StoragePathFields) SetOwner(owner *int64) *StoragePathFields

+ func (f *StoragePathFields) SetSetPermissions(setPermissions *ObjectPermissions) *StoragePathFields

+ func (f StoragePathFields) AsMap() map[string]any

type Tag

+ Owner *int64

type TagFields

+ func (f *TagFields) SetColor(color Color) *TagFields

+ func (f *TagFields) SetIsInboxTag(isInboxTag bool) *TagFields

+ func (f *TagFields) SetIsInsensitive(isInsensitive bool) *TagFields

+ func (f *TagFields) SetMatch(match string) *TagFields

+ func (f *TagFields) SetMatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *TagFields

+ func (f *TagFields) SetName(name string) *TagFields

+ func (f *TagFields) SetOwner(owner *int64) *TagFields

+ func (f *TagFields) SetSetPermissions(setPermissions *ObjectPermissions) *TagFields

+ func (f *TagFields) SetTextColor(textColor Color) *TagFields

+ func (f TagFields) AsMap() map[string]any

+ type User struct

+ Email string

+ FirstName string

+ ID int64

+ IsActive bool

+ IsStaff bool

+ IsSuperuser bool

+ LastName string

+ Username string

+ type UserFields struct

+ func NewUserFields() *UserFields

+ func (f *UserFields) SetEmail(email string) *UserFields

+ func (f *UserFields) SetFirstName(firstName string) *UserFields

+ func (f *UserFields) SetIsActive(isActive bool) *UserFields

+ func (f *UserFields) SetIsStaff(isStaff bool) *UserFields

+ func (f *UserFields) SetIsSuperuser(isSuperuser bool) *UserFields

+ func (f *UserFields) SetLastName(lastName string) *UserFields

+ func (f *UserFields) SetUsername(username string) *UserFields

+ func (f UserFields) AsMap() map[string]any

+ func (f UserFields) MarshalJSON() ([]byte, error)

v0.0.5

Dec 17, 2023

Changes in this version

type Client

+ func (c *Client) CreateCustomField(ctx context.Context, data *CustomFieldFields) (*CustomField, *Response, error)

+ func (c *Client) DeleteCustomField(ctx context.Context, id int64) (*Response, error)

+ func (c *Client) GetCustomField(ctx context.Context, id int64) (*CustomField, *Response, error)

+ func (c *Client) ListAllCustomFields(ctx context.Context, opts ListCustomFieldsOptions, ...) error

+ func (c *Client) ListCustomFields(ctx context.Context, opts ListCustomFieldsOptions) ([]CustomField, *Response, error)

+ func (c *Client) PatchCorrespondent(ctx context.Context, id int64, data *CorrespondentFields) (*Correspondent, *Response, error)

+ func (c *Client) PatchCustomField(ctx context.Context, id int64, data *CustomFieldFields) (*CustomField, *Response, error)

+ func (c *Client) PatchDocumentType(ctx context.Context, id int64, data *DocumentTypeFields) (*DocumentType, *Response, error)

+ func (c *Client) PatchStoragePath(ctx context.Context, id int64, data *StoragePathFields) (*StoragePath, *Response, error)

+ func (c *Client) PatchTag(ctx context.Context, id int64, data *TagFields) (*Tag, *Response, error)

+ func (c *Client) UpdateCustomField(ctx context.Context, id int64, data *CustomField) (*CustomField, *Response, error)

+ type CorrespondentFields struct

+ func NewCorrespondentFields() *CorrespondentFields

+ func (f *CorrespondentFields) IsInsensitive(isInsensitive bool) *CorrespondentFields

+ func (f *CorrespondentFields) Match(match string) *CorrespondentFields

+ func (f *CorrespondentFields) MatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *CorrespondentFields

+ func (f *CorrespondentFields) Name(name string) *CorrespondentFields

+ func (f CorrespondentFields) MarshalJSON() ([]byte, error)

+ type CustomField struct

+ DataType string

+ ID int64

+ Name string

+ type CustomFieldFields struct

+ func NewCustomFieldFields() *CustomFieldFields

+ func (f *CustomFieldFields) DataType(dataType string) *CustomFieldFields

+ func (f *CustomFieldFields) Name(name string) *CustomFieldFields

+ func (f CustomFieldFields) MarshalJSON() ([]byte, error)

+ type CustomFieldInstance struct

+ Field int64

+ Value any

type Document

+ CustomFields []CustomFieldInstance

+ type DocumentTypeFields struct

+ func NewDocumentTypeFields() *DocumentTypeFields

+ func (f *DocumentTypeFields) IsInsensitive(isInsensitive bool) *DocumentTypeFields

+ func (f *DocumentTypeFields) Match(match string) *DocumentTypeFields

+ func (f *DocumentTypeFields) MatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *DocumentTypeFields

+ func (f *DocumentTypeFields) Name(name string) *DocumentTypeFields

+ func (f DocumentTypeFields) MarshalJSON() ([]byte, error)

type ListCorrespondentsOptions

+ Owner IntFilterSpec

+ type ListCustomFieldsOptions struct

type ListDocumentTypesOptions

+ Owner IntFilterSpec

type ListDocumentsOptions

+ Owner IntFilterSpec

type ListStoragePathsOptions

+ Owner IntFilterSpec

type ListTagsOptions

+ Owner IntFilterSpec

+ type StoragePathFields struct

+ func NewStoragePathFields() *StoragePathFields

+ func (f *StoragePathFields) IsInsensitive(isInsensitive bool) *StoragePathFields

+ func (f *StoragePathFields) Match(match string) *StoragePathFields

+ func (f *StoragePathFields) MatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *StoragePathFields

+ func (f *StoragePathFields) Name(name string) *StoragePathFields

+ func (f StoragePathFields) MarshalJSON() ([]byte, error)

+ type TagFields struct

+ func NewTagFields() *TagFields

+ func (f *TagFields) Color(color Color) *TagFields

+ func (f *TagFields) IsInboxTag(isInboxTag bool) *TagFields

+ func (f *TagFields) IsInsensitive(isInsensitive bool) *TagFields

+ func (f *TagFields) Match(match string) *TagFields

+ func (f *TagFields) MatchingAlgorithm(matchingAlgorithm MatchingAlgorithm) *TagFields

+ func (f *TagFields) Name(name string) *TagFields

+ func (f *TagFields) TextColor(textColor Color) *TagFields

+ func (f TagFields) MarshalJSON() ([]byte, error)

v0.0.4

Jul 6, 2023

v0.0.3

Jul 2, 2023

Changes in this version

type Client

+ func (c *Client) ListAllCorrespondents(ctx context.Context, opts *ListCorrespondentsOptions, ...) error

+ func (c *Client) ListAllDocumentTypes(ctx context.Context, opts *ListDocumentTypesOptions, ...) error

+ func (c *Client) ListAllDocuments(ctx context.Context, opts *ListDocumentsOptions, ...) error

+ func (c *Client) ListAllStoragePaths(ctx context.Context, opts *ListStoragePathsOptions, ...) error

+ func (c *Client) ListAllTags(ctx context.Context, opts *ListTagsOptions, ...) error

v0.0.2

May 14, 2023

v0.0.1

May 14, 2023

Changes in this version

+ func Bool(v bool) *bool

+ func DefaultWaitForTaskCondition(task *Task) error

+ func Int(v int) *int

+ func Int64(v int64) *int64

+ func String(v string) *string

+ func Time(v time.Time) *time.Time

+ type AuthMechanism interface

+ type CharFilterSpec struct

+ ContainsIgnoringCase *string

+ EndsWithIgnoringCase *string

+ EqualsIgnoringCase *string

+ StartsWithIgnoringCase *string

+ func (s CharFilterSpec) EncodeValues(key string, v *url.Values) error

+ type Client struct

+ func New(opts Options) *Client

+ func (c *Client) CreateCorrespondent(ctx context.Context, data *Correspondent) (*Correspondent, *Response, error)

+ func (c *Client) CreateDocumentType(ctx context.Context, data *DocumentType) (*DocumentType, *Response, error)

+ func (c *Client) CreateStoragePath(ctx context.Context, data *StoragePath) (*StoragePath, *Response, error)

+ func (c *Client) CreateTag(ctx context.Context, data *Tag) (*Tag, *Response, error)

+ func (c *Client) DeleteCorrespondent(ctx context.Context, id int64) (*Response, error)

+ func (c *Client) DeleteDocument(ctx context.Context, id int64) (*Response, error)

+ func (c *Client) DeleteDocumentType(ctx context.Context, id int64) (*Response, error)

+ func (c *Client) DeleteStoragePath(ctx context.Context, id int64) (*Response, error)

+ func (c *Client) DeleteTag(ctx context.Context, id int64) (*Response, error)

+ func (c *Client) DownloadDocumentArchived(ctx context.Context, w io.Writer, id int64) (*DownloadResult, *Response, error)

+ func (c *Client) DownloadDocumentOriginal(ctx context.Context, w io.Writer, id int64) (*DownloadResult, *Response, error)

+ func (c *Client) DownloadDocumentThumbnail(ctx context.Context, w io.Writer, id int64) (*DownloadResult, *Response, error)

+ func (c *Client) GetCorrespondent(ctx context.Context, id int64) (*Correspondent, *Response, error)

+ func (c *Client) GetDocument(ctx context.Context, id int64) (*Document, *Response, error)

+ func (c *Client) GetDocumentMetadata(ctx context.Context, id int64) (*DocumentMetadata, error)

+ func (c *Client) GetDocumentType(ctx context.Context, id int64) (*DocumentType, *Response, error)

+ func (c *Client) GetLog(ctx context.Context, name string) ([]LogEntry, *Response, error)

+ func (c *Client) GetStoragePath(ctx context.Context, id int64) (*StoragePath, *Response, error)

+ func (c *Client) GetTag(ctx context.Context, id int64) (*Tag, *Response, error)

+ func (c *Client) GetTask(ctx context.Context, taskID string) (*Task, *Response, error)

+ func (c *Client) ListCorrespondents(ctx context.Context, opts *ListCorrespondentsOptions) ([]Correspondent, *Response, error)

+ func (c *Client) ListDocumentTypes(ctx context.Context, opts *ListDocumentTypesOptions) ([]DocumentType, *Response, error)

+ func (c *Client) ListDocuments(ctx context.Context, opts *ListDocumentsOptions) ([]Document, *Response, error)

+ func (c *Client) ListLogs(ctx context.Context) ([]string, *Response, error)

+ func (c *Client) ListStoragePaths(ctx context.Context, opts *ListStoragePathsOptions) ([]StoragePath, *Response, error)

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

+ func (c *Client) ListTasks(ctx context.Context) ([]Task, *Response, error)

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

+ func (c *Client) UpdateCorrespondent(ctx context.Context, id int64, data *Correspondent) (*Correspondent, *Response, error)

+ func (c *Client) UpdateDocument(ctx context.Context, id int64, data *Document) (*Document, *Response, error)

+ func (c *Client) UpdateDocumentType(ctx context.Context, id int64, data *DocumentType) (*DocumentType, *Response, error)

+ func (c *Client) UpdateStoragePath(ctx context.Context, id int64, data *StoragePath) (*StoragePath, *Response, error)

+ func (c *Client) UpdateTag(ctx context.Context, id int64, data *Tag) (*Tag, *Response, error)

+ func (c *Client) UploadDocument(ctx context.Context, r io.Reader, opts *DocumentUploadOptions) (*DocumentUpload, *Response, error)

+ func (c *Client) WaitForTask(ctx context.Context, taskID string, opts *WaitForTaskOptions) (*Task, error)

+ type Color struct

+ B uint8

+ G uint8

+ R uint8

+ func NewColor(src color.Color) Color

+ func (c *Color) UnmarshalJSON(data []byte) error

+ func (c Color) MarshalJSON() ([]byte, error)

+ func (c Color) RGBA() (r, g, b, a uint32)

+ type Correspondent struct

+ DocumentCount int64

+ ID int64

+ IsInsensitive bool

+ LastCorrespondence time.Time

+ Match string

+ MatchingAlgorithm MatchingAlgorithm

+ Name string

+ Slug string

+ type DateTimeFilterSpec struct

+ Gt *time.Time

+ Lt *time.Time

+ func (s DateTimeFilterSpec) EncodeValues(key string, v *url.Values) error

+ type Document struct

+ Added time.Time

+ ArchiveSerialNumber *int64

+ ArchivedFileName *string

+ Content string

+ Correspondent *int64

+ Created time.Time

+ DocumentType *int64

+ ID int64

+ Modified time.Time

+ OriginalFileName string

+ StoragePath *int64

+ Tags []int64

+ Title string

+ type DocumentMetadata struct

+ ArchiveChecksum string

+ ArchiveMediaFilename string

+ ArchiveMetadata []DocumentVersionMetadata

+ ArchiveSize int64

+ HasArchiveVersion bool

+ Language string

+ OriginalChecksum string

+ OriginalFilename string

+ OriginalMediaFilename string

+ OriginalMetadata []DocumentVersionMetadata

+ OriginalMimeType string

+ OriginalSize int64

+ type DocumentType struct

+ DocumentCount int64

+ ID int64

+ IsInsensitive bool

+ Match string

+ MatchingAlgorithm MatchingAlgorithm

+ Name string

+ Slug string

+ type DocumentUpload struct

+ TaskID string

+ type DocumentUploadOptions struct

+ ArchiveSerialNumber *int64

+ Correspondent *int64

+ Created time.Time

+ DocumentType *int64

+ Filename string

+ Tags []int64

+ Title string

+ type DocumentVersionMetadata struct

+ Key string

+ Namespace string

+ Prefix string

+ Value string

+ type DownloadResult struct

+ ContentType string

+ ContentTypeParams map[string]string

+ Filename string

+ Length int64

+ type Flags struct

+ AuthPassword string

+ AuthPasswordFile string

+ AuthToken string

+ AuthTokenFile string

+ AuthUsername string

+ BaseURL string

+ DebugMode bool

+ Header http.Header

+ ServerTimezone string

+ func (f *Flags) Build() (*Client, error)

+ func (f *Flags) BuildOptions() (*Options, error)

+ type ForeignKeyFilterSpec struct

+ ID *int64

+ IsNull *bool

+ Name CharFilterSpec

+ func (s ForeignKeyFilterSpec) EncodeValues(key string, v *url.Values) error

+ type IntFilterSpec struct

+ Equals *int64

+ Gt *int64

+ Gte *int64

+ IsNull *bool

+ Lt *int64

+ Lte *int64

+ func (s IntFilterSpec) EncodeValues(key string, v *url.Values) error

+ type ListCorrespondentsOptions struct

+ Name CharFilterSpec

+ Ordering OrderingSpec

+ type ListDocumentTypesOptions struct

+ Name CharFilterSpec

+ Ordering OrderingSpec

+ type ListDocumentsOptions struct

+ Added DateTimeFilterSpec

+ ArchiveSerialNumber IntFilterSpec

+ Content CharFilterSpec

+ Correspondent ForeignKeyFilterSpec

+ Created DateTimeFilterSpec

+ DocumentType ForeignKeyFilterSpec

+ Modified DateTimeFilterSpec

+ Ordering OrderingSpec

+ StoragePath ForeignKeyFilterSpec

+ Tags ForeignKeyFilterSpec

+ Title CharFilterSpec

+ type ListOptions struct

+ Page *PageToken

+ type ListStoragePathsOptions struct

+ Name CharFilterSpec

+ Ordering OrderingSpec

+ Path CharFilterSpec

+ type ListTagsOptions struct

+ Name CharFilterSpec

+ Ordering OrderingSpec

+ type LogEntry struct

+ Level string

+ Message string

+ Module string

+ Time time.Time

+ type Logger interface

+ Debugf func(format string, v ...any)

+ Errorf func(format string, v ...any)

+ Warnf func(format string, v ...any)

+ type MatchingAlgorithm int

+ const MatchAll

+ const MatchAny

+ const MatchAuto

+ const MatchFuzzy

+ const MatchLiteral

+ const MatchRegex

+ const MatchUnspecified

+ func (i MatchingAlgorithm) String() string

+ type Options struct

+ Auth AuthMechanism

+ BaseURL string

+ DebugMode bool

+ Header http.Header

+ Logger Logger

+ ServerLocation *time.Location

+ type OrderingSpec struct

+ Desc bool

+ Field string

+ func (o OrderingSpec) EncodeValues(key string, v *url.Values) error

+ type PageToken struct

+ func (t *PageToken) EncodeValues(_ string, v *url.Values) error

+ type RequestError struct

+ Message string

+ StatusCode int

+ func (e *RequestError) Error() string

+ func (e *RequestError) Is(other error) bool

+ type Response struct

+ NextPage *PageToken

+ PrevPage *PageToken

+ type StoragePath struct

+ DocumentCount int64

+ ID int64

+ IsInsensitive bool

+ Match string

+ MatchingAlgorithm MatchingAlgorithm

+ Name string

+ Slug string

+ type Tag struct

+ Color Color

+ DocumentCount int64

+ ID int64

+ IsInboxTag bool

+ IsInsensitive bool

+ Match string

+ MatchingAlgorithm MatchingAlgorithm

+ Name string

+ Slug string

+ TextColor Color

+ type Task struct

+ Acknowledged bool

+ Created *time.Time

+ Done *time.Time

+ ID int64

+ Result *string

+ Status TaskStatus

+ TaskFileName *string

+ TaskID string

+ Type string

+ type TaskError struct

+ Message string

+ Status TaskStatus

+ TaskID string

+ func (e *TaskError) Error() string

+ func (e *TaskError) Is(other error) bool

+ type TaskStatus int

+ const TaskFailure

+ const TaskPending

+ const TaskRetry

+ const TaskRevoked

+ const TaskStarted

+ const TaskStatusUnspecified

+ const TaskSuccess

+ func (i TaskStatus) String() string

+ func (s *TaskStatus) UnmarshalJSON(data []byte) error

+ func (s TaskStatus) MarshalJSON() ([]byte, error)

+ func (s TaskStatus) Terminal() bool

+ type TokenAuth struct

+ Token string

+ type UsernamePasswordAuth struct

+ Password string

+ Username string

+ type WaitForTaskConditionFunc func(*Task) error

+ type WaitForTaskOptions struct

+ Condition WaitForTaskConditionFunc

+ MaxElapsedTime time.Duration

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