diff --git a/changelog/unreleased/enhancement-use-beta-endpoint-for-single-drive-operations.md b/changelog/unreleased/enhancement-use-beta-endpoint-for-single-drive-operations.md new file mode 100644 index 00000000000..1d5f1464f43 --- /dev/null +++ b/changelog/unreleased/enhancement-use-beta-endpoint-for-single-drive-operations.md @@ -0,0 +1,6 @@ +Enhancement: Use beta endpoint for single drive operations + +We've updated the single drive operations to use the v1 beta endpoint. +This allows us to drop custom hardcoded logic for converting drive permissions. + +https://github.com/owncloud/web/pull/13412 diff --git a/packages/web-client/src/graph/drives/drives.ts b/packages/web-client/src/graph/drives/drives.ts index 48ab7366e95..f43cdf089b8 100644 --- a/packages/web-client/src/graph/drives/drives.ts +++ b/packages/web-client/src/graph/drives/drives.ts @@ -5,25 +5,6 @@ import type { GraphDrives } from './types' const getServerUrlFromDrive = (drive: Drive) => new URL(drive.webUrl).origin -const roleIdv1Tov2Map = { - manager: '312c0871-5ef7-4b3a-85b6-0e4074c64049', - editor: '58c63c02-1d89-4572-916a-870abc5a1b7d', - viewer: 'a8d5fe5e-96e3-418d-825b-534dbdf22b99' -} - -// FIXME: convert old v1 drive to v2 drive. remove with https://github.com/owncloud/ocis/issues/9884 -const v1Tov2Drive = (drive: Drive) => { - drive.root?.permissions?.forEach((p) => { - p.grantedToV2 = p.grantedToV2 || p.grantedToIdentities?.[0] - delete p.grantedToIdentities - const oldRole = p.roles[0] - if (oldRole) { - p.roles[0] = roleIdv1Tov2Map[oldRole] - } - }) - return drive -} - export const DrivesFactory = ({ axiosClient, config }: GraphFactoryOptions): GraphDrives => { const drivesApiFactory = DrivesApiFactory(config, config.basePath, axiosClient) const meDrivesApi = new MeDrivesApi(config, config.basePath, axiosClient) @@ -31,29 +12,26 @@ export const DrivesFactory = ({ axiosClient, config }: GraphFactoryOptions): Gra return { async getDrive(id, graphRoles, requestOptions) { - let { data: drive } = await drivesApiFactory.getDrive(id, requestOptions) - drive = v1Tov2Drive(drive) + const { data: drive } = await drivesApiFactory.getDriveBeta(id, requestOptions) return buildSpace({ ...drive, serverUrl: getServerUrlFromDrive(drive) }, graphRoles) }, async createDrive(data, graphRoles, requestOptions) { - let { data: drive } = await drivesApiFactory.createDrive(data, requestOptions) - drive = v1Tov2Drive(drive) + const { data: drive } = await drivesApiFactory.createDriveBeta(data, requestOptions) return buildSpace({ ...drive, serverUrl: getServerUrlFromDrive(drive) }, graphRoles) }, async updateDrive(id, data, graphRoles, requestOptions) { - let { data: drive } = await drivesApiFactory.updateDrive(id, data, requestOptions) - drive = v1Tov2Drive(drive) + const { data: drive } = await drivesApiFactory.updateDriveBeta(id, data, requestOptions) return buildSpace({ ...drive, serverUrl: getServerUrlFromDrive(drive) }, graphRoles) }, async disableDrive(id, ifMatch, requestOptions) { - await drivesApiFactory.deleteDrive(id, ifMatch, requestOptions) + await drivesApiFactory.deleteDriveBeta(id, ifMatch, requestOptions) }, async deleteDrive(id, ifMatch, requestOptions) { - await drivesApiFactory.deleteDrive(id, ifMatch, { + await drivesApiFactory.deleteDriveBeta(id, ifMatch, { headers: { ...((requestOptions?.headers && requestOptions.headers) || {}), Purge: 'T' diff --git a/packages/web-client/src/graph/generated/.openapi-generator/FILES b/packages/web-client/src/graph/generated/.openapi-generator/FILES index 16b445eee6d..fd8f04e82f7 100644 --- a/packages/web-client/src/graph/generated/.openapi-generator/FILES +++ b/packages/web-client/src/graph/generated/.openapi-generator/FILES @@ -5,5 +5,107 @@ api.ts base.ts common.ts configuration.ts +docs/ActivitiesApi.md +docs/Activity.md +docs/ActivityTemplate.md +docs/ActivityTimes.md +docs/AppRole.md +docs/AppRoleAssignment.md +docs/Application.md +docs/ApplicationsApi.md +docs/Audio.md +docs/ClassMemberReference.md +docs/ClassReference.md +docs/ClassTeacherReference.md +docs/CollectionOfActivities.md +docs/CollectionOfAppRoleAssignments.md +docs/CollectionOfApplications.md +docs/CollectionOfClass.md +docs/CollectionOfDriveItems.md +docs/CollectionOfDriveItems1.md +docs/CollectionOfDrives.md +docs/CollectionOfDrives1.md +docs/CollectionOfEducationClass.md +docs/CollectionOfEducationUser.md +docs/CollectionOfGroup.md +docs/CollectionOfPermissions.md +docs/CollectionOfPermissionsWithAllowedValues.md +docs/CollectionOfSchools.md +docs/CollectionOfTags.md +docs/CollectionOfUser.md +docs/CollectionOfUsers.md +docs/Deleted.md +docs/Drive.md +docs/DriveItem.md +docs/DriveItemApi.md +docs/DriveItemCreateLink.md +docs/DriveItemInvite.md +docs/DriveRecipient.md +docs/DriveUpdate.md +docs/DrivesApi.md +docs/DrivesGetDrivesApi.md +docs/DrivesPermissionsApi.md +docs/DrivesRootApi.md +docs/EducationClass.md +docs/EducationClassApi.md +docs/EducationClassTeachersApi.md +docs/EducationSchool.md +docs/EducationSchoolApi.md +docs/EducationUser.md +docs/EducationUserApi.md +docs/EducationUserReference.md +docs/ExportPersonalDataRequest.md +docs/FileSystemInfo.md +docs/Folder.md +docs/FolderView.md +docs/GeoCoordinates.md +docs/Group.md +docs/GroupApi.md +docs/GroupsApi.md +docs/Hashes.md +docs/Identity.md +docs/IdentitySet.md +docs/Image.md +docs/ItemReference.md +docs/MeChangepasswordApi.md +docs/MeDriveApi.md +docs/MeDriveRootApi.md +docs/MeDriveRootChildrenApi.md +docs/MeDrivesApi.md +docs/MeUserApi.md +docs/MemberReference.md +docs/ObjectIdentity.md +docs/OdataError.md +docs/OdataErrorDetail.md +docs/OdataErrorMain.md +docs/OpenGraphFile.md +docs/PasswordChange.md +docs/PasswordProfile.md +docs/Permission.md +docs/Photo.md +docs/Quota.md +docs/RemoteItem.md +docs/RoleManagementApi.md +docs/SharePointIdentitySet.md +docs/SharingInvitation.md +docs/SharingLink.md +docs/SharingLinkPassword.md +docs/SharingLinkType.md +docs/SignInActivity.md +docs/SpecialFolder.md +docs/TagAssignment.md +docs/TagUnassignment.md +docs/TagsApi.md +docs/Thumbnail.md +docs/ThumbnailSet.md +docs/Trash.md +docs/UnifiedRoleDefinition.md +docs/UnifiedRolePermission.md +docs/User.md +docs/UserApi.md +docs/UserAppRoleAssignmentApi.md +docs/UserUpdate.md +docs/UsersApi.md +docs/Video.md git_push.sh index.ts diff --git a/packages/web-client/src/graph/generated/.openapi-generator/VERSION b/packages/web-client/src/graph/generated/.openapi-generator/VERSION index 6116b14d2c5..909dcd0eca6 100644 --- a/packages/web-client/src/graph/generated/.openapi-generator/VERSION +++ b/packages/web-client/src/graph/generated/.openapi-generator/VERSION @@ -1 +1 @@ -7.8.0-SNAPSHOT +7.19.0-SNAPSHOT diff --git a/packages/web-client/src/graph/generated/api.ts b/packages/web-client/src/graph/generated/api.ts index c1e7b540bcf..0c0c2f0645a 100644 --- a/packages/web-client/src/graph/generated/api.ts +++ b/packages/web-client/src/graph/generated/api.ts @@ -25,1148 +25,529 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Represents activity. - * @export - * @interface Activity */ export interface Activity { /** * Activity ID. - * @type {string} - * @memberof Activity */ 'id': string; - /** - * - * @type {ActivityTimes} - * @memberof Activity - */ 'times': ActivityTimes; - /** - * - * @type {ActivityTemplate} - * @memberof Activity - */ 'template': ActivityTemplate; } -/** - * - * @export - * @interface ActivityTemplate - */ export interface ActivityTemplate { /** * Activity description. - * @type {string} - * @memberof ActivityTemplate */ 'message': string; /** * Activity description variables. - * @type {object} - * @memberof ActivityTemplate */ 'variables'?: object; } -/** - * - * @export - * @interface ActivityTimes - */ export interface ActivityTimes { /** * Timestamp of the activity. - * @type {string} - * @memberof ActivityTimes */ 'recordedTime': string; } -/** - * - * @export - * @interface AppRole - */ export interface AppRole { /** * Specifies whether this app role can be assigned to users and groups (by setting to [\'User\']), to other application\'s (by setting to [\'Application\'], or both (by setting to [\'User\', \'Application\']). App roles supporting assignment to other applications\' service principals are also known as application permissions. The \'Application\' value is only supported for app roles defined on application entities. - * @type {Array} - * @memberof AppRole */ 'allowedMemberTypes'?: Array; /** * The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. - * @type {string} - * @memberof AppRole */ 'description'?: string | null; /** * Display name for the permission that appears in the app role assignment and consent experiences. - * @type {string} - * @memberof AppRole */ 'displayName'?: string | null; /** * Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided. - * @type {string} - * @memberof AppRole */ 'id': string; } -/** - * - * @export - * @interface AppRoleAssignment - */ export interface AppRoleAssignment { /** * The unique identifier for the object. 12345678-9abc-def0-1234-56789abcde. The value of the ID property is often, but not exclusively, in the form of a GUID. The value should be treated as an opaque identifier and not based in being a GUID. Null values are not allowed. Read-only. - * @type {string} - * @memberof AppRoleAssignment */ 'id'?: string; - /** - * - * @type {string} - * @memberof AppRoleAssignment - */ 'deletedDateTime'?: string; /** * The identifier (id) for the app role which is assigned to the user. Required on create. - * @type {string} - * @memberof AppRoleAssignment */ 'appRoleId': string; /** * The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. - * @type {string} - * @memberof AppRoleAssignment */ 'createdDateTime'?: string | null; /** * The display name of the user, group, or service principal that was granted the app role assignment. Read-only. - * @type {string} - * @memberof AppRoleAssignment */ 'principalDisplayName'?: string | null; /** * The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create. - * @type {string} - * @memberof AppRoleAssignment */ 'principalId': string | null; /** * The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only. - * @type {string} - * @memberof AppRoleAssignment */ 'principalType'?: string | null; /** * The display name of the resource app\'s service principal to which the assignment is made. - * @type {string} - * @memberof AppRoleAssignment */ 'resourceDisplayName'?: string | null; /** * The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. - * @type {string} - * @memberof AppRoleAssignment */ 'resourceId': string | null; } -/** - * - * @export - * @interface Application - */ export interface Application { /** * The unique identifier for the object. 12345678-9abc-def0-1234-56789abcde. The value of the ID property is often, but not exclusively, in the form of a GUID. The value should be treated as an opaque identifier and not based in being a GUID. Null values are not allowed. Read-only. - * @type {string} - * @memberof Application */ 'id': string; /** * The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. - * @type {Array} - * @memberof Application */ 'appRoles'?: Array; /** * The display name for the application. - * @type {string} - * @memberof Application */ 'displayName'?: string | null; } /** * The Audio resource groups audio-related properties on an item into a single structure. If a DriveItem has a non-null audio facet, the item represents an audio file. The properties of the Audio resource are populated by extracting metadata from the file. - * @export - * @interface Audio */ export interface Audio { /** * The title of the album for this audio file. - * @type {string} - * @memberof Audio */ 'album'?: string; /** * The artist named on the album for the audio file. - * @type {string} - * @memberof Audio */ 'albumArtist'?: string; /** * The performing artist for the audio file. - * @type {string} - * @memberof Audio */ 'artist'?: string; /** * Bitrate expressed in kbps. - * @type {number} - * @memberof Audio */ 'bitrate'?: number; /** * The name of the composer of the audio file. - * @type {string} - * @memberof Audio */ 'composers'?: string; /** * Copyright information for the audio file. - * @type {string} - * @memberof Audio */ 'copyright'?: string; /** * The number of the disc this audio file came from. - * @type {number} - * @memberof Audio */ 'disc'?: number; /** * The total number of discs in this album. - * @type {number} - * @memberof Audio */ 'discCount'?: number; /** * Duration of the audio file, expressed in milliseconds - * @type {number} - * @memberof Audio */ 'duration'?: number; /** * The genre of this audio file. - * @type {string} - * @memberof Audio */ 'genre'?: string; /** * Indicates if the file is protected with digital rights management. - * @type {boolean} - * @memberof Audio */ 'hasDrm'?: boolean; /** * Indicates if the file is encoded with a variable bitrate. - * @type {boolean} - * @memberof Audio */ 'isVariableBitrate'?: boolean; /** * The title of the audio file. - * @type {string} - * @memberof Audio */ 'title'?: string; /** * The number of the track on the original disc for this audio file. - * @type {number} - * @memberof Audio */ 'track'?: number; /** * The total number of tracks on the original disc for this audio file. - * @type {number} - * @memberof Audio */ 'trackCount'?: number; /** * The year the audio file was recorded. - * @type {number} - * @memberof Audio */ 'year'?: number; } -/** - * - * @export - * @interface ClassMemberReference - */ export interface ClassMemberReference { - /** - * - * @type {string} - * @memberof ClassMemberReference - */ '@odata.id'?: string; } -/** - * - * @export - * @interface ClassReference - */ export interface ClassReference { - /** - * - * @type {string} - * @memberof ClassReference - */ '@odata.id'?: string; } -/** - * - * @export - * @interface ClassTeacherReference - */ export interface ClassTeacherReference { - /** - * - * @type {string} - * @memberof ClassTeacherReference - */ '@odata.id'?: string; } -/** - * - * @export - * @interface CollectionOfActivities - */ export interface CollectionOfActivities { - /** - * - * @type {Array} - * @memberof CollectionOfActivities - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfAppRoleAssignments - */ export interface CollectionOfAppRoleAssignments { - /** - * - * @type {Array} - * @memberof CollectionOfAppRoleAssignments - */ 'value'?: Array; - /** - * - * @type {string} - * @memberof CollectionOfAppRoleAssignments - */ '@odata.nextLink'?: string; } -/** - * - * @export - * @interface CollectionOfApplications - */ export interface CollectionOfApplications { - /** - * - * @type {Array} - * @memberof CollectionOfApplications - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfClass - */ export interface CollectionOfClass { - /** - * - * @type {Array} - * @memberof CollectionOfClass - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfDriveItems - */ export interface CollectionOfDriveItems { - /** - * - * @type {Array} - * @memberof CollectionOfDriveItems - */ 'value'?: Array; - /** - * - * @type {string} - * @memberof CollectionOfDriveItems - */ '@odata.nextLink'?: string; } -/** - * - * @export - * @interface CollectionOfDriveItems1 - */ export interface CollectionOfDriveItems1 { - /** - * - * @type {Array} - * @memberof CollectionOfDriveItems1 - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfDrives - */ export interface CollectionOfDrives { - /** - * - * @type {Array} - * @memberof CollectionOfDrives - */ 'value'?: Array; - /** - * - * @type {string} - * @memberof CollectionOfDrives - */ '@odata.nextLink'?: string; } -/** - * - * @export - * @interface CollectionOfDrives1 - */ export interface CollectionOfDrives1 { - /** - * - * @type {Array} - * @memberof CollectionOfDrives1 - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfEducationClass - */ export interface CollectionOfEducationClass { - /** - * - * @type {Array} - * @memberof CollectionOfEducationClass - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfEducationUser - */ export interface CollectionOfEducationUser { - /** - * - * @type {Array} - * @memberof CollectionOfEducationUser - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfGroup - */ export interface CollectionOfGroup { - /** - * - * @type {Array} - * @memberof CollectionOfGroup - */ 'value'?: Array; - /** - * - * @type {string} - * @memberof CollectionOfGroup - */ '@odata.nextLink'?: string; } -/** - * - * @export - * @interface CollectionOfPermissions - */ export interface CollectionOfPermissions { - /** - * - * @type {Array} - * @memberof CollectionOfPermissions - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfPermissionsWithAllowedValues - */ export interface CollectionOfPermissionsWithAllowedValues { /** * A list of role definitions that can be chosen for the resource. - * @type {Array} - * @memberof CollectionOfPermissionsWithAllowedValues */ '@libre.graph.permissions.roles.allowedValues'?: Array; /** * A list of actions that can be chosen for a custom role. Following the CS3 API we can represent the CS3 permissions by mapping them to driveItem properties or relations like this: | [CS3 ResourcePermission](https://cs3org.github.io/cs3apis/#cs3.storage.provider.v1beta1.ResourcePermissions) | action | comment | | ------------------------------------------------------------------------------------------------------------ | ------ | ------- | | `stat` | `libre.graph/driveItem/basic/read` | `basic` because it does not include versions or trashed items | | `get_quota` | `libre.graph/driveItem/quota/read` | read only the `quota` property | | `get_path` | `libre.graph/driveItem/path/read` | read only the `path` property | | `move` | `libre.graph/driveItem/path/update` | allows updating the `path` property of a CS3 resource | | `delete` | `libre.graph/driveItem/standard/delete` | `standard` because deleting is a common update operation | | `list_container` | `libre.graph/driveItem/children/read` | | | `create_container` | `libre.graph/driveItem/children/create` | | | `initiate_file_download` | `libre.graph/driveItem/content/read` | `content` is the property read when initiating a download | | `initiate_file_upload` | `libre.graph/driveItem/upload/create` | `uploads` are a separate property. postprocessing creates the `content` | | `add_grant` | `libre.graph/driveItem/permissions/create` | | | `list_grant` | `libre.graph/driveItem/permissions/read` | | | `update_grant` | `libre.graph/driveItem/permissions/update` | | | `remove_grant` | `libre.graph/driveItem/permissions/delete` | | | `deny_grant` | `libre.graph/driveItem/permissions/deny` | uses a non CRUD action `deny` | | `list_file_versions` | `libre.graph/driveItem/versions/read` | `versions` is a `driveItemVersion` collection | | `restore_file_version` | `libre.graph/driveItem/versions/update` | the only `update` action is restore | | `list_recycle` | `libre.graph/driveItem/deleted/read` | reading a driveItem `deleted` property implies listing | | `restore_recycle_item` | `libre.graph/driveItem/deleted/update` | the only `update` action is restore | | `purge_recycle` | `libre.graph/driveItem/deleted/delete` | allows purging deleted `driveItems` | - * @type {Array} - * @memberof CollectionOfPermissionsWithAllowedValues */ '@libre.graph.permissions.actions.allowedValues'?: Array; - /** - * - * @type {Array} - * @memberof CollectionOfPermissionsWithAllowedValues - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfSchools - */ export interface CollectionOfSchools { - /** - * - * @type {Array} - * @memberof CollectionOfSchools - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfTags - */ export interface CollectionOfTags { - /** - * - * @type {Array} - * @memberof CollectionOfTags - */ 'value'?: Array; } -/** - * - * @export - * @interface CollectionOfUser - */ export interface CollectionOfUser { - /** - * - * @type {Array} - * @memberof CollectionOfUser - */ 'value'?: Array; - /** - * - * @type {string} - * @memberof CollectionOfUser - */ '@odata.nextLink'?: string; } -/** - * - * @export - * @interface CollectionOfUsers - */ export interface CollectionOfUsers { - /** - * - * @type {Array} - * @memberof CollectionOfUsers - */ 'value'?: Array; } /** * Information about the deleted state of the item. Read-only. - * @export - * @interface Deleted */ export interface Deleted { /** * Represents the state of the deleted item. - * @type {string} - * @memberof Deleted */ 'state'?: string; } /** * The drive represents a space on the storage. - * @export - * @interface Drive */ export interface Drive { /** * The unique identifier for this drive. - * @type {string} - * @memberof Drive */ 'id'?: string; - /** - * - * @type {IdentitySet} - * @memberof Drive - */ 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. - * @type {string} - * @memberof Drive */ 'createdDateTime'?: string; /** * Provides a user-visible description of the item. Optional. - * @type {string} - * @memberof Drive */ 'description'?: string; /** * ETag for the item. Read-only. - * @type {string} - * @memberof Drive */ 'eTag'?: string; - /** - * - * @type {IdentitySet} - * @memberof Drive - */ 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. - * @type {string} - * @memberof Drive */ 'lastModifiedDateTime'?: string; /** * The name of the item. Read-write. - * @type {string} - * @memberof Drive */ 'name': string; - /** - * - * @type {ItemReference} - * @memberof Drive - */ 'parentReference'?: ItemReference; /** * URL that displays the resource in the browser. Read-only. - * @type {string} - * @memberof Drive */ 'webUrl'?: string; /** * Describes the type of drive represented by this resource. Values are \"personal\" for users home spaces, \"project\", \"virtual\" or \"share\". Read-only. - * @type {string} - * @memberof Drive */ 'driveType'?: string; /** * The drive alias can be used in clients to make the urls user friendly. Example: \'personal/einstein\'. This will be used to resolve to the correct driveID. - * @type {string} - * @memberof Drive */ 'driveAlias'?: string; - /** - * - * @type {IdentitySet} - * @memberof Drive - */ 'owner'?: IdentitySet; - /** - * - * @type {Quota} - * @memberof Drive - */ 'quota'?: Quota; /** * All items contained in the drive. Read-only. Nullable. - * @type {Array} - * @memberof Drive */ 'items'?: Array; - /** - * - * @type {DriveItem} - * @memberof Drive - */ 'root'?: DriveItem; /** * A collection of special drive resources. - * @type {Array} - * @memberof Drive */ 'special'?: Array; } /** * Represents a resource inside a drive. Read-only. - * @export - * @interface DriveItem */ export interface DriveItem { /** * Read-only. - * @type {string} - * @memberof DriveItem */ 'id'?: string; - /** - * - * @type {IdentitySet} - * @memberof DriveItem - */ 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. - * @type {string} - * @memberof DriveItem */ 'createdDateTime'?: string; /** * Provides a user-visible description of the item. Optional. - * @type {string} - * @memberof DriveItem */ 'description'?: string; /** * ETag for the item. Read-only. - * @type {string} - * @memberof DriveItem */ 'eTag'?: string; - /** - * - * @type {IdentitySet} - * @memberof DriveItem - */ 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. - * @type {string} - * @memberof DriveItem */ 'lastModifiedDateTime'?: string; /** * The name of the item. Read-write. - * @type {string} - * @memberof DriveItem */ 'name'?: string; - /** - * - * @type {ItemReference} - * @memberof DriveItem - */ 'parentReference'?: ItemReference; /** * URL that displays the resource in the browser. Read-only. - * @type {string} - * @memberof DriveItem */ 'webUrl'?: string; /** * The content stream, if the item represents a file. - * @type {string} - * @memberof DriveItem */ 'content'?: string; /** * An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only. - * @type {string} - * @memberof DriveItem */ 'cTag'?: string; - /** - * - * @type {Deleted} - * @memberof DriveItem - */ 'deleted'?: Deleted; - /** - * - * @type {OpenGraphFile} - * @memberof DriveItem - */ 'file'?: OpenGraphFile; - /** - * - * @type {FileSystemInfo} - * @memberof DriveItem - */ 'fileSystemInfo'?: FileSystemInfo; - /** - * - * @type {Folder} - * @memberof DriveItem - */ 'folder'?: Folder; - /** - * - * @type {Image} - * @memberof DriveItem - */ 'image'?: Image; - /** - * - * @type {Photo} - * @memberof DriveItem - */ 'photo'?: Photo; - /** - * - * @type {GeoCoordinates} - * @memberof DriveItem - */ 'location'?: GeoCoordinates; /** * Collection containing ThumbnailSet objects associated with the item. Read-only. Nullable. - * @type {Array} - * @memberof DriveItem */ 'thumbnails'?: Array; /** * If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. - * @type {object} - * @memberof DriveItem */ 'root'?: object; - /** - * - * @type {Trash} - * @memberof DriveItem - */ 'trash'?: Trash; - /** - * - * @type {SpecialFolder} - * @memberof DriveItem - */ 'specialFolder'?: SpecialFolder; - /** - * - * @type {RemoteItem} - * @memberof DriveItem - */ 'remoteItem'?: RemoteItem; /** * Size of the item in bytes. Read-only. - * @type {number} - * @memberof DriveItem */ 'size'?: number; /** * WebDAV compatible URL for the item. Read-only. - * @type {string} - * @memberof DriveItem */ 'webDavUrl'?: string; /** * Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable. - * @type {Array} - * @memberof DriveItem */ 'children'?: Array; /** * The set of permissions for the item. Read-only. Nullable. - * @type {Array} - * @memberof DriveItem */ 'permissions'?: Array; - /** - * - * @type {Audio} - * @memberof DriveItem - */ 'audio'?: Audio; - /** - * - * @type {Video} - * @memberof DriveItem - */ 'video'?: Video; /** * Indicates if the item is synchronized with the underlying storage provider. Read-only. - * @type {boolean} - * @memberof DriveItem */ '@client.synchronize'?: boolean; /** * Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true. Users can set this to hide permissions. - * @type {boolean} - * @memberof DriveItem */ '@UI.Hidden'?: boolean; } -/** - * - * @export - * @interface DriveItemCreateLink - */ export interface DriveItemCreateLink { - /** - * - * @type {SharingLinkType} - * @memberof DriveItemCreateLink - */ 'type'?: SharingLinkType; /** * Optional. A String with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission. - * @type {string} - * @memberof DriveItemCreateLink */ 'expirationDateTime'?: string; /** * Optional.The password of the sharing link that is set by the creator. - * @type {string} - * @memberof DriveItemCreateLink */ 'password'?: string; /** * Provides a user-visible display name of the link. Optional. Libregraph only. - * @type {string} - * @memberof DriveItemCreateLink */ 'displayName'?: string; /** * The quicklink property can be assigned to only one link per resource. A quicklink can be used in the clients to provide a one-click copy to clipboard action. Optional. Libregraph only. - * @type {boolean} - * @memberof DriveItemCreateLink */ '@libre.graph.quickLink'?: boolean; } -/** - * - * @export - * @interface DriveItemInvite - */ export interface DriveItemInvite { /** * A collection of recipients who will receive access and the sharing invitation. Currently, only internal users or groups are supported. - * @type {Array} - * @memberof DriveItemInvite */ 'recipients'?: Array; /** * Specifies the roles that are to be granted to the recipients of the sharing invitation. - * @type {Array} - * @memberof DriveItemInvite */ 'roles'?: Array; /** * Specifies the actions that are to be granted to the recipients of the sharing invitation, in effect creating a custom role. - * @type {Array} - * @memberof DriveItemInvite */ '@libre.graph.permissions.actions'?: Array; /** * Specifies the dateTime after which the permission expires. - * @type {string} - * @memberof DriveItemInvite */ 'expirationDateTime'?: string; } /** * Represents a person, group, or other recipient to share a drive item with using the invite action. When using invite to add permissions, the `driveRecipient` object would specify the `email`, `alias`, or `objectId` of the recipient. Only one of these values is required; multiple values are not accepted. - * @export - * @interface DriveRecipient */ export interface DriveRecipient { /** * The unique identifier for the recipient in the directory. - * @type {string} - * @memberof DriveRecipient */ 'objectId'?: string; /** * When the recipient is referenced by objectId this annotation is used to differentiate `user` and `group` recipients. - * @type {string} - * @memberof DriveRecipient */ '@libre.graph.recipient.type'?: string; } /** * The drive represents an update to a space on the storage. - * @export - * @interface DriveUpdate */ export interface DriveUpdate { /** * The unique identifier for this drive. - * @type {string} - * @memberof DriveUpdate */ 'id'?: string; - /** - * - * @type {IdentitySet} - * @memberof DriveUpdate - */ 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. - * @type {string} - * @memberof DriveUpdate */ 'createdDateTime'?: string; /** * Provides a user-visible description of the item. Optional. - * @type {string} - * @memberof DriveUpdate */ 'description'?: string; /** * ETag for the item. Read-only. - * @type {string} - * @memberof DriveUpdate */ 'eTag'?: string; - /** - * - * @type {IdentitySet} - * @memberof DriveUpdate - */ 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. - * @type {string} - * @memberof DriveUpdate */ 'lastModifiedDateTime'?: string; /** * The name of the item. Read-write. - * @type {string} - * @memberof DriveUpdate */ 'name'?: string; - /** - * - * @type {ItemReference} - * @memberof DriveUpdate - */ 'parentReference'?: ItemReference; /** * URL that displays the resource in the browser. Read-only. - * @type {string} - * @memberof DriveUpdate */ 'webUrl'?: string; /** * Describes the type of drive represented by this resource. Values are \"personal\" for users home spaces, \"project\", \"virtual\" or \"share\". Read-only. - * @type {string} - * @memberof DriveUpdate */ 'driveType'?: string; /** * The drive alias can be used in clients to make the urls user friendly. Example: \'personal/einstein\'. This will be used to resolve to the correct driveID. - * @type {string} - * @memberof DriveUpdate */ 'driveAlias'?: string; - /** - * - * @type {IdentitySet} - * @memberof DriveUpdate - */ 'owner'?: IdentitySet; - /** - * - * @type {Quota} - * @memberof DriveUpdate - */ 'quota'?: Quota; /** * All items contained in the drive. Read-only. Nullable. - * @type {Array} - * @memberof DriveUpdate */ 'items'?: Array; - /** - * - * @type {DriveItem} - * @memberof DriveUpdate - */ 'root'?: DriveItem; /** * A collection of special drive resources. - * @type {Array} - * @memberof DriveUpdate */ 'special'?: Array; } /** * And extension of group representing a class or course - * @export - * @interface EducationClass */ export interface EducationClass { /** * Read-only. - * @type {string} - * @memberof EducationClass */ 'id'?: string; /** * An optional description for the group. Returned by default. - * @type {string} - * @memberof EducationClass */ 'description'?: string; /** * The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $search and $orderBy. - * @type {string} - * @memberof EducationClass */ - 'displayName': string; + 'displayName'?: string; /** * Users and groups that are members of this group. HTTP Methods: GET (supported for all groups), Nullable. Supports $expand. - * @type {Array} - * @memberof EducationClass */ 'members'?: Array; /** * A list of member references to the members to be added. Up to 20 members can be added with a single request - * @type {Set} - * @memberof EducationClass */ 'members@odata.bind'?: Set; /** * Classification of the group, i.e. \"class\" or \"course\" - * @type {string} - * @memberof EducationClass */ - 'classification': EducationClassClassificationEnum; + 'classification'?: EducationClassClassificationEnum; /** * An external unique ID for the class - * @type {string} - * @memberof EducationClass */ 'externalId'?: string; } @@ -1180,967 +561,518 @@ export type EducationClassClassificationEnum = typeof EducationClassClassificati /** * Represents a school - * @export - * @interface EducationSchool */ export interface EducationSchool { /** * The unique identifier for an entity. Read-only. - * @type {string} - * @memberof EducationSchool */ 'id'?: string; /** * The organization name - * @type {string} - * @memberof EducationSchool */ 'displayName'?: string; /** * School number - * @type {string} - * @memberof EducationSchool */ 'schoolNumber'?: string; /** * Date and time at which the service for this organization is scheduled to be terminated - * @type {string} - * @memberof EducationSchool */ 'terminationDate'?: string | null; } /** * An extension of user with education-specific attributes - * @export - * @interface EducationUser */ export interface EducationUser { /** * Read-only. - * @type {string} - * @memberof EducationUser */ 'id'?: string; /** * Set to \"true\" when the account is enabled. - * @type {boolean} - * @memberof EducationUser */ 'accountEnabled'?: boolean; /** * The name displayed in the address book for the user. This value is usually the combination of the user\'s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Returned by default. Supports $orderby. - * @type {string} - * @memberof EducationUser */ 'displayName'?: string; /** * A collection of drives available for this user. Read-only. - * @type {Array} - * @memberof EducationUser */ 'drives'?: Array; - /** - * - * @type {Drive} - * @memberof EducationUser - */ 'drive'?: Drive; /** * Identities associated with this account. - * @type {Array} - * @memberof EducationUser */ 'identities'?: Array; /** * The SMTP address for the user, for example, \'jeff@contoso.onowncloud.com\'. Returned by default. - * @type {string} - * @memberof EducationUser */ 'mail'?: string; /** * Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. - * @type {Array} - * @memberof EducationUser */ 'memberOf'?: Array; /** * Contains the on-premises SAM account name synchronized from the on-premises directory. Read-only. - * @type {string} - * @memberof EducationUser */ 'onPremisesSamAccountName'?: string; - /** - * - * @type {PasswordProfile} - * @memberof EducationUser - */ 'passwordProfile'?: PasswordProfile; /** * The user\'s surname (family name or last name). Returned by default. - * @type {string} - * @memberof EducationUser */ 'surname'?: string; /** * The user\'s givenName. Returned by default. - * @type {string} - * @memberof EducationUser */ 'givenName'?: string; /** * The user`s default role. Such as \"student\" or \"teacher\" - * @type {string} - * @memberof EducationUser */ 'primaryRole'?: string; /** * The user`s type. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. - * @type {string} - * @memberof EducationUser */ 'userType'?: string; -} -/** - * - * @export - * @interface EducationUserReference - */ -export interface EducationUserReference { /** - * - * @type {string} - * @memberof EducationUserReference + * A unique identifier for the user assigned by the school or institution. */ + 'externalID'?: string; +} +export interface EducationUserReference { '@odata.id'?: string; } -/** - * - * @export - * @interface ExportPersonalDataRequest - */ export interface ExportPersonalDataRequest { /** * the path where the file should be created in the users personal space - * @type {string} - * @memberof ExportPersonalDataRequest */ 'storageLocation'?: string; } /** * File system information on client. Read-write. - * @export - * @interface FileSystemInfo */ export interface FileSystemInfo { /** * The UTC date and time the file was created on a client. - * @type {string} - * @memberof FileSystemInfo */ 'createdDateTime'?: string; /** * The UTC date and time the file was last accessed. Available for the recent file list only. - * @type {string} - * @memberof FileSystemInfo */ 'lastAccessedDateTime'?: string; /** * The UTC date and time the file was last modified on a client. - * @type {string} - * @memberof FileSystemInfo */ 'lastModifiedDateTime'?: string; } /** * Folder metadata, if the item is a folder. Read-only. - * @export - * @interface Folder */ export interface Folder { /** * Number of children contained immediately within this container. - * @type {number} - * @memberof Folder */ 'childCount'?: number; - /** - * - * @type {FolderView} - * @memberof Folder - */ 'view'?: FolderView; } /** * A collection of properties defining the recommended view for the folder. - * @export - * @interface FolderView */ export interface FolderView { /** * The method by which the folder should be sorted. - * @type {string} - * @memberof FolderView */ 'sortBy'?: string; /** * If true, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending. - * @type {string} - * @memberof FolderView */ 'sortOrder'?: string; /** * The type of view that should be used to represent the folder. - * @type {string} - * @memberof FolderView */ 'viewType'?: string; } /** * The GeoCoordinates resource provides geographic coordinates and elevation of a location based on metadata contained within the file. If a DriveItem has a non-null location facet, the item represents a file with a known location associated with it. - * @export - * @interface GeoCoordinates */ export interface GeoCoordinates { /** * The altitude (height), in feet, above sea level for the item. Read-only. - * @type {number} - * @memberof GeoCoordinates */ 'altitude'?: number; /** * The latitude, in decimal, for the item. Read-only. - * @type {number} - * @memberof GeoCoordinates */ 'latitude'?: number; /** * The longitude, in decimal, for the item. Read-only. - * @type {number} - * @memberof GeoCoordinates */ 'longitude'?: number; } -/** - * - * @export - * @interface Group - */ export interface Group { /** * Read-only. - * @type {string} - * @memberof Group */ 'id'?: string; /** * An optional description for the group. Returned by default. - * @type {string} - * @memberof Group */ 'description'?: string; /** * The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $search and $orderBy. - * @type {string} - * @memberof Group */ 'displayName'?: string; /** * Specifies the group types. In MS Graph a group can have multiple types, so this is an array. In libreGraph the possible group types deviate from the MS Graph. The only group type that we currently support is \"ReadOnly\", which is set for groups that cannot be modified on the current instance. - * @type {Array} - * @memberof Group */ 'groupTypes'?: Array; /** * Users and groups that are members of this group. HTTP Methods: GET (supported for all groups), Nullable. Supports $expand. - * @type {Array} - * @memberof Group */ 'members'?: Array; /** * A list of member references to the members to be added. Up to 20 members can be added with a single request - * @type {Set} - * @memberof Group */ 'members@odata.bind'?: Set; } /** * Hashes of the file\'s binary content, if available. Read-only. - * @export - * @interface Hashes */ export interface Hashes { /** * The CRC32 value of the file (if available). Read-only. - * @type {string} - * @memberof Hashes */ 'crc32Hash'?: string; /** * A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available). Read-only. - * @type {string} - * @memberof Hashes */ 'quickXorHash'?: string; /** * SHA1 hash for the contents of the file (if available). Read-only. - * @type {string} - * @memberof Hashes */ 'sha1Hash'?: string; /** * SHA256 hash for the contents of the file (if available). Read-only. - * @type {string} - * @memberof Hashes */ 'sha256Hash'?: string; } -/** - * - * @export - * @interface Identity - */ export interface Identity { /** * The identity\'s display name. Note that this may not always be available or up to date. For example, if a user changes their display name, the API may show the new value in a future response, but the items associated with the user won\'t show up as having changed when using delta. - * @type {string} - * @memberof Identity */ 'displayName': string; /** * Unique identifier for the identity. - * @type {string} - * @memberof Identity */ 'id'?: string; /** - * The type of the identity. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. Can be used by clients to indicate the type of user. For more details, clients should look up and cache the user at the /users enpoint. - * @type {string} - * @memberof Identity + * The type of the identity. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. Can be used by clients to indicate the type of user. For more details, clients should look up and cache the user at the /users endpoint. */ '@libre.graph.userType'?: string; } /** * Optional. User account. - * @export - * @interface IdentitySet */ export interface IdentitySet { - /** - * - * @type {Identity} - * @memberof IdentitySet - */ 'application'?: Identity; - /** - * - * @type {Identity} - * @memberof IdentitySet - */ 'device'?: Identity; - /** - * - * @type {Identity} - * @memberof IdentitySet - */ 'user'?: Identity; - /** - * - * @type {Identity} - * @memberof IdentitySet - */ 'group'?: Identity; } /** * Image metadata, if the item is an image. Read-only. - * @export - * @interface Image */ export interface Image { /** * Optional. Height of the image, in pixels. Read-only. - * @type {number} - * @memberof Image */ 'height'?: number; /** * Optional. Width of the image, in pixels. Read-only. - * @type {number} - * @memberof Image */ 'width'?: number; } -/** - * - * @export - * @interface ItemReference - */ export interface ItemReference { /** * Unique identifier of the drive instance that contains the item. Read-only. - * @type {string} - * @memberof ItemReference */ 'driveId'?: string; /** * Identifies the type of drive. See [drive][] resource for values. Read-only. - * @type {string} - * @memberof ItemReference */ 'driveType'?: string; /** * Unique identifier of the item in the drive. Read-only. - * @type {string} - * @memberof ItemReference */ 'id'?: string; /** * The name of the item being referenced. Read-only. - * @type {string} - * @memberof ItemReference */ 'name'?: string; /** * Path that can be used to navigate to the item. Read-only. - * @type {string} - * @memberof ItemReference */ 'path'?: string; } -/** - * - * @export - * @interface MemberReference - */ export interface MemberReference { - /** - * - * @type {string} - * @memberof MemberReference - */ '@odata.id'?: string; } /** * Represents an identity used to sign in to a user account - * @export - * @interface ObjectIdentity */ export interface ObjectIdentity { /** * domain of the Provider issuing the identity - * @type {string} - * @memberof ObjectIdentity */ 'issuer'?: string; /** * The unique id assigned by the issuer to the account - * @type {string} - * @memberof ObjectIdentity */ 'issuerAssignedId'?: string; } -/** - * - * @export - * @interface OdataError - */ export interface OdataError { - /** - * - * @type {OdataErrorMain} - * @memberof OdataError - */ 'error': OdataErrorMain; -} -/** - * - * @export - * @interface OdataErrorDetail - */ +} export interface OdataErrorDetail { - /** - * - * @type {string} - * @memberof OdataErrorDetail - */ 'code': string; - /** - * - * @type {string} - * @memberof OdataErrorDetail - */ 'message': string; - /** - * - * @type {string} - * @memberof OdataErrorDetail - */ 'target'?: string; } -/** - * - * @export - * @interface OdataErrorMain - */ export interface OdataErrorMain { - /** - * - * @type {string} - * @memberof OdataErrorMain - */ 'code': string; - /** - * - * @type {string} - * @memberof OdataErrorMain - */ 'message': string; - /** - * - * @type {string} - * @memberof OdataErrorMain - */ 'target'?: string; - /** - * - * @type {Array} - * @memberof OdataErrorMain - */ 'details'?: Array; /** * The structure of this object is service-specific - * @type {object} - * @memberof OdataErrorMain */ 'innererror'?: object; } /** * File metadata, if the item is a file. Read-only. - * @export - * @interface OpenGraphFile */ export interface OpenGraphFile { - /** - * - * @type {Hashes} - * @memberof OpenGraphFile - */ 'hashes'?: Hashes; /** * The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only. - * @type {string} - * @memberof OpenGraphFile */ 'mimeType'?: string; - /** - * - * @type {boolean} - * @memberof OpenGraphFile - */ 'processingMetadata'?: boolean; } -/** - * - * @export - * @interface PasswordChange - */ export interface PasswordChange { - /** - * - * @type {string} - * @memberof PasswordChange - */ 'currentPassword': string; - /** - * - * @type {string} - * @memberof PasswordChange - */ 'newPassword': string; } /** * Password Profile associated with a user - * @export - * @interface PasswordProfile */ export interface PasswordProfile { /** * If true the user is required to change their password upon the next login - * @type {boolean} - * @memberof PasswordProfile */ 'forceChangePasswordNextSignIn'?: boolean; /** * The user\'s password - * @type {string} - * @memberof PasswordProfile */ 'password'?: string; } /** * The Permission resource provides information about a sharing permission granted for a DriveItem resource. ### Remarks The Permission resource uses *facets* to provide information about the kind of permission represented by the resource. Permissions with a `link` facet represent sharing links created on the item. Sharing links contain a unique token that provides access to the item for anyone with the link. Permissions with a `invitation` facet represent permissions added by inviting specific users or groups to have access to the file. - * @export - * @interface Permission */ export interface Permission { /** * The unique identifier of the permission among all permissions on the item. Read-only. - * @type {string} - * @memberof Permission */ 'id'?: string; /** * Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. - * @type {boolean} - * @memberof Permission */ 'hasPassword'?: boolean; /** * An optional expiration date which limits the permission in time. - * @type {string} - * @memberof Permission */ 'expirationDateTime'?: string | null; /** * An optional creation date. Libregraph only. - * @type {string} - * @memberof Permission */ 'createdDateTime'?: string | null; - /** - * - * @type {SharePointIdentitySet} - * @memberof Permission - */ 'grantedToV2'?: SharePointIdentitySet; - /** - * - * @type {SharingLink} - * @memberof Permission - */ 'link'?: SharingLink; - /** - * - * @type {Array} - * @memberof Permission - */ 'roles'?: Array; /** * For link type permissions, the details of the identity to whom permission was granted. This could be used to grant access to a an external user that can be identified by email, aka guest accounts. - * @type {Array} - * @memberof Permission * @deprecated */ 'grantedToIdentities'?: Array; /** * Use this to create a permission with custom actions. - * @type {Array} - * @memberof Permission */ '@libre.graph.permissions.actions'?: Array; - /** - * - * @type {SharingInvitation} - * @memberof Permission - */ 'invitation'?: SharingInvitation; } /** * The photo resource provides photo and camera properties, for example, EXIF metadata, on a driveItem. - * @export - * @interface Photo */ export interface Photo { /** * Camera manufacturer. Read-only. - * @type {string} - * @memberof Photo */ 'cameraMake'?: string; /** * Camera model. Read-only. - * @type {string} - * @memberof Photo */ 'cameraModel'?: string; /** * The denominator for the exposure time fraction from the camera. Read-only. - * @type {number} - * @memberof Photo */ 'exposureDenominator'?: number; /** * The numerator for the exposure time fraction from the camera. Read-only. - * @type {number} - * @memberof Photo */ 'exposureNumerator'?: number; /** * The F-stop value from the camera. Read-only. - * @type {number} - * @memberof Photo */ 'fNumber'?: number; /** * The focal length from the camera. Read-only. - * @type {number} - * @memberof Photo */ 'focalLength'?: number; /** * The ISO value from the camera. Read-only. - * @type {number} - * @memberof Photo */ 'iso'?: number; /** * The orientation value from the camera. Read-only. - * @type {number} - * @memberof Photo */ 'orientation'?: number; /** * Represents the date and time the photo was taken. Read-only. - * @type {string} - * @memberof Photo */ 'takenDateTime'?: string; } /** * Optional. Information about the drive\'s storage space quota. Read-only. - * @export - * @interface Quota */ export interface Quota { /** * Total space consumed by files in the recycle bin, in bytes. Read-only. - * @type {number} - * @memberof Quota */ 'deleted'?: number; /** * Total space remaining before reaching the quota limit, in bytes. Read-only. - * @type {number} - * @memberof Quota */ 'remaining'?: number; /** * Enumeration value that indicates the state of the storage space. Either \"normal\", \"nearing\", \"critical\" or \"exceeded\". Read-only. - * @type {string} - * @memberof Quota */ 'state'?: string; /** * Total allowed storage space, in bytes. Read-only. - * @type {number} - * @memberof Quota */ 'total'?: number; /** * Total space used, in bytes. Read-only. - * @type {number} - * @memberof Quota */ 'used'?: number; } /** * Remote item data, if the item is shared from a drive other than the one being accessed. Read-only. - * @export - * @interface RemoteItem */ export interface RemoteItem { - /** - * - * @type {IdentitySet} - * @memberof RemoteItem - */ 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. - * @type {string} - * @memberof RemoteItem */ 'createdDateTime'?: string; - /** - * - * @type {OpenGraphFile} - * @memberof RemoteItem - */ 'file'?: OpenGraphFile; - /** - * - * @type {FileSystemInfo} - * @memberof RemoteItem - */ 'fileSystemInfo'?: FileSystemInfo; - /** - * - * @type {Folder} - * @memberof RemoteItem - */ 'folder'?: Folder; /** * The drive alias can be used in clients to make the urls user friendly. Example: \'personal/einstein\'. This will be used to resolve to the correct driveID. - * @type {string} - * @memberof RemoteItem */ 'driveAlias'?: string; /** * The relative path of the item in relation to its drive root. - * @type {string} - * @memberof RemoteItem */ 'path'?: string; /** * Unique identifier for the drive root of this item. Read-only. - * @type {string} - * @memberof RemoteItem */ 'rootId'?: string; /** * Unique identifier for the remote item in its drive. Read-only. - * @type {string} - * @memberof RemoteItem */ 'id'?: string; - /** - * - * @type {Image} - * @memberof RemoteItem - */ 'image'?: Image; - /** - * - * @type {IdentitySet} - * @memberof RemoteItem - */ 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. - * @type {string} - * @memberof RemoteItem */ 'lastModifiedDateTime'?: string; /** * Optional. Filename of the remote item. Read-only. - * @type {string} - * @memberof RemoteItem */ 'name'?: string; /** * ETag for the item. Read-only. - * @type {string} - * @memberof RemoteItem */ 'eTag'?: string; /** * An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only. - * @type {string} - * @memberof RemoteItem */ 'cTag'?: string; - /** - * - * @type {ItemReference} - * @memberof RemoteItem - */ 'parentReference'?: ItemReference; /** * The set of permissions for the item. Read-only. Nullable. - * @type {Array} - * @memberof RemoteItem */ 'permissions'?: Array; /** * Size of the remote item. Read-only. - * @type {number} - * @memberof RemoteItem */ 'size'?: number; - /** - * - * @type {SpecialFolder} - * @memberof RemoteItem - */ 'specialFolder'?: SpecialFolder; /** * DAV compatible URL for the item. - * @type {string} - * @memberof RemoteItem */ 'webDavUrl'?: string; /** * URL that displays the resource in the browser. Read-only. - * @type {string} - * @memberof RemoteItem */ 'webUrl'?: string; } /** * This resource is used to represent a set of identities associated with various events for an item, such as created by or last modified by. - * @export - * @interface SharePointIdentitySet */ export interface SharePointIdentitySet { - /** - * - * @type {Identity} - * @memberof SharePointIdentitySet - */ 'user'?: Identity; - /** - * - * @type {Identity} - * @memberof SharePointIdentitySet - */ 'group'?: Identity; } /** * invitation-related data items - * @export - * @interface SharingInvitation */ export interface SharingInvitation { - /** - * - * @type {IdentitySet} - * @memberof SharingInvitation - */ 'invitedBy'?: IdentitySet; } /** * The `SharingLink` resource groups link-related data items into a single structure. If a `permission` resource has a non-null `sharingLink` facet, the permission represents a sharing link (as opposed to permissions granted to a person or group). - * @export - * @interface SharingLink */ export interface SharingLink { - /** - * - * @type {SharingLinkType} - * @memberof SharingLink - */ 'type'?: SharingLinkType; /** * If `true` then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. - * @type {boolean} - * @memberof SharingLink */ 'preventsDownload'?: boolean; /** * A URL that opens the item in the browser on the website. - * @type {string} - * @memberof SharingLink */ 'webUrl'?: string; /** * Provides a user-visible display name of the link. Optional. Libregraph only. - * @type {string} - * @memberof SharingLink */ '@libre.graph.displayName'?: string; /** * The quicklink property can be assigned to only one link per resource. A quicklink can be used in the clients to provide a one-click copy to clipboard action. Optional. Libregraph only. - * @type {boolean} - * @memberof SharingLink */ '@libre.graph.quickLink'?: boolean; } @@ -2148,21 +1080,15 @@ export interface SharingLink { /** * The sharing link password which should be set. - * @export - * @interface SharingLinkPassword */ export interface SharingLinkPassword { /** * Password. It may require a password policy. - * @type {string} - * @memberof SharingLinkPassword */ 'password'?: string; } /** * The type of the link created. | Value | Display name | Description | | -------------- | ----------------- | --------------------------------------------------------------- | | internal | Internal | Creates an internal link without any permissions. | | view | View | Creates a read-only link to the driveItem. | | upload | Upload | Creates a read-write link to the folder driveItem. | | edit | Edit | Creates a read-write link to the driveItem. | | createOnly | File Drop | Creates an upload-only link to the folder driveItem. | | blocksDownload | Secure View | Creates a read-only link that blocks download to the driveItem. | - * @export - * @enum {string} */ export const SharingLinkType = { @@ -2177,471 +1103,294 @@ export const SharingLinkType = { export type SharingLinkType = typeof SharingLinkType[keyof typeof SharingLinkType]; +/** + * Provides the last successful sign-in attempt for a user + */ +export interface SignInActivity { + /** + * The date and time of the last successful sign-in for the user. + */ + 'lastSuccessfulSignInDateTime'?: string; +} /** * If the current item is also available as a special folder, this facet is returned. Read-only - * @export - * @interface SpecialFolder */ export interface SpecialFolder { /** * The unique identifier for this item in the /drive/special collection - * @type {string} - * @memberof SpecialFolder */ 'name'?: string; } -/** - * - * @export - * @interface TagAssignment - */ export interface TagAssignment { - /** - * - * @type {string} - * @memberof TagAssignment - */ 'resourceId': string; - /** - * - * @type {Array} - * @memberof TagAssignment - */ 'tags': Array; } -/** - * - * @export - * @interface TagUnassignment - */ export interface TagUnassignment { - /** - * - * @type {string} - * @memberof TagUnassignment - */ 'resourceId': string; - /** - * - * @type {Array} - * @memberof TagUnassignment - */ 'tags': Array; } /** * The thumbnail resource type represents a thumbnail for an image, video, document, or any item that has a bitmap representation. - * @export - * @interface Thumbnail */ export interface Thumbnail { /** * The content stream for the thumbnail. - * @type {string} - * @memberof Thumbnail */ 'content'?: string; /** * The height of the thumbnail, in pixels. - * @type {number} - * @memberof Thumbnail */ 'height'?: number; /** * The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested. - * @type {string} - * @memberof Thumbnail */ 'sourceItemId'?: string; /** * The URL used to fetch the thumbnail content. - * @type {string} - * @memberof Thumbnail */ 'url'?: string; /** * The width of the thumbnail, in pixels. - * @type {number} - * @memberof Thumbnail */ 'width'?: number; } /** * The ThumbnailSet resource is a keyed collection of thumbnail resources. It\'s used to represent a set of thumbnails associated with a DriveItem. - * @export - * @interface ThumbnailSet */ export interface ThumbnailSet { /** * The ID within the item. Read-only. - * @type {string} - * @memberof ThumbnailSet */ 'id'?: string; - /** - * - * @type {Thumbnail} - * @memberof ThumbnailSet - */ 'large'?: Thumbnail; - /** - * - * @type {Thumbnail} - * @memberof ThumbnailSet - */ 'medium'?: Thumbnail; - /** - * - * @type {Thumbnail} - * @memberof ThumbnailSet - */ 'small'?: Thumbnail; - /** - * - * @type {Thumbnail} - * @memberof ThumbnailSet - */ 'source'?: Thumbnail; } /** * Metadata for trashed drive Items - * @export - * @interface Trash */ export interface Trash { - /** - * - * @type {IdentitySet} - * @memberof Trash - */ 'trashedBy'?: IdentitySet; /** * The UTC date and time the folder was marked as trashed. - * @type {string} - * @memberof Trash */ 'trashedDateTime'?: string; } /** * A role definition is a collection of permissions in libre graph listing the operations that can be performed and the resources against which they can performed. - * @export - * @interface UnifiedRoleDefinition */ export interface UnifiedRoleDefinition { /** * The description for the unifiedRoleDefinition. - * @type {string} - * @memberof UnifiedRoleDefinition */ 'description'?: string; /** * The display name for the unifiedRoleDefinition. Required. Supports $filter (`eq`, `in`). - * @type {string} - * @memberof UnifiedRoleDefinition */ 'displayName'?: string; /** * The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (`eq`, `in`). - * @type {string} - * @memberof UnifiedRoleDefinition */ 'id'?: string; /** * List of permissions included in the role. - * @type {Array} - * @memberof UnifiedRoleDefinition */ 'rolePermissions'?: Array; /** * When presenting a list of roles the weight can be used to order them in a meaningful way. Lower weight gets higher precedence. So content with lower weight will come first. If set, weights should be non-zero, as 0 is interpreted as an unset weight. - * @type {number} - * @memberof UnifiedRoleDefinition */ '@libre.graph.weight'?: number; } /** * Represents a collection of allowed resource actions and the conditions that must be met for the action to be allowed. Resource actions are tasks that can be performed on a resource. For example, an application resource may support create, update, delete, and reset password actions. - * @export - * @interface UnifiedRolePermission */ export interface UnifiedRolePermission { /** * Set of tasks that can be performed on a resource. Required. The following is the schema for resource actions: ``` {Namespace}/{Entity}/{PropertySet}/{Action} ``` For example: `libre.graph/applications/credentials/update` * *{Namespace}* - The services that exposes the task. For example, all tasks in libre graph use the namespace `libre.graph`. * *{Entity}* - The logical features or components exposed by the service in libre graph. For example, `applications`, `servicePrincipals`, or `groups`. * *{PropertySet}* - Optional. The specific properties or aspects of the entity for which access is being granted. For example, `libre.graph/applications/authentication/read` grants the ability to read the reply URL, logout URL, and implicit flow property on the **application** object in libre graph. The following are reserved names for common property sets: * `allProperties` - Designates all properties of the entity, including privileged properties. Examples include `libre.graph/applications/allProperties/read` and `libre.graph/applications/allProperties/update`. * `basic` - Designates common read properties but excludes privileged ones. For example, `libre.graph/applications/basic/update` includes the ability to update standard properties like display name. * `standard` - Designates common update properties but excludes privileged ones. For example, `libre.graph/applications/standard/read`. * *{Actions}* - The operations being granted. In most circumstances, permissions should be expressed in terms of CRUD operations or allTasks. Actions include: * `create` - The ability to create a new instance of the entity. * `read` - The ability to read a given property set (including allProperties). * `update` - The ability to update a given property set (including allProperties). * `delete` - The ability to delete a given entity. * `allTasks` - Represents all CRUD operations (create, read, update, and delete). Following the CS3 API we can represent the CS3 permissions by mapping them to driveItem properties or relations like this: | [CS3 ResourcePermission](https://cs3org.github.io/cs3apis/#cs3.storage.provider.v1beta1.ResourcePermissions) | action | comment | | ------------------------------------------------------------------------------------------------------------ | ------ | ------- | | `stat` | `libre.graph/driveItem/basic/read` | `basic` because it does not include versions or trashed items | | `get_quota` | `libre.graph/driveItem/quota/read` | read only the `quota` property | | `get_path` | `libre.graph/driveItem/path/read` | read only the `path` property | | `move` | `libre.graph/driveItem/path/update` | allows updating the `path` property of a CS3 resource | | `delete` | `libre.graph/driveItem/standard/delete` | `standard` because deleting is a common update operation | | `list_container` | `libre.graph/driveItem/children/read` | | | `create_container` | `libre.graph/driveItem/children/create` | | | `initiate_file_download` | `libre.graph/driveItem/content/read` | `content` is the property read when initiating a download | | `initiate_file_upload` | `libre.graph/driveItem/upload/create` | `uploads` are a separate property. postprocessing creates the `content` | | `add_grant` | `libre.graph/driveItem/permissions/create` | | | `list_grant` | `libre.graph/driveItem/permissions/read` | | | `update_grant` | `libre.graph/driveItem/permissions/update` | | | `remove_grant` | `libre.graph/driveItem/permissions/delete` | | | `deny_grant` | `libre.graph/driveItem/permissions/deny` | uses a non CRUD action `deny` | | `list_file_versions` | `libre.graph/driveItem/versions/read` | `versions` is a `driveItemVersion` collection | | `restore_file_version` | `libre.graph/driveItem/versions/update` | the only `update` action is restore | | `list_recycle` | `libre.graph/driveItem/deleted/read` | reading a driveItem `deleted` property implies listing | | `restore_recycle_item` | `libre.graph/driveItem/deleted/update` | the only `update` action is restore | | `purge_recycle` | `libre.graph/driveItem/deleted/delete` | allows purging deleted `driveItems` | Managing drives would be a different entity. A space manager role could be written as `libre.graph/drive/permission/allTasks`. - * @type {Array} - * @memberof UnifiedRolePermission */ 'allowedResourceActions'?: Array; /** * Optional constraints that must be met for the permission to be effective. Not supported for custom roles. Conditions define constraints that must be met. For example, a requirement that target resource must have a certain property. The following are the supported conditions: * Drive: `exists @Resource.Drive` - The target resource must be a drive/space * Folder: `exists @Resource.Folder` - The target resource must be a folder * File: `exists @Resource.File` - The target resource must be a file The following is an example of a role permission with a condition that the target resource is a folder: ```json \"rolePermissions\": [ { \"allowedResourceActions\": [ \"libre.graph/applications/basic/update\", \"libre.graph/applications/credentials/update\" ], \"condition\": \"exists @Resource.File\" } ] ``` Conditions aren\'t supported for custom roles. - * @type {string} - * @memberof UnifiedRolePermission */ 'condition'?: string; } /** * Represents an Active Directory user object. - * @export - * @interface User */ export interface User { /** * Read-only. - * @type {string} - * @memberof User */ 'id'?: string; /** * Set to \"true\" when the account is enabled. - * @type {boolean} - * @memberof User */ 'accountEnabled'?: boolean; /** * The apps and app roles which this user has been assigned. - * @type {Array} - * @memberof User */ 'appRoleAssignments'?: Array; /** * The name displayed in the address book for the user. This value is usually the combination of the user\'s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Returned by default. Supports $orderby. - * @type {string} - * @memberof User */ 'displayName': string; /** * A collection of drives available for this user. Read-only. - * @type {Array} - * @memberof User */ 'drives'?: Array; - /** - * - * @type {Drive} - * @memberof User - */ 'drive'?: Drive; /** * Identities associated with this account. - * @type {Array} - * @memberof User */ 'identities'?: Array; /** * The SMTP address for the user, for example, \'jeff@contoso.onowncloud.com\'. Returned by default. - * @type {string} - * @memberof User */ 'mail'?: string; /** * Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. - * @type {Array} - * @memberof User */ 'memberOf'?: Array; /** * Contains the on-premises SAM account name synchronized from the on-premises directory. - * @type {string} - * @memberof User */ 'onPremisesSamAccountName': string; - /** - * - * @type {PasswordProfile} - * @memberof User - */ 'passwordProfile'?: PasswordProfile; /** * The user\'s surname (family name or last name). Returned by default. - * @type {string} - * @memberof User */ 'surname'?: string; /** * The user\'s givenName. Returned by default. - * @type {string} - * @memberof User */ 'givenName'?: string; /** * The user`s type. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. - * @type {string} - * @memberof User */ 'userType'?: string; /** * Represents the users language setting, ISO-639-1 Code - * @type {string} - * @memberof User */ 'preferredLanguage'?: string; + 'signInActivity'?: SignInActivity; + /** + * A unique identifier assigned to the user by the organization. + */ + 'externalID'?: string; } /** * Represents updates to an Active Directory user object. - * @export - * @interface UserUpdate */ export interface UserUpdate { /** * Read-only. - * @type {string} - * @memberof UserUpdate */ 'id'?: string; /** * Set to \"true\" when the account is enabled. - * @type {boolean} - * @memberof UserUpdate */ 'accountEnabled'?: boolean; /** * The apps and app roles which this user has been assigned. - * @type {Array} - * @memberof UserUpdate */ 'appRoleAssignments'?: Array; /** * The name displayed in the address book for the user. This value is usually the combination of the user\'s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Returned by default. Supports $orderby. - * @type {string} - * @memberof UserUpdate */ 'displayName'?: string; /** * A collection of drives available for this user. Read-only. - * @type {Array} - * @memberof UserUpdate */ 'drives'?: Array; - /** - * - * @type {Drive} - * @memberof UserUpdate - */ 'drive'?: Drive; /** * Identities associated with this account. - * @type {Array} - * @memberof UserUpdate */ 'identities'?: Array; /** * The SMTP address for the user, for example, \'jeff@contoso.onowncloud.com\'. Returned by default. - * @type {string} - * @memberof UserUpdate */ 'mail'?: string; /** * Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. - * @type {Array} - * @memberof UserUpdate */ 'memberOf'?: Array; /** * Contains the on-premises SAM account name synchronized from the on-premises directory. - * @type {string} - * @memberof UserUpdate */ 'onPremisesSamAccountName'?: string; - /** - * - * @type {PasswordProfile} - * @memberof UserUpdate - */ 'passwordProfile'?: PasswordProfile; /** * The user\'s surname (family name or last name). Returned by default. - * @type {string} - * @memberof UserUpdate */ 'surname'?: string; /** * The user\'s givenName. Returned by default. - * @type {string} - * @memberof UserUpdate */ 'givenName'?: string; /** * The user`s type. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. - * @type {string} - * @memberof UserUpdate */ 'userType'?: string; /** * Represents the users language setting, ISO-639-1 Code - * @type {string} - * @memberof UserUpdate */ 'preferredLanguage'?: string; + 'signInActivity'?: SignInActivity; + /** + * A unique identifier assigned to the user by the organization. + */ + 'externalID'?: string; } /** * The video resource groups video-related data items into a single structure. If a driveItem has a non-null video facet, the item represents a video file. The properties of the video resource are populated by extracting metadata from the file. - * @export - * @interface Video */ export interface Video { /** * Number of audio bits per sample. - * @type {number} - * @memberof Video */ 'audioBitsPerSample'?: number; /** * Number of audio channels. - * @type {number} - * @memberof Video */ 'audioChannels'?: number; /** * Name of the audio format (AAC, MP3, etc.). - * @type {string} - * @memberof Video */ 'audioFormat'?: string; /** * Number of audio samples per second. - * @type {number} - * @memberof Video */ 'audioSamplesPerSecond'?: number; /** * Bit rate of the video in bits per second. - * @type {number} - * @memberof Video */ 'bitrate'?: number; /** * Duration of the file in milliseconds. - * @type {number} - * @memberof Video */ 'duration'?: number; /** * \\\"Four character code\\\" name of the video format. - * @type {string} - * @memberof Video */ 'fourCC'?: string; /** * Frame rate of the video. - * @type {number} - * @memberof Video */ 'frameRate'?: number; /** * Height of the video, in pixels. - * @type {number} - * @memberof Video */ 'height'?: number; /** * Width of the video, in pixels. - * @type {number} - * @memberof Video */ 'width'?: number; } /** * ActivitiesApi - axios parameter creator - * @export */ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -2675,8 +1424,8 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur localVarQueryParameter['kql'] = kql; } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -2691,7 +1440,6 @@ export const ActivitiesApiAxiosParamCreator = function (configuration?: Configur /** * ActivitiesApi - functional programming interface - * @export */ export const ActivitiesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ActivitiesApiAxiosParamCreator(configuration) @@ -2714,7 +1462,6 @@ export const ActivitiesApiFp = function(configuration?: Configuration) { /** * ActivitiesApi - factory interface - * @export */ export const ActivitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ActivitiesApiFp(configuration) @@ -2734,9 +1481,6 @@ export const ActivitiesApiFactory = function (configuration?: Configuration, bas /** * ActivitiesApi - object-oriented interface - * @export - * @class ActivitiesApi - * @extends {BaseAPI} */ export class ActivitiesApi extends BaseAPI { /** @@ -2745,7 +1489,6 @@ export class ActivitiesApi extends BaseAPI { * @param {string} [kql] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ActivitiesApi */ public getActivities(kql?: string, options?: RawAxiosRequestConfig) { return ActivitiesApiFp(this.configuration).getActivities(kql, options).then((request) => request(this.axios, this.basePath)); @@ -2756,7 +1499,6 @@ export class ActivitiesApi extends BaseAPI { /** * ApplicationsApi - axios parameter creator - * @export */ export const ApplicationsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -2789,8 +1531,8 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -2825,8 +1567,8 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -2841,7 +1583,6 @@ export const ApplicationsApiAxiosParamCreator = function (configuration?: Config /** * ApplicationsApi - functional programming interface - * @export */ export const ApplicationsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ApplicationsApiAxiosParamCreator(configuration) @@ -2876,7 +1617,6 @@ export const ApplicationsApiFp = function(configuration?: Configuration) { /** * ApplicationsApi - factory interface - * @export */ export const ApplicationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = ApplicationsApiFp(configuration) @@ -2905,9 +1645,6 @@ export const ApplicationsApiFactory = function (configuration?: Configuration, b /** * ApplicationsApi - object-oriented interface - * @export - * @class ApplicationsApi - * @extends {BaseAPI} */ export class ApplicationsApi extends BaseAPI { /** @@ -2916,7 +1653,6 @@ export class ApplicationsApi extends BaseAPI { * @param {string} applicationId key: id of application * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ApplicationsApi */ public getApplication(applicationId: string, options?: RawAxiosRequestConfig) { return ApplicationsApiFp(this.configuration).getApplication(applicationId, options).then((request) => request(this.axios, this.basePath)); @@ -2927,7 +1663,6 @@ export class ApplicationsApi extends BaseAPI { * @summary Get all applications * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof ApplicationsApi */ public listApplications(options?: RawAxiosRequestConfig) { return ApplicationsApiFp(this.configuration).listApplications(options).then((request) => request(this.axios, this.basePath)); @@ -2938,7 +1673,6 @@ export class ApplicationsApi extends BaseAPI { /** * DriveItemApi - axios parameter creator - * @export */ export const DriveItemApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -2975,8 +1709,8 @@ export const DriveItemApiAxiosParamCreator = function (configuration?: Configura // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3019,8 +1753,8 @@ export const DriveItemApiAxiosParamCreator = function (configuration?: Configura // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3066,9 +1800,8 @@ export const DriveItemApiAxiosParamCreator = function (configuration?: Configura // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -3085,7 +1818,6 @@ export const DriveItemApiAxiosParamCreator = function (configuration?: Configura /** * DriveItemApi - functional programming interface - * @export */ export const DriveItemApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DriveItemApiAxiosParamCreator(configuration) @@ -3138,7 +1870,6 @@ export const DriveItemApiFp = function(configuration?: Configuration) { /** * DriveItemApi - factory interface - * @export */ export const DriveItemApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DriveItemApiFp(configuration) @@ -3182,9 +1913,6 @@ export const DriveItemApiFactory = function (configuration?: Configuration, base /** * DriveItemApi - object-oriented interface - * @export - * @class DriveItemApi - * @extends {BaseAPI} */ export class DriveItemApi extends BaseAPI { /** @@ -3194,7 +1922,6 @@ export class DriveItemApi extends BaseAPI { * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DriveItemApi */ public deleteDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig) { return DriveItemApiFp(this.configuration).deleteDriveItem(driveId, itemId, options).then((request) => request(this.axios, this.basePath)); @@ -3207,7 +1934,6 @@ export class DriveItemApi extends BaseAPI { * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DriveItemApi */ public getDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig) { return DriveItemApiFp(this.configuration).getDriveItem(driveId, itemId, options).then((request) => request(this.axios, this.basePath)); @@ -3221,7 +1947,6 @@ export class DriveItemApi extends BaseAPI { * @param {DriveItem} driveItem DriveItem properties to update * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DriveItemApi */ public updateDriveItem(driveId: string, itemId: string, driveItem: DriveItem, options?: RawAxiosRequestConfig) { return DriveItemApiFp(this.configuration).updateDriveItem(driveId, itemId, driveItem, options).then((request) => request(this.axios, this.basePath)); @@ -3232,21 +1957,148 @@ export class DriveItemApi extends BaseAPI { /** * DrivesApi - axios parameter creator - * @export */ export const DrivesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * - * @summary Create a new drive of a specific type - * @param {Drive} drive New space property values + * @summary Create a new drive of a specific type + * @param {Drive} drive New space property values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createDrive: async (drive: Drive, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'drive' is not null or undefined + assertParamExists('createDrive', 'drive', drive) + const localVarPath = `/v1.0/drives`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication openId required + + // authentication basicAuth required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(drive, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Create a new drive of a specific type. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles. + * @param {Drive} drive New space property values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createDriveBeta: async (drive: Drive, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'drive' is not null or undefined + assertParamExists('createDriveBeta', 'drive', drive) + const localVarPath = `/v1beta1/drives`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication openId required + + // authentication basicAuth required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(drive, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Delete a specific space + * @param {string} driveId key: id of drive + * @param {string} [ifMatch] ETag + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteDrive: async (driveId: string, ifMatch?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'driveId' is not null or undefined + assertParamExists('deleteDrive', 'driveId', driveId) + const localVarPath = `/v1.0/drives/{drive-id}` + .replace(`{${"drive-id"}}`, encodeURIComponent(String(driveId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication openId required + + // authentication basicAuth required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + + localVarHeaderParameter['Accept'] = 'application/json'; + + if (ifMatch != null) { + localVarHeaderParameter['If-Match'] = String(ifMatch); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Delete a specific space. Alias for \'/v1.0/drives\'. + * @param {string} driveId key: id of drive + * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createDrive: async (drive: Drive, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'drive' is not null or undefined - assertParamExists('createDrive', 'drive', drive) - const localVarPath = `/v1.0/drives`; + deleteDriveBeta: async (driveId: string, ifMatch?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'driveId' is not null or undefined + assertParamExists('deleteDriveBeta', 'driveId', driveId) + const localVarPath = `/v1beta1/drives/{drive-id}` + .replace(`{${"drive-id"}}`, encodeURIComponent(String(driveId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -3254,7 +2106,7 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -3264,14 +2116,14 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - - localVarHeaderParameter['Content-Type'] = 'application/json'; - + if (ifMatch != null) { + localVarHeaderParameter['If-Match'] = String(ifMatch); + } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(drive, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -3280,15 +2132,14 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary Delete a specific space + * @summary Get drive by id * @param {string} driveId key: id of drive - * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteDrive: async (driveId: string, ifMatch?: string, options: RawAxiosRequestConfig = {}): Promise => { + getDrive: async (driveId: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'driveId' is not null or undefined - assertParamExists('deleteDrive', 'driveId', driveId) + assertParamExists('getDrive', 'driveId', driveId) const localVarPath = `/v1.0/drives/{drive-id}` .replace(`{${"drive-id"}}`, encodeURIComponent(String(driveId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -3298,7 +2149,7 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -3308,12 +2159,8 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - if (ifMatch != null) { - localVarHeaderParameter['If-Match'] = String(ifMatch); - } - + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3325,15 +2172,15 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary Get drive by id + * @summary Get drive by id. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} driveId key: id of drive * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDrive: async (driveId: string, options: RawAxiosRequestConfig = {}): Promise => { + getDriveBeta: async (driveId: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'driveId' is not null or undefined - assertParamExists('getDrive', 'driveId', driveId) - const localVarPath = `/v1.0/drives/{drive-id}` + assertParamExists('getDriveBeta', 'driveId', driveId) + const localVarPath = `/v1beta1/drives/{drive-id}` .replace(`{${"drive-id"}}`, encodeURIComponent(String(driveId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -3352,8 +2199,8 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3395,9 +2242,53 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(driveUpdate, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Update the drive. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles + * @param {string} driveId key: id of drive + * @param {DriveUpdate} driveUpdate New space values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateDriveBeta: async (driveId: string, driveUpdate: DriveUpdate, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'driveId' is not null or undefined + assertParamExists('updateDriveBeta', 'driveId', driveId) + // verify required parameter 'driveUpdate' is not null or undefined + assertParamExists('updateDriveBeta', 'driveUpdate', driveUpdate) + const localVarPath = `/v1beta1/drives/{drive-id}` + .replace(`{${"drive-id"}}`, encodeURIComponent(String(driveId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication openId required + + // authentication basicAuth required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -3414,7 +2305,6 @@ export const DrivesApiAxiosParamCreator = function (configuration?: Configuratio /** * DrivesApi - functional programming interface - * @export */ export const DrivesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DrivesApiAxiosParamCreator(configuration) @@ -3432,6 +2322,19 @@ export const DrivesApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DrivesApi.createDrive']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * + * @summary Create a new drive of a specific type. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles. + * @param {Drive} drive New space property values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async createDriveBeta(drive: Drive, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createDriveBeta(drive, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DrivesApi.createDriveBeta']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * * @summary Delete a specific space @@ -3446,6 +2349,20 @@ export const DrivesApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DrivesApi.deleteDrive']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * + * @summary Delete a specific space. Alias for \'/v1.0/drives\'. + * @param {string} driveId key: id of drive + * @param {string} [ifMatch] ETag + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteDriveBeta(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDriveBeta(driveId, ifMatch, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DrivesApi.deleteDriveBeta']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * * @summary Get drive by id @@ -3459,6 +2376,19 @@ export const DrivesApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DrivesApi.getDrive']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * + * @summary Get drive by id. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles + * @param {string} driveId key: id of drive + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getDriveBeta(driveId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getDriveBeta(driveId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DrivesApi.getDriveBeta']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * * @summary Update the drive @@ -3473,12 +2403,25 @@ export const DrivesApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DrivesApi.updateDrive']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * + * @summary Update the drive. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles + * @param {string} driveId key: id of drive + * @param {DriveUpdate} driveUpdate New space values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updateDriveBeta(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateDriveBeta(driveId, driveUpdate, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DrivesApi.updateDriveBeta']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, } }; /** * DrivesApi - factory interface - * @export */ export const DrivesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DrivesApiFp(configuration) @@ -3493,6 +2436,16 @@ export const DrivesApiFactory = function (configuration?: Configuration, basePat createDrive(drive: Drive, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createDrive(drive, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Create a new drive of a specific type. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles. + * @param {Drive} drive New space property values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + createDriveBeta(drive: Drive, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createDriveBeta(drive, options).then((request) => request(axios, basePath)); + }, /** * * @summary Delete a specific space @@ -3504,6 +2457,17 @@ export const DrivesApiFactory = function (configuration?: Configuration, basePat deleteDrive(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteDrive(driveId, ifMatch, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Delete a specific space. Alias for \'/v1.0/drives\'. + * @param {string} driveId key: id of drive + * @param {string} [ifMatch] ETag + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteDriveBeta(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteDriveBeta(driveId, ifMatch, options).then((request) => request(axios, basePath)); + }, /** * * @summary Get drive by id @@ -3514,6 +2478,16 @@ export const DrivesApiFactory = function (configuration?: Configuration, basePat getDrive(driveId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getDrive(driveId, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Get drive by id. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles + * @param {string} driveId key: id of drive + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getDriveBeta(driveId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getDriveBeta(driveId, options).then((request) => request(axios, basePath)); + }, /** * * @summary Update the drive @@ -3525,14 +2499,22 @@ export const DrivesApiFactory = function (configuration?: Configuration, basePat updateDrive(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateDrive(driveId, driveUpdate, options).then((request) => request(axios, basePath)); }, + /** + * + * @summary Update the drive. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles + * @param {string} driveId key: id of drive + * @param {DriveUpdate} driveUpdate New space values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updateDriveBeta(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateDriveBeta(driveId, driveUpdate, options).then((request) => request(axios, basePath)); + }, }; }; /** * DrivesApi - object-oriented interface - * @export - * @class DrivesApi - * @extends {BaseAPI} */ export class DrivesApi extends BaseAPI { /** @@ -3541,12 +2523,22 @@ export class DrivesApi extends BaseAPI { * @param {Drive} drive New space property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesApi */ public createDrive(drive: Drive, options?: RawAxiosRequestConfig) { return DrivesApiFp(this.configuration).createDrive(drive, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Create a new drive of a specific type. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles. + * @param {Drive} drive New space property values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public createDriveBeta(drive: Drive, options?: RawAxiosRequestConfig) { + return DrivesApiFp(this.configuration).createDriveBeta(drive, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Delete a specific space @@ -3554,24 +2546,45 @@ export class DrivesApi extends BaseAPI { * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesApi */ public deleteDrive(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig) { return DrivesApiFp(this.configuration).deleteDrive(driveId, ifMatch, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Delete a specific space. Alias for \'/v1.0/drives\'. + * @param {string} driveId key: id of drive + * @param {string} [ifMatch] ETag + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public deleteDriveBeta(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig) { + return DrivesApiFp(this.configuration).deleteDriveBeta(driveId, ifMatch, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Get drive by id * @param {string} driveId key: id of drive * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesApi */ public getDrive(driveId: string, options?: RawAxiosRequestConfig) { return DrivesApiFp(this.configuration).getDrive(driveId, options).then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Get drive by id. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles + * @param {string} driveId key: id of drive + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public getDriveBeta(driveId: string, options?: RawAxiosRequestConfig) { + return DrivesApiFp(this.configuration).getDriveBeta(driveId, options).then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Update the drive @@ -3579,18 +2592,28 @@ export class DrivesApi extends BaseAPI { * @param {DriveUpdate} driveUpdate New space values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesApi */ public updateDrive(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig) { return DrivesApiFp(this.configuration).updateDrive(driveId, driveUpdate, options).then((request) => request(this.axios, this.basePath)); } + + /** + * + * @summary Update the drive. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles + * @param {string} driveId key: id of drive + * @param {DriveUpdate} driveUpdate New space values + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + public updateDriveBeta(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig) { + return DrivesApiFp(this.configuration).updateDriveBeta(driveId, driveUpdate, options).then((request) => request(this.axios, this.basePath)); + } } /** * DrivesGetDrivesApi - axios parameter creator - * @export */ export const DrivesGetDrivesApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -3629,8 +2652,8 @@ export const DrivesGetDrivesApiAxiosParamCreator = function (configuration?: Con localVarQueryParameter['$filter'] = $filter; } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3675,8 +2698,8 @@ export const DrivesGetDrivesApiAxiosParamCreator = function (configuration?: Con localVarQueryParameter['$filter'] = $filter; } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3691,7 +2714,6 @@ export const DrivesGetDrivesApiAxiosParamCreator = function (configuration?: Con /** * DrivesGetDrivesApi - functional programming interface - * @export */ export const DrivesGetDrivesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DrivesGetDrivesApiAxiosParamCreator(configuration) @@ -3729,7 +2751,6 @@ export const DrivesGetDrivesApiFp = function(configuration?: Configuration) { /** * DrivesGetDrivesApi - factory interface - * @export */ export const DrivesGetDrivesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DrivesGetDrivesApiFp(configuration) @@ -3761,9 +2782,6 @@ export const DrivesGetDrivesApiFactory = function (configuration?: Configuration /** * DrivesGetDrivesApi - object-oriented interface - * @export - * @class DrivesGetDrivesApi - * @extends {BaseAPI} */ export class DrivesGetDrivesApi extends BaseAPI { /** @@ -3773,7 +2791,6 @@ export class DrivesGetDrivesApi extends BaseAPI { * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesGetDrivesApi */ public listAllDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig) { return DrivesGetDrivesApiFp(this.configuration).listAllDrives($orderby, $filter, options).then((request) => request(this.axios, this.basePath)); @@ -3786,7 +2803,6 @@ export class DrivesGetDrivesApi extends BaseAPI { * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesGetDrivesApi */ public listAllDrivesBeta($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig) { return DrivesGetDrivesApiFp(this.configuration).listAllDrivesBeta($orderby, $filter, options).then((request) => request(this.axios, this.basePath)); @@ -3797,7 +2813,6 @@ export class DrivesGetDrivesApi extends BaseAPI { /** * DrivesPermissionsApi - axios parameter creator - * @export */ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -3835,9 +2850,8 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -3886,8 +2900,8 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3934,8 +2948,8 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -3979,9 +2993,8 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4036,8 +3049,8 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C localVarQueryParameter['$select'] = Array.from($select).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -4087,9 +3100,8 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4141,9 +3153,8 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4160,7 +3171,6 @@ export const DrivesPermissionsApiAxiosParamCreator = function (configuration?: C /** * DrivesPermissionsApi - functional programming interface - * @export */ export const DrivesPermissionsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DrivesPermissionsApiAxiosParamCreator(configuration) @@ -4278,7 +3288,6 @@ export const DrivesPermissionsApiFp = function(configuration?: Configuration) { /** * DrivesPermissionsApi - factory interface - * @export */ export const DrivesPermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DrivesPermissionsApiFp(configuration) @@ -4375,9 +3384,6 @@ export const DrivesPermissionsApiFactory = function (configuration?: Configurati /** * DrivesPermissionsApi - object-oriented interface - * @export - * @class DrivesPermissionsApi - * @extends {BaseAPI} */ export class DrivesPermissionsApi extends BaseAPI { /** @@ -4388,7 +3394,6 @@ export class DrivesPermissionsApi extends BaseAPI { * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesPermissionsApi */ public createLink(driveId: string, itemId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig) { return DrivesPermissionsApiFp(this.configuration).createLink(driveId, itemId, driveItemCreateLink, options).then((request) => request(this.axios, this.basePath)); @@ -4402,7 +3407,6 @@ export class DrivesPermissionsApi extends BaseAPI { * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesPermissionsApi */ public deletePermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig) { return DrivesPermissionsApiFp(this.configuration).deletePermission(driveId, itemId, permId, options).then((request) => request(this.axios, this.basePath)); @@ -4416,7 +3420,6 @@ export class DrivesPermissionsApi extends BaseAPI { * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesPermissionsApi */ public getPermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig) { return DrivesPermissionsApiFp(this.configuration).getPermission(driveId, itemId, permId, options).then((request) => request(this.axios, this.basePath)); @@ -4430,7 +3433,6 @@ export class DrivesPermissionsApi extends BaseAPI { * @param {DriveItemInvite} [driveItemInvite] In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesPermissionsApi */ public invite(driveId: string, itemId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig) { return DrivesPermissionsApiFp(this.configuration).invite(driveId, itemId, driveItemInvite, options).then((request) => request(this.axios, this.basePath)); @@ -4445,7 +3447,6 @@ export class DrivesPermissionsApi extends BaseAPI { * @param {Set} [$select] Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesPermissionsApi */ public listPermissions(driveId: string, itemId: string, $filter?: string, $select?: Set, options?: RawAxiosRequestConfig) { return DrivesPermissionsApiFp(this.configuration).listPermissions(driveId, itemId, $filter, $select, options).then((request) => request(this.axios, this.basePath)); @@ -4460,7 +3461,6 @@ export class DrivesPermissionsApi extends BaseAPI { * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesPermissionsApi */ public setPermissionPassword(driveId: string, itemId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig) { return DrivesPermissionsApiFp(this.configuration).setPermissionPassword(driveId, itemId, permId, sharingLinkPassword, options).then((request) => request(this.axios, this.basePath)); @@ -4475,16 +3475,12 @@ export class DrivesPermissionsApi extends BaseAPI { * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesPermissionsApi */ public updatePermission(driveId: string, itemId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig) { return DrivesPermissionsApiFp(this.configuration).updatePermission(driveId, itemId, permId, permission, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const ListPermissionsSelectEnum = { LibreGraphPermissionsActionsAllowedValues: '@libre.graph.permissions.actions.allowedValues', LibreGraphPermissionsRolesAllowedValues: '@libre.graph.permissions.roles.allowedValues', @@ -4495,7 +3491,6 @@ export type ListPermissionsSelectEnum = typeof ListPermissionsSelectEnum[keyof t /** * DrivesRootApi - axios parameter creator - * @export */ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -4529,9 +3524,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4573,9 +3567,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4620,8 +3613,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -4664,8 +3657,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -4704,8 +3697,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -4745,9 +3738,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4798,8 +3790,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur localVarQueryParameter['$select'] = Array.from($select).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -4845,9 +3837,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4895,9 +3886,8 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -4914,7 +3904,6 @@ export const DrivesRootApiAxiosParamCreator = function (configuration?: Configur /** * DrivesRootApi - functional programming interface - * @export */ export const DrivesRootApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DrivesRootApiAxiosParamCreator(configuration) @@ -5052,7 +4041,6 @@ export const DrivesRootApiFp = function(configuration?: Configuration) { /** * DrivesRootApi - factory interface - * @export */ export const DrivesRootApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DrivesRootApiFp(configuration) @@ -5163,9 +4151,6 @@ export const DrivesRootApiFactory = function (configuration?: Configuration, bas /** * DrivesRootApi - object-oriented interface - * @export - * @class DrivesRootApi - * @extends {BaseAPI} */ export class DrivesRootApi extends BaseAPI { /** @@ -5175,7 +4160,6 @@ export class DrivesRootApi extends BaseAPI { * @param {DriveItem} [driveItem] In the request body, provide a JSON object with the following parameters. For mounting a share the necessary remoteItem id and permission id can be taken from the [sharedWithMe](#/me.drive/ListSharedWithMe) endpoint. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public createDriveItem(driveId: string, driveItem?: DriveItem, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).createDriveItem(driveId, driveItem, options).then((request) => request(this.axios, this.basePath)); @@ -5188,7 +4172,6 @@ export class DrivesRootApi extends BaseAPI { * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public createLinkSpaceRoot(driveId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).createLinkSpaceRoot(driveId, driveItemCreateLink, options).then((request) => request(this.axios, this.basePath)); @@ -5201,7 +4184,6 @@ export class DrivesRootApi extends BaseAPI { * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public deletePermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).deletePermissionSpaceRoot(driveId, permId, options).then((request) => request(this.axios, this.basePath)); @@ -5214,7 +4196,6 @@ export class DrivesRootApi extends BaseAPI { * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public getPermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).getPermissionSpaceRoot(driveId, permId, options).then((request) => request(this.axios, this.basePath)); @@ -5226,7 +4207,6 @@ export class DrivesRootApi extends BaseAPI { * @param {string} driveId key: id of drive * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public getRoot(driveId: string, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).getRoot(driveId, options).then((request) => request(this.axios, this.basePath)); @@ -5239,7 +4219,6 @@ export class DrivesRootApi extends BaseAPI { * @param {DriveItemInvite} [driveItemInvite] In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public inviteSpaceRoot(driveId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).inviteSpaceRoot(driveId, driveItemInvite, options).then((request) => request(this.axios, this.basePath)); @@ -5253,7 +4232,6 @@ export class DrivesRootApi extends BaseAPI { * @param {Set} [$select] Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public listPermissionsSpaceRoot(driveId: string, $filter?: string, $select?: Set, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).listPermissionsSpaceRoot(driveId, $filter, $select, options).then((request) => request(this.axios, this.basePath)); @@ -5267,7 +4245,6 @@ export class DrivesRootApi extends BaseAPI { * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public setPermissionPasswordSpaceRoot(driveId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).setPermissionPasswordSpaceRoot(driveId, permId, sharingLinkPassword, options).then((request) => request(this.axios, this.basePath)); @@ -5281,16 +4258,12 @@ export class DrivesRootApi extends BaseAPI { * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DrivesRootApi */ public updatePermissionSpaceRoot(driveId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig) { return DrivesRootApiFp(this.configuration).updatePermissionSpaceRoot(driveId, permId, permission, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const ListPermissionsSpaceRootSelectEnum = { LibreGraphPermissionsActionsAllowedValues: '@libre.graph.permissions.actions.allowedValues', LibreGraphPermissionsRolesAllowedValues: '@libre.graph.permissions.roles.allowedValues', @@ -5301,7 +4274,6 @@ export type ListPermissionsSpaceRootSelectEnum = typeof ListPermissionsSpaceRoot /** * EducationClassApi - axios parameter creator - * @export */ export const EducationClassApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -5335,9 +4307,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -5375,9 +4346,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -5416,8 +4386,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -5458,8 +4428,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -5496,8 +4466,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -5534,8 +4504,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -5568,8 +4538,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -5609,9 +4579,8 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -5628,7 +4597,6 @@ export const EducationClassApiAxiosParamCreator = function (configuration?: Conf /** * EducationClassApi - functional programming interface - * @export */ export const EducationClassApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = EducationClassApiAxiosParamCreator(configuration) @@ -5744,7 +4712,6 @@ export const EducationClassApiFp = function(configuration?: Configuration) { /** * EducationClassApi - factory interface - * @export */ export const EducationClassApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = EducationClassApiFp(configuration) @@ -5836,9 +4803,6 @@ export const EducationClassApiFactory = function (configuration?: Configuration, /** * EducationClassApi - object-oriented interface - * @export - * @class EducationClassApi - * @extends {BaseAPI} */ export class EducationClassApi extends BaseAPI { /** @@ -5848,7 +4812,6 @@ export class EducationClassApi extends BaseAPI { * @param {ClassMemberReference} classMemberReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public addUserToClass(classId: string, classMemberReference: ClassMemberReference, options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).addUserToClass(classId, classMemberReference, options).then((request) => request(this.axios, this.basePath)); @@ -5860,7 +4823,6 @@ export class EducationClassApi extends BaseAPI { * @param {EducationClass} educationClass New entity * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public createClass(educationClass: EducationClass, options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).createClass(educationClass, options).then((request) => request(this.axios, this.basePath)); @@ -5872,7 +4834,6 @@ export class EducationClassApi extends BaseAPI { * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public deleteClass(classId: string, options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).deleteClass(classId, options).then((request) => request(this.axios, this.basePath)); @@ -5885,7 +4846,6 @@ export class EducationClassApi extends BaseAPI { * @param {string} userId key: id or username of the user to unassign from class * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public deleteUserFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).deleteUserFromClass(classId, userId, options).then((request) => request(this.axios, this.basePath)); @@ -5897,7 +4857,6 @@ export class EducationClassApi extends BaseAPI { * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public getClass(classId: string, options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).getClass(classId, options).then((request) => request(this.axios, this.basePath)); @@ -5909,7 +4868,6 @@ export class EducationClassApi extends BaseAPI { * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public listClassMembers(classId: string, options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).listClassMembers(classId, options).then((request) => request(this.axios, this.basePath)); @@ -5920,7 +4878,6 @@ export class EducationClassApi extends BaseAPI { * @summary list education classes * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public listClasses(options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).listClasses(options).then((request) => request(this.axios, this.basePath)); @@ -5933,7 +4890,6 @@ export class EducationClassApi extends BaseAPI { * @param {EducationClass} educationClass New property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassApi */ public updateClass(classId: string, educationClass: EducationClass, options?: RawAxiosRequestConfig) { return EducationClassApiFp(this.configuration).updateClass(classId, educationClass, options).then((request) => request(this.axios, this.basePath)); @@ -5944,7 +4900,6 @@ export class EducationClassApi extends BaseAPI { /** * EducationClassTeachersApi - axios parameter creator - * @export */ export const EducationClassTeachersApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -5978,9 +4933,8 @@ export const EducationClassTeachersApiAxiosParamCreator = function (configuratio // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -6023,8 +4977,8 @@ export const EducationClassTeachersApiAxiosParamCreator = function (configuratio // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6061,8 +5015,8 @@ export const EducationClassTeachersApiAxiosParamCreator = function (configuratio // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6077,7 +5031,6 @@ export const EducationClassTeachersApiAxiosParamCreator = function (configuratio /** * EducationClassTeachersApi - functional programming interface - * @export */ export const EducationClassTeachersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = EducationClassTeachersApiAxiosParamCreator(configuration) @@ -6128,7 +5081,6 @@ export const EducationClassTeachersApiFp = function(configuration?: Configuratio /** * EducationClassTeachersApi - factory interface - * @export */ export const EducationClassTeachersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = EducationClassTeachersApiFp(configuration) @@ -6170,9 +5122,6 @@ export const EducationClassTeachersApiFactory = function (configuration?: Config /** * EducationClassTeachersApi - object-oriented interface - * @export - * @class EducationClassTeachersApi - * @extends {BaseAPI} */ export class EducationClassTeachersApi extends BaseAPI { /** @@ -6182,7 +5131,6 @@ export class EducationClassTeachersApi extends BaseAPI { * @param {ClassTeacherReference} classTeacherReference educationUser to be added as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassTeachersApi */ public addTeacherToClass(classId: string, classTeacherReference: ClassTeacherReference, options?: RawAxiosRequestConfig) { return EducationClassTeachersApiFp(this.configuration).addTeacherToClass(classId, classTeacherReference, options).then((request) => request(this.axios, this.basePath)); @@ -6195,7 +5143,6 @@ export class EducationClassTeachersApi extends BaseAPI { * @param {string} userId key: id or username of the user to unassign as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassTeachersApi */ public deleteTeacherFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig) { return EducationClassTeachersApiFp(this.configuration).deleteTeacherFromClass(classId, userId, options).then((request) => request(this.axios, this.basePath)); @@ -6207,7 +5154,6 @@ export class EducationClassTeachersApi extends BaseAPI { * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationClassTeachersApi */ public getTeachers(classId: string, options?: RawAxiosRequestConfig) { return EducationClassTeachersApiFp(this.configuration).getTeachers(classId, options).then((request) => request(this.axios, this.basePath)); @@ -6218,7 +5164,6 @@ export class EducationClassTeachersApi extends BaseAPI { /** * EducationSchoolApi - axios parameter creator - * @export */ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -6252,9 +5197,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -6296,9 +5240,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -6336,9 +5279,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -6381,8 +5323,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6419,8 +5361,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6461,8 +5403,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6499,8 +5441,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6537,8 +5479,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6575,8 +5517,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6609,8 +5551,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -6650,9 +5592,8 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -6669,7 +5610,6 @@ export const EducationSchoolApiAxiosParamCreator = function (configuration?: Con /** * EducationSchoolApi - functional programming interface - * @export */ export const EducationSchoolApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = EducationSchoolApiAxiosParamCreator(configuration) @@ -6826,7 +5766,6 @@ export const EducationSchoolApiFp = function(configuration?: Configuration) { /** * EducationSchoolApi - factory interface - * @export */ export const EducationSchoolApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = EducationSchoolApiFp(configuration) @@ -6950,9 +5889,6 @@ export const EducationSchoolApiFactory = function (configuration?: Configuration /** * EducationSchoolApi - object-oriented interface - * @export - * @class EducationSchoolApi - * @extends {BaseAPI} */ export class EducationSchoolApi extends BaseAPI { /** @@ -6962,7 +5898,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {ClassReference} classReference educationClass to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public addClassToSchool(schoolId: string, classReference: ClassReference, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).addClassToSchool(schoolId, classReference, options).then((request) => request(this.axios, this.basePath)); @@ -6975,7 +5910,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {EducationUserReference} educationUserReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public addUserToSchool(schoolId: string, educationUserReference: EducationUserReference, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).addUserToSchool(schoolId, educationUserReference, options).then((request) => request(this.axios, this.basePath)); @@ -6987,7 +5921,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {EducationSchool} educationSchool New school * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public createSchool(educationSchool: EducationSchool, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).createSchool(educationSchool, options).then((request) => request(this.axios, this.basePath)); @@ -7000,7 +5933,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {string} classId key: id or externalId of the class to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public deleteClassFromSchool(schoolId: string, classId: string, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).deleteClassFromSchool(schoolId, classId, options).then((request) => request(this.axios, this.basePath)); @@ -7012,7 +5944,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public deleteSchool(schoolId: string, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).deleteSchool(schoolId, options).then((request) => request(this.axios, this.basePath)); @@ -7025,7 +5956,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {string} userId key: id or username of the user to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public deleteUserFromSchool(schoolId: string, userId: string, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).deleteUserFromSchool(schoolId, userId, options).then((request) => request(this.axios, this.basePath)); @@ -7037,7 +5967,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public getSchool(schoolId: string, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).getSchool(schoolId, options).then((request) => request(this.axios, this.basePath)); @@ -7049,7 +5978,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public listSchoolClasses(schoolId: string, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).listSchoolClasses(schoolId, options).then((request) => request(this.axios, this.basePath)); @@ -7061,7 +5989,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public listSchoolUsers(schoolId: string, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).listSchoolUsers(schoolId, options).then((request) => request(this.axios, this.basePath)); @@ -7072,7 +5999,6 @@ export class EducationSchoolApi extends BaseAPI { * @summary Get a list of schools and their properties * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public listSchools(options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).listSchools(options).then((request) => request(this.axios, this.basePath)); @@ -7085,7 +6011,6 @@ export class EducationSchoolApi extends BaseAPI { * @param {EducationSchool} educationSchool New property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationSchoolApi */ public updateSchool(schoolId: string, educationSchool: EducationSchool, options?: RawAxiosRequestConfig) { return EducationSchoolApiFp(this.configuration).updateSchool(schoolId, educationSchool, options).then((request) => request(this.axios, this.basePath)); @@ -7096,7 +6021,6 @@ export class EducationSchoolApi extends BaseAPI { /** * EducationUserApi - axios parameter creator - * @export */ export const EducationUserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -7126,9 +6050,8 @@ export const EducationUserApiAxiosParamCreator = function (configuration?: Confi // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -7167,8 +6090,8 @@ export const EducationUserApiAxiosParamCreator = function (configuration?: Confi // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -7210,8 +6133,8 @@ export const EducationUserApiAxiosParamCreator = function (configuration?: Confi localVarQueryParameter['$expand'] = Array.from($expand).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -7254,8 +6177,8 @@ export const EducationUserApiAxiosParamCreator = function (configuration?: Confi localVarQueryParameter['$expand'] = Array.from($expand).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -7295,9 +6218,8 @@ export const EducationUserApiAxiosParamCreator = function (configuration?: Confi // http bearer authentication required await setBearerAuthToObject(localVarHeaderParameter, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -7314,7 +6236,6 @@ export const EducationUserApiAxiosParamCreator = function (configuration?: Confi /** * EducationUserApi - functional programming interface - * @export */ export const EducationUserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = EducationUserApiAxiosParamCreator(configuration) @@ -7392,7 +6313,6 @@ export const EducationUserApiFp = function(configuration?: Configuration) { /** * EducationUserApi - factory interface - * @export */ export const EducationUserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = EducationUserApiFp(configuration) @@ -7455,9 +6375,6 @@ export const EducationUserApiFactory = function (configuration?: Configuration, /** * EducationUserApi - object-oriented interface - * @export - * @class EducationUserApi - * @extends {BaseAPI} */ export class EducationUserApi extends BaseAPI { /** @@ -7466,7 +6383,6 @@ export class EducationUserApi extends BaseAPI { * @param {EducationUser} educationUser New entity * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationUserApi */ public createEducationUser(educationUser: EducationUser, options?: RawAxiosRequestConfig) { return EducationUserApiFp(this.configuration).createEducationUser(educationUser, options).then((request) => request(this.axios, this.basePath)); @@ -7478,7 +6394,6 @@ export class EducationUserApi extends BaseAPI { * @param {string} userId key: id or username of user * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationUserApi */ public deleteEducationUser(userId: string, options?: RawAxiosRequestConfig) { return EducationUserApiFp(this.configuration).deleteEducationUser(userId, options).then((request) => request(this.axios, this.basePath)); @@ -7491,7 +6406,6 @@ export class EducationUserApi extends BaseAPI { * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationUserApi */ public getEducationUser(userId: string, $expand?: Set, options?: RawAxiosRequestConfig) { return EducationUserApiFp(this.configuration).getEducationUser(userId, $expand, options).then((request) => request(this.axios, this.basePath)); @@ -7504,7 +6418,6 @@ export class EducationUserApi extends BaseAPI { * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationUserApi */ public listEducationUsers($orderby?: Set, $expand?: Set, options?: RawAxiosRequestConfig) { return EducationUserApiFp(this.configuration).listEducationUsers($orderby, $expand, options).then((request) => request(this.axios, this.basePath)); @@ -7517,23 +6430,16 @@ export class EducationUserApi extends BaseAPI { * @param {EducationUser} educationUser New property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof EducationUserApi */ public updateEducationUser(userId: string, educationUser: EducationUser, options?: RawAxiosRequestConfig) { return EducationUserApiFp(this.configuration).updateEducationUser(userId, educationUser, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const GetEducationUserExpandEnum = { MemberOf: 'memberOf' } as const; export type GetEducationUserExpandEnum = typeof GetEducationUserExpandEnum[keyof typeof GetEducationUserExpandEnum]; -/** - * @export - */ export const ListEducationUsersOrderbyEnum = { DisplayName: 'displayName', DisplayNameDesc: 'displayName desc', @@ -7543,9 +6449,6 @@ export const ListEducationUsersOrderbyEnum = { OnPremisesSamAccountNameDesc: 'onPremisesSamAccountName desc' } as const; export type ListEducationUsersOrderbyEnum = typeof ListEducationUsersOrderbyEnum[keyof typeof ListEducationUsersOrderbyEnum]; -/** - * @export - */ export const ListEducationUsersExpandEnum = { MemberOf: 'memberOf' } as const; @@ -7554,7 +6457,6 @@ export type ListEducationUsersExpandEnum = typeof ListEducationUsersExpandEnum[k /** * GroupApi - axios parameter creator - * @export */ export const GroupApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -7590,9 +6492,8 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -7634,12 +6535,11 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; + if (ifMatch != null) { localVarHeaderParameter['If-Match'] = String(ifMatch); } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -7683,12 +6583,11 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; + if (ifMatch != null) { localVarHeaderParameter['If-Match'] = String(ifMatch); } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -7737,8 +6636,8 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['$expand'] = Array.from($expand).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -7777,8 +6676,8 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -7820,9 +6719,8 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -7839,7 +6737,6 @@ export const GroupApiAxiosParamCreator = function (configuration?: Configuration /** * GroupApi - functional programming interface - * @export */ export const GroupApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = GroupApiAxiosParamCreator(configuration) @@ -7934,7 +6831,6 @@ export const GroupApiFp = function(configuration?: Configuration) { /** * GroupApi - factory interface - * @export */ export const GroupApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = GroupApiFp(configuration) @@ -8011,9 +6907,6 @@ export const GroupApiFactory = function (configuration?: Configuration, basePath /** * GroupApi - object-oriented interface - * @export - * @class GroupApi - * @extends {BaseAPI} */ export class GroupApi extends BaseAPI { /** @@ -8023,7 +6916,6 @@ export class GroupApi extends BaseAPI { * @param {MemberReference} memberReference Object to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupApi */ public addMember(groupId: string, memberReference: MemberReference, options?: RawAxiosRequestConfig) { return GroupApiFp(this.configuration).addMember(groupId, memberReference, options).then((request) => request(this.axios, this.basePath)); @@ -8036,7 +6928,6 @@ export class GroupApi extends BaseAPI { * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupApi */ public deleteGroup(groupId: string, ifMatch?: string, options?: RawAxiosRequestConfig) { return GroupApiFp(this.configuration).deleteGroup(groupId, ifMatch, options).then((request) => request(this.axios, this.basePath)); @@ -8050,7 +6941,6 @@ export class GroupApi extends BaseAPI { * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupApi */ public deleteMember(groupId: string, directoryObjectId: string, ifMatch?: string, options?: RawAxiosRequestConfig) { return GroupApiFp(this.configuration).deleteMember(groupId, directoryObjectId, ifMatch, options).then((request) => request(this.axios, this.basePath)); @@ -8064,7 +6954,6 @@ export class GroupApi extends BaseAPI { * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupApi */ public getGroup(groupId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) { return GroupApiFp(this.configuration).getGroup(groupId, $select, $expand, options).then((request) => request(this.axios, this.basePath)); @@ -8076,7 +6965,6 @@ export class GroupApi extends BaseAPI { * @param {string} groupId key: id or name of group * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupApi */ public listMembers(groupId: string, options?: RawAxiosRequestConfig) { return GroupApiFp(this.configuration).listMembers(groupId, options).then((request) => request(this.axios, this.basePath)); @@ -8089,16 +6977,12 @@ export class GroupApi extends BaseAPI { * @param {Group} group New property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupApi */ public updateGroup(groupId: string, group: Group, options?: RawAxiosRequestConfig) { return GroupApiFp(this.configuration).updateGroup(groupId, group, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const GetGroupSelectEnum = { Id: 'id', Description: 'description', @@ -8106,9 +6990,6 @@ export const GetGroupSelectEnum = { Members: 'members' } as const; export type GetGroupSelectEnum = typeof GetGroupSelectEnum[keyof typeof GetGroupSelectEnum]; -/** - * @export - */ export const GetGroupExpandEnum = { Members: 'members' } as const; @@ -8117,7 +6998,6 @@ export type GetGroupExpandEnum = typeof GetGroupExpandEnum[keyof typeof GetGroup /** * GroupsApi - axios parameter creator - * @export */ export const GroupsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -8149,9 +7029,8 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -8208,8 +7087,8 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio localVarQueryParameter['$expand'] = Array.from($expand).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -8224,7 +7103,6 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio /** * GroupsApi - functional programming interface - * @export */ export const GroupsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = GroupsApiAxiosParamCreator(configuration) @@ -8263,7 +7141,6 @@ export const GroupsApiFp = function(configuration?: Configuration) { /** * GroupsApi - factory interface - * @export */ export const GroupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = GroupsApiFp(configuration) @@ -8296,9 +7173,6 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat /** * GroupsApi - object-oriented interface - * @export - * @class GroupsApi - * @extends {BaseAPI} */ export class GroupsApi extends BaseAPI { /** @@ -8307,7 +7181,6 @@ export class GroupsApi extends BaseAPI { * @param {Group} group New entity * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupsApi */ public createGroup(group: Group, options?: RawAxiosRequestConfig) { return GroupsApiFp(this.configuration).createGroup(group, options).then((request) => request(this.axios, this.basePath)); @@ -8322,24 +7195,17 @@ export class GroupsApi extends BaseAPI { * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof GroupsApi */ public listGroups($search?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) { return GroupsApiFp(this.configuration).listGroups($search, $orderby, $select, $expand, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const ListGroupsOrderbyEnum = { DisplayName: 'displayName', DisplayNameDesc: 'displayName desc' } as const; export type ListGroupsOrderbyEnum = typeof ListGroupsOrderbyEnum[keyof typeof ListGroupsOrderbyEnum]; -/** - * @export - */ export const ListGroupsSelectEnum = { Id: 'id', Description: 'description', @@ -8348,9 +7214,6 @@ export const ListGroupsSelectEnum = { Members: 'members' } as const; export type ListGroupsSelectEnum = typeof ListGroupsSelectEnum[keyof typeof ListGroupsSelectEnum]; -/** - * @export - */ export const ListGroupsExpandEnum = { Members: 'members' } as const; @@ -8359,7 +7222,6 @@ export type ListGroupsExpandEnum = typeof ListGroupsExpandEnum[keyof typeof List /** * MeChangepasswordApi - axios parameter creator - * @export */ export const MeChangepasswordApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -8391,9 +7253,8 @@ export const MeChangepasswordApiAxiosParamCreator = function (configuration?: Co // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -8410,7 +7271,6 @@ export const MeChangepasswordApiAxiosParamCreator = function (configuration?: Co /** * MeChangepasswordApi - functional programming interface - * @export */ export const MeChangepasswordApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MeChangepasswordApiAxiosParamCreator(configuration) @@ -8433,7 +7293,6 @@ export const MeChangepasswordApiFp = function(configuration?: Configuration) { /** * MeChangepasswordApi - factory interface - * @export */ export const MeChangepasswordApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MeChangepasswordApiFp(configuration) @@ -8453,9 +7312,6 @@ export const MeChangepasswordApiFactory = function (configuration?: Configuratio /** * MeChangepasswordApi - object-oriented interface - * @export - * @class MeChangepasswordApi - * @extends {BaseAPI} */ export class MeChangepasswordApi extends BaseAPI { /** @@ -8464,7 +7320,6 @@ export class MeChangepasswordApi extends BaseAPI { * @param {PasswordChange} passwordChange Password change request * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeChangepasswordApi */ public changeOwnPassword(passwordChange: PasswordChange, options?: RawAxiosRequestConfig) { return MeChangepasswordApiFp(this.configuration).changeOwnPassword(passwordChange, options).then((request) => request(this.axios, this.basePath)); @@ -8475,7 +7330,6 @@ export class MeChangepasswordApi extends BaseAPI { /** * MeDriveApi - axios parameter creator - * @export */ export const MeDriveApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -8504,8 +7358,8 @@ export const MeDriveApiAxiosParamCreator = function (configuration?: Configurati // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -8540,8 +7394,8 @@ export const MeDriveApiAxiosParamCreator = function (configuration?: Configurati // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -8576,8 +7430,8 @@ export const MeDriveApiAxiosParamCreator = function (configuration?: Configurati // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -8592,7 +7446,6 @@ export const MeDriveApiAxiosParamCreator = function (configuration?: Configurati /** * MeDriveApi - functional programming interface - * @export */ export const MeDriveApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MeDriveApiAxiosParamCreator(configuration) @@ -8638,7 +7491,6 @@ export const MeDriveApiFp = function(configuration?: Configuration) { /** * MeDriveApi - factory interface - * @export */ export const MeDriveApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MeDriveApiFp(configuration) @@ -8675,9 +7527,6 @@ export const MeDriveApiFactory = function (configuration?: Configuration, basePa /** * MeDriveApi - object-oriented interface - * @export - * @class MeDriveApi - * @extends {BaseAPI} */ export class MeDriveApi extends BaseAPI { /** @@ -8685,7 +7534,6 @@ export class MeDriveApi extends BaseAPI { * @summary Get personal space for user * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeDriveApi */ public getHome(options?: RawAxiosRequestConfig) { return MeDriveApiFp(this.configuration).getHome(options).then((request) => request(this.axios, this.basePath)); @@ -8696,7 +7544,6 @@ export class MeDriveApi extends BaseAPI { * @summary Get a list of driveItem objects shared by the current user. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeDriveApi */ public listSharedByMe(options?: RawAxiosRequestConfig) { return MeDriveApiFp(this.configuration).listSharedByMe(options).then((request) => request(this.axios, this.basePath)); @@ -8707,7 +7554,6 @@ export class MeDriveApi extends BaseAPI { * @summary Get a list of driveItem objects shared with the owner of a drive. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeDriveApi */ public listSharedWithMe(options?: RawAxiosRequestConfig) { return MeDriveApiFp(this.configuration).listSharedWithMe(options).then((request) => request(this.axios, this.basePath)); @@ -8718,7 +7564,6 @@ export class MeDriveApi extends BaseAPI { /** * MeDriveRootApi - axios parameter creator - * @export */ export const MeDriveRootApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -8747,8 +7592,8 @@ export const MeDriveRootApiAxiosParamCreator = function (configuration?: Configu // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -8763,7 +7608,6 @@ export const MeDriveRootApiAxiosParamCreator = function (configuration?: Configu /** * MeDriveRootApi - functional programming interface - * @export */ export const MeDriveRootApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MeDriveRootApiAxiosParamCreator(configuration) @@ -8785,7 +7629,6 @@ export const MeDriveRootApiFp = function(configuration?: Configuration) { /** * MeDriveRootApi - factory interface - * @export */ export const MeDriveRootApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MeDriveRootApiFp(configuration) @@ -8804,9 +7647,6 @@ export const MeDriveRootApiFactory = function (configuration?: Configuration, ba /** * MeDriveRootApi - object-oriented interface - * @export - * @class MeDriveRootApi - * @extends {BaseAPI} */ export class MeDriveRootApi extends BaseAPI { /** @@ -8814,7 +7654,6 @@ export class MeDriveRootApi extends BaseAPI { * @summary Get root from personal space * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeDriveRootApi */ public homeGetRoot(options?: RawAxiosRequestConfig) { return MeDriveRootApiFp(this.configuration).homeGetRoot(options).then((request) => request(this.axios, this.basePath)); @@ -8825,7 +7664,6 @@ export class MeDriveRootApi extends BaseAPI { /** * MeDriveRootChildrenApi - axios parameter creator - * @export */ export const MeDriveRootChildrenApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -8854,8 +7692,8 @@ export const MeDriveRootChildrenApiAxiosParamCreator = function (configuration?: // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -8870,7 +7708,6 @@ export const MeDriveRootChildrenApiAxiosParamCreator = function (configuration?: /** * MeDriveRootChildrenApi - functional programming interface - * @export */ export const MeDriveRootChildrenApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MeDriveRootChildrenApiAxiosParamCreator(configuration) @@ -8892,7 +7729,6 @@ export const MeDriveRootChildrenApiFp = function(configuration?: Configuration) /** * MeDriveRootChildrenApi - factory interface - * @export */ export const MeDriveRootChildrenApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MeDriveRootChildrenApiFp(configuration) @@ -8911,9 +7747,6 @@ export const MeDriveRootChildrenApiFactory = function (configuration?: Configura /** * MeDriveRootChildrenApi - object-oriented interface - * @export - * @class MeDriveRootChildrenApi - * @extends {BaseAPI} */ export class MeDriveRootChildrenApi extends BaseAPI { /** @@ -8921,7 +7754,6 @@ export class MeDriveRootChildrenApi extends BaseAPI { * @summary Get children from drive * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeDriveRootChildrenApi */ public homeGetChildren(options?: RawAxiosRequestConfig) { return MeDriveRootChildrenApiFp(this.configuration).homeGetChildren(options).then((request) => request(this.axios, this.basePath)); @@ -8932,7 +7764,6 @@ export class MeDriveRootChildrenApi extends BaseAPI { /** * MeDrivesApi - axios parameter creator - * @export */ export const MeDrivesApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -8971,8 +7802,8 @@ export const MeDrivesApiAxiosParamCreator = function (configuration?: Configurat localVarQueryParameter['$filter'] = $filter; } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9017,8 +7848,8 @@ export const MeDrivesApiAxiosParamCreator = function (configuration?: Configurat localVarQueryParameter['$filter'] = $filter; } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9033,7 +7864,6 @@ export const MeDrivesApiAxiosParamCreator = function (configuration?: Configurat /** * MeDrivesApi - functional programming interface - * @export */ export const MeDrivesApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MeDrivesApiAxiosParamCreator(configuration) @@ -9071,7 +7901,6 @@ export const MeDrivesApiFp = function(configuration?: Configuration) { /** * MeDrivesApi - factory interface - * @export */ export const MeDrivesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MeDrivesApiFp(configuration) @@ -9103,9 +7932,6 @@ export const MeDrivesApiFactory = function (configuration?: Configuration, baseP /** * MeDrivesApi - object-oriented interface - * @export - * @class MeDrivesApi - * @extends {BaseAPI} */ export class MeDrivesApi extends BaseAPI { /** @@ -9115,7 +7941,6 @@ export class MeDrivesApi extends BaseAPI { * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeDrivesApi */ public listMyDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig) { return MeDrivesApiFp(this.configuration).listMyDrives($orderby, $filter, options).then((request) => request(this.axios, this.basePath)); @@ -9128,7 +7953,6 @@ export class MeDrivesApi extends BaseAPI { * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeDrivesApi */ public listMyDrivesBeta($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig) { return MeDrivesApiFp(this.configuration).listMyDrivesBeta($orderby, $filter, options).then((request) => request(this.axios, this.basePath)); @@ -9139,7 +7963,6 @@ export class MeDrivesApi extends BaseAPI { /** * MeUserApi - axios parameter creator - * @export */ export const MeUserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -9173,8 +7996,8 @@ export const MeUserApiAxiosParamCreator = function (configuration?: Configuratio localVarQueryParameter['$expand'] = Array.from($expand).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9210,9 +8033,8 @@ export const MeUserApiAxiosParamCreator = function (configuration?: Configuratio // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -9229,7 +8051,6 @@ export const MeUserApiAxiosParamCreator = function (configuration?: Configuratio /** * MeUserApi - functional programming interface - * @export */ export const MeUserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = MeUserApiAxiosParamCreator(configuration) @@ -9265,7 +8086,6 @@ export const MeUserApiFp = function(configuration?: Configuration) { /** * MeUserApi - factory interface - * @export */ export const MeUserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = MeUserApiFp(configuration) @@ -9295,9 +8115,6 @@ export const MeUserApiFactory = function (configuration?: Configuration, basePat /** * MeUserApi - object-oriented interface - * @export - * @class MeUserApi - * @extends {BaseAPI} */ export class MeUserApi extends BaseAPI { /** @@ -9306,7 +8123,6 @@ export class MeUserApi extends BaseAPI { * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeUserApi */ public getOwnUser($expand?: Set, options?: RawAxiosRequestConfig) { return MeUserApiFp(this.configuration).getOwnUser($expand, options).then((request) => request(this.axios, this.basePath)); @@ -9318,16 +8134,12 @@ export class MeUserApi extends BaseAPI { * @param {UserUpdate} [userUpdate] New user values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof MeUserApi */ public updateOwnUser(userUpdate?: UserUpdate, options?: RawAxiosRequestConfig) { return MeUserApiFp(this.configuration).updateOwnUser(userUpdate, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const GetOwnUserExpandEnum = { MemberOf: 'memberOf' } as const; @@ -9336,7 +8148,6 @@ export type GetOwnUserExpandEnum = typeof GetOwnUserExpandEnum[keyof typeof GetO /** * RoleManagementApi - axios parameter creator - * @export */ export const RoleManagementApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -9369,8 +8180,8 @@ export const RoleManagementApiAxiosParamCreator = function (configuration?: Conf // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9405,8 +8216,8 @@ export const RoleManagementApiAxiosParamCreator = function (configuration?: Conf // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9421,7 +8232,6 @@ export const RoleManagementApiAxiosParamCreator = function (configuration?: Conf /** * RoleManagementApi - functional programming interface - * @export */ export const RoleManagementApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = RoleManagementApiAxiosParamCreator(configuration) @@ -9456,7 +8266,6 @@ export const RoleManagementApiFp = function(configuration?: Configuration) { /** * RoleManagementApi - factory interface - * @export */ export const RoleManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = RoleManagementApiFp(configuration) @@ -9485,9 +8294,6 @@ export const RoleManagementApiFactory = function (configuration?: Configuration, /** * RoleManagementApi - object-oriented interface - * @export - * @class RoleManagementApi - * @extends {BaseAPI} */ export class RoleManagementApi extends BaseAPI { /** @@ -9496,7 +8302,6 @@ export class RoleManagementApi extends BaseAPI { * @param {string} roleId key: id of roleDefinition * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RoleManagementApi */ public getPermissionRoleDefinition(roleId: string, options?: RawAxiosRequestConfig) { return RoleManagementApiFp(this.configuration).getPermissionRoleDefinition(roleId, options).then((request) => request(this.axios, this.basePath)); @@ -9507,7 +8312,6 @@ export class RoleManagementApi extends BaseAPI { * @summary List roleDefinitions * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof RoleManagementApi */ public listPermissionRoleDefinitions(options?: RawAxiosRequestConfig) { return RoleManagementApiFp(this.configuration).listPermissionRoleDefinitions(options).then((request) => request(this.axios, this.basePath)); @@ -9518,7 +8322,6 @@ export class RoleManagementApi extends BaseAPI { /** * TagsApi - axios parameter creator - * @export */ export const TagsApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -9548,9 +8351,8 @@ export const TagsApiAxiosParamCreator = function (configuration?: Configuration) // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -9587,8 +8389,8 @@ export const TagsApiAxiosParamCreator = function (configuration?: Configuration) // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9624,9 +8426,8 @@ export const TagsApiAxiosParamCreator = function (configuration?: Configuration) // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -9643,7 +8444,6 @@ export const TagsApiAxiosParamCreator = function (configuration?: Configuration) /** * TagsApi - functional programming interface - * @export */ export const TagsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = TagsApiAxiosParamCreator(configuration) @@ -9691,7 +8491,6 @@ export const TagsApiFp = function(configuration?: Configuration) { /** * TagsApi - factory interface - * @export */ export const TagsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = TagsApiFp(configuration) @@ -9730,9 +8529,6 @@ export const TagsApiFactory = function (configuration?: Configuration, basePath? /** * TagsApi - object-oriented interface - * @export - * @class TagsApi - * @extends {BaseAPI} */ export class TagsApi extends BaseAPI { /** @@ -9741,7 +8537,6 @@ export class TagsApi extends BaseAPI { * @param {TagAssignment} [tagAssignment] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TagsApi */ public assignTags(tagAssignment?: TagAssignment, options?: RawAxiosRequestConfig) { return TagsApiFp(this.configuration).assignTags(tagAssignment, options).then((request) => request(this.axios, this.basePath)); @@ -9752,7 +8547,6 @@ export class TagsApi extends BaseAPI { * @summary Get all known tags * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TagsApi */ public getTags(options?: RawAxiosRequestConfig) { return TagsApiFp(this.configuration).getTags(options).then((request) => request(this.axios, this.basePath)); @@ -9764,7 +8558,6 @@ export class TagsApi extends BaseAPI { * @param {TagUnassignment} [tagUnassignment] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof TagsApi */ public unassignTags(tagUnassignment?: TagUnassignment, options?: RawAxiosRequestConfig) { return TagsApiFp(this.configuration).unassignTags(tagUnassignment, options).then((request) => request(this.axios, this.basePath)); @@ -9775,7 +8568,6 @@ export class TagsApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -9809,12 +8601,11 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; + if (ifMatch != null) { localVarHeaderParameter['If-Match'] = String(ifMatch); } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9854,9 +8645,8 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -9907,8 +8697,8 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['$expand'] = Array.from($expand).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -9950,9 +8740,8 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -9969,7 +8758,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -10036,7 +8824,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -10091,9 +8878,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -10103,7 +8887,6 @@ export class UserApi extends BaseAPI { * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(userId: string, ifMatch?: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(userId, ifMatch, options).then((request) => request(this.axios, this.basePath)); @@ -10116,7 +8899,6 @@ export class UserApi extends BaseAPI { * @param {ExportPersonalDataRequest} [exportPersonalDataRequest] destination the file should be created at * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public exportPersonalData(userId: string, exportPersonalDataRequest?: ExportPersonalDataRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).exportPersonalData(userId, exportPersonalDataRequest, options).then((request) => request(this.axios, this.basePath)); @@ -10130,7 +8912,6 @@ export class UserApi extends BaseAPI { * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUser(userId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUser(userId, $select, $expand, options).then((request) => request(this.axios, this.basePath)); @@ -10143,16 +8924,12 @@ export class UserApi extends BaseAPI { * @param {UserUpdate} userUpdate New property values * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(userId: string, userUpdate: UserUpdate, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(userId, userUpdate, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const GetUserSelectEnum = { Id: 'id', DisplayName: 'displayName', @@ -10164,9 +8941,6 @@ export const GetUserSelectEnum = { Surname: 'surname' } as const; export type GetUserSelectEnum = typeof GetUserSelectEnum[keyof typeof GetUserSelectEnum]; -/** - * @export - */ export const GetUserExpandEnum = { Drive: 'drive', Drives: 'drives', @@ -10178,7 +8952,6 @@ export type GetUserExpandEnum = typeof GetUserExpandEnum[keyof typeof GetUserExp /** * UserAppRoleAssignmentApi - axios parameter creator - * @export */ export const UserAppRoleAssignmentApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -10214,9 +8987,8 @@ export const UserAppRoleAssignmentApiAxiosParamCreator = function (configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -10262,12 +9034,11 @@ export const UserAppRoleAssignmentApiAxiosParamCreator = function (configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; + if (ifMatch != null) { localVarHeaderParameter['If-Match'] = String(ifMatch); } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -10306,8 +9077,8 @@ export const UserAppRoleAssignmentApiAxiosParamCreator = function (configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -10322,7 +9093,6 @@ export const UserAppRoleAssignmentApiAxiosParamCreator = function (configuration /** * UserAppRoleAssignmentApi - functional programming interface - * @export */ export const UserAppRoleAssignmentApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserAppRoleAssignmentApiAxiosParamCreator(configuration) @@ -10374,7 +9144,6 @@ export const UserAppRoleAssignmentApiFp = function(configuration?: Configuration /** * UserAppRoleAssignmentApi - factory interface - * @export */ export const UserAppRoleAssignmentApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserAppRoleAssignmentApiFp(configuration) @@ -10417,9 +9186,6 @@ export const UserAppRoleAssignmentApiFactory = function (configuration?: Configu /** * UserAppRoleAssignmentApi - object-oriented interface - * @export - * @class UserAppRoleAssignmentApi - * @extends {BaseAPI} */ export class UserAppRoleAssignmentApi extends BaseAPI { /** @@ -10429,7 +9195,6 @@ export class UserAppRoleAssignmentApi extends BaseAPI { * @param {AppRoleAssignment} appRoleAssignment New app role assignment value * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserAppRoleAssignmentApi */ public userCreateAppRoleAssignments(userId: string, appRoleAssignment: AppRoleAssignment, options?: RawAxiosRequestConfig) { return UserAppRoleAssignmentApiFp(this.configuration).userCreateAppRoleAssignments(userId, appRoleAssignment, options).then((request) => request(this.axios, this.basePath)); @@ -10443,7 +9208,6 @@ export class UserAppRoleAssignmentApi extends BaseAPI { * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserAppRoleAssignmentApi */ public userDeleteAppRoleAssignments(userId: string, appRoleAssignmentId: string, ifMatch?: string, options?: RawAxiosRequestConfig) { return UserAppRoleAssignmentApiFp(this.configuration).userDeleteAppRoleAssignments(userId, appRoleAssignmentId, ifMatch, options).then((request) => request(this.axios, this.basePath)); @@ -10455,7 +9219,6 @@ export class UserAppRoleAssignmentApi extends BaseAPI { * @param {string} userId key: id of user * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserAppRoleAssignmentApi */ public userListAppRoleAssignments(userId: string, options?: RawAxiosRequestConfig) { return UserAppRoleAssignmentApiFp(this.configuration).userListAppRoleAssignments(userId, options).then((request) => request(this.axios, this.basePath)); @@ -10466,7 +9229,6 @@ export class UserAppRoleAssignmentApi extends BaseAPI { /** * UsersApi - axios parameter creator - * @export */ export const UsersApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -10498,9 +9260,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) - - localVarHeaderParameter['Content-Type'] = 'application/json'; + localVarHeaderParameter['Accept'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -10562,8 +9323,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['$expand'] = Array.from($expand).join(COLLECTION_FORMATS.csv); } + localVarHeaderParameter['Accept'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -10578,7 +9339,6 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration /** * UsersApi - functional programming interface - * @export */ export const UsersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration) @@ -10618,7 +9378,6 @@ export const UsersApiFp = function(configuration?: Configuration) { /** * UsersApi - factory interface - * @export */ export const UsersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UsersApiFp(configuration) @@ -10652,9 +9411,6 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath /** * UsersApi - object-oriented interface - * @export - * @class UsersApi - * @extends {BaseAPI} */ export class UsersApi extends BaseAPI { /** @@ -10663,7 +9419,6 @@ export class UsersApi extends BaseAPI { * @param {User} user New entity * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ public createUser(user: User, options?: RawAxiosRequestConfig) { return UsersApiFp(this.configuration).createUser(user, options).then((request) => request(this.axios, this.basePath)); @@ -10679,16 +9434,12 @@ export class UsersApi extends BaseAPI { * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UsersApi */ public listUsers($search?: string, $filter?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) { return UsersApiFp(this.configuration).listUsers($search, $filter, $orderby, $select, $expand, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const ListUsersOrderbyEnum = { DisplayName: 'displayName', DisplayNameDesc: 'displayName desc', @@ -10698,9 +9449,6 @@ export const ListUsersOrderbyEnum = { OnPremisesSamAccountNameDesc: 'onPremisesSamAccountName desc' } as const; export type ListUsersOrderbyEnum = typeof ListUsersOrderbyEnum[keyof typeof ListUsersOrderbyEnum]; -/** - * @export - */ export const ListUsersSelectEnum = { Id: 'id', DisplayName: 'displayName', @@ -10710,9 +9458,6 @@ export const ListUsersSelectEnum = { Surname: 'surname' } as const; export type ListUsersSelectEnum = typeof ListUsersSelectEnum[keyof typeof ListUsersSelectEnum]; -/** - * @export - */ export const ListUsersExpandEnum = { Drive: 'drive', Drives: 'drives', diff --git a/packages/web-client/src/graph/generated/base.ts b/packages/web-client/src/graph/generated/base.ts index 4bbc60c56ab..8cf1026c20b 100644 --- a/packages/web-client/src/graph/generated/base.ts +++ b/packages/web-client/src/graph/generated/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "https://ocis.ocis.rolling.owncloud.works/graph".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/packages/web-client/src/graph/generated/common.ts b/packages/web-client/src/graph/generated/common.ts index f167d6f189f..05c1f9550b5 100644 --- a/packages/web-client/src/graph/generated/common.ts +++ b/packages/web-client/src/graph/generated/common.ts @@ -12,22 +12,16 @@ * Do not edit the class manually. */ - import type { Configuration } from "./configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +29,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +38,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +53,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -84,42 +62,35 @@ export const setOAuthToObject = async function (object: any, name: string, scope } } + function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { if (parameter == null) return; if (typeof parameter === "object") { if (Array.isArray(parameter)) { (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); - } + } else { - Object.keys(parameter).forEach(currentKey => + Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`) ); } - } + } else { if (urlSearchParams.has(key)) { urlSearchParams.append(key, parameter); - } + } else { urlSearchParams.set(key, parameter); } } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/packages/web-client/src/graph/generated/configuration.ts b/packages/web-client/src/graph/generated/configuration.ts index 028ff713bc2..90150673840 100644 --- a/packages/web-client/src/graph/generated/configuration.ts +++ b/packages/web-client/src/graph/generated/configuration.ts @@ -1,5 +1,4 @@ /* tslint:disable */ -/* eslint-disable */ /** * Libre Graph API * Libre Graph is a free API for cloud collaboration inspired by the MS Graph API. @@ -12,12 +11,24 @@ * Do not edit the class manually. */ +interface AWSv4Configuration { + options?: { + region?: string + service?: string + } + credentials?: { + accessKeyId?: string + secretAccessKey?: string, + sessionToken?: string + } +} export interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); + awsv4?: AWSv4Configuration; basePath?: string; serverIndex?: number; baseOptions?: any; @@ -28,49 +39,43 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** - * override base path - * - * @type {string} + * parameter for aws4 signature security + * @param {Object} AWS4Signature - AWS4 Signature security + * @param {string} options.region - aws region + * @param {string} options.service - name of the service. + * @param {string} credentials.accessKeyId - aws access key id + * @param {string} credentials.secretAccessKey - aws access key + * @param {string} credentials.sessionToken - aws session token * @memberof Configuration */ + awsv4?: AWSv4Configuration; + /** + * override base path + */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** @@ -87,9 +92,15 @@ export class Configuration { this.username = param.username; this.password = param.password; this.accessToken = param.accessToken; + this.awsv4 = param.awsv4; this.basePath = param.basePath; this.serverIndex = param.serverIndex; - this.baseOptions = param.baseOptions; + this.baseOptions = { + ...param.baseOptions, + headers: { + ...param.baseOptions?.headers, + }, + }; this.formDataCtor = param.formDataCtor; } diff --git a/packages/web-client/src/graph/generated/docs/ActivitiesApi.md b/packages/web-client/src/graph/generated/docs/ActivitiesApi.md new file mode 100644 index 00000000000..32251a578d0 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ActivitiesApi.md @@ -0,0 +1,59 @@ +# ActivitiesApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getActivities**](#getactivities) | **GET** /v1beta1/extensions/org.libregraph/activities | Get activities| + +# **getActivities** +> CollectionOfActivities getActivities() + + +### Example + +```typescript +import { + ActivitiesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ActivitiesApi(configuration); + +let kql: string; // (optional) (default to undefined) + +const { status, data } = await apiInstance.getActivities( + kql +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **kql** | [**string**] | | (optional) defaults to undefined| + + +### Return type + +**CollectionOfActivities** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Found activities | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/Activity.md b/packages/web-client/src/graph/generated/docs/Activity.md new file mode 100644 index 00000000000..f4b5a37d31c --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Activity.md @@ -0,0 +1,25 @@ +# Activity + +Represents activity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Activity ID. | [default to undefined] +**times** | [**ActivityTimes**](ActivityTimes.md) | | [default to undefined] +**template** | [**ActivityTemplate**](ActivityTemplate.md) | | [default to undefined] + +## Example + +```typescript +import { Activity } from './api'; + +const instance: Activity = { + id, + times, + template, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ActivityTemplate.md b/packages/web-client/src/graph/generated/docs/ActivityTemplate.md new file mode 100644 index 00000000000..759bdd7cc61 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ActivityTemplate.md @@ -0,0 +1,22 @@ +# ActivityTemplate + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | Activity description. | [default to undefined] +**variables** | **object** | Activity description variables. | [optional] [default to undefined] + +## Example + +```typescript +import { ActivityTemplate } from './api'; + +const instance: ActivityTemplate = { + message, + variables, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ActivityTimes.md b/packages/web-client/src/graph/generated/docs/ActivityTimes.md new file mode 100644 index 00000000000..097380c8888 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ActivityTimes.md @@ -0,0 +1,20 @@ +# ActivityTimes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recordedTime** | **string** | Timestamp of the activity. | [default to undefined] + +## Example + +```typescript +import { ActivityTimes } from './api'; + +const instance: ActivityTimes = { + recordedTime, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/AppRole.md b/packages/web-client/src/graph/generated/docs/AppRole.md new file mode 100644 index 00000000000..d475c7d8d12 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/AppRole.md @@ -0,0 +1,26 @@ +# AppRole + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowedMemberTypes** | **Array<string>** | Specifies whether this app role can be assigned to users and groups (by setting to [\'User\']), to other application\'s (by setting to [\'Application\'], or both (by setting to [\'User\', \'Application\']). App roles supporting assignment to other applications\' service principals are also known as application permissions. The \'Application\' value is only supported for app roles defined on application entities. | [optional] [default to undefined] +**description** | **string** | The description for the app role. This is displayed when the app role is being assigned and, if the app role functions as an application permission, during consent experiences. | [optional] [default to undefined] +**displayName** | **string** | Display name for the permission that appears in the app role assignment and consent experiences. | [optional] [default to undefined] +**id** | **string** | Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided. | [default to undefined] + +## Example + +```typescript +import { AppRole } from './api'; + +const instance: AppRole = { + allowedMemberTypes, + description, + displayName, + id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/AppRoleAssignment.md b/packages/web-client/src/graph/generated/docs/AppRoleAssignment.md new file mode 100644 index 00000000000..a79d18eb25c --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/AppRoleAssignment.md @@ -0,0 +1,36 @@ +# AppRoleAssignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier for the object. 12345678-9abc-def0-1234-56789abcde. The value of the ID property is often, but not exclusively, in the form of a GUID. The value should be treated as an opaque identifier and not based in being a GUID. Null values are not allowed. Read-only. | [optional] [readonly] [default to undefined] +**deletedDateTime** | **string** | | [optional] [default to undefined] +**appRoleId** | **string** | The identifier (id) for the app role which is assigned to the user. Required on create. | [default to undefined] +**createdDateTime** | **string** | The time when the app role assignment was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. | [optional] [default to undefined] +**principalDisplayName** | **string** | The display name of the user, group, or service principal that was granted the app role assignment. Read-only. | [optional] [default to undefined] +**principalId** | **string** | The unique identifier (id) for the user, security group, or service principal being granted the app role. Security groups with dynamic memberships are supported. Required on create. | [default to undefined] +**principalType** | **string** | The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only. | [optional] [default to undefined] +**resourceDisplayName** | **string** | The display name of the resource app\'s service principal to which the assignment is made. | [optional] [default to undefined] +**resourceId** | **string** | The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. | [default to undefined] + +## Example + +```typescript +import { AppRoleAssignment } from './api'; + +const instance: AppRoleAssignment = { + id, + deletedDateTime, + appRoleId, + createdDateTime, + principalDisplayName, + principalId, + principalType, + resourceDisplayName, + resourceId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Application.md b/packages/web-client/src/graph/generated/docs/Application.md new file mode 100644 index 00000000000..c70b86930b7 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Application.md @@ -0,0 +1,24 @@ +# Application + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier for the object. 12345678-9abc-def0-1234-56789abcde. The value of the ID property is often, but not exclusively, in the form of a GUID. The value should be treated as an opaque identifier and not based in being a GUID. Null values are not allowed. Read-only. | [readonly] [default to undefined] +**appRoles** | [**Array<AppRole>**](AppRole.md) | The collection of roles defined for the application. With app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. Not nullable. | [optional] [default to undefined] +**displayName** | **string** | The display name for the application. | [optional] [default to undefined] + +## Example + +```typescript +import { Application } from './api'; + +const instance: Application = { + id, + appRoles, + displayName, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ApplicationsApi.md b/packages/web-client/src/graph/generated/docs/ApplicationsApi.md new file mode 100644 index 00000000000..89cf4c62e1d --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ApplicationsApi.md @@ -0,0 +1,104 @@ +# ApplicationsApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getApplication**](#getapplication) | **GET** /v1.0/applications/{application-id} | Get application by id| +|[**listApplications**](#listapplications) | **GET** /v1.0/applications | Get all applications| + +# **getApplication** +> Application getApplication() + + +### Example + +```typescript +import { + ApplicationsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ApplicationsApi(configuration); + +let applicationId: string; //key: id of application (default to undefined) + +const { status, data } = await apiInstance.getApplication( + applicationId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **applicationId** | [**string**] | key: id of application | defaults to undefined| + + +### Return type + +**Application** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listApplications** +> CollectionOfApplications listApplications() + + +### Example + +```typescript +import { + ApplicationsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ApplicationsApi(configuration); + +const { status, data } = await apiInstance.listApplications(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**CollectionOfApplications** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entities | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/Audio.md b/packages/web-client/src/graph/generated/docs/Audio.md new file mode 100644 index 00000000000..326bbdd5b23 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Audio.md @@ -0,0 +1,51 @@ +# Audio + +The Audio resource groups audio-related properties on an item into a single structure. If a DriveItem has a non-null audio facet, the item represents an audio file. The properties of the Audio resource are populated by extracting metadata from the file. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**album** | **string** | The title of the album for this audio file. | [optional] [default to undefined] +**albumArtist** | **string** | The artist named on the album for the audio file. | [optional] [default to undefined] +**artist** | **string** | The performing artist for the audio file. | [optional] [default to undefined] +**bitrate** | **number** | Bitrate expressed in kbps. | [optional] [default to undefined] +**composers** | **string** | The name of the composer of the audio file. | [optional] [default to undefined] +**copyright** | **string** | Copyright information for the audio file. | [optional] [default to undefined] +**disc** | **number** | The number of the disc this audio file came from. | [optional] [default to undefined] +**discCount** | **number** | The total number of discs in this album. | [optional] [default to undefined] +**duration** | **number** | Duration of the audio file, expressed in milliseconds | [optional] [default to undefined] +**genre** | **string** | The genre of this audio file. | [optional] [default to undefined] +**hasDrm** | **boolean** | Indicates if the file is protected with digital rights management. | [optional] [default to undefined] +**isVariableBitrate** | **boolean** | Indicates if the file is encoded with a variable bitrate. | [optional] [default to undefined] +**title** | **string** | The title of the audio file. | [optional] [default to undefined] +**track** | **number** | The number of the track on the original disc for this audio file. | [optional] [default to undefined] +**trackCount** | **number** | The total number of tracks on the original disc for this audio file. | [optional] [default to undefined] +**year** | **number** | The year the audio file was recorded. | [optional] [default to undefined] + +## Example + +```typescript +import { Audio } from './api'; + +const instance: Audio = { + album, + albumArtist, + artist, + bitrate, + composers, + copyright, + disc, + discCount, + duration, + genre, + hasDrm, + isVariableBitrate, + title, + track, + trackCount, + year, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ClassMemberReference.md b/packages/web-client/src/graph/generated/docs/ClassMemberReference.md new file mode 100644 index 00000000000..0257c44728c --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ClassMemberReference.md @@ -0,0 +1,20 @@ +# ClassMemberReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**odata_id** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { ClassMemberReference } from './api'; + +const instance: ClassMemberReference = { + odata_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ClassReference.md b/packages/web-client/src/graph/generated/docs/ClassReference.md new file mode 100644 index 00000000000..fc90649be2b --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ClassReference.md @@ -0,0 +1,20 @@ +# ClassReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**odata_id** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { ClassReference } from './api'; + +const instance: ClassReference = { + odata_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ClassTeacherReference.md b/packages/web-client/src/graph/generated/docs/ClassTeacherReference.md new file mode 100644 index 00000000000..9cac4b51e79 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ClassTeacherReference.md @@ -0,0 +1,20 @@ +# ClassTeacherReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**odata_id** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { ClassTeacherReference } from './api'; + +const instance: ClassTeacherReference = { + odata_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfActivities.md b/packages/web-client/src/graph/generated/docs/CollectionOfActivities.md new file mode 100644 index 00000000000..bf5e72ced28 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfActivities.md @@ -0,0 +1,20 @@ +# CollectionOfActivities + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<Activity>**](Activity.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfActivities } from './api'; + +const instance: CollectionOfActivities = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfAppRoleAssignments.md b/packages/web-client/src/graph/generated/docs/CollectionOfAppRoleAssignments.md new file mode 100644 index 00000000000..93cb8490cb1 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfAppRoleAssignments.md @@ -0,0 +1,22 @@ +# CollectionOfAppRoleAssignments + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<AppRoleAssignment>**](AppRoleAssignment.md) | | [optional] [default to undefined] +**odata_nextLink** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfAppRoleAssignments } from './api'; + +const instance: CollectionOfAppRoleAssignments = { + value, + odata_nextLink, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfApplications.md b/packages/web-client/src/graph/generated/docs/CollectionOfApplications.md new file mode 100644 index 00000000000..bef89f9314b --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfApplications.md @@ -0,0 +1,20 @@ +# CollectionOfApplications + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<Application>**](Application.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfApplications } from './api'; + +const instance: CollectionOfApplications = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfClass.md b/packages/web-client/src/graph/generated/docs/CollectionOfClass.md new file mode 100644 index 00000000000..c2fe363fc42 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfClass.md @@ -0,0 +1,20 @@ +# CollectionOfClass + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<EducationClass>**](EducationClass.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfClass } from './api'; + +const instance: CollectionOfClass = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfDriveItems.md b/packages/web-client/src/graph/generated/docs/CollectionOfDriveItems.md new file mode 100644 index 00000000000..4e53f85c1e5 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfDriveItems.md @@ -0,0 +1,22 @@ +# CollectionOfDriveItems + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<DriveItem>**](DriveItem.md) | | [optional] [default to undefined] +**odata_nextLink** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfDriveItems } from './api'; + +const instance: CollectionOfDriveItems = { + value, + odata_nextLink, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfDriveItems1.md b/packages/web-client/src/graph/generated/docs/CollectionOfDriveItems1.md new file mode 100644 index 00000000000..8eb62f121e0 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfDriveItems1.md @@ -0,0 +1,20 @@ +# CollectionOfDriveItems1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<DriveItem>**](DriveItem.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfDriveItems1 } from './api'; + +const instance: CollectionOfDriveItems1 = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfDrives.md b/packages/web-client/src/graph/generated/docs/CollectionOfDrives.md new file mode 100644 index 00000000000..9402bff5a85 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfDrives.md @@ -0,0 +1,22 @@ +# CollectionOfDrives + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<Drive>**](Drive.md) | | [optional] [default to undefined] +**odata_nextLink** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfDrives } from './api'; + +const instance: CollectionOfDrives = { + value, + odata_nextLink, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfDrives1.md b/packages/web-client/src/graph/generated/docs/CollectionOfDrives1.md new file mode 100644 index 00000000000..b5ab307dfa6 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfDrives1.md @@ -0,0 +1,20 @@ +# CollectionOfDrives1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<Drive>**](Drive.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfDrives1 } from './api'; + +const instance: CollectionOfDrives1 = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfEducationClass.md b/packages/web-client/src/graph/generated/docs/CollectionOfEducationClass.md new file mode 100644 index 00000000000..3f8e7864f56 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfEducationClass.md @@ -0,0 +1,20 @@ +# CollectionOfEducationClass + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<EducationClass>**](EducationClass.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfEducationClass } from './api'; + +const instance: CollectionOfEducationClass = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfEducationUser.md b/packages/web-client/src/graph/generated/docs/CollectionOfEducationUser.md new file mode 100644 index 00000000000..03c7a437da8 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfEducationUser.md @@ -0,0 +1,20 @@ +# CollectionOfEducationUser + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<EducationUser>**](EducationUser.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfEducationUser } from './api'; + +const instance: CollectionOfEducationUser = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfGroup.md b/packages/web-client/src/graph/generated/docs/CollectionOfGroup.md new file mode 100644 index 00000000000..e4109472b49 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfGroup.md @@ -0,0 +1,22 @@ +# CollectionOfGroup + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<Group>**](Group.md) | | [optional] [default to undefined] +**odata_nextLink** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfGroup } from './api'; + +const instance: CollectionOfGroup = { + value, + odata_nextLink, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfPermissions.md b/packages/web-client/src/graph/generated/docs/CollectionOfPermissions.md new file mode 100644 index 00000000000..e34766a3e49 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfPermissions.md @@ -0,0 +1,20 @@ +# CollectionOfPermissions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<Permission>**](Permission.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfPermissions } from './api'; + +const instance: CollectionOfPermissions = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfPermissionsWithAllowedValues.md b/packages/web-client/src/graph/generated/docs/CollectionOfPermissionsWithAllowedValues.md new file mode 100644 index 00000000000..2c4c4ce3afa --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfPermissionsWithAllowedValues.md @@ -0,0 +1,24 @@ +# CollectionOfPermissionsWithAllowedValues + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**libre_graph_permissions_roles_allowedValues** | [**Array<UnifiedRoleDefinition>**](UnifiedRoleDefinition.md) | A list of role definitions that can be chosen for the resource. | [optional] [default to undefined] +**libre_graph_permissions_actions_allowedValues** | **Array<string>** | A list of actions that can be chosen for a custom role. Following the CS3 API we can represent the CS3 permissions by mapping them to driveItem properties or relations like this: | [CS3 ResourcePermission](https://cs3org.github.io/cs3apis/#cs3.storage.provider.v1beta1.ResourcePermissions) | action | comment | | ------------------------------------------------------------------------------------------------------------ | ------ | ------- | | `stat` | `libre.graph/driveItem/basic/read` | `basic` because it does not include versions or trashed items | | `get_quota` | `libre.graph/driveItem/quota/read` | read only the `quota` property | | `get_path` | `libre.graph/driveItem/path/read` | read only the `path` property | | `move` | `libre.graph/driveItem/path/update` | allows updating the `path` property of a CS3 resource | | `delete` | `libre.graph/driveItem/standard/delete` | `standard` because deleting is a common update operation | | `list_container` | `libre.graph/driveItem/children/read` | | | `create_container` | `libre.graph/driveItem/children/create` | | | `initiate_file_download` | `libre.graph/driveItem/content/read` | `content` is the property read when initiating a download | | `initiate_file_upload` | `libre.graph/driveItem/upload/create` | `uploads` are a separate property. postprocessing creates the `content` | | `add_grant` | `libre.graph/driveItem/permissions/create` | | | `list_grant` | `libre.graph/driveItem/permissions/read` | | | `update_grant` | `libre.graph/driveItem/permissions/update` | | | `remove_grant` | `libre.graph/driveItem/permissions/delete` | | | `deny_grant` | `libre.graph/driveItem/permissions/deny` | uses a non CRUD action `deny` | | `list_file_versions` | `libre.graph/driveItem/versions/read` | `versions` is a `driveItemVersion` collection | | `restore_file_version` | `libre.graph/driveItem/versions/update` | the only `update` action is restore | | `list_recycle` | `libre.graph/driveItem/deleted/read` | reading a driveItem `deleted` property implies listing | | `restore_recycle_item` | `libre.graph/driveItem/deleted/update` | the only `update` action is restore | | `purge_recycle` | `libre.graph/driveItem/deleted/delete` | allows purging deleted `driveItems` | | [optional] [default to undefined] +**value** | [**Array<Permission>**](Permission.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfPermissionsWithAllowedValues } from './api'; + +const instance: CollectionOfPermissionsWithAllowedValues = { + libre_graph_permissions_roles_allowedValues, + libre_graph_permissions_actions_allowedValues, + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfSchools.md b/packages/web-client/src/graph/generated/docs/CollectionOfSchools.md new file mode 100644 index 00000000000..6cacd338b2d --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfSchools.md @@ -0,0 +1,20 @@ +# CollectionOfSchools + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<EducationSchool>**](EducationSchool.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfSchools } from './api'; + +const instance: CollectionOfSchools = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfTags.md b/packages/web-client/src/graph/generated/docs/CollectionOfTags.md new file mode 100644 index 00000000000..742ce5f3725 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfTags.md @@ -0,0 +1,20 @@ +# CollectionOfTags + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **Array<string>** | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfTags } from './api'; + +const instance: CollectionOfTags = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfUser.md b/packages/web-client/src/graph/generated/docs/CollectionOfUser.md new file mode 100644 index 00000000000..b697ae76880 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfUser.md @@ -0,0 +1,22 @@ +# CollectionOfUser + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<User>**](User.md) | | [optional] [default to undefined] +**odata_nextLink** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfUser } from './api'; + +const instance: CollectionOfUser = { + value, + odata_nextLink, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/CollectionOfUsers.md b/packages/web-client/src/graph/generated/docs/CollectionOfUsers.md new file mode 100644 index 00000000000..0e4b064e7be --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/CollectionOfUsers.md @@ -0,0 +1,20 @@ +# CollectionOfUsers + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**Array<User>**](User.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { CollectionOfUsers } from './api'; + +const instance: CollectionOfUsers = { + value, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Deleted.md b/packages/web-client/src/graph/generated/docs/Deleted.md new file mode 100644 index 00000000000..7529adc90da --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Deleted.md @@ -0,0 +1,21 @@ +# Deleted + +Information about the deleted state of the item. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **string** | Represents the state of the deleted item. | [optional] [default to undefined] + +## Example + +```typescript +import { Deleted } from './api'; + +const instance: Deleted = { + state, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Drive.md b/packages/web-client/src/graph/generated/docs/Drive.md new file mode 100644 index 00000000000..34abe5c37ef --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Drive.md @@ -0,0 +1,53 @@ +# Drive + +The drive represents a space on the storage. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier for this drive. | [optional] [readonly] [default to undefined] +**createdBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**createdDateTime** | **string** | Date and time of item creation. Read-only. | [optional] [readonly] [default to undefined] +**description** | **string** | Provides a user-visible description of the item. Optional. | [optional] [default to undefined] +**eTag** | **string** | ETag for the item. Read-only. | [optional] [readonly] [default to undefined] +**lastModifiedBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**lastModifiedDateTime** | **string** | Date and time the item was last modified. Read-only. | [optional] [readonly] [default to undefined] +**name** | **string** | The name of the item. Read-write. | [default to undefined] +**parentReference** | [**ItemReference**](ItemReference.md) | | [optional] [default to undefined] +**webUrl** | **string** | URL that displays the resource in the browser. Read-only. | [optional] [readonly] [default to undefined] +**driveType** | **string** | Describes the type of drive represented by this resource. Values are \"personal\" for users home spaces, \"project\", \"virtual\" or \"share\". Read-only. | [optional] [readonly] [default to undefined] +**driveAlias** | **string** | The drive alias can be used in clients to make the urls user friendly. Example: \'personal/einstein\'. This will be used to resolve to the correct driveID. | [optional] [default to undefined] +**owner** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**quota** | [**Quota**](Quota.md) | | [optional] [default to undefined] +**items** | [**Array<DriveItem>**](DriveItem.md) | All items contained in the drive. Read-only. Nullable. | [optional] [readonly] [default to undefined] +**root** | [**DriveItem**](DriveItem.md) | | [optional] [default to undefined] +**special** | [**Array<DriveItem>**](DriveItem.md) | A collection of special drive resources. | [optional] [default to undefined] + +## Example + +```typescript +import { Drive } from './api'; + +const instance: Drive = { + id, + createdBy, + createdDateTime, + description, + eTag, + lastModifiedBy, + lastModifiedDateTime, + name, + parentReference, + webUrl, + driveType, + driveAlias, + owner, + quota, + items, + root, + special, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/DriveItem.md b/packages/web-client/src/graph/generated/docs/DriveItem.md new file mode 100644 index 00000000000..afb8d18feb0 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DriveItem.md @@ -0,0 +1,83 @@ +# DriveItem + +Represents a resource inside a drive. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Read-only. | [optional] [readonly] [default to undefined] +**createdBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**createdDateTime** | **string** | Date and time of item creation. Read-only. | [optional] [readonly] [default to undefined] +**description** | **string** | Provides a user-visible description of the item. Optional. | [optional] [default to undefined] +**eTag** | **string** | ETag for the item. Read-only. | [optional] [readonly] [default to undefined] +**lastModifiedBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**lastModifiedDateTime** | **string** | Date and time the item was last modified. Read-only. | [optional] [readonly] [default to undefined] +**name** | **string** | The name of the item. Read-write. | [optional] [default to undefined] +**parentReference** | [**ItemReference**](ItemReference.md) | | [optional] [default to undefined] +**webUrl** | **string** | URL that displays the resource in the browser. Read-only. | [optional] [readonly] [default to undefined] +**content** | **string** | The content stream, if the item represents a file. | [optional] [default to undefined] +**cTag** | **string** | An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only. | [optional] [readonly] [default to undefined] +**deleted** | [**Deleted**](Deleted.md) | | [optional] [default to undefined] +**file** | [**OpenGraphFile**](OpenGraphFile.md) | | [optional] [default to undefined] +**fileSystemInfo** | [**FileSystemInfo**](FileSystemInfo.md) | | [optional] [default to undefined] +**folder** | [**Folder**](Folder.md) | | [optional] [default to undefined] +**image** | [**Image**](Image.md) | | [optional] [default to undefined] +**photo** | [**Photo**](Photo.md) | | [optional] [default to undefined] +**location** | [**GeoCoordinates**](GeoCoordinates.md) | | [optional] [default to undefined] +**thumbnails** | [**Array<ThumbnailSet>**](ThumbnailSet.md) | Collection containing ThumbnailSet objects associated with the item. Read-only. Nullable. | [optional] [default to undefined] +**root** | **object** | If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. | [optional] [default to undefined] +**trash** | [**Trash**](Trash.md) | | [optional] [default to undefined] +**specialFolder** | [**SpecialFolder**](SpecialFolder.md) | | [optional] [default to undefined] +**remoteItem** | [**RemoteItem**](RemoteItem.md) | | [optional] [default to undefined] +**size** | **number** | Size of the item in bytes. Read-only. | [optional] [readonly] [default to undefined] +**webDavUrl** | **string** | WebDAV compatible URL for the item. Read-only. | [optional] [readonly] [default to undefined] +**children** | [**Array<DriveItem>**](DriveItem.md) | Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable. | [optional] [readonly] [default to undefined] +**permissions** | [**Array<Permission>**](Permission.md) | The set of permissions for the item. Read-only. Nullable. | [optional] [readonly] [default to undefined] +**audio** | [**Audio**](Audio.md) | | [optional] [default to undefined] +**video** | [**Video**](Video.md) | | [optional] [default to undefined] +**client_synchronize** | **boolean** | Indicates if the item is synchronized with the underlying storage provider. Read-only. | [optional] [default to undefined] +**UI_Hidden** | **boolean** | Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true. Users can set this to hide permissions. | [optional] [default to undefined] + +## Example + +```typescript +import { DriveItem } from './api'; + +const instance: DriveItem = { + id, + createdBy, + createdDateTime, + description, + eTag, + lastModifiedBy, + lastModifiedDateTime, + name, + parentReference, + webUrl, + content, + cTag, + deleted, + file, + fileSystemInfo, + folder, + image, + photo, + location, + thumbnails, + root, + trash, + specialFolder, + remoteItem, + size, + webDavUrl, + children, + permissions, + audio, + video, + client_synchronize, + UI_Hidden, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/DriveItemApi.md b/packages/web-client/src/graph/generated/docs/DriveItemApi.md new file mode 100644 index 00000000000..1d7ed0a0eab --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DriveItemApi.md @@ -0,0 +1,179 @@ +# DriveItemApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**deleteDriveItem**](#deletedriveitem) | **DELETE** /v1beta1/drives/{drive-id}/items/{item-id} | Delete a DriveItem.| +|[**getDriveItem**](#getdriveitem) | **GET** /v1beta1/drives/{drive-id}/items/{item-id} | Get a DriveItem.| +|[**updateDriveItem**](#updatedriveitem) | **PATCH** /v1beta1/drives/{drive-id}/items/{item-id} | Update a DriveItem.| + +# **deleteDriveItem** +> deleteDriveItem() + +Delete a DriveItem by using its ID. Deleting items using this method moves the items to the recycle bin instead of permanently deleting the item. Mounted shares in the share jail are unmounted. The `@client.synchronize` property of the `driveItem` in the [sharedWithMe](#/me.drive/ListSharedWithMe) endpoint will change to false. + +### Example + +```typescript +import { + DriveItemApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DriveItemApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) + +const { status, data } = await apiInstance.deleteDriveItem( + driveId, + itemId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getDriveItem** +> DriveItem getDriveItem() + +Get a DriveItem by using its ID. + +### Example + +```typescript +import { + DriveItemApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DriveItemApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) + +const { status, data } = await apiInstance.getDriveItem( + driveId, + itemId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| + + +### Return type + +**DriveItem** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved driveItem | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateDriveItem** +> DriveItem updateDriveItem(driveItem) + +Update a DriveItem. The request body must include a JSON object with the properties to update. Only the properties that are provided will be updated. Currently it supports updating the following properties: * `@UI.Hidden` - Hides the item from the UI. + +### Example + +```typescript +import { + DriveItemApi, + Configuration, + DriveItem +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DriveItemApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let driveItem: DriveItem; //DriveItem properties to update + +const { status, data } = await apiInstance.updateDriveItem( + driveId, + itemId, + driveItem +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveItem** | **DriveItem**| DriveItem properties to update | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| + + +### Return type + +**DriveItem** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/DriveItemCreateLink.md b/packages/web-client/src/graph/generated/docs/DriveItemCreateLink.md new file mode 100644 index 00000000000..cb7fdd24836 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DriveItemCreateLink.md @@ -0,0 +1,28 @@ +# DriveItemCreateLink + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**SharingLinkType**](SharingLinkType.md) | | [optional] [default to undefined] +**expirationDateTime** | **string** | Optional. A String with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission. | [optional] [default to undefined] +**password** | **string** | Optional.The password of the sharing link that is set by the creator. | [optional] [default to undefined] +**displayName** | **string** | Provides a user-visible display name of the link. Optional. Libregraph only. | [optional] [default to undefined] +**libre_graph_quickLink** | **boolean** | The quicklink property can be assigned to only one link per resource. A quicklink can be used in the clients to provide a one-click copy to clipboard action. Optional. Libregraph only. | [optional] [default to undefined] + +## Example + +```typescript +import { DriveItemCreateLink } from './api'; + +const instance: DriveItemCreateLink = { + type, + expirationDateTime, + password, + displayName, + libre_graph_quickLink, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/DriveItemInvite.md b/packages/web-client/src/graph/generated/docs/DriveItemInvite.md new file mode 100644 index 00000000000..ecc59ecaf70 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DriveItemInvite.md @@ -0,0 +1,26 @@ +# DriveItemInvite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recipients** | [**Array<DriveRecipient>**](DriveRecipient.md) | A collection of recipients who will receive access and the sharing invitation. Currently, only internal users or groups are supported. | [optional] [default to undefined] +**roles** | **Array<string>** | Specifies the roles that are to be granted to the recipients of the sharing invitation. | [optional] [default to undefined] +**libre_graph_permissions_actions** | **Array<string>** | Specifies the actions that are to be granted to the recipients of the sharing invitation, in effect creating a custom role. | [optional] [default to undefined] +**expirationDateTime** | **string** | Specifies the dateTime after which the permission expires. | [optional] [default to undefined] + +## Example + +```typescript +import { DriveItemInvite } from './api'; + +const instance: DriveItemInvite = { + recipients, + roles, + libre_graph_permissions_actions, + expirationDateTime, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/DriveRecipient.md b/packages/web-client/src/graph/generated/docs/DriveRecipient.md new file mode 100644 index 00000000000..8b14366d6fc --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DriveRecipient.md @@ -0,0 +1,23 @@ +# DriveRecipient + +Represents a person, group, or other recipient to share a drive item with using the invite action. When using invite to add permissions, the `driveRecipient` object would specify the `email`, `alias`, or `objectId` of the recipient. Only one of these values is required; multiple values are not accepted. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectId** | **string** | The unique identifier for the recipient in the directory. | [optional] [default to undefined] +**libre_graph_recipient_type** | **string** | When the recipient is referenced by objectId this annotation is used to differentiate `user` and `group` recipients. | [optional] [default to 'user'] + +## Example + +```typescript +import { DriveRecipient } from './api'; + +const instance: DriveRecipient = { + objectId, + libre_graph_recipient_type, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/DriveUpdate.md b/packages/web-client/src/graph/generated/docs/DriveUpdate.md new file mode 100644 index 00000000000..61010dceea3 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DriveUpdate.md @@ -0,0 +1,53 @@ +# DriveUpdate + +The drive represents an update to a space on the storage. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier for this drive. | [optional] [readonly] [default to undefined] +**createdBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**createdDateTime** | **string** | Date and time of item creation. Read-only. | [optional] [readonly] [default to undefined] +**description** | **string** | Provides a user-visible description of the item. Optional. | [optional] [default to undefined] +**eTag** | **string** | ETag for the item. Read-only. | [optional] [readonly] [default to undefined] +**lastModifiedBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**lastModifiedDateTime** | **string** | Date and time the item was last modified. Read-only. | [optional] [readonly] [default to undefined] +**name** | **string** | The name of the item. Read-write. | [optional] [default to undefined] +**parentReference** | [**ItemReference**](ItemReference.md) | | [optional] [default to undefined] +**webUrl** | **string** | URL that displays the resource in the browser. Read-only. | [optional] [readonly] [default to undefined] +**driveType** | **string** | Describes the type of drive represented by this resource. Values are \"personal\" for users home spaces, \"project\", \"virtual\" or \"share\". Read-only. | [optional] [readonly] [default to undefined] +**driveAlias** | **string** | The drive alias can be used in clients to make the urls user friendly. Example: \'personal/einstein\'. This will be used to resolve to the correct driveID. | [optional] [default to undefined] +**owner** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**quota** | [**Quota**](Quota.md) | | [optional] [default to undefined] +**items** | [**Array<DriveItem>**](DriveItem.md) | All items contained in the drive. Read-only. Nullable. | [optional] [readonly] [default to undefined] +**root** | [**DriveItem**](DriveItem.md) | | [optional] [default to undefined] +**special** | [**Array<DriveItem>**](DriveItem.md) | A collection of special drive resources. | [optional] [default to undefined] + +## Example + +```typescript +import { DriveUpdate } from './api'; + +const instance: DriveUpdate = { + id, + createdBy, + createdDateTime, + description, + eTag, + lastModifiedBy, + lastModifiedDateTime, + name, + parentReference, + webUrl, + driveType, + driveAlias, + owner, + quota, + items, + root, + special, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/DrivesApi.md b/packages/web-client/src/graph/generated/docs/DrivesApi.md new file mode 100644 index 00000000000..fe26e216e68 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DrivesApi.md @@ -0,0 +1,439 @@ +# DrivesApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createDrive**](#createdrive) | **POST** /v1.0/drives | Create a new drive of a specific type| +|[**createDriveBeta**](#createdrivebeta) | **POST** /v1beta1/drives | Create a new drive of a specific type. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles.| +|[**deleteDrive**](#deletedrive) | **DELETE** /v1.0/drives/{drive-id} | Delete a specific space| +|[**deleteDriveBeta**](#deletedrivebeta) | **DELETE** /v1beta1/drives/{drive-id} | Delete a specific space. Alias for \'/v1.0/drives\'.| +|[**getDrive**](#getdrive) | **GET** /v1.0/drives/{drive-id} | Get drive by id| +|[**getDriveBeta**](#getdrivebeta) | **GET** /v1beta1/drives/{drive-id} | Get drive by id. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles| +|[**updateDrive**](#updatedrive) | **PATCH** /v1.0/drives/{drive-id} | Update the drive| +|[**updateDriveBeta**](#updatedrivebeta) | **PATCH** /v1beta1/drives/{drive-id} | Update the drive. Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles| + +# **createDrive** +> Drive createDrive(drive) + + +### Example + +```typescript +import { + DrivesApi, + Configuration, + Drive +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let drive: Drive; //New space property values + +const { status, data } = await apiInstance.createDrive( + drive +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **drive** | **Drive**| New space property values | | + + +### Return type + +**Drive** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createDriveBeta** +> Drive createDriveBeta(drive) + + +### Example + +```typescript +import { + DrivesApi, + Configuration, + Drive +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let drive: Drive; //New space property values + +const { status, data } = await apiInstance.createDriveBeta( + drive +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **drive** | **Drive**| New space property values | | + + +### Return type + +**Drive** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteDrive** +> deleteDrive() + + +### Example + +```typescript +import { + DrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let ifMatch: string; //ETag (optional) (default to undefined) + +const { status, data } = await apiInstance.deleteDrive( + driveId, + ifMatch +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **ifMatch** | [**string**] | ETag | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteDriveBeta** +> deleteDriveBeta() + + +### Example + +```typescript +import { + DrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let ifMatch: string; //ETag (optional) (default to undefined) + +const { status, data } = await apiInstance.deleteDriveBeta( + driveId, + ifMatch +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **ifMatch** | [**string**] | ETag | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getDrive** +> Drive getDrive() + + +### Example + +```typescript +import { + DrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) + +const { status, data } = await apiInstance.getDrive( + driveId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**Drive** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved drive | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getDriveBeta** +> Drive getDriveBeta() + + +### Example + +```typescript +import { + DrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) + +const { status, data } = await apiInstance.getDriveBeta( + driveId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**Drive** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved drive | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateDrive** +> Drive updateDrive(driveUpdate) + + +### Example + +```typescript +import { + DrivesApi, + Configuration, + DriveUpdate +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let driveUpdate: DriveUpdate; //New space values + +const { status, data } = await apiInstance.updateDrive( + driveId, + driveUpdate +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveUpdate** | **DriveUpdate**| New space values | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**Drive** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateDriveBeta** +> Drive updateDriveBeta(driveUpdate) + + +### Example + +```typescript +import { + DrivesApi, + Configuration, + DriveUpdate +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let driveUpdate: DriveUpdate; //New space values + +const { status, data } = await apiInstance.updateDriveBeta( + driveId, + driveUpdate +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveUpdate** | **DriveUpdate**| New space values | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**Drive** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/DrivesGetDrivesApi.md b/packages/web-client/src/graph/generated/docs/DrivesGetDrivesApi.md new file mode 100644 index 00000000000..1f5d2149e34 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DrivesGetDrivesApi.md @@ -0,0 +1,117 @@ +# DrivesGetDrivesApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**listAllDrives**](#listalldrives) | **GET** /v1.0/drives | Get all available drives| +|[**listAllDrivesBeta**](#listalldrivesbeta) | **GET** /v1beta1/drives | Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles| + +# **listAllDrives** +> CollectionOfDrives1 listAllDrives() + + +### Example + +```typescript +import { + DrivesGetDrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesGetDrivesApi(configuration); + +let $orderby: string; //The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. (optional) (default to undefined) +let $filter: string; //Filter items by property values (optional) (default to undefined) + +const { status, data } = await apiInstance.listAllDrives( + $orderby, + $filter +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$orderby** | [**string**] | The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. | (optional) defaults to undefined| +| **$filter** | [**string**] | Filter items by property values | (optional) defaults to undefined| + + +### Return type + +**CollectionOfDrives1** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved spaces | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listAllDrivesBeta** +> CollectionOfDrives1 listAllDrivesBeta() + + +### Example + +```typescript +import { + DrivesGetDrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesGetDrivesApi(configuration); + +let $orderby: string; //The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. (optional) (default to undefined) +let $filter: string; //Filter items by property values (optional) (default to undefined) + +const { status, data } = await apiInstance.listAllDrivesBeta( + $orderby, + $filter +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$orderby** | [**string**] | The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. | (optional) defaults to undefined| +| **$filter** | [**string**] | Filter items by property values | (optional) defaults to undefined| + + +### Return type + +**CollectionOfDrives1** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved spaces | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/DrivesPermissionsApi.md b/packages/web-client/src/graph/generated/docs/DrivesPermissionsApi.md new file mode 100644 index 00000000000..e60aee2b94c --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DrivesPermissionsApi.md @@ -0,0 +1,436 @@ +# DrivesPermissionsApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createLink**](#createlink) | **POST** /v1beta1/drives/{drive-id}/items/{item-id}/createLink | Create a sharing link for a DriveItem| +|[**deletePermission**](#deletepermission) | **DELETE** /v1beta1/drives/{drive-id}/items/{item-id}/permissions/{perm-id} | Remove access to a DriveItem| +|[**getPermission**](#getpermission) | **GET** /v1beta1/drives/{drive-id}/items/{item-id}/permissions/{perm-id} | Get sharing permission for a file or folder| +|[**invite**](#invite) | **POST** /v1beta1/drives/{drive-id}/items/{item-id}/invite | Send a sharing invitation| +|[**listPermissions**](#listpermissions) | **GET** /v1beta1/drives/{drive-id}/items/{item-id}/permissions | List the effective sharing permissions on a driveItem.| +|[**setPermissionPassword**](#setpermissionpassword) | **POST** /v1beta1/drives/{drive-id}/items/{item-id}/permissions/{perm-id}/setPassword | Set sharing link password| +|[**updatePermission**](#updatepermission) | **PATCH** /v1beta1/drives/{drive-id}/items/{item-id}/permissions/{perm-id} | Update sharing permission| + +# **createLink** +> Permission createLink() + +You can use the createLink action to share a driveItem via a sharing link. The response will be a permission object with the link facet containing the created link details. ## Link types For now, The following values are allowed for the type parameter. | Value | Display name | Description | | -------------- | ----------------- | --------------------------------------------------------------- | | view | View | Creates a read-only link to the driveItem. | | upload | Upload | Creates a read-write link to the folder driveItem. | | edit | Edit | Creates a read-write link to the driveItem. | | createOnly | File Drop | Creates an upload-only link to the folder driveItem. | | blocksDownload | Secure View | Creates a read-only link that blocks download to the driveItem. | + +### Example + +```typescript +import { + DrivesPermissionsApi, + Configuration, + DriveItemCreateLink +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesPermissionsApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let driveItemCreateLink: DriveItemCreateLink; //In the request body, provide a JSON object with the following parameters. (optional) + +const { status, data } = await apiInstance.createLink( + driveId, + itemId, + driveItemCreateLink +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveItemCreateLink** | **DriveItemCreateLink**| In the request body, provide a JSON object with the following parameters. | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Response | - | +|**207** | Partial success response TODO | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deletePermission** +> deletePermission() + +Remove access to a DriveItem. Only sharing permissions that are not inherited can be deleted. The `inheritedFrom` property must be `null`. + +### Example + +```typescript +import { + DrivesPermissionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesPermissionsApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let permId: string; //key: id of permission (default to undefined) + +const { status, data } = await apiInstance.deletePermission( + driveId, + itemId, + permId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getPermission** +> Permission getPermission() + +Return the effective sharing permission for a particular permission resource. + +### Example + +```typescript +import { + DrivesPermissionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesPermissionsApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let permId: string; //key: id of permission (default to undefined) + +const { status, data } = await apiInstance.getPermission( + driveId, + itemId, + permId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved resource | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **invite** +> CollectionOfPermissions invite() + +Sends a sharing invitation for a `driveItem`. A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link. The response will be a permission object with the grantedToV2 property containing the created grant details. ## Roles property values For now, roles are only identified by a uuid. There are no hardcoded aliases like `read` or `write` because role actions can be completely customized. + +### Example + +```typescript +import { + DrivesPermissionsApi, + Configuration, + DriveItemInvite +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesPermissionsApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let driveItemInvite: DriveItemInvite; //In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. (optional) + +const { status, data } = await apiInstance.invite( + driveId, + itemId, + driveItemInvite +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveItemInvite** | **DriveItemInvite**| In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| + + +### Return type + +**CollectionOfPermissions** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Response | - | +|**207** | Partial success response TODO | - | +|**400** | Bad request | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listPermissions** +> CollectionOfPermissionsWithAllowedValues listPermissions() + +The permissions collection includes potentially sensitive information and may not be available for every caller. * For the owner of the item, all sharing permissions will be returned. This includes co-owners. * For a non-owner caller, only the sharing permissions that apply to the caller are returned. * Sharing permission properties that contain secrets (e.g. `webUrl`) are only returned for callers that are able to create the sharing permission. All permission objects have an `id`. A permission representing * a link has the `link` facet filled with details. * a share has the `roles` property set and the `grantedToV2` property filled with the grant recipient details. + +### Example + +```typescript +import { + DrivesPermissionsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesPermissionsApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let $filter: string; //Filter items by property values. By default all permissions are returned and the avalable sharing roles are limited to normal users. To get a list of sharing roles applicable to federated users use the example $select query and combine it with $filter to omit the list of permissions. (optional) (default to undefined) +let $select: Set<'@libre.graph.permissions.actions.allowedValues' | '@libre.graph.permissions.roles.allowedValues' | 'value'>; //Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. (optional) (default to undefined) + +const { status, data } = await apiInstance.listPermissions( + driveId, + itemId, + $filter, + $select +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| +| **$filter** | [**string**] | Filter items by property values. By default all permissions are returned and the avalable sharing roles are limited to normal users. To get a list of sharing roles applicable to federated users use the example $select query and combine it with $filter to omit the list of permissions. | (optional) defaults to undefined| +| **$select** | **Array<'@libre.graph.permissions.actions.allowedValues' | '@libre.graph.permissions.roles.allowedValues' | 'value'>** | Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. | (optional) defaults to undefined| + + +### Return type + +**CollectionOfPermissionsWithAllowedValues** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved resource | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setPermissionPassword** +> Permission setPermissionPassword(sharingLinkPassword) + +Set the password of a sharing permission. Only the `password` property can be modified this way. + +### Example + +```typescript +import { + DrivesPermissionsApi, + Configuration, + SharingLinkPassword +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesPermissionsApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let permId: string; //key: id of permission (default to undefined) +let sharingLinkPassword: SharingLinkPassword; //New password value + +const { status, data } = await apiInstance.setPermissionPassword( + driveId, + itemId, + permId, + sharingLinkPassword +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sharingLinkPassword** | **SharingLinkPassword**| New password value | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated permission | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updatePermission** +> Permission updatePermission(permission) + +Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. + +### Example + +```typescript +import { + DrivesPermissionsApi, + Configuration, + Permission +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesPermissionsApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let itemId: string; //key: id of item (default to undefined) +let permId: string; //key: id of permission (default to undefined) +let permission: Permission; //New property values + +const { status, data } = await apiInstance.updatePermission( + driveId, + itemId, + permId, + permission +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **permission** | **Permission**| New property values | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **itemId** | [**string**] | key: id of item | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated permission | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/DrivesRootApi.md b/packages/web-client/src/graph/generated/docs/DrivesRootApi.md new file mode 100644 index 00000000000..cd32aeaec0e --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/DrivesRootApi.md @@ -0,0 +1,524 @@ +# DrivesRootApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createDriveItem**](#createdriveitem) | **POST** /v1beta1/drives/{drive-id}/root/children | Create a drive item| +|[**createLinkSpaceRoot**](#createlinkspaceroot) | **POST** /v1beta1/drives/{drive-id}/root/createLink | Create a sharing link for the root item of a Drive| +|[**deletePermissionSpaceRoot**](#deletepermissionspaceroot) | **DELETE** /v1beta1/drives/{drive-id}/root/permissions/{perm-id} | Remove access to a Drive| +|[**getPermissionSpaceRoot**](#getpermissionspaceroot) | **GET** /v1beta1/drives/{drive-id}/root/permissions/{perm-id} | Get a single sharing permission for the root item of a drive| +|[**getRoot**](#getroot) | **GET** /v1.0/drives/{drive-id}/root | Get root from arbitrary space| +|[**inviteSpaceRoot**](#invitespaceroot) | **POST** /v1beta1/drives/{drive-id}/root/invite | Send a sharing invitation| +|[**listPermissionsSpaceRoot**](#listpermissionsspaceroot) | **GET** /v1beta1/drives/{drive-id}/root/permissions | List the effective permissions on the root item of a drive.| +|[**setPermissionPasswordSpaceRoot**](#setpermissionpasswordspaceroot) | **POST** /v1beta1/drives/{drive-id}/root/permissions/{perm-id}/setPassword | Set sharing link password for the root item of a drive| +|[**updatePermissionSpaceRoot**](#updatepermissionspaceroot) | **PATCH** /v1beta1/drives/{drive-id}/root/permissions/{perm-id} | Update sharing permission| + +# **createDriveItem** +> DriveItem createDriveItem() + +You can use the root childrens endpoint to mount a remoteItem in the share jail. The `@client.synchronize` property of the `driveItem` in the [sharedWithMe](#/me.drive/ListSharedWithMe) endpoint will change to true. + +### Example + +```typescript +import { + DrivesRootApi, + Configuration, + DriveItem +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let driveItem: DriveItem; //In the request body, provide a JSON object with the following parameters. For mounting a share the necessary remoteItem id and permission id can be taken from the [sharedWithMe](#/me.drive/ListSharedWithMe) endpoint. (optional) + +const { status, data } = await apiInstance.createDriveItem( + driveId, + driveItem +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveItem** | **DriveItem**| In the request body, provide a JSON object with the following parameters. For mounting a share the necessary remoteItem id and permission id can be taken from the [sharedWithMe](#/me.drive/ListSharedWithMe) endpoint. | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**DriveItem** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Response | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createLinkSpaceRoot** +> Permission createLinkSpaceRoot() + +You can use the createLink action to share a driveItem via a sharing link. The response will be a permission object with the link facet containing the created link details. ## Link types For now, The following values are allowed for the type parameter. | Value | Display name | Description | | -------------- | ----------------- | --------------------------------------------------------------- | | view | View | Creates a read-only link to the driveItem. | | upload | Upload | Creates a read-write link to the folder driveItem. | | edit | Edit | Creates a read-write link to the driveItem. | | createOnly | File Drop | Creates an upload-only link to the folder driveItem. | | blocksDownload | Secure View | Creates a read-only link that blocks download to the driveItem. | + +### Example + +```typescript +import { + DrivesRootApi, + Configuration, + DriveItemCreateLink +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let driveItemCreateLink: DriveItemCreateLink; //In the request body, provide a JSON object with the following parameters. (optional) + +const { status, data } = await apiInstance.createLinkSpaceRoot( + driveId, + driveItemCreateLink +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveItemCreateLink** | **DriveItemCreateLink**| In the request body, provide a JSON object with the following parameters. | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Response | - | +|**207** | Partial success response TODO | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deletePermissionSpaceRoot** +> deletePermissionSpaceRoot() + +Remove access to the root item of a drive. Only sharing permissions that are not inherited can be deleted. The `inheritedFrom` property must be `null`. + +### Example + +```typescript +import { + DrivesRootApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let permId: string; //key: id of permission (default to undefined) + +const { status, data } = await apiInstance.deletePermissionSpaceRoot( + driveId, + permId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getPermissionSpaceRoot** +> Permission getPermissionSpaceRoot() + +Return the effective sharing permission for a particular permission resource. + +### Example + +```typescript +import { + DrivesRootApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let permId: string; //key: id of permission (default to undefined) + +const { status, data } = await apiInstance.getPermissionSpaceRoot( + driveId, + permId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved resource | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getRoot** +> DriveItem getRoot() + + +### Example + +```typescript +import { + DrivesRootApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) + +const { status, data } = await apiInstance.getRoot( + driveId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**DriveItem** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved resource | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **inviteSpaceRoot** +> CollectionOfPermissions inviteSpaceRoot() + +Sends a sharing invitation for the root of a `drive`. A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link. The response will be a permission object with the grantedToV2 property containing the created grant details. ## Roles property values For now, roles are only identified by a uuid. There are no hardcoded aliases like `read` or `write` because role actions can be completely customized. + +### Example + +```typescript +import { + DrivesRootApi, + Configuration, + DriveItemInvite +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let driveItemInvite: DriveItemInvite; //In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. (optional) + +const { status, data } = await apiInstance.inviteSpaceRoot( + driveId, + driveItemInvite +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveItemInvite** | **DriveItemInvite**| In the request body, provide a JSON object with the following parameters. To create a custom role submit a list of actions instead of roles. | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| + + +### Return type + +**CollectionOfPermissions** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Response | - | +|**207** | Partial success response TODO | - | +|**400** | Bad request | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listPermissionsSpaceRoot** +> CollectionOfPermissionsWithAllowedValues listPermissionsSpaceRoot() + +The permissions collection includes potentially sensitive information and may not be available for every caller. * For the owner of the item, all sharing permissions will be returned. This includes co-owners. * For a non-owner caller, only the sharing permissions that apply to the caller are returned. * Sharing permission properties that contain secrets (e.g. `webUrl`) are only returned for callers that are able to create the sharing permission. All permission objects have an `id`. A permission representing * a link has the `link` facet filled with details. * a share has the `roles` property set and the `grantedToV2` property filled with the grant recipient details. + +### Example + +```typescript +import { + DrivesRootApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let $filter: string; //Filter items by property values. By default all permissions are returned and the avalable sharing roles are limited to normal users. To get a list of sharing roles applicable to federated users use the example $select query and combine it with $filter to omit the list of permissions. (optional) (default to undefined) +let $select: Set<'@libre.graph.permissions.actions.allowedValues' | '@libre.graph.permissions.roles.allowedValues' | 'value'>; //Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. (optional) (default to undefined) + +const { status, data } = await apiInstance.listPermissionsSpaceRoot( + driveId, + $filter, + $select +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **$filter** | [**string**] | Filter items by property values. By default all permissions are returned and the avalable sharing roles are limited to normal users. To get a list of sharing roles applicable to federated users use the example $select query and combine it with $filter to omit the list of permissions. | (optional) defaults to undefined| +| **$select** | **Array<'@libre.graph.permissions.actions.allowedValues' | '@libre.graph.permissions.roles.allowedValues' | 'value'>** | Select properties to be returned. By default all properties are returned. Select the roles property to fetch the available sharing roles without resolving all the permissions. Combine this with the $filter parameter to fetch the actions applicable to federated users. | (optional) defaults to undefined| + + +### Return type + +**CollectionOfPermissionsWithAllowedValues** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved resource | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setPermissionPasswordSpaceRoot** +> Permission setPermissionPasswordSpaceRoot(sharingLinkPassword) + +Set the password of a sharing permission. Only the `password` property can be modified this way. + +### Example + +```typescript +import { + DrivesRootApi, + Configuration, + SharingLinkPassword +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let permId: string; //key: id of permission (default to undefined) +let sharingLinkPassword: SharingLinkPassword; //New password value + +const { status, data } = await apiInstance.setPermissionPasswordSpaceRoot( + driveId, + permId, + sharingLinkPassword +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **sharingLinkPassword** | **SharingLinkPassword**| New password value | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated permission | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updatePermissionSpaceRoot** +> Permission updatePermissionSpaceRoot(permission) + +Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. + +### Example + +```typescript +import { + DrivesRootApi, + Configuration, + Permission +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new DrivesRootApi(configuration); + +let driveId: string; //key: id of drive (default to undefined) +let permId: string; //key: id of permission (default to undefined) +let permission: Permission; //New property values + +const { status, data } = await apiInstance.updatePermissionSpaceRoot( + driveId, + permId, + permission +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **permission** | **Permission**| New property values | | +| **driveId** | [**string**] | key: id of drive | defaults to undefined| +| **permId** | [**string**] | key: id of permission | defaults to undefined| + + +### Return type + +**Permission** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Updated permission | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/EducationClass.md b/packages/web-client/src/graph/generated/docs/EducationClass.md new file mode 100644 index 00000000000..8e42b8200f3 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationClass.md @@ -0,0 +1,33 @@ +# EducationClass + +And extension of group representing a class or course + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Read-only. | [optional] [readonly] [default to undefined] +**description** | **string** | An optional description for the group. Returned by default. | [optional] [default to undefined] +**displayName** | **string** | The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $search and $orderBy. | [optional] [default to undefined] +**members** | [**Array<User>**](User.md) | Users and groups that are members of this group. HTTP Methods: GET (supported for all groups), Nullable. Supports $expand. | [optional] [default to undefined] +**membersodata_bind** | **Set<string>** | A list of member references to the members to be added. Up to 20 members can be added with a single request | [optional] [default to undefined] +**classification** | **string** | Classification of the group, i.e. \"class\" or \"course\" | [optional] [default to undefined] +**externalId** | **string** | An external unique ID for the class | [optional] [default to undefined] + +## Example + +```typescript +import { EducationClass } from './api'; + +const instance: EducationClass = { + id, + description, + displayName, + members, + membersodata_bind, + classification, + externalId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/EducationClassApi.md b/packages/web-client/src/graph/generated/docs/EducationClassApi.md new file mode 100644 index 00000000000..07c326e5fe5 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationClassApi.md @@ -0,0 +1,429 @@ +# EducationClassApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**addUserToClass**](#addusertoclass) | **POST** /v1.0/education/classes/{class-id}/members/$ref | Assign a user to a class| +|[**createClass**](#createclass) | **POST** /v1.0/education/classes | Add new education class| +|[**deleteClass**](#deleteclass) | **DELETE** /v1.0/education/classes/{class-id} | Delete education class| +|[**deleteUserFromClass**](#deleteuserfromclass) | **DELETE** /v1.0/education/classes/{class-id}/members/{user-id}/$ref | Unassign user from a class| +|[**getClass**](#getclass) | **GET** /v1.0/education/classes/{class-id} | Get class by key| +|[**listClassMembers**](#listclassmembers) | **GET** /v1.0/education/classes/{class-id}/members | Get the educationClass resources owned by an educationSchool| +|[**listClasses**](#listclasses) | **GET** /v1.0/education/classes | list education classes| +|[**updateClass**](#updateclass) | **PATCH** /v1.0/education/classes/{class-id} | Update properties of a education class| + +# **addUserToClass** +> addUserToClass(classMemberReference) + + +### Example + +```typescript +import { + EducationClassApi, + Configuration, + ClassMemberReference +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) +let classMemberReference: ClassMemberReference; //educationUser to be added as member + +const { status, data } = await apiInstance.addUserToClass( + classId, + classMemberReference +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classMemberReference** | **ClassMemberReference**| educationUser to be added as member | | +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createClass** +> EducationClass createClass(educationClass) + + +### Example + +```typescript +import { + EducationClassApi, + Configuration, + EducationClass +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +let educationClass: EducationClass; //New entity + +const { status, data } = await apiInstance.createClass( + educationClass +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **educationClass** | **EducationClass**| New entity | | + + +### Return type + +**EducationClass** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteClass** +> deleteClass() + + +### Example + +```typescript +import { + EducationClassApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) + +const { status, data } = await apiInstance.deleteClass( + classId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteUserFromClass** +> deleteUserFromClass() + + +### Example + +```typescript +import { + EducationClassApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) +let userId: string; //key: id or username of the user to unassign from class (default to undefined) + +const { status, data } = await apiInstance.deleteUserFromClass( + classId, + userId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| +| **userId** | [**string**] | key: id or username of the user to unassign from class | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getClass** +> EducationClass getClass() + + +### Example + +```typescript +import { + EducationClassApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) + +const { status, data } = await apiInstance.getClass( + classId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| + + +### Return type + +**EducationClass** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listClassMembers** +> CollectionOfEducationUser listClassMembers() + + +### Example + +```typescript +import { + EducationClassApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) + +const { status, data } = await apiInstance.listClassMembers( + classId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| + + +### Return type + +**CollectionOfEducationUser** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved class members | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listClasses** +> CollectionOfClass listClasses() + + +### Example + +```typescript +import { + EducationClassApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +const { status, data } = await apiInstance.listClasses(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**CollectionOfClass** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entities | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateClass** +> EducationClass updateClass(educationClass) + + +### Example + +```typescript +import { + EducationClassApi, + Configuration, + EducationClass +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) +let educationClass: EducationClass; //New property values + +const { status, data } = await apiInstance.updateClass( + classId, + educationClass +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **educationClass** | **EducationClass**| New property values | | +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| + + +### Return type + +**EducationClass** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | New property values | - | +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/EducationClassTeachersApi.md b/packages/web-client/src/graph/generated/docs/EducationClassTeachersApi.md new file mode 100644 index 00000000000..c9610b8b08b --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationClassTeachersApi.md @@ -0,0 +1,170 @@ +# EducationClassTeachersApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**addTeacherToClass**](#addteachertoclass) | **POST** /v1.0/education/classes/{class-id}/teachers/$ref | Assign a teacher to a class| +|[**deleteTeacherFromClass**](#deleteteacherfromclass) | **DELETE** /v1.0/education/classes/{class-id}/teachers/{user-id}/$ref | Unassign user as teacher of a class| +|[**getTeachers**](#getteachers) | **GET** /v1.0/education/classes/{class-id}/teachers | Get the teachers for a class| + +# **addTeacherToClass** +> addTeacherToClass(classTeacherReference) + + +### Example + +```typescript +import { + EducationClassTeachersApi, + Configuration, + ClassTeacherReference +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassTeachersApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) +let classTeacherReference: ClassTeacherReference; //educationUser to be added as teacher + +const { status, data } = await apiInstance.addTeacherToClass( + classId, + classTeacherReference +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classTeacherReference** | **ClassTeacherReference**| educationUser to be added as teacher | | +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteTeacherFromClass** +> deleteTeacherFromClass() + + +### Example + +```typescript +import { + EducationClassTeachersApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassTeachersApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) +let userId: string; //key: id or username of the user to unassign as teacher (default to undefined) + +const { status, data } = await apiInstance.deleteTeacherFromClass( + classId, + userId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| +| **userId** | [**string**] | key: id or username of the user to unassign as teacher | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getTeachers** +> CollectionOfEducationUser getTeachers() + + +### Example + +```typescript +import { + EducationClassTeachersApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationClassTeachersApi(configuration); + +let classId: string; //key: id or externalId of class (default to undefined) + +const { status, data } = await apiInstance.getTeachers( + classId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classId** | [**string**] | key: id or externalId of class | defaults to undefined| + + +### Return type + +**CollectionOfEducationUser** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved class teachers | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/EducationSchool.md b/packages/web-client/src/graph/generated/docs/EducationSchool.md new file mode 100644 index 00000000000..13d3f71cfcf --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationSchool.md @@ -0,0 +1,27 @@ +# EducationSchool + +Represents a school + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier for an entity. Read-only. | [optional] [readonly] [default to undefined] +**displayName** | **string** | The organization name | [optional] [default to undefined] +**schoolNumber** | **string** | School number | [optional] [default to undefined] +**terminationDate** | **string** | Date and time at which the service for this organization is scheduled to be terminated | [optional] [default to undefined] + +## Example + +```typescript +import { EducationSchool } from './api'; + +const instance: EducationSchool = { + id, + displayName, + schoolNumber, + terminationDate, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/EducationSchoolApi.md b/packages/web-client/src/graph/generated/docs/EducationSchoolApi.md new file mode 100644 index 00000000000..0a840576c92 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationSchoolApi.md @@ -0,0 +1,592 @@ +# EducationSchoolApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**addClassToSchool**](#addclasstoschool) | **POST** /v1.0/education/schools/{school-id}/classes/$ref | Assign a class to a school| +|[**addUserToSchool**](#addusertoschool) | **POST** /v1.0/education/schools/{school-id}/users/$ref | Assign a user to a school| +|[**createSchool**](#createschool) | **POST** /v1.0/education/schools | Add new school| +|[**deleteClassFromSchool**](#deleteclassfromschool) | **DELETE** /v1.0/education/schools/{school-id}/classes/{class-id}/$ref | Unassign class from a school| +|[**deleteSchool**](#deleteschool) | **DELETE** /v1.0/education/schools/{school-id} | Delete school| +|[**deleteUserFromSchool**](#deleteuserfromschool) | **DELETE** /v1.0/education/schools/{school-id}/users/{user-id}/$ref | Unassign user from a school| +|[**getSchool**](#getschool) | **GET** /v1.0/education/schools/{school-id} | Get the properties of a specific school| +|[**listSchoolClasses**](#listschoolclasses) | **GET** /v1.0/education/schools/{school-id}/classes | Get the educationClass resources owned by an educationSchool| +|[**listSchoolUsers**](#listschoolusers) | **GET** /v1.0/education/schools/{school-id}/users | Get the educationUser resources associated with an educationSchool| +|[**listSchools**](#listschools) | **GET** /v1.0/education/schools | Get a list of schools and their properties| +|[**updateSchool**](#updateschool) | **PATCH** /v1.0/education/schools/{school-id} | Update properties of a school| + +# **addClassToSchool** +> addClassToSchool(classReference) + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration, + ClassReference +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) +let classReference: ClassReference; //educationClass to be added as member + +const { status, data } = await apiInstance.addClassToSchool( + schoolId, + classReference +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **classReference** | **ClassReference**| educationClass to be added as member | | +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **addUserToSchool** +> addUserToSchool(educationUserReference) + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration, + EducationUserReference +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) +let educationUserReference: EducationUserReference; //educationUser to be added as member + +const { status, data } = await apiInstance.addUserToSchool( + schoolId, + educationUserReference +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **educationUserReference** | **EducationUserReference**| educationUser to be added as member | | +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createSchool** +> EducationSchool createSchool(educationSchool) + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration, + EducationSchool +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let educationSchool: EducationSchool; //New school + +const { status, data } = await apiInstance.createSchool( + educationSchool +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **educationSchool** | **EducationSchool**| New school | | + + +### Return type + +**EducationSchool** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteClassFromSchool** +> deleteClassFromSchool() + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) +let classId: string; //key: id or externalId of the class to unassign from school (default to undefined) + +const { status, data } = await apiInstance.deleteClassFromSchool( + schoolId, + classId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| +| **classId** | [**string**] | key: id or externalId of the class to unassign from school | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteSchool** +> deleteSchool() + +Deletes a school. A school can only be delete if it has the terminationDate property set. And if that termination Date is in the past. + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) + +const { status, data } = await apiInstance.deleteSchool( + schoolId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteUserFromSchool** +> deleteUserFromSchool() + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) +let userId: string; //key: id or username of the user to unassign from school (default to undefined) + +const { status, data } = await apiInstance.deleteUserFromSchool( + schoolId, + userId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| +| **userId** | [**string**] | key: id or username of the user to unassign from school | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSchool** +> EducationSchool getSchool() + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) + +const { status, data } = await apiInstance.getSchool( + schoolId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| + + +### Return type + +**EducationSchool** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listSchoolClasses** +> CollectionOfEducationClass listSchoolClasses() + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) + +const { status, data } = await apiInstance.listSchoolClasses( + schoolId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| + + +### Return type + +**CollectionOfEducationClass** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved classes | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listSchoolUsers** +> CollectionOfEducationUser listSchoolUsers() + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) + +const { status, data } = await apiInstance.listSchoolUsers( + schoolId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| + + +### Return type + +**CollectionOfEducationUser** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved educationUser | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listSchools** +> CollectionOfSchools listSchools() + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +const { status, data } = await apiInstance.listSchools(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**CollectionOfSchools** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entities | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateSchool** +> EducationSchool updateSchool(educationSchool) + + +### Example + +```typescript +import { + EducationSchoolApi, + Configuration, + EducationSchool +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationSchoolApi(configuration); + +let schoolId: string; //key: id or schoolNumber of school (default to undefined) +let educationSchool: EducationSchool; //New property values + +const { status, data } = await apiInstance.updateSchool( + schoolId, + educationSchool +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **educationSchool** | **EducationSchool**| New property values | | +| **schoolId** | [**string**] | key: id or schoolNumber of school | defaults to undefined| + + +### Return type + +**EducationSchool** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/EducationUser.md b/packages/web-client/src/graph/generated/docs/EducationUser.md new file mode 100644 index 00000000000..4856d2c3514 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationUser.md @@ -0,0 +1,49 @@ +# EducationUser + +An extension of user with education-specific attributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Read-only. | [optional] [readonly] [default to undefined] +**accountEnabled** | **boolean** | Set to \"true\" when the account is enabled. | [optional] [default to undefined] +**displayName** | **string** | The name displayed in the address book for the user. This value is usually the combination of the user\'s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Returned by default. Supports $orderby. | [optional] [default to undefined] +**drives** | [**Array<Drive>**](Drive.md) | A collection of drives available for this user. Read-only. | [optional] [readonly] [default to undefined] +**drive** | [**Drive**](Drive.md) | | [optional] [default to undefined] +**identities** | [**Array<ObjectIdentity>**](ObjectIdentity.md) | Identities associated with this account. | [optional] [default to undefined] +**mail** | **string** | The SMTP address for the user, for example, \'jeff@contoso.onowncloud.com\'. Returned by default. | [optional] [default to undefined] +**memberOf** | [**Array<Group>**](Group.md) | Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. | [optional] [default to undefined] +**onPremisesSamAccountName** | **string** | Contains the on-premises SAM account name synchronized from the on-premises directory. Read-only. | [optional] [default to undefined] +**passwordProfile** | [**PasswordProfile**](PasswordProfile.md) | | [optional] [default to undefined] +**surname** | **string** | The user\'s surname (family name or last name). Returned by default. | [optional] [default to undefined] +**givenName** | **string** | The user\'s givenName. Returned by default. | [optional] [default to undefined] +**primaryRole** | **string** | The user`s default role. Such as \"student\" or \"teacher\" | [optional] [default to undefined] +**userType** | **string** | The user`s type. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. | [optional] [default to undefined] +**externalID** | **string** | A unique identifier for the user assigned by the school or institution. | [optional] [default to undefined] + +## Example + +```typescript +import { EducationUser } from './api'; + +const instance: EducationUser = { + id, + accountEnabled, + displayName, + drives, + drive, + identities, + mail, + memberOf, + onPremisesSamAccountName, + passwordProfile, + surname, + givenName, + primaryRole, + userType, + externalID, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/EducationUserApi.md b/packages/web-client/src/graph/generated/docs/EducationUserApi.md new file mode 100644 index 00000000000..5309d112241 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationUserApi.md @@ -0,0 +1,279 @@ +# EducationUserApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createEducationUser**](#createeducationuser) | **POST** /v1.0/education/users | Add new education user| +|[**deleteEducationUser**](#deleteeducationuser) | **DELETE** /v1.0/education/users/{user-id} | Delete educationUser| +|[**getEducationUser**](#geteducationuser) | **GET** /v1.0/education/users/{user-id} | Get properties of educationUser| +|[**listEducationUsers**](#listeducationusers) | **GET** /v1.0/education/users | Get entities from education users| +|[**updateEducationUser**](#updateeducationuser) | **PATCH** /v1.0/education/users/{user-id} | Update properties of educationUser| + +# **createEducationUser** +> EducationUser createEducationUser(educationUser) + + +### Example + +```typescript +import { + EducationUserApi, + Configuration, + EducationUser +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationUserApi(configuration); + +let educationUser: EducationUser; //New entity + +const { status, data } = await apiInstance.createEducationUser( + educationUser +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **educationUser** | **EducationUser**| New entity | | + + +### Return type + +**EducationUser** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteEducationUser** +> deleteEducationUser() + + +### Example + +```typescript +import { + EducationUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationUserApi(configuration); + +let userId: string; //key: id or username of user (default to undefined) + +const { status, data } = await apiInstance.deleteEducationUser( + userId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userId** | [**string**] | key: id or username of user | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getEducationUser** +> EducationUser getEducationUser() + + +### Example + +```typescript +import { + EducationUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationUserApi(configuration); + +let userId: string; //key: id or username of user (default to undefined) +let $expand: Set<'memberOf'>; //Expand related entities (optional) (default to undefined) + +const { status, data } = await apiInstance.getEducationUser( + userId, + $expand +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userId** | [**string**] | key: id or username of user | defaults to undefined| +| **$expand** | **Array<'memberOf'>** | Expand related entities | (optional) defaults to undefined| + + +### Return type + +**EducationUser** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listEducationUsers** +> CollectionOfEducationUser listEducationUsers() + + +### Example + +```typescript +import { + EducationUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationUserApi(configuration); + +let $orderby: Set<'displayName' | 'displayName desc' | 'mail' | 'mail desc' | 'onPremisesSamAccountName' | 'onPremisesSamAccountName desc'>; //Order items by property values (optional) (default to undefined) +let $expand: Set<'memberOf'>; //Expand related entities (optional) (default to undefined) + +const { status, data } = await apiInstance.listEducationUsers( + $orderby, + $expand +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$orderby** | **Array<'displayName' | 'displayName desc' | 'mail' | 'mail desc' | 'onPremisesSamAccountName' | 'onPremisesSamAccountName desc'>** | Order items by property values | (optional) defaults to undefined| +| **$expand** | **Array<'memberOf'>** | Expand related entities | (optional) defaults to undefined| + + +### Return type + +**CollectionOfEducationUser** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entities | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateEducationUser** +> EducationUser updateEducationUser(educationUser) + + +### Example + +```typescript +import { + EducationUserApi, + Configuration, + EducationUser +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new EducationUserApi(configuration); + +let userId: string; //key: id or username of user (default to undefined) +let educationUser: EducationUser; //New property values + +const { status, data } = await apiInstance.updateEducationUser( + userId, + educationUser +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **educationUser** | **EducationUser**| New property values | | +| **userId** | [**string**] | key: id or username of user | defaults to undefined| + + +### Return type + +**EducationUser** + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/EducationUserReference.md b/packages/web-client/src/graph/generated/docs/EducationUserReference.md new file mode 100644 index 00000000000..9564e7af870 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/EducationUserReference.md @@ -0,0 +1,20 @@ +# EducationUserReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**odata_id** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { EducationUserReference } from './api'; + +const instance: EducationUserReference = { + odata_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ExportPersonalDataRequest.md b/packages/web-client/src/graph/generated/docs/ExportPersonalDataRequest.md new file mode 100644 index 00000000000..b6a5bcf2335 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ExportPersonalDataRequest.md @@ -0,0 +1,20 @@ +# ExportPersonalDataRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**storageLocation** | **string** | the path where the file should be created in the users personal space | [optional] [default to undefined] + +## Example + +```typescript +import { ExportPersonalDataRequest } from './api'; + +const instance: ExportPersonalDataRequest = { + storageLocation, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/FileSystemInfo.md b/packages/web-client/src/graph/generated/docs/FileSystemInfo.md new file mode 100644 index 00000000000..db9d7789662 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/FileSystemInfo.md @@ -0,0 +1,25 @@ +# FileSystemInfo + +File system information on client. Read-write. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdDateTime** | **string** | The UTC date and time the file was created on a client. | [optional] [default to undefined] +**lastAccessedDateTime** | **string** | The UTC date and time the file was last accessed. Available for the recent file list only. | [optional] [default to undefined] +**lastModifiedDateTime** | **string** | The UTC date and time the file was last modified on a client. | [optional] [default to undefined] + +## Example + +```typescript +import { FileSystemInfo } from './api'; + +const instance: FileSystemInfo = { + createdDateTime, + lastAccessedDateTime, + lastModifiedDateTime, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Folder.md b/packages/web-client/src/graph/generated/docs/Folder.md new file mode 100644 index 00000000000..41a8ecc8290 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Folder.md @@ -0,0 +1,23 @@ +# Folder + +Folder metadata, if the item is a folder. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**childCount** | **number** | Number of children contained immediately within this container. | [optional] [default to undefined] +**view** | [**FolderView**](FolderView.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { Folder } from './api'; + +const instance: Folder = { + childCount, + view, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/FolderView.md b/packages/web-client/src/graph/generated/docs/FolderView.md new file mode 100644 index 00000000000..288e2046edb --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/FolderView.md @@ -0,0 +1,25 @@ +# FolderView + +A collection of properties defining the recommended view for the folder. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sortBy** | **string** | The method by which the folder should be sorted. | [optional] [default to undefined] +**sortOrder** | **string** | If true, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending. | [optional] [default to undefined] +**viewType** | **string** | The type of view that should be used to represent the folder. | [optional] [default to undefined] + +## Example + +```typescript +import { FolderView } from './api'; + +const instance: FolderView = { + sortBy, + sortOrder, + viewType, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/GeoCoordinates.md b/packages/web-client/src/graph/generated/docs/GeoCoordinates.md new file mode 100644 index 00000000000..17f10184516 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/GeoCoordinates.md @@ -0,0 +1,25 @@ +# GeoCoordinates + +The GeoCoordinates resource provides geographic coordinates and elevation of a location based on metadata contained within the file. If a DriveItem has a non-null location facet, the item represents a file with a known location associated with it. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**altitude** | **number** | The altitude (height), in feet, above sea level for the item. Read-only. | [optional] [default to undefined] +**latitude** | **number** | The latitude, in decimal, for the item. Read-only. | [optional] [default to undefined] +**longitude** | **number** | The longitude, in decimal, for the item. Read-only. | [optional] [default to undefined] + +## Example + +```typescript +import { GeoCoordinates } from './api'; + +const instance: GeoCoordinates = { + altitude, + latitude, + longitude, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Group.md b/packages/web-client/src/graph/generated/docs/Group.md new file mode 100644 index 00000000000..b2ac53223aa --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Group.md @@ -0,0 +1,30 @@ +# Group + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Read-only. | [optional] [readonly] [default to undefined] +**description** | **string** | An optional description for the group. Returned by default. | [optional] [default to undefined] +**displayName** | **string** | The display name for the group. This property is required when a group is created and cannot be cleared during updates. Returned by default. Supports $search and $orderBy. | [optional] [default to undefined] +**groupTypes** | **Array<string>** | Specifies the group types. In MS Graph a group can have multiple types, so this is an array. In libreGraph the possible group types deviate from the MS Graph. The only group type that we currently support is \"ReadOnly\", which is set for groups that cannot be modified on the current instance. | [optional] [default to undefined] +**members** | [**Array<User>**](User.md) | Users and groups that are members of this group. HTTP Methods: GET (supported for all groups), Nullable. Supports $expand. | [optional] [default to undefined] +**membersodata_bind** | **Set<string>** | A list of member references to the members to be added. Up to 20 members can be added with a single request | [optional] [default to undefined] + +## Example + +```typescript +import { Group } from './api'; + +const instance: Group = { + id, + description, + displayName, + groupTypes, + members, + membersodata_bind, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/GroupApi.md b/packages/web-client/src/graph/generated/docs/GroupApi.md new file mode 100644 index 00000000000..0844add24af --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/GroupApi.md @@ -0,0 +1,342 @@ +# GroupApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**addMember**](#addmember) | **POST** /v1.0/groups/{group-id}/members/$ref | Add a member to a group| +|[**deleteGroup**](#deletegroup) | **DELETE** /v1.0/groups/{group-id} | Delete entity from groups| +|[**deleteMember**](#deletemember) | **DELETE** /v1.0/groups/{group-id}/members/{directory-object-id}/$ref | Delete member from a group| +|[**getGroup**](#getgroup) | **GET** /v1.0/groups/{group-id} | Get entity from groups by key| +|[**listMembers**](#listmembers) | **GET** /v1.0/groups/{group-id}/members | Get a list of the group\'s direct members| +|[**updateGroup**](#updategroup) | **PATCH** /v1.0/groups/{group-id} | Update entity in groups| + +# **addMember** +> addMember(memberReference) + + +### Example + +```typescript +import { + GroupApi, + Configuration, + MemberReference +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupApi(configuration); + +let groupId: string; //key: id of group (default to undefined) +let memberReference: MemberReference; //Object to be added as member + +const { status, data } = await apiInstance.addMember( + groupId, + memberReference +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **memberReference** | **MemberReference**| Object to be added as member | | +| **groupId** | [**string**] | key: id of group | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteGroup** +> deleteGroup() + + +### Example + +```typescript +import { + GroupApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupApi(configuration); + +let groupId: string; //key: id of group (default to undefined) +let ifMatch: string; //ETag (optional) (default to undefined) + +const { status, data } = await apiInstance.deleteGroup( + groupId, + ifMatch +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **groupId** | [**string**] | key: id of group | defaults to undefined| +| **ifMatch** | [**string**] | ETag | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteMember** +> deleteMember() + + +### Example + +```typescript +import { + GroupApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupApi(configuration); + +let groupId: string; //key: id of group (default to undefined) +let directoryObjectId: string; //key: id of group member to remove (default to undefined) +let ifMatch: string; //ETag (optional) (default to undefined) + +const { status, data } = await apiInstance.deleteMember( + groupId, + directoryObjectId, + ifMatch +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **groupId** | [**string**] | key: id of group | defaults to undefined| +| **directoryObjectId** | [**string**] | key: id of group member to remove | defaults to undefined| +| **ifMatch** | [**string**] | ETag | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getGroup** +> Group getGroup() + + +### Example + +```typescript +import { + GroupApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupApi(configuration); + +let groupId: string; //key: id or name of group (default to undefined) +let $select: Set<'id' | 'description' | 'displayName' | 'members'>; //Select properties to be returned (optional) (default to undefined) +let $expand: Set<'members'>; //Expand related entities (optional) (default to undefined) + +const { status, data } = await apiInstance.getGroup( + groupId, + $select, + $expand +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **groupId** | [**string**] | key: id or name of group | defaults to undefined| +| **$select** | **Array<'id' | 'description' | 'displayName' | 'members'>** | Select properties to be returned | (optional) defaults to undefined| +| **$expand** | **Array<'members'>** | Expand related entities | (optional) defaults to undefined| + + +### Return type + +**Group** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listMembers** +> CollectionOfUsers listMembers() + + +### Example + +```typescript +import { + GroupApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupApi(configuration); + +let groupId: string; //key: id or name of group (default to undefined) + +const { status, data } = await apiInstance.listMembers( + groupId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **groupId** | [**string**] | key: id or name of group | defaults to undefined| + + +### Return type + +**CollectionOfUsers** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved group members | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateGroup** +> updateGroup(group) + + +### Example + +```typescript +import { + GroupApi, + Configuration, + Group +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupApi(configuration); + +let groupId: string; //key: id of group (default to undefined) +let group: Group; //New property values + +const { status, data } = await apiInstance.updateGroup( + groupId, + group +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **group** | **Group**| New property values | | +| **groupId** | [**string**] | key: id of group | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/GroupsApi.md b/packages/web-client/src/graph/generated/docs/GroupsApi.md new file mode 100644 index 00000000000..44238940900 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/GroupsApi.md @@ -0,0 +1,121 @@ +# GroupsApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createGroup**](#creategroup) | **POST** /v1.0/groups | Add new entity to groups| +|[**listGroups**](#listgroups) | **GET** /v1.0/groups | Get entities from groups| + +# **createGroup** +> Group createGroup(group) + + +### Example + +```typescript +import { + GroupsApi, + Configuration, + Group +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupsApi(configuration); + +let group: Group; //New entity + +const { status, data } = await apiInstance.createGroup( + group +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **group** | **Group**| New entity | | + + +### Return type + +**Group** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listGroups** +> CollectionOfGroup listGroups() + + +### Example + +```typescript +import { + GroupsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new GroupsApi(configuration); + +let $search: string; //Search items by search phrases (optional) (default to undefined) +let $orderby: Set<'displayName' | 'displayName desc'>; //Order items by property values (optional) (default to undefined) +let $select: Set<'id' | 'description' | 'displayName' | 'mail' | 'members'>; //Select properties to be returned (optional) (default to undefined) +let $expand: Set<'members'>; //Expand related entities (optional) (default to undefined) + +const { status, data } = await apiInstance.listGroups( + $search, + $orderby, + $select, + $expand +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$search** | [**string**] | Search items by search phrases | (optional) defaults to undefined| +| **$orderby** | **Array<'displayName' | 'displayName desc'>** | Order items by property values | (optional) defaults to undefined| +| **$select** | **Array<'id' | 'description' | 'displayName' | 'mail' | 'members'>** | Select properties to be returned | (optional) defaults to undefined| +| **$expand** | **Array<'members'>** | Expand related entities | (optional) defaults to undefined| + + +### Return type + +**CollectionOfGroup** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entities | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/Hashes.md b/packages/web-client/src/graph/generated/docs/Hashes.md new file mode 100644 index 00000000000..8d3aa870b46 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Hashes.md @@ -0,0 +1,27 @@ +# Hashes + +Hashes of the file\'s binary content, if available. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**crc32Hash** | **string** | The CRC32 value of the file (if available). Read-only. | [optional] [default to undefined] +**quickXorHash** | **string** | A proprietary hash of the file that can be used to determine if the contents of the file have changed (if available). Read-only. | [optional] [default to undefined] +**sha1Hash** | **string** | SHA1 hash for the contents of the file (if available). Read-only. | [optional] [default to undefined] +**sha256Hash** | **string** | SHA256 hash for the contents of the file (if available). Read-only. | [optional] [default to undefined] + +## Example + +```typescript +import { Hashes } from './api'; + +const instance: Hashes = { + crc32Hash, + quickXorHash, + sha1Hash, + sha256Hash, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Identity.md b/packages/web-client/src/graph/generated/docs/Identity.md new file mode 100644 index 00000000000..c7fdad08b41 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Identity.md @@ -0,0 +1,24 @@ +# Identity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**displayName** | **string** | The identity\'s display name. Note that this may not always be available or up to date. For example, if a user changes their display name, the API may show the new value in a future response, but the items associated with the user won\'t show up as having changed when using delta. | [default to undefined] +**id** | **string** | Unique identifier for the identity. | [optional] [default to undefined] +**libre_graph_userType** | **string** | The type of the identity. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. Can be used by clients to indicate the type of user. For more details, clients should look up and cache the user at the /users endpoint. | [optional] [default to undefined] + +## Example + +```typescript +import { Identity } from './api'; + +const instance: Identity = { + displayName, + id, + libre_graph_userType, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/IdentitySet.md b/packages/web-client/src/graph/generated/docs/IdentitySet.md new file mode 100644 index 00000000000..cb163af757f --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/IdentitySet.md @@ -0,0 +1,27 @@ +# IdentitySet + +Optional. User account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application** | [**Identity**](Identity.md) | | [optional] [default to undefined] +**device** | [**Identity**](Identity.md) | | [optional] [default to undefined] +**user** | [**Identity**](Identity.md) | | [optional] [default to undefined] +**group** | [**Identity**](Identity.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { IdentitySet } from './api'; + +const instance: IdentitySet = { + application, + device, + user, + group, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Image.md b/packages/web-client/src/graph/generated/docs/Image.md new file mode 100644 index 00000000000..3370053befb --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Image.md @@ -0,0 +1,23 @@ +# Image + +Image metadata, if the item is an image. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**height** | **number** | Optional. Height of the image, in pixels. Read-only. | [optional] [readonly] [default to undefined] +**width** | **number** | Optional. Width of the image, in pixels. Read-only. | [optional] [readonly] [default to undefined] + +## Example + +```typescript +import { Image } from './api'; + +const instance: Image = { + height, + width, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ItemReference.md b/packages/web-client/src/graph/generated/docs/ItemReference.md new file mode 100644 index 00000000000..a9aad5261b9 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ItemReference.md @@ -0,0 +1,28 @@ +# ItemReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**driveId** | **string** | Unique identifier of the drive instance that contains the item. Read-only. | [optional] [readonly] [default to undefined] +**driveType** | **string** | Identifies the type of drive. See [drive][] resource for values. Read-only. | [optional] [readonly] [default to undefined] +**id** | **string** | Unique identifier of the item in the drive. Read-only. | [optional] [readonly] [default to undefined] +**name** | **string** | The name of the item being referenced. Read-only. | [optional] [readonly] [default to undefined] +**path** | **string** | Path that can be used to navigate to the item. Read-only. | [optional] [readonly] [default to undefined] + +## Example + +```typescript +import { ItemReference } from './api'; + +const instance: ItemReference = { + driveId, + driveType, + id, + name, + path, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/MeChangepasswordApi.md b/packages/web-client/src/graph/generated/docs/MeChangepasswordApi.md new file mode 100644 index 00000000000..aa2c47d685f --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/MeChangepasswordApi.md @@ -0,0 +1,60 @@ +# MeChangepasswordApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**changeOwnPassword**](#changeownpassword) | **POST** /v1.0/me/changePassword | Change your own password| + +# **changeOwnPassword** +> changeOwnPassword(passwordChange) + + +### Example + +```typescript +import { + MeChangepasswordApi, + Configuration, + PasswordChange +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeChangepasswordApi(configuration); + +let passwordChange: PasswordChange; //Password change request + +const { status, data } = await apiInstance.changeOwnPassword( + passwordChange +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **passwordChange** | **PasswordChange**| Password change request | | + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/MeDriveApi.md b/packages/web-client/src/graph/generated/docs/MeDriveApi.md new file mode 100644 index 00000000000..7cb52ca12e5 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/MeDriveApi.md @@ -0,0 +1,144 @@ +# MeDriveApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getHome**](#gethome) | **GET** /v1.0/me/drive | Get personal space for user| +|[**listSharedByMe**](#listsharedbyme) | **GET** /v1beta1/me/drive/sharedByMe | Get a list of driveItem objects shared by the current user.| +|[**listSharedWithMe**](#listsharedwithme) | **GET** /v1beta1/me/drive/sharedWithMe | Get a list of driveItem objects shared with the owner of a drive.| + +# **getHome** +> Drive getHome() + + +### Example + +```typescript +import { + MeDriveApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeDriveApi(configuration); + +const { status, data } = await apiInstance.getHome(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Drive** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved personal space | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listSharedByMe** +> CollectionOfDriveItems1 listSharedByMe() + +The `driveItems` returned from the `sharedByMe` method always include the `permissions` relation that indicates they are shared items. + +### Example + +```typescript +import { + MeDriveApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeDriveApi(configuration); + +const { status, data } = await apiInstance.listSharedByMe(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**CollectionOfDriveItems1** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listSharedWithMe** +> CollectionOfDriveItems1 listSharedWithMe() + +The `driveItems` returned from the `sharedWithMe` method always include the `remoteItem` facet that indicates they are items from a different drive. + +### Example + +```typescript +import { + MeDriveApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeDriveApi(configuration); + +const { status, data } = await apiInstance.listSharedWithMe(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**CollectionOfDriveItems1** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/MeDriveRootApi.md b/packages/web-client/src/graph/generated/docs/MeDriveRootApi.md new file mode 100644 index 00000000000..6815b716027 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/MeDriveRootApi.md @@ -0,0 +1,52 @@ +# MeDriveRootApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**homeGetRoot**](#homegetroot) | **GET** /v1.0/me/drive/root | Get root from personal space| + +# **homeGetRoot** +> DriveItem homeGetRoot() + + +### Example + +```typescript +import { + MeDriveRootApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeDriveRootApi(configuration); + +const { status, data } = await apiInstance.homeGetRoot(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**DriveItem** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved resource | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/MeDriveRootChildrenApi.md b/packages/web-client/src/graph/generated/docs/MeDriveRootChildrenApi.md new file mode 100644 index 00000000000..0372670bac3 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/MeDriveRootChildrenApi.md @@ -0,0 +1,52 @@ +# MeDriveRootChildrenApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**homeGetChildren**](#homegetchildren) | **GET** /v1.0/me/drive/root/children | Get children from drive| + +# **homeGetChildren** +> CollectionOfDriveItems homeGetChildren() + + +### Example + +```typescript +import { + MeDriveRootChildrenApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeDriveRootChildrenApi(configuration); + +const { status, data } = await apiInstance.homeGetChildren(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**CollectionOfDriveItems** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved resource list | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/MeDrivesApi.md b/packages/web-client/src/graph/generated/docs/MeDrivesApi.md new file mode 100644 index 00000000000..f536a46418c --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/MeDrivesApi.md @@ -0,0 +1,117 @@ +# MeDrivesApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**listMyDrives**](#listmydrives) | **GET** /v1.0/me/drives | Get all drives where the current user is a regular member of| +|[**listMyDrivesBeta**](#listmydrivesbeta) | **GET** /v1beta1/me/drives | Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles| + +# **listMyDrives** +> CollectionOfDrives listMyDrives() + + +### Example + +```typescript +import { + MeDrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeDrivesApi(configuration); + +let $orderby: string; //The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. (optional) (default to undefined) +let $filter: string; //Filter items by property values (optional) (default to undefined) + +const { status, data } = await apiInstance.listMyDrives( + $orderby, + $filter +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$orderby** | [**string**] | The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. | (optional) defaults to undefined| +| **$filter** | [**string**] | Filter items by property values | (optional) defaults to undefined| + + +### Return type + +**CollectionOfDrives** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved spaces | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listMyDrivesBeta** +> CollectionOfDrives listMyDrivesBeta() + + +### Example + +```typescript +import { + MeDrivesApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeDrivesApi(configuration); + +let $orderby: string; //The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. (optional) (default to undefined) +let $filter: string; //Filter items by property values (optional) (default to undefined) + +const { status, data } = await apiInstance.listMyDrivesBeta( + $orderby, + $filter +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$orderby** | [**string**] | The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. | (optional) defaults to undefined| +| **$filter** | [**string**] | Filter items by property values | (optional) defaults to undefined| + + +### Return type + +**CollectionOfDrives** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved spaces | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/MeUserApi.md b/packages/web-client/src/graph/generated/docs/MeUserApi.md new file mode 100644 index 00000000000..9f10cf762c7 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/MeUserApi.md @@ -0,0 +1,112 @@ +# MeUserApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getOwnUser**](#getownuser) | **GET** /v1.0/me | Get current user| +|[**updateOwnUser**](#updateownuser) | **PATCH** /v1.0/me | Update the current user| + +# **getOwnUser** +> User getOwnUser() + + +### Example + +```typescript +import { + MeUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeUserApi(configuration); + +let $expand: Set<'memberOf'>; //Expand related entities (optional) (default to undefined) + +const { status, data } = await apiInstance.getOwnUser( + $expand +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$expand** | **Array<'memberOf'>** | Expand related entities | (optional) defaults to undefined| + + +### Return type + +**User** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateOwnUser** +> User updateOwnUser() + + +### Example + +```typescript +import { + MeUserApi, + Configuration, + UserUpdate +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new MeUserApi(configuration); + +let userUpdate: UserUpdate; //New user values (optional) + +const { status, data } = await apiInstance.updateOwnUser( + userUpdate +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userUpdate** | **UserUpdate**| New user values | | + + +### Return type + +**User** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/MemberReference.md b/packages/web-client/src/graph/generated/docs/MemberReference.md new file mode 100644 index 00000000000..43ee0d75c62 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/MemberReference.md @@ -0,0 +1,20 @@ +# MemberReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**odata_id** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { MemberReference } from './api'; + +const instance: MemberReference = { + odata_id, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ObjectIdentity.md b/packages/web-client/src/graph/generated/docs/ObjectIdentity.md new file mode 100644 index 00000000000..4ea13ee2faa --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ObjectIdentity.md @@ -0,0 +1,23 @@ +# ObjectIdentity + +Represents an identity used to sign in to a user account + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**issuer** | **string** | domain of the Provider issuing the identity | [optional] [default to undefined] +**issuerAssignedId** | **string** | The unique id assigned by the issuer to the account | [optional] [default to undefined] + +## Example + +```typescript +import { ObjectIdentity } from './api'; + +const instance: ObjectIdentity = { + issuer, + issuerAssignedId, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/OdataError.md b/packages/web-client/src/graph/generated/docs/OdataError.md new file mode 100644 index 00000000000..768d640c5c3 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/OdataError.md @@ -0,0 +1,20 @@ +# OdataError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | [**OdataErrorMain**](OdataErrorMain.md) | | [default to undefined] + +## Example + +```typescript +import { OdataError } from './api'; + +const instance: OdataError = { + error, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/OdataErrorDetail.md b/packages/web-client/src/graph/generated/docs/OdataErrorDetail.md new file mode 100644 index 00000000000..9e0cdcd42dd --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/OdataErrorDetail.md @@ -0,0 +1,24 @@ +# OdataErrorDetail + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **string** | | [default to undefined] +**message** | **string** | | [default to undefined] +**target** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { OdataErrorDetail } from './api'; + +const instance: OdataErrorDetail = { + code, + message, + target, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/OdataErrorMain.md b/packages/web-client/src/graph/generated/docs/OdataErrorMain.md new file mode 100644 index 00000000000..b448c0d4797 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/OdataErrorMain.md @@ -0,0 +1,28 @@ +# OdataErrorMain + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **string** | | [default to undefined] +**message** | **string** | | [default to undefined] +**target** | **string** | | [optional] [default to undefined] +**details** | [**Array<OdataErrorDetail>**](OdataErrorDetail.md) | | [optional] [default to undefined] +**innererror** | **object** | The structure of this object is service-specific | [optional] [default to undefined] + +## Example + +```typescript +import { OdataErrorMain } from './api'; + +const instance: OdataErrorMain = { + code, + message, + target, + details, + innererror, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/OpenGraphFile.md b/packages/web-client/src/graph/generated/docs/OpenGraphFile.md new file mode 100644 index 00000000000..7d665fabc42 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/OpenGraphFile.md @@ -0,0 +1,25 @@ +# OpenGraphFile + +File metadata, if the item is a file. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hashes** | [**Hashes**](Hashes.md) | | [optional] [default to undefined] +**mimeType** | **string** | The MIME type for the file. This is determined by logic on the server and might not be the value provided when the file was uploaded. Read-only. | [optional] [readonly] [default to undefined] +**processingMetadata** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { OpenGraphFile } from './api'; + +const instance: OpenGraphFile = { + hashes, + mimeType, + processingMetadata, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/PasswordChange.md b/packages/web-client/src/graph/generated/docs/PasswordChange.md new file mode 100644 index 00000000000..f98cb685da6 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/PasswordChange.md @@ -0,0 +1,22 @@ +# PasswordChange + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currentPassword** | **string** | | [default to undefined] +**newPassword** | **string** | | [default to undefined] + +## Example + +```typescript +import { PasswordChange } from './api'; + +const instance: PasswordChange = { + currentPassword, + newPassword, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/PasswordProfile.md b/packages/web-client/src/graph/generated/docs/PasswordProfile.md new file mode 100644 index 00000000000..cc47c839007 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/PasswordProfile.md @@ -0,0 +1,23 @@ +# PasswordProfile + +Password Profile associated with a user + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forceChangePasswordNextSignIn** | **boolean** | If true the user is required to change their password upon the next login | [optional] [default to false] +**password** | **string** | The user\'s password | [optional] [default to undefined] + +## Example + +```typescript +import { PasswordProfile } from './api'; + +const instance: PasswordProfile = { + forceChangePasswordNextSignIn, + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Permission.md b/packages/web-client/src/graph/generated/docs/Permission.md new file mode 100644 index 00000000000..997219baad3 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Permission.md @@ -0,0 +1,39 @@ +# Permission + +The Permission resource provides information about a sharing permission granted for a DriveItem resource. ### Remarks The Permission resource uses *facets* to provide information about the kind of permission represented by the resource. Permissions with a `link` facet represent sharing links created on the item. Sharing links contain a unique token that provides access to the item for anyone with the link. Permissions with a `invitation` facet represent permissions added by inviting specific users or groups to have access to the file. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the permission among all permissions on the item. Read-only. | [optional] [readonly] [default to undefined] +**hasPassword** | **boolean** | Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. | [optional] [readonly] [default to undefined] +**expirationDateTime** | **string** | An optional expiration date which limits the permission in time. | [optional] [default to undefined] +**createdDateTime** | **string** | An optional creation date. Libregraph only. | [optional] [default to undefined] +**grantedToV2** | [**SharePointIdentitySet**](SharePointIdentitySet.md) | | [optional] [default to undefined] +**link** | [**SharingLink**](SharingLink.md) | | [optional] [default to undefined] +**roles** | **Array<string>** | | [optional] [default to undefined] +**grantedToIdentities** | [**Array<IdentitySet>**](IdentitySet.md) | For link type permissions, the details of the identity to whom permission was granted. This could be used to grant access to a an external user that can be identified by email, aka guest accounts. | [optional] [default to undefined] +**libre_graph_permissions_actions** | **Array<string>** | Use this to create a permission with custom actions. | [optional] [default to undefined] +**invitation** | [**SharingInvitation**](SharingInvitation.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { Permission } from './api'; + +const instance: Permission = { + id, + hasPassword, + expirationDateTime, + createdDateTime, + grantedToV2, + link, + roles, + grantedToIdentities, + libre_graph_permissions_actions, + invitation, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Photo.md b/packages/web-client/src/graph/generated/docs/Photo.md new file mode 100644 index 00000000000..f101222bd32 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Photo.md @@ -0,0 +1,37 @@ +# Photo + +The photo resource provides photo and camera properties, for example, EXIF metadata, on a driveItem. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cameraMake** | **string** | Camera manufacturer. Read-only. | [optional] [default to undefined] +**cameraModel** | **string** | Camera model. Read-only. | [optional] [default to undefined] +**exposureDenominator** | **number** | The denominator for the exposure time fraction from the camera. Read-only. | [optional] [default to undefined] +**exposureNumerator** | **number** | The numerator for the exposure time fraction from the camera. Read-only. | [optional] [default to undefined] +**fNumber** | **number** | The F-stop value from the camera. Read-only. | [optional] [default to undefined] +**focalLength** | **number** | The focal length from the camera. Read-only. | [optional] [default to undefined] +**iso** | **number** | The ISO value from the camera. Read-only. | [optional] [default to undefined] +**orientation** | **number** | The orientation value from the camera. Read-only. | [optional] [default to undefined] +**takenDateTime** | **string** | Represents the date and time the photo was taken. Read-only. | [optional] [default to undefined] + +## Example + +```typescript +import { Photo } from './api'; + +const instance: Photo = { + cameraMake, + cameraModel, + exposureDenominator, + exposureNumerator, + fNumber, + focalLength, + iso, + orientation, + takenDateTime, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Quota.md b/packages/web-client/src/graph/generated/docs/Quota.md new file mode 100644 index 00000000000..0edbe1c3ddd --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Quota.md @@ -0,0 +1,29 @@ +# Quota + +Optional. Information about the drive\'s storage space quota. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deleted** | **number** | Total space consumed by files in the recycle bin, in bytes. Read-only. | [optional] [readonly] [default to undefined] +**remaining** | **number** | Total space remaining before reaching the quota limit, in bytes. Read-only. | [optional] [readonly] [default to undefined] +**state** | **string** | Enumeration value that indicates the state of the storage space. Either \"normal\", \"nearing\", \"critical\" or \"exceeded\". Read-only. | [optional] [readonly] [default to undefined] +**total** | **number** | Total allowed storage space, in bytes. Read-only. | [optional] [readonly] [default to undefined] +**used** | **number** | Total space used, in bytes. Read-only. | [optional] [readonly] [default to undefined] + +## Example + +```typescript +import { Quota } from './api'; + +const instance: Quota = { + deleted, + remaining, + state, + total, + used, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/RemoteItem.md b/packages/web-client/src/graph/generated/docs/RemoteItem.md new file mode 100644 index 00000000000..0d4f8125e6c --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/RemoteItem.md @@ -0,0 +1,61 @@ +# RemoteItem + +Remote item data, if the item is shared from a drive other than the one being accessed. Read-only. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**createdDateTime** | **string** | Date and time of item creation. Read-only. | [optional] [default to undefined] +**file** | [**OpenGraphFile**](OpenGraphFile.md) | | [optional] [default to undefined] +**fileSystemInfo** | [**FileSystemInfo**](FileSystemInfo.md) | | [optional] [default to undefined] +**folder** | [**Folder**](Folder.md) | | [optional] [default to undefined] +**driveAlias** | **string** | The drive alias can be used in clients to make the urls user friendly. Example: \'personal/einstein\'. This will be used to resolve to the correct driveID. | [optional] [default to undefined] +**path** | **string** | The relative path of the item in relation to its drive root. | [optional] [default to undefined] +**rootId** | **string** | Unique identifier for the drive root of this item. Read-only. | [optional] [default to undefined] +**id** | **string** | Unique identifier for the remote item in its drive. Read-only. | [optional] [default to undefined] +**image** | [**Image**](Image.md) | | [optional] [default to undefined] +**lastModifiedBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**lastModifiedDateTime** | **string** | Date and time the item was last modified. Read-only. | [optional] [default to undefined] +**name** | **string** | Optional. Filename of the remote item. Read-only. | [optional] [default to undefined] +**eTag** | **string** | ETag for the item. Read-only. | [optional] [readonly] [default to undefined] +**cTag** | **string** | An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only. | [optional] [readonly] [default to undefined] +**parentReference** | [**ItemReference**](ItemReference.md) | | [optional] [default to undefined] +**permissions** | [**Array<Permission>**](Permission.md) | The set of permissions for the item. Read-only. Nullable. | [optional] [readonly] [default to undefined] +**size** | **number** | Size of the remote item. Read-only. | [optional] [default to undefined] +**specialFolder** | [**SpecialFolder**](SpecialFolder.md) | | [optional] [default to undefined] +**webDavUrl** | **string** | DAV compatible URL for the item. | [optional] [default to undefined] +**webUrl** | **string** | URL that displays the resource in the browser. Read-only. | [optional] [default to undefined] + +## Example + +```typescript +import { RemoteItem } from './api'; + +const instance: RemoteItem = { + createdBy, + createdDateTime, + file, + fileSystemInfo, + folder, + driveAlias, + path, + rootId, + id, + image, + lastModifiedBy, + lastModifiedDateTime, + name, + eTag, + cTag, + parentReference, + permissions, + size, + specialFolder, + webDavUrl, + webUrl, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/RoleManagementApi.md b/packages/web-client/src/graph/generated/docs/RoleManagementApi.md new file mode 100644 index 00000000000..fd330c0e80b --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/RoleManagementApi.md @@ -0,0 +1,106 @@ +# RoleManagementApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getPermissionRoleDefinition**](#getpermissionroledefinition) | **GET** /v1beta1/roleManagement/permissions/roleDefinitions/{role-id} | Get unifiedRoleDefinition| +|[**listPermissionRoleDefinitions**](#listpermissionroledefinitions) | **GET** /v1beta1/roleManagement/permissions/roleDefinitions | List roleDefinitions| + +# **getPermissionRoleDefinition** +> UnifiedRoleDefinition getPermissionRoleDefinition() + +Read the properties and relationships of a `unifiedRoleDefinition` object. + +### Example + +```typescript +import { + RoleManagementApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RoleManagementApi(configuration); + +let roleId: string; //key: id of roleDefinition (default to undefined) + +const { status, data } = await apiInstance.getPermissionRoleDefinition( + roleId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **roleId** | [**string**] | key: id of roleDefinition | defaults to undefined| + + +### Return type + +**UnifiedRoleDefinition** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | OK | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listPermissionRoleDefinitions** +> UnifiedRoleDefinition listPermissionRoleDefinitions() + +Get a list of `unifiedRoleDefinition` objects for the permissions provider. This list determines the roles that can be selected when creating sharing invites. + +### Example + +```typescript +import { + RoleManagementApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new RoleManagementApi(configuration); + +const { status, data } = await apiInstance.listPermissionRoleDefinitions(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**UnifiedRoleDefinition** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | A list of permission roles than can be used when sharing with users or groups. | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/SharePointIdentitySet.md b/packages/web-client/src/graph/generated/docs/SharePointIdentitySet.md new file mode 100644 index 00000000000..4de4fb4cb42 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/SharePointIdentitySet.md @@ -0,0 +1,23 @@ +# SharePointIdentitySet + +This resource is used to represent a set of identities associated with various events for an item, such as created by or last modified by. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user** | [**Identity**](Identity.md) | | [optional] [default to undefined] +**group** | [**Identity**](Identity.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { SharePointIdentitySet } from './api'; + +const instance: SharePointIdentitySet = { + user, + group, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/SharingInvitation.md b/packages/web-client/src/graph/generated/docs/SharingInvitation.md new file mode 100644 index 00000000000..869cb938fdc --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/SharingInvitation.md @@ -0,0 +1,21 @@ +# SharingInvitation + +invitation-related data items + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invitedBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { SharingInvitation } from './api'; + +const instance: SharingInvitation = { + invitedBy, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/SharingLink.md b/packages/web-client/src/graph/generated/docs/SharingLink.md new file mode 100644 index 00000000000..0d2cd85e50d --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/SharingLink.md @@ -0,0 +1,29 @@ +# SharingLink + +The `SharingLink` resource groups link-related data items into a single structure. If a `permission` resource has a non-null `sharingLink` facet, the permission represents a sharing link (as opposed to permissions granted to a person or group). + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**SharingLinkType**](SharingLinkType.md) | | [optional] [default to undefined] +**preventsDownload** | **boolean** | If `true` then the user can only use this link to view the item on the web, and cannot use it to download the contents of the item. | [optional] [readonly] [default to undefined] +**webUrl** | **string** | A URL that opens the item in the browser on the website. | [optional] [readonly] [default to undefined] +**libre_graph_displayName** | **string** | Provides a user-visible display name of the link. Optional. Libregraph only. | [optional] [default to undefined] +**libre_graph_quickLink** | **boolean** | The quicklink property can be assigned to only one link per resource. A quicklink can be used in the clients to provide a one-click copy to clipboard action. Optional. Libregraph only. | [optional] [default to undefined] + +## Example + +```typescript +import { SharingLink } from './api'; + +const instance: SharingLink = { + type, + preventsDownload, + webUrl, + libre_graph_displayName, + libre_graph_quickLink, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/SharingLinkPassword.md b/packages/web-client/src/graph/generated/docs/SharingLinkPassword.md new file mode 100644 index 00000000000..6ebe5a70a89 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/SharingLinkPassword.md @@ -0,0 +1,21 @@ +# SharingLinkPassword + +The sharing link password which should be set. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **string** | Password. It may require a password policy. | [optional] [default to undefined] + +## Example + +```typescript +import { SharingLinkPassword } from './api'; + +const instance: SharingLinkPassword = { + password, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/SharingLinkType.md b/packages/web-client/src/graph/generated/docs/SharingLinkType.md new file mode 100644 index 00000000000..1068f1c8dfa --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/SharingLinkType.md @@ -0,0 +1,19 @@ +# SharingLinkType + +The type of the link created. | Value | Display name | Description | | -------------- | ----------------- | --------------------------------------------------------------- | | internal | Internal | Creates an internal link without any permissions. | | view | View | Creates a read-only link to the driveItem. | | upload | Upload | Creates a read-write link to the folder driveItem. | | edit | Edit | Creates a read-write link to the driveItem. | | createOnly | File Drop | Creates an upload-only link to the folder driveItem. | | blocksDownload | Secure View | Creates a read-only link that blocks download to the driveItem. | + +## Enum + +* `Internal` (value: `'internal'`) + +* `View` (value: `'view'`) + +* `Upload` (value: `'upload'`) + +* `Edit` (value: `'edit'`) + +* `CreateOnly` (value: `'createOnly'`) + +* `BlocksDownload` (value: `'blocksDownload'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/SignInActivity.md b/packages/web-client/src/graph/generated/docs/SignInActivity.md new file mode 100644 index 00000000000..427361052cc --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/SignInActivity.md @@ -0,0 +1,21 @@ +# SignInActivity + +Provides the last successful sign-in attempt for a user + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lastSuccessfulSignInDateTime** | **string** | The date and time of the last successful sign-in for the user. | [optional] [default to undefined] + +## Example + +```typescript +import { SignInActivity } from './api'; + +const instance: SignInActivity = { + lastSuccessfulSignInDateTime, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/SpecialFolder.md b/packages/web-client/src/graph/generated/docs/SpecialFolder.md new file mode 100644 index 00000000000..fe08adda280 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/SpecialFolder.md @@ -0,0 +1,21 @@ +# SpecialFolder + +If the current item is also available as a special folder, this facet is returned. Read-only + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The unique identifier for this item in the /drive/special collection | [optional] [default to undefined] + +## Example + +```typescript +import { SpecialFolder } from './api'; + +const instance: SpecialFolder = { + name, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/TagAssignment.md b/packages/web-client/src/graph/generated/docs/TagAssignment.md new file mode 100644 index 00000000000..185f0ab7102 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/TagAssignment.md @@ -0,0 +1,22 @@ +# TagAssignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**resourceId** | **string** | | [default to undefined] +**tags** | **Array<string>** | | [default to undefined] + +## Example + +```typescript +import { TagAssignment } from './api'; + +const instance: TagAssignment = { + resourceId, + tags, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/TagUnassignment.md b/packages/web-client/src/graph/generated/docs/TagUnassignment.md new file mode 100644 index 00000000000..f258f52784c --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/TagUnassignment.md @@ -0,0 +1,22 @@ +# TagUnassignment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**resourceId** | **string** | | [default to undefined] +**tags** | **Array<string>** | | [default to undefined] + +## Example + +```typescript +import { TagUnassignment } from './api'; + +const instance: TagUnassignment = { + resourceId, + tags, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/TagsApi.md b/packages/web-client/src/graph/generated/docs/TagsApi.md new file mode 100644 index 00000000000..2a01e3a9bd6 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/TagsApi.md @@ -0,0 +1,158 @@ +# TagsApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**assignTags**](#assigntags) | **PUT** /v1.0/extensions/org.libregraph/tags | Assign tags to a resource| +|[**getTags**](#gettags) | **GET** /v1.0/extensions/org.libregraph/tags | Get all known tags| +|[**unassignTags**](#unassigntags) | **DELETE** /v1.0/extensions/org.libregraph/tags | Unassign tags from a resource| + +# **assignTags** +> assignTags() + + +### Example + +```typescript +import { + TagsApi, + Configuration, + TagAssignment +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TagsApi(configuration); + +let tagAssignment: TagAssignment; // (optional) + +const { status, data } = await apiInstance.assignTags( + tagAssignment +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **tagAssignment** | **TagAssignment**| | | + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | No content | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getTags** +> CollectionOfTags getTags() + + +### Example + +```typescript +import { + TagsApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TagsApi(configuration); + +const { status, data } = await apiInstance.getTags(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**CollectionOfTags** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved tags | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unassignTags** +> unassignTags() + + +### Example + +```typescript +import { + TagsApi, + Configuration, + TagUnassignment +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new TagsApi(configuration); + +let tagUnassignment: TagUnassignment; // (optional) + +const { status, data } = await apiInstance.unassignTags( + tagUnassignment +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **tagUnassignment** | **TagUnassignment**| | | + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | No content | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/Thumbnail.md b/packages/web-client/src/graph/generated/docs/Thumbnail.md new file mode 100644 index 00000000000..9cb0039a090 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Thumbnail.md @@ -0,0 +1,29 @@ +# Thumbnail + +The thumbnail resource type represents a thumbnail for an image, video, document, or any item that has a bitmap representation. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **string** | The content stream for the thumbnail. | [optional] [default to undefined] +**height** | **number** | The height of the thumbnail, in pixels. | [optional] [default to undefined] +**sourceItemId** | **string** | The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested. | [optional] [default to undefined] +**url** | **string** | The URL used to fetch the thumbnail content. | [optional] [default to undefined] +**width** | **number** | The width of the thumbnail, in pixels. | [optional] [default to undefined] + +## Example + +```typescript +import { Thumbnail } from './api'; + +const instance: Thumbnail = { + content, + height, + sourceItemId, + url, + width, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/ThumbnailSet.md b/packages/web-client/src/graph/generated/docs/ThumbnailSet.md new file mode 100644 index 00000000000..49bebf231e6 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/ThumbnailSet.md @@ -0,0 +1,29 @@ +# ThumbnailSet + +The ThumbnailSet resource is a keyed collection of thumbnail resources. It\'s used to represent a set of thumbnails associated with a DriveItem. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The ID within the item. Read-only. | [optional] [default to undefined] +**large** | [**Thumbnail**](Thumbnail.md) | | [optional] [default to undefined] +**medium** | [**Thumbnail**](Thumbnail.md) | | [optional] [default to undefined] +**small** | [**Thumbnail**](Thumbnail.md) | | [optional] [default to undefined] +**source** | [**Thumbnail**](Thumbnail.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { ThumbnailSet } from './api'; + +const instance: ThumbnailSet = { + id, + large, + medium, + small, + source, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/Trash.md b/packages/web-client/src/graph/generated/docs/Trash.md new file mode 100644 index 00000000000..1ec4a438726 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Trash.md @@ -0,0 +1,23 @@ +# Trash + +Metadata for trashed drive Items + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trashedBy** | [**IdentitySet**](IdentitySet.md) | | [optional] [default to undefined] +**trashedDateTime** | **string** | The UTC date and time the folder was marked as trashed. | [optional] [default to undefined] + +## Example + +```typescript +import { Trash } from './api'; + +const instance: Trash = { + trashedBy, + trashedDateTime, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/UnifiedRoleDefinition.md b/packages/web-client/src/graph/generated/docs/UnifiedRoleDefinition.md new file mode 100644 index 00000000000..3e02c57faa2 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/UnifiedRoleDefinition.md @@ -0,0 +1,29 @@ +# UnifiedRoleDefinition + +A role definition is a collection of permissions in libre graph listing the operations that can be performed and the resources against which they can performed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **string** | The description for the unifiedRoleDefinition. | [optional] [default to undefined] +**displayName** | **string** | The display name for the unifiedRoleDefinition. Required. Supports $filter (`eq`, `in`). | [optional] [default to undefined] +**id** | **string** | The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (`eq`, `in`). | [optional] [default to undefined] +**rolePermissions** | [**Array<UnifiedRolePermission>**](UnifiedRolePermission.md) | List of permissions included in the role. | [optional] [default to undefined] +**libre_graph_weight** | **number** | When presenting a list of roles the weight can be used to order them in a meaningful way. Lower weight gets higher precedence. So content with lower weight will come first. If set, weights should be non-zero, as 0 is interpreted as an unset weight. | [optional] [default to undefined] + +## Example + +```typescript +import { UnifiedRoleDefinition } from './api'; + +const instance: UnifiedRoleDefinition = { + description, + displayName, + id, + rolePermissions, + libre_graph_weight, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/UnifiedRolePermission.md b/packages/web-client/src/graph/generated/docs/UnifiedRolePermission.md new file mode 100644 index 00000000000..ae817935572 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/UnifiedRolePermission.md @@ -0,0 +1,23 @@ +# UnifiedRolePermission + +Represents a collection of allowed resource actions and the conditions that must be met for the action to be allowed. Resource actions are tasks that can be performed on a resource. For example, an application resource may support create, update, delete, and reset password actions. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowedResourceActions** | **Array<string>** | Set of tasks that can be performed on a resource. Required. The following is the schema for resource actions: ``` {Namespace}/{Entity}/{PropertySet}/{Action} ``` For example: `libre.graph/applications/credentials/update` * *{Namespace}* - The services that exposes the task. For example, all tasks in libre graph use the namespace `libre.graph`. * *{Entity}* - The logical features or components exposed by the service in libre graph. For example, `applications`, `servicePrincipals`, or `groups`. * *{PropertySet}* - Optional. The specific properties or aspects of the entity for which access is being granted. For example, `libre.graph/applications/authentication/read` grants the ability to read the reply URL, logout URL, and implicit flow property on the **application** object in libre graph. The following are reserved names for common property sets: * `allProperties` - Designates all properties of the entity, including privileged properties. Examples include `libre.graph/applications/allProperties/read` and `libre.graph/applications/allProperties/update`. * `basic` - Designates common read properties but excludes privileged ones. For example, `libre.graph/applications/basic/update` includes the ability to update standard properties like display name. * `standard` - Designates common update properties but excludes privileged ones. For example, `libre.graph/applications/standard/read`. * *{Actions}* - The operations being granted. In most circumstances, permissions should be expressed in terms of CRUD operations or allTasks. Actions include: * `create` - The ability to create a new instance of the entity. * `read` - The ability to read a given property set (including allProperties). * `update` - The ability to update a given property set (including allProperties). * `delete` - The ability to delete a given entity. * `allTasks` - Represents all CRUD operations (create, read, update, and delete). Following the CS3 API we can represent the CS3 permissions by mapping them to driveItem properties or relations like this: | [CS3 ResourcePermission](https://cs3org.github.io/cs3apis/#cs3.storage.provider.v1beta1.ResourcePermissions) | action | comment | | ------------------------------------------------------------------------------------------------------------ | ------ | ------- | | `stat` | `libre.graph/driveItem/basic/read` | `basic` because it does not include versions or trashed items | | `get_quota` | `libre.graph/driveItem/quota/read` | read only the `quota` property | | `get_path` | `libre.graph/driveItem/path/read` | read only the `path` property | | `move` | `libre.graph/driveItem/path/update` | allows updating the `path` property of a CS3 resource | | `delete` | `libre.graph/driveItem/standard/delete` | `standard` because deleting is a common update operation | | `list_container` | `libre.graph/driveItem/children/read` | | | `create_container` | `libre.graph/driveItem/children/create` | | | `initiate_file_download` | `libre.graph/driveItem/content/read` | `content` is the property read when initiating a download | | `initiate_file_upload` | `libre.graph/driveItem/upload/create` | `uploads` are a separate property. postprocessing creates the `content` | | `add_grant` | `libre.graph/driveItem/permissions/create` | | | `list_grant` | `libre.graph/driveItem/permissions/read` | | | `update_grant` | `libre.graph/driveItem/permissions/update` | | | `remove_grant` | `libre.graph/driveItem/permissions/delete` | | | `deny_grant` | `libre.graph/driveItem/permissions/deny` | uses a non CRUD action `deny` | | `list_file_versions` | `libre.graph/driveItem/versions/read` | `versions` is a `driveItemVersion` collection | | `restore_file_version` | `libre.graph/driveItem/versions/update` | the only `update` action is restore | | `list_recycle` | `libre.graph/driveItem/deleted/read` | reading a driveItem `deleted` property implies listing | | `restore_recycle_item` | `libre.graph/driveItem/deleted/update` | the only `update` action is restore | | `purge_recycle` | `libre.graph/driveItem/deleted/delete` | allows purging deleted `driveItems` | Managing drives would be a different entity. A space manager role could be written as `libre.graph/drive/permission/allTasks`. | [optional] [default to undefined] +**condition** | **string** | Optional constraints that must be met for the permission to be effective. Not supported for custom roles. Conditions define constraints that must be met. For example, a requirement that target resource must have a certain property. The following are the supported conditions: * Drive: `exists @Resource.Drive` - The target resource must be a drive/space * Folder: `exists @Resource.Folder` - The target resource must be a folder * File: `exists @Resource.File` - The target resource must be a file The following is an example of a role permission with a condition that the target resource is a folder: ```json \"rolePermissions\": [ { \"allowedResourceActions\": [ \"libre.graph/applications/basic/update\", \"libre.graph/applications/credentials/update\" ], \"condition\": \"exists @Resource.File\" } ] ``` Conditions aren\'t supported for custom roles. | [optional] [default to undefined] + +## Example + +```typescript +import { UnifiedRolePermission } from './api'; + +const instance: UnifiedRolePermission = { + allowedResourceActions, + condition, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/User.md b/packages/web-client/src/graph/generated/docs/User.md new file mode 100644 index 00000000000..165d24632cf --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/User.md @@ -0,0 +1,53 @@ +# User + +Represents an Active Directory user object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Read-only. | [optional] [readonly] [default to undefined] +**accountEnabled** | **boolean** | Set to \"true\" when the account is enabled. | [optional] [default to undefined] +**appRoleAssignments** | [**Array<AppRoleAssignment>**](AppRoleAssignment.md) | The apps and app roles which this user has been assigned. | [optional] [readonly] [default to undefined] +**displayName** | **string** | The name displayed in the address book for the user. This value is usually the combination of the user\'s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Returned by default. Supports $orderby. | [default to undefined] +**drives** | [**Array<Drive>**](Drive.md) | A collection of drives available for this user. Read-only. | [optional] [readonly] [default to undefined] +**drive** | [**Drive**](Drive.md) | | [optional] [default to undefined] +**identities** | [**Array<ObjectIdentity>**](ObjectIdentity.md) | Identities associated with this account. | [optional] [default to undefined] +**mail** | **string** | The SMTP address for the user, for example, \'jeff@contoso.onowncloud.com\'. Returned by default. | [optional] [default to undefined] +**memberOf** | [**Array<Group>**](Group.md) | Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. | [optional] [readonly] [default to undefined] +**onPremisesSamAccountName** | **string** | Contains the on-premises SAM account name synchronized from the on-premises directory. | [default to undefined] +**passwordProfile** | [**PasswordProfile**](PasswordProfile.md) | | [optional] [default to undefined] +**surname** | **string** | The user\'s surname (family name or last name). Returned by default. | [optional] [default to undefined] +**givenName** | **string** | The user\'s givenName. Returned by default. | [optional] [default to undefined] +**userType** | **string** | The user`s type. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. | [optional] [readonly] [default to undefined] +**preferredLanguage** | **string** | Represents the users language setting, ISO-639-1 Code | [optional] [default to undefined] +**signInActivity** | [**SignInActivity**](SignInActivity.md) | | [optional] [default to undefined] +**externalID** | **string** | A unique identifier assigned to the user by the organization. | [optional] [default to undefined] + +## Example + +```typescript +import { User } from './api'; + +const instance: User = { + id, + accountEnabled, + appRoleAssignments, + displayName, + drives, + drive, + identities, + mail, + memberOf, + onPremisesSamAccountName, + passwordProfile, + surname, + givenName, + userType, + preferredLanguage, + signInActivity, + externalID, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/UserApi.md b/packages/web-client/src/graph/generated/docs/UserApi.md new file mode 100644 index 00000000000..62ca90a780a --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/UserApi.md @@ -0,0 +1,232 @@ +# UserApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**deleteUser**](#deleteuser) | **DELETE** /v1.0/users/{user-id} | Delete entity from users| +|[**exportPersonalData**](#exportpersonaldata) | **POST** /v1.0/users/{user-id}/exportPersonalData | export personal data of a user| +|[**getUser**](#getuser) | **GET** /v1.0/users/{user-id} | Get entity from users by key| +|[**updateUser**](#updateuser) | **PATCH** /v1.0/users/{user-id} | Update entity in users| + +# **deleteUser** +> deleteUser() + + +### Example + +```typescript +import { + UserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let userId: string; //key: id or name of user (default to undefined) +let ifMatch: string; //ETag (optional) (default to undefined) + +const { status, data } = await apiInstance.deleteUser( + userId, + ifMatch +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userId** | [**string**] | key: id or name of user | defaults to undefined| +| **ifMatch** | [**string**] | ETag | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **exportPersonalData** +> exportPersonalData() + + +### Example + +```typescript +import { + UserApi, + Configuration, + ExportPersonalDataRequest +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let userId: string; //key: id or name of user (default to undefined) +let exportPersonalDataRequest: ExportPersonalDataRequest; //destination the file should be created at (optional) + +const { status, data } = await apiInstance.exportPersonalData( + userId, + exportPersonalDataRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **exportPersonalDataRequest** | **ExportPersonalDataRequest**| destination the file should be created at | | +| **userId** | [**string**] | key: id or name of user | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**202** | success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUser** +> User getUser() + + +### Example + +```typescript +import { + UserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let userId: string; //key: id or name of user (default to undefined) +let $select: Set<'id' | 'displayName' | 'drive' | 'drives' | 'mail' | 'memberOf' | 'onPremisesSamAccountName' | 'surname'>; //Select properties to be returned (optional) (default to undefined) +let $expand: Set<'drive' | 'drives' | 'memberOf' | 'appRoleAssignments'>; //Expand related entities (optional) (default to undefined) + +const { status, data } = await apiInstance.getUser( + userId, + $select, + $expand +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userId** | [**string**] | key: id or name of user | defaults to undefined| +| **$select** | **Array<'id' | 'displayName' | 'drive' | 'drives' | 'mail' | 'memberOf' | 'onPremisesSamAccountName' | 'surname'>** | Select properties to be returned | (optional) defaults to undefined| +| **$expand** | **Array<'drive' | 'drives' | 'memberOf' | 'appRoleAssignments'>** | Expand related entities | (optional) defaults to undefined| + + +### Return type + +**User** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateUser** +> User updateUser(userUpdate) + + +### Example + +```typescript +import { + UserApi, + Configuration, + UserUpdate +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let userId: string; //key: id of user (default to undefined) +let userUpdate: UserUpdate; //New property values + +const { status, data } = await apiInstance.updateUser( + userId, + userUpdate +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userUpdate** | **UserUpdate**| New property values | | +| **userId** | [**string**] | key: id of user | defaults to undefined| + + +### Return type + +**User** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/UserAppRoleAssignmentApi.md b/packages/web-client/src/graph/generated/docs/UserAppRoleAssignmentApi.md new file mode 100644 index 00000000000..d7a591ca6f2 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/UserAppRoleAssignmentApi.md @@ -0,0 +1,175 @@ +# UserAppRoleAssignmentApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**userCreateAppRoleAssignments**](#usercreateapproleassignments) | **POST** /v1.0/users/{user-id}/appRoleAssignments | Grant an appRoleAssignment to a user| +|[**userDeleteAppRoleAssignments**](#userdeleteapproleassignments) | **DELETE** /v1.0/users/{user-id}/appRoleAssignments/{appRoleAssignment-id} | Delete the appRoleAssignment from a user| +|[**userListAppRoleAssignments**](#userlistapproleassignments) | **GET** /v1.0/users/{user-id}/appRoleAssignments | Get appRoleAssignments from a user| + +# **userCreateAppRoleAssignments** +> AppRoleAssignment userCreateAppRoleAssignments(appRoleAssignment) + +Use this API to assign a global role to a user. To grant an app role assignment to a user, you need three identifiers: * `principalId`: The `id` of the user to whom you are assigning the app role. * `resourceId`: The `id` of the resource `servicePrincipal` or `application` that has defined the app role. * `appRoleId`: The `id` of the `appRole` (defined on the resource service principal or application) to assign to the user. + +### Example + +```typescript +import { + UserAppRoleAssignmentApi, + Configuration, + AppRoleAssignment +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserAppRoleAssignmentApi(configuration); + +let userId: string; //key: id of user (default to undefined) +let appRoleAssignment: AppRoleAssignment; //New app role assignment value + +const { status, data } = await apiInstance.userCreateAppRoleAssignments( + userId, + appRoleAssignment +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **appRoleAssignment** | **AppRoleAssignment**| New app role assignment value | | +| **userId** | [**string**] | key: id of user | defaults to undefined| + + +### Return type + +**AppRoleAssignment** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Created new app role assignment. | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **userDeleteAppRoleAssignments** +> userDeleteAppRoleAssignments() + + +### Example + +```typescript +import { + UserAppRoleAssignmentApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserAppRoleAssignmentApi(configuration); + +let userId: string; //key: id of user (default to undefined) +let appRoleAssignmentId: string; //key: id of appRoleAssignment. This is the concatenated {user-id}:{appRole-id} separated by a colon. (default to undefined) +let ifMatch: string; //ETag (optional) (default to undefined) + +const { status, data } = await apiInstance.userDeleteAppRoleAssignments( + userId, + appRoleAssignmentId, + ifMatch +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userId** | [**string**] | key: id of user | defaults to undefined| +| **appRoleAssignmentId** | [**string**] | key: id of appRoleAssignment. This is the concatenated {user-id}:{appRole-id} separated by a colon. | defaults to undefined| +| **ifMatch** | [**string**] | ETag | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**204** | Success | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **userListAppRoleAssignments** +> CollectionOfAppRoleAssignments userListAppRoleAssignments() + +Represents the global roles a user has been granted for an application. + +### Example + +```typescript +import { + UserAppRoleAssignmentApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserAppRoleAssignmentApi(configuration); + +let userId: string; //key: id of user (default to undefined) + +const { status, data } = await apiInstance.userListAppRoleAssignments( + userId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userId** | [**string**] | key: id of user | defaults to undefined| + + +### Return type + +**CollectionOfAppRoleAssignments** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved appRoleAssignments | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/UserUpdate.md b/packages/web-client/src/graph/generated/docs/UserUpdate.md new file mode 100644 index 00000000000..4dfdea34480 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/UserUpdate.md @@ -0,0 +1,53 @@ +# UserUpdate + +Represents updates to an Active Directory user object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Read-only. | [optional] [readonly] [default to undefined] +**accountEnabled** | **boolean** | Set to \"true\" when the account is enabled. | [optional] [default to undefined] +**appRoleAssignments** | [**Array<AppRoleAssignment>**](AppRoleAssignment.md) | The apps and app roles which this user has been assigned. | [optional] [readonly] [default to undefined] +**displayName** | **string** | The name displayed in the address book for the user. This value is usually the combination of the user\'s first name, middle initial, and last name. This property is required when a user is created and it cannot be cleared during updates. Returned by default. Supports $orderby. | [optional] [default to undefined] +**drives** | [**Array<Drive>**](Drive.md) | A collection of drives available for this user. Read-only. | [optional] [readonly] [default to undefined] +**drive** | [**Drive**](Drive.md) | | [optional] [default to undefined] +**identities** | [**Array<ObjectIdentity>**](ObjectIdentity.md) | Identities associated with this account. | [optional] [default to undefined] +**mail** | **string** | The SMTP address for the user, for example, \'jeff@contoso.onowncloud.com\'. Returned by default. | [optional] [default to undefined] +**memberOf** | [**Array<Group>**](Group.md) | Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. | [optional] [readonly] [default to undefined] +**onPremisesSamAccountName** | **string** | Contains the on-premises SAM account name synchronized from the on-premises directory. | [optional] [default to undefined] +**passwordProfile** | [**PasswordProfile**](PasswordProfile.md) | | [optional] [default to undefined] +**surname** | **string** | The user\'s surname (family name or last name). Returned by default. | [optional] [default to undefined] +**givenName** | **string** | The user\'s givenName. Returned by default. | [optional] [default to undefined] +**userType** | **string** | The user`s type. This can be either \"Member\" for regular user, \"Guest\" for guest users or \"Federated\" for users imported from a federated instance. | [optional] [readonly] [default to undefined] +**preferredLanguage** | **string** | Represents the users language setting, ISO-639-1 Code | [optional] [default to undefined] +**signInActivity** | [**SignInActivity**](SignInActivity.md) | | [optional] [default to undefined] +**externalID** | **string** | A unique identifier assigned to the user by the organization. | [optional] [default to undefined] + +## Example + +```typescript +import { UserUpdate } from './api'; + +const instance: UserUpdate = { + id, + accountEnabled, + appRoleAssignments, + displayName, + drives, + drive, + identities, + mail, + memberOf, + onPremisesSamAccountName, + passwordProfile, + surname, + givenName, + userType, + preferredLanguage, + signInActivity, + externalID, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/packages/web-client/src/graph/generated/docs/UsersApi.md b/packages/web-client/src/graph/generated/docs/UsersApi.md new file mode 100644 index 00000000000..813f15ee331 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/UsersApi.md @@ -0,0 +1,124 @@ +# UsersApi + +All URIs are relative to *https://ocis.ocis.rolling.owncloud.works/graph* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**createUser**](#createuser) | **POST** /v1.0/users | Add new entity to users| +|[**listUsers**](#listusers) | **GET** /v1.0/users | Get entities from users| + +# **createUser** +> User createUser(user) + + +### Example + +```typescript +import { + UsersApi, + Configuration, + User +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UsersApi(configuration); + +let user: User; //New entity + +const { status, data } = await apiInstance.createUser( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **User**| New entity | | + + +### Return type + +**User** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**201** | Created entity | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listUsers** +> CollectionOfUser listUsers() + + +### Example + +```typescript +import { + UsersApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UsersApi(configuration); + +let $search: string; //Search items by search phrases (optional) (default to undefined) +let $filter: string; //Filter users by property values and relationship attributes (optional) (default to undefined) +let $orderby: Set<'displayName' | 'displayName desc' | 'mail' | 'mail desc' | 'onPremisesSamAccountName' | 'onPremisesSamAccountName desc'>; //Order items by property values (optional) (default to undefined) +let $select: Set<'id' | 'displayName' | 'mail' | 'memberOf' | 'onPremisesSamAccountName' | 'surname'>; //Select properties to be returned (optional) (default to undefined) +let $expand: Set<'drive' | 'drives' | 'memberOf' | 'appRoleAssignments'>; //Expand related entities (optional) (default to undefined) + +const { status, data } = await apiInstance.listUsers( + $search, + $filter, + $orderby, + $select, + $expand +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **$search** | [**string**] | Search items by search phrases | (optional) defaults to undefined| +| **$filter** | [**string**] | Filter users by property values and relationship attributes | (optional) defaults to undefined| +| **$orderby** | **Array<'displayName' | 'displayName desc' | 'mail' | 'mail desc' | 'onPremisesSamAccountName' | 'onPremisesSamAccountName desc'>** | Order items by property values | (optional) defaults to undefined| +| **$select** | **Array<'id' | 'displayName' | 'mail' | 'memberOf' | 'onPremisesSamAccountName' | 'surname'>** | Select properties to be returned | (optional) defaults to undefined| +| **$expand** | **Array<'drive' | 'drives' | 'memberOf' | 'appRoleAssignments'>** | Expand related entities | (optional) defaults to undefined| + + +### Return type + +**CollectionOfUser** + +### Authorization + +[openId](../README.md#openId), [basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Retrieved entities | - | +|**0** | error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/packages/web-client/src/graph/generated/docs/Video.md b/packages/web-client/src/graph/generated/docs/Video.md new file mode 100644 index 00000000000..5f890ec69b5 --- /dev/null +++ b/packages/web-client/src/graph/generated/docs/Video.md @@ -0,0 +1,39 @@ +# Video + +The video resource groups video-related data items into a single structure. If a driveItem has a non-null video facet, the item represents a video file. The properties of the video resource are populated by extracting metadata from the file. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**audioBitsPerSample** | **number** | Number of audio bits per sample. | [optional] [default to undefined] +**audioChannels** | **number** | Number of audio channels. | [optional] [default to undefined] +**audioFormat** | **string** | Name of the audio format (AAC, MP3, etc.). | [optional] [default to undefined] +**audioSamplesPerSecond** | **number** | Number of audio samples per second. | [optional] [default to undefined] +**bitrate** | **number** | Bit rate of the video in bits per second. | [optional] [default to undefined] +**duration** | **number** | Duration of the file in milliseconds. | [optional] [default to undefined] +**fourCC** | **string** | \\\"Four character code\\\" name of the video format. | [optional] [default to undefined] +**frameRate** | **number** | Frame rate of the video. | [optional] [default to undefined] +**height** | **number** | Height of the video, in pixels. | [optional] [default to undefined] +**width** | **number** | Width of the video, in pixels. | [optional] [default to undefined] + +## Example + +```typescript +import { Video } from './api'; + +const instance: Video = { + audioBitsPerSample, + audioChannels, + audioFormat, + audioSamplesPerSecond, + bitrate, + duration, + fourCC, + frameRate, + height, + width, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/tests/e2e/support/objects/app-files/resource/actions.ts b/tests/e2e/support/objects/app-files/resource/actions.ts index 38a57ae567e..40c29633c9c 100644 --- a/tests/e2e/support/objects/app-files/resource/actions.ts +++ b/tests/e2e/support/objects/app-files/resource/actions.ts @@ -1292,7 +1292,7 @@ export const deleteResource = async (args: deleteResourceArgs): Promise => waitResponses.push( page.waitForResponse( (resp) => - resp.url().includes('graph/v1.0/drives') && + resp.url().includes('graph/v1beta1/drives') && resp.status() === 200 && resp.request().method() === 'GET' )