/** * Libre Graph API * Libre Graph is a free API for cloud collaboration inspired by the MS Graph API. * * The version of the OpenAPI document: v1.0.8 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * Represents activity. */ export interface Activity { /** * Activity ID. */ 'id': string; 'times': ActivityTimes; 'template': ActivityTemplate; } /** * An activity someone is notified about. */ export interface ActivityNotification { 'topic': ActivityTopic; /** * What happened. Only `mentioned` is supported at the time of writing. */ 'activityType': string; /** * The app the activity happened in, as an id the server knows. */ 'teamsAppId': string; } export interface ActivityTemplate { /** * Activity description. */ 'message': string; /** * Activity description variables. */ 'variables'?: object; } export interface ActivityTimes { /** * Timestamp of the activity. */ 'recordedTime': string; } /** * What an activity happened on. */ export interface ActivityTopic { /** * How to read the value. Only `text` is supported at the time of writing. built from it. */ 'source': string; /** * With the source `text`, the id of the resource the activity happened on. */ 'value': string; } 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. */ '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. */ 'description'?: string | null; /** * Display name for the permission that appears in the app role assignment and consent experiences. */ 'displayName'?: string | null; /** * Unique role identifier inside the appRoles collection. When creating a new app role, a new GUID identifier must be provided. */ 'id': string; } 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. */ 'id'?: string; 'deletedDateTime'?: string; /** * The identifier (id) for the app role which is assigned to the user. Required on create. */ '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. */ 'createdDateTime'?: string | null; /** * The display name of the user, group, or service principal that was granted the app role assignment. Read-only. */ '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. */ 'principalId': string | null; /** * The type of the assigned principal. This can either be User, Group, or ServicePrincipal. Read-only. */ 'principalType'?: string | null; /** * The display name of the resource app\'s service principal to which the assignment is made. */ 'resourceDisplayName'?: string | null; /** * The unique identifier (id) for the resource service principal for which the assignment is made. Required on create. */ 'resourceId': string | null; } 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. */ '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. */ 'appRoles'?: Array; /** * The display name for the 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 { /** * The title of the album for this audio file. */ 'album'?: string; /** * The artist named on the album for the audio file. */ 'albumArtist'?: string; /** * The performing artist for the audio file. */ 'artist'?: string; /** * Bitrate expressed in kbps. */ 'bitrate'?: number; /** * The name of the composer of the audio file. */ 'composers'?: string; /** * Copyright information for the audio file. */ 'copyright'?: string; /** * The number of the disc this audio file came from. */ 'disc'?: number; /** * The total number of discs in this album. */ 'discCount'?: number; /** * Duration of the audio file, expressed in milliseconds */ 'duration'?: number; /** * The genre of this audio file. */ 'genre'?: string; /** * Indicates if the file is protected with digital rights management. */ 'hasDrm'?: boolean; /** * Indicates if the file is encoded with a variable bitrate. */ 'isVariableBitrate'?: boolean; /** * The title of the audio file. */ 'title'?: string; /** * The number of the track on the original disc for this audio file. */ 'track'?: number; /** * The total number of tracks on the original disc for this audio file. */ 'trackCount'?: number; /** * The year the audio file was recorded. */ 'year'?: number; } export interface ClassMemberReference { '@odata.id'?: string; } export interface ClassReference { '@odata.id'?: string; } export interface ClassTeacherReference { '@odata.id'?: string; } export interface CollectionOfActivities { 'value'?: Array; } export interface CollectionOfAppRoleAssignments { 'value'?: Array; '@odata.nextLink'?: string; } export interface CollectionOfApplications { 'value'?: Array; } export interface CollectionOfClass { 'value'?: Array; } export interface CollectionOfDriveItems { 'value'?: Array; '@odata.nextLink'?: string; } export interface CollectionOfDriveItems1 { 'value'?: Array; } export interface CollectionOfDrives { 'value'?: Array; '@odata.nextLink'?: string; } export interface CollectionOfDrives1 { 'value'?: Array; } export interface CollectionOfEducationClass { 'value'?: Array; } export interface CollectionOfEducationUser { 'value'?: Array; } export interface CollectionOfGroup { 'value'?: Array; '@odata.nextLink'?: string; } export interface CollectionOfInvitations { 'value'?: Array; } export interface CollectionOfPermissions { 'value'?: Array; } export interface CollectionOfPermissionsWithAllowedValues { /** * A list of role definitions that can be chosen for the resource. */ '@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` | */ '@libre.graph.permissions.actions.allowedValues'?: Array; 'value'?: Array; /** * The total number of permissions available, only present if the `count` query parameter is set to true. */ '@odata.count'?: number; } export interface CollectionOfSchools { 'value'?: Array; } export interface CollectionOfTags { 'value'?: Array; } export interface CollectionOfUser { 'value'?: Array; '@odata.nextLink'?: string; } export interface CollectionOfUsers { 'value'?: Array; } /** * Information about the deleted state of the item. Read-only. */ export interface Deleted { /** * Represents the state of the deleted item. */ 'state'?: string; } /** * The drive represents a space on the storage. */ export interface Drive { /** * The unique identifier for this drive. */ 'id'?: string; 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. */ 'createdDateTime'?: string; /** * Provides a user-visible description of the item. Optional. */ 'description'?: string; /** * ETag for the item. Read-only. */ 'eTag'?: string; 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. */ 'lastModifiedDateTime'?: string; /** * The name of the item. Read-write. */ 'name': string; 'parentReference'?: ItemReference; /** * URL that displays the resource in the browser. Read-only. */ 'webUrl'?: string; /** * Describes the type of drive represented by this resource. Values are \"personal\" for users home spaces, \"project\", \"virtual\" or \"share\". Read-only. */ '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. */ 'driveAlias'?: string; 'owner'?: IdentitySet; 'quota'?: Quota; /** * All items contained in the drive. Read-only. Nullable. */ 'items'?: Array; 'root'?: DriveItem; /** * A collection of special drive resources. */ 'special'?: Array; /** * Indicates whether the drive has items in the trash. Read-only. */ '@libre.graph.hasTrashedItems'?: boolean; /** * Specifier for the web client that a drive is of a certain content type that could potentially be opened by a specific web app. Example: `application/vnd.opencloud.vault`, indicating the drive can be opened by the rclone-crypt web app. */ '@libre.graph.contentType'?: string; } /** * Represents a resource inside a drive. Read-only. */ export interface DriveItem { /** * Read-only. */ 'id'?: string; 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. */ 'createdDateTime'?: string; /** * Provides a user-visible description of the item. Optional. */ 'description'?: string; /** * ETag for the item. Read-only. */ 'eTag'?: string; 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. */ 'lastModifiedDateTime'?: string; /** * The name of the item. Read-write. */ 'name'?: string; 'parentReference'?: ItemReference; /** * URL that displays the resource in the browser. Read-only. */ 'webUrl'?: string; /** * The content stream, if the item represents a file. */ '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. */ 'cTag'?: string; 'deleted'?: Deleted; 'pendingOperations'?: PendingOperations; 'file'?: OpenGraphFile; 'fileSystemInfo'?: FileSystemInfo; 'folder'?: Folder; 'image'?: Image; 'photo'?: Photo; 'location'?: GeoCoordinates; /** * Collection containing ThumbnailSet objects associated with the item. Read-only. Nullable. */ 'thumbnails'?: Array; /** * If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive. */ 'root'?: object; 'trash'?: Trash; 'specialFolder'?: SpecialFolder; 'remoteItem'?: RemoteItem; /** * Size of the item in bytes. Read-only. */ 'size'?: number; /** * WebDAV compatible URL for the item. Read-only. */ 'webDavUrl'?: string; /** * Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable. */ 'children'?: Array; /** * The set of permissions for the item. Read-only. Nullable. */ 'permissions'?: Array; 'audio'?: Audio; 'video'?: Video; '@libre.graph.motionPhoto'?: MotionPhoto; '@libre.graph.livePhoto'?: LivePhoto; /** * Indicates if the item is synchronized with the underlying storage provider. Read-only. */ '@client.synchronize'?: boolean; /** * A pre-authenticated URL that can be used to download the item\'s content without providing an Authorization header. The URL is short-lived and cannot be cached. This annotation is only populated when explicitly requested via `$select`, and only for items that have a `file` facet. The returned URL is valid for a limited time and should be used promptly. */ '@microsoft.graph.downloadUrl'?: string; /** * 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. */ '@UI.Hidden'?: boolean; /** * Indicates whether the current user is following this DriveItem. Read-only. Use the FollowDriveItem and UnfollowDriveItem operations to change the following state. */ '@libre.graph.me.following'?: boolean; /** * The list of tags assigned to this DriveItem. Read-only. Use the AssignTags and UnassignTags operations to modify tags. */ '@libre.graph.tags'?: Array; /** * A list of actions the caller is allowed to perform on this item. Only returned when explicitly requested via `$select` on endpoints that support it. Mirrors the annotation of the same name on the `/permissions` endpoint, allowing clients to learn a caller\'s effective actions on an item without a separate round-trip. */ '@libre.graph.permissions.actions.allowedValues'?: Array; } export interface DriveItemCreateLink { 'type'?: SharingLinkType; /** * Optional. A String with format of yyyy-MM-ddTHH:mm:ssZ of DateTime indicates the expiration time of the permission. */ 'expirationDateTime'?: string; /** * Optional.The password of the sharing link that is set by the creator. */ 'password'?: string; /** * Provides a user-visible display name of the link. Optional. Libregraph only. */ '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. */ '@libre.graph.quickLink'?: boolean; } export interface DriveItemInvite { /** * A collection of recipients who will receive access and the sharing invitation. Currently, only internal users or groups are supported. */ 'recipients'?: Array; /** * Specifies the roles that are to be granted to the recipients of the sharing invitation. */ 'roles'?: Array; /** * Specifies the actions that are to be granted to the recipients of the sharing invitation, in effect creating a custom role. */ '@libre.graph.permissions.actions'?: Array; /** * Specifies the dateTime after which the permission expires. */ '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 { /** * The unique identifier for the recipient in the directory. */ 'objectId'?: string; /** * When the recipient is referenced by objectId this annotation is used to differentiate `user` and `group` recipients. */ '@libre.graph.recipient.type'?: string; } /** * The drive represents an update to a space on the storage. */ export interface DriveUpdate { /** * The unique identifier for this drive. */ 'id'?: string; 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. */ 'createdDateTime'?: string; /** * Provides a user-visible description of the item. Optional. */ 'description'?: string; /** * ETag for the item. Read-only. */ 'eTag'?: string; 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. */ 'lastModifiedDateTime'?: string; /** * The name of the item. Read-write. */ 'name'?: string; 'parentReference'?: ItemReference; /** * URL that displays the resource in the browser. Read-only. */ 'webUrl'?: string; /** * Describes the type of drive represented by this resource. Values are \"personal\" for users home spaces, \"project\", \"virtual\" or \"share\". Read-only. */ '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. */ 'driveAlias'?: string; 'owner'?: IdentitySet; 'quota'?: Quota; /** * All items contained in the drive. Read-only. Nullable. */ 'items'?: Array; 'root'?: DriveItem; /** * A collection of special drive resources. */ 'special'?: Array; /** * Indicates whether the drive has items in the trash. Read-only. */ '@libre.graph.hasTrashedItems'?: boolean; /** * Specifier for the web client that a drive is of a certain content type that could potentially be opened by a specific web app. Example: `application/vnd.opencloud.vault`, indicating the drive can be opened by the rclone-crypt web app. */ '@libre.graph.contentType'?: string; } /** * And extension of group representing a class or course */ export interface EducationClass { /** * Read-only. */ 'id'?: string; /** * An optional description for the group. Returned by default. */ '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. */ 'displayName': string; /** * Users and groups that are members of this group. HTTP Methods: GET (supported for all groups), Nullable. Supports $expand. */ 'members'?: Array; /** * A list of member references to the members to be added. Up to 20 members can be added with a single request */ 'members@odata.bind'?: Set; /** * Classification of the group, i.e. \"class\" or \"course\" */ 'classification': EducationClassClassificationEnum; /** * An external unique ID for the class */ 'externalId'?: string; } export declare const EducationClassClassificationEnum: { readonly Class: "class"; readonly Course: "course"; }; export type EducationClassClassificationEnum = typeof EducationClassClassificationEnum[keyof typeof EducationClassClassificationEnum]; /** * Represents a school */ export interface EducationSchool { /** * The unique identifier for an entity. Read-only. */ 'id'?: string; /** * The organization name */ 'displayName'?: string; /** * School number */ 'schoolNumber'?: string; /** * External identifier of the school */ 'externalId'?: string; /** * Date and time at which the service for this organization is scheduled to be terminated */ 'terminationDate'?: string | null; } /** * An extension of user with education-specific attributes */ export interface EducationUser { /** * Read-only. */ 'id'?: string; /** * Set to \"true\" when the account is enabled. */ '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. */ 'displayName'?: string; /** * A collection of drives available for this user. Read-only. */ 'drives'?: Array; 'drive'?: Drive; /** * An external unique ID for the user. Use it to associate a user in another system, such as a student or employee ID number. */ 'externalId'?: string; /** * Identities associated with this account. */ 'identities'?: Array; /** * The SMTP address for the user, for example, \'jeff@contoso.opencloud.com\'. Returned by default. */ 'mail'?: string; /** * Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. */ 'memberOf'?: Array; /** * Contains the on-premises SAM account name synchronized from the on-premises directory. Read-only. */ 'onPremisesSamAccountName'?: string; 'passwordProfile'?: PasswordProfile; /** * The user\'s surname (family name or last name). Returned by default. */ 'surname'?: string; /** * The user\'s givenName. Returned by default. */ 'givenName'?: string; /** * The user`s default role. Such as \"student\" or \"teacher\" */ '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. */ 'userType'?: string; } export interface EducationUserReference { '@odata.id'?: string; } /** * Represents an email address. */ export interface EmailAddress { /** * The email address. */ 'address'?: string; /** * The name associated with the email address. */ 'name'?: string; } export interface ExportPersonalDataRequest { /** * the path where the file should be created in the users personal space */ 'storageLocation'?: string; } /** * File system information on client. Read-write. */ export interface FileSystemInfo { /** * The UTC date and time the file was created on a client. */ 'createdDateTime'?: string; /** * The UTC date and time the file was last accessed. Available for the recent file list only. */ 'lastAccessedDateTime'?: string; /** * The UTC date and time the file was last modified on a client. */ 'lastModifiedDateTime'?: string; } /** * Folder metadata, if the item is a folder. Read-only. */ export interface Folder { /** * Number of children contained immediately within this container. */ 'childCount'?: number; 'view'?: FolderView; } /** * A collection of properties defining the recommended view for the folder. */ export interface FolderView { /** * The method by which the folder should be sorted. */ 'sortBy'?: string; /** * If true, indicates that items should be sorted in descending order. Otherwise, items should be sorted ascending. */ 'sortOrder'?: string; /** * The type of view that should be used to represent the folder. */ '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 { /** * The altitude (height), in feet, above sea level for the item. Read-only. */ 'altitude'?: number; /** * The latitude, in decimal, for the item. Read-only. */ 'latitude'?: number; /** * The longitude, in decimal, for the item. Read-only. */ 'longitude'?: number; } export interface Group { /** * Read-only. */ 'id'?: string; /** * An optional description for the group. Returned by default. */ '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. */ '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. */ 'groupTypes'?: Array; /** * Users and groups that are members of this group. HTTP Methods: GET (supported for all groups), Nullable. Supports $expand. */ 'members'?: Array; /** * A list of member references to the members to be added. Up to 20 members can be added with a single request */ 'members@odata.bind'?: Set; } /** * Hashes of the file\'s binary content, if available. Read-only. */ export interface Hashes { /** * The CRC32 value of the file (if available). Read-only. */ '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. */ 'quickXorHash'?: string; /** * SHA1 hash for the contents of the file (if available). Read-only. */ 'sha1Hash'?: string; /** * SHA256 hash for the contents of the file (if available). Read-only. */ 'sha256Hash'?: string; } 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. */ 'displayName': string; /** * Unique identifier for the 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 endpoint. */ '@libre.graph.userType'?: string; } /** * Optional. User account. */ export interface IdentitySet { 'application'?: Identity; 'device'?: Identity; 'user'?: Identity; 'group'?: Identity; } /** * Image metadata, if the item is an image. Read-only. */ export interface Image { /** * Optional. Height of the image, in pixels. Read-only. */ 'height'?: number; /** * Optional. Width of the image, in pixels. Read-only. */ 'width'?: number; } /** * Represents an invitation to a drive item. */ export interface Invitation { /** * The display name of the user being invited. */ 'invitedUserDisplayName'?: string; /** * The email address of the user being invited. Required. */ 'invitedUserEmailAddress'?: string; 'invitedUserMessageInfo'?: InvitedUserMessageInfo; /** * Indicates whether an invitation message should be sent to the user. */ 'sendInvitationMessage'?: boolean; /** * The URL to which the user is redirected after accepting the invitation. Required. */ 'inviteRedirectUrl'?: string; /** * The URL that the user can use to redeem the invitation. Read-only. */ 'inviteRedeemUrl'?: string; /** * The status of the invitation. Read-only. */ 'status'?: string; 'invitedUser'?: User; /** * The type of user being invited. */ 'invitedUserType'?: string; } /** * Additional information about the invitation message. */ export interface InvitedUserMessageInfo { /** * Additional recipients who will receive a copy of the invitation message. */ 'ccRecipients'?: Array; /** * The customized message body that will be included in the invitation message. */ 'customizedMessageBody'?: string; /** * The language of the invitation message. */ 'messageLanguage'?: string; } export interface ItemReference { /** * Unique identifier of the drive instance that contains the item. Read-only. */ 'driveId'?: string; /** * Identifies the type of drive. See [drive][] resource for values. Read-only. */ 'driveType'?: string; /** * Unique identifier of the item in the drive. Read-only. */ 'id'?: string; /** * The name of the item being referenced. Read-only. */ 'name'?: string; /** * Path that can be used to navigate to the item. Read-only. */ 'path'?: string; } /** * Apple Live Photo metadata. A Live Photo is a pair of files sharing one content identifier: a still image (HEIC or JPEG) and a short QuickTime video. Unlike a Motion Photo, the two parts are separate driveItems. The presence of this facet indicates the item was captured as part of a Live Photo; the counterpart is the driveItem whose livePhoto facet carries the same contentId. Whether an item is the still image or the video half follows from its photo/video facets and MIME type. There is no public file format specification; the metadata keys are documented as AVFoundation metadata identifiers: https://developer.apple.com/documentation/avfoundation/avmetadataidentifier On the still image they are stored in the Apple maker note, on the video as com.apple.quicktime.* QuickTime metadata keys. */ export interface LivePhoto { /** * Identifier (UUID) shared by the still image and the paired video of one Live Photo. Read-only. */ 'contentId': string; /** * Time in microseconds within the paired video at which the still image was captured. The value comes from the video file only: it is the presentation time of the com.apple.quicktime.still-image-time timed metadata sample in the QuickTime movie, so it is only present on the video half. The still image carries no reliable equivalent (the Apple maker note tag 0x0017, historically documented as a derivable video index, does not encode a usable time on current iOS versions). If absent, readers should use a timestamp near the middle of the video track. Read-only. */ 'stillImageTimeUs'?: number; /** * True if the device decided automatically whether to capture the Live Photo video (com.apple.quicktime.live-photo.auto). Only present on the video half. Read-only. */ 'auto'?: boolean; /** * Score between 0 and 1 rating how interesting the motion clip is, used by readers to decide whether to autoplay it (com.apple.quicktime.live-photo.vitality-score). Only present on the video half. Read-only. */ 'vitalityScore'?: number; /** * Version of the algorithm that produced vitalityScore (com.apple.quicktime.live-photo.vitality-scoring-version). Only present on the video half. Read-only. */ 'vitalityScoringVersion'?: number; } export interface MemberReference { '@odata.id'?: string; } /** * Motion Photo metadata. A Motion Photo is a still image with a short video clip appended to the end of the file. The presence of this facet on a driveItem indicates that the item is a Motion Photo; absence indicates it is not. Based on the Google Motion Photo format v1.0 specification: https://developer.android.com/media/platform/motion-photo-format */ export interface MotionPhoto { /** * The file format version of the Motion Photo. Currently always 1. Read-only. */ 'version'?: number; /** * Presentation timestamp in microseconds of the video frame that corresponds to the still image. A value of -1 indicates unspecified. If absent, readers should use a timestamp near the middle of the video track. Read-only. */ 'presentationTimestampUs'?: number; /** * Size in bytes of the embedded video portion of the file. The video is appended at the end of the file, so clients can fetch it with a Range request: `Range: bytes=-`. Read-only. */ 'videoSize'?: number; } /** * Represents an identity used to sign in to a user account */ export interface ObjectIdentity { /** * domain of the Provider issuing the identity */ 'issuer'?: string; /** * The unique id assigned by the issuer to the account */ 'issuerAssignedId'?: string; } export interface OdataError { 'error': OdataErrorMain; } export interface OdataErrorDetail { 'code': string; 'message': string; 'target'?: string; } export interface OdataErrorMain { 'code': string; 'message': string; 'target'?: string; 'details'?: Array; /** * The structure of this object is service-specific */ 'innererror'?: object; } /** * File metadata, if the item is a file. Read-only. */ export interface 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. */ 'mimeType'?: string; 'processingMetadata'?: boolean; } export interface PasswordChange { 'currentPassword': string; 'newPassword': string; } /** * Password Profile associated with a user */ export interface PasswordProfile { /** * If true the user is required to change their password upon the next login */ 'forceChangePasswordNextSignIn'?: boolean; /** * The user\'s password */ 'password'?: string; } /** * Present while operations affecting the item\'s content have not completed, whether still queued or already running. While present, requests for the item\'s content fail, the content is withheld until processing completes and the facet disappears. */ export interface PendingOperations { 'pendingContentUpdate'?: PendingOperationsPendingContentUpdate; } /** * An update to the item\'s content has not completed, for example post-processing such as virus scanning after an upload. MS Graph does not specify how reads behave while this is present; in OpenCloud content requests fail. */ export interface PendingOperationsPendingContentUpdate { /** * Time the operation was queued. May be absent. Read-only. */ 'queuedDateTime'?: 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 { /** * The unique identifier of the permission among all permissions on the item. Read-only. */ 'id'?: string; /** * Indicates whether the password is set for this permission. This property only appears in the response. Optional. Read-only. */ 'hasPassword'?: boolean; /** * An optional expiration date which limits the permission in time. */ 'expirationDateTime'?: string | null; /** * An optional creation date. Libregraph only. */ 'createdDateTime'?: string | null; 'grantedToV2'?: SharePointIdentitySet; 'link'?: SharingLink; '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. * @deprecated */ 'grantedToIdentities'?: Array; /** * Use this to create a permission with custom actions. */ '@libre.graph.permissions.actions'?: Array; 'invitation'?: SharingInvitation; } /** * The photo resource provides photo and camera properties, for example, EXIF metadata, on a driveItem. */ export interface Photo { /** * Camera manufacturer. Read-only. */ 'cameraMake'?: string; /** * Camera model. Read-only. */ 'cameraModel'?: string; /** * The denominator for the exposure time fraction from the camera. Read-only. */ 'exposureDenominator'?: number; /** * The numerator for the exposure time fraction from the camera. Read-only. */ 'exposureNumerator'?: number; /** * The F-stop value from the camera. Read-only. */ 'fNumber'?: number; /** * The focal length from the camera. Read-only. */ 'focalLength'?: number; /** * The ISO value from the camera. Read-only. */ 'iso'?: number; /** * The orientation value from the camera. Read-only. */ 'orientation'?: number; /** * Represents the date and time the photo was taken. Read-only. */ 'takenDateTime'?: string; } /** * Optional. Information about the drive\'s storage space quota. Read-only. */ export interface Quota { /** * Total space consumed by files in the recycle bin, in bytes. Read-only. */ 'deleted'?: number; /** * Total space remaining before reaching the quota limit, in bytes. Read-only. */ 'remaining'?: number; /** * Enumeration value that indicates the state of the storage space. Either \"normal\", \"nearing\", \"critical\" or \"exceeded\". Read-only. */ 'state'?: string; /** * Total allowed storage space, in bytes. Read-only. */ 'total'?: number; /** * Total space used, in bytes. Read-only. */ 'used'?: number; } /** * Represents a recipient of an invitation. */ export interface Recipient { 'emailAddress'?: EmailAddress; } /** * Remote item data, if the item is shared from a drive other than the one being accessed. Read-only. */ export interface RemoteItem { 'createdBy'?: IdentitySet; /** * Date and time of item creation. Read-only. */ 'createdDateTime'?: string; 'file'?: OpenGraphFile; 'fileSystemInfo'?: FileSystemInfo; '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. */ 'driveAlias'?: string; /** * The relative path of the item in relation to its drive root. */ 'path'?: string; /** * Unique identifier for the drive root of this item. Read-only. */ 'rootId'?: string; /** * Unique identifier for the remote item in its drive. Read-only. */ 'id'?: string; 'image'?: Image; 'lastModifiedBy'?: IdentitySet; /** * Date and time the item was last modified. Read-only. */ 'lastModifiedDateTime'?: string; /** * Optional. Filename of the remote item. Read-only. */ 'name'?: string; /** * ETag for the item. Read-only. */ '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. */ 'cTag'?: string; 'parentReference'?: ItemReference; /** * The set of permissions for the item. Read-only. Nullable. */ 'permissions'?: Array; /** * Size of the remote item. Read-only. */ 'size'?: number; 'specialFolder'?: SpecialFolder; /** * DAV compatible URL for the item. */ 'webDavUrl'?: string; /** * URL that displays the resource in the browser. Read-only. */ '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 { 'user'?: Identity; 'group'?: Identity; } /** * invitation-related data items */ export interface 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 { '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. */ 'preventsDownload'?: boolean; /** * A URL that opens the item in the browser on the website. */ 'webUrl'?: string; /** * Provides a user-visible display name of the link. Optional. Libregraph only. */ '@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. */ '@libre.graph.quickLink'?: boolean; } /** * The sharing link password which should be set. */ export interface SharingLinkPassword { /** * Password. It may require a password policy. */ '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 declare const SharingLinkType: { readonly Internal: "internal"; readonly View: "view"; readonly Upload: "upload"; readonly Edit: "edit"; readonly CreateOnly: "createOnly"; readonly BlocksDownload: "blocksDownload"; }; 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 { /** * The unique identifier for this item in the /drive/special collection */ 'name'?: string; } export interface TagAssignment { 'resourceId': string; 'tags': Array; } export interface TagUnassignment { 'resourceId': string; '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 { /** * The content stream for the thumbnail. */ 'content'?: string; /** * The height of the thumbnail, in pixels. */ 'height'?: number; /** * The unique identifier of the item that provided the thumbnail. This is only available when a folder thumbnail is requested. */ 'sourceItemId'?: string; /** * The URL used to fetch the thumbnail content. */ 'url'?: string; /** * The width of the thumbnail, in pixels. */ '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 { /** * The ID within the item. Read-only. */ 'id'?: string; 'large'?: Thumbnail; 'medium'?: Thumbnail; 'small'?: Thumbnail; 'source'?: Thumbnail; } /** * Metadata for trashed drive Items */ export interface Trash { 'trashedBy'?: IdentitySet; /** * The UTC date and time the folder was marked as trashed. */ '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 { /** * The description for the unifiedRoleDefinition. */ 'description'?: string; /** * The display name for the unifiedRoleDefinition. Required. Supports $filter (`eq`, `in`). */ 'displayName'?: string; /** * The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (`eq`, `in`). */ 'id'?: string; /** * List of permissions included in the role. */ '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. */ '@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 { /** * 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`. */ '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. */ 'condition'?: string; } /** * Represents an Active Directory user object. */ export interface User { /** * Read-only. */ 'id'?: string; /** * Set to \"true\" when the account is enabled. */ 'accountEnabled'?: boolean; /** * The apps and app roles which this user has been assigned. */ '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. */ 'displayName': string; /** * A collection of drives available for this user. Read-only. */ 'drives'?: Array; 'drive'?: Drive; /** * Identities associated with this account. */ 'identities'?: Array; /** * The SMTP address for the user, for example, \'jeff@contoso.opencloud.com\'. Returned by default. */ 'mail'?: string; /** * Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. */ 'memberOf'?: Array; /** * Contains the on-premises SAM account name synchronized from the on-premises directory. */ 'onPremisesSamAccountName': string; 'passwordProfile'?: PasswordProfile; /** * The user\'s surname (family name or last name). Returned by default. */ 'surname'?: string; /** * The user\'s givenName. Returned by default. */ '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. */ 'userType'?: string; /** * Represents the users language setting, ISO-639-1 Code */ 'preferredLanguage'?: string; 'signInActivity'?: SignInActivity; } /** * Represents updates to an Active Directory user object. */ export interface UserUpdate { /** * Read-only. */ 'id'?: string; /** * Set to \"true\" when the account is enabled. */ 'accountEnabled'?: boolean; /** * The apps and app roles which this user has been assigned. */ '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. */ 'displayName'?: string; /** * A collection of drives available for this user. Read-only. */ 'drives'?: Array; 'drive'?: Drive; /** * Identities associated with this account. */ 'identities'?: Array; /** * The SMTP address for the user, for example, \'jeff@contoso.opencloud.com\'. Returned by default. */ 'mail'?: string; /** * Groups that this user is a member of. HTTP Methods: GET (supported for all groups). Read-only. Nullable. Supports $expand. */ 'memberOf'?: Array; /** * Contains the on-premises SAM account name synchronized from the on-premises directory. */ 'onPremisesSamAccountName'?: string; 'passwordProfile'?: PasswordProfile; /** * The user\'s surname (family name or last name). Returned by default. */ 'surname'?: string; /** * The user\'s givenName. Returned by default. */ '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. */ 'userType'?: string; /** * Represents the users language setting, ISO-639-1 Code */ 'preferredLanguage'?: string; 'signInActivity'?: SignInActivity; } /** * 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 { /** * Number of audio bits per sample. */ 'audioBitsPerSample'?: number; /** * Number of audio channels. */ 'audioChannels'?: number; /** * Name of the audio format (AAC, MP3, etc.). */ 'audioFormat'?: string; /** * Number of audio samples per second. */ 'audioSamplesPerSecond'?: number; /** * Bit rate of the video in bits per second. */ 'bitrate'?: number; /** * Duration of the file in milliseconds. */ 'duration'?: number; /** * \\\"Four character code\\\" name of the video format. */ 'fourCC'?: string; /** * Frame rate of the video. */ 'frameRate'?: number; /** * Height of the video, in pixels. */ 'height'?: number; /** * Width of the video, in pixels. */ 'width'?: number; } /** * ActivitiesApi - axios parameter creator */ export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get activities * @param {string} [kql] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActivities: (kql?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ActivitiesApi - functional programming interface */ export declare const ActivitiesApiFp: (configuration?: Configuration) => { /** * * @summary Get activities * @param {string} [kql] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActivities(kql?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ActivitiesApi - factory interface */ export declare const ActivitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get activities * @param {string} [kql] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActivities(kql?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ActivitiesApi - object-oriented interface */ export declare class ActivitiesApi extends BaseAPI { /** * * @summary Get activities * @param {string} [kql] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActivities(kql?: string, options?: RawAxiosRequestConfig): Promise>; } /** * ApplicationsApi - axios parameter creator */ export declare const ApplicationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get application by id * @param {string} applicationId key: id of application * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplication: (applicationId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get all applications * @param {*} [options] Override http request option. * @throws {RequiredError} */ listApplications: (options?: RawAxiosRequestConfig) => Promise; }; /** * ApplicationsApi - functional programming interface */ export declare const ApplicationsApiFp: (configuration?: Configuration) => { /** * * @summary Get application by id * @param {string} applicationId key: id of application * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplication(applicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get all applications * @param {*} [options] Override http request option. * @throws {RequiredError} */ listApplications(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ApplicationsApi - factory interface */ export declare const ApplicationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get application by id * @param {string} applicationId key: id of application * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplication(applicationId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get all applications * @param {*} [options] Override http request option. * @throws {RequiredError} */ listApplications(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ApplicationsApi - object-oriented interface */ export declare class ApplicationsApi extends BaseAPI { /** * * @summary Get application by id * @param {string} applicationId key: id of application * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApplication(applicationId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get all applications * @param {*} [options] Override http request option. * @throws {RequiredError} */ listApplications(options?: RawAxiosRequestConfig): Promise>; } /** * DriveItemApi - axios parameter creator */ export declare const DriveItemApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new folder or DriveItem in a Drive with the specified parent item. The parent must exist and be a folder. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). Identical request and response shape to the [drive-root variant](#/drives.root/CreateDriveItem), just with an explicit parent item id rather than the drive root. The request body must specify exactly one of `folder` (set to `{}` to create a folder) or `file` (to create a file item). Requests with none of these, or with both, return 400. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item (relative to `item-id`), and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem under a parent item * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder` or `file`. * @param {CreateChildDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createChildDriveItem: (driveId: string, itemId: string, driveItem: DriveItem, libreGraphConflictBehavior?: CreateChildDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Delete a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDriveItem: (driveId: string, itemId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a DriveItem by using its ID. * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItem: (driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig) => Promise; /** * List the children of the item identified by `item-id` in the drive identified by `drive-id`. The item must exist and be a folder. Modeled on the MS Graph list driveItem children endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-list-children). This endpoint also accepts the MS Graph colon-syntax URL forms: GET /v1.0/drives/{drive-id}/root:/{path}:/children GET /v1.0/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so these URL forms are not represented as separate operations in this specification. The server still accepts them, resolves `:/{path}:` as the parent item, and lists its children. * @summary List children of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemChildren: (driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig) => Promise; /** * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded. The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation. The pre-authenticated URL is short-lived and does not require an `Authorization` header. To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request. * @summary Download the content of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemContent: (driveId: string, itemId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a DriveItem by using its ID. Modeled on the MS Graph get driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-get). * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemV1: (driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Update a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem DriveItem properties to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDriveItem: (driveId: string, itemId: string, driveItem: DriveItem, options?: RawAxiosRequestConfig) => Promise; }; /** * DriveItemApi - functional programming interface */ export declare const DriveItemApiFp: (configuration?: Configuration) => { /** * Create a new folder or DriveItem in a Drive with the specified parent item. The parent must exist and be a folder. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). Identical request and response shape to the [drive-root variant](#/drives.root/CreateDriveItem), just with an explicit parent item id rather than the drive root. The request body must specify exactly one of `folder` (set to `{}` to create a folder) or `file` (to create a file item). Requests with none of these, or with both, return 400. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item (relative to `item-id`), and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem under a parent item * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder` or `file`. * @param {CreateChildDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createChildDriveItem(driveId: string, itemId: string, driveItem: DriveItem, libreGraphConflictBehavior?: CreateChildDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Delete a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a DriveItem by using its ID. * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItem(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List the children of the item identified by `item-id` in the drive identified by `drive-id`. The item must exist and be a folder. Modeled on the MS Graph list driveItem children endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-list-children). This endpoint also accepts the MS Graph colon-syntax URL forms: GET /v1.0/drives/{drive-id}/root:/{path}:/children GET /v1.0/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so these URL forms are not represented as separate operations in this specification. The server still accepts them, resolves `:/{path}:` as the parent item, and lists its children. * @summary List children of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemChildren(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded. The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation. The pre-authenticated URL is short-lived and does not require an `Authorization` header. To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request. * @summary Download the content of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemContent(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a DriveItem by using its ID. Modeled on the MS Graph get driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-get). * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemV1(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Update a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem DriveItem properties to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDriveItem(driveId: string, itemId: string, driveItem: DriveItem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DriveItemApi - factory interface */ export declare const DriveItemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new folder or DriveItem in a Drive with the specified parent item. The parent must exist and be a folder. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). Identical request and response shape to the [drive-root variant](#/drives.root/CreateDriveItem), just with an explicit parent item id rather than the drive root. The request body must specify exactly one of `folder` (set to `{}` to create a folder) or `file` (to create a file item). Requests with none of these, or with both, return 400. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item (relative to `item-id`), and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem under a parent item * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder` or `file`. * @param {CreateChildDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createChildDriveItem(driveId: string, itemId: string, driveItem: DriveItem, libreGraphConflictBehavior?: CreateChildDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Delete a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a DriveItem by using its ID. * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItem(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * List the children of the item identified by `item-id` in the drive identified by `drive-id`. The item must exist and be a folder. Modeled on the MS Graph list driveItem children endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-list-children). This endpoint also accepts the MS Graph colon-syntax URL forms: GET /v1.0/drives/{drive-id}/root:/{path}:/children GET /v1.0/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so these URL forms are not represented as separate operations in this specification. The server still accepts them, resolves `:/{path}:` as the parent item, and lists its children. * @summary List children of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemChildren(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded. The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation. The pre-authenticated URL is short-lived and does not require an `Authorization` header. To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request. * @summary Download the content of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemContent(driveId: string, itemId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a DriveItem by using its ID. Modeled on the MS Graph get driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-get). * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemV1(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Update a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem DriveItem properties to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDriveItem(driveId: string, itemId: string, driveItem: DriveItem, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DriveItemApi - object-oriented interface */ export declare class DriveItemApi extends BaseAPI { /** * Create a new folder or DriveItem in a Drive with the specified parent item. The parent must exist and be a folder. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). Identical request and response shape to the [drive-root variant](#/drives.root/CreateDriveItem), just with an explicit parent item id rather than the drive root. The request body must specify exactly one of `folder` (set to `{}` to create a folder) or `file` (to create a file item). Requests with none of these, or with both, return 400. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item (relative to `item-id`), and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem under a parent item * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder` or `file`. * @param {CreateChildDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createChildDriveItem(driveId: string, itemId: string, driveItem: DriveItem, libreGraphConflictBehavior?: CreateChildDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Delete a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDriveItem(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise>; /** * Get a DriveItem by using its ID. * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItem(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise>; /** * List the children of the item identified by `item-id` in the drive identified by `drive-id`. The item must exist and be a folder. Modeled on the MS Graph list driveItem children endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-list-children). This endpoint also accepts the MS Graph colon-syntax URL forms: GET /v1.0/drives/{drive-id}/root:/{path}:/children GET /v1.0/drives/{drive-id}/items/{item-id}:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so these URL forms are not represented as separate operations in this specification. The server still accepts them, resolves `:/{path}:` as the parent item, and lists its children. * @summary List children of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemChildren(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise>; /** * Download the contents of the primary stream (file) of a driveItem. Only driveItem objects with a `file` facet can be downloaded. The response is a `302 Found` redirecting to a pre-authenticated download URL for the file. This is the same URL that is returned via the `@microsoft.graph.downloadUrl` instance annotation on the driveItem when requested via `$select`. Choose between the two based on whether you want to call the redirecting `/content` endpoint directly (for example, with a client that follows redirects automatically) or you want to inspect / schedule / prefetch the URL yourself via the annotation. The pre-authenticated URL is short-lived and does not require an `Authorization` header. To download a partial range of bytes, apply the `Range` header to the redirect target (the pre-authenticated URL), not to the `/content` request. * @summary Download the content of a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemContent(driveId: string, itemId: string, options?: RawAxiosRequestConfig): Promise>; /** * Get a DriveItem by using its ID. Modeled on the MS Graph get driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-get). * @summary Get a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDriveItemV1(driveId: string, itemId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Update a DriveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItem} driveItem DriveItem properties to update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDriveItem(driveId: string, itemId: string, driveItem: DriveItem, options?: RawAxiosRequestConfig): Promise>; } export declare const CreateChildDriveItemAtLibreGraphConflictBehaviorEnum: { readonly Fail: "fail"; readonly Replace: "replace"; }; export type CreateChildDriveItemAtLibreGraphConflictBehaviorEnum = typeof CreateChildDriveItemAtLibreGraphConflictBehaviorEnum[keyof typeof CreateChildDriveItemAtLibreGraphConflictBehaviorEnum]; export declare const CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum: { readonly Fail: "fail"; readonly Create: "create"; }; export type CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum = typeof CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum[keyof typeof CreateChildDriveItemAtLibreGraphMissingParentsBehaviorEnum]; export declare const GetDriveItemSelectEnum: { readonly MicrosoftGraphDownloadUrl: "@microsoft.graph.downloadUrl"; readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; }; export type GetDriveItemSelectEnum = typeof GetDriveItemSelectEnum[keyof typeof GetDriveItemSelectEnum]; export declare const GetDriveItemChildrenSelectEnum: { readonly MicrosoftGraphDownloadUrl: "@microsoft.graph.downloadUrl"; readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; }; export type GetDriveItemChildrenSelectEnum = typeof GetDriveItemChildrenSelectEnum[keyof typeof GetDriveItemChildrenSelectEnum]; export declare const GetDriveItemV1SelectEnum: { readonly MicrosoftGraphDownloadUrl: "@microsoft.graph.downloadUrl"; readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; }; export type GetDriveItemV1SelectEnum = typeof GetDriveItemV1SelectEnum[keyof typeof GetDriveItemV1SelectEnum]; /** * DrivesApi - axios parameter creator */ export declare const DrivesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @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: (drive: Drive, options?: RawAxiosRequestConfig) => Promise; /** * * @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: (driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get drive by id * @param {string} driveId key: id of drive * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDrive: (driveId: string, $select?: Set, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update the drive * @param {string} driveId key: id of drive * @param {DriveUpdate} driveUpdate New space values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDrive: (driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig) => Promise; }; /** * DrivesApi - functional programming interface */ export declare const DrivesApiFp: (configuration?: Configuration) => { /** * * @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(drive: Drive, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @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(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get drive by id * @param {string} driveId key: id of drive * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDrive(driveId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the drive * @param {string} driveId key: id of drive * @param {DriveUpdate} driveUpdate New space values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDrive(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DrivesApi - factory interface */ export declare const DrivesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @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(drive: Drive, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @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(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get drive by id * @param {string} driveId key: id of drive * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDrive(driveId: string, $select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update the drive * @param {string} driveId key: id of drive * @param {DriveUpdate} driveUpdate New space values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDrive(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DrivesApi - object-oriented interface */ export declare class DrivesApi extends BaseAPI { /** * * @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(drive: Drive, options?: RawAxiosRequestConfig): Promise>; /** * * @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(driveId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get drive by id * @param {string} driveId key: id of drive * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDrive(driveId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update the drive * @param {string} driveId key: id of drive * @param {DriveUpdate} driveUpdate New space values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateDrive(driveId: string, driveUpdate: DriveUpdate, options?: RawAxiosRequestConfig): Promise>; } export declare const GetDriveSelectEnum: { readonly LibreGraphHasTrashedItems: "@libre.graph.hasTrashedItems"; }; export type GetDriveSelectEnum = typeof GetDriveSelectEnum[keyof typeof GetDriveSelectEnum]; /** * DrivesGetDrivesApi - axios parameter creator */ export declare const DrivesGetDrivesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get all available drives * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrives: ($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrivesBeta: ($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig) => Promise; }; /** * DrivesGetDrivesApi - functional programming interface */ export declare const DrivesGetDrivesApiFp: (configuration?: Configuration) => { /** * * @summary Get all available drives * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrivesBeta($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DrivesGetDrivesApi - factory interface */ export declare const DrivesGetDrivesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get all available drives * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrivesBeta($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DrivesGetDrivesApi - object-oriented interface */ export declare class DrivesGetDrivesApi extends BaseAPI { /** * * @summary Get all available drives * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAllDrivesBeta($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig): Promise>; } export declare const ListAllDrivesBetaSelectEnum: { readonly LibreGraphHasTrashedItems: "@libre.graph.hasTrashedItems"; }; export type ListAllDrivesBetaSelectEnum = typeof ListAllDrivesBetaSelectEnum[keyof typeof ListAllDrivesBetaSelectEnum]; /** * DrivesPermissionsApi - axios parameter creator */ export declare const DrivesPermissionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * 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. | * @summary Create a sharing link for a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLink: (driveId: string, itemId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig) => Promise; /** * Remove access to a DriveItem. Only sharing permissions that are not inherited can be deleted. The `inheritedFrom` property must be `null`. * @summary Remove access to a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermission: (driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig) => Promise; /** * Return the effective sharing permission for a particular permission resource. * @summary Get sharing permission for a file or folder * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermission: (driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @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} */ invite: (driveId: string, itemId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary List the effective sharing permissions on a driveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissions: (driveId: string, itemId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig) => Promise; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPassword: (driveId: string, itemId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig) => Promise; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermission: (driveId: string, itemId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig) => Promise; }; /** * DrivesPermissionsApi - functional programming interface */ export declare const DrivesPermissionsApiFp: (configuration?: Configuration) => { /** * 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. | * @summary Create a sharing link for a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLink(driveId: string, itemId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove access to a DriveItem. Only sharing permissions that are not inherited can be deleted. The `inheritedFrom` property must be `null`. * @summary Remove access to a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return the effective sharing permission for a particular permission resource. * @summary Get sharing permission for a file or folder * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @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} */ invite(driveId: string, itemId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary List the effective sharing permissions on a driveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissions(driveId: string, itemId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPassword(driveId: string, itemId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermission(driveId: string, itemId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DrivesPermissionsApi - factory interface */ export declare const DrivesPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 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. | * @summary Create a sharing link for a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLink(driveId: string, itemId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig): AxiosPromise; /** * Remove access to a DriveItem. Only sharing permissions that are not inherited can be deleted. The `inheritedFrom` property must be `null`. * @summary Remove access to a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Return the effective sharing permission for a particular permission resource. * @summary Get sharing permission for a file or folder * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @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} */ invite(driveId: string, itemId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary List the effective sharing permissions on a driveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissions(driveId: string, itemId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPassword(driveId: string, itemId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermission(driveId: string, itemId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DrivesPermissionsApi - object-oriented interface */ export declare class DrivesPermissionsApi extends BaseAPI { /** * 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. | * @summary Create a sharing link for a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLink(driveId: string, itemId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig): Promise>; /** * Remove access to a DriveItem. Only sharing permissions that are not inherited can be deleted. The `inheritedFrom` property must be `null`. * @summary Remove access to a DriveItem * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig): Promise>; /** * Return the effective sharing permission for a particular permission resource. * @summary Get sharing permission for a file or folder * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermission(driveId: string, itemId: string, permId: string, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @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} */ invite(driveId: string, itemId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary List the effective sharing permissions on a driveItem. * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissions(driveId: string, itemId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig): Promise>; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPassword(driveId: string, itemId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig): Promise>; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} itemId key: id of item * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermission(driveId: string, itemId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig): Promise>; } export declare const ListPermissionsSelectEnum: { readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; readonly LibreGraphPermissionsRolesAllowedValues: "@libre.graph.permissions.roles.allowedValues"; readonly Value: "value"; }; export type ListPermissionsSelectEnum = typeof ListPermissionsSelectEnum[keyof typeof ListPermissionsSelectEnum]; /** * DrivesRootApi - axios parameter creator */ export declare const DrivesRootApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new folder or DriveItem in a Drive with the drive root as the parent. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). The request body must specify exactly one of `folder` (set to `{}` to create a folder), `file` (to create a file item), or `remoteItem` (to mount a shared item; see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id`). Requests with none of these, or with more than one, return 400. Mounting a share changes the `@client.synchronize` property of the `driveItem` in [sharedWithMe](#/me.drive/ListSharedWithMe) to true. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/root:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item, and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem at the drive root * @param {string} driveId key: id of drive * @param {CreateDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {DriveItem} [driveItem] In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder`, `file`, or `remoteItem`. For mount-share, see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id` and `permission` id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDriveItem: (driveId: string, libreGraphConflictBehavior?: CreateDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum, driveItem?: DriveItem, options?: RawAxiosRequestConfig) => Promise; /** * 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. | * @summary Create a sharing link for the root item of a Drive * @param {string} driveId key: id of drive * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLinkSpaceRoot: (driveId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig) => Promise; /** * 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`. * @summary Remove access to a Drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermissionSpaceRoot: (driveId: string, permId: string, options?: RawAxiosRequestConfig) => Promise; /** * Return the effective sharing permission for a particular permission resource. * @summary Get a single sharing permission for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionSpaceRoot: (driveId: string, permId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get root from arbitrary space * @param {string} driveId key: id of drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoot: (driveId: string, $select?: Set, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @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} */ inviteSpaceRoot: (driveId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary List the effective permissions on the root item of a drive. * @param {string} driveId key: id of drive * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionsSpaceRoot: (driveId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig) => Promise; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPasswordSpaceRoot: (driveId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig) => Promise; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermissionSpaceRoot: (driveId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig) => Promise; }; /** * DrivesRootApi - functional programming interface */ export declare const DrivesRootApiFp: (configuration?: Configuration) => { /** * Create a new folder or DriveItem in a Drive with the drive root as the parent. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). The request body must specify exactly one of `folder` (set to `{}` to create a folder), `file` (to create a file item), or `remoteItem` (to mount a shared item; see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id`). Requests with none of these, or with more than one, return 400. Mounting a share changes the `@client.synchronize` property of the `driveItem` in [sharedWithMe](#/me.drive/ListSharedWithMe) to true. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/root:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item, and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem at the drive root * @param {string} driveId key: id of drive * @param {CreateDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {DriveItem} [driveItem] In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder`, `file`, or `remoteItem`. For mount-share, see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id` and `permission` id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDriveItem(driveId: string, libreGraphConflictBehavior?: CreateDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum, driveItem?: DriveItem, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. | * @summary Create a sharing link for the root item of a Drive * @param {string} driveId key: id of drive * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLinkSpaceRoot(driveId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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`. * @summary Remove access to a Drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Return the effective sharing permission for a particular permission resource. * @summary Get a single sharing permission for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get root from arbitrary space * @param {string} driveId key: id of drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoot(driveId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @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} */ inviteSpaceRoot(driveId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary List the effective permissions on the root item of a drive. * @param {string} driveId key: id of drive * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionsSpaceRoot(driveId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPasswordSpaceRoot(driveId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermissionSpaceRoot(driveId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DrivesRootApi - factory interface */ export declare const DrivesRootApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new folder or DriveItem in a Drive with the drive root as the parent. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). The request body must specify exactly one of `folder` (set to `{}` to create a folder), `file` (to create a file item), or `remoteItem` (to mount a shared item; see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id`). Requests with none of these, or with more than one, return 400. Mounting a share changes the `@client.synchronize` property of the `driveItem` in [sharedWithMe](#/me.drive/ListSharedWithMe) to true. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/root:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item, and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem at the drive root * @param {string} driveId key: id of drive * @param {CreateDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {DriveItem} [driveItem] In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder`, `file`, or `remoteItem`. For mount-share, see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id` and `permission` id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDriveItem(driveId: string, libreGraphConflictBehavior?: CreateDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum, driveItem?: DriveItem, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. | * @summary Create a sharing link for the root item of a Drive * @param {string} driveId key: id of drive * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLinkSpaceRoot(driveId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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`. * @summary Remove access to a Drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Return the effective sharing permission for a particular permission resource. * @summary Get a single sharing permission for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get root from arbitrary space * @param {string} driveId key: id of drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoot(driveId: string, $select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @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} */ inviteSpaceRoot(driveId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary List the effective permissions on the root item of a drive. * @param {string} driveId key: id of drive * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionsSpaceRoot(driveId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPasswordSpaceRoot(driveId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermissionSpaceRoot(driveId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * DrivesRootApi - object-oriented interface */ export declare class DrivesRootApi extends BaseAPI { /** * Create a new folder or DriveItem in a Drive with the drive root as the parent. Modeled on the MS Graph create driveItem endpoint (https://learn.microsoft.com/en-us/graph/api/driveitem-post-children). The request body must specify exactly one of `folder` (set to `{}` to create a folder), `file` (to create a file item), or `remoteItem` (to mount a shared item; see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id`). Requests with none of these, or with more than one, return 400. Mounting a share changes the `@client.synchronize` property of the `driveItem` in [sharedWithMe](#/me.drive/ListSharedWithMe) to true. The `@libre.graph.conflictBehavior` query parameter controls what happens if a child with the same name already exists. This endpoint also accepts the MS Graph colon-syntax URL form: POST /v1beta1/drives/{drive-id}/root:/{path}:/children OpenAPI cannot express the colon-delimited path segment, so this URL form is not represented as a separate operation in this specification. The server still accepts it, resolves `:/{path}:` as the parent of the new item, and applies `@libre.graph.missingParentsBehavior` to decide whether to create missing intermediate folders. * @summary Create a new DriveItem at the drive root * @param {string} driveId key: id of drive * @param {CreateDriveItemAtLibreGraphConflictBehaviorEnum} [libreGraphConflictBehavior] Controls what happens when a child with the same name already exists. `fail` (default) returns 409; `replace` overwrites the existing item. MS Graph\'s `rename` value is not supported. * @param {CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum} [libreGraphMissingParentsBehavior] Controls what happens when a colon-syntax URL refers to a path whose intermediate folders don\'t all exist yet. `fail` (default) returns 404; `create` creates the missing intermediate folders before creating the final item. Only meaningful for colon-syntax URLs; ignored otherwise. * @param {DriveItem} [driveItem] In the request body, provide a JSON object describing the new driveItem. Must specify exactly one of `folder`, `file`, or `remoteItem`. For mount-share, see [sharedWithMe](#/me.drive/ListSharedWithMe) for obtaining the source `remoteItem.id` and `permission` id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDriveItem(driveId: string, libreGraphConflictBehavior?: CreateDriveItemAtLibreGraphConflictBehaviorEnum, libreGraphMissingParentsBehavior?: CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum, driveItem?: DriveItem, options?: RawAxiosRequestConfig): Promise>; /** * 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. | * @summary Create a sharing link for the root item of a Drive * @param {string} driveId key: id of drive * @param {DriveItemCreateLink} [driveItemCreateLink] In the request body, provide a JSON object with the following parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLinkSpaceRoot(driveId: string, driveItemCreateLink?: DriveItemCreateLink, options?: RawAxiosRequestConfig): Promise>; /** * 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`. * @summary Remove access to a Drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ deletePermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig): Promise>; /** * Return the effective sharing permission for a particular permission resource. * @summary Get a single sharing permission for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionSpaceRoot(driveId: string, permId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get root from arbitrary space * @param {string} driveId key: id of drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoot(driveId: string, $select?: Set, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Send a sharing invitation * @param {string} driveId key: id of drive * @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} */ inviteSpaceRoot(driveId: string, driveItemInvite?: DriveItemInvite, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary List the effective permissions on the root item of a drive. * @param {string} driveId key: id of drive * @param {string} [$filter] 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. * @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 {boolean} [$count] Include count of items * @param {number} [$top] Show only the first n items * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionsSpaceRoot(driveId: string, $filter?: string, $select?: Set, $count?: boolean, $top?: number, options?: RawAxiosRequestConfig): Promise>; /** * Set the password of a sharing permission. Only the `password` property can be modified this way. * @summary Set sharing link password for the root item of a drive * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {SharingLinkPassword} sharingLinkPassword New password value * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPermissionPasswordSpaceRoot(driveId: string, permId: string, sharingLinkPassword: SharingLinkPassword, options?: RawAxiosRequestConfig): Promise>; /** * Update the properties of a sharing permission by patching the permission resource. Only the `roles`, `expirationDateTime` and `password` properties can be modified this way. * @summary Update sharing permission * @param {string} driveId key: id of drive * @param {string} permId key: id of permission * @param {Permission} permission New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePermissionSpaceRoot(driveId: string, permId: string, permission: Permission, options?: RawAxiosRequestConfig): Promise>; } export declare const CreateDriveItemAtLibreGraphConflictBehaviorEnum: { readonly Fail: "fail"; readonly Replace: "replace"; }; export type CreateDriveItemAtLibreGraphConflictBehaviorEnum = typeof CreateDriveItemAtLibreGraphConflictBehaviorEnum[keyof typeof CreateDriveItemAtLibreGraphConflictBehaviorEnum]; export declare const CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum: { readonly Fail: "fail"; readonly Create: "create"; }; export type CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum = typeof CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum[keyof typeof CreateDriveItemAtLibreGraphMissingParentsBehaviorEnum]; export declare const GetRootSelectEnum: { readonly MicrosoftGraphDownloadUrl: "@microsoft.graph.downloadUrl"; readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; }; export type GetRootSelectEnum = typeof GetRootSelectEnum[keyof typeof GetRootSelectEnum]; export declare const ListPermissionsSpaceRootSelectEnum: { readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; readonly LibreGraphPermissionsRolesAllowedValues: "@libre.graph.permissions.roles.allowedValues"; readonly Value: "value"; }; export type ListPermissionsSpaceRootSelectEnum = typeof ListPermissionsSpaceRootSelectEnum[keyof typeof ListPermissionsSpaceRootSelectEnum]; /** * EducationClassApi - axios parameter creator */ export declare const EducationClassApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Assign a user to a class * @param {string} classId key: id or externalId of class * @param {ClassMemberReference} classMemberReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToClass: (classId: string, classMemberReference: ClassMemberReference, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Add new education class * @param {EducationClass} educationClass New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClass: (educationClass: EducationClass, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete education class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClass: (classId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Unassign user from a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign from class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromClass: (classId: string, userId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get class by key * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClass: (classId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClassMembers: (classId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary list education classes * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClasses: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update properties of a education class * @param {string} classId key: id or externalId of class * @param {EducationClass} educationClass New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClass: (classId: string, educationClass: EducationClass, options?: RawAxiosRequestConfig) => Promise; }; /** * EducationClassApi - functional programming interface */ export declare const EducationClassApiFp: (configuration?: Configuration) => { /** * * @summary Assign a user to a class * @param {string} classId key: id or externalId of class * @param {ClassMemberReference} classMemberReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToClass(classId: string, classMemberReference: ClassMemberReference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Add new education class * @param {EducationClass} educationClass New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClass(educationClass: EducationClass, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete education class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClass(classId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Unassign user from a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign from class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get class by key * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClass(classId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClassMembers(classId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary list education classes * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClasses(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update properties of a education class * @param {string} classId key: id or externalId of class * @param {EducationClass} educationClass New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClass(classId: string, educationClass: EducationClass, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EducationClassApi - factory interface */ export declare const EducationClassApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Assign a user to a class * @param {string} classId key: id or externalId of class * @param {ClassMemberReference} classMemberReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToClass(classId: string, classMemberReference: ClassMemberReference, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Add new education class * @param {EducationClass} educationClass New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClass(educationClass: EducationClass, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete education class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClass(classId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Unassign user from a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign from class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get class by key * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClass(classId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClassMembers(classId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary list education classes * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClasses(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update properties of a education class * @param {string} classId key: id or externalId of class * @param {EducationClass} educationClass New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClass(classId: string, educationClass: EducationClass, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * EducationClassApi - object-oriented interface */ export declare class EducationClassApi extends BaseAPI { /** * * @summary Assign a user to a class * @param {string} classId key: id or externalId of class * @param {ClassMemberReference} classMemberReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToClass(classId: string, classMemberReference: ClassMemberReference, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Add new education class * @param {EducationClass} educationClass New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClass(educationClass: EducationClass, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete education class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClass(classId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Unassign user from a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign from class * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get class by key * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClass(classId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClassMembers(classId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary list education classes * @param {*} [options] Override http request option. * @throws {RequiredError} */ listClasses(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update properties of a education class * @param {string} classId key: id or externalId of class * @param {EducationClass} educationClass New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateClass(classId: string, educationClass: EducationClass, options?: RawAxiosRequestConfig): Promise>; } /** * EducationClassTeachersApi - axios parameter creator */ export declare const EducationClassTeachersApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Assign a teacher to a class * @param {string} classId key: id or externalId of class * @param {ClassTeacherReference} classTeacherReference educationUser to be added as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ addTeacherToClass: (classId: string, classTeacherReference: ClassTeacherReference, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Unassign user as teacher of a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeacherFromClass: (classId: string, userId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get the teachers for a class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeachers: (classId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * EducationClassTeachersApi - functional programming interface */ export declare const EducationClassTeachersApiFp: (configuration?: Configuration) => { /** * * @summary Assign a teacher to a class * @param {string} classId key: id or externalId of class * @param {ClassTeacherReference} classTeacherReference educationUser to be added as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ addTeacherToClass(classId: string, classTeacherReference: ClassTeacherReference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Unassign user as teacher of a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeacherFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get the teachers for a class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeachers(classId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EducationClassTeachersApi - factory interface */ export declare const EducationClassTeachersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Assign a teacher to a class * @param {string} classId key: id or externalId of class * @param {ClassTeacherReference} classTeacherReference educationUser to be added as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ addTeacherToClass(classId: string, classTeacherReference: ClassTeacherReference, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Unassign user as teacher of a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeacherFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get the teachers for a class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeachers(classId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * EducationClassTeachersApi - object-oriented interface */ export declare class EducationClassTeachersApi extends BaseAPI { /** * * @summary Assign a teacher to a class * @param {string} classId key: id or externalId of class * @param {ClassTeacherReference} classTeacherReference educationUser to be added as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ addTeacherToClass(classId: string, classTeacherReference: ClassTeacherReference, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Unassign user as teacher of a class * @param {string} classId key: id or externalId of class * @param {string} userId key: id or username of the user to unassign as teacher * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeacherFromClass(classId: string, userId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get the teachers for a class * @param {string} classId key: id or externalId of class * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTeachers(classId: string, options?: RawAxiosRequestConfig): Promise>; } /** * EducationSchoolApi - axios parameter creator */ export declare const EducationSchoolApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Assign a class to a school * @param {string} schoolId key: id or schoolNumber of school * @param {ClassReference} classReference educationClass to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addClassToSchool: (schoolId: string, classReference: ClassReference, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Assign a user to a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationUserReference} educationUserReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToSchool: (schoolId: string, educationUserReference: EducationUserReference, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Add new school * @param {EducationSchool} educationSchool New school * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSchool: (educationSchool: EducationSchool, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Unassign class from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} classId key: id or externalId of the class to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClassFromSchool: (schoolId: string, classId: string, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Delete school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSchool: (schoolId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Unassign user from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} userId key: id or username of the user to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromSchool: (schoolId: string, userId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get the properties of a specific school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSchool: (schoolId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolClasses: (schoolId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get the educationUser resources associated with an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolUsers: (schoolId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a collection of education schools with optional filtering and ordering. **Filtering by external ID:** Use `$filter` to query schools by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get a list of schools and their properties * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchools: ($filter?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update properties of a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationSchool} educationSchool New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSchool: (schoolId: string, educationSchool: EducationSchool, options?: RawAxiosRequestConfig) => Promise; }; /** * EducationSchoolApi - functional programming interface */ export declare const EducationSchoolApiFp: (configuration?: Configuration) => { /** * * @summary Assign a class to a school * @param {string} schoolId key: id or schoolNumber of school * @param {ClassReference} classReference educationClass to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addClassToSchool(schoolId: string, classReference: ClassReference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Assign a user to a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationUserReference} educationUserReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToSchool(schoolId: string, educationUserReference: EducationUserReference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Add new school * @param {EducationSchool} educationSchool New school * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSchool(educationSchool: EducationSchool, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Unassign class from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} classId key: id or externalId of the class to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClassFromSchool(schoolId: string, classId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Delete school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSchool(schoolId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Unassign user from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} userId key: id or username of the user to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromSchool(schoolId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get the properties of a specific school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSchool(schoolId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolClasses(schoolId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get the educationUser resources associated with an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolUsers(schoolId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a collection of education schools with optional filtering and ordering. **Filtering by external ID:** Use `$filter` to query schools by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get a list of schools and their properties * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchools($filter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update properties of a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationSchool} educationSchool New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSchool(schoolId: string, educationSchool: EducationSchool, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EducationSchoolApi - factory interface */ export declare const EducationSchoolApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Assign a class to a school * @param {string} schoolId key: id or schoolNumber of school * @param {ClassReference} classReference educationClass to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addClassToSchool(schoolId: string, classReference: ClassReference, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Assign a user to a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationUserReference} educationUserReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToSchool(schoolId: string, educationUserReference: EducationUserReference, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Add new school * @param {EducationSchool} educationSchool New school * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSchool(educationSchool: EducationSchool, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Unassign class from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} classId key: id or externalId of the class to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClassFromSchool(schoolId: string, classId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Delete school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSchool(schoolId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Unassign user from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} userId key: id or username of the user to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromSchool(schoolId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get the properties of a specific school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSchool(schoolId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolClasses(schoolId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get the educationUser resources associated with an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolUsers(schoolId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a collection of education schools with optional filtering and ordering. **Filtering by external ID:** Use `$filter` to query schools by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get a list of schools and their properties * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchools($filter?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update properties of a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationSchool} educationSchool New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSchool(schoolId: string, educationSchool: EducationSchool, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * EducationSchoolApi - object-oriented interface */ export declare class EducationSchoolApi extends BaseAPI { /** * * @summary Assign a class to a school * @param {string} schoolId key: id or schoolNumber of school * @param {ClassReference} classReference educationClass to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addClassToSchool(schoolId: string, classReference: ClassReference, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Assign a user to a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationUserReference} educationUserReference educationUser to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserToSchool(schoolId: string, educationUserReference: EducationUserReference, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Add new school * @param {EducationSchool} educationSchool New school * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSchool(educationSchool: EducationSchool, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Unassign class from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} classId key: id or externalId of the class to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClassFromSchool(schoolId: string, classId: string, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Delete school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSchool(schoolId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Unassign user from a school * @param {string} schoolId key: id or schoolNumber of school * @param {string} userId key: id or username of the user to unassign from school * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserFromSchool(schoolId: string, userId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get the properties of a specific school * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSchool(schoolId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get the educationClass resources owned by an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolClasses(schoolId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get the educationUser resources associated with an educationSchool * @param {string} schoolId key: id or schoolNumber of school * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchoolUsers(schoolId: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a collection of education schools with optional filtering and ordering. **Filtering by external ID:** Use `$filter` to query schools by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get a list of schools and their properties * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSchools($filter?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update properties of a school * @param {string} schoolId key: id or schoolNumber of school * @param {EducationSchool} educationSchool New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSchool(schoolId: string, educationSchool: EducationSchool, options?: RawAxiosRequestConfig): Promise>; } /** * EducationUserApi - axios parameter creator */ export declare const EducationUserApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Add new education user * @param {EducationUser} educationUser New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEducationUser: (educationUser: EducationUser, options?: RawAxiosRequestConfig) => Promise; /** * Deletes an education user by their internal ID. **To delete by external ID:** If you only have an external ID, you must first retrieve the user\'s internal ID: 1. Call `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` 2. Extract the `id` from the response 3. Use that `id` in this DELETE endpoint See the [ListEducationUsers](#/educationUser/ListEducationUsers) operation for query details. * @summary Delete educationUser * @param {string} userId key: internal user id (UUID format) or username of user. **Note:** If you only have an external ID, first query the user with `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` to retrieve the internal ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEducationUser: (userId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get properties of educationUser * @param {string} userId key: id or username of user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEducationUser: (userId: string, $expand?: Set, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves a collection of education users with optional filtering, ordering, and expansion. **Filtering by external ID:** Use `$filter` to query users by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get entities from education users * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {Set} [$orderby] Order items by property values * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEducationUsers: ($filter?: string, $orderby?: Set, $expand?: Set, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update properties of educationUser * @param {string} userId key: id or username of user * @param {EducationUser} educationUser New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEducationUser: (userId: string, educationUser: EducationUser, options?: RawAxiosRequestConfig) => Promise; }; /** * EducationUserApi - functional programming interface */ export declare const EducationUserApiFp: (configuration?: Configuration) => { /** * * @summary Add new education user * @param {EducationUser} educationUser New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEducationUser(educationUser: EducationUser, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes an education user by their internal ID. **To delete by external ID:** If you only have an external ID, you must first retrieve the user\'s internal ID: 1. Call `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` 2. Extract the `id` from the response 3. Use that `id` in this DELETE endpoint See the [ListEducationUsers](#/educationUser/ListEducationUsers) operation for query details. * @summary Delete educationUser * @param {string} userId key: internal user id (UUID format) or username of user. **Note:** If you only have an external ID, first query the user with `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` to retrieve the internal ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEducationUser(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get properties of educationUser * @param {string} userId key: id or username of user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEducationUser(userId: string, $expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves a collection of education users with optional filtering, ordering, and expansion. **Filtering by external ID:** Use `$filter` to query users by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get entities from education users * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {Set} [$orderby] Order items by property values * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEducationUsers($filter?: string, $orderby?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update properties of educationUser * @param {string} userId key: id or username of user * @param {EducationUser} educationUser New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEducationUser(userId: string, educationUser: EducationUser, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EducationUserApi - factory interface */ export declare const EducationUserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Add new education user * @param {EducationUser} educationUser New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEducationUser(educationUser: EducationUser, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes an education user by their internal ID. **To delete by external ID:** If you only have an external ID, you must first retrieve the user\'s internal ID: 1. Call `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` 2. Extract the `id` from the response 3. Use that `id` in this DELETE endpoint See the [ListEducationUsers](#/educationUser/ListEducationUsers) operation for query details. * @summary Delete educationUser * @param {string} userId key: internal user id (UUID format) or username of user. **Note:** If you only have an external ID, first query the user with `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` to retrieve the internal ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEducationUser(userId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get properties of educationUser * @param {string} userId key: id or username of user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEducationUser(userId: string, $expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves a collection of education users with optional filtering, ordering, and expansion. **Filtering by external ID:** Use `$filter` to query users by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get entities from education users * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {Set} [$orderby] Order items by property values * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEducationUsers($filter?: string, $orderby?: Set, $expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update properties of educationUser * @param {string} userId key: id or username of user * @param {EducationUser} educationUser New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEducationUser(userId: string, educationUser: EducationUser, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * EducationUserApi - object-oriented interface */ export declare class EducationUserApi extends BaseAPI { /** * * @summary Add new education user * @param {EducationUser} educationUser New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEducationUser(educationUser: EducationUser, options?: RawAxiosRequestConfig): Promise>; /** * Deletes an education user by their internal ID. **To delete by external ID:** If you only have an external ID, you must first retrieve the user\'s internal ID: 1. Call `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` 2. Extract the `id` from the response 3. Use that `id` in this DELETE endpoint See the [ListEducationUsers](#/educationUser/ListEducationUsers) operation for query details. * @summary Delete educationUser * @param {string} userId key: internal user id (UUID format) or username of user. **Note:** If you only have an external ID, first query the user with `GET /graph/v1.0/education/users?$filter=externalId eq \'{value}\'` to retrieve the internal ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEducationUser(userId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get properties of educationUser * @param {string} userId key: id or username of user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEducationUser(userId: string, $expand?: Set, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves a collection of education users with optional filtering, ordering, and expansion. **Filtering by external ID:** Use `$filter` to query users by their external identifier, for example: `$filter=externalId eq \'EX12345\'` * @summary Get entities from education users * @param {string} [$filter] Filter items by property values. Supports a subset of OData filter expressions. **Supported filters:** - By external ID: `externalId eq \'ext_12345\'` * @param {Set} [$orderby] Order items by property values * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEducationUsers($filter?: string, $orderby?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update properties of educationUser * @param {string} userId key: id or username of user * @param {EducationUser} educationUser New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEducationUser(userId: string, educationUser: EducationUser, options?: RawAxiosRequestConfig): Promise>; } export declare const GetEducationUserExpandEnum: { readonly MemberOf: "memberOf"; }; export type GetEducationUserExpandEnum = typeof GetEducationUserExpandEnum[keyof typeof GetEducationUserExpandEnum]; export declare const ListEducationUsersOrderbyEnum: { readonly DisplayName: "displayName"; readonly DisplayNameDesc: "displayName desc"; readonly Mail: "mail"; readonly MailDesc: "mail desc"; readonly OnPremisesSamAccountName: "onPremisesSamAccountName"; readonly OnPremisesSamAccountNameDesc: "onPremisesSamAccountName desc"; }; export type ListEducationUsersOrderbyEnum = typeof ListEducationUsersOrderbyEnum[keyof typeof ListEducationUsersOrderbyEnum]; export declare const ListEducationUsersExpandEnum: { readonly MemberOf: "memberOf"; }; export type ListEducationUsersExpandEnum = typeof ListEducationUsersExpandEnum[keyof typeof ListEducationUsersExpandEnum]; /** * GroupApi - axios parameter creator */ export declare const GroupApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Add a member to a group * @param {string} groupId key: id of group * @param {MemberReference} memberReference Object to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMember: (groupId: string, memberReference: MemberReference, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete entity from groups * @param {string} groupId key: id of group * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGroup: (groupId: string, ifMatch?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete member from a group * @param {string} groupId key: id of group * @param {string} directoryObjectId key: id of group member to remove * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMember: (groupId: string, directoryObjectId: string, ifMatch?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get entity from groups by key * @param {string} groupId key: id or name of group * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroup: (groupId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get a list of the group\'s direct members * @param {string} groupId key: id or name of group * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMembers: (groupId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update entity in groups * @param {string} groupId key: id of group * @param {Group} group New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup: (groupId: string, group: Group, options?: RawAxiosRequestConfig) => Promise; }; /** * GroupApi - functional programming interface */ export declare const GroupApiFp: (configuration?: Configuration) => { /** * * @summary Add a member to a group * @param {string} groupId key: id of group * @param {MemberReference} memberReference Object to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMember(groupId: string, memberReference: MemberReference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete entity from groups * @param {string} groupId key: id of group * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGroup(groupId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete member from a group * @param {string} groupId key: id of group * @param {string} directoryObjectId key: id of group member to remove * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMember(groupId: string, directoryObjectId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get entity from groups by key * @param {string} groupId key: id or name of group * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroup(groupId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get a list of the group\'s direct members * @param {string} groupId key: id or name of group * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMembers(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update entity in groups * @param {string} groupId key: id of group * @param {Group} group New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup(groupId: string, group: Group, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * GroupApi - factory interface */ export declare const GroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Add a member to a group * @param {string} groupId key: id of group * @param {MemberReference} memberReference Object to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMember(groupId: string, memberReference: MemberReference, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete entity from groups * @param {string} groupId key: id of group * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGroup(groupId: string, ifMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete member from a group * @param {string} groupId key: id of group * @param {string} directoryObjectId key: id of group member to remove * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMember(groupId: string, directoryObjectId: string, ifMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get entity from groups by key * @param {string} groupId key: id or name of group * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroup(groupId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get a list of the group\'s direct members * @param {string} groupId key: id or name of group * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMembers(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update entity in groups * @param {string} groupId key: id of group * @param {Group} group New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup(groupId: string, group: Group, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * GroupApi - object-oriented interface */ export declare class GroupApi extends BaseAPI { /** * * @summary Add a member to a group * @param {string} groupId key: id of group * @param {MemberReference} memberReference Object to be added as member * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMember(groupId: string, memberReference: MemberReference, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete entity from groups * @param {string} groupId key: id of group * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGroup(groupId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete member from a group * @param {string} groupId key: id of group * @param {string} directoryObjectId key: id of group member to remove * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMember(groupId: string, directoryObjectId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get entity from groups by key * @param {string} groupId key: id or name of group * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroup(groupId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get a list of the group\'s direct members * @param {string} groupId key: id or name of group * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMembers(groupId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update entity in groups * @param {string} groupId key: id of group * @param {Group} group New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGroup(groupId: string, group: Group, options?: RawAxiosRequestConfig): Promise>; } export declare const GetGroupSelectEnum: { readonly Id: "id"; readonly Description: "description"; readonly DisplayName: "displayName"; readonly Members: "members"; }; export type GetGroupSelectEnum = typeof GetGroupSelectEnum[keyof typeof GetGroupSelectEnum]; export declare const GetGroupExpandEnum: { readonly Members: "members"; }; export type GetGroupExpandEnum = typeof GetGroupExpandEnum[keyof typeof GetGroupExpandEnum]; /** * GroupsApi - axios parameter creator */ export declare const GroupsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Add new entity to groups * @param {Group} group New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGroup: (group: Group, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get entities from groups * @param {string} [$search] Search items by search phrases * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGroups: ($search?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) => Promise; }; /** * GroupsApi - functional programming interface */ export declare const GroupsApiFp: (configuration?: Configuration) => { /** * * @summary Add new entity to groups * @param {Group} group New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGroup(group: Group, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get entities from groups * @param {string} [$search] Search items by search phrases * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGroups($search?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * GroupsApi - factory interface */ export declare const GroupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Add new entity to groups * @param {Group} group New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGroup(group: Group, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get entities from groups * @param {string} [$search] Search items by search phrases * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGroups($search?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * GroupsApi - object-oriented interface */ export declare class GroupsApi extends BaseAPI { /** * * @summary Add new entity to groups * @param {Group} group New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGroup(group: Group, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get entities from groups * @param {string} [$search] Search items by search phrases * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGroups($search?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise>; } export declare const ListGroupsOrderbyEnum: { readonly DisplayName: "displayName"; readonly DisplayNameDesc: "displayName desc"; }; export type ListGroupsOrderbyEnum = typeof ListGroupsOrderbyEnum[keyof typeof ListGroupsOrderbyEnum]; export declare const ListGroupsSelectEnum: { readonly Id: "id"; readonly Description: "description"; readonly DisplayName: "displayName"; readonly Mail: "mail"; readonly Members: "members"; }; export type ListGroupsSelectEnum = typeof ListGroupsSelectEnum[keyof typeof ListGroupsSelectEnum]; export declare const ListGroupsExpandEnum: { readonly Members: "members"; }; export type ListGroupsExpandEnum = typeof ListGroupsExpandEnum[keyof typeof ListGroupsExpandEnum]; /** * InvitationsApi - axios parameter creator */ export declare const InvitationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create a new invitation * @param {Invitation} [invitation] New invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInvitation: (invitation?: Invitation, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get an invitation by key * @param {string} invitationId key: id of invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInvitation: (invitationId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get a list of invitations * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvitations: (options?: RawAxiosRequestConfig) => Promise; }; /** * InvitationsApi - functional programming interface */ export declare const InvitationsApiFp: (configuration?: Configuration) => { /** * * @summary Create a new invitation * @param {Invitation} [invitation] New invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInvitation(invitation?: Invitation, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get an invitation by key * @param {string} invitationId key: id of invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInvitation(invitationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get a list of invitations * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvitations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InvitationsApi - factory interface */ export declare const InvitationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create a new invitation * @param {Invitation} [invitation] New invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInvitation(invitation?: Invitation, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get an invitation by key * @param {string} invitationId key: id of invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInvitation(invitationId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get a list of invitations * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvitations(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * InvitationsApi - object-oriented interface */ export declare class InvitationsApi extends BaseAPI { /** * * @summary Create a new invitation * @param {Invitation} [invitation] New invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInvitation(invitation?: Invitation, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get an invitation by key * @param {string} invitationId key: id of invitation * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInvitation(invitationId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get a list of invitations * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvitations(options?: RawAxiosRequestConfig): Promise>; } /** * MeChangepasswordApi - axios parameter creator */ export declare const MeChangepasswordApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Change your own password * @param {PasswordChange} passwordChange Password change request * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeOwnPassword: (passwordChange: PasswordChange, options?: RawAxiosRequestConfig) => Promise; }; /** * MeChangepasswordApi - functional programming interface */ export declare const MeChangepasswordApiFp: (configuration?: Configuration) => { /** * * @summary Change your own password * @param {PasswordChange} passwordChange Password change request * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeOwnPassword(passwordChange: PasswordChange, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MeChangepasswordApi - factory interface */ export declare const MeChangepasswordApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Change your own password * @param {PasswordChange} passwordChange Password change request * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeOwnPassword(passwordChange: PasswordChange, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MeChangepasswordApi - object-oriented interface */ export declare class MeChangepasswordApi extends BaseAPI { /** * * @summary Change your own password * @param {PasswordChange} passwordChange Password change request * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeOwnPassword(passwordChange: PasswordChange, options?: RawAxiosRequestConfig): Promise>; } /** * MeDriveApi - axios parameter creator */ export declare const MeDriveApiAxiosParamCreator: (configuration?: Configuration) => { /** * Follow a DriveItem. * @summary Follow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ followDriveItem: (itemId: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get personal space for user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHome: (options?: RawAxiosRequestConfig) => Promise; /** * The `driveItems` returned from the `sharedByMe` method always include the `permissions` relation that indicates they are shared items. * @summary Get a list of driveItem objects shared by the current user. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedByMe: ($expand?: Set, options?: RawAxiosRequestConfig) => Promise; /** * The `driveItems` returned from the `sharedWithMe` method always include the `remoteItem` facet that indicates they are items from a different drive. * @summary Get a list of driveItem objects shared with the owner of a drive. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedWithMe: ($expand?: Set, options?: RawAxiosRequestConfig) => Promise; /** * Unfollow a DriveItem. * @summary Unfollow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ unfollowDriveItem: (itemId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * MeDriveApi - functional programming interface */ export declare const MeDriveApiFp: (configuration?: Configuration) => { /** * Follow a DriveItem. * @summary Follow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ followDriveItem(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get personal space for user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHome(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The `driveItems` returned from the `sharedByMe` method always include the `permissions` relation that indicates they are shared items. * @summary Get a list of driveItem objects shared by the current user. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedByMe($expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The `driveItems` returned from the `sharedWithMe` method always include the `remoteItem` facet that indicates they are items from a different drive. * @summary Get a list of driveItem objects shared with the owner of a drive. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedWithMe($expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unfollow a DriveItem. * @summary Unfollow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ unfollowDriveItem(itemId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MeDriveApi - factory interface */ export declare const MeDriveApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Follow a DriveItem. * @summary Follow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ followDriveItem(itemId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get personal space for user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHome(options?: RawAxiosRequestConfig): AxiosPromise; /** * The `driveItems` returned from the `sharedByMe` method always include the `permissions` relation that indicates they are shared items. * @summary Get a list of driveItem objects shared by the current user. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedByMe($expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * The `driveItems` returned from the `sharedWithMe` method always include the `remoteItem` facet that indicates they are items from a different drive. * @summary Get a list of driveItem objects shared with the owner of a drive. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedWithMe($expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * Unfollow a DriveItem. * @summary Unfollow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ unfollowDriveItem(itemId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MeDriveApi - object-oriented interface */ export declare class MeDriveApi extends BaseAPI { /** * Follow a DriveItem. * @summary Follow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ followDriveItem(itemId: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get personal space for user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getHome(options?: RawAxiosRequestConfig): Promise>; /** * The `driveItems` returned from the `sharedByMe` method always include the `permissions` relation that indicates they are shared items. * @summary Get a list of driveItem objects shared by the current user. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedByMe($expand?: Set, options?: RawAxiosRequestConfig): Promise>; /** * The `driveItems` returned from the `sharedWithMe` method always include the `remoteItem` facet that indicates they are items from a different drive. * @summary Get a list of driveItem objects shared with the owner of a drive. * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSharedWithMe($expand?: Set, options?: RawAxiosRequestConfig): Promise>; /** * Unfollow a DriveItem. * @summary Unfollow a DriveItem * @param {string} itemId key: id of item * @param {*} [options] Override http request option. * @throws {RequiredError} */ unfollowDriveItem(itemId: string, options?: RawAxiosRequestConfig): Promise>; } export declare const ListSharedByMeExpandEnum: { readonly Thumbnails: "thumbnails"; }; export type ListSharedByMeExpandEnum = typeof ListSharedByMeExpandEnum[keyof typeof ListSharedByMeExpandEnum]; export declare const ListSharedWithMeExpandEnum: { readonly Thumbnails: "thumbnails"; }; export type ListSharedWithMeExpandEnum = typeof ListSharedWithMeExpandEnum[keyof typeof ListSharedWithMeExpandEnum]; /** * MeDriveRootApi - axios parameter creator */ export declare const MeDriveRootApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get root from personal space * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetRoot: ($select?: Set, options?: RawAxiosRequestConfig) => Promise; }; /** * MeDriveRootApi - functional programming interface */ export declare const MeDriveRootApiFp: (configuration?: Configuration) => { /** * * @summary Get root from personal space * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetRoot($select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MeDriveRootApi - factory interface */ export declare const MeDriveRootApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get root from personal space * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetRoot($select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MeDriveRootApi - object-oriented interface */ export declare class MeDriveRootApi extends BaseAPI { /** * * @summary Get root from personal space * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetRoot($select?: Set, options?: RawAxiosRequestConfig): Promise>; } export declare const HomeGetRootSelectEnum: { readonly MicrosoftGraphDownloadUrl: "@microsoft.graph.downloadUrl"; readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; }; export type HomeGetRootSelectEnum = typeof HomeGetRootSelectEnum[keyof typeof HomeGetRootSelectEnum]; /** * MeDriveRootChildrenApi - axios parameter creator */ export declare const MeDriveRootChildrenApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get children from drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetChildren: ($select?: Set, options?: RawAxiosRequestConfig) => Promise; }; /** * MeDriveRootChildrenApi - functional programming interface */ export declare const MeDriveRootChildrenApiFp: (configuration?: Configuration) => { /** * * @summary Get children from drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetChildren($select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MeDriveRootChildrenApi - factory interface */ export declare const MeDriveRootChildrenApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get children from drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetChildren($select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MeDriveRootChildrenApi - object-oriented interface */ export declare class MeDriveRootChildrenApi extends BaseAPI { /** * * @summary Get children from drive * @param {Set} [$select] Select additional properties to be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ homeGetChildren($select?: Set, options?: RawAxiosRequestConfig): Promise>; } export declare const HomeGetChildrenSelectEnum: { readonly MicrosoftGraphDownloadUrl: "@microsoft.graph.downloadUrl"; readonly LibreGraphPermissionsActionsAllowedValues: "@libre.graph.permissions.actions.allowedValues"; }; export type HomeGetChildrenSelectEnum = typeof HomeGetChildrenSelectEnum[keyof typeof HomeGetChildrenSelectEnum]; /** * MeDrivesApi - axios parameter creator */ export declare const MeDrivesApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get all drives where the current user is a regular member of * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrives: ($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrivesBeta: ($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig) => Promise; }; /** * MeDrivesApi - functional programming interface */ export declare const MeDrivesApiFp: (configuration?: Configuration) => { /** * * @summary Get all drives where the current user is a regular member of * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrivesBeta($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MeDrivesApi - factory interface */ export declare const MeDrivesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get all drives where the current user is a regular member of * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrivesBeta($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MeDrivesApi - object-oriented interface */ export declare class MeDrivesApi extends BaseAPI { /** * * @summary Get all drives where the current user is a regular member of * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrives($orderby?: string, $filter?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Alias for \'/v1.0/drives\', the difference is that grantedtoV2 is used and roles contain unified roles instead of cs3 roles * @param {string} [$orderby] The $orderby system query option allows clients to request resources in either ascending order using asc or descending order using desc. * @param {string} [$filter] Filter items by property values * @param {string} [$expand] Expand related entities * @param {Set} [$select] Select properties to be returned. By default all properties are returned. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyDrivesBeta($orderby?: string, $filter?: string, $expand?: string, $select?: Set, options?: RawAxiosRequestConfig): Promise>; } export declare const ListMyDrivesBetaSelectEnum: { readonly LibreGraphHasTrashedItems: "@libre.graph.hasTrashedItems"; }; export type ListMyDrivesBetaSelectEnum = typeof ListMyDrivesBetaSelectEnum[keyof typeof ListMyDrivesBetaSelectEnum]; /** * MePhotoApi - axios parameter creator */ export declare const MePhotoApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Delete the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOwnUserPhoto: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUserPhoto: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPatch: (body?: File, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPut: (body?: File, options?: RawAxiosRequestConfig) => Promise; }; /** * MePhotoApi - functional programming interface */ export declare const MePhotoApiFp: (configuration?: Configuration) => { /** * * @summary Delete the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOwnUserPhoto(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUserPhoto(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPatch(body?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPut(body?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MePhotoApi - factory interface */ export declare const MePhotoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Delete the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOwnUserPhoto(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUserPhoto(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPatch(body?: File, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPut(body?: File, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MePhotoApi - object-oriented interface */ export declare class MePhotoApi extends BaseAPI { /** * * @summary Delete the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOwnUserPhoto(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get the current user\'s profile photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUserPhoto(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPatch(body?: File, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update the current user\'s profile photo * @param {File} [body] New user photo * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUserPhotoPut(body?: File, options?: RawAxiosRequestConfig): Promise>; } /** * MeUserApi - axios parameter creator */ export declare const MeUserApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get current user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUser: ($expand?: Set, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update the current user * @param {UserUpdate} [userUpdate] New user values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUser: (userUpdate?: UserUpdate, options?: RawAxiosRequestConfig) => Promise; }; /** * MeUserApi - functional programming interface */ export declare const MeUserApiFp: (configuration?: Configuration) => { /** * * @summary Get current user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUser($expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update the current user * @param {UserUpdate} [userUpdate] New user values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUser(userUpdate?: UserUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MeUserApi - factory interface */ export declare const MeUserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get current user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUser($expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update the current user * @param {UserUpdate} [userUpdate] New user values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUser(userUpdate?: UserUpdate, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MeUserApi - object-oriented interface */ export declare class MeUserApi extends BaseAPI { /** * * @summary Get current user * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOwnUser($expand?: Set, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update the current user * @param {UserUpdate} [userUpdate] New user values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateOwnUser(userUpdate?: UserUpdate, options?: RawAxiosRequestConfig): Promise>; } export declare const GetOwnUserExpandEnum: { readonly MemberOf: "memberOf"; }; export type GetOwnUserExpandEnum = typeof GetOwnUserExpandEnum[keyof typeof GetOwnUserExpandEnum]; /** * RoleManagementApi - axios parameter creator */ export declare const RoleManagementApiAxiosParamCreator: (configuration?: Configuration) => { /** * Read the properties and relationships of a `unifiedRoleDefinition` object. * @summary Get unifiedRoleDefinition * @param {string} roleId key: id of roleDefinition * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionRoleDefinition: (roleId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a list of `unifiedRoleDefinition` objects for the permissions provider. This list determines the roles that can be selected when creating sharing invites. * @summary List roleDefinitions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionRoleDefinitions: (options?: RawAxiosRequestConfig) => Promise; }; /** * RoleManagementApi - functional programming interface */ export declare const RoleManagementApiFp: (configuration?: Configuration) => { /** * Read the properties and relationships of a `unifiedRoleDefinition` object. * @summary Get unifiedRoleDefinition * @param {string} roleId key: id of roleDefinition * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionRoleDefinition(roleId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a list of `unifiedRoleDefinition` objects for the permissions provider. This list determines the roles that can be selected when creating sharing invites. * @summary List roleDefinitions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionRoleDefinitions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * RoleManagementApi - factory interface */ export declare const RoleManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Read the properties and relationships of a `unifiedRoleDefinition` object. * @summary Get unifiedRoleDefinition * @param {string} roleId key: id of roleDefinition * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionRoleDefinition(roleId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get a list of `unifiedRoleDefinition` objects for the permissions provider. This list determines the roles that can be selected when creating sharing invites. * @summary List roleDefinitions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionRoleDefinitions(options?: RawAxiosRequestConfig): AxiosPromise>; }; /** * RoleManagementApi - object-oriented interface */ export declare class RoleManagementApi extends BaseAPI { /** * Read the properties and relationships of a `unifiedRoleDefinition` object. * @summary Get unifiedRoleDefinition * @param {string} roleId key: id of roleDefinition * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPermissionRoleDefinition(roleId: string, options?: RawAxiosRequestConfig): Promise>; /** * Get a list of `unifiedRoleDefinition` objects for the permissions provider. This list determines the roles that can be selected when creating sharing invites. * @summary List roleDefinitions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissionRoleDefinitions(options?: RawAxiosRequestConfig): Promise>; } /** * TagsApi - axios parameter creator */ export declare const TagsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Assign tags to a resource * @param {TagAssignment} [tagAssignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignTags: (tagAssignment?: TagAssignment, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get all known tags * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTags: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Unassign tags from a resource * @param {TagUnassignment} [tagUnassignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unassignTags: (tagUnassignment?: TagUnassignment, options?: RawAxiosRequestConfig) => Promise; }; /** * TagsApi - functional programming interface */ export declare const TagsApiFp: (configuration?: Configuration) => { /** * * @summary Assign tags to a resource * @param {TagAssignment} [tagAssignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignTags(tagAssignment?: TagAssignment, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get all known tags * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTags(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Unassign tags from a resource * @param {TagUnassignment} [tagUnassignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unassignTags(tagUnassignment?: TagUnassignment, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TagsApi - factory interface */ export declare const TagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Assign tags to a resource * @param {TagAssignment} [tagAssignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignTags(tagAssignment?: TagAssignment, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get all known tags * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTags(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Unassign tags from a resource * @param {TagUnassignment} [tagUnassignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unassignTags(tagUnassignment?: TagUnassignment, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TagsApi - object-oriented interface */ export declare class TagsApi extends BaseAPI { /** * * @summary Assign tags to a resource * @param {TagAssignment} [tagAssignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignTags(tagAssignment?: TagAssignment, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get all known tags * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTags(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Unassign tags from a resource * @param {TagUnassignment} [tagUnassignment] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unassignTags(tagUnassignment?: TagUnassignment, options?: RawAxiosRequestConfig): Promise>; } /** * UserApi - axios parameter creator */ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Delete entity from users * @param {string} userId key: id or name of user * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser: (userId: string, ifMatch?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @summary export personal data of a user * @param {string} userId key: id or name of user * @param {ExportPersonalDataRequest} [exportPersonalDataRequest] destination the file should be created at * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportPersonalData: (userId: string, exportPersonalDataRequest?: ExportPersonalDataRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get entity from users by key * @param {string} userId key: id or name of user * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser: (userId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update entity in users * @param {string} userId key: id of user * @param {UserUpdate} userUpdate New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser: (userId: string, userUpdate: UserUpdate, options?: RawAxiosRequestConfig) => Promise; }; /** * UserApi - functional programming interface */ export declare const UserApiFp: (configuration?: Configuration) => { /** * * @summary Delete entity from users * @param {string} userId key: id or name of user * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser(userId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary export personal data of a user * @param {string} userId key: id or name of user * @param {ExportPersonalDataRequest} [exportPersonalDataRequest] destination the file should be created at * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportPersonalData(userId: string, exportPersonalDataRequest?: ExportPersonalDataRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get entity from users by key * @param {string} userId key: id or name of user * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(userId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update entity in users * @param {string} userId key: id of user * @param {UserUpdate} userUpdate New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(userId: string, userUpdate: UserUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserApi - factory interface */ export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Delete entity from users * @param {string} userId key: id or name of user * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser(userId: string, ifMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary export personal data of a user * @param {string} userId key: id or name of user * @param {ExportPersonalDataRequest} [exportPersonalDataRequest] destination the file should be created at * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportPersonalData(userId: string, exportPersonalDataRequest?: ExportPersonalDataRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get entity from users by key * @param {string} userId key: id or name of user * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(userId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update entity in users * @param {string} userId key: id of user * @param {UserUpdate} userUpdate New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(userId: string, userUpdate: UserUpdate, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UserApi - object-oriented interface */ export declare class UserApi extends BaseAPI { /** * * @summary Delete entity from users * @param {string} userId key: id or name of user * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser(userId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise>; /** * * @summary export personal data of a user * @param {string} userId key: id or name of user * @param {ExportPersonalDataRequest} [exportPersonalDataRequest] destination the file should be created at * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportPersonalData(userId: string, exportPersonalDataRequest?: ExportPersonalDataRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get entity from users by key * @param {string} userId key: id or name of user * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(userId: string, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update entity in users * @param {string} userId key: id of user * @param {UserUpdate} userUpdate New property values * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(userId: string, userUpdate: UserUpdate, options?: RawAxiosRequestConfig): Promise>; } export declare const GetUserSelectEnum: { readonly Id: "id"; readonly DisplayName: "displayName"; readonly Drive: "drive"; readonly Drives: "drives"; readonly Mail: "mail"; readonly MemberOf: "memberOf"; readonly OnPremisesSamAccountName: "onPremisesSamAccountName"; readonly Surname: "surname"; }; export type GetUserSelectEnum = typeof GetUserSelectEnum[keyof typeof GetUserSelectEnum]; export declare const GetUserExpandEnum: { readonly Drive: "drive"; readonly Drives: "drives"; readonly MemberOf: "memberOf"; readonly AppRoleAssignments: "appRoleAssignments"; }; export type GetUserExpandEnum = typeof GetUserExpandEnum[keyof typeof GetUserExpandEnum]; /** * UserAppRoleAssignmentApi - axios parameter creator */ export declare const UserAppRoleAssignmentApiAxiosParamCreator: (configuration?: Configuration) => { /** * 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. * @summary Grant an appRoleAssignment to a user * @param {string} userId key: id of user * @param {AppRoleAssignment} appRoleAssignment New app role assignment value * @param {*} [options] Override http request option. * @throws {RequiredError} */ userCreateAppRoleAssignments: (userId: string, appRoleAssignment: AppRoleAssignment, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Delete the appRoleAssignment from a user * @param {string} userId key: id of user * @param {string} appRoleAssignmentId key: id of appRoleAssignment. This is the concatenated {user-id}:{appRole-id} separated by a colon. * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ userDeleteAppRoleAssignments: (userId: string, appRoleAssignmentId: string, ifMatch?: string, options?: RawAxiosRequestConfig) => Promise; /** * Represents the global roles a user has been granted for an application. * @summary Get appRoleAssignments from a user * @param {string} userId key: id of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ userListAppRoleAssignments: (userId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * UserAppRoleAssignmentApi - functional programming interface */ export declare const UserAppRoleAssignmentApiFp: (configuration?: Configuration) => { /** * 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. * @summary Grant an appRoleAssignment to a user * @param {string} userId key: id of user * @param {AppRoleAssignment} appRoleAssignment New app role assignment value * @param {*} [options] Override http request option. * @throws {RequiredError} */ userCreateAppRoleAssignments(userId: string, appRoleAssignment: AppRoleAssignment, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Delete the appRoleAssignment from a user * @param {string} userId key: id of user * @param {string} appRoleAssignmentId key: id of appRoleAssignment. This is the concatenated {user-id}:{appRole-id} separated by a colon. * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ userDeleteAppRoleAssignments(userId: string, appRoleAssignmentId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Represents the global roles a user has been granted for an application. * @summary Get appRoleAssignments from a user * @param {string} userId key: id of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ userListAppRoleAssignments(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserAppRoleAssignmentApi - factory interface */ export declare const UserAppRoleAssignmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 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. * @summary Grant an appRoleAssignment to a user * @param {string} userId key: id of user * @param {AppRoleAssignment} appRoleAssignment New app role assignment value * @param {*} [options] Override http request option. * @throws {RequiredError} */ userCreateAppRoleAssignments(userId: string, appRoleAssignment: AppRoleAssignment, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Delete the appRoleAssignment from a user * @param {string} userId key: id of user * @param {string} appRoleAssignmentId key: id of appRoleAssignment. This is the concatenated {user-id}:{appRole-id} separated by a colon. * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ userDeleteAppRoleAssignments(userId: string, appRoleAssignmentId: string, ifMatch?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Represents the global roles a user has been granted for an application. * @summary Get appRoleAssignments from a user * @param {string} userId key: id of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ userListAppRoleAssignments(userId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UserAppRoleAssignmentApi - object-oriented interface */ export declare class UserAppRoleAssignmentApi extends BaseAPI { /** * 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. * @summary Grant an appRoleAssignment to a user * @param {string} userId key: id of user * @param {AppRoleAssignment} appRoleAssignment New app role assignment value * @param {*} [options] Override http request option. * @throws {RequiredError} */ userCreateAppRoleAssignments(userId: string, appRoleAssignment: AppRoleAssignment, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Delete the appRoleAssignment from a user * @param {string} userId key: id of user * @param {string} appRoleAssignmentId key: id of appRoleAssignment. This is the concatenated {user-id}:{appRole-id} separated by a colon. * @param {string} [ifMatch] ETag * @param {*} [options] Override http request option. * @throws {RequiredError} */ userDeleteAppRoleAssignments(userId: string, appRoleAssignmentId: string, ifMatch?: string, options?: RawAxiosRequestConfig): Promise>; /** * Represents the global roles a user has been granted for an application. * @summary Get appRoleAssignments from a user * @param {string} userId key: id of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ userListAppRoleAssignments(userId: string, options?: RawAxiosRequestConfig): Promise>; } /** * UserPhotoApi - axios parameter creator */ export declare const UserPhotoApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get the photo of a user * @param {string} userId key: id or name of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPhoto: (userId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * UserPhotoApi - functional programming interface */ export declare const UserPhotoApiFp: (configuration?: Configuration) => { /** * * @summary Get the photo of a user * @param {string} userId key: id or name of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPhoto(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserPhotoApi - factory interface */ export declare const UserPhotoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get the photo of a user * @param {string} userId key: id or name of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPhoto(userId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UserPhotoApi - object-oriented interface */ export declare class UserPhotoApi extends BaseAPI { /** * * @summary Get the photo of a user * @param {string} userId key: id or name of user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPhoto(userId: string, options?: RawAxiosRequestConfig): Promise>; } /** * UserTeamworkApi - axios parameter creator */ export declare const UserTeamworkApiAxiosParamCreator: (configuration?: Configuration) => { /** * Sends a notification about an activity to a user. The sender is the caller, the recipient is the user in the path, `activityType` says what happened and `topic` says what it happened on. * @summary Send an activity notification to a user * @param {string} userId key: id or name of user * @param {ActivityNotification} activityNotification The activity the user is notified about. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendActivityNotification: (userId: string, activityNotification: ActivityNotification, options?: RawAxiosRequestConfig) => Promise; }; /** * UserTeamworkApi - functional programming interface */ export declare const UserTeamworkApiFp: (configuration?: Configuration) => { /** * Sends a notification about an activity to a user. The sender is the caller, the recipient is the user in the path, `activityType` says what happened and `topic` says what it happened on. * @summary Send an activity notification to a user * @param {string} userId key: id or name of user * @param {ActivityNotification} activityNotification The activity the user is notified about. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendActivityNotification(userId: string, activityNotification: ActivityNotification, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserTeamworkApi - factory interface */ export declare const UserTeamworkApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Sends a notification about an activity to a user. The sender is the caller, the recipient is the user in the path, `activityType` says what happened and `topic` says what it happened on. * @summary Send an activity notification to a user * @param {string} userId key: id or name of user * @param {ActivityNotification} activityNotification The activity the user is notified about. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendActivityNotification(userId: string, activityNotification: ActivityNotification, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UserTeamworkApi - object-oriented interface */ export declare class UserTeamworkApi extends BaseAPI { /** * Sends a notification about an activity to a user. The sender is the caller, the recipient is the user in the path, `activityType` says what happened and `topic` says what it happened on. * @summary Send an activity notification to a user * @param {string} userId key: id or name of user * @param {ActivityNotification} activityNotification The activity the user is notified about. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendActivityNotification(userId: string, activityNotification: ActivityNotification, options?: RawAxiosRequestConfig): Promise>; } /** * UsersApi - axios parameter creator */ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Add new entity to users * @param {User} user New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser: (user: User, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Get entities from users * @param {string} [$search] Search items by search phrases * @param {string} [$filter] Filter users by property values and relationship attributes * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsers: ($search?: string, $filter?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig) => Promise; }; /** * UsersApi - functional programming interface */ export declare const UsersApiFp: (configuration?: Configuration) => { /** * * @summary Add new entity to users * @param {User} user New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(user: User, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get entities from users * @param {string} [$search] Search items by search phrases * @param {string} [$filter] Filter users by property values and relationship attributes * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsers($search?: string, $filter?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersApi - factory interface */ export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Add new entity to users * @param {User} user New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(user: User, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Get entities from users * @param {string} [$search] Search items by search phrases * @param {string} [$filter] Filter users by property values and relationship attributes * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsers($search?: string, $filter?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UsersApi - object-oriented interface */ export declare class UsersApi extends BaseAPI { /** * * @summary Add new entity to users * @param {User} user New entity * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(user: User, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Get entities from users * @param {string} [$search] Search items by search phrases * @param {string} [$filter] Filter users by property values and relationship attributes * @param {Set} [$orderby] Order items by property values * @param {Set} [$select] Select properties to be returned * @param {Set} [$expand] Expand related entities * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsers($search?: string, $filter?: string, $orderby?: Set, $select?: Set, $expand?: Set, options?: RawAxiosRequestConfig): Promise>; } export declare const ListUsersOrderbyEnum: { readonly DisplayName: "displayName"; readonly DisplayNameDesc: "displayName desc"; readonly Mail: "mail"; readonly MailDesc: "mail desc"; readonly OnPremisesSamAccountName: "onPremisesSamAccountName"; readonly OnPremisesSamAccountNameDesc: "onPremisesSamAccountName desc"; }; export type ListUsersOrderbyEnum = typeof ListUsersOrderbyEnum[keyof typeof ListUsersOrderbyEnum]; export declare const ListUsersSelectEnum: { readonly Id: "id"; readonly DisplayName: "displayName"; readonly Mail: "mail"; readonly MemberOf: "memberOf"; readonly OnPremisesSamAccountName: "onPremisesSamAccountName"; readonly Surname: "surname"; }; export type ListUsersSelectEnum = typeof ListUsersSelectEnum[keyof typeof ListUsersSelectEnum]; export declare const ListUsersExpandEnum: { readonly Drive: "drive"; readonly Drives: "drives"; readonly MemberOf: "memberOf"; readonly AppRoleAssignments: "appRoleAssignments"; }; export type ListUsersExpandEnum = typeof ListUsersExpandEnum[keyof typeof ListUsersExpandEnum];