Go API client for gohiarc

Welcome to the Hiarc API documentation.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 0.1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./gohiarc"

Documentation for API Endpoints

All URIs are relative to http://localhost:5000

Class	Method	HTTP request	Description
AdminApi	InitDB	Post /admin/database/init	Init the Hiarc database
AdminApi	ResetDB	Put /admin/database/reset	Reset the Hiarc database
ClassificationApi	CreateClassification	Post /classifications	Create a Classification
ClassificationApi	DeleteClassification	Delete /classifications/{key}	Delete a Classification
ClassificationApi	FindClassification	Post /classifications/find	Find a Classification
ClassificationApi	GetAllClassifications	Get /classifications	Get all Classifications
ClassificationApi	GetClassification	Get /classifications/{key}	Get a Classification's Info
ClassificationApi	UpdateClassification	Put /classifications/{key}	Update a Classification
CollectionApi	AddChildToCollection	Put /collections/{key}/children/{childKey}	Add a child item to a Collection
CollectionApi	AddFileToCollection	Put /collections/{key}/files	Add a File to a Collection
CollectionApi	AddGroupToCollection	Put /collections/{key}/groups	Add a Group to a Collection
CollectionApi	AddUserToCollection	Put /collections/{key}/users	Add a User to a Collection
CollectionApi	CreateCollection	Post /collections	Create a Collection
CollectionApi	DeleteCollection	Delete /collections/{key}	Delete a Collection
CollectionApi	FindCollection	Post /collections/find	Find a Collection
CollectionApi	GetAllCollections	Get /collections	Get all Collections
CollectionApi	GetCollection	Get /collections/{key}	Get a Collection's Info
CollectionApi	GetCollectionChildren	Get /collections/{key}/children	Get a Collection's child Collections
CollectionApi	GetCollectionFiles	Get /collections/{key}/files	Get a Collection's Files
CollectionApi	GetCollectionItems	Get /collections/{key}/items	Get a Collection's child items, including Collections and Files
CollectionApi	RemoveFileFromCollection	Delete /collections/{key}/files/{fileKey}	Remove a File from a Collection
CollectionApi	UpdateCollection	Put /collections/{key}	Update a Collection
FileApi	AddClassificationToFile	Put /files/{key}/classifications	Add a Classification to a File
FileApi	AddGroupToFile	Put /files/{key}/groups	Give a group access to a File
FileApi	AddRetentionPolicyToFile	Put /files/{key}/retentionpolicies	Add a Retention Policy to a File
FileApi	AddUserToFile	Put /files/{key}/users	Give a user access to a File
FileApi	AddVersion	Put /files/{key}/versions	Add a new File Version
FileApi	AttachToExisitingFile	Put /files/{key}/attach	Attach to an existing File
FileApi	CopyFile	Put /files/{key}/copy	Copy a File
FileApi	CreateDirectUploadUrl	Post /files/directuploadurl	Create a direct upload url to a storage service
FileApi	CreateFile	Post /files	Create a File
FileApi	DeleteFile	Delete /files/{key}	Delete a File
FileApi	DownloadFile	Get /files/{key}/download	Download a File
FileApi	GetCollectionsForFile	Get /files/{key}/collections	Get a list of Collections for a File
FileApi	GetDirectDownloadUrl	Get /files/{key}/directdownloadurl	Get a direct download URL to a File
FileApi	GetFile	Get /files/{key}	Get a File's Info
FileApi	GetRetentionPolicies	Get /files/{key}/retentionpolicies	Get a list of Retention Policies on a File
FileApi	GetVersions	Get /files/{key}/versions	Get a list of File Versions
FileApi	UpdateFile	Put /files/{key}	Update a File
FilesApi	FilterAllowedFiles	Post /files/allowed	Filter a list of File keys that a User can access
GroupApi	AddUserToGroup	Put /groups/{key}/users/{userKey}	Add a User to a Group
GroupApi	CreateGroup	Post /groups	Create a Group
GroupApi	DeleteGroup	Delete /groups/{key}	Delete a Group
GroupApi	FindGroup	Post /groups/find	Find a Group
GroupApi	GetAllGroups	Get /groups	Get all Groups
GroupApi	GetGroup	Get /groups/{key}	Get a Group's Info
GroupApi	GetGroupsForCurrentUser	Get /users/current/groups	Get the Groups for the current User
GroupApi	UpdateGroup	Put /groups/{key}	Update a Group
GroupsApi	GetGroupsForUser	Get /users/{key}/groups	Get Groups for a User
LegalHoldApi	CreateLegalHold	Post /legalholds	Create a Legal Hold
LegalHoldApi	GetLegalHold	Get /legalholds/{key}	Get a Legal Hold's Info
RetentionPolicyApi	CreateRetentionPolicy	Post /retentionpolicies	Create a Retention Policy
RetentionPolicyApi	FindRetentionPolicies	Post /retentionpolicies/find	Find a Retention Policy
RetentionPolicyApi	GetAllRetentionPolicies	Get /retentionpolicies	Get all Retention Policies
RetentionPolicyApi	GetRetentionPolicy	Get /retentionpolicies/{key}	Get a Retention Policy's Info
RetentionPolicyApi	UpdateRetentionPolicy	Put /retentionpolicies/{key}	Update a Retention Policy
TokenApi	CreateUserToken	Post /tokens/user	Create a Token for a User
UserApi	CreateUser	Post /users	Create a User
UserApi	DeleteUser	Delete /users/{key}	Delete a User
UserApi	FindUser	Post /users/find	Find a User
UserApi	GetAllUsers	Get /users	Get all Users
UserApi	GetCurrentUser	Get /users/current	Get the current User
UserApi	GetGroupsForCurrentUser	Get /users/current/groups	Get the Groups for the current User
UserApi	GetGroupsForUser	Get /users/{key}/groups	Get Groups for a User
UserApi	GetUser	Get /users/{key}	Get a User
UserApi	UpdateUser	Put /users/{key}	Update a User

Documentation For Models

• AccessLevel
• AddClassificationToFileRequest
• AddFileToCollectionRequest
• AddGroupToCollectionRequest
• AddGroupToFileRequest
• AddRetentionPolicyToFileRequest
• AddUserToCollectionRequest
• AddUserToFileRequest
• AddVersionToFileRequest
• AllowedFilesRequest
• AttachToExistingFileRequest
• Classification
• Collection
• CollectionItems
• CopyFileRequest
• CreateClassificationRequest
• CreateCollectionRequest
• CreateDirectUploadUrlRequest
• CreateFileRequest
• CreateFileRequestAllOf
• CreateGroupRequest
• CreateLegalHoldRequest
• CreateOrUpdateEntityRequest
• CreateRetentionPolicyRequest
• CreateRetentionPolicyRequestAllOf
• CreateUserRequest
• CreateUserTokenRequest
• Entity
• File
• FileAllOf
• FileDirectDownload
• FileDirectUpload
• FileVersion
• FindClassificationsRequest
• FindCollectionsRequest
• FindEntityRequest
• FindGroupsRequest
• FindRetentionPoliciesRequest
• FindUsersRequest
• Group
• InlineObject
• InlineObject1
• LegalHold
• RetentionPolicy
• RetentionPolicyApplication
• UpdateClassificationRequest
• UpdateCollectionRequest
• UpdateFileRequest
• UpdateGroupRequest
• UpdateRetentionPolicyRequest
• UpdateUserRequest
• User
• UserCredentials

Documentation For Authorization

AdminApiKeyAuth

• Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    Key: "APIKEY",
    Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

JWTBearerAuth

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author