Categorygithub.com/owncloud/libre-graph-api-go
modulepackage
0.17.0
Repository: https://github.com/owncloud/libre-graph-api-go.git
Documentation: pkg.go.dev

# README

Go API client for libregraph

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: v0.17.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

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

import libregraph "github.com/owncloud/libre-graph-api-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), libregraph.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), libregraph.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), libregraph.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), libregraph.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://ocis.ocis-traefik.latest.owncloud.works

ClassMethodHTTP requestDescription
DrivesApiCreateDrivePost /drivesCreate a new space of a specific type
DrivesApiDeleteDriveDelete /drives/{drive-id}Delete a specific space
DrivesApiGetDriveGet /drives/{drive-id}Get drive by id
DrivesApiUpdateDrivePatch /drives/{drive-id}Update the space
DrivesGetDrivesApiListAllDrivesGet /drivesGet All drives
DrivesRootApiGetRootGet /drives/{drive-id}/rootGet root from arbitrary space
GroupApiAddMemberPost /groups/{group-id}/members/$refAdd a member to a group
GroupApiDeleteGroupDelete /groups/{group-id}Delete entity from groups
GroupApiDeleteMemberDelete /groups/{group-id}/members/{directory-object-id}/$refDelete member from a group
GroupApiGetGroupGet /groups/{group-id}Get entity from groups by key
GroupApiUpdateGroupPatch /groups/{group-id}Update entity in groups
GroupsApiCreateGroupPost /groupsAdd new entity to groups
GroupsApiListGroupsGet /groupsGet entities from groups
MeChangepasswordApiChangeOwnPasswordPost /me/changePasswordChanage your own password
MeDriveApiGetHomeGet /me/driveGet personal space for user
MeDriveRootApiHomeGetRootGet /me/drive/rootGet root from personal space
MeDriveRootChildrenApiHomeGetChildrenGet /me/drive/root/childrenGet children from drive
MeDrivesApiListMyDrivesGet /me/drivesGet drives from me
MeUserApiGetOwnUserGet /meGet current user
UserApiDeleteUserDelete /users/{user-id}Delete entity from users
UserApiGetUserGet /users/{user-id}Get entity from users by key
UserApiUpdateUserPatch /users/{user-id}Update entity in users
UsersApiCreateUserPost /usersAdd new entity to users
UsersApiListUsersGet /usersGet entities from users

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewCollectionOfDriveItems instantiates a new CollectionOfDriveItems object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCollectionOfDriveItemsWithDefaults instantiates a new CollectionOfDriveItems object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCollectionOfDrives instantiates a new CollectionOfDrives object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCollectionOfDrivesWithDefaults instantiates a new CollectionOfDrives object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCollectionOfGroup instantiates a new CollectionOfGroup object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCollectionOfGroupWithDefaults instantiates a new CollectionOfGroup object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCollectionOfUser instantiates a new CollectionOfUser object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCollectionOfUserWithDefaults instantiates a new CollectionOfUser object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewDeleted instantiates a new Deleted object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeletedWithDefaults instantiates a new Deleted object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDirectoryObject instantiates a new DirectoryObject object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDirectoryObjectWithDefaults instantiates a new DirectoryObject object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDrive instantiates a new Drive object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDriveItem instantiates a new DriveItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDriveItemWithDefaults instantiates a new DriveItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDriveWithDefaults instantiates a new Drive object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFileSystemInfo instantiates a new FileSystemInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFileSystemInfoWithDefaults instantiates a new FileSystemInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFolder instantiates a new Folder object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFolderView instantiates a new FolderView object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFolderViewWithDefaults instantiates a new FolderView object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFolderWithDefaults instantiates a new Folder object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGroup instantiates a new Group object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGroupWithDefaults instantiates a new Group object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHashes instantiates a new Hashes object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHashesWithDefaults instantiates a new Hashes object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIdentity instantiates a new Identity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIdentitySet instantiates a new IdentitySet object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIdentitySetWithDefaults instantiates a new IdentitySet object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIdentityWithDefaults instantiates a new Identity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewImage instantiates a new Image object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewImageWithDefaults instantiates a new Image object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewItemReference instantiates a new ItemReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewItemReferenceWithDefaults instantiates a new ItemReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewMemberReference instantiates a new MemberReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewMemberReferenceWithDefaults instantiates a new MemberReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOdataError instantiates a new OdataError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOdataErrorDetail instantiates a new OdataErrorDetail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOdataErrorDetailWithDefaults instantiates a new OdataErrorDetail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOdataErrorMain instantiates a new OdataErrorMain object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOdataErrorMainWithDefaults instantiates a new OdataErrorMain object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOdataErrorWithDefaults instantiates a new OdataError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOpenGraphFile instantiates a new OpenGraphFile object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOpenGraphFileWithDefaults instantiates a new OpenGraphFile object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPasswordChange instantiates a new PasswordChange object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPasswordChangeWithDefaults instantiates a new PasswordChange object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPasswordProfile instantiates a new PasswordProfile object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPasswordProfileWithDefaults instantiates a new PasswordProfile object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPermission instantiates a new Permission object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPermissionWithDefaults instantiates a new Permission object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewQuota instantiates a new Quota object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewQuotaWithDefaults instantiates a new Quota object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRemoteItem instantiates a new RemoteItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRemoteItemWithDefaults instantiates a new RemoteItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewShared instantiates a new Shared object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSharedWithDefaults instantiates a new Shared object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSpecialFolder instantiates a new SpecialFolder object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSpecialFolderWithDefaults instantiates a new SpecialFolder object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTrash instantiates a new Trash object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTrashWithDefaults instantiates a new Trash object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUser instantiates a new User object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserWithDefaults instantiates a new User object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

No description provided by the author
No description provided by the author
APIClient manages communication with the Libre Graph API API vv0.17.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CollectionOfDriveItems struct for CollectionOfDriveItems.
CollectionOfDrives struct for CollectionOfDrives.
CollectionOfGroup struct for CollectionOfGroup.
CollectionOfUser struct for CollectionOfUser.
Configuration stores the configuration of the API client.
Deleted Information about the deleted state of the item.
DirectoryObject Represents a Directory object.
Drive Storage Space.
DriveItem Reprensents a resource inside a drive.
FileSystemInfo File system information on client.
Folder Folder metadata, if the item is a folder.
FolderView A collection of properties defining the recommended view for the folder.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Group struct for Group.
Hashes Hashes of the file's binary content, if available.
Identity struct for Identity.
IdentitySet Optional.
Image Image metadata, if the item is an image.
ItemReference struct for ItemReference.
MemberReference struct for MemberReference.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OdataError struct for OdataError.
OdataErrorDetail struct for OdataErrorDetail.
OdataErrorMain struct for OdataErrorMain.
OpenGraphFile File metadata, if the item is a file.
PasswordChange struct for PasswordChange.
PasswordProfile Password Profile associated with a user.
Permission The Permission resource provides information about a sharing permission granted for a DriveItem resource.
Quota Optional.
RemoteItem Remote item data, if the item is shared from a drive other than the one being accessed.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Shared struct for Shared.
SpecialFolder If the current item is also available as a special folder, this facet is returned.
Trash Metadata for trashed drive Items.
User Represents an Active Directory user object.

# Type aliases

DrivesApiService DrivesApi service.
DrivesGetDrivesApiService DrivesGetDrivesApi service.
DrivesRootApiService DrivesRootApi service.
GroupApiService GroupApi service.
GroupsApiService GroupsApi service.
MeChangepasswordApiService MeChangepasswordApi service.
MeDriveApiService MeDriveApi service.
MeDriveRootApiService MeDriveRootApi service.
MeDriveRootChildrenApiService MeDriveRootChildrenApi service.
MeDrivesApiService MeDrivesApi service.
MeUserApiService MeUserApi service.
ServerConfigurations stores multiple ServerConfiguration items.
UserApiService UserApi service.
UsersApiService UsersApi service.