Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AccessLevel
- type AddChildToCollectionOpts
- type AddClassificationToFileOpts
- type AddClassificationToFileRequest
- type AddFileToCollectionOpts
- type AddFileToCollectionRequest
- type AddGroupToCollectionOpts
- type AddGroupToCollectionRequest
- type AddGroupToFileOpts
- type AddGroupToFileRequest
- type AddRetentionPolicyToFileOpts
- type AddRetentionPolicyToFileRequest
- type AddUserToCollectionOpts
- type AddUserToCollectionRequest
- type AddUserToFileOpts
- type AddUserToFileRequest
- type AddVersionOpts
- type AddVersionToFileRequest
- type AdminApiService
- type AllowedFilesRequest
- type AttachToExisitingFileOpts
- type AttachToExistingFileRequest
- type BasicAuth
- type Classification
- type ClassificationApiService
- func (a *ClassificationApiService) CreateClassification(ctx _context.Context, createClassificationRequest CreateClassificationRequest, ...) (Classification, *_nethttp.Response, error)
- func (a *ClassificationApiService) DeleteClassification(ctx _context.Context, key string, localVarOptionals *DeleteClassificationOpts) (map[string]interface{}, *_nethttp.Response, error)
- func (a *ClassificationApiService) FindClassification(ctx _context.Context, findClassificationsRequest FindClassificationsRequest, ...) ([]Classification, *_nethttp.Response, error)
- func (a *ClassificationApiService) GetAllClassifications(ctx _context.Context, localVarOptionals *GetAllClassificationsOpts) ([]Classification, *_nethttp.Response, error)
- func (a *ClassificationApiService) GetClassification(ctx _context.Context, key string, localVarOptionals *GetClassificationOpts) (Classification, *_nethttp.Response, error)
- func (a *ClassificationApiService) UpdateClassification(ctx _context.Context, key string, ...) (Classification, *_nethttp.Response, error)
- type Collection
- type CollectionApiService
- func (a *CollectionApiService) AddChildToCollection(ctx _context.Context, key string, childKey string, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *CollectionApiService) AddFileToCollection(ctx _context.Context, key string, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *CollectionApiService) AddGroupToCollection(ctx _context.Context, key string, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *CollectionApiService) AddUserToCollection(ctx _context.Context, key string, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *CollectionApiService) CreateCollection(ctx _context.Context, createCollectionRequest CreateCollectionRequest, ...) (Collection, *_nethttp.Response, error)
- func (a *CollectionApiService) DeleteCollection(ctx _context.Context, key string, localVarOptionals *DeleteCollectionOpts) (map[string]interface{}, *_nethttp.Response, error)
- func (a *CollectionApiService) FindCollection(ctx _context.Context, findCollectionsRequest FindCollectionsRequest, ...) ([]Collection, *_nethttp.Response, error)
- func (a *CollectionApiService) GetAllCollections(ctx _context.Context, localVarOptionals *GetAllCollectionsOpts) ([]Collection, *_nethttp.Response, error)
- func (a *CollectionApiService) GetCollection(ctx _context.Context, key string, localVarOptionals *GetCollectionOpts) (Collection, *_nethttp.Response, error)
- func (a *CollectionApiService) GetCollectionChildren(ctx _context.Context, key string, localVarOptionals *GetCollectionChildrenOpts) ([]Collection, *_nethttp.Response, error)
- func (a *CollectionApiService) GetCollectionFiles(ctx _context.Context, key string, localVarOptionals *GetCollectionFilesOpts) ([]File, *_nethttp.Response, error)
- func (a *CollectionApiService) GetCollectionItems(ctx _context.Context, key string, localVarOptionals *GetCollectionItemsOpts) (CollectionItems, *_nethttp.Response, error)
- func (a *CollectionApiService) RemoveFileFromCollection(ctx _context.Context, key string, fileKey string, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *CollectionApiService) UpdateCollection(ctx _context.Context, key string, ...) (Collection, *_nethttp.Response, error)
- type CollectionItems
- type Configuration
- type CopyFileOpts
- type CopyFileRequest
- type CreateClassificationOpts
- type CreateClassificationRequest
- type CreateCollectionOpts
- type CreateCollectionRequest
- type CreateDirectUploadUrlOpts
- type CreateDirectUploadUrlRequest
- type CreateFileOpts
- type CreateFileRequest
- type CreateFileRequestAllOf
- type CreateGroupRequest
- type CreateLegalHoldRequest
- type CreateOrUpdateEntityRequest
- type CreateRetentionPolicyRequest
- type CreateRetentionPolicyRequestAllOf
- type CreateUserRequest
- type CreateUserTokenRequest
- type DeleteClassificationOpts
- type DeleteCollectionOpts
- type DeleteFileOpts
- type DownloadFileOpts
- type Entity
- type File
- type FileAllOf
- type FileApiService
- func (a *FileApiService) AddClassificationToFile(ctx _context.Context, key string, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *FileApiService) AddGroupToFile(ctx _context.Context, key string, addGroupToFileRequest AddGroupToFileRequest, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *FileApiService) AddRetentionPolicyToFile(ctx _context.Context, key string, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *FileApiService) AddUserToFile(ctx _context.Context, key string, addUserToFileRequest AddUserToFileRequest, ...) (map[string]interface{}, *_nethttp.Response, error)
- func (a *FileApiService) AddVersion(ctx _context.Context, key string, filepath string, filename string, ...) (File, *_nethttp.Response, error)
- func (a *FileApiService) AttachToExisitingFile(ctx _context.Context, key string, ...) (File, *_nethttp.Response, error)
- func (a *FileApiService) CopyFile(ctx _context.Context, key string, copyFileRequest CopyFileRequest, ...) (File, *_nethttp.Response, error)
- func (a *FileApiService) CreateDirectUploadUrl(ctx _context.Context, ...) (FileDirectUpload, *_nethttp.Response, error)
- func (a *FileApiService) CreateFile(ctx _context.Context, filepath string, filename string, cfr CreateFileRequest, ...) (File, *_nethttp.Response, error)
- func (a *FileApiService) DeleteFile(ctx _context.Context, key string, localVarOptionals *DeleteFileOpts) (map[string]interface{}, *_nethttp.Response, error)
- func (a *FileApiService) DownloadFile(ctx _context.Context, key string, localVarOptionals *DownloadFileOpts) (*os.File, *_nethttp.Response, error)
- func (a *FileApiService) GetCollectionsForFile(ctx _context.Context, key string, localVarOptionals *GetCollectionsForFileOpts) ([]Collection, *_nethttp.Response, error)
- func (a *FileApiService) GetDirectDownloadUrl(ctx _context.Context, key string, localVarOptionals *GetDirectDownloadUrlOpts) (FileDirectDownload, *_nethttp.Response, error)
- func (a *FileApiService) GetFile(ctx _context.Context, key string, localVarOptionals *GetFileOpts) (File, *_nethttp.Response, error)
- func (a *FileApiService) GetRetentionPolicies(ctx _context.Context, key string, localVarOptionals *GetRetentionPoliciesOpts) ([]RetentionPolicyApplication, *_nethttp.Response, error)
- func (a *FileApiService) GetVersions(ctx _context.Context, key string, localVarOptionals *GetVersionsOpts) ([]FileVersion, *_nethttp.Response, error)
- func (a *FileApiService) UpdateFile(ctx _context.Context, key string, updateFileRequest UpdateFileRequest, ...) (File, *_nethttp.Response, error)
- type FileDirectDownload
- type FileDirectUpload
- type FileVersion
- type FilesApiService
- type FilterAllowedFilesOpts
- type FindClassificationOpts
- type FindClassificationsRequest
- type FindCollectionOpts
- type FindCollectionsRequest
- type FindEntityRequest
- type FindGroupsRequest
- type FindRetentionPoliciesRequest
- type FindUsersRequest
- type GenericOpenAPIError
- type GetAllClassificationsOpts
- type GetAllCollectionsOpts
- type GetClassificationOpts
- type GetCollectionChildrenOpts
- type GetCollectionFilesOpts
- type GetCollectionItemsOpts
- type GetCollectionOpts
- type GetCollectionsForFileOpts
- type GetCurrentUserOpts
- type GetDirectDownloadUrlOpts
- type GetFileOpts
- type GetGroupsForCurrentUserOpts
- type GetGroupsForUserOpts
- type GetRetentionPoliciesOpts
- type GetVersionsOpts
- type Group
- type GroupApiService
- func (a *GroupApiService) AddUserToGroup(ctx _context.Context, key string, userKey string) (map[string]interface{}, *_nethttp.Response, error)
- func (a *GroupApiService) CreateGroup(ctx _context.Context, createGroupRequest CreateGroupRequest) (Group, *_nethttp.Response, error)
- func (a *GroupApiService) DeleteGroup(ctx _context.Context, key string) (map[string]interface{}, *_nethttp.Response, error)
- func (a *GroupApiService) FindGroup(ctx _context.Context, findGroupsRequest FindGroupsRequest) ([]Group, *_nethttp.Response, error)
- func (a *GroupApiService) GetAllGroups(ctx _context.Context) ([]Group, *_nethttp.Response, error)
- func (a *GroupApiService) GetGroup(ctx _context.Context, key string) (Group, *_nethttp.Response, error)
- func (a *GroupApiService) GetGroupsForCurrentUser(ctx _context.Context, localVarOptionals *GetGroupsForCurrentUserOpts) ([]Group, *_nethttp.Response, error)
- func (a *GroupApiService) UpdateGroup(ctx _context.Context, key string, updateGroupRequest UpdateGroupRequest) (Group, *_nethttp.Response, error)
- type GroupsApiService
- type InlineObject
- type InlineObject1
- type LegalHold
- type LegalHoldApiService
- type RemoveFileFromCollectionOpts
- type RetentionPolicy
- type RetentionPolicyApiService
- func (a *RetentionPolicyApiService) CreateRetentionPolicy(ctx _context.Context, ...) (RetentionPolicy, *_nethttp.Response, error)
- func (a *RetentionPolicyApiService) FindRetentionPolicies(ctx _context.Context, ...) ([]RetentionPolicy, *_nethttp.Response, error)
- func (a *RetentionPolicyApiService) GetAllRetentionPolicies(ctx _context.Context) ([]RetentionPolicy, *_nethttp.Response, error)
- func (a *RetentionPolicyApiService) GetRetentionPolicy(ctx _context.Context, key string) (RetentionPolicy, *_nethttp.Response, error)
- func (a *RetentionPolicyApiService) UpdateRetentionPolicy(ctx _context.Context, key string, ...) (RetentionPolicy, *_nethttp.Response, error)
- type RetentionPolicyApplication
- type ServerConfiguration
- type ServerVariable
- type TokenApiService
- type UpdateClassificationOpts
- type UpdateClassificationRequest
- type UpdateCollectionOpts
- type UpdateCollectionRequest
- type UpdateFileOpts
- type UpdateFileRequest
- type UpdateGroupRequest
- type UpdateRetentionPolicyRequest
- type UpdateUserRequest
- type User
- type UserApiService
- func (a *UserApiService) CreateUser(ctx _context.Context, createUserRequest CreateUserRequest) (User, *_nethttp.Response, error)
- func (a *UserApiService) DeleteUser(ctx _context.Context, key string) (map[string]interface{}, *_nethttp.Response, error)
- func (a *UserApiService) FindUser(ctx _context.Context, findUsersRequest FindUsersRequest) ([]User, *_nethttp.Response, error)
- func (a *UserApiService) GetAllUsers(ctx _context.Context) ([]User, *_nethttp.Response, error)
- func (a *UserApiService) GetCurrentUser(ctx _context.Context, localVarOptionals *GetCurrentUserOpts) (User, *_nethttp.Response, error)
- func (a *UserApiService) GetGroupsForCurrentUser(ctx _context.Context, localVarOptionals *GetGroupsForCurrentUserOpts) ([]Group, *_nethttp.Response, error)
- func (a *UserApiService) GetGroupsForUser(ctx _context.Context, key string, localVarOptionals *GetGroupsForUserOpts) ([]Group, *_nethttp.Response, error)
- func (a *UserApiService) GetUser(ctx _context.Context, key string) (User, *_nethttp.Response, error)
- func (a *UserApiService) UpdateUser(ctx _context.Context, key string, updateUserRequest UpdateUserRequest) (User, *_nethttp.Response, error)
- type UserCredentials
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes an oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { AdminApi *AdminApiService ClassificationApi *ClassificationApiService CollectionApi *CollectionApiService FileApi *FileApiService FilesApi *FilesApiService GroupApi *GroupApiService GroupsApi *GroupsApiService LegalHoldApi *LegalHoldApiService RetentionPolicyApi *RetentionPolicyApiService TokenApi *TokenApiService UserApi *UserApiService // contains filtered or unexported fields }
APIClient manages communication with the Hiarc API API v0.1.0 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
ChangeBasePath changes base path to allow switching to mocks
func (*APIClient) GetConfig ¶
func (c *APIClient) GetConfig() *Configuration
Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct { *http.Response `json:"-"` Message string `json:"message,omitempty"` // Operation is the name of the OpenAPI operation. Operation string `json:"operation,omitempty"` // RequestURL is the request URL. This value is always available, even if the // embedded *http.Response is nil. RequestURL string `json:"url,omitempty"` // Method is the HTTP method used for the request. This value is always // available, even if the embedded *http.Response is nil. Method string `json:"method,omitempty"` // Payload holds the contents of the response body (which may be nil or empty). // This is provided here as the raw response.Body() reader will have already // been drained. Payload []byte `json:"-"` }
APIResponse stores the API response returned by the server.
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
NewAPIResponse returns a new APIResonse object.
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
type AccessLevel ¶
type AccessLevel string
AccessLevel the model 'AccessLevel'
const ( CO_OWNER AccessLevel = "CO_OWNER" READ_WRITE AccessLevel = "READ_WRITE" READ_ONLY AccessLevel = "READ_ONLY" UPLOAD_ONLY AccessLevel = "UPLOAD_ONLY" )
List of AccessLevel
type AddChildToCollectionOpts ¶
AddChildToCollectionOpts Optional parameters for the method 'AddChildToCollection'
type AddClassificationToFileOpts ¶
AddClassificationToFileOpts Optional parameters for the method 'AddClassificationToFile'
type AddClassificationToFileRequest ¶
type AddClassificationToFileRequest struct {
ClassificationKey string `json:"classificationKey,omitempty"`
}
AddClassificationToFileRequest struct for AddClassificationToFileRequest
type AddFileToCollectionOpts ¶
AddFileToCollectionOpts Optional parameters for the method 'AddFileToCollection'
type AddFileToCollectionRequest ¶
type AddFileToCollectionRequest struct {
FileKey string `json:"fileKey,omitempty"`
}
AddFileToCollectionRequest struct for AddFileToCollectionRequest
type AddGroupToCollectionOpts ¶
AddGroupToCollectionOpts Optional parameters for the method 'AddGroupToCollection'
type AddGroupToCollectionRequest ¶
type AddGroupToCollectionRequest struct { GroupKey string `json:"groupKey,omitempty"` AccessLevel AccessLevel `json:"accessLevel,omitempty"` }
AddGroupToCollectionRequest struct for AddGroupToCollectionRequest
type AddGroupToFileOpts ¶
AddGroupToFileOpts Optional parameters for the method 'AddGroupToFile'
type AddGroupToFileRequest ¶
type AddGroupToFileRequest struct { GroupKey string `json:"groupKey,omitempty"` AccessLevel AccessLevel `json:"accessLevel,omitempty"` }
AddGroupToFileRequest struct for AddGroupToFileRequest
type AddRetentionPolicyToFileOpts ¶
AddRetentionPolicyToFileOpts Optional parameters for the method 'AddRetentionPolicyToFile'
type AddRetentionPolicyToFileRequest ¶
type AddRetentionPolicyToFileRequest struct {
RetentionPolicyKey string `json:"retentionPolicyKey,omitempty"`
}
AddRetentionPolicyToFileRequest struct for AddRetentionPolicyToFileRequest
type AddUserToCollectionOpts ¶
AddUserToCollectionOpts Optional parameters for the method 'AddUserToCollection'
type AddUserToCollectionRequest ¶
type AddUserToCollectionRequest struct { UserKey string `json:"userKey,omitempty"` AccessLevel AccessLevel `json:"accessLevel,omitempty"` }
AddUserToCollectionRequest struct for AddUserToCollectionRequest
type AddUserToFileOpts ¶
AddUserToFileOpts Optional parameters for the method 'AddUserToFile'
type AddUserToFileRequest ¶
type AddUserToFileRequest struct { UserKey string `json:"userKey,omitempty"` AccessLevel AccessLevel `json:"accessLevel,omitempty"` }
AddUserToFileRequest struct for AddUserToFileRequest
type AddVersionOpts ¶
AddVersionOpts Optional parameters for the method 'AddVersion'
type AddVersionToFileRequest ¶
type AddVersionToFileRequest struct { Key string `json:"key,omitempty"` StorageService string `json:"storageService,omitempty"` }
AddVersionToFileRequest struct for AddVersionToFileRequest
type AdminApiService ¶
type AdminApiService service
AdminApiService AdminApi service
func (*AdminApiService) InitDB ¶
func (a *AdminApiService) InitDB(ctx _context.Context) (map[string]interface{}, *_nethttp.Response, error)
InitDB Init the Hiarc database
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return map[string]interface{}
func (*AdminApiService) ResetDB ¶
func (a *AdminApiService) ResetDB(ctx _context.Context) (map[string]interface{}, *_nethttp.Response, error)
ResetDB Reset the Hiarc database
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return map[string]interface{}
type AllowedFilesRequest ¶
type AllowedFilesRequest struct {
Keys []string `json:"keys,omitempty"`
}
AllowedFilesRequest struct for AllowedFilesRequest
type AttachToExisitingFileOpts ¶
AttachToExisitingFileOpts Optional parameters for the method 'AttachToExisitingFile'
type AttachToExistingFileRequest ¶
type AttachToExistingFileRequest struct { Name string `json:"name,omitempty"` StorageService string `json:"storageService,omitempty"` StorageId string `json:"storageId,omitempty"` }
AttachToExistingFileRequest struct for AttachToExistingFileRequest
type BasicAuth ¶
type BasicAuth struct { UserName string `json:"userName,omitempty"` Password string `json:"password,omitempty"` }
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type Classification ¶
type Classification struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` }
Classification struct for Classification
type ClassificationApiService ¶
type ClassificationApiService service
ClassificationApiService ClassificationApi service
func (*ClassificationApiService) CreateClassification ¶
func (a *ClassificationApiService) CreateClassification(ctx _context.Context, createClassificationRequest CreateClassificationRequest, localVarOptionals *CreateClassificationOpts) (Classification, *_nethttp.Response, error)
CreateClassification Create a Classification
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createClassificationRequest Classification information
- @param optional nil or *CreateClassificationOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return Classification
func (*ClassificationApiService) DeleteClassification ¶
func (a *ClassificationApiService) DeleteClassification(ctx _context.Context, key string, localVarOptionals *DeleteClassificationOpts) (map[string]interface{}, *_nethttp.Response, error)
DeleteClassification Delete a Classification
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Classification to delete
- @param optional nil or *DeleteClassificationOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*ClassificationApiService) FindClassification ¶
func (a *ClassificationApiService) FindClassification(ctx _context.Context, findClassificationsRequest FindClassificationsRequest, localVarOptionals *FindClassificationOpts) ([]Classification, *_nethttp.Response, error)
FindClassification Find a Classification
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param findClassificationsRequest Classification query
- @param optional nil or *FindClassificationOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []Classification
func (*ClassificationApiService) GetAllClassifications ¶
func (a *ClassificationApiService) GetAllClassifications(ctx _context.Context, localVarOptionals *GetAllClassificationsOpts) ([]Classification, *_nethttp.Response, error)
GetAllClassifications Get all Classifications
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *GetAllClassificationsOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []Classification
func (*ClassificationApiService) GetClassification ¶
func (a *ClassificationApiService) GetClassification(ctx _context.Context, key string, localVarOptionals *GetClassificationOpts) (Classification, *_nethttp.Response, error)
GetClassification Get a Classification's Info
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Classification to get info
- @param optional nil or *GetClassificationOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return Classification
func (*ClassificationApiService) UpdateClassification ¶
func (a *ClassificationApiService) UpdateClassification(ctx _context.Context, key string, updateClassificationRequest UpdateClassificationRequest, localVarOptionals *UpdateClassificationOpts) (Classification, *_nethttp.Response, error)
UpdateClassification Update a Classification
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Classification to get info
- @param updateClassificationRequest Classification information
- @param optional nil or *UpdateClassificationOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return Classification
type Collection ¶
type Collection struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` }
Collection struct for Collection
type CollectionApiService ¶
type CollectionApiService service
CollectionApiService CollectionApi service
func (*CollectionApiService) AddChildToCollection ¶
func (a *CollectionApiService) AddChildToCollection(ctx _context.Context, key string, childKey string, localVarOptionals *AddChildToCollectionOpts) (map[string]interface{}, *_nethttp.Response, error)
AddChildToCollection Add a child item to a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Collection
- @param childKey Key of item to add as child to Collection
- @param optional nil or *AddChildToCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*CollectionApiService) AddFileToCollection ¶
func (a *CollectionApiService) AddFileToCollection(ctx _context.Context, key string, addFileToCollectionRequest AddFileToCollectionRequest, localVarOptionals *AddFileToCollectionOpts) (map[string]interface{}, *_nethttp.Response, error)
AddFileToCollection Add a File to a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Collection
- @param addFileToCollectionRequest Add File request
- @param optional nil or *AddFileToCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*CollectionApiService) AddGroupToCollection ¶
func (a *CollectionApiService) AddGroupToCollection(ctx _context.Context, key string, addGroupToCollectionRequest AddGroupToCollectionRequest, localVarOptionals *AddGroupToCollectionOpts) (map[string]interface{}, *_nethttp.Response, error)
AddGroupToCollection Add a Group to a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Collection
- @param addGroupToCollectionRequest Add Group request
- @param optional nil or *AddGroupToCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*CollectionApiService) AddUserToCollection ¶
func (a *CollectionApiService) AddUserToCollection(ctx _context.Context, key string, addUserToCollectionRequest AddUserToCollectionRequest, localVarOptionals *AddUserToCollectionOpts) (map[string]interface{}, *_nethttp.Response, error)
AddUserToCollection Add a User to a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Collection
- @param addUserToCollectionRequest Add User request
- @param optional nil or *AddUserToCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*CollectionApiService) CreateCollection ¶
func (a *CollectionApiService) CreateCollection(ctx _context.Context, createCollectionRequest CreateCollectionRequest, localVarOptionals *CreateCollectionOpts) (Collection, *_nethttp.Response, error)
CreateCollection Create a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createCollectionRequest Collection information
- @param optional nil or *CreateCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return Collection
func (*CollectionApiService) DeleteCollection ¶
func (a *CollectionApiService) DeleteCollection(ctx _context.Context, key string, localVarOptionals *DeleteCollectionOpts) (map[string]interface{}, *_nethttp.Response, error)
DeleteCollection Delete a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Collection to delete
- @param optional nil or *DeleteCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*CollectionApiService) FindCollection ¶
func (a *CollectionApiService) FindCollection(ctx _context.Context, findCollectionsRequest FindCollectionsRequest, localVarOptionals *FindCollectionOpts) ([]Collection, *_nethttp.Response, error)
FindCollection Find a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param findCollectionsRequest Collection query
- @param optional nil or *FindCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []Collection
func (*CollectionApiService) GetAllCollections ¶
func (a *CollectionApiService) GetAllCollections(ctx _context.Context, localVarOptionals *GetAllCollectionsOpts) ([]Collection, *_nethttp.Response, error)
GetAllCollections Get all Collections
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *GetAllCollectionsOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []Collection
func (*CollectionApiService) GetCollection ¶
func (a *CollectionApiService) GetCollection(ctx _context.Context, key string, localVarOptionals *GetCollectionOpts) (Collection, *_nethttp.Response, error)
GetCollection Get a Collection's Info
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of collection to get info
- @param optional nil or *GetCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return Collection
func (*CollectionApiService) GetCollectionChildren ¶
func (a *CollectionApiService) GetCollectionChildren(ctx _context.Context, key string, localVarOptionals *GetCollectionChildrenOpts) ([]Collection, *_nethttp.Response, error)
GetCollectionChildren Get a Collection's child Collections
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of collection
- @param optional nil or *GetCollectionChildrenOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []Collection
func (*CollectionApiService) GetCollectionFiles ¶
func (a *CollectionApiService) GetCollectionFiles(ctx _context.Context, key string, localVarOptionals *GetCollectionFilesOpts) ([]File, *_nethttp.Response, error)
GetCollectionFiles Get a Collection's Files
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of collection
- @param optional nil or *GetCollectionFilesOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []File
func (*CollectionApiService) GetCollectionItems ¶
func (a *CollectionApiService) GetCollectionItems(ctx _context.Context, key string, localVarOptionals *GetCollectionItemsOpts) (CollectionItems, *_nethttp.Response, error)
GetCollectionItems Get a Collection's child items, including Collections and Files
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of collection
- @param optional nil or *GetCollectionItemsOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return CollectionItems
func (*CollectionApiService) RemoveFileFromCollection ¶
func (a *CollectionApiService) RemoveFileFromCollection(ctx _context.Context, key string, fileKey string, localVarOptionals *RemoveFileFromCollectionOpts) (map[string]interface{}, *_nethttp.Response, error)
RemoveFileFromCollection Remove a File from a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Collection
- @param fileKey Key of File to remove from Collection
- @param optional nil or *RemoveFileFromCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*CollectionApiService) UpdateCollection ¶
func (a *CollectionApiService) UpdateCollection(ctx _context.Context, key string, updateCollectionRequest UpdateCollectionRequest, localVarOptionals *UpdateCollectionOpts) (Collection, *_nethttp.Response, error)
UpdateCollection Update a Collection
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of collection to get info
- @param updateCollectionRequest Collection information
- @param optional nil or *UpdateCollectionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return Collection
type CollectionItems ¶
type CollectionItems struct { ChildCollections []Collection `json:"childCollections,omitempty"` Files []File `json:"files,omitempty"` }
CollectionItems struct for CollectionItems
type Configuration ¶
type Configuration struct { BasePath string `json:"basePath,omitempty"` Host string `json:"host,omitempty"` Scheme string `json:"scheme,omitempty"` DefaultHeader map[string]string `json:"defaultHeader,omitempty"` UserAgent string `json:"userAgent,omitempty"` Debug bool `json:"debug,omitempty"` Servers []ServerConfiguration HTTPClient *http.Client }
Configuration stores the configuration of the API client
func NewConfiguration ¶
func NewConfiguration() *Configuration
NewConfiguration returns a new Configuration object
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
AddDefaultHeader adds a new HTTP header to the default header in the request
type CopyFileOpts ¶
CopyFileOpts Optional parameters for the method 'CopyFile'
type CopyFileRequest ¶
type CopyFileRequest struct { Key string `json:"key,omitempty"` StorageService string `json:"storageService,omitempty"` }
CopyFileRequest struct for CopyFileRequest
type CreateClassificationOpts ¶
CreateClassificationOpts Optional parameters for the method 'CreateClassification'
type CreateClassificationRequest ¶
type CreateClassificationRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
CreateClassificationRequest struct for CreateClassificationRequest
type CreateCollectionOpts ¶
CreateCollectionOpts Optional parameters for the method 'CreateCollection'
type CreateCollectionRequest ¶
type CreateCollectionRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
CreateCollectionRequest struct for CreateCollectionRequest
type CreateDirectUploadUrlOpts ¶
type CreateDirectUploadUrlOpts struct { XHiarcUserKey optional.String ExpiresInSeconds optional.Int32 }
CreateDirectUploadUrlOpts Optional parameters for the method 'CreateDirectUploadUrl'
type CreateDirectUploadUrlRequest ¶
type CreateDirectUploadUrlRequest struct {
StorageService string `json:"storageService,omitempty"`
}
CreateDirectUploadUrlRequest struct for CreateDirectUploadUrlRequest
type CreateFileOpts ¶
CreateFileOpts Optional parameters for the method 'CreateFile'
type CreateFileRequest ¶
type CreateFileRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` StorageService string `json:"storageService,omitempty"` }
CreateFileRequest struct for CreateFileRequest
type CreateFileRequestAllOf ¶
type CreateFileRequestAllOf struct {
StorageService string `json:"storageService,omitempty"`
}
CreateFileRequestAllOf struct for CreateFileRequestAllOf
type CreateGroupRequest ¶
type CreateGroupRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
CreateGroupRequest struct for CreateGroupRequest
type CreateLegalHoldRequest ¶
type CreateLegalHoldRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
CreateLegalHoldRequest struct for CreateLegalHoldRequest
type CreateOrUpdateEntityRequest ¶
type CreateOrUpdateEntityRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
CreateOrUpdateEntityRequest struct for CreateOrUpdateEntityRequest
type CreateRetentionPolicyRequest ¶
type CreateRetentionPolicyRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` Seconds int32 `json:"seconds,omitempty"` }
CreateRetentionPolicyRequest struct for CreateRetentionPolicyRequest
type CreateRetentionPolicyRequestAllOf ¶
type CreateRetentionPolicyRequestAllOf struct {
Seconds int32 `json:"seconds,omitempty"`
}
CreateRetentionPolicyRequestAllOf struct for CreateRetentionPolicyRequestAllOf
type CreateUserRequest ¶
type CreateUserRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
CreateUserRequest struct for CreateUserRequest
type CreateUserTokenRequest ¶
type CreateUserTokenRequest struct { Key string `json:"key,omitempty"` ExpirationMinues float32 `json:"expirationMinues,omitempty"` }
CreateUserTokenRequest struct for CreateUserTokenRequest
type DeleteClassificationOpts ¶
DeleteClassificationOpts Optional parameters for the method 'DeleteClassification'
type DeleteCollectionOpts ¶
DeleteCollectionOpts Optional parameters for the method 'DeleteCollection'
type DeleteFileOpts ¶
DeleteFileOpts Optional parameters for the method 'DeleteFile'
type DownloadFileOpts ¶
DownloadFileOpts Optional parameters for the method 'DownloadFile'
type Entity ¶
type Entity struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` }
Entity struct for Entity
type File ¶
type File struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` VersionCount float32 `json:"versionCount,omitempty"` }
type FileAllOf ¶
type FileAllOf struct {
VersionCount float32 `json:"versionCount,omitempty"`
}
FileAllOf struct for FileAllOf
type FileApiService ¶
type FileApiService service
FileApiService FileApi service
func (*FileApiService) AddClassificationToFile ¶
func (a *FileApiService) AddClassificationToFile(ctx _context.Context, key string, addClassificationToFileRequest AddClassificationToFileRequest, localVarOptionals *AddClassificationToFileOpts) (map[string]interface{}, *_nethttp.Response, error)
AddClassificationToFile Add a Classification to a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file
- @param addClassificationToFileRequest Classification information
- @param optional nil or *AddClassificationToFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return map[string]interface{}
func (*FileApiService) AddGroupToFile ¶
func (a *FileApiService) AddGroupToFile(ctx _context.Context, key string, addGroupToFileRequest AddGroupToFileRequest, localVarOptionals *AddGroupToFileOpts) (map[string]interface{}, *_nethttp.Response, error)
AddGroupToFile Give a group access to a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file
- @param addGroupToFileRequest Group information
- @param optional nil or *AddGroupToFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return map[string]interface{}
func (*FileApiService) AddRetentionPolicyToFile ¶
func (a *FileApiService) AddRetentionPolicyToFile(ctx _context.Context, key string, addRetentionPolicyToFileRequest AddRetentionPolicyToFileRequest, localVarOptionals *AddRetentionPolicyToFileOpts) (map[string]interface{}, *_nethttp.Response, error)
AddRetentionPolicyToFile Add a Retention Policy to a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file
- @param addRetentionPolicyToFileRequest Retention Policy information
- @param optional nil or *AddRetentionPolicyToFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return map[string]interface{}
func (*FileApiService) AddUserToFile ¶
func (a *FileApiService) AddUserToFile(ctx _context.Context, key string, addUserToFileRequest AddUserToFileRequest, localVarOptionals *AddUserToFileOpts) (map[string]interface{}, *_nethttp.Response, error)
AddUserToFile Give a user access to a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file
- @param addUserToFileRequest User information
- @param optional nil or *AddUserToFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return map[string]interface{}
func (*FileApiService) AddVersion ¶
func (a *FileApiService) AddVersion(ctx _context.Context, key string, filepath string, filename string, av AddVersionToFileRequest, localVarOptionals *AddVersionOpts) (File, *_nethttp.Response, error)
AddVersion Add a new File Version
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to add a version
- @param optional nil or *AddVersionOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
- @param "Request" (optional.String) -
- @param "File" (optional.Interface of *os.File) -
@return File
func (*FileApiService) AttachToExisitingFile ¶
func (a *FileApiService) AttachToExisitingFile(ctx _context.Context, key string, attachToExistingFileRequest AttachToExistingFileRequest, localVarOptionals *AttachToExisitingFileOpts) (File, *_nethttp.Response, error)
AttachToExisitingFile Attach to an existing File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to attach to
- @param attachToExistingFileRequest File information
- @param optional nil or *AttachToExisitingFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return File
func (*FileApiService) CopyFile ¶
func (a *FileApiService) CopyFile(ctx _context.Context, key string, copyFileRequest CopyFileRequest, localVarOptionals *CopyFileOpts) (File, *_nethttp.Response, error)
CopyFile Copy a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to attach to
- @param copyFileRequest File information
- @param optional nil or *CopyFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return File
func (*FileApiService) CreateDirectUploadUrl ¶
func (a *FileApiService) CreateDirectUploadUrl(ctx _context.Context, createDirectUploadUrlRequest CreateDirectUploadUrlRequest, localVarOptionals *CreateDirectUploadUrlOpts) (FileDirectUpload, *_nethttp.Response, error)
CreateDirectUploadUrl Create a direct upload url to a storage service
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createDirectUploadUrlRequest Storage service information
- @param optional nil or *CreateDirectUploadUrlOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
- @param "ExpiresInSeconds" (optional.Int32) - When access to the url should expire
@return FileDirectUpload
func (*FileApiService) CreateFile ¶
func (a *FileApiService) CreateFile(ctx _context.Context, filepath string, filename string, cfr CreateFileRequest, localVarOptionals *CreateFileOpts) (File, *_nethttp.Response, error)
CreateFile Create a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *CreateFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return File
func (*FileApiService) DeleteFile ¶
func (a *FileApiService) DeleteFile(ctx _context.Context, key string, localVarOptionals *DeleteFileOpts) (map[string]interface{}, *_nethttp.Response, error)
DeleteFile Delete a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to delete
- @param optional nil or *DeleteFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return map[string]interface{}
func (*FileApiService) DownloadFile ¶
func (a *FileApiService) DownloadFile(ctx _context.Context, key string, localVarOptionals *DownloadFileOpts) (*os.File, *_nethttp.Response, error)
DownloadFile Download a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to download
- @param optional nil or *DownloadFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return *os.File
func (*FileApiService) GetCollectionsForFile ¶
func (a *FileApiService) GetCollectionsForFile(ctx _context.Context, key string, localVarOptionals *GetCollectionsForFileOpts) ([]Collection, *_nethttp.Response, error)
GetCollectionsForFile Get a list of Collections for a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to get all collections
- @param optional nil or *GetCollectionsForFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []Collection
func (*FileApiService) GetDirectDownloadUrl ¶
func (a *FileApiService) GetDirectDownloadUrl(ctx _context.Context, key string, localVarOptionals *GetDirectDownloadUrlOpts) (FileDirectDownload, *_nethttp.Response, error)
GetDirectDownloadUrl Get a direct download URL to a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to get download URL
- @param optional nil or *GetDirectDownloadUrlOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
- @param "ExpiresInSeconds" (optional.Int32) - When access to the url should expire
@return FileDirectDownload
func (*FileApiService) GetFile ¶
func (a *FileApiService) GetFile(ctx _context.Context, key string, localVarOptionals *GetFileOpts) (File, *_nethttp.Response, error)
GetFile Get a File's Info
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to get info
- @param optional nil or *GetFileOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return File
func (*FileApiService) GetRetentionPolicies ¶
func (a *FileApiService) GetRetentionPolicies(ctx _context.Context, key string, localVarOptionals *GetRetentionPoliciesOpts) ([]RetentionPolicyApplication, *_nethttp.Response, error)
GetRetentionPolicies Get a list of Retention Policies on a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to get all retention policies
- @param optional nil or *GetRetentionPoliciesOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []RetentionPolicyApplication
func (*FileApiService) GetVersions ¶
func (a *FileApiService) GetVersions(ctx _context.Context, key string, localVarOptionals *GetVersionsOpts) ([]FileVersion, *_nethttp.Response, error)
GetVersions Get a list of File Versions
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to get all versions
- @param optional nil or *GetVersionsOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []FileVersion
func (*FileApiService) UpdateFile ¶
func (a *FileApiService) UpdateFile(ctx _context.Context, key string, updateFileRequest UpdateFileRequest, localVarOptionals *UpdateFileOpts) (File, *_nethttp.Response, error)
UpdateFile Update a File
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of file to update
- @param updateFileRequest File information
@return File
type FileDirectDownload ¶
type FileDirectDownload struct { Key string `json:"key,omitempty"` DirectDownloadUrl string `json:"directDownloadUrl,omitempty"` ExpiresAt time.Time `json:"expiresAt,omitempty"` }
FileDirectDownload struct for FileDirectDownload
type FileDirectUpload ¶
type FileDirectUpload struct { DirectUploadUrl string `json:"directUploadUrl,omitempty"` StorageId string `json:"storageId,omitempty"` StorageService string `json:"storageService,omitempty"` ExpiresAt time.Time `json:"expiresAt,omitempty"` }
FileDirectUpload struct for FileDirectUpload
type FileVersion ¶
type FileVersion struct { CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` StorageService string `json:"storageService,omitempty"` StorageId string `json:"storageId,omitempty"` }
FileVersion struct for FileVersion
type FilesApiService ¶
type FilesApiService service
FilesApiService FilesApi service
func (*FilesApiService) FilterAllowedFiles ¶
func (a *FilesApiService) FilterAllowedFiles(ctx _context.Context, allowedFilesRequest AllowedFilesRequest, localVarOptionals *FilterAllowedFilesOpts) ([]string, *_nethttp.Response, error)
FilterAllowedFiles Filter a list of File keys that a User can access
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param allowedFilesRequest File key list
- @param optional nil or *FilterAllowedFilesOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) - Optional key of user to impersonate
@return []string
type FilterAllowedFilesOpts ¶
FilterAllowedFilesOpts Optional parameters for the method 'FilterAllowedFiles'
type FindClassificationOpts ¶
FindClassificationOpts Optional parameters for the method 'FindClassification'
type FindClassificationsRequest ¶
type FindClassificationsRequest struct {
Query []map[string]interface{} `json:"query,omitempty"`
}
FindClassificationsRequest struct for FindClassificationsRequest
type FindCollectionOpts ¶
FindCollectionOpts Optional parameters for the method 'FindCollection'
type FindCollectionsRequest ¶
type FindCollectionsRequest struct {
Query []map[string]interface{} `json:"query,omitempty"`
}
FindCollectionsRequest struct for FindCollectionsRequest
type FindEntityRequest ¶
type FindEntityRequest struct {
Query []map[string]interface{} `json:"query,omitempty"`
}
FindEntityRequest struct for FindEntityRequest
type FindGroupsRequest ¶
type FindGroupsRequest struct {
Query []map[string]interface{} `json:"query,omitempty"`
}
FindGroupsRequest struct for FindGroupsRequest
type FindRetentionPoliciesRequest ¶
type FindRetentionPoliciesRequest struct {
Query []map[string]interface{} `json:"query,omitempty"`
}
FindRetentionPoliciesRequest struct for FindRetentionPoliciesRequest
type FindUsersRequest ¶
type FindUsersRequest struct {
Query []map[string]interface{} `json:"query,omitempty"`
}
FindUsersRequest struct for FindUsersRequest
type GenericOpenAPIError ¶
type GenericOpenAPIError struct {
// contains filtered or unexported fields
}
GenericOpenAPIError Provides access to the body, error and model on returned errors.
func (GenericOpenAPIError) Body ¶
func (e GenericOpenAPIError) Body() []byte
Body returns the raw bytes of the response
func (GenericOpenAPIError) Error ¶
func (e GenericOpenAPIError) Error() string
Error returns non-empty string if there was an error.
func (GenericOpenAPIError) Model ¶
func (e GenericOpenAPIError) Model() interface{}
Model returns the unpacked model of the error
type GetAllClassificationsOpts ¶
GetAllClassificationsOpts Optional parameters for the method 'GetAllClassifications'
type GetAllCollectionsOpts ¶
GetAllCollectionsOpts Optional parameters for the method 'GetAllCollections'
type GetClassificationOpts ¶
GetClassificationOpts Optional parameters for the method 'GetClassification'
type GetCollectionChildrenOpts ¶
GetCollectionChildrenOpts Optional parameters for the method 'GetCollectionChildren'
type GetCollectionFilesOpts ¶
GetCollectionFilesOpts Optional parameters for the method 'GetCollectionFiles'
type GetCollectionItemsOpts ¶
GetCollectionItemsOpts Optional parameters for the method 'GetCollectionItems'
type GetCollectionOpts ¶
GetCollectionOpts Optional parameters for the method 'GetCollection'
type GetCollectionsForFileOpts ¶
GetCollectionsForFileOpts Optional parameters for the method 'GetCollectionsForFile'
type GetCurrentUserOpts ¶
GetCurrentUserOpts Optional parameters for the method 'GetCurrentUser'
type GetDirectDownloadUrlOpts ¶
type GetDirectDownloadUrlOpts struct { XHiarcUserKey optional.String ExpiresInSeconds optional.Int32 }
GetDirectDownloadUrlOpts Optional parameters for the method 'GetDirectDownloadUrl'
type GetFileOpts ¶
GetFileOpts Optional parameters for the method 'GetFile'
type GetGroupsForCurrentUserOpts ¶
GetGroupsForCurrentUserOpts Optional parameters for the method 'GetGroupsForCurrentUser'
type GetGroupsForUserOpts ¶
GetGroupsForUserOpts Optional parameters for the method 'GetGroupsForUser'
type GetRetentionPoliciesOpts ¶
GetRetentionPoliciesOpts Optional parameters for the method 'GetRetentionPolicies'
type GetVersionsOpts ¶
GetVersionsOpts Optional parameters for the method 'GetVersions'
type Group ¶
type Group struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` }
type GroupApiService ¶
type GroupApiService service
GroupApiService GroupApi service
func (*GroupApiService) AddUserToGroup ¶
func (a *GroupApiService) AddUserToGroup(ctx _context.Context, key string, userKey string) (map[string]interface{}, *_nethttp.Response, error)
AddUserToGroup Add a User to a Group
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Group
- @param userKey Key of User to add to Group
@return map[string]interface{}
func (*GroupApiService) CreateGroup ¶
func (a *GroupApiService) CreateGroup(ctx _context.Context, createGroupRequest CreateGroupRequest) (Group, *_nethttp.Response, error)
CreateGroup Create a Group
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createGroupRequest Group information
@return Group
func (*GroupApiService) DeleteGroup ¶
func (a *GroupApiService) DeleteGroup(ctx _context.Context, key string) (map[string]interface{}, *_nethttp.Response, error)
DeleteGroup Delete a Group
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Group to delete
@return map[string]interface{}
func (*GroupApiService) FindGroup ¶
func (a *GroupApiService) FindGroup(ctx _context.Context, findGroupsRequest FindGroupsRequest) ([]Group, *_nethttp.Response, error)
FindGroup Find a Group
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param findGroupsRequest Group query
@return []Group
func (*GroupApiService) GetAllGroups ¶
GetAllGroups Get all Groups
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return []Group
func (*GroupApiService) GetGroup ¶
func (a *GroupApiService) GetGroup(ctx _context.Context, key string) (Group, *_nethttp.Response, error)
GetGroup Get a Group's Info
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Group to get info
@return Group
func (*GroupApiService) GetGroupsForCurrentUser ¶
func (a *GroupApiService) GetGroupsForCurrentUser(ctx _context.Context, localVarOptionals *GetGroupsForCurrentUserOpts) ([]Group, *_nethttp.Response, error)
GetGroupsForCurrentUser Get the Groups for the current User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *GetGroupsForCurrentUserOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return []Group
func (*GroupApiService) UpdateGroup ¶
func (a *GroupApiService) UpdateGroup(ctx _context.Context, key string, updateGroupRequest UpdateGroupRequest) (Group, *_nethttp.Response, error)
UpdateGroup Update a Group
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Group to update
- @param updateGroupRequest Group information
@return Group
type GroupsApiService ¶
type GroupsApiService service
GroupsApiService GroupsApi service
func (*GroupsApiService) GetGroupsForUser ¶
func (a *GroupsApiService) GetGroupsForUser(ctx _context.Context, key string, localVarOptionals *GetGroupsForUserOpts) ([]Group, *_nethttp.Response, error)
GetGroupsForUser Get Groups for a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of user
- @param optional nil or *GetGroupsForUserOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return []Group
type InlineObject ¶
type InlineObject struct { Request string `json:"request,omitempty"` File *os.File `json:"file,omitempty"` }
InlineObject struct for InlineObject
type InlineObject1 ¶
type InlineObject1 struct { Request string `json:"request,omitempty"` File *os.File `json:"file,omitempty"` }
InlineObject1 struct for InlineObject1
type LegalHold ¶
type LegalHold struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` }
LegalHold struct for LegalHold
type LegalHoldApiService ¶
type LegalHoldApiService service
LegalHoldApiService LegalHoldApi service
func (*LegalHoldApiService) CreateLegalHold ¶
func (a *LegalHoldApiService) CreateLegalHold(ctx _context.Context, createLegalHoldRequest CreateLegalHoldRequest) (LegalHold, *_nethttp.Response, error)
CreateLegalHold Create a Legal Hold
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createLegalHoldRequest Legal Hold information
@return LegalHold
func (*LegalHoldApiService) GetLegalHold ¶
func (a *LegalHoldApiService) GetLegalHold(ctx _context.Context, key string) (LegalHold, *_nethttp.Response, error)
GetLegalHold Get a Legal Hold's Info
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Legal Hold to get info
@return LegalHold
type RemoveFileFromCollectionOpts ¶
RemoveFileFromCollectionOpts Optional parameters for the method 'RemoveFileFromCollection'
type RetentionPolicy ¶
type RetentionPolicy struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` Seconds int32 `json:"seconds,omitempty"` }
type RetentionPolicyApiService ¶
type RetentionPolicyApiService service
RetentionPolicyApiService RetentionPolicyApi service
func (*RetentionPolicyApiService) CreateRetentionPolicy ¶
func (a *RetentionPolicyApiService) CreateRetentionPolicy(ctx _context.Context, createRetentionPolicyRequest CreateRetentionPolicyRequest) (RetentionPolicy, *_nethttp.Response, error)
CreateRetentionPolicy Create a Retention Policy
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createRetentionPolicyRequest Retention Policy information
@return RetentionPolicy
func (*RetentionPolicyApiService) FindRetentionPolicies ¶
func (a *RetentionPolicyApiService) FindRetentionPolicies(ctx _context.Context, findRetentionPoliciesRequest FindRetentionPoliciesRequest) ([]RetentionPolicy, *_nethttp.Response, error)
FindRetentionPolicies Find a Retention Policy
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param findRetentionPoliciesRequest Retention Policy query
@return []RetentionPolicy
func (*RetentionPolicyApiService) GetAllRetentionPolicies ¶
func (a *RetentionPolicyApiService) GetAllRetentionPolicies(ctx _context.Context) ([]RetentionPolicy, *_nethttp.Response, error)
GetAllRetentionPolicies Get all Retention Policies
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return []RetentionPolicy
func (*RetentionPolicyApiService) GetRetentionPolicy ¶
func (a *RetentionPolicyApiService) GetRetentionPolicy(ctx _context.Context, key string) (RetentionPolicy, *_nethttp.Response, error)
GetRetentionPolicy Get a Retention Policy's Info
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Retention Policy to get info
@return RetentionPolicy
func (*RetentionPolicyApiService) UpdateRetentionPolicy ¶
func (a *RetentionPolicyApiService) UpdateRetentionPolicy(ctx _context.Context, key string, updateRetentionPolicyRequest UpdateRetentionPolicyRequest) (RetentionPolicy, *_nethttp.Response, error)
UpdateRetentionPolicy Update a Retention Policy
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of Retention Policy to update
- @param updateRetentionPolicyRequest RetentionPolicy information
@return RetentionPolicy
type RetentionPolicyApplication ¶
type RetentionPolicyApplication struct { RetentionPolicy RetentionPolicy `json:"retentionPolicy,omitempty"` AppliedAt time.Time `json:"appliedAt,omitempty"` ExpiresAt time.Time `json:"expiresAt,omitempty"` }
RetentionPolicyApplication struct for RetentionPolicyApplication
type ServerConfiguration ¶
type ServerConfiguration struct { Url string Description string Variables map[string]ServerVariable }
ServerConfiguration stores the information about a server
type ServerVariable ¶
ServerVariable stores the information about a server variable
type TokenApiService ¶
type TokenApiService service
TokenApiService TokenApi service
func (*TokenApiService) CreateUserToken ¶
func (a *TokenApiService) CreateUserToken(ctx _context.Context, createUserTokenRequest CreateUserTokenRequest) (UserCredentials, *_nethttp.Response, error)
CreateUserToken Create a Token for a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createUserTokenRequest User information
@return UserCredentials
type UpdateClassificationOpts ¶
UpdateClassificationOpts Optional parameters for the method 'UpdateClassification'
type UpdateClassificationRequest ¶
type UpdateClassificationRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
UpdateClassificationRequest struct for UpdateClassificationRequest
type UpdateCollectionOpts ¶
UpdateCollectionOpts Optional parameters for the method 'UpdateCollection'
type UpdateCollectionRequest ¶
type UpdateCollectionRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
UpdateCollectionRequest struct for UpdateCollectionRequest
type UpdateFileOpts ¶
UpdateFileOpts Optional parameters for the method 'UpdateFile'
type UpdateFileRequest ¶
type UpdateFileRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
UpdateFileRequest struct for UpdateFileRequest
type UpdateGroupRequest ¶
type UpdateGroupRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
UpdateGroupRequest struct for UpdateGroupRequest
type UpdateRetentionPolicyRequest ¶
type UpdateRetentionPolicyRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` Seconds int32 `json:"seconds,omitempty"` }
UpdateRetentionPolicyRequest struct for UpdateRetentionPolicyRequest
type UpdateUserRequest ¶
type UpdateUserRequest struct { Key string `json:"key,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` }
UpdateUserRequest struct for UpdateUserRequest
type User ¶
type User struct { Key string `json:"key,omitempty"` Type string `json:"type,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"` CreatedBy string `json:"createdBy,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` ModifiedAt time.Time `json:"modifiedAt,omitempty"` }
User struct for User
type UserApiService ¶
type UserApiService service
UserApiService UserApi service
func (*UserApiService) CreateUser ¶
func (a *UserApiService) CreateUser(ctx _context.Context, createUserRequest CreateUserRequest) (User, *_nethttp.Response, error)
CreateUser Create a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param createUserRequest User information
@return User
func (*UserApiService) DeleteUser ¶
func (a *UserApiService) DeleteUser(ctx _context.Context, key string) (map[string]interface{}, *_nethttp.Response, error)
DeleteUser Delete a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of user to delete
@return map[string]interface{}
func (*UserApiService) FindUser ¶
func (a *UserApiService) FindUser(ctx _context.Context, findUsersRequest FindUsersRequest) ([]User, *_nethttp.Response, error)
FindUser Find a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param findUsersRequest User query
@return []User
func (*UserApiService) GetAllUsers ¶
GetAllUsers Get all Users
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return []User
func (*UserApiService) GetCurrentUser ¶
func (a *UserApiService) GetCurrentUser(ctx _context.Context, localVarOptionals *GetCurrentUserOpts) (User, *_nethttp.Response, error)
GetCurrentUser Get the current User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *GetCurrentUserOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return User
func (*UserApiService) GetGroupsForCurrentUser ¶
func (a *UserApiService) GetGroupsForCurrentUser(ctx _context.Context, localVarOptionals *GetGroupsForCurrentUserOpts) ([]Group, *_nethttp.Response, error)
GetGroupsForCurrentUser Get the Groups for the current User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *GetGroupsForCurrentUserOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return []Group
func (*UserApiService) GetGroupsForUser ¶
func (a *UserApiService) GetGroupsForUser(ctx _context.Context, key string, localVarOptionals *GetGroupsForUserOpts) ([]Group, *_nethttp.Response, error)
GetGroupsForUser Get Groups for a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of user
- @param optional nil or *GetGroupsForUserOpts - Optional Parameters:
- @param "XHiarcUserKey" (optional.String) -
@return []Group
func (*UserApiService) GetUser ¶
func (a *UserApiService) GetUser(ctx _context.Context, key string) (User, *_nethttp.Response, error)
GetUser Get a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of user to get
@return User
func (*UserApiService) UpdateUser ¶
func (a *UserApiService) UpdateUser(ctx _context.Context, key string, updateUserRequest UpdateUserRequest) (User, *_nethttp.Response, error)
UpdateUser Update a User
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param key Key of user to get
- @param updateUserRequest User information
@return User
Source Files ¶
- api_admin.go
- api_classification.go
- api_collection.go
- api_file.go
- api_files.go
- api_group.go
- api_groups.go
- api_legal_hold.go
- api_retention_policy.go
- api_token.go
- api_user.go
- client.go
- configuration.go
- model_access_level.go
- model_add_classification_to_file_request.go
- model_add_file_to_collection_request.go
- model_add_group_to_collection_request.go
- model_add_group_to_file_request.go
- model_add_retention_policy_to_file_request.go
- model_add_user_to_collection_request.go
- model_add_user_to_file_request.go
- model_add_version_to_file_request.go
- model_allowed_files_request.go
- model_attach_to_existing_file_request.go
- model_classification.go
- model_collection.go
- model_collection_items.go
- model_copy_file_request.go
- model_create_classification_request.go
- model_create_collection_request.go
- model_create_direct_upload_url_request.go
- model_create_file_request.go
- model_create_file_request_all_of.go
- model_create_group_request.go
- model_create_legal_hold_request.go
- model_create_or_update_entity_request.go
- model_create_retention_policy_request.go
- model_create_retention_policy_request_all_of.go
- model_create_user_request.go
- model_create_user_token_request.go
- model_entity.go
- model_file.go
- model_file_all_of.go
- model_file_direct_download.go
- model_file_direct_upload.go
- model_file_version.go
- model_find_classifications_request.go
- model_find_collections_request.go
- model_find_entity_request.go
- model_find_groups_request.go
- model_find_retention_policies_request.go
- model_find_users_request.go
- model_group.go
- model_inline_object.go
- model_inline_object_1.go
- model_legal_hold.go
- model_retention_policy.go
- model_retention_policy_application.go
- model_update_classification_request.go
- model_update_collection_request.go
- model_update_file_request.go
- model_update_group_request.go
- model_update_retention_policy_request.go
- model_update_user_request.go
- model_user.go
- model_user_credentials.go
- response.go