@nuxtus/nuxtus/client/interfaces/nuxtus.ts

Directus/Nuxt boilerplate with Tailwind CSS.

/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */

export interface paths {
	"/assets/{id}": {
		/**
		 * Get an Asset
		 * @description Image typed files can be dynamically resized and transformed to fit any need.
		 */
		get: operations["getAsset"]
	}
	"/auth/login": {
		/**
		 * Retrieve a Temporary Access Token
		 * @description Retrieve a Temporary Access Token
		 */
		post: operations["login"]
	}
	"/auth/refresh": {
		/**
		 * Refresh Token
		 * @description Refresh a Temporary Access Token.
		 */
		post: operations["refresh"]
	}
	"/auth/logout": {
		/**
		 * Log Out
		 * @description Log Out
		 */
		post: operations["logout"]
	}
	"/auth/password/request": {
		/**
		 * Request a Password Reset
		 * @description Request a reset password email to be send.
		 */
		post: operations["passwordRequest"]
	}
	"/auth/password/reset": {
		/**
		 * Reset a Password
		 * @description The request a password reset endpoint sends an email with a link to the admin app which in turn uses this endpoint to allow the user to reset their password.
		 */
		post: operations["passwordReset"]
	}
	"/auth/oauth": {
		/**
		 * List OAuth Providers
		 * @description List configured OAuth providers.
		 */
		get: operations["oauth"]
	}
	"/auth/oauth/{provider}": {
		/**
		 * Authenticated using an OAuth provider
		 * @description Start OAuth flow using the specified provider
		 */
		get: operations["oauthProvider"]
	}
	"/schema/snapshot": {
		/**
		 * Retrieve Schema Snapshot
		 * @description Retrieve the current schema. This endpoint is only available to admin users.
		 */
		get: operations["schemaSnapshot"]
	}
	"/schema/apply": {
		/**
		 * Apply Schema Difference
		 * @description Update the instance's schema by passing the diff previously retrieved via `/schema/diff` endpoint in the JSON request body or a JSON/YAML file. This endpoint is only available to admin users.
		 */
		post: operations["schemaApply"]
	}
	"/schema/diff": {
		/**
		 * Retrieve Schema Difference
		 * @description Compare the current instance's schema against the schema snapshot in JSON request body or a JSON/YAML file and retrieve the difference. This endpoint is only available to admin users.
		 */
		post: operations["schemaDiff"]
	}
	"/server/info": {
		/**
		 * System Info
		 * @description Perform a system status check and return the options.
		 */
		get: operations["serverInfo"]
	}
	"/server/ping": {
		/**
		 * Ping
		 * @description Ping, pong. Ping.. pong.
		 */
		get: operations["ping"]
	}
	"/utils/hash/generate": {
		/**
		 * Hash a string
		 * @description Generate a hash for a given string.
		 */
		post: operations["hash-generate"]
	}
	"/utils/hash/verify": {
		/**
		 * Hash a string
		 * @description Generate a hash for a given string.
		 */
		post: operations["hash-verify"]
	}
	"/utils/sort/{collection}": {
		/**
		 * Sort Items
		 * @description Re-sort items in collection based on start and to value of item
		 */
		post: operations["sort"]
	}
	"/utils/import/{collection}": {
		/**
		 * Import Items
		 * @description Import multiple records from a JSON or CSV file into a collection.
		 */
		post: operations["import"]
	}
	"/utils/export/{collection}": {
		/**
		 * Export Items
		 * @description Export a larger data set to a file in the File Library
		 */
		post: operations["export"]
	}
	"/utils/cache/clear": {
		/**
		 * Clear Cache
		 * @description Resets both the data and schema cache of Directus.
		 */
		post: operations["clear-cache"]
	}
	"/utils/random/string": {
		/**
		 * Get a Random String
		 * @description Returns a random string of given length.
		 */
		get: operations["random"]
	}
	"/folders": {
		/**
		 * List Folders
		 * @description List the folders.
		 */
		get: operations["getFolders"]
		/**
		 * Create a Folder
		 * @description Create a new folder.
		 */
		post: operations["createFolder"]
		/**
		 * Delete Multiple Folders
		 * @description Delete multiple existing folders.
		 */
		delete: operations["deleteFolders"]
		/**
		 * Update Multiple Folders
		 * @description Update multiple folders at the same time.
		 */
		patch: operations["updateFolders"]
	}
	"/folders/{id}": {
		/**
		 * Retrieve a Folder
		 * @description Retrieve a single folder by unique identifier.
		 */
		get: operations["getFolder"]
		/**
		 * Delete a Folder
		 * @description Delete an existing folder
		 */
		delete: operations["deleteFolder"]
		/**
		 * Update a Folder
		 * @description Update an existing folder
		 */
		patch: operations["updateFolder"]
	}
	"/relations": {
		/**
		 * List Relations
		 * @description List the relations.
		 */
		get: operations["getRelations"]
		/**
		 * Create a Relation
		 * @description Create a new relation.
		 */
		post: operations["createRelation"]
	}
	"/relations/{id}": {
		/**
		 * Retrieve a Relation
		 * @description Retrieve a single relation by unique identifier.
		 */
		get: operations["getRelation"]
		/**
		 * Delete a Relation
		 * @description Delete an existing relation.
		 */
		delete: operations["deleteRelation"]
		/**
		 * Update a Relation
		 * @description Update an existing relation
		 */
		patch: operations["updateRelation"]
	}
	"/files": {
		/**
		 * List Files
		 * @description List the files.
		 */
		get: operations["getFiles"]
		/**
		 * Create a File
		 * @description Create a new file
		 */
		post: operations["createFile"]
		/**
		 * Delete Multiple Files
		 * @description Delete multiple existing files.
		 */
		delete: operations["deleteFiles"]
		/**
		 * Update Multiple Files
		 * @description Update multiple files at the same time.
		 */
		patch: operations["updateFiles"]
	}
	"/files/{id}": {
		/**
		 * Retrieve a Files
		 * @description Retrieve a single file by unique identifier.
		 */
		get: operations["getFile"]
		/**
		 * Delete a File
		 * @description Delete an existing file.
		 */
		delete: operations["deleteFile"]
		/**
		 * Update a File
		 * @description Update an existing file, and/or replace it's file contents.
		 */
		patch: operations["updateFile"]
	}
	"/permissions": {
		/**
		 * List Permissions
		 * @description List all permissions.
		 */
		get: operations["getPermissions"]
		/**
		 * Create a Permission
		 * @description Create a new permission.
		 */
		post: operations["createPermission"]
		/**
		 * Delete Multiple Permissions
		 * @description Delete multiple existing permissions.
		 */
		delete: operations["deletePermissions"]
		/**
		 * Update Multiple Permissions
		 * @description Update multiple permissions at the same time.
		 */
		patch: operations["updatePermissions"]
	}
	"/permissions/me": {
		/**
		 * List My Permissions
		 * @description List the permissions that apply to the current user.
		 */
		get: operations["getMyPermissions"]
	}
	"/permissions/{id}": {
		/**
		 * Retrieve a Permission
		 * @description Retrieve a single permissions object by unique identifier.
		 */
		get: operations["getPermission"]
		/**
		 * Delete a Permission
		 * @description Delete an existing permission
		 */
		delete: operations["deletePermission"]
		/**
		 * Update a Permission
		 * @description Update an existing permission
		 */
		patch: operations["updatePermission"]
	}
	"/webhooks": {
		/**
		 * List Webhooks
		 * @description Get all webhooks.
		 */
		get: operations["getWebhooks"]
		/**
		 * Create a Webhook
		 * @description Create a new webhook.
		 */
		post: operations["createWebhook"]
		/**
		 * Delete Multiple Webhooks
		 * @description Delete multiple existing webhooks.
		 */
		delete: operations["deleteWebhooks"]
		/**
		 * Update Multiple Webhooks
		 * @description Update multiple webhooks at the same time.
		 */
		patch: operations["updateWebhooks"]
	}
	"/webhooks/{id}": {
		/**
		 * Retrieve a Webhook
		 * @description Retrieve a single webhook by unique identifier.
		 */
		get: operations["getWebhook"]
		/**
		 * Delete a Webhook
		 * @description Delete an existing webhook
		 */
		delete: operations["deleteWebhook"]
		/**
		 * Update a Webhook
		 * @description Update an existing webhook
		 */
		patch: operations["updateWebhook"]
	}
	"/collections": {
		/**
		 * List Collections
		 * @description Returns a list of the collections available in the project.
		 */
		get: operations["getCollections"]
		/**
		 * Create a Collection
		 * @description Create a new collection in Directus.
		 */
		post: operations["createCollection"]
	}
	"/collections/{id}": {
		/**
		 * Retrieve a Collection
		 * @description Retrieves the details of a single collection.
		 */
		get: operations["getCollection"]
		/**
		 * Delete a Collection
		 * @description Delete an existing collection. Warning: This will delete the whole collection, including the items within. Proceed with caution.
		 */
		delete: operations["deleteCollection"]
		/**
		 * Update a Collection
		 * @description Update an existing collection.
		 */
		patch: operations["updateCollection"]
	}
	"/fields": {
		/**
		 * List All Fields
		 * @description Returns a list of the fields available in the project.
		 */
		get: operations["getFields"]
	}
	"/fields/{collection}": {
		/**
		 * List Fields in Collection
		 * @description Returns a list of the fields available in the given collection.
		 */
		get: operations["getCollectionFields"]
		/**
		 * Create Field in Collection
		 * @description Create a new field in a given collection.
		 */
		post: operations["createField"]
	}
	"/fields/{collection}/{id}": {
		/**
		 * Retrieve a Field
		 * @description Retrieves the details of a single field in a given collection.
		 */
		get: operations["getCollectionField"]
		/**
		 * Delete a Field
		 * @description Delete an existing field.
		 */
		delete: operations["deleteField"]
		/**
		 * Update a Field
		 * @description Update an existing field.
		 */
		patch: operations["updateField"]
	}
	"/roles": {
		/**
		 * List Roles
		 * @description List the roles.
		 */
		get: operations["getRoles"]
		/**
		 * Create a Role
		 * @description Create a new role.
		 */
		post: operations["createRole"]
		/**
		 * Delete Multiple Roles
		 * @description Delete multiple existing roles.
		 */
		delete: operations["deleteRoles"]
		/**
		 * Update Multiple Roles
		 * @description Update multiple roles at the same time.
		 */
		patch: operations["updateRoles"]
	}
	"/roles/{id}": {
		/**
		 * Retrieve a Role
		 * @description Retrieve a single role by unique identifier.
		 */
		get: operations["getRole"]
		/**
		 * Delete a Role
		 * @description Delete an existing role
		 */
		delete: operations["deleteRole"]
		/**
		 * Update a Role
		 * @description Update an existing role
		 */
		patch: operations["updateRole"]
	}
	"/flows": {
		/**
		 * List Flows
		 * @description Get all flows.
		 */
		get: operations["getFlows"]
		/**
		 * Create a Flow
		 * @description Create a new flow.
		 */
		post: operations["createFlow"]
		/**
		 * Delete Multiple Flows
		 * @description Delete multiple existing flows.
		 */
		delete: operations["deleteFlows"]
		/**
		 * Update Multiple Flows
		 * @description Update multiple flows at the same time.
		 */
		patch: operations["updateFlows"]
	}
	"/flows/{id}": {
		/**
		 * Retrieve a Flow
		 * @description Retrieve a single flow by unique identifier.
		 */
		get: operations["getFlow"]
		/**
		 * Delete a Flow
		 * @description Delete an existing flow
		 */
		delete: operations["deleteFlow"]
		/**
		 * Update a Flow
		 * @description Update an existing flow
		 */
		patch: operations["updateFlow"]
	}
	"/operations": {
		/**
		 * List Operations
		 * @description Get all operations.
		 */
		get: operations["getOperations"]
		/**
		 * Create an Operation
		 * @description Create a new operation.
		 */
		post: operations["createOperation"]
		/**
		 * Delete Multiple Operations
		 * @description Delete multiple existing operations.
		 */
		delete: operations["deleteOperations"]
		/**
		 * Update Multiple Operations
		 * @description Update multiple operations at the same time.
		 */
		patch: operations["updateOperations"]
	}
	"/operations/{id}": {
		/**
		 * Retrieve an Operation
		 * @description Retrieve a single operation by unique identifier.
		 */
		get: operations["getOperation"]
		/**
		 * Delete an Operation
		 * @description Delete an existing operation
		 */
		delete: operations["deleteOperation"]
		/**
		 * Update an Operation
		 * @description Update an existing operation
		 */
		patch: operations["updateOperation"]
	}
	"/activity": {
		/**
		 * List Activity Actions
		 * @description Returns a list of activity actions.
		 */
		get: operations["getActivities"]
	}
	"/activity/comment": {
		/**
		 * Create a Comment
		 * @description Creates a new comment.
		 */
		post: operations["createComment"]
	}
	"/activity/{id}": {
		/**
		 * Retrieve an Activity Action
		 * @description Retrieves the details of an existing activity action. Provide the primary key of the activity action and Directus will return the corresponding information.
		 */
		get: operations["getActivity"]
	}
	"/activity/comment/{id}": {
		/**
		 * Delete a Comment
		 * @description Delete an existing comment. Deleted comments can not be retrieved.
		 */
		delete: operations["deleteComment"]
		/**
		 * Update a Comment
		 * @description Update the content of an existing comment.
		 */
		patch: operations["updateComment"]
	}
	"/presets": {
		/**
		 * List Presets
		 * @description List the presets.
		 */
		get: operations["getPresets"]
		/**
		 * Create a Preset
		 * @description Create a new preset.
		 */
		post: operations["createPreset"]
		/**
		 * Delete Multiple Presets
		 * @description Delete multiple existing presets.
		 */
		delete: operations["deletePresets"]
		/**
		 * Update Multiple Presets
		 * @description Update multiple presets at the same time.
		 */
		patch: operations["updatePresets"]
	}
	"/presets/{id}": {
		/**
		 * Retrieve a Preset
		 * @description Retrieve a single preset by unique identifier.
		 */
		get: operations["getPreset"]
		/**
		 * Delete a Preset
		 * @description Delete an existing preset.
		 */
		delete: operations["deletePreset"]
		/**
		 * Update a Preset
		 * @description Update an existing preset.
		 */
		patch: operations["updatePreset"]
	}
	"/versions": {
		/**
		 * List Content Versions
		 * @description Get all Content Versions.
		 */
		get: operations["getContentVersions"]
		/**
		 * Create Multiple Content Versions
		 * @description Create multiple new Content Versions.
		 */
		post: operations["createContentVersion"]
		/**
		 * Delete Multiple Content Versions
		 * @description Delete multiple existing Content Versions.
		 */
		delete: operations["deleteContentVersions"]
		/**
		 * Update Multiple Content Versions
		 * @description Update multiple Content Versions at the same time.
		 */
		patch: operations["updateContentVersions"]
	}
	"/versions/{id}": {
		/**
		 * Retrieve a Content Version
		 * @description Retrieve a single Content Version by unique identifier.
		 */
		get: operations["getContentVersion"]
		/**
		 * Delete a Content Version
		 * @description Delete an existing Content Version.
		 */
		delete: operations["deleteContentVersion"]
		/**
		 * Update a Content Version
		 * @description Update an existing Content Version.
		 */
		patch: operations["updateContentVersion"]
	}
	"/versions/{id}/save": {
		/**
		 * Save to a Content Version
		 * @description Save item changes to an existing Content Version.
		 */
		post: operations["saveContentVersion"]
	}
	"/versions/{id}/compare": {
		/**
		 * Compare a Content Version
		 * @description Compare an existing Content Version with the main version of the item.
		 */
		get: operations["compareContentVersion"]
	}
	"/versions/{id}/promote": {
		/**
		 * Promote a Content Version
		 * @description Pass the current hash of the main version of the item (obtained from the `compare` endpoint) along with an optional array of field names of which the values are to be promoted (by default, all fields are selected).
		 */
		post: operations["promoteContentVersion"]
	}
	"/revisions": {
		/**
		 * List Revisions
		 * @description List the revisions.
		 */
		get: operations["getRevisions"]
	}
	"/revisions/{id}": {
		/**
		 * Retrieve a Revision
		 * @description Retrieve a single revision by unique identifier.
		 */
		get: operations["getRevision"]
	}
	"/users": {
		/**
		 * List Users
		 * @description List the users.
		 */
		get: operations["getUsers"]
		/**
		 * Create a User
		 * @description Create a new user.
		 */
		post: operations["createUser"]
		/**
		 * Delete Multiple Users
		 * @description Delete multiple existing users.
		 */
		delete: operations["deleteUsers"]
		/**
		 * Update Multiple Users
		 * @description Update multiple users at the same time.
		 */
		patch: operations["updateUsers"]
	}
	"/users/{id}": {
		/**
		 * Retrieve a User
		 * @description Retrieve a single user by unique identifier.
		 */
		get: operations["getUser"]
		/**
		 * Delete a User
		 * @description Delete an existing user
		 */
		delete: operations["deleteUser"]
		/**
		 * Update a User
		 * @description Update an existing user
		 */
		patch: operations["updateUser"]
	}
	"/users/invite": {
		/**
		 * Invite User(s)
		 * @description Invites one or more users to this project. It creates a user with an invited status, and then sends an email to the user with instructions on how to activate their account.
		 */
		post: operations["invite"]
	}
	"/users/invite/accept": {
		/**
		 * Accept User Invite
		 * @description Accepts and enables an invited user using a JWT invitation token.
		 */
		post: operations["acceptInvite"]
	}
	"/users/me": {
		/**
		 * Retrieve Current User
		 * @description Retrieve the currently authenticated user.
		 */
		get: operations["getMe"]
		/**
		 * Update Current User
		 * @description Update the currently authenticated user.
		 */
		patch: operations["updateMe"]
	}
	"/users/me/track/page": {
		/**
		 * Update Last Page
		 * @description Updates the last used page field of the currently authenticated user. This is used internally to be able to open the Directus admin app from the last page you used.
		 */
		patch: operations["updateLastUsedPageMe"]
	}
	"/users/me/tfa/enable": {
		/**
		 * Enable 2FA
		 * @description Enables two-factor authentication for the currently authenticated user.
		 */
		post: operations["meTfaEnable"]
	}
	"/users/me/tfa/disable": {
		/**
		 * Disable 2FA
		 * @description Disables two-factor authentication for the currently authenticated user.
		 */
		post: operations["meTfaDisable"]
	}
	"/settings": {
		/**
		 * Retrieve Settings
		 * @description List the settings.
		 */
		get: operations["getSettings"]
		/**
		 * Update Settings
		 * @description Update the settings
		 */
		patch: operations["updateSetting"]
	}
	"/extensions": {
		/**
		 * List Extensions
		 * @description List the installed extensions and their configuration in the project.
		 */
		get: operations["listExtensions"]
	}
	"/extensions/{name}": {
		/**
		 * Update an Extension
		 * @description Update an existing extension.
		 */
		patch: operations["updateExtensions"]
	}
	"/extensions/{bundle}/{name}": {
		/**
		 * Update an Extension
		 * @description Update an existing extension.
		 */
		patch: operations["updateExtensions"]
	}
}

export type webhooks = Record<string, never>

export interface components {
	schemas: {
		Diff: {
			hash?: string
			diff?: {
				collections?: {
					collection?: string
					diff?: Record<string, never>[]
				}[]
				fields?: {
					collection?: string
					field?: string
					diff?: Record<string, never>[]
				}[]
				relations?: {
					collection?: string
					field?: string
					related_collection?: string
					diff?: Record<string, never>[]
				}[]
			}
		}
		Files: {
			/**
			 * @description Unique identifier for the file.
			 * @example 8cbb43fe-4cdf-4991-8352-c461779cec02
			 */
			id?: string
			/**
			 * @description Where the file is stored. Either `local` for the local filesystem or the name of the storage adapter (for example `s3`).
			 * @example local
			 */
			storage?: string
			/**
			 * @description Name of the file on disk. By default, Directus uses a random hash for the filename.
			 * @example a88c3b72-ac58-5436-a4ec-b2858531333a.jpg
			 */
			filename_disk?: string
			/**
			 * @description How you want to the file to be named when it's being downloaded.
			 * @example avatar.jpg
			 */
			filename_download?: string
			/**
			 * @description Title for the file. Is extracted from the filename on upload, but can be edited by the user.
			 * @example User Avatar
			 */
			title?: string
			/**
			 * @description MIME type of the file.
			 * @example image/jpeg
			 */
			type?: string
			/**
			 * @description Virtual folder where this file resides in.
			 * @example null
			 */
			folder?: string | components["schemas"]["Folders"] | null
			/**
			 * @description Who uploaded the file.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			uploaded_by?: string | components["schemas"]["Users"]
			/**
			 * Format: date-time
			 * @description When the file was uploaded.
			 * @example 2019-12-03T00:10:15+00:00
			 */
			uploaded_on?: string
			modified_by?: string | components["schemas"]["Users"] | null
			/** Format: date-time */
			modified_on?: string
			/**
			 * @description Character set of the file.
			 * @example binary
			 */
			charset?: string | null
			/**
			 * @description Size of the file in bytes.
			 * @example 137862
			 */
			filesize?: number
			/**
			 * @description Width of the file in pixels. Only applies to images.
			 * @example 800
			 */
			width?: number | null
			/**
			 * @description Height of the file in pixels. Only applies to images.
			 * @example 838
			 */
			height?: number | null
			/**
			 * @description Duration of the file in seconds. Only applies to audio and video.
			 * @example 0
			 */
			duration?: number | null
			/**
			 * @description Where the file was embedded from.
			 * @example null
			 */
			embed?: string | null
			/** @description Description for the file. */
			description?: string | null
			/** @description Where the file was created. Is automatically populated based on Exif data for images. */
			location?: string | null
			/** @description Tags for the file. Is automatically populated based on Exif data for images. */
			tags?: string[] | null
			/** @description IPTC, Exif, and ICC metadata extracted from file */
			metadata?: unknown
			focal_point_x?: number | null
			focal_point_y?: number | null
		}
		Folders: {
			/**
			 * @description Unique identifier for the folder.
			 * @example 0cf0e03d-4364-45df-b77b-ca61f61869d2
			 */
			id?: string
			/**
			 * @description Name of the folder.
			 * @example New York
			 */
			name?: string
			/**
			 * @description Unique identifier of the parent folder. This allows for nested folders.
			 * @example null
			 */
			parent?: string | components["schemas"]["Folders"] | null
		}
		Roles: {
			/**
			 * @description Unique identifier for the role.
			 * @example 2f24211d-d928-469a-aea3-3c8f53d4e426
			 */
			id?: string
			/**
			 * @description Name of the role.
			 * @example Administrator
			 */
			name?: string
			/**
			 * @description The role's icon.
			 * @example verified_user
			 */
			icon?: string
			/**
			 * @description Description of the role.
			 * @example Admins have access to all managed data within the system by default
			 */
			description?: string | null
			/**
			 * @description Array of IP addresses that are allowed to connect to the API as a user of this role.
			 * @example []
			 */
			ip_access?: string[]
			/**
			 * @description Whether or not this role enforces the use of 2FA.
			 * @example false
			 */
			enforce_tfa?: boolean
			/**
			 * @description Admin role. If true, skips all permission checks.
			 * @example false
			 */
			admin_access?: boolean
			/**
			 * @description The users in the role are allowed to use the app.
			 * @example true
			 */
			app_access?: boolean
			users?: (string | components["schemas"]["Users"])[] | null
		}
		Schema: {
			/** @example 1 */
			version?: number
			directus?: string
			vendor?: string
			collections?: components["schemas"]["Collections"][]
			fields?: components["schemas"]["Fields"][]
			relations?: components["schemas"]["Relations"][]
		}
		Users: {
			/**
			 * @description Unique identifier for the user.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			id?: string
			/**
			 * @description First name of the user.
			 * @example Admin
			 */
			first_name?: string
			/**
			 * @description Last name of the user.
			 * @example User
			 */
			last_name?: string
			/**
			 * Format: email
			 * @description Unique email address for the user.
			 * @example admin@example.com
			 */
			email?: string
			/** @description Password of the user. */
			password?: string
			/**
			 * @description The user's location.
			 * @example null
			 */
			location?: string | null
			/**
			 * @description The user's title.
			 * @example null
			 */
			title?: string | null
			/**
			 * @description The user's description.
			 * @example null
			 */
			description?: string | null
			/**
			 * @description The user's tags.
			 * @example null
			 */
			tags?: string[] | null
			/**
			 * @description The user's avatar.
			 * @example null
			 */
			avatar?: string | components["schemas"]["Files"] | null
			/**
			 * @description The user's language used in Directus.
			 * @example en-US
			 */
			language?: string
			/**
			 * @description The 2FA secret string that's used to generate one time passwords.
			 * @example null
			 */
			tfa_secret?: string | null
			/**
			 * @description Status of the user.
			 * @example active
			 * @enum {string}
			 */
			status?: "active" | "invited" | "draft" | "suspended" | "deleted"
			/**
			 * @description Unique identifier of the role of this user.
			 * @example 2f24211d-d928-469a-aea3-3c8f53d4e426
			 */
			role?: string | components["schemas"]["Roles"]
			/** @description Static token for the user. */
			token?: string | null
			/**
			 * Format: date-time
			 * @description When this user used the API last.
			 * @example 2020-05-31T14:32:37Z
			 */
			last_access?: string | null
			/**
			 * @description Last page that the user was on.
			 * @example /my-project/settings/collections/a
			 */
			last_page?: string | null
			provider?: string
			external_identifier?: string | null
			auth_data?: unknown
			email_notifications?: boolean | null
			appearance?: string | null
			theme_dark?: string | null
			theme_light?: string | null
			theme_light_overrides?: unknown
			theme_dark_overrides?: unknown
		}
		Query: {
			/**
			 * @description Control what fields are being returned in the object.
			 * @example [
			 *   "*",
			 *   "*.*"
			 * ]
			 */
			fields?: string[]
			/**
			 * @example {
			 *   "<field>": {
			 *     "<operator>": "<value>"
			 *   }
			 * }
			 */
			filter?: Record<string, never>
			/** @description Filter by items that contain the given search query in one of their fields. */
			search?: string
			/**
			 * @description How to sort the returned items.
			 * @example [
			 *   "-date_created"
			 * ]
			 */
			sort?: string[]
			/** @description Set the maximum number of items that will be returned */
			limit?: number
			/** @description How many items to skip when fetching data. */
			offset?: number
			/** @description Cursor for use in pagination. Often used in combination with limit. */
			page?: number
			/**
			 * @description Deep allows you to set any of the other query parameters on a nested relational dataset.
			 * @example {
			 *   "related_articles": {
			 *     "_limit": 3
			 *   }
			 * }
			 */
			deep?: Record<string, never>
		}
		"x-metadata": {
			/** @description Returns the total item count of the collection you're querying. */
			total_count?: number
			/** @description Returns the item count of the collection you're querying, taking the current filter/search parameters into account. */
			filter_count?: number
		}
		Relations: {
			/**
			 * @description Unique identifier for the relation.
			 * @example 1
			 */
			id?: number
			/**
			 * @description Collection that has the field that holds the foreign key.
			 * @example directus_activity
			 */
			many_collection?: string
			/**
			 * @description Foreign key. Field that holds the primary key of the related collection.
			 * @example user
			 */
			many_field?: string
			/**
			 * @description Collection on the _one_ side of the relationship.
			 * @example directus_users
			 */
			one_collection?: string
			/**
			 * @description Alias column that serves as the _one_ side of the relationship.
			 * @example null
			 */
			one_field?: string | null
			one_collection_field?: string | null
			one_allowed_collections?: string[] | null
			/**
			 * @description Field on the junction table that holds the many field of the related relation.
			 * @example null
			 */
			junction_field?: string | null
			sort_field?: string | null
			one_deselect_action?: string
		}
		Permissions: {
			/**
			 * @description Unique identifier for the permission.
			 * @example 1
			 */
			id?: number
			/**
			 * @description Unique identifier of the role this permission applies to.
			 * @example 2f24211d-d928-469a-aea3-3c8f53d4e426
			 */
			role?: string | null
			/**
			 * @description What collection this permission applies to.
			 * @example customers
			 */
			collection?: string
			/**
			 * @description What action this permission applies to.
			 * @example create
			 * @enum {string}
			 */
			action?: "create" | "read" | "update" | "delete"
			/** @description JSON structure containing the permissions checks for this permission. */
			permissions?: unknown
			/** @description JSON structure containing the validation checks for this permission. */
			validation?: unknown
			/** @description JSON structure containing the preset value for created/updated items. */
			presets?: unknown
			/** @description CSV of fields that the user is allowed to interact with. */
			fields?: string[] | null
		}
		Webhooks: {
			/**
			 * @description The index of the webhook.
			 * @example 1
			 */
			id?: number
			/**
			 * @description The name of the webhook.
			 * @example create articles
			 */
			name?: string
			/**
			 * @description Method used in the webhook.
			 * @example POST
			 */
			method?: string
			/**
			 * @description The url of the webhook.
			 * @example null
			 */
			url?: string | null
			/**
			 * @description The status of the webhook.
			 * @example inactive
			 */
			status?: string
			/**
			 * @description If yes, send the content of what was done
			 * @example true
			 */
			data?: boolean
			/**
			 * @description The actions that triggers this webhook.
			 * @example null
			 */
			actions?: string[] | null
			collections?: string[]
			headers?: unknown
		}
		Collections: {
			/**
			 * @description The collection key.
			 * @example customers
			 */
			collection?: string
			icon?: string | null
			note?: string | null
			display_template?: string | null
			hidden?: boolean
			singleton?: boolean
			translations?: unknown
			archive_field?: string | null
			archive_app_filter?: boolean
			archive_value?: string | null
			unarchive_value?: string | null
			sort_field?: string | null
			accountability?: string | null
			color?: string | null
			item_duplication_fields?: unknown
			sort?: number | null
			group?: string | components["schemas"]["Collections"] | null
			collapse?: string
			preview_url?: string | null
			versioning?: boolean
		}
		Fields: {
			id?: number
			/**
			 * @description Unique name of the collection this field is in.
			 * @example about_us
			 */
			collection?: string
			/**
			 * @description Unique name of the field. Field name is unique within the collection.
			 * @example id
			 */
			field?: string
			special?: string[] | null
			interface?: string | null
			options?: unknown
			display?: string | null
			display_options?: unknown
			readonly?: boolean
			hidden?: boolean
			sort?: number | null
			width?: string | null
			translations?: unknown
			note?: string | null
			conditions?: unknown
			required?: boolean | null
			group?: number | components["schemas"]["Fields"] | null
			validation?: unknown
			validation_message?: string | null
		}
		Flows: {
			/**
			 * @description Unique identifier for the flow.
			 * @example 2f24211d-d928-469a-aea3-3c8f53d4e426
			 */
			id?: string
			/**
			 * @description The name of the flow.
			 * @example Update Articles Flow
			 */
			name?: string
			/**
			 * @description Icon displayed in the Admin App for the flow.
			 * @example bolt
			 */
			icon?: string
			/**
			 * @description Color of the icon displayed in the Admin App for the flow.
			 * @example #112233
			 */
			color?: string | null
			description?: string | null
			/**
			 * @description Current status of the flow.
			 * @default active
			 * @example active
			 * @enum {string}
			 */
			status?: "active" | "inactive"
			/**
			 * @description Type of trigger for the flow. One of `hook`, `webhook`, `operation`, `schedule`, `manual`.
			 * @example manual
			 */
			trigger?: string
			/**
			 * @description The permission used during the flow. One of `$public`, `$trigger`, `$full`, or UUID of a role.
			 * @example $trigger
			 */
			accountability?: string
			/**
			 * @description Options of the selected trigger for the flow.
			 * @example null
			 */
			options?: unknown
			/**
			 * @description UUID of the operation connected to the trigger in the flow.
			 * @example 92e82998-e421-412f-a513-13701e83e4ce
			 */
			operation?: string | components["schemas"]["Operations"]
			/**
			 * Format: date-time
			 * @description Timestamp in ISO8601 when the flow was created.
			 * @example 2022-05-11T13:14:52Z
			 */
			date_created?: string | null
			/**
			 * @description The user who created the flow.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			user_created?: string | components["schemas"]["Users"]
			operations?: (string | components["schemas"]["Operations"])[] | null
		}
		Operations: {
			/**
			 * @description Unique identifier for the operation.
			 * @example 2f24211d-d928-469a-aea3-3c8f53d4e426
			 */
			id?: string
			/**
			 * @description The name of the operation.
			 * @example Log to Console
			 */
			name?: string
			/**
			 * @description Key for the operation. Must be unique within a given flow.
			 * @example log_console
			 */
			key?: string
			/**
			 * @description Type of operation. One of `log`, `mail`, `notification`, `create`, `read`, `request`, `sleep`, `transform`, `trigger`, `condition`, or any type of custom operation extensions.
			 * @example log
			 */
			type?: string
			/**
			 * @description Position of the operation on the X axis within the flow workspace.
			 * @example 12
			 */
			position_x?: number
			/**
			 * @description Position of the operation on the Y axis within the flow workspace.
			 * @example 12
			 */
			position_y?: number
			/**
			 * @description Options depending on the type of the operation.
			 * @example null
			 */
			options?: unknown
			/**
			 * @description The operation triggered when the current operation succeeds (or `then` logic of a condition operation).
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			resolve?: string | components["schemas"]["Operations"]
			/**
			 * @description The operation triggered when the current operation fails (or `otherwise` logic of a condition operation).
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			reject?: string | components["schemas"]["Operations"]
			flow?: string | components["schemas"]["Flows"]
			/**
			 * Format: date-time
			 * @description Timestamp in ISO8601 when the operation was created.
			 * @example 2022-05-11T13:14:52Z
			 */
			date_created?: string | null
			/**
			 * @description The user who created the operation.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			user_created?: string | components["schemas"]["Users"]
		}
		Activity: {
			/**
			 * @description Unique identifier for the object.
			 * @example 2
			 */
			id?: number
			/**
			 * @description Action that was performed.
			 * @example update
			 * @enum {string}
			 */
			action?: "create" | "update" | "delete" | "login"
			/** @description The user who performed this action. */
			user?: string | components["schemas"]["Users"] | null
			/**
			 * Format: date-time
			 * @description When the action happened.
			 * @example 2019-12-05T22:52:09Z
			 */
			timestamp?: string
			/**
			 * @description The IP address of the user at the time the action took place.
			 * @example 127.0.0.1
			 */
			ip?: string
			/**
			 * @description User agent string of the browser the user used when the action took place.
			 * @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/78.0.3904.108 Safari/537.36
			 */
			user_agent?: string
			/** @description Collection identifier in which the item resides. */
			collection?: string | components["schemas"]["Collections"]
			/**
			 * @description Unique identifier for the item the action applied to. This is always a string, even for integer primary keys.
			 * @example 328
			 */
			item?: string
			/**
			 * @description User comment. This will store the comments that show up in the right sidebar of the item edit page in the admin app.
			 * @example null
			 */
			comment?: string | null
			/**
			 * @description Origin of the request when the action took place.
			 * @example https://directus.io
			 */
			origin?: string
			revisions?: (number | components["schemas"]["Revisions"])[] | null
		}
		Presets: {
			/**
			 * @description Unique identifier for this single collection preset.
			 * @example 155
			 */
			id?: number
			/** @description Name for the bookmark. If this is set, the preset will be considered a bookmark. */
			bookmark?: string | null
			/**
			 * @description The unique identifier of the user to whom this collection preset applies.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			user?: string | components["schemas"]["Users"] | null
			/**
			 * @description The unique identifier of a role in the platform. If `user` is null, this will be used to apply the collection preset or bookmark for all users in the role.
			 * @example 50419801-0f30-8644-2b3c-9bc2d980d0a0
			 */
			role?: string | components["schemas"]["Roles"] | null
			/**
			 * @description What collection this collection preset is used for.
			 * @example articles
			 */
			collection?: string | components["schemas"]["Collections"]
			/** @description Search query. */
			search?: string | null
			/**
			 * @description Key of the layout that is used.
			 * @example null
			 */
			layout?: string
			/**
			 * @description Layout query that's saved per layout type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters.
			 * @example {
			 *   "cards": {
			 *     "sort": "-published_on"
			 *   }
			 * }
			 */
			layout_query?: unknown
			/**
			 * @description Options of the views. The properties in here are controlled by the layout.
			 * @example {
			 *   "cards": {
			 *     "icon": "account_circle",
			 *     "title": "{{ first_name }} {{ last_name }}",
			 *     "subtitle": "{{ title }}",
			 *     "size": 3
			 *   }
			 * }
			 */
			layout_options?: unknown
			refresh_interval?: number | null
			filter?: unknown
			icon?: string | null
			color?: string | null
		}
		Versions: {
			/**
			 * @description Primary key of the Content Version.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			id?: string
			/**
			 * @description Key of the Content Version, used as the value for the "version" query parameter.
			 * @example draft
			 */
			key?: string
			/**
			 * @description Descriptive name of the Content Version.
			 * @example My Draft
			 */
			name?: string
			/**
			 * @description Name of the collection the Content Version is created on.
			 * @example articles
			 */
			collection?: string | components["schemas"]["Collections"]
			/**
			 * @description The item the Content Version is created on.
			 * @example 168
			 */
			item?: string
			hash?: string | null
			/**
			 * Format: date-time
			 * @description When the Content Version was created.
			 * @example 2022-05-11T13:14:52Z
			 */
			date_created?: string | null
			/**
			 * Format: date-time
			 * @description When the Content Version was updated.
			 * @example 2022-05-11T13:14:53Z
			 */
			date_updated?: string | null
			/**
			 * @description User that created the Content Version.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			user_created?: string | components["schemas"]["Users"]
			/**
			 * @description User that updated the Content Version.
			 * @example 63716273-0f29-4648-8a2a-2af2948f6f78
			 */
			user_updated?: string | components["schemas"]["Users"]
		}
		Revisions: {
			/**
			 * @description Unique identifier for the revision.
			 * @example 1
			 */
			id?: number
			/**
			 * @description Unique identifier for the activity record.
			 * @example 2
			 */
			activity?: number | components["schemas"]["Activity"]
			/**
			 * @description Collection of the updated item.
			 * @example articles
			 */
			collection?: string | components["schemas"]["Collections"]
			/**
			 * @description Primary key of updated item.
			 * @example 168
			 */
			item?: string
			/**
			 * @description Copy of item state at time of update.
			 * @example {
			 *   "author": 1,
			 *   "body": "This is my first post",
			 *   "featured_image": 15,
			 *   "id": "168",
			 *   "title": "Hello, World!"
			 * }
			 */
			data?: unknown
			/**
			 * @description Changes between the previous and the current revision.
			 * @example {
			 *   "title": "Hello, World!"
			 * }
			 */
			delta?: Record<string, never>
			/**
			 * @description If the current item was updated relationally, this is the id of the parent revision record
			 * @example null
			 */
			parent?: number | null
			/**
			 * @description Associated version of this revision.
			 * @example draft
			 */
			version?: string | components["schemas"]["Versions"]
		}
		Settings: {
			/**
			 * @description Unique identifier for the setting.
			 * @example 1
			 */
			id?: number
			/**
			 * @description The name of the project.
			 * @example Directus
			 */
			project_name?: string
			/**
			 * @description The url of the project.
			 * @example null
			 */
			project_url?: string | null
			/**
			 * @description The brand color of the project.
			 * @example null
			 */
			project_color?: string | null
			/**
			 * @description The logo of the project.
			 * @example null
			 */
			project_logo?: string | null
			/**
			 * @description The foreground of the project.
			 * @example null
			 */
			public_foreground?: string | null
			/**
			 * @description The background of the project.
			 * @example null
			 */
			public_background?: string | null
			/**
			 * @description Note rendered on the public pages of the app.
			 * @example null
			 */
			public_note?: string | null
			/**
			 * @description Allowed authentication login attempts before the user's status is set to blocked.
			 * @example 25
			 */
			auth_login_attempts?: number
			/** @description Authentication password policy. */
			auth_password_policy?: string | null
			/**
			 * @description What transformations are allowed in the assets endpoint.
			 * @example all
			 * @enum {string|null}
			 */
			storage_asset_transform?: "all" | "none" | "presets" | null
			/**
			 * @description Array of allowed
			 * @example null
			 */
			storage_asset_presets?:
				| {
						/** @description Key for the asset. Used in the assets endpoint. */
						key?: string
						/**
						 * @description Whether to crop the thumbnail to match the size, or maintain the aspect ratio.
						 * @enum {string}
						 */
						fit?: "cover" | "contain" | "inside" | "outside"
						/** @description Width of the thumbnail. */
						width?: number
						/** @description Height of the thumbnail. */
						height?: number
						/** @description No image upscale */
						withoutEnlargement?: boolean
						/** @description Quality of the compression used. */
						quality?: number
						/**
						 * @description Reformat output image
						 * @enum {string}
						 */
						format?: "" | "jpeg" | "png" | "webp" | "tiff" | "avif"
						/** @description Additional transformations to apply */
						transforms?:
							| {
									/** @description The Sharp method name */
									method?: string
									/** @description A list of arguments to pass to the Sharp method */
									arguments?:
										| {
												/** @description A JSON representation of the argument value */
												argument?: string
										  }[]
										| null
							  }[]
							| null
				  }[]
				| null
			custom_css?: string | null
			/**
			 * Format: uuid
			 * @description Default folder to place files
			 */
			storage_default_folder?: string
			basemaps?: unknown
			mapbox_key?: string | null
			module_bar?: unknown
			project_descriptor?: string | null
			default_language?: string
			custom_aspect_ratios?: unknown
			/** @description $t:field_options.directus_settings.project_favicon_note */
			public_favicon?: string | components["schemas"]["Files"] | null
			default_appearance?: string
			default_theme_light?: string | null
			theme_light_overrides?: unknown
			default_theme_dark?: string | null
			theme_dark_overrides?: unknown
		}
		Extensions: {
			/**
			 * @description Unique name of the extension.
			 * @example my-bundle-operation
			 */
			name?: string
			enabled?: boolean
		}
	}
	responses: {
		/** @description Error: Not found. */
		NotFoundError: {
			content: {
				"application/json": {
					error?: {
						/** Format: int64 */
						code?: number
						message?: string
					}
				}
			}
		}
		/** @description Error: Unauthorized request */
		UnauthorizedError: {
			content: {
				"application/json": {
					error?: {
						/** Format: int64 */
						code?: number
						message?: string
					}
				}
			}
		}
	}
	parameters: {
		/** @description Index */
		Id: number
		/** @description Unique identifier for the object. */
		UUId: string
		/** @description Collection of which you want to retrieve the items from. */
		Collection: string
		/** @description Filter by items that contain the given search query in one of their fields. */
		Search?: string
		/** @description Cursor for use in pagination. Often used in combination with limit. */
		Page?: number
		/** @description How many items to skip when fetching data. */
		Offset?: number
		/** @description How to sort the returned items. `sort` is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (` - `) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ` ? ` to sort randomly. */
		Sort?: string[]
		/** @description What metadata to return in the response. */
		Meta?: string
		/** @description A limit on the number of objects that are returned. */
		Limit?: number
		/** @description Select items in collection by given conditions. */
		Filter?: string[]
		/** @description Control what fields are being returned in the object. */
		Fields?: string[]
		/** @description Controls if the API sets a cookie or returns a JWT on successful login. */
		Mode: "jwt" | "cookie"
		/** @description Saves the API response to a file. Accepts one of "csv", "json", "xml", "yaml". */
		Export?: "csv" | "json" | "xml" | "yaml"
		/** @description Retrieve an item's state from a specific Content Version. The value corresponds to the "key" of the Content Version. */
		Version?: string
	}
	requestBodies: never
	headers: never
	pathItems: never
}

export type $defs = Record<string, never>

export type external = Record<string, never>

export interface operations {
	/**
	 * Get an Asset
	 * @description Image typed files can be dynamically resized and transformed to fit any need.
	 */
	getAsset: {
		parameters: {
			query?: {
				/** @description The key of the asset size configured in settings. */
				key?: string
				/** @description A JSON array of image transformations */
				transforms?: string
				/** @description Download the asset to your computer */
				download?: boolean
			}
			path: {
				/** @description The id of the file. */
				id: string
			}
		}
		responses: {
			/** @description Successful request */
			200: {
				content: {
					"text/plain": string
				}
			}
			404: components["responses"]["NotFoundError"]
		}
	}
	/**
	 * Retrieve a Temporary Access Token
	 * @description Retrieve a Temporary Access Token
	 */
	login: {
		requestBody?: {
			content: {
				"application/json": {
					/**
					 * @description Email address of the user you're retrieving the access token for.
					 * @example admin@example.com
					 */
					email: string
					/**
					 * Format: password
					 * @description Password of the user.
					 * @example password
					 */
					password: string
					/**
					 * @description Choose between retrieving the token as a string, or setting it as a cookie.
					 * @default json
					 * @enum {string}
					 */
					mode?: "json" | "cookie"
					/** @description If 2FA is enabled, you need to pass the one time password. */
					otp?: string
				}
			}
		}
		responses: {
			/** @description Successful authentification */
			200: {
				content: {
					"application/json": {
						data?: {
							/** @example eyJhbGciOiJI... */
							access_token?: string
							/** @example 900 */
							expires?: number
							/** @example yuOJkjdPXMd... */
							refresh_token?: string
						}
					}
				}
			}
		}
	}
	/**
	 * Refresh Token
	 * @description Refresh a Temporary Access Token.
	 */
	refresh: {
		requestBody?: {
			content: {
				"application/json":