diff --git a/.devcontainer/devcontainer-lock.json b/.devcontainer/devcontainer-lock.json new file mode 100644 index 0000000000000..b9f7155fe081d --- /dev/null +++ b/.devcontainer/devcontainer-lock.json @@ -0,0 +1,9 @@ +{ + "features": { + "ghcr.io/devcontainers/features/docker-in-docker:4": { + "version": "4.0.0", + "resolved": "ghcr.io/devcontainers/features/docker-in-docker@sha256:4fa87399214366e320d489991769c4f3f461e1ffe461f54eea78a41b34945bb5", + "integrity": "sha256:4fa87399214366e320d489991769c4f3f461e1ffe461f54eea78a41b34945bb5" + } + } +} diff --git a/e2e/package.json b/e2e/package.json index 6f38758a5fd8c..c1c934c725572 100644 --- a/e2e/package.json +++ b/e2e/package.json @@ -26,6 +26,7 @@ "devDependencies": { "@eslint/js": "^10.0.0", "@faker-js/faker": "^10.1.0", + "@futo-org/backups-orchestrator-ui": "0.30.0", "@immich/cli": "workspace:*", "@immich/e2e-auth-server": "workspace:*", "@immich/sdk": "workspace:*", @@ -36,6 +37,7 @@ "@types/pg": "^8.15.1", "@types/pngjs": "^6.0.4", "@types/supertest": "^7.0.0", + "@typescript/native": "npm:typescript@^7.0.2", "dotenv": "^17.2.3", "eslint": "^10.0.0", "eslint-config-prettier": "^10.1.8", @@ -51,7 +53,6 @@ "sharp": "^0.34.5", "socket.io-client": "^4.7.4", "supertest": "^7.0.0", - "@typescript/native": "npm:typescript@^7.0.2", "typescript": "npm:@typescript/typescript6@^6.0.2", "typescript-eslint": "^8.28.0", "utimes": "^5.2.1", diff --git a/e2e/src/specs/maintenance/server/yucca-backups.e2e-spec.ts b/e2e/src/specs/maintenance/server/yucca-backups.e2e-spec.ts new file mode 100644 index 0000000000000..fd048db682f55 --- /dev/null +++ b/e2e/src/specs/maintenance/server/yucca-backups.e2e-spec.ts @@ -0,0 +1,385 @@ +import * as sdk from '@futo-org/backups-orchestrator-ui/sdk'; +import { LoginResponseDto, StorageFolder } from '@immich/sdk'; +import { io, Socket } from 'socket.io-client'; +import { createUserDto } from 'src/fixtures'; +import { errorDto } from 'src/responses'; +import { app, asBearerAuth, baseUrl, utils } from 'src/utils'; +import request from 'supertest'; +import { afterAll, beforeAll, describe, expect, it } from 'vitest'; + +describe('/yucca', () => { + let admin: LoginResponseDto; + let nonAdmin: LoginResponseDto; + let requestOpts: any; + let filename: string; + + let socket: Socket; + let libraryId: string; + + beforeAll(async () => { + sdk.defaults.baseUrl = baseUrl; + + await utils.resetDatabase(); + admin = await utils.adminSetup(); + nonAdmin = await utils.userSetup(admin.accessToken, createUserDto.user1); + + requestOpts = { headers: asBearerAuth(admin.accessToken) }; + + await utils.resetBackups(admin.accessToken); + await sdk.resetOrchestrator(requestOpts); + + socket = io(baseUrl, { + path: '/api/yucca/socket.io', + transports: ['websocket'], + extraHeaders: asBearerAuth(admin.accessToken), + }); + + socket.onAny(console.info); + }); + + afterAll(async () => { + socket.close(); + + // "resetDatabase" does not reinit the module config, trigger an update / clean up + if (libraryId) { + await utils.deleteLibrary(admin.accessToken, libraryId); + } + }); + + const waitForMessage = (type: string) => { + return new Promise((resolve) => { + const listener = (msg: string) => { + const payload = JSON.parse(msg); + if (payload.type !== type) { + return; + } + + resolve(payload); + socket.offAny(listener); + }; + + socket.onAny(listener); + }); + }; + + describe('Orchestration Module', async () => { + it('works', async () => { + await expect(sdk.onboardingStatus(requestOpts)).resolves.toEqual( + expect.objectContaining({ + hasOnboardedKey: false, + hasBackend: false, + hasBackup: false, + hasSchedule: false, + hasSkippedExtraConfig: false, + }), + ); + }); + + it('is inaccessible without admin', async () => { + await expect(sdk.onboardingStatus({ headers: asBearerAuth(nonAdmin.accessToken) })).rejects.toEqual( + expect.objectContaining({ data: errorDto.forbidden }), + ); + }); + + it('is inaccessible without logging in', async () => { + await expect(sdk.onboardingStatus()).rejects.toEqual(expect.objectContaining({ data: errorDto.unauthorized })); + }); + }); + + describe.sequential('Local Backup', async () => { + beforeAll(async () => { + await sdk.importRecoveryKey( + { + recoveryKey: '0'.repeat(64), + }, + requestOpts, + ); + }); + + it.sequential('configures a local backend', async () => { + await utils.mkFolder('/local-backend'); + + await sdk.createLocalBackend( + { + path: '/local-backend', + }, + requestOpts, + ); + }); + + it.sequential('configures Immich backup', async () => { + const event = waitForMessage('IntegrationUpdate'); + + await sdk.configureImmichIntegration( + { + name: 'Immich', + worm: false, + cron: '0 3 * * *', + backupConfiguration: true, + dataFolders: [StorageFolder.Backups, StorageFolder.Upload], + libraries: 'all', + }, + requestOpts, + ); + + await event; + + await expect(sdk.getIntegrations(requestOpts)).resolves.toEqual( + expect.objectContaining({ + immichIntegration: expect.objectContaining({ + configuration: { + backupConfiguration: true, + dataFolders: ['backups', 'upload'], + libraries: 'all', + }, + }), + immichState: { + dataFolders: expect.arrayContaining(Object.values(StorageFolder)), + dataPath: '/data', + libraries: [], + }, + }), + ); + }); + + it.sequential('updates configuration', async () => { + await utils.mkFolder('/test'); + + ({ id: libraryId } = await utils.createLibrary(admin.accessToken, { + ownerId: admin.userId, + name: 'My Library', + importPaths: ['/test'], + })); + + await expect(sdk.getIntegrations(requestOpts)).resolves.toEqual( + expect.objectContaining({ + immichIntegration: expect.any(Object), + immichState: expect.objectContaining({ + libraries: expect.arrayContaining([ + expect.objectContaining({ + name: 'My Library', + importPaths: ['/test'], + }), + ]), + }), + }), + ); + }); + + it.sequential('creates a snapshot', async () => { + const event = waitForMessage('TaskEnd'); + + const { + repositories: [{ id }], + } = await sdk.getRepositories(requestOpts); + + filename = await utils.createBackup(admin.accessToken); + + await sdk.createBackup(id, requestOpts); + await event; + + const { + snapshots: [{ id: snapshotId }], + } = await sdk.getSnapshots(id, requestOpts); + + await expect(sdk.getSnapshotListing(id, snapshotId, {}, requestOpts)).resolves.toMatchInlineSnapshot(` + { + "items": [ + { + "isDirectory": true, + "path": "/data", + }, + { + "isDirectory": true, + "path": "/test", + }, + ], + "parent": "/", + "path": "/", + } + `); + + await expect(sdk.getSnapshotListing(id, snapshotId, { path: '/data' }, requestOpts)).resolves + .toMatchInlineSnapshot(` + { + "items": [ + { + "isDirectory": true, + "path": "/data/backups", + }, + { + "isDirectory": true, + "path": "/data/upload", + }, + { + "isDirectory": true, + "path": "/data/yucca", + }, + ], + "parent": "/", + "path": "/data", + } + `); + + await expect(sdk.getSnapshotListing(id, snapshotId, { path: '/data/backups' }, requestOpts)).resolves.toEqual( + expect.objectContaining({ + items: [ + { + isDirectory: false, + path: '/data/backups/.immich', + }, + { + isDirectory: false, + path: expect.stringContaining('/data/backups/immich-db-backup-'), + }, + ], + parent: '/data', + path: '/data/backups', + }), + ); + }); + }); + + describe.sequential('Restore Local Backup', async () => { + let cookie: string; + + beforeAll(async () => { + await sdk.resetOrchestrator(requestOpts); + await utils.resetDatabase(); + socket.disconnect(); + await utils.disconnectDatabase(); + }); + + afterAll(async () => { + await utils.connectDatabase(); + }); + + it.sequential( + 'restores backup', + async () => { + const { status, headers } = await request(app).post('/admin/database-backups/start-restore').send(); + expect(status).toBe(201); + cookie = headers['set-cookie'][0].split(';')[0]; + + await expect + .poll( + async () => { + const { status, body } = await request(app).get('/server/config'); + expect(status).toBe(200); + return body.maintenanceMode; + }, + { + interval: 500, + timeout: 10_000, + }, + ) + .toBeTruthy(); + + const maintenanceRequestOpts = { + headers: { + cookie, + }, + }; + + await expect(sdk.getSchedules(maintenanceRequestOpts)).resolves.toEqual({ schedules: [] }); + + await sdk.importRecoveryKey( + { + recoveryKey: '0'.repeat(64), + }, + maintenanceRequestOpts, + ); + + const { + backend: { id: backendId }, + } = await sdk.createLocalBackend( + { + path: '/local-backend', + }, + maintenanceRequestOpts, + ); + + const { + repositories: [ + { + id: repositoryId, + snapshots: [{ id: snapshotId }], + }, + ], + } = await sdk.inspectRepositories({}, maintenanceRequestOpts); + + socket = io(baseUrl, { + path: '/api/yucca/socket.io', + transports: ['websocket'], + extraHeaders: { + cookie, + }, + }); + + const event = waitForMessage('TaskEnd'); + await sdk.restoreFromPoint( + repositoryId, + snapshotId, + backendId, + { + yuccaConfig: '/data/yucca', + include: ['/data'], + }, + maintenanceRequestOpts, + ); + + await event; + socket.disconnect(); + + const { status: restoreStatus } = await request(app).post('/admin/maintenance').set('Cookie', cookie).send({ + action: 'restore_database', + restoreBackupFilename: filename, + }); + + expect(restoreStatus).toBe(201); + + await expect + .poll( + async () => { + const { status, body } = await request(app).get('/server/config'); + expect(status).toBe(200); + return body.maintenanceMode; + }, + { + interval: 500, + timeout: 10_000, + }, + ) + .toBeTruthy(); + + const { status: status2, body } = await request(app).get('/admin/maintenance/status'); + expect(status2).toBe(200); + expect(body).toEqual( + expect.objectContaining({ + active: true, + action: 'restore_database', + }), + ); + + await expect + .poll( + async () => { + const { status, body } = await request(app).get('/server/config'); + expect(status).toBe(200); + return body.maintenanceMode; + }, + { + interval: 500, + timeout: 60_000, + }, + ) + .toBeFalsy(); + + await expect(sdk.getSchedules(requestOpts)).resolves.toEqual({ + schedules: expect.arrayContaining([expect.objectContaining({ id: expect.any(String) })]), + }); + }, + 60_000, + ); + }); +}); diff --git a/e2e/src/specs/maintenance/web/database-backups.e2e-spec.ts b/e2e/src/specs/maintenance/web/database-backups.e2e-spec.ts index d101215ceb889..044e1f5687dc3 100644 --- a/e2e/src/specs/maintenance/web/database-backups.e2e-spec.ts +++ b/e2e/src/specs/maintenance/web/database-backups.e2e-spec.ts @@ -95,6 +95,7 @@ test.describe('Database Backups', () => { await page.waitForURL('/maintenance**'); } + await page.getByRole('button', { name: 'Database Backup' }).click(); await page.getByRole('button', { name: 'Next' }).click(); await page.getByRole('button', { name: 'Restore', exact: true }).click(); await page.getByRole('dialog').getByRole('button', { name: 'Restore' }).click(); diff --git a/e2e/src/specs/maintenance/web/yucca-backups.e2e-spec.ts b/e2e/src/specs/maintenance/web/yucca-backups.e2e-spec.ts new file mode 100644 index 0000000000000..fc5ada8afcbd9 --- /dev/null +++ b/e2e/src/specs/maintenance/web/yucca-backups.e2e-spec.ts @@ -0,0 +1,148 @@ +import { + LoginResponseDto, + confirmRecoveryKey, + enableTelemetry, + importRecoveryKey, + resetOrchestrator, +} from '@immich/sdk'; +import { expect, test } from '@playwright/test'; +import { io, type Socket } from 'socket.io-client'; +import { asBearerAuth, baseUrl, utils } from 'src/utils'; + +test.describe.configure({ mode: 'serial' }); + +test.describe('Yucca Backups', () => { + let admin: LoginResponseDto; + let socket: Socket; + + const waitForTaskEnd = () => + new Promise((resolve) => { + const listener = (msg: string) => { + try { + const payload = JSON.parse(msg); + if (payload.type === 'TaskEnd') { + socket.offAny(listener); + resolve(); + } + } catch { + // no-op + } + }; + socket.onAny(listener); + }); + + test.beforeAll(async () => { + utils.initSdk(); + await utils.resetDatabase(); + admin = await utils.adminSetup(); + + const headers = asBearerAuth(admin.accessToken); + await resetOrchestrator({ headers }); + await importRecoveryKey({ importRecoveryKeyRequest: { recoveryKey: '0'.repeat(64) } }, { headers }); + await confirmRecoveryKey({ headers }); + await enableTelemetry({ headers }); + await utils.mkFolder('/local-backend'); + + socket = io(baseUrl, { + path: '/api/yucca/socket.io', + transports: ['websocket'], + extraHeaders: headers, + forceNew: true, + }); + await new Promise((resolve) => socket.on('connect', () => resolve())); + }); + + test.afterAll(async () => { + socket?.close(); + }); + + test('onboarding configures a local backend', async ({ context, page }) => { + test.setTimeout(30_000); + await utils.setAuthCookies(context, admin.accessToken); + + await page.goto('/admin/backups'); + + const dialog = page.getByRole('dialog'); + await expect(dialog.filter({ hasText: 'Backup options' })).toBeVisible(); + await dialog.getByText('Local Folder').click(); + + await expect(dialog.filter({ hasText: 'Create local backend' })).toBeVisible(); + await dialog.getByLabel('Path').fill('/local-backend'); + await dialog.getByRole('button', { name: 'Save' }).click(); + + await expect(dialog.filter({ hasText: 'Configure Your Immich Backup' })).toBeVisible(); + await dialog.getByRole('button', { name: 'Save' }).click(); + await expect(dialog).toHaveCount(0); + + await expect(page.getByRole('link', { name: 'Repositories' })).toBeVisible(); + }); + + test('manually triggers a backup and waits for completion', async ({ context, page }) => { + test.setTimeout(60_000); + await utils.setAuthCookies(context, admin.accessToken); + + await page.goto('/admin/backups/repositories'); + const backupNow = page.getByRole('button', { name: 'Backup Now' }); + await expect(backupNow).toBeVisible(); + + const taskEnd = waitForTaskEnd(); + await backupNow.click(); + await expect(page.getByRole('dialog').filter({ hasText: 'Log Output' })).toBeVisible(); + + await taskEnd; + }); + + test('resets immich and restores from the local yucca backup', async ({ context, page }) => { + test.setTimeout(120_000); + await utils.setAuthCookies(context, admin.accessToken); + + await utils.resetBackups(admin.accessToken); + await utils.createBackup(admin.accessToken); + + await resetOrchestrator({ headers: asBearerAuth(admin.accessToken) }); + await utils.resetDatabase(); + + await page.goto('/'); + await page.getByRole('button', { name: 'Restore from backup' }).click(); + + try { + await page.waitForURL('/maintenance**'); + } catch { + await page.goto('/maintenance'); + await page.waitForURL('/maintenance**'); + } + + await page.getByRole('button', { name: 'FUTO Backups' }).click(); + + const dialog = page.getByRole('dialog'); + await expect(dialog.filter({ hasText: 'Import recovery key' })).toBeVisible(); + await dialog.getByLabel('Recovery Key').fill('0'.repeat(64)); + await dialog.getByRole('button', { name: 'Save' }).click(); + + await expect(dialog.filter({ hasText: 'Where would you like to restore from?' })).toBeVisible(); + await dialog.getByText('Local Folder').click(); + + await expect(dialog.filter({ hasText: 'Create local backend' })).toBeVisible(); + await dialog.getByLabel('Path').fill('/local-backend'); + await dialog.getByRole('button', { name: 'Save' }).click(); + + await expect(dialog.filter({ hasText: 'Select Restore Point' })).toBeVisible(); + await dialog.getByRole('button', { name: 'Select' }).first().click(); + + await expect(dialog.filter({ hasText: /Restore from/ })).toBeVisible(); + await dialog.getByRole('button', { name: 'Restore' }).first().click(); + + await expect(dialog.filter({ hasText: 'Confirm restore from snapshot' })).toBeVisible(); + await dialog.getByRole('button', { name: 'Restore' }).click(); + + await expect(dialog.filter({ hasText: 'Restoring' })).toBeVisible(); + await expect(dialog.filter({ hasText: 'Restoring' })).toBeHidden({ timeout: 60_000 }); + + await page.getByRole('button', { name: 'Next' }).click(); + await page.getByRole('button', { name: 'Restore', exact: true }).click(); + await page.getByRole('dialog').getByRole('button', { name: 'Restore' }).click(); + + await page.waitForURL('/maintenance?**'); + await page.waitForURL('/photos', { timeout: 90_000 }); + }); +}); diff --git a/e2e/src/specs/server/api/server.e2e-spec.ts b/e2e/src/specs/server/api/server.e2e-spec.ts index f0eed82f7a72d..9b46ac50ac6ef 100644 --- a/e2e/src/specs/server/api/server.e2e-spec.ts +++ b/e2e/src/specs/server/api/server.e2e-spec.ts @@ -99,6 +99,7 @@ describe('/server', () => { configFile: false, duplicateDetection: false, facialRecognition: false, + backups: false, map: true, reverseGeocoding: true, importFaces: false, diff --git a/e2e/src/ui/mock-network/base-network.ts b/e2e/src/ui/mock-network/base-network.ts index af8d1dbfeff8e..e092f8d2f49d7 100644 --- a/e2e/src/ui/mock-network/base-network.ts +++ b/e2e/src/ui/mock-network/base-network.ts @@ -121,6 +121,7 @@ export const setupBaseMockApiRoutes = async (context: BrowserContext, adminUserI smartSearch: false, facialRecognition: false, duplicateDetection: false, + backups: false, map: true, reverseGeocoding: true, importFaces: false, diff --git a/e2e/src/utils.ts b/e2e/src/utils.ts index 3124dd0609f77..26a1d5c362030 100644 --- a/e2e/src/utils.ts +++ b/e2e/src/utils.ts @@ -31,6 +31,7 @@ import { createUserAdmin, deleteAssets, deleteDatabaseBackup, + deleteLibrary, getAssetInfo, getConfig, getConfigDefaults, @@ -462,6 +463,8 @@ export const utils = { updateLibrary: (accessToken: string, id: string, dto: UpdateLibraryDto) => updateLibrary({ id, updateLibraryDto: dto }, { headers: asBearerAuth(accessToken) }), + deleteLibrary: (accessToken: string, id: string) => deleteLibrary({ id }, { headers: asBearerAuth(accessToken) }), + createPartner: (accessToken: string, id: string) => createPartner({ partnerCreateDto: { sharedWithId: id } }, { headers: asBearerAuth(accessToken) }), diff --git a/i18n/en.json b/i18n/en.json index 536b7677ac0d8..1bd3c695704fd 100644 --- a/i18n/en.json +++ b/i18n/en.json @@ -1338,10 +1338,12 @@ "main_branch_warning": "You're using a development version; we strongly recommend using a release version!", "main_menu": "Main menu", "maintenance_action_restore": "Restoring Database", + "maintenance_action_rollback": "Restoring from Backup", "maintenance_description": "Immich has been put into maintenance mode.", "maintenance_end": "End maintenance mode", "maintenance_logged_in_as": "Currently logged in as {user}", "maintenance_restore_from_backup": "Restore From Backup", + "maintenance_restore_latest_backup_description": "We'll restore your database from the most recent backup. You can also pick a different one.", "maintenance_restore_library": "Restore Your Library", "maintenance_restore_library_confirm": "If this looks correct, continue to restoring a backup!", "maintenance_restore_library_description": "Restoring Database", @@ -1354,6 +1356,10 @@ "maintenance_restore_library_hint_regenerate_later": "You can regenerate these later in settings", "maintenance_restore_library_hint_storage_template_missing_files": "Using storage template? You may be missing files", "maintenance_restore_library_loading": "Loading integrity checks and heuristics…", + "maintenance_restore_loading_backups": "Loading backups…", + "maintenance_restore_no_backups": "There are no database backups.", + "maintenance_restore_select_another": "Select another backup", + "maintenance_restore_upload_backup": "Upload a backup", "maintenance_task_backup": "Creating a backup of the existing database…", "maintenance_task_migrations": "Running database migrations…", "maintenance_task_restore": "Restoring the chosen backup…", diff --git a/mise.lock b/mise.lock index 836712e0fd263..655e53a843b7a 100644 --- a/mise.lock +++ b/mise.lock @@ -4,101 +4,20 @@ version = "1.6.3" backend = "github:extism/cli" -[tools."github:extism/cli"."platforms.linux-arm64"] -checksum = "sha256:d92f830c9be39637569feacb04e9750c28848df6d9a219db94152a9b4eb9452b" -url = "https://github.com/extism/cli/releases/download/v1.6.3/extism-v1.6.3-linux-arm64.tar.gz" -url_api = "https://api.github.com/repos/extism/cli/releases/assets/275694030" - -[tools."github:extism/cli"."platforms.linux-arm64-musl"] -checksum = "sha256:d92f830c9be39637569feacb04e9750c28848df6d9a219db94152a9b4eb9452b" -url = "https://github.com/extism/cli/releases/download/v1.6.3/extism-v1.6.3-linux-arm64.tar.gz" -url_api = "https://api.github.com/repos/extism/cli/releases/assets/275694030" - [tools."github:extism/cli"."platforms.linux-x64"] checksum = "sha256:34e7ae9bfded6e2c32dee83f70a4e50d34f9d3e80d1762b09625fe82e214d02d" url = "https://github.com/extism/cli/releases/download/v1.6.3/extism-v1.6.3-linux-amd64.tar.gz" url_api = "https://api.github.com/repos/extism/cli/releases/assets/275694025" -[tools."github:extism/cli"."platforms.linux-x64-musl"] -checksum = "sha256:34e7ae9bfded6e2c32dee83f70a4e50d34f9d3e80d1762b09625fe82e214d02d" -url = "https://github.com/extism/cli/releases/download/v1.6.3/extism-v1.6.3-linux-amd64.tar.gz" -url_api = "https://api.github.com/repos/extism/cli/releases/assets/275694025" - -[tools."github:extism/cli"."platforms.macos-arm64"] -checksum = "sha256:b4ddbc575b5ac000115247f781723f9b9f284ed87b29c600539d72161b5b29fc" -url = "https://github.com/extism/cli/releases/download/v1.6.3/extism-v1.6.3-darwin-arm64.tar.gz" -url_api = "https://api.github.com/repos/extism/cli/releases/assets/275694029" - -[tools."github:extism/cli"."platforms.macos-x64"] -checksum = "sha256:9a2f71b6e6009685a622cc3084e52d2a1a8e23c98d29ffa72e666e9dc699855f" -url = "https://github.com/extism/cli/releases/download/v1.6.3/extism-v1.6.3-darwin-amd64.tar.gz" -url_api = "https://api.github.com/repos/extism/cli/releases/assets/275694026" - -[tools."github:extism/cli"."platforms.windows-x64"] -checksum = "sha256:47e4ed2782445b2b08a4d1ac127211588f8b4d1fc25fd6481d4cb65151b5213c" -url = "https://github.com/extism/cli/releases/download/v1.6.3/extism-v1.6.3-windows-amd64.zip" -url_api = "https://api.github.com/repos/extism/cli/releases/assets/275694035" - [[tools."github:extism/js-pdk"]] version = "1.6.0" backend = "github:extism/js-pdk" -[tools."github:extism/js-pdk"."platforms.linux-arm64"] -checksum = "sha256:15a186250e68d6bff4ec839fff275d45a90e383a69209dcc1239eb9e3aee6e1b" -url = "https://github.com/extism/js-pdk/releases/download/v1.6.0/extism-js-aarch64-linux-v1.6.0.gz" -url_api = "https://api.github.com/repos/extism/js-pdk/releases/assets/353223214" - -[tools."github:extism/js-pdk"."platforms.linux-arm64-musl"] -checksum = "sha256:15a186250e68d6bff4ec839fff275d45a90e383a69209dcc1239eb9e3aee6e1b" -url = "https://github.com/extism/js-pdk/releases/download/v1.6.0/extism-js-aarch64-linux-v1.6.0.gz" -url_api = "https://api.github.com/repos/extism/js-pdk/releases/assets/353223214" - [tools."github:extism/js-pdk"."platforms.linux-x64"] checksum = "sha256:4ded271ccf465031ccd0dc35e7a140e134d7f30721671cc4a8e1ff805d4aad68" url = "https://github.com/extism/js-pdk/releases/download/v1.6.0/extism-js-x86_64-linux-v1.6.0.gz" url_api = "https://api.github.com/repos/extism/js-pdk/releases/assets/353223119" -[tools."github:extism/js-pdk"."platforms.linux-x64-musl"] -checksum = "sha256:4ded271ccf465031ccd0dc35e7a140e134d7f30721671cc4a8e1ff805d4aad68" -url = "https://github.com/extism/js-pdk/releases/download/v1.6.0/extism-js-x86_64-linux-v1.6.0.gz" -url_api = "https://api.github.com/repos/extism/js-pdk/releases/assets/353223119" - -[tools."github:extism/js-pdk"."platforms.macos-arm64"] -checksum = "sha256:548e25bda3971a07c32d78a249135cf8cb7b3eede101e878e06e53e01ac2e0ce" -url = "https://github.com/extism/js-pdk/releases/download/v1.6.0/extism-js-aarch64-macos-v1.6.0.gz" -url_api = "https://api.github.com/repos/extism/js-pdk/releases/assets/353223215" - -[tools."github:extism/js-pdk"."platforms.macos-x64"] -checksum = "sha256:d85a875c2a071f0c29fe572764c52c3a499f157ab7f9efac8939a4364390e29b" -url = "https://github.com/extism/js-pdk/releases/download/v1.6.0/extism-js-x86_64-macos-v1.6.0.gz" -url_api = "https://api.github.com/repos/extism/js-pdk/releases/assets/353223239" - -[tools."github:extism/js-pdk"."platforms.windows-x64"] -checksum = "sha256:97b7b746141e4777e1ca2b76febdeb16dc9d314ff6a4257df05a476b67228acc" -url = "https://github.com/extism/js-pdk/releases/download/v1.6.0/extism-js-x86_64-windows-v1.6.0.gz" -url_api = "https://api.github.com/repos/extism/js-pdk/releases/assets/353224133" - -[[tools."github:jellyfin/jellyfin-ffmpeg"]] -version = "7.1.3-6" -backend = "github:jellyfin/jellyfin-ffmpeg" - -[tools."github:jellyfin/jellyfin-ffmpeg"."platforms.windows-x64"] -checksum = "sha256:7b7168149689610296f3a187c717056ce0786cc125a31caf28056737e9ba1cc1" -url = "https://github.com/jellyfin/jellyfin-ffmpeg/releases/download/v7.1.3-6/jellyfin-ffmpeg_7.1.3-6_portable_win64-clang-gpl.zip" -url_api = "https://api.github.com/repos/jellyfin/jellyfin-ffmpeg/releases/assets/409036094" - -[[tools."github:jellyfin/jellyfin-ffmpeg"]] -version = "7.1.3-6" -backend = "github:jellyfin/jellyfin-ffmpeg" - -[tools."github:jellyfin/jellyfin-ffmpeg".options] -asset_pattern = "jellyfin-ffmpeg_*_portable_macarm64-gpl.tar.xz" - -[tools."github:jellyfin/jellyfin-ffmpeg"."platforms.macos-arm64"] -checksum = "sha256:e024d5e78d5414e75f0181036cd21373fafb9270c72894dfd7dbda2572439820" -url = "https://github.com/jellyfin/jellyfin-ffmpeg/releases/download/v7.1.3-6/jellyfin-ffmpeg_7.1.3-6_portable_macarm64-gpl.tar.xz" -url_api = "https://api.github.com/repos/jellyfin/jellyfin-ffmpeg/releases/assets/408995838" - [[tools."github:jellyfin/jellyfin-ffmpeg"]] version = "7.1.3-6" backend = "github:jellyfin/jellyfin-ffmpeg" @@ -111,79 +30,15 @@ checksum = "sha256:39e99a7927468a6abec5f65d00f55010e8ff2ae3c2605294f179c94f6ae21 url = "https://github.com/jellyfin/jellyfin-ffmpeg/releases/download/v7.1.3-6/jellyfin-ffmpeg_7.1.3-6_portable_linux64-gpl.tar.xz" url_api = "https://api.github.com/repos/jellyfin/jellyfin-ffmpeg/releases/assets/409048879" -[tools."github:jellyfin/jellyfin-ffmpeg"."platforms.linux-x64-musl"] -checksum = "sha256:39e99a7927468a6abec5f65d00f55010e8ff2ae3c2605294f179c94f6ae21af2" -url = "https://github.com/jellyfin/jellyfin-ffmpeg/releases/download/v7.1.3-6/jellyfin-ffmpeg_7.1.3-6_portable_linux64-gpl.tar.xz" -url_api = "https://api.github.com/repos/jellyfin/jellyfin-ffmpeg/releases/assets/409048879" - -[[tools."github:jellyfin/jellyfin-ffmpeg"]] -version = "7.1.3-6" -backend = "github:jellyfin/jellyfin-ffmpeg" - -[tools."github:jellyfin/jellyfin-ffmpeg".options] -asset_pattern = "jellyfin-ffmpeg_*_portable_mac64-gpl.tar.xz" - -[tools."github:jellyfin/jellyfin-ffmpeg"."platforms.macos-x64"] -checksum = "sha256:066ede9774aaae97a18098aaeea8b7e0d286653eb8618f640476e99c59a536c2" -url = "https://github.com/jellyfin/jellyfin-ffmpeg/releases/download/v7.1.3-6/jellyfin-ffmpeg_7.1.3-6_portable_mac64-gpl.tar.xz" -url_api = "https://api.github.com/repos/jellyfin/jellyfin-ffmpeg/releases/assets/408995889" - -[[tools."github:jellyfin/jellyfin-ffmpeg"]] -version = "7.1.3-6" -backend = "github:jellyfin/jellyfin-ffmpeg" - -[tools."github:jellyfin/jellyfin-ffmpeg".options] -asset_pattern = "jellyfin-ffmpeg_*_portable_linuxarm64-gpl.tar.xz" - -[tools."github:jellyfin/jellyfin-ffmpeg"."platforms.linux-arm64"] -checksum = "sha256:bea03c670e8cc5bfe9edc0c5d624d4735421610cef5e808db93e7d8596952886" -url = "https://github.com/jellyfin/jellyfin-ffmpeg/releases/download/v7.1.3-6/jellyfin-ffmpeg_7.1.3-6_portable_linuxarm64-gpl.tar.xz" -url_api = "https://api.github.com/repos/jellyfin/jellyfin-ffmpeg/releases/assets/409048876" - -[tools."github:jellyfin/jellyfin-ffmpeg"."platforms.linux-arm64-musl"] -checksum = "sha256:bea03c670e8cc5bfe9edc0c5d624d4735421610cef5e808db93e7d8596952886" -url = "https://github.com/jellyfin/jellyfin-ffmpeg/releases/download/v7.1.3-6/jellyfin-ffmpeg_7.1.3-6_portable_linuxarm64-gpl.tar.xz" -url_api = "https://api.github.com/repos/jellyfin/jellyfin-ffmpeg/releases/assets/409048876" - [[tools."github:webassembly/binaryen"]] version = "version_124" backend = "github:webassembly/binaryen" -[tools."github:webassembly/binaryen"."platforms.linux-arm64"] -checksum = "sha256:6291bd9a57d8e046f3bc099a4db386c147433a87f71c783a901c5b1792e38de3" -url = "https://github.com/WebAssembly/binaryen/releases/download/version_124/binaryen-version_124-aarch64-linux.tar.gz" -url_api = "https://api.github.com/repos/WebAssembly/binaryen/releases/assets/288927659" - -[tools."github:webassembly/binaryen"."platforms.linux-arm64-musl"] -checksum = "sha256:6291bd9a57d8e046f3bc099a4db386c147433a87f71c783a901c5b1792e38de3" -url = "https://github.com/WebAssembly/binaryen/releases/download/version_124/binaryen-version_124-aarch64-linux.tar.gz" -url_api = "https://api.github.com/repos/WebAssembly/binaryen/releases/assets/288927659" - [tools."github:webassembly/binaryen"."platforms.linux-x64"] checksum = "sha256:0290c3779fedf592b8da0ded3032ff55c41a2b7bfa2d6bf7b7bac6f0e6e28963" url = "https://github.com/WebAssembly/binaryen/releases/download/version_124/binaryen-version_124-x86_64-linux.tar.gz" url_api = "https://api.github.com/repos/WebAssembly/binaryen/releases/assets/288926769" -[tools."github:webassembly/binaryen"."platforms.linux-x64-musl"] -checksum = "sha256:0290c3779fedf592b8da0ded3032ff55c41a2b7bfa2d6bf7b7bac6f0e6e28963" -url = "https://github.com/WebAssembly/binaryen/releases/download/version_124/binaryen-version_124-x86_64-linux.tar.gz" -url_api = "https://api.github.com/repos/WebAssembly/binaryen/releases/assets/288926769" - -[tools."github:webassembly/binaryen"."platforms.macos-arm64"] -checksum = "sha256:86a2c960ff62c6d2ea6009d1f89745c22c70100d394a095eab45eb941bdaa24c" -url = "https://github.com/WebAssembly/binaryen/releases/download/version_124/binaryen-version_124-arm64-macos.tar.gz" -url_api = "https://api.github.com/repos/WebAssembly/binaryen/releases/assets/288926134" - -[tools."github:webassembly/binaryen"."platforms.macos-x64"] -checksum = "sha256:b389bb0731758d86c3cb266d01d28a12725c23bd3cabc3df34faa162af0887e9" -url = "https://github.com/WebAssembly/binaryen/releases/download/version_124/binaryen-version_124-x86_64-macos.tar.gz" -url_api = "https://api.github.com/repos/WebAssembly/binaryen/releases/assets/288926135" - -[tools."github:webassembly/binaryen"."platforms.windows-x64"] -checksum = "sha256:b5e1d2a1ad3c03229ddc89823848f4a1c11f9c6402a51fa26f0aaa5f1d7a2203" -url = "https://github.com/WebAssembly/binaryen/releases/download/version_124/binaryen-version_124-x86_64-windows.tar.gz" -url_api = "https://api.github.com/repos/WebAssembly/binaryen/releases/assets/288925833" - [[tools.java]] version = "21.0.2" backend = "core:java" @@ -191,58 +46,18 @@ backend = "core:java" [tools.java.options] shorthand_vendor = "openjdk" -[tools.java."platforms.linux-arm64"] -checksum = "sha256:08db1392a48d4eb5ea5315cf8f18b89dbaf36cda663ba882cf03c704c9257ec2" -url = "https://download.java.net/java/GA/jdk21.0.2/f2283984656d49d69e91c558476027ac/13/GPL/openjdk-21.0.2_linux-aarch64_bin.tar.gz" - [tools.java."platforms.linux-x64"] checksum = "sha256:a2def047a73941e01a73739f92755f86b895811afb1f91243db214cff5bdac3f" url = "https://download.java.net/java/GA/jdk21.0.2/f2283984656d49d69e91c558476027ac/13/GPL/openjdk-21.0.2_linux-x64_bin.tar.gz" -[tools.java."platforms.macos-arm64"] -checksum = "sha256:b3d588e16ec1e0ef9805d8a696591bd518a5cea62567da8f53b5ce32d11d22e4" -url = "https://download.java.net/java/GA/jdk21.0.2/f2283984656d49d69e91c558476027ac/13/GPL/openjdk-21.0.2_macos-aarch64_bin.tar.gz" - -[tools.java."platforms.macos-x64"] -checksum = "sha256:8fd09e15dc406387a0aba70bf5d99692874e999bf9cd9208b452b5d76ac922d3" -url = "https://download.java.net/java/GA/jdk21.0.2/f2283984656d49d69e91c558476027ac/13/GPL/openjdk-21.0.2_macos-x64_bin.tar.gz" - -[tools.java."platforms.windows-x64"] -checksum = "sha256:b6c17e747ae78cdd6de4d7532b3164b277daee97c007d3eaa2b39cca99882664" -url = "https://download.java.net/java/GA/jdk21.0.2/f2283984656d49d69e91c558476027ac/13/GPL/openjdk-21.0.2_windows-x64_bin.zip" - [[tools.node]] version = "24.15.0" backend = "core:node" -[tools.node."platforms.linux-arm64"] -checksum = "sha256:73afc234d558c24919875f51c2d1ea002a2ada4ea6f83601a383869fefa64eed" -url = "https://nodejs.org/dist/v24.15.0/node-v24.15.0-linux-arm64.tar.gz" - -[tools.node."platforms.linux-arm64-musl"] -checksum = "sha256:31e98aa960a067da91edffd5d93bc46657b5d2a8029612c359f5f2ac0060152a" -url = "https://unofficial-builds.nodejs.org/download/release/v24.15.0/node-v24.15.0-linux-arm64-musl.tar.gz" - [tools.node."platforms.linux-x64"] checksum = "sha256:44836872d9aec49f1e6b52a9a922872db9a2b02d235a616a5681b6a85fec8d89" url = "https://nodejs.org/dist/v24.15.0/node-v24.15.0-linux-x64.tar.gz" -[tools.node."platforms.linux-x64-musl"] -checksum = "sha256:f55af5bd489c5347b113ca6594cae00a54b30ba57ac5875324311bfc6f4762e3" -url = "https://unofficial-builds.nodejs.org/download/release/v24.15.0/node-v24.15.0-linux-x64-musl.tar.gz" - -[tools.node."platforms.macos-arm64"] -checksum = "sha256:372331b969779ab5d15b949884fc6eaf88d5afe87bde8ba881d6400b9100ffc4" -url = "https://nodejs.org/dist/v24.15.0/node-v24.15.0-darwin-arm64.tar.gz" - -[tools.node."platforms.macos-x64"] -checksum = "sha256:ffd5ee293467927f3ee731a553eb88fd1f48cf74eebc2d74a6babe4af228673b" -url = "https://nodejs.org/dist/v24.15.0/node-v24.15.0-darwin-x64.tar.gz" - -[tools.node."platforms.windows-x64"] -checksum = "sha256:cc5149eabd53779ce1e7bdc5401643622d0c7e6800ade18928a767e940bb0e62" -url = "https://nodejs.org/dist/v24.15.0/node-v24.15.0-win-x64.zip" - [[tools."npm:@openapitools/openapi-generator-cli"]] version = "2.40.1" backend = "npm:@openapitools/openapi-generator-cli" @@ -255,116 +70,35 @@ backend = "npm:oazapfts" version = "1.12.5" backend = "aqua:opentofu/opentofu" -[tools.opentofu."platforms.linux-arm64"] -checksum = "sha256:e67e9da2b1ddf5050ebee62a584cb826eafe1dfd3827d7ec20899ac62791ed1a" -url = "https://github.com/opentofu/opentofu/releases/download/v1.12.5/tofu_1.12.5_linux_arm64.tar.gz" -url_api = "https://api.github.com/repos/opentofu/opentofu/releases/assets/484602545" - -[tools.opentofu."platforms.linux-arm64-musl"] -checksum = "sha256:e67e9da2b1ddf5050ebee62a584cb826eafe1dfd3827d7ec20899ac62791ed1a" -url = "https://github.com/opentofu/opentofu/releases/download/v1.12.5/tofu_1.12.5_linux_arm64.tar.gz" -url_api = "https://api.github.com/repos/opentofu/opentofu/releases/assets/484602545" - [tools.opentofu."platforms.linux-x64"] checksum = "sha256:a6894d45ae7a17ce83189cce8fe04b5a65f68cefceb62455b5a6a89fa53ab38f" url = "https://github.com/opentofu/opentofu/releases/download/v1.12.5/tofu_1.12.5_linux_amd64.tar.gz" url_api = "https://api.github.com/repos/opentofu/opentofu/releases/assets/484602624" -[tools.opentofu."platforms.linux-x64-musl"] -checksum = "sha256:a6894d45ae7a17ce83189cce8fe04b5a65f68cefceb62455b5a6a89fa53ab38f" -url = "https://github.com/opentofu/opentofu/releases/download/v1.12.5/tofu_1.12.5_linux_amd64.tar.gz" -url_api = "https://api.github.com/repos/opentofu/opentofu/releases/assets/484602624" - -[tools.opentofu."platforms.macos-arm64"] -checksum = "sha256:2ae38150a667f5c0bd57b318d18ad8091d08f93fcca40345f3d88998661de5a9" -url = "https://github.com/opentofu/opentofu/releases/download/v1.12.5/tofu_1.12.5_darwin_arm64.tar.gz" -url_api = "https://api.github.com/repos/opentofu/opentofu/releases/assets/484602544" - -[tools.opentofu."platforms.macos-x64"] -checksum = "sha256:1012d8f3d4567bcbcd1f2c7d766feca39a30bced32fb8be47e1887fbbee2456d" -url = "https://github.com/opentofu/opentofu/releases/download/v1.12.5/tofu_1.12.5_darwin_amd64.tar.gz" -url_api = "https://api.github.com/repos/opentofu/opentofu/releases/assets/484602621" - -[tools.opentofu."platforms.windows-x64"] -checksum = "sha256:af11850b496f3720e0184084c56d8b43aa74ea92d2338978bf368d70c96473f1" -url = "https://github.com/opentofu/opentofu/releases/download/v1.12.5/tofu_1.12.5_windows_amd64.tar.gz" -url_api = "https://api.github.com/repos/opentofu/opentofu/releases/assets/484602547" - [[tools.pnpm]] version = "11.20.0" backend = "aqua:pnpm/pnpm" -[tools.pnpm."platforms.linux-arm64"] -checksum = "sha256:f00fc2041bb41742b7943bf2bb24183ad20320e8384824a8031eb94edf2f57a5" -url = "https://github.com/pnpm/pnpm/releases/download/v11.20.0/pnpm-linux-arm64.tar.gz" -url_api = "https://api.github.com/repos/pnpm/pnpm/releases/assets/500142378" -provenance = "github-attestations" - -[tools.pnpm."platforms.linux-arm64-musl"] -checksum = "sha256:2a21235d3f0fbfbcb9e530b9a98f2c64dcee95d1d5d1c2d04428255c7b85f32c" -url = "https://github.com/pnpm/pnpm/releases/download/v11.20.0/pnpm-linux-arm64-musl.tar.gz" -url_api = "https://api.github.com/repos/pnpm/pnpm/releases/assets/500142372" -provenance = "github-attestations" - [tools.pnpm."platforms.linux-x64"] checksum = "sha256:b4ad6ad2b21db2f8cd50af416c3aa148ba704c31c84893f465a770a01c2c4572" url = "https://github.com/pnpm/pnpm/releases/download/v11.20.0/pnpm-linux-x64.tar.gz" url_api = "https://api.github.com/repos/pnpm/pnpm/releases/assets/500142376" provenance = "github-attestations" -[tools.pnpm."platforms.linux-x64-musl"] -checksum = "sha256:db046881c027f1a2d69e9a530a21a62c2bced4ba8ff437e7300426ae56951fe4" -url = "https://github.com/pnpm/pnpm/releases/download/v11.20.0/pnpm-linux-x64-musl.tar.gz" -url_api = "https://api.github.com/repos/pnpm/pnpm/releases/assets/500142377" -provenance = "github-attestations" +[[tools.restic]] +version = "0.19.0" +backend = "aqua:restic/restic" -[tools.pnpm."platforms.macos-arm64"] -checksum = "sha256:4bc97fea72e5c92eec1fefc8d410c35d01e0d0d52f3160c59f38c32db58b5cd2" -url = "https://github.com/pnpm/pnpm/releases/download/v11.20.0/pnpm-darwin-arm64.tar.gz" -url_api = "https://api.github.com/repos/pnpm/pnpm/releases/assets/500142373" -provenance = "github-attestations" - -[tools.pnpm."platforms.windows-x64"] -checksum = "sha256:ea2528bdc3d96a1ff3c35587dc48ca692b39d77f08f26df4adeaaa9eb427024e" -url = "https://github.com/pnpm/pnpm/releases/download/v11.20.0/pnpm-win32-x64.zip" -url_api = "https://api.github.com/repos/pnpm/pnpm/releases/assets/500142371" -provenance = "github-attestations" +[tools.restic."platforms.linux-x64"] +checksum = "sha256:13176fe6d89d4357947a2cd107218ab2873a5f9d8e1ac2d4cd1c8e07e6839c21" +url = "https://github.com/restic/restic/releases/download/v0.19.0/restic_0.19.0_linux_amd64.bz2" +url_api = "https://api.github.com/repos/restic/restic/releases/assets/442897993" [[tools.terragrunt]] version = "1.1.1" backend = "aqua:gruntwork-io/terragrunt" -[tools.terragrunt."platforms.linux-arm64"] -checksum = "sha256:a374a7993ff3d99665a7e014007d3647ec7f0465c9d55c85e9f94c932e73cea2" -url = "https://github.com/gruntwork-io/terragrunt/releases/download/v1.1.1/terragrunt_linux_arm64.tar.gz" -url_api = "https://api.github.com/repos/gruntwork-io/terragrunt/releases/assets/476786148" - -[tools.terragrunt."platforms.linux-arm64-musl"] -checksum = "sha256:a374a7993ff3d99665a7e014007d3647ec7f0465c9d55c85e9f94c932e73cea2" -url = "https://github.com/gruntwork-io/terragrunt/releases/download/v1.1.1/terragrunt_linux_arm64.tar.gz" -url_api = "https://api.github.com/repos/gruntwork-io/terragrunt/releases/assets/476786148" - [tools.terragrunt."platforms.linux-x64"] checksum = "sha256:ce90077ac31ef17a2ba10d11d45f36c6501997a8f4f79d703bb7daba37032f53" url = "https://github.com/gruntwork-io/terragrunt/releases/download/v1.1.1/terragrunt_linux_amd64.tar.gz" url_api = "https://api.github.com/repos/gruntwork-io/terragrunt/releases/assets/476785968" - -[tools.terragrunt."platforms.linux-x64-musl"] -checksum = "sha256:ce90077ac31ef17a2ba10d11d45f36c6501997a8f4f79d703bb7daba37032f53" -url = "https://github.com/gruntwork-io/terragrunt/releases/download/v1.1.1/terragrunt_linux_amd64.tar.gz" -url_api = "https://api.github.com/repos/gruntwork-io/terragrunt/releases/assets/476785968" - -[tools.terragrunt."platforms.macos-arm64"] -checksum = "sha256:9ec8f678b9ae6c81d5d9d77b94cbf6349ce639d5938694b4adc9dea73e416794" -url = "https://github.com/gruntwork-io/terragrunt/releases/download/v1.1.1/terragrunt_darwin_arm64.tar.gz" -url_api = "https://api.github.com/repos/gruntwork-io/terragrunt/releases/assets/476785628" - -[tools.terragrunt."platforms.macos-x64"] -checksum = "sha256:73e768a69fa44a60f9d9174f54aaf179327e08706f633c9c79d5f5c9622c91c2" -url = "https://github.com/gruntwork-io/terragrunt/releases/download/v1.1.1/terragrunt_darwin_amd64.tar.gz" -url_api = "https://api.github.com/repos/gruntwork-io/terragrunt/releases/assets/476785520" - -[tools.terragrunt."platforms.windows-x64"] -checksum = "sha256:dd50a324691e072a3ac879e9ec43d6310e2936c929fda658eb2811fefcc75115" -url = "https://github.com/gruntwork-io/terragrunt/releases/download/v1.1.1/terragrunt_windows_amd64.exe.tar.gz" -url_api = "https://api.github.com/repos/gruntwork-io/terragrunt/releases/assets/476786421" diff --git a/mise.toml b/mise.toml index 0039dbac2de62..93ecbb0f7aa43 100644 --- a/mise.toml +++ b/mise.toml @@ -24,6 +24,7 @@ opentofu = "1.12.5" "github:extism/cli" = "1.6.3" "github:webassembly/binaryen" = "version_124" "github:extism/js-pdk" = "1.6.0" +restic = "0.19.0" java = "21.0.2" [tools."github:jellyfin/jellyfin-ffmpeg"] diff --git a/mobile/openapi/.openapi-generator/FILES b/mobile/openapi/.openapi-generator/FILES new file mode 100644 index 0000000000000..1f86dca9eaacf --- /dev/null +++ b/mobile/openapi/.openapi-generator/FILES @@ -0,0 +1,1448 @@ +.gitignore +.openapi-generator-ignore +.travis.yml +README.md +analysis_options.yaml +doc/APIKeysApi.md +doc/ActiveScheduleItemDto.md +doc/ActivitiesApi.md +doc/ActivityCreateDto.md +doc/ActivityResponseDto.md +doc/ActivityStatisticsResponseDto.md +doc/AddUsersDto.md +doc/AdminOnboardingUpdateDto.md +doc/AlbumResponseDto.md +doc/AlbumStatisticsResponseDto.md +doc/AlbumUserAddDto.md +doc/AlbumUserCreateDto.md +doc/AlbumUserResponseDto.md +doc/AlbumUserRole.md +doc/AlbumsAddAssetsDto.md +doc/AlbumsAddAssetsResponseDto.md +doc/AlbumsApi.md +doc/AlbumsResponse.md +doc/AlbumsUpdate.md +doc/ApiKeyCreateDto.md +doc/ApiKeyCreateResponseDto.md +doc/ApiKeyResponseDto.md +doc/ApiKeyUpdateDto.md +doc/AssetBulkDeleteDto.md +doc/AssetBulkUpdateDto.md +doc/AssetBulkUploadCheckDto.md +doc/AssetBulkUploadCheckItem.md +doc/AssetBulkUploadCheckResponseDto.md +doc/AssetBulkUploadCheckResult.md +doc/AssetCopyDto.md +doc/AssetEditAction.md +doc/AssetEditActionItemDto.md +doc/AssetEditActionItemDtoParameters.md +doc/AssetEditActionItemResponseDto.md +doc/AssetEditsCreateDto.md +doc/AssetEditsResponseDto.md +doc/AssetFaceCreateDto.md +doc/AssetFaceDeleteDto.md +doc/AssetFaceResponseDto.md +doc/AssetFaceUpdateDto.md +doc/AssetFaceUpdateItem.md +doc/AssetIdErrorReason.md +doc/AssetIdsDto.md +doc/AssetIdsResponseDto.md +doc/AssetJobName.md +doc/AssetJobsDto.md +doc/AssetMediaResponseDto.md +doc/AssetMediaSize.md +doc/AssetMediaStatus.md +doc/AssetMetadataBulkDeleteDto.md +doc/AssetMetadataBulkDeleteItemDto.md +doc/AssetMetadataBulkResponseDto.md +doc/AssetMetadataBulkUpsertDto.md +doc/AssetMetadataBulkUpsertItemDto.md +doc/AssetMetadataResponseDto.md +doc/AssetMetadataUpsertDto.md +doc/AssetMetadataUpsertItemDto.md +doc/AssetOcrResponseDto.md +doc/AssetOrder.md +doc/AssetOrderBy.md +doc/AssetRejectReason.md +doc/AssetResponseDto.md +doc/AssetStackResponseDto.md +doc/AssetStatsResponseDto.md +doc/AssetTypeEnum.md +doc/AssetUploadAction.md +doc/AssetVisibility.md +doc/AssetsApi.md +doc/AudioCodec.md +doc/AuthApi.md +doc/AuthStatusResponseDto.md +doc/AuthenticationAdminApi.md +doc/AuthenticationApi.md +doc/AvatarUpdate.md +doc/BackendApi.md +doc/BackendDto.md +doc/BackendResponseDto.md +doc/BackendType.md +doc/BackendsResponseDto.md +doc/BootstrapStatus.md +doc/BulkIdErrorReason.md +doc/BulkIdResponseDto.md +doc/BulkIdsDto.md +doc/CLIPConfig.md +doc/CQMode.md +doc/CalendarHeatmapResponseDto.md +doc/CalendarHeatmapResponseDtoSeriesInner.md +doc/CalendarHeatmapType.md +doc/CastResponse.md +doc/CastUpdate.md +doc/ChangePasswordDto.md +doc/Colorspace.md +doc/ConfigureImmichIntegrationRequestDto.md +doc/ConfigureImmichIntegrationRequestDtoLibraries.md +doc/ContributorCountResponseDto.md +doc/CreateAlbumDto.md +doc/CreateLibraryDto.md +doc/CreateLocalBackendRequestDto.md +doc/CreateProfileImageResponseDto.md +doc/CropParameters.md +doc/CurrentRecoveryKeyResponse.md +doc/DatabaseBackupConfig.md +doc/DatabaseBackupDeleteDto.md +doc/DatabaseBackupDto.md +doc/DatabaseBackupListResponseDto.md +doc/DatabaseBackupsAdminApi.md +doc/DeprecatedApi.md +doc/DevelopmentApi.md +doc/DeviceFlowResponseDto.md +doc/DownloadApi.md +doc/DownloadArchiveDto.md +doc/DownloadArchiveInfo.md +doc/DownloadInfoDto.md +doc/DownloadResponse.md +doc/DownloadResponseDto.md +doc/DownloadUpdate.md +doc/DuplicateDetectionConfig.md +doc/DuplicateResolveDto.md +doc/DuplicateResolveGroupDto.md +doc/DuplicateResponseDto.md +doc/DuplicatesApi.md +doc/EmailNotificationsResponse.md +doc/EmailNotificationsUpdate.md +doc/ExifResponseDto.md +doc/FaceDto.md +doc/FacesApi.md +doc/FacialRecognitionConfig.md +doc/FilesystemApi.md +doc/FilesystemListingItemDto.md +doc/FilesystemListingResponseDto.md +doc/FoldersResponse.md +doc/FoldersUpdate.md +doc/HlsVideoResolution.md +doc/ImageFormat.md +doc/ImmichIntegrationConfigurationDto.md +doc/ImmichIntegrationDto.md +doc/ImmichLibraryDto.md +doc/ImmichRollbackRequestDto.md +doc/ImmichStateDto.md +doc/ImportRecoveryKeyRequest.md +doc/InspectedLocalRepositoryDto.md +doc/IntegrationsApi.md +doc/IntegrationsResponseDto.md +doc/IntegrityReport.md +doc/IntegrityReportResponseDto.md +doc/IntegrityReportResponseDtoItemsInner.md +doc/IntegrityReportSummaryResponseDto.md +doc/JobCreateDto.md +doc/JobName.md +doc/JobSettingsDto.md +doc/JobsApi.md +doc/LibrariesApi.md +doc/LibraryResponseDto.md +doc/LibraryStatsResponseDto.md +doc/LicenseKeyDto.md +doc/ListSnapshotsResponseDto.md +doc/LocalRepositoryDto.md +doc/LogLevel.md +doc/LogResponseDto.md +doc/LoginCredentialDto.md +doc/LoginResponseDto.md +doc/LogoutResponseDto.md +doc/MachineLearningAvailabilityChecksDto.md +doc/MaintenanceAction.md +doc/MaintenanceAdminApi.md +doc/MaintenanceAuthDto.md +doc/MaintenanceDetectInstallResponseDto.md +doc/MaintenanceDetectInstallStorageFolderDto.md +doc/MaintenanceLoginDto.md +doc/MaintenanceStatusResponseDto.md +doc/ManualJobName.md +doc/MapApi.md +doc/MapMarkerResponseDto.md +doc/MapReverseGeocodeResponseDto.md +doc/MemoriesApi.md +doc/MemoriesResponse.md +doc/MemoriesUpdate.md +doc/MemoryCreateDto.md +doc/MemoryResponseDto.md +doc/MemorySearchOrder.md +doc/MemoryStatisticsResponseDto.md +doc/MemoryType.md +doc/MemoryUpdateDto.md +doc/MergePersonDto.md +doc/MetadataSearchDto.md +doc/MirrorAxis.md +doc/MirrorParameters.md +doc/NotificationCreateDto.md +doc/NotificationDeleteAllDto.md +doc/NotificationDto.md +doc/NotificationLevel.md +doc/NotificationType.md +doc/NotificationUpdateAllDto.md +doc/NotificationUpdateDto.md +doc/NotificationsAdminApi.md +doc/NotificationsApi.md +doc/OAuthAuthorizeResponseDto.md +doc/OAuthCallbackDto.md +doc/OAuthConfigDto.md +doc/OAuthTokenEndpointAuthMethod.md +doc/OcrConfig.md +doc/OnThisDayDto.md +doc/OnboardingApi.md +doc/OnboardingDto.md +doc/OnboardingResponseDto.md +doc/OnboardingStatusResponseDto.md +doc/PartnerCreateDto.md +doc/PartnerDirection.md +doc/PartnerResponseDto.md +doc/PartnerUpdateDto.md +doc/PartnersApi.md +doc/PeopleApi.md +doc/PeopleResponse.md +doc/PeopleResponseDto.md +doc/PeopleUpdate.md +doc/PeopleUpdateDto.md +doc/PeopleUpdateItem.md +doc/Permission.md +doc/PersonCreateDto.md +doc/PersonResponseDto.md +doc/PersonStatisticsResponseDto.md +doc/PersonUpdateDto.md +doc/PinCodeChangeDto.md +doc/PinCodeResetDto.md +doc/PinCodeSetupDto.md +doc/PlacesResponseDto.md +doc/PluginMethodResponseDto.md +doc/PluginResponseDto.md +doc/PluginTemplateResponseDto.md +doc/PluginTemplateStepResponseDto.md +doc/PluginsApi.md +doc/PurchaseResponse.md +doc/PurchaseUpdate.md +doc/QueueCommand.md +doc/QueueCommandDto.md +doc/QueueDeleteDto.md +doc/QueueJobResponseDto.md +doc/QueueJobStatus.md +doc/QueueName.md +doc/QueueResponseDto.md +doc/QueueResponseLegacyDto.md +doc/QueueStatisticsDto.md +doc/QueueStatusLegacyDto.md +doc/QueueUpdateDto.md +doc/QueuesApi.md +doc/QueuesResponseLegacyDto.md +doc/RandomSearchDto.md +doc/RatingsResponse.md +doc/RatingsUpdate.md +doc/ReactionLevel.md +doc/ReactionType.md +doc/RecentlyAddedResponse.md +doc/RecentlyAddedUpdate.md +doc/ReleaseChannel.md +doc/ReleaseEventV1.md +doc/ReleaseType.md +doc/RepositoryApi.md +doc/RepositoryBackendDto.md +doc/RepositoryBackendsDto.md +doc/RepositoryCheckImportResponseDto.md +doc/RepositoryConfigurationDto.md +doc/RepositoryCreateRequestDto.md +doc/RepositoryCreateResponseDto.md +doc/RepositoryInspectResponseDto.md +doc/RepositoryListResponseDto.md +doc/RepositoryMeterDto.md +doc/RepositoryMetricsDto.md +doc/RepositoryPrimaryBackendReconfigureRequestDto.md +doc/RepositorySnapshotRestoreFromPointRequestDto.md +doc/RepositorySnapshotRestoreRequestDto.md +doc/RepositoryUpdateRequestDto.md +doc/RepositoryUpdateResponseDto.md +doc/RetentionPolicyDto.md +doc/ReverseGeocodingStateResponseDto.md +doc/RotateParameters.md +doc/RunDto.md +doc/RunHistoryApi.md +doc/RunHistoryResponseDto.md +doc/RunResponseDto.md +doc/RunStatus.md +doc/RunType.md +doc/RunningTaskDto.md +doc/RunningTaskListResponse.md +doc/RunningTasksApi.md +doc/ScheduleApi.md +doc/ScheduleCreateRequestDto.md +doc/ScheduleCreateResponseDto.md +doc/ScheduleDto.md +doc/ScheduleListResponseDto.md +doc/ScheduleUpdateRequestDto.md +doc/ScheduleUpdateResponseDto.md +doc/SearchAlbumResponseDto.md +doc/SearchApi.md +doc/SearchAssetResponseDto.md +doc/SearchExploreItem.md +doc/SearchExploreResponseDto.md +doc/SearchFacetCountResponseDto.md +doc/SearchFacetResponseDto.md +doc/SearchResponseDto.md +doc/SearchStatisticsResponseDto.md +doc/SearchSuggestionType.md +doc/ServerAboutResponseDto.md +doc/ServerApi.md +doc/ServerApkLinksDto.md +doc/ServerConfigDto.md +doc/ServerFeaturesDto.md +doc/ServerMediaTypesResponseDto.md +doc/ServerPingResponse.md +doc/ServerStatsResponseDto.md +doc/ServerStorageResponseDto.md +doc/ServerVersionHistoryResponseDto.md +doc/ServerVersionResponseDto.md +doc/SessionCreateDto.md +doc/SessionCreateResponseDto.md +doc/SessionResponseDto.md +doc/SessionUnlockDto.md +doc/SessionUpdateDto.md +doc/SessionsApi.md +doc/SetMaintenanceModeDto.md +doc/SharedLinkCreateDto.md +doc/SharedLinkEditDto.md +doc/SharedLinkLoginDto.md +doc/SharedLinkResponseDto.md +doc/SharedLinkType.md +doc/SharedLinksApi.md +doc/SharedLinksResponse.md +doc/SharedLinksUpdate.md +doc/SignUpDto.md +doc/SmartSearchDto.md +doc/SnapshotDto.md +doc/SnapshotSummaryDto.md +doc/SourceType.md +doc/StackCreateDto.md +doc/StackResponseDto.md +doc/StackUpdateDto.md +doc/StacksApi.md +doc/StatisticsSearchDto.md +doc/StorageFolder.md +doc/SyncAckDeleteDto.md +doc/SyncAckDto.md +doc/SyncAckSetDto.md +doc/SyncAlbumDeleteV1.md +doc/SyncAlbumToAssetDeleteV1.md +doc/SyncAlbumToAssetV1.md +doc/SyncAlbumUserDeleteV1.md +doc/SyncAlbumUserV1.md +doc/SyncAlbumV1.md +doc/SyncAlbumV2.md +doc/SyncApi.md +doc/SyncAssetDeleteV1.md +doc/SyncAssetEditDeleteV1.md +doc/SyncAssetEditV1.md +doc/SyncAssetExifV1.md +doc/SyncAssetFaceDeleteV1.md +doc/SyncAssetFaceV1.md +doc/SyncAssetFaceV2.md +doc/SyncAssetMetadataDeleteV1.md +doc/SyncAssetMetadataV1.md +doc/SyncAssetOcrDeleteV1.md +doc/SyncAssetOcrV1.md +doc/SyncAssetV1.md +doc/SyncAssetV2.md +doc/SyncAuthUserV1.md +doc/SyncEntityType.md +doc/SyncMemoryAssetDeleteV1.md +doc/SyncMemoryAssetV1.md +doc/SyncMemoryDeleteV1.md +doc/SyncMemoryV1.md +doc/SyncPartnerDeleteV1.md +doc/SyncPartnerV1.md +doc/SyncPersonDeleteV1.md +doc/SyncPersonV1.md +doc/SyncRequestType.md +doc/SyncStackDeleteV1.md +doc/SyncStackV1.md +doc/SyncStreamDto.md +doc/SyncUserDeleteV1.md +doc/SyncUserMetadataDeleteV1.md +doc/SyncUserMetadataV1.md +doc/SyncUserV1.md +doc/SystemConfigApi.md +doc/SystemConfigBackupsDto.md +doc/SystemConfigDto.md +doc/SystemConfigFFmpegDto.md +doc/SystemConfigFFmpegRealtimeDto.md +doc/SystemConfigFacesDto.md +doc/SystemConfigGeneratedFullsizeImageDto.md +doc/SystemConfigGeneratedImageDto.md +doc/SystemConfigImageDto.md +doc/SystemConfigIntegrityChecks.md +doc/SystemConfigIntegrityChecksumJob.md +doc/SystemConfigIntegrityJob.md +doc/SystemConfigJobDto.md +doc/SystemConfigLibraryDto.md +doc/SystemConfigLibraryScanDto.md +doc/SystemConfigLibraryWatchDto.md +doc/SystemConfigLoggingDto.md +doc/SystemConfigMachineLearningDto.md +doc/SystemConfigMapDto.md +doc/SystemConfigMetadataDto.md +doc/SystemConfigNewVersionCheckDto.md +doc/SystemConfigNightlyTasksDto.md +doc/SystemConfigNotificationsDto.md +doc/SystemConfigOAuthDto.md +doc/SystemConfigPasswordLoginDto.md +doc/SystemConfigReverseGeocodingDto.md +doc/SystemConfigServerDto.md +doc/SystemConfigSmtpDto.md +doc/SystemConfigSmtpTransportDto.md +doc/SystemConfigStorageTemplateDto.md +doc/SystemConfigTemplateEmailsDto.md +doc/SystemConfigTemplateStorageOptionDto.md +doc/SystemConfigTemplatesDto.md +doc/SystemConfigThemeDto.md +doc/SystemConfigTrashDto.md +doc/SystemConfigUserDto.md +doc/SystemMetadataApi.md +doc/TagBulkAssetsDto.md +doc/TagBulkAssetsResponseDto.md +doc/TagCreateDto.md +doc/TagResponseDto.md +doc/TagUpdateDto.md +doc/TagUpsertDto.md +doc/TagsApi.md +doc/TagsResponse.md +doc/TagsUpdate.md +doc/TaskStatus.md +doc/TaskType.md +doc/TelemetryLevel.md +doc/TemplateDto.md +doc/TemplateResponseDto.md +doc/TestEmailResponseDto.md +doc/TimeBucketAssetResponseDto.md +doc/TimeBucketsResponseDto.md +doc/TimelineApi.md +doc/ToneMapping.md +doc/TranscodeHWAccel.md +doc/TranscodePolicy.md +doc/TrashApi.md +doc/TrashResponseDto.md +doc/UpdateAlbumDto.md +doc/UpdateAlbumUserDto.md +doc/UpdateAssetDto.md +doc/UpdateLibraryDto.md +doc/UsageByUserDto.md +doc/UserAdminCreateDto.md +doc/UserAdminDeleteDto.md +doc/UserAdminResponseDto.md +doc/UserAdminUpdateDto.md +doc/UserAvatarColor.md +doc/UserLicense.md +doc/UserMetadataKey.md +doc/UserPreferencesResponseDto.md +doc/UserPreferencesUpdateDto.md +doc/UserResponseDto.md +doc/UserStatus.md +doc/UserUpdateMeDto.md +doc/UsersAdminApi.md +doc/UsersApi.md +doc/ValidateAccessTokenResponseDto.md +doc/ValidateLibraryDto.md +doc/ValidateLibraryImportPathResponseDto.md +doc/ValidateLibraryResponseDto.md +doc/VersionCheckStateResponseDto.md +doc/VideoCodec.md +doc/VideoContainer.md +doc/ViewsApi.md +doc/WorkflowCreateDto.md +doc/WorkflowResponseDto.md +doc/WorkflowShareResponseDto.md +doc/WorkflowShareStepDto.md +doc/WorkflowStepDto.md +doc/WorkflowTrigger.md +doc/WorkflowTriggerResponseDto.md +doc/WorkflowType.md +doc/WorkflowUpdateDto.md +doc/WorkflowsApi.md +git_push.sh +lib/api.dart +lib/api/activities_api.dart +lib/api/albums_api.dart +lib/api/api_keys_api.dart +lib/api/assets_api.dart +lib/api/auth_api.dart +lib/api/authentication_admin_api.dart +lib/api/authentication_api.dart +lib/api/backend_api.dart +lib/api/database_backups_admin_api.dart +lib/api/deprecated_api.dart +lib/api/development_api.dart +lib/api/download_api.dart +lib/api/duplicates_api.dart +lib/api/faces_api.dart +lib/api/filesystem_api.dart +lib/api/integrations_api.dart +lib/api/jobs_api.dart +lib/api/libraries_api.dart +lib/api/maintenance_admin_api.dart +lib/api/map_api.dart +lib/api/memories_api.dart +lib/api/notifications_admin_api.dart +lib/api/notifications_api.dart +lib/api/onboarding_api.dart +lib/api/partners_api.dart +lib/api/people_api.dart +lib/api/plugins_api.dart +lib/api/queues_api.dart +lib/api/repository_api.dart +lib/api/run_history_api.dart +lib/api/running_tasks_api.dart +lib/api/schedule_api.dart +lib/api/search_api.dart +lib/api/server_api.dart +lib/api/sessions_api.dart +lib/api/shared_links_api.dart +lib/api/stacks_api.dart +lib/api/sync_api.dart +lib/api/system_config_api.dart +lib/api/system_metadata_api.dart +lib/api/tags_api.dart +lib/api/timeline_api.dart +lib/api/trash_api.dart +lib/api/users_admin_api.dart +lib/api/users_api.dart +lib/api/views_api.dart +lib/api/workflows_api.dart +lib/api_client.dart +lib/api_exception.dart +lib/api_helper.dart +lib/auth/api_key_auth.dart +lib/auth/authentication.dart +lib/auth/http_basic_auth.dart +lib/auth/http_bearer_auth.dart +lib/auth/oauth.dart +lib/model/active_schedule_item_dto.dart +lib/model/activity_create_dto.dart +lib/model/activity_response_dto.dart +lib/model/activity_statistics_response_dto.dart +lib/model/add_users_dto.dart +lib/model/admin_onboarding_update_dto.dart +lib/model/album_response_dto.dart +lib/model/album_statistics_response_dto.dart +lib/model/album_user_add_dto.dart +lib/model/album_user_create_dto.dart +lib/model/album_user_response_dto.dart +lib/model/album_user_role.dart +lib/model/albums_add_assets_dto.dart +lib/model/albums_add_assets_response_dto.dart +lib/model/albums_response.dart +lib/model/albums_update.dart +lib/model/api_key_create_dto.dart +lib/model/api_key_create_response_dto.dart +lib/model/api_key_response_dto.dart +lib/model/api_key_update_dto.dart +lib/model/asset_bulk_delete_dto.dart +lib/model/asset_bulk_update_dto.dart +lib/model/asset_bulk_upload_check_dto.dart +lib/model/asset_bulk_upload_check_item.dart +lib/model/asset_bulk_upload_check_response_dto.dart +lib/model/asset_bulk_upload_check_result.dart +lib/model/asset_copy_dto.dart +lib/model/asset_edit_action.dart +lib/model/asset_edit_action_item_dto.dart +lib/model/asset_edit_action_item_dto_parameters.dart +lib/model/asset_edit_action_item_response_dto.dart +lib/model/asset_edits_create_dto.dart +lib/model/asset_edits_response_dto.dart +lib/model/asset_face_create_dto.dart +lib/model/asset_face_delete_dto.dart +lib/model/asset_face_response_dto.dart +lib/model/asset_face_update_dto.dart +lib/model/asset_face_update_item.dart +lib/model/asset_id_error_reason.dart +lib/model/asset_ids_dto.dart +lib/model/asset_ids_response_dto.dart +lib/model/asset_job_name.dart +lib/model/asset_jobs_dto.dart +lib/model/asset_media_response_dto.dart +lib/model/asset_media_size.dart +lib/model/asset_media_status.dart +lib/model/asset_metadata_bulk_delete_dto.dart +lib/model/asset_metadata_bulk_delete_item_dto.dart +lib/model/asset_metadata_bulk_response_dto.dart +lib/model/asset_metadata_bulk_upsert_dto.dart +lib/model/asset_metadata_bulk_upsert_item_dto.dart +lib/model/asset_metadata_response_dto.dart +lib/model/asset_metadata_upsert_dto.dart +lib/model/asset_metadata_upsert_item_dto.dart +lib/model/asset_ocr_response_dto.dart +lib/model/asset_order.dart +lib/model/asset_order_by.dart +lib/model/asset_reject_reason.dart +lib/model/asset_response_dto.dart +lib/model/asset_stack_response_dto.dart +lib/model/asset_stats_response_dto.dart +lib/model/asset_type_enum.dart +lib/model/asset_upload_action.dart +lib/model/asset_visibility.dart +lib/model/audio_codec.dart +lib/model/auth_status_response_dto.dart +lib/model/avatar_update.dart +lib/model/backend_dto.dart +lib/model/backend_response_dto.dart +lib/model/backend_type.dart +lib/model/backends_response_dto.dart +lib/model/bootstrap_status.dart +lib/model/bulk_id_error_reason.dart +lib/model/bulk_id_response_dto.dart +lib/model/bulk_ids_dto.dart +lib/model/calendar_heatmap_response_dto.dart +lib/model/calendar_heatmap_response_dto_series_inner.dart +lib/model/calendar_heatmap_type.dart +lib/model/cast_response.dart +lib/model/cast_update.dart +lib/model/change_password_dto.dart +lib/model/clip_config.dart +lib/model/colorspace.dart +lib/model/configure_immich_integration_request_dto.dart +lib/model/configure_immich_integration_request_dto_libraries.dart +lib/model/contributor_count_response_dto.dart +lib/model/cq_mode.dart +lib/model/create_album_dto.dart +lib/model/create_library_dto.dart +lib/model/create_local_backend_request_dto.dart +lib/model/create_profile_image_response_dto.dart +lib/model/crop_parameters.dart +lib/model/current_recovery_key_response.dart +lib/model/database_backup_config.dart +lib/model/database_backup_delete_dto.dart +lib/model/database_backup_dto.dart +lib/model/database_backup_list_response_dto.dart +lib/model/device_flow_response_dto.dart +lib/model/download_archive_dto.dart +lib/model/download_archive_info.dart +lib/model/download_info_dto.dart +lib/model/download_response.dart +lib/model/download_response_dto.dart +lib/model/download_update.dart +lib/model/duplicate_detection_config.dart +lib/model/duplicate_resolve_dto.dart +lib/model/duplicate_resolve_group_dto.dart +lib/model/duplicate_response_dto.dart +lib/model/email_notifications_response.dart +lib/model/email_notifications_update.dart +lib/model/exif_response_dto.dart +lib/model/face_dto.dart +lib/model/facial_recognition_config.dart +lib/model/filesystem_listing_item_dto.dart +lib/model/filesystem_listing_response_dto.dart +lib/model/folders_response.dart +lib/model/folders_update.dart +lib/model/hls_video_resolution.dart +lib/model/image_format.dart +lib/model/immich_integration_configuration_dto.dart +lib/model/immich_integration_dto.dart +lib/model/immich_library_dto.dart +lib/model/immich_rollback_request_dto.dart +lib/model/immich_state_dto.dart +lib/model/import_recovery_key_request.dart +lib/model/inspected_local_repository_dto.dart +lib/model/integrations_response_dto.dart +lib/model/integrity_report.dart +lib/model/integrity_report_response_dto.dart +lib/model/integrity_report_response_dto_items_inner.dart +lib/model/integrity_report_summary_response_dto.dart +lib/model/job_create_dto.dart +lib/model/job_name.dart +lib/model/job_settings_dto.dart +lib/model/library_response_dto.dart +lib/model/library_stats_response_dto.dart +lib/model/license_key_dto.dart +lib/model/list_snapshots_response_dto.dart +lib/model/local_repository_dto.dart +lib/model/log_level.dart +lib/model/log_response_dto.dart +lib/model/login_credential_dto.dart +lib/model/login_response_dto.dart +lib/model/logout_response_dto.dart +lib/model/machine_learning_availability_checks_dto.dart +lib/model/maintenance_action.dart +lib/model/maintenance_auth_dto.dart +lib/model/maintenance_detect_install_response_dto.dart +lib/model/maintenance_detect_install_storage_folder_dto.dart +lib/model/maintenance_login_dto.dart +lib/model/maintenance_status_response_dto.dart +lib/model/manual_job_name.dart +lib/model/map_marker_response_dto.dart +lib/model/map_reverse_geocode_response_dto.dart +lib/model/memories_response.dart +lib/model/memories_update.dart +lib/model/memory_create_dto.dart +lib/model/memory_response_dto.dart +lib/model/memory_search_order.dart +lib/model/memory_statistics_response_dto.dart +lib/model/memory_type.dart +lib/model/memory_update_dto.dart +lib/model/merge_person_dto.dart +lib/model/metadata_search_dto.dart +lib/model/mirror_axis.dart +lib/model/mirror_parameters.dart +lib/model/notification_create_dto.dart +lib/model/notification_delete_all_dto.dart +lib/model/notification_dto.dart +lib/model/notification_level.dart +lib/model/notification_type.dart +lib/model/notification_update_all_dto.dart +lib/model/notification_update_dto.dart +lib/model/o_auth_authorize_response_dto.dart +lib/model/o_auth_callback_dto.dart +lib/model/o_auth_config_dto.dart +lib/model/o_auth_token_endpoint_auth_method.dart +lib/model/ocr_config.dart +lib/model/on_this_day_dto.dart +lib/model/onboarding_dto.dart +lib/model/onboarding_response_dto.dart +lib/model/onboarding_status_response_dto.dart +lib/model/partner_create_dto.dart +lib/model/partner_direction.dart +lib/model/partner_response_dto.dart +lib/model/partner_update_dto.dart +lib/model/people_response.dart +lib/model/people_response_dto.dart +lib/model/people_update.dart +lib/model/people_update_dto.dart +lib/model/people_update_item.dart +lib/model/permission.dart +lib/model/person_create_dto.dart +lib/model/person_response_dto.dart +lib/model/person_statistics_response_dto.dart +lib/model/person_update_dto.dart +lib/model/pin_code_change_dto.dart +lib/model/pin_code_reset_dto.dart +lib/model/pin_code_setup_dto.dart +lib/model/places_response_dto.dart +lib/model/plugin_method_response_dto.dart +lib/model/plugin_response_dto.dart +lib/model/plugin_template_response_dto.dart +lib/model/plugin_template_step_response_dto.dart +lib/model/purchase_response.dart +lib/model/purchase_update.dart +lib/model/queue_command.dart +lib/model/queue_command_dto.dart +lib/model/queue_delete_dto.dart +lib/model/queue_job_response_dto.dart +lib/model/queue_job_status.dart +lib/model/queue_name.dart +lib/model/queue_response_dto.dart +lib/model/queue_response_legacy_dto.dart +lib/model/queue_statistics_dto.dart +lib/model/queue_status_legacy_dto.dart +lib/model/queue_update_dto.dart +lib/model/queues_response_legacy_dto.dart +lib/model/random_search_dto.dart +lib/model/ratings_response.dart +lib/model/ratings_update.dart +lib/model/reaction_level.dart +lib/model/reaction_type.dart +lib/model/recently_added_response.dart +lib/model/recently_added_update.dart +lib/model/release_channel.dart +lib/model/release_event_v1.dart +lib/model/release_type.dart +lib/model/repository_backend_dto.dart +lib/model/repository_backends_dto.dart +lib/model/repository_check_import_response_dto.dart +lib/model/repository_configuration_dto.dart +lib/model/repository_create_request_dto.dart +lib/model/repository_create_response_dto.dart +lib/model/repository_inspect_response_dto.dart +lib/model/repository_list_response_dto.dart +lib/model/repository_meter_dto.dart +lib/model/repository_metrics_dto.dart +lib/model/repository_primary_backend_reconfigure_request_dto.dart +lib/model/repository_snapshot_restore_from_point_request_dto.dart +lib/model/repository_snapshot_restore_request_dto.dart +lib/model/repository_update_request_dto.dart +lib/model/repository_update_response_dto.dart +lib/model/retention_policy_dto.dart +lib/model/reverse_geocoding_state_response_dto.dart +lib/model/rotate_parameters.dart +lib/model/run_dto.dart +lib/model/run_history_response_dto.dart +lib/model/run_response_dto.dart +lib/model/run_status.dart +lib/model/run_type.dart +lib/model/running_task_dto.dart +lib/model/running_task_list_response.dart +lib/model/schedule_create_request_dto.dart +lib/model/schedule_create_response_dto.dart +lib/model/schedule_dto.dart +lib/model/schedule_list_response_dto.dart +lib/model/schedule_update_request_dto.dart +lib/model/schedule_update_response_dto.dart +lib/model/search_album_response_dto.dart +lib/model/search_asset_response_dto.dart +lib/model/search_explore_item.dart +lib/model/search_explore_response_dto.dart +lib/model/search_facet_count_response_dto.dart +lib/model/search_facet_response_dto.dart +lib/model/search_response_dto.dart +lib/model/search_statistics_response_dto.dart +lib/model/search_suggestion_type.dart +lib/model/server_about_response_dto.dart +lib/model/server_apk_links_dto.dart +lib/model/server_config_dto.dart +lib/model/server_features_dto.dart +lib/model/server_media_types_response_dto.dart +lib/model/server_ping_response.dart +lib/model/server_stats_response_dto.dart +lib/model/server_storage_response_dto.dart +lib/model/server_version_history_response_dto.dart +lib/model/server_version_response_dto.dart +lib/model/session_create_dto.dart +lib/model/session_create_response_dto.dart +lib/model/session_response_dto.dart +lib/model/session_unlock_dto.dart +lib/model/session_update_dto.dart +lib/model/set_maintenance_mode_dto.dart +lib/model/shared_link_create_dto.dart +lib/model/shared_link_edit_dto.dart +lib/model/shared_link_login_dto.dart +lib/model/shared_link_response_dto.dart +lib/model/shared_link_type.dart +lib/model/shared_links_response.dart +lib/model/shared_links_update.dart +lib/model/sign_up_dto.dart +lib/model/smart_search_dto.dart +lib/model/snapshot_dto.dart +lib/model/snapshot_summary_dto.dart +lib/model/source_type.dart +lib/model/stack_create_dto.dart +lib/model/stack_response_dto.dart +lib/model/stack_update_dto.dart +lib/model/statistics_search_dto.dart +lib/model/storage_folder.dart +lib/model/sync_ack_delete_dto.dart +lib/model/sync_ack_dto.dart +lib/model/sync_ack_set_dto.dart +lib/model/sync_album_delete_v1.dart +lib/model/sync_album_to_asset_delete_v1.dart +lib/model/sync_album_to_asset_v1.dart +lib/model/sync_album_user_delete_v1.dart +lib/model/sync_album_user_v1.dart +lib/model/sync_album_v1.dart +lib/model/sync_album_v2.dart +lib/model/sync_asset_delete_v1.dart +lib/model/sync_asset_edit_delete_v1.dart +lib/model/sync_asset_edit_v1.dart +lib/model/sync_asset_exif_v1.dart +lib/model/sync_asset_face_delete_v1.dart +lib/model/sync_asset_face_v1.dart +lib/model/sync_asset_face_v2.dart +lib/model/sync_asset_metadata_delete_v1.dart +lib/model/sync_asset_metadata_v1.dart +lib/model/sync_asset_ocr_delete_v1.dart +lib/model/sync_asset_ocr_v1.dart +lib/model/sync_asset_v1.dart +lib/model/sync_asset_v2.dart +lib/model/sync_auth_user_v1.dart +lib/model/sync_entity_type.dart +lib/model/sync_memory_asset_delete_v1.dart +lib/model/sync_memory_asset_v1.dart +lib/model/sync_memory_delete_v1.dart +lib/model/sync_memory_v1.dart +lib/model/sync_partner_delete_v1.dart +lib/model/sync_partner_v1.dart +lib/model/sync_person_delete_v1.dart +lib/model/sync_person_v1.dart +lib/model/sync_request_type.dart +lib/model/sync_stack_delete_v1.dart +lib/model/sync_stack_v1.dart +lib/model/sync_stream_dto.dart +lib/model/sync_user_delete_v1.dart +lib/model/sync_user_metadata_delete_v1.dart +lib/model/sync_user_metadata_v1.dart +lib/model/sync_user_v1.dart +lib/model/system_config_backups_dto.dart +lib/model/system_config_dto.dart +lib/model/system_config_f_fmpeg_dto.dart +lib/model/system_config_f_fmpeg_realtime_dto.dart +lib/model/system_config_faces_dto.dart +lib/model/system_config_generated_fullsize_image_dto.dart +lib/model/system_config_generated_image_dto.dart +lib/model/system_config_image_dto.dart +lib/model/system_config_integrity_checks.dart +lib/model/system_config_integrity_checksum_job.dart +lib/model/system_config_integrity_job.dart +lib/model/system_config_job_dto.dart +lib/model/system_config_library_dto.dart +lib/model/system_config_library_scan_dto.dart +lib/model/system_config_library_watch_dto.dart +lib/model/system_config_logging_dto.dart +lib/model/system_config_machine_learning_dto.dart +lib/model/system_config_map_dto.dart +lib/model/system_config_metadata_dto.dart +lib/model/system_config_new_version_check_dto.dart +lib/model/system_config_nightly_tasks_dto.dart +lib/model/system_config_notifications_dto.dart +lib/model/system_config_o_auth_dto.dart +lib/model/system_config_password_login_dto.dart +lib/model/system_config_reverse_geocoding_dto.dart +lib/model/system_config_server_dto.dart +lib/model/system_config_smtp_dto.dart +lib/model/system_config_smtp_transport_dto.dart +lib/model/system_config_storage_template_dto.dart +lib/model/system_config_template_emails_dto.dart +lib/model/system_config_template_storage_option_dto.dart +lib/model/system_config_templates_dto.dart +lib/model/system_config_theme_dto.dart +lib/model/system_config_trash_dto.dart +lib/model/system_config_user_dto.dart +lib/model/tag_bulk_assets_dto.dart +lib/model/tag_bulk_assets_response_dto.dart +lib/model/tag_create_dto.dart +lib/model/tag_response_dto.dart +lib/model/tag_update_dto.dart +lib/model/tag_upsert_dto.dart +lib/model/tags_response.dart +lib/model/tags_update.dart +lib/model/task_status.dart +lib/model/task_type.dart +lib/model/telemetry_level.dart +lib/model/template_dto.dart +lib/model/template_response_dto.dart +lib/model/test_email_response_dto.dart +lib/model/time_bucket_asset_response_dto.dart +lib/model/time_buckets_response_dto.dart +lib/model/tone_mapping.dart +lib/model/transcode_hw_accel.dart +lib/model/transcode_policy.dart +lib/model/trash_response_dto.dart +lib/model/update_album_dto.dart +lib/model/update_album_user_dto.dart +lib/model/update_asset_dto.dart +lib/model/update_library_dto.dart +lib/model/usage_by_user_dto.dart +lib/model/user_admin_create_dto.dart +lib/model/user_admin_delete_dto.dart +lib/model/user_admin_response_dto.dart +lib/model/user_admin_update_dto.dart +lib/model/user_avatar_color.dart +lib/model/user_license.dart +lib/model/user_metadata_key.dart +lib/model/user_preferences_response_dto.dart +lib/model/user_preferences_update_dto.dart +lib/model/user_response_dto.dart +lib/model/user_status.dart +lib/model/user_update_me_dto.dart +lib/model/validate_access_token_response_dto.dart +lib/model/validate_library_dto.dart +lib/model/validate_library_import_path_response_dto.dart +lib/model/validate_library_response_dto.dart +lib/model/version_check_state_response_dto.dart +lib/model/video_codec.dart +lib/model/video_container.dart +lib/model/workflow_create_dto.dart +lib/model/workflow_response_dto.dart +lib/model/workflow_share_response_dto.dart +lib/model/workflow_share_step_dto.dart +lib/model/workflow_step_dto.dart +lib/model/workflow_trigger.dart +lib/model/workflow_trigger_response_dto.dart +lib/model/workflow_type.dart +lib/model/workflow_update_dto.dart +lib/optional.dart +pubspec.yaml +test/active_schedule_item_dto_test.dart +test/activities_api_test.dart +test/activity_create_dto_test.dart +test/activity_response_dto_test.dart +test/activity_statistics_response_dto_test.dart +test/add_users_dto_test.dart +test/admin_onboarding_update_dto_test.dart +test/album_response_dto_test.dart +test/album_statistics_response_dto_test.dart +test/album_user_add_dto_test.dart +test/album_user_create_dto_test.dart +test/album_user_response_dto_test.dart +test/album_user_role_test.dart +test/albums_add_assets_dto_test.dart +test/albums_add_assets_response_dto_test.dart +test/albums_api_test.dart +test/albums_response_test.dart +test/albums_update_test.dart +test/api_key_create_dto_test.dart +test/api_key_create_response_dto_test.dart +test/api_key_response_dto_test.dart +test/api_key_update_dto_test.dart +test/api_keys_api_test.dart +test/asset_bulk_delete_dto_test.dart +test/asset_bulk_update_dto_test.dart +test/asset_bulk_upload_check_dto_test.dart +test/asset_bulk_upload_check_item_test.dart +test/asset_bulk_upload_check_response_dto_test.dart +test/asset_bulk_upload_check_result_test.dart +test/asset_copy_dto_test.dart +test/asset_edit_action_item_dto_parameters_test.dart +test/asset_edit_action_item_dto_test.dart +test/asset_edit_action_item_response_dto_test.dart +test/asset_edit_action_test.dart +test/asset_edits_create_dto_test.dart +test/asset_edits_response_dto_test.dart +test/asset_face_create_dto_test.dart +test/asset_face_delete_dto_test.dart +test/asset_face_response_dto_test.dart +test/asset_face_update_dto_test.dart +test/asset_face_update_item_test.dart +test/asset_id_error_reason_test.dart +test/asset_ids_dto_test.dart +test/asset_ids_response_dto_test.dart +test/asset_job_name_test.dart +test/asset_jobs_dto_test.dart +test/asset_media_response_dto_test.dart +test/asset_media_size_test.dart +test/asset_media_status_test.dart +test/asset_metadata_bulk_delete_dto_test.dart +test/asset_metadata_bulk_delete_item_dto_test.dart +test/asset_metadata_bulk_response_dto_test.dart +test/asset_metadata_bulk_upsert_dto_test.dart +test/asset_metadata_bulk_upsert_item_dto_test.dart +test/asset_metadata_response_dto_test.dart +test/asset_metadata_upsert_dto_test.dart +test/asset_metadata_upsert_item_dto_test.dart +test/asset_ocr_response_dto_test.dart +test/asset_order_by_test.dart +test/asset_order_test.dart +test/asset_reject_reason_test.dart +test/asset_response_dto_test.dart +test/asset_stack_response_dto_test.dart +test/asset_stats_response_dto_test.dart +test/asset_type_enum_test.dart +test/asset_upload_action_test.dart +test/asset_visibility_test.dart +test/assets_api_test.dart +test/audio_codec_test.dart +test/auth_api_test.dart +test/auth_status_response_dto_test.dart +test/authentication_admin_api_test.dart +test/authentication_api_test.dart +test/avatar_update_test.dart +test/backend_api_test.dart +test/backend_dto_test.dart +test/backend_response_dto_test.dart +test/backend_type_test.dart +test/backends_response_dto_test.dart +test/bootstrap_status_test.dart +test/bulk_id_error_reason_test.dart +test/bulk_id_response_dto_test.dart +test/bulk_ids_dto_test.dart +test/calendar_heatmap_response_dto_series_inner_test.dart +test/calendar_heatmap_response_dto_test.dart +test/calendar_heatmap_type_test.dart +test/cast_response_test.dart +test/cast_update_test.dart +test/change_password_dto_test.dart +test/clip_config_test.dart +test/colorspace_test.dart +test/configure_immich_integration_request_dto_libraries_test.dart +test/configure_immich_integration_request_dto_test.dart +test/contributor_count_response_dto_test.dart +test/cq_mode_test.dart +test/create_album_dto_test.dart +test/create_library_dto_test.dart +test/create_local_backend_request_dto_test.dart +test/create_profile_image_response_dto_test.dart +test/crop_parameters_test.dart +test/current_recovery_key_response_test.dart +test/database_backup_config_test.dart +test/database_backup_delete_dto_test.dart +test/database_backup_dto_test.dart +test/database_backup_list_response_dto_test.dart +test/database_backups_admin_api_test.dart +test/deprecated_api_test.dart +test/development_api_test.dart +test/device_flow_response_dto_test.dart +test/download_api_test.dart +test/download_archive_dto_test.dart +test/download_archive_info_test.dart +test/download_info_dto_test.dart +test/download_response_dto_test.dart +test/download_response_test.dart +test/download_update_test.dart +test/duplicate_detection_config_test.dart +test/duplicate_resolve_dto_test.dart +test/duplicate_resolve_group_dto_test.dart +test/duplicate_response_dto_test.dart +test/duplicates_api_test.dart +test/email_notifications_response_test.dart +test/email_notifications_update_test.dart +test/exif_response_dto_test.dart +test/face_dto_test.dart +test/faces_api_test.dart +test/facial_recognition_config_test.dart +test/filesystem_api_test.dart +test/filesystem_listing_item_dto_test.dart +test/filesystem_listing_response_dto_test.dart +test/folders_response_test.dart +test/folders_update_test.dart +test/hls_video_resolution_test.dart +test/image_format_test.dart +test/immich_integration_configuration_dto_test.dart +test/immich_integration_dto_test.dart +test/immich_library_dto_test.dart +test/immich_rollback_request_dto_test.dart +test/immich_state_dto_test.dart +test/import_recovery_key_request_test.dart +test/inspected_local_repository_dto_test.dart +test/integrations_api_test.dart +test/integrations_response_dto_test.dart +test/integrity_report_response_dto_items_inner_test.dart +test/integrity_report_response_dto_test.dart +test/integrity_report_summary_response_dto_test.dart +test/integrity_report_test.dart +test/job_create_dto_test.dart +test/job_name_test.dart +test/job_settings_dto_test.dart +test/jobs_api_test.dart +test/libraries_api_test.dart +test/library_response_dto_test.dart +test/library_stats_response_dto_test.dart +test/license_key_dto_test.dart +test/list_snapshots_response_dto_test.dart +test/local_repository_dto_test.dart +test/log_level_test.dart +test/log_response_dto_test.dart +test/login_credential_dto_test.dart +test/login_response_dto_test.dart +test/logout_response_dto_test.dart +test/machine_learning_availability_checks_dto_test.dart +test/maintenance_action_test.dart +test/maintenance_admin_api_test.dart +test/maintenance_auth_dto_test.dart +test/maintenance_detect_install_response_dto_test.dart +test/maintenance_detect_install_storage_folder_dto_test.dart +test/maintenance_login_dto_test.dart +test/maintenance_status_response_dto_test.dart +test/manual_job_name_test.dart +test/map_api_test.dart +test/map_marker_response_dto_test.dart +test/map_reverse_geocode_response_dto_test.dart +test/memories_api_test.dart +test/memories_response_test.dart +test/memories_update_test.dart +test/memory_create_dto_test.dart +test/memory_response_dto_test.dart +test/memory_search_order_test.dart +test/memory_statistics_response_dto_test.dart +test/memory_type_test.dart +test/memory_update_dto_test.dart +test/merge_person_dto_test.dart +test/metadata_search_dto_test.dart +test/mirror_axis_test.dart +test/mirror_parameters_test.dart +test/notification_create_dto_test.dart +test/notification_delete_all_dto_test.dart +test/notification_dto_test.dart +test/notification_level_test.dart +test/notification_type_test.dart +test/notification_update_all_dto_test.dart +test/notification_update_dto_test.dart +test/notifications_admin_api_test.dart +test/notifications_api_test.dart +test/o_auth_authorize_response_dto_test.dart +test/o_auth_callback_dto_test.dart +test/o_auth_config_dto_test.dart +test/o_auth_token_endpoint_auth_method_test.dart +test/ocr_config_test.dart +test/on_this_day_dto_test.dart +test/onboarding_api_test.dart +test/onboarding_dto_test.dart +test/onboarding_response_dto_test.dart +test/onboarding_status_response_dto_test.dart +test/partner_create_dto_test.dart +test/partner_direction_test.dart +test/partner_response_dto_test.dart +test/partner_update_dto_test.dart +test/partners_api_test.dart +test/people_api_test.dart +test/people_response_dto_test.dart +test/people_response_test.dart +test/people_update_dto_test.dart +test/people_update_item_test.dart +test/people_update_test.dart +test/permission_test.dart +test/person_create_dto_test.dart +test/person_response_dto_test.dart +test/person_statistics_response_dto_test.dart +test/person_update_dto_test.dart +test/pin_code_change_dto_test.dart +test/pin_code_reset_dto_test.dart +test/pin_code_setup_dto_test.dart +test/places_response_dto_test.dart +test/plugin_method_response_dto_test.dart +test/plugin_response_dto_test.dart +test/plugin_template_response_dto_test.dart +test/plugin_template_step_response_dto_test.dart +test/plugins_api_test.dart +test/purchase_response_test.dart +test/purchase_update_test.dart +test/queue_command_dto_test.dart +test/queue_command_test.dart +test/queue_delete_dto_test.dart +test/queue_job_response_dto_test.dart +test/queue_job_status_test.dart +test/queue_name_test.dart +test/queue_response_dto_test.dart +test/queue_response_legacy_dto_test.dart +test/queue_statistics_dto_test.dart +test/queue_status_legacy_dto_test.dart +test/queue_update_dto_test.dart +test/queues_api_test.dart +test/queues_response_legacy_dto_test.dart +test/random_search_dto_test.dart +test/ratings_response_test.dart +test/ratings_update_test.dart +test/reaction_level_test.dart +test/reaction_type_test.dart +test/recently_added_response_test.dart +test/recently_added_update_test.dart +test/release_channel_test.dart +test/release_event_v1_test.dart +test/release_type_test.dart +test/repository_api_test.dart +test/repository_backend_dto_test.dart +test/repository_backends_dto_test.dart +test/repository_check_import_response_dto_test.dart +test/repository_configuration_dto_test.dart +test/repository_create_request_dto_test.dart +test/repository_create_response_dto_test.dart +test/repository_inspect_response_dto_test.dart +test/repository_list_response_dto_test.dart +test/repository_meter_dto_test.dart +test/repository_metrics_dto_test.dart +test/repository_primary_backend_reconfigure_request_dto_test.dart +test/repository_snapshot_restore_from_point_request_dto_test.dart +test/repository_snapshot_restore_request_dto_test.dart +test/repository_update_request_dto_test.dart +test/repository_update_response_dto_test.dart +test/retention_policy_dto_test.dart +test/reverse_geocoding_state_response_dto_test.dart +test/rotate_parameters_test.dart +test/run_dto_test.dart +test/run_history_api_test.dart +test/run_history_response_dto_test.dart +test/run_response_dto_test.dart +test/run_status_test.dart +test/run_type_test.dart +test/running_task_dto_test.dart +test/running_task_list_response_test.dart +test/running_tasks_api_test.dart +test/schedule_api_test.dart +test/schedule_create_request_dto_test.dart +test/schedule_create_response_dto_test.dart +test/schedule_dto_test.dart +test/schedule_list_response_dto_test.dart +test/schedule_update_request_dto_test.dart +test/schedule_update_response_dto_test.dart +test/search_album_response_dto_test.dart +test/search_api_test.dart +test/search_asset_response_dto_test.dart +test/search_explore_item_test.dart +test/search_explore_response_dto_test.dart +test/search_facet_count_response_dto_test.dart +test/search_facet_response_dto_test.dart +test/search_response_dto_test.dart +test/search_statistics_response_dto_test.dart +test/search_suggestion_type_test.dart +test/server_about_response_dto_test.dart +test/server_api_test.dart +test/server_apk_links_dto_test.dart +test/server_config_dto_test.dart +test/server_features_dto_test.dart +test/server_media_types_response_dto_test.dart +test/server_ping_response_test.dart +test/server_stats_response_dto_test.dart +test/server_storage_response_dto_test.dart +test/server_version_history_response_dto_test.dart +test/server_version_response_dto_test.dart +test/session_create_dto_test.dart +test/session_create_response_dto_test.dart +test/session_response_dto_test.dart +test/session_unlock_dto_test.dart +test/session_update_dto_test.dart +test/sessions_api_test.dart +test/set_maintenance_mode_dto_test.dart +test/shared_link_create_dto_test.dart +test/shared_link_edit_dto_test.dart +test/shared_link_login_dto_test.dart +test/shared_link_response_dto_test.dart +test/shared_link_type_test.dart +test/shared_links_api_test.dart +test/shared_links_response_test.dart +test/shared_links_update_test.dart +test/sign_up_dto_test.dart +test/smart_search_dto_test.dart +test/snapshot_dto_test.dart +test/snapshot_summary_dto_test.dart +test/source_type_test.dart +test/stack_create_dto_test.dart +test/stack_response_dto_test.dart +test/stack_update_dto_test.dart +test/stacks_api_test.dart +test/statistics_search_dto_test.dart +test/storage_folder_test.dart +test/sync_ack_delete_dto_test.dart +test/sync_ack_dto_test.dart +test/sync_ack_set_dto_test.dart +test/sync_album_delete_v1_test.dart +test/sync_album_to_asset_delete_v1_test.dart +test/sync_album_to_asset_v1_test.dart +test/sync_album_user_delete_v1_test.dart +test/sync_album_user_v1_test.dart +test/sync_album_v1_test.dart +test/sync_album_v2_test.dart +test/sync_api_test.dart +test/sync_asset_delete_v1_test.dart +test/sync_asset_edit_delete_v1_test.dart +test/sync_asset_edit_v1_test.dart +test/sync_asset_exif_v1_test.dart +test/sync_asset_face_delete_v1_test.dart +test/sync_asset_face_v1_test.dart +test/sync_asset_face_v2_test.dart +test/sync_asset_metadata_delete_v1_test.dart +test/sync_asset_metadata_v1_test.dart +test/sync_asset_ocr_delete_v1_test.dart +test/sync_asset_ocr_v1_test.dart +test/sync_asset_v1_test.dart +test/sync_asset_v2_test.dart +test/sync_auth_user_v1_test.dart +test/sync_entity_type_test.dart +test/sync_memory_asset_delete_v1_test.dart +test/sync_memory_asset_v1_test.dart +test/sync_memory_delete_v1_test.dart +test/sync_memory_v1_test.dart +test/sync_partner_delete_v1_test.dart +test/sync_partner_v1_test.dart +test/sync_person_delete_v1_test.dart +test/sync_person_v1_test.dart +test/sync_request_type_test.dart +test/sync_stack_delete_v1_test.dart +test/sync_stack_v1_test.dart +test/sync_stream_dto_test.dart +test/sync_user_delete_v1_test.dart +test/sync_user_metadata_delete_v1_test.dart +test/sync_user_metadata_v1_test.dart +test/sync_user_v1_test.dart +test/system_config_api_test.dart +test/system_config_backups_dto_test.dart +test/system_config_dto_test.dart +test/system_config_f_fmpeg_dto_test.dart +test/system_config_f_fmpeg_realtime_dto_test.dart +test/system_config_faces_dto_test.dart +test/system_config_generated_fullsize_image_dto_test.dart +test/system_config_generated_image_dto_test.dart +test/system_config_image_dto_test.dart +test/system_config_integrity_checks_test.dart +test/system_config_integrity_checksum_job_test.dart +test/system_config_integrity_job_test.dart +test/system_config_job_dto_test.dart +test/system_config_library_dto_test.dart +test/system_config_library_scan_dto_test.dart +test/system_config_library_watch_dto_test.dart +test/system_config_logging_dto_test.dart +test/system_config_machine_learning_dto_test.dart +test/system_config_map_dto_test.dart +test/system_config_metadata_dto_test.dart +test/system_config_new_version_check_dto_test.dart +test/system_config_nightly_tasks_dto_test.dart +test/system_config_notifications_dto_test.dart +test/system_config_o_auth_dto_test.dart +test/system_config_password_login_dto_test.dart +test/system_config_reverse_geocoding_dto_test.dart +test/system_config_server_dto_test.dart +test/system_config_smtp_dto_test.dart +test/system_config_smtp_transport_dto_test.dart +test/system_config_storage_template_dto_test.dart +test/system_config_template_emails_dto_test.dart +test/system_config_template_storage_option_dto_test.dart +test/system_config_templates_dto_test.dart +test/system_config_theme_dto_test.dart +test/system_config_trash_dto_test.dart +test/system_config_user_dto_test.dart +test/system_metadata_api_test.dart +test/tag_bulk_assets_dto_test.dart +test/tag_bulk_assets_response_dto_test.dart +test/tag_create_dto_test.dart +test/tag_response_dto_test.dart +test/tag_update_dto_test.dart +test/tag_upsert_dto_test.dart +test/tags_api_test.dart +test/tags_response_test.dart +test/tags_update_test.dart +test/task_status_test.dart +test/task_type_test.dart +test/telemetry_level_test.dart +test/template_dto_test.dart +test/template_response_dto_test.dart +test/test_email_response_dto_test.dart +test/time_bucket_asset_response_dto_test.dart +test/time_buckets_response_dto_test.dart +test/timeline_api_test.dart +test/tone_mapping_test.dart +test/transcode_hw_accel_test.dart +test/transcode_policy_test.dart +test/trash_api_test.dart +test/trash_response_dto_test.dart +test/update_album_dto_test.dart +test/update_album_user_dto_test.dart +test/update_asset_dto_test.dart +test/update_library_dto_test.dart +test/usage_by_user_dto_test.dart +test/user_admin_create_dto_test.dart +test/user_admin_delete_dto_test.dart +test/user_admin_response_dto_test.dart +test/user_admin_update_dto_test.dart +test/user_avatar_color_test.dart +test/user_license_test.dart +test/user_metadata_key_test.dart +test/user_preferences_response_dto_test.dart +test/user_preferences_update_dto_test.dart +test/user_response_dto_test.dart +test/user_status_test.dart +test/user_update_me_dto_test.dart +test/users_admin_api_test.dart +test/users_api_test.dart +test/validate_access_token_response_dto_test.dart +test/validate_library_dto_test.dart +test/validate_library_import_path_response_dto_test.dart +test/validate_library_response_dto_test.dart +test/version_check_state_response_dto_test.dart +test/video_codec_test.dart +test/video_container_test.dart +test/views_api_test.dart +test/workflow_create_dto_test.dart +test/workflow_response_dto_test.dart +test/workflow_share_response_dto_test.dart +test/workflow_share_step_dto_test.dart +test/workflow_step_dto_test.dart +test/workflow_trigger_response_dto_test.dart +test/workflow_trigger_test.dart +test/workflow_type_test.dart +test/workflow_update_dto_test.dart +test/workflows_api_test.dart diff --git a/mobile/openapi/doc/APIKeysApi.md b/mobile/openapi/doc/APIKeysApi.md new file mode 100644 index 0000000000000..b530ad937fff5 --- /dev/null +++ b/mobile/openapi/doc/APIKeysApi.md @@ -0,0 +1,354 @@ +# openapi.api.APIKeysApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createApiKey**](APIKeysApi.md#createapikey) | **POST** /api-keys | Create an API key +[**deleteApiKey**](APIKeysApi.md#deleteapikey) | **DELETE** /api-keys/{id} | Delete an API key +[**getApiKey**](APIKeysApi.md#getapikey) | **GET** /api-keys/{id} | Retrieve an API key +[**getApiKeys**](APIKeysApi.md#getapikeys) | **GET** /api-keys | List all API keys +[**getMyApiKey**](APIKeysApi.md#getmyapikey) | **GET** /api-keys/me | Retrieve the current API key +[**updateApiKey**](APIKeysApi.md#updateapikey) | **PUT** /api-keys/{id} | Update an API key + + +# **createApiKey** +> ApiKeyCreateResponseDto createApiKey(apiKeyCreateDto) + +Create an API key + +Creates a new API key. It will be limited to the permissions specified. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = APIKeysApi(); +final apiKeyCreateDto = ApiKeyCreateDto(); // ApiKeyCreateDto | + +try { + final result = api_instance.createApiKey(apiKeyCreateDto); + print(result); +} catch (e) { + print('Exception when calling APIKeysApi->createApiKey: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **apiKeyCreateDto** | [**ApiKeyCreateDto**](ApiKeyCreateDto.md)| | + +### Return type + +[**ApiKeyCreateResponseDto**](ApiKeyCreateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteApiKey** +> deleteApiKey(id) + +Delete an API key + +Deletes an API key identified by its ID. The current user must own this API key. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = APIKeysApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteApiKey(id); +} catch (e) { + print('Exception when calling APIKeysApi->deleteApiKey: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getApiKey** +> ApiKeyResponseDto getApiKey(id) + +Retrieve an API key + +Retrieve an API key by its ID. The current user must own this API key. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = APIKeysApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getApiKey(id); + print(result); +} catch (e) { + print('Exception when calling APIKeysApi->getApiKey: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**ApiKeyResponseDto**](ApiKeyResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getApiKeys** +> List getApiKeys() + +List all API keys + +Retrieve all API keys of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = APIKeysApi(); + +try { + final result = api_instance.getApiKeys(); + print(result); +} catch (e) { + print('Exception when calling APIKeysApi->getApiKeys: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](ApiKeyResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMyApiKey** +> ApiKeyResponseDto getMyApiKey() + +Retrieve the current API key + +Retrieve the API key that is used to access this endpoint. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = APIKeysApi(); + +try { + final result = api_instance.getMyApiKey(); + print(result); +} catch (e) { + print('Exception when calling APIKeysApi->getMyApiKey: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ApiKeyResponseDto**](ApiKeyResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateApiKey** +> ApiKeyResponseDto updateApiKey(id, apiKeyUpdateDto) + +Update an API key + +Updates the name and permissions of an API key by its ID. The current user must own this API key. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = APIKeysApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final apiKeyUpdateDto = ApiKeyUpdateDto(); // ApiKeyUpdateDto | + +try { + final result = api_instance.updateApiKey(id, apiKeyUpdateDto); + print(result); +} catch (e) { + print('Exception when calling APIKeysApi->updateApiKey: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **apiKeyUpdateDto** | [**ApiKeyUpdateDto**](ApiKeyUpdateDto.md)| | + +### Return type + +[**ApiKeyResponseDto**](ApiKeyResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/ActiveScheduleItemDto.md b/mobile/openapi/doc/ActiveScheduleItemDto.md new file mode 100644 index 0000000000000..74b14b66c4e24 --- /dev/null +++ b/mobile/openapi/doc/ActiveScheduleItemDto.md @@ -0,0 +1,16 @@ +# openapi.model.ActiveScheduleItemDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**repositoryId** | **String** | | +**status** | [**TaskStatus**](TaskStatus.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ActivitiesApi.md b/mobile/openapi/doc/ActivitiesApi.md new file mode 100644 index 0000000000000..d5a43151fcccb --- /dev/null +++ b/mobile/openapi/doc/ActivitiesApi.md @@ -0,0 +1,254 @@ +# openapi.api.ActivitiesApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createActivity**](ActivitiesApi.md#createactivity) | **POST** /activities | Create an activity +[**deleteActivity**](ActivitiesApi.md#deleteactivity) | **DELETE** /activities/{id} | Delete an activity +[**getActivities**](ActivitiesApi.md#getactivities) | **GET** /activities | List all activities +[**getActivityStatistics**](ActivitiesApi.md#getactivitystatistics) | **GET** /activities/statistics | Retrieve activity statistics + + +# **createActivity** +> ActivityResponseDto createActivity(activityCreateDto) + +Create an activity + +Create a like or a comment for an album, or an asset in an album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ActivitiesApi(); +final activityCreateDto = ActivityCreateDto(); // ActivityCreateDto | + +try { + final result = api_instance.createActivity(activityCreateDto); + print(result); +} catch (e) { + print('Exception when calling ActivitiesApi->createActivity: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **activityCreateDto** | [**ActivityCreateDto**](ActivityCreateDto.md)| | + +### Return type + +[**ActivityResponseDto**](ActivityResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteActivity** +> deleteActivity(id) + +Delete an activity + +Removes a like or comment from a given album or asset in an album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ActivitiesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteActivity(id); +} catch (e) { + print('Exception when calling ActivitiesApi->deleteActivity: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getActivities** +> List getActivities(albumId, assetId, level, type, userId) + +List all activities + +Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ActivitiesApi(); +final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Album ID +final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Asset ID (if activity is for an asset) +final level = ; // ReactionLevel | +final type = ; // ReactionType | +final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter by user ID + +try { + final result = api_instance.getActivities(albumId, assetId, level, type, userId); + print(result); +} catch (e) { + print('Exception when calling ActivitiesApi->getActivities: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **albumId** | **String**| Album ID | + **assetId** | **String**| Asset ID (if activity is for an asset) | [optional] + **level** | [**ReactionLevel**](.md)| | [optional] + **type** | [**ReactionType**](.md)| | [optional] + **userId** | **String**| Filter by user ID | [optional] + +### Return type + +[**List**](ActivityResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getActivityStatistics** +> ActivityStatisticsResponseDto getActivityStatistics(albumId, assetId) + +Retrieve activity statistics + +Returns the number of likes and comments for a given album or asset in an album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ActivitiesApi(); +final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Album ID +final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Asset ID (if activity is for an asset) + +try { + final result = api_instance.getActivityStatistics(albumId, assetId); + print(result); +} catch (e) { + print('Exception when calling ActivitiesApi->getActivityStatistics: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **albumId** | **String**| Album ID | + **assetId** | **String**| Asset ID (if activity is for an asset) | [optional] + +### Return type + +[**ActivityStatisticsResponseDto**](ActivityStatisticsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/ActivityCreateDto.md b/mobile/openapi/doc/ActivityCreateDto.md new file mode 100644 index 0000000000000..b0df547e25cff --- /dev/null +++ b/mobile/openapi/doc/ActivityCreateDto.md @@ -0,0 +1,18 @@ +# openapi.model.ActivityCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **String** | Album ID | +**assetId** | **Optional** | Asset ID (if activity is for an asset) | [optional] +**comment** | **Optional** | Comment text (required if type is comment) | [optional] +**type** | [**ReactionType**](ReactionType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ActivityResponseDto.md b/mobile/openapi/doc/ActivityResponseDto.md new file mode 100644 index 0000000000000..019b2b628721e --- /dev/null +++ b/mobile/openapi/doc/ActivityResponseDto.md @@ -0,0 +1,20 @@ +# openapi.model.ActivityResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID (if activity is for an asset) | +**comment** | **Optional** | Comment text (for comment activities) | [optional] +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**id** | **String** | Activity ID | +**type** | [**ReactionType**](ReactionType.md) | | +**user** | [**UserResponseDto**](UserResponseDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ActivityStatisticsResponseDto.md b/mobile/openapi/doc/ActivityStatisticsResponseDto.md new file mode 100644 index 0000000000000..f6efcbc8eebc3 --- /dev/null +++ b/mobile/openapi/doc/ActivityStatisticsResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.ActivityStatisticsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments** | **int** | Number of comments | +**likes** | **int** | Number of likes | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AddUsersDto.md b/mobile/openapi/doc/AddUsersDto.md new file mode 100644 index 0000000000000..5468a680611ad --- /dev/null +++ b/mobile/openapi/doc/AddUsersDto.md @@ -0,0 +1,15 @@ +# openapi.model.AddUsersDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumUsers** | [**List**](AlbumUserAddDto.md) | Album users to add | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AdminOnboardingUpdateDto.md b/mobile/openapi/doc/AdminOnboardingUpdateDto.md new file mode 100644 index 0000000000000..6cfcbe547b751 --- /dev/null +++ b/mobile/openapi/doc/AdminOnboardingUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.AdminOnboardingUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isOnboarded** | **bool** | Is admin onboarded | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumResponseDto.md b/mobile/openapi/doc/AlbumResponseDto.md new file mode 100644 index 0000000000000..0590184396a4b --- /dev/null +++ b/mobile/openapi/doc/AlbumResponseDto.md @@ -0,0 +1,30 @@ +# openapi.model.AlbumResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumName** | **String** | Album name | +**albumThumbnailAssetId** | **String** | Thumbnail asset ID | +**albumUsers** | [**List**](AlbumUserResponseDto.md) | First entry is always the album owner. Second entry is the auth user, if it differs from the owner. The rest are ordered alphabetically. | [default to const []] +**assetCount** | **int** | Number of assets | +**contributorCounts** | [**Optional?>**](ContributorCountResponseDto.md) | | [optional] [default to const []] +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**description** | **String** | Album description | +**endDate** | [**Optional**](DateTime.md) | End date (latest asset) | [optional] +**hasSharedLink** | **bool** | Has shared link | +**id** | **String** | Album ID | +**isActivityEnabled** | **bool** | Activity feed enabled | +**lastModifiedAssetTimestamp** | [**Optional**](DateTime.md) | Last modified asset timestamp | [optional] +**order** | [**Optional**](AssetOrder.md) | | [optional] +**shared** | **bool** | Is shared album | +**startDate** | [**Optional**](DateTime.md) | Start date (earliest asset) | [optional] +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumStatisticsResponseDto.md b/mobile/openapi/doc/AlbumStatisticsResponseDto.md new file mode 100644 index 0000000000000..34277afb34dc9 --- /dev/null +++ b/mobile/openapi/doc/AlbumStatisticsResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.AlbumStatisticsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notShared** | **int** | Number of non-shared albums | +**owned** | **int** | Number of owned albums | +**shared** | **int** | Number of shared albums | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumUserAddDto.md b/mobile/openapi/doc/AlbumUserAddDto.md new file mode 100644 index 0000000000000..a33a148d2f749 --- /dev/null +++ b/mobile/openapi/doc/AlbumUserAddDto.md @@ -0,0 +1,16 @@ +# openapi.model.AlbumUserAddDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | [**Optional**](AlbumUserRole.md) | | [optional] +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumUserCreateDto.md b/mobile/openapi/doc/AlbumUserCreateDto.md new file mode 100644 index 0000000000000..3458187c9470c --- /dev/null +++ b/mobile/openapi/doc/AlbumUserCreateDto.md @@ -0,0 +1,16 @@ +# openapi.model.AlbumUserCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | [**AlbumUserRole**](AlbumUserRole.md) | | +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumUserResponseDto.md b/mobile/openapi/doc/AlbumUserResponseDto.md new file mode 100644 index 0000000000000..3f59d3142fd2b --- /dev/null +++ b/mobile/openapi/doc/AlbumUserResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.AlbumUserResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | [**AlbumUserRole**](AlbumUserRole.md) | | +**user** | [**UserResponseDto**](UserResponseDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumUserRole.md b/mobile/openapi/doc/AlbumUserRole.md new file mode 100644 index 0000000000000..d0f64ef3ec93f --- /dev/null +++ b/mobile/openapi/doc/AlbumUserRole.md @@ -0,0 +1,14 @@ +# openapi.model.AlbumUserRole + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumsAddAssetsDto.md b/mobile/openapi/doc/AlbumsAddAssetsDto.md new file mode 100644 index 0000000000000..eb3d319725405 --- /dev/null +++ b/mobile/openapi/doc/AlbumsAddAssetsDto.md @@ -0,0 +1,16 @@ +# openapi.model.AlbumsAddAssetsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumIds** | **List** | Album IDs | [default to const []] +**assetIds** | **List** | Asset IDs | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumsAddAssetsResponseDto.md b/mobile/openapi/doc/AlbumsAddAssetsResponseDto.md new file mode 100644 index 0000000000000..8041da27fcd95 --- /dev/null +++ b/mobile/openapi/doc/AlbumsAddAssetsResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.AlbumsAddAssetsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | [**Optional**](BulkIdErrorReason.md) | | [optional] +**success** | **bool** | Operation success | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumsApi.md b/mobile/openapi/doc/AlbumsApi.md new file mode 100644 index 0000000000000..55d1449635c83 --- /dev/null +++ b/mobile/openapi/doc/AlbumsApi.md @@ -0,0 +1,790 @@ +# openapi.api.AlbumsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**addAssetsToAlbum**](AlbumsApi.md#addassetstoalbum) | **PUT** /albums/{id}/assets | Add assets to an album +[**addAssetsToAlbums**](AlbumsApi.md#addassetstoalbums) | **PUT** /albums/assets | Add assets to albums +[**addUsersToAlbum**](AlbumsApi.md#adduserstoalbum) | **PUT** /albums/{id}/users | Share album with users +[**createAlbum**](AlbumsApi.md#createalbum) | **POST** /albums | Create an album +[**deleteAlbum**](AlbumsApi.md#deletealbum) | **DELETE** /albums/{id} | Delete an album +[**getAlbumInfo**](AlbumsApi.md#getalbuminfo) | **GET** /albums/{id} | Retrieve an album +[**getAlbumMapMarkers**](AlbumsApi.md#getalbummapmarkers) | **GET** /albums/{id}/map-markers | Retrieve album map markers +[**getAlbumStatistics**](AlbumsApi.md#getalbumstatistics) | **GET** /albums/statistics | Retrieve album statistics +[**getAllAlbums**](AlbumsApi.md#getallalbums) | **GET** /albums | List all albums +[**removeAssetFromAlbum**](AlbumsApi.md#removeassetfromalbum) | **DELETE** /albums/{id}/assets | Remove assets from an album +[**removeUserFromAlbum**](AlbumsApi.md#removeuserfromalbum) | **DELETE** /albums/{id}/user/{userId} | Remove user from album +[**updateAlbumInfo**](AlbumsApi.md#updatealbuminfo) | **PATCH** /albums/{id} | Update an album +[**updateAlbumUser**](AlbumsApi.md#updatealbumuser) | **PUT** /albums/{id}/user/{userId} | Update user role + + +# **addAssetsToAlbum** +> List addAssetsToAlbum(id, bulkIdsDto) + +Add assets to an album + +Add multiple assets to a specific album by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + final result = api_instance.addAssetsToAlbum(id, bulkIdsDto); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->addAssetsToAlbum: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **addAssetsToAlbums** +> AlbumsAddAssetsResponseDto addAssetsToAlbums(albumsAddAssetsDto) + +Add assets to albums + +Send a list of asset IDs and album IDs to add each asset to each album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final albumsAddAssetsDto = AlbumsAddAssetsDto(); // AlbumsAddAssetsDto | + +try { + final result = api_instance.addAssetsToAlbums(albumsAddAssetsDto); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->addAssetsToAlbums: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **albumsAddAssetsDto** | [**AlbumsAddAssetsDto**](AlbumsAddAssetsDto.md)| | + +### Return type + +[**AlbumsAddAssetsResponseDto**](AlbumsAddAssetsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **addUsersToAlbum** +> AlbumResponseDto addUsersToAlbum(id, addUsersDto) + +Share album with users + +Share an album with multiple users. Each user can be given a specific role in the album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final addUsersDto = AddUsersDto(); // AddUsersDto | + +try { + final result = api_instance.addUsersToAlbum(id, addUsersDto); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->addUsersToAlbum: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **addUsersDto** | [**AddUsersDto**](AddUsersDto.md)| | + +### Return type + +[**AlbumResponseDto**](AlbumResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createAlbum** +> AlbumResponseDto createAlbum(createAlbumDto) + +Create an album + +Create a new album. The album can also be created with initial users and assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final createAlbumDto = CreateAlbumDto(); // CreateAlbumDto | + +try { + final result = api_instance.createAlbum(createAlbumDto); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->createAlbum: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createAlbumDto** | [**CreateAlbumDto**](CreateAlbumDto.md)| | + +### Return type + +[**AlbumResponseDto**](AlbumResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteAlbum** +> deleteAlbum(id) + +Delete an album + +Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteAlbum(id); +} catch (e) { + print('Exception when calling AlbumsApi->deleteAlbum: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAlbumInfo** +> AlbumResponseDto getAlbumInfo(id, key, slug) + +Retrieve an album + +Retrieve information about a specific album by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.getAlbumInfo(id, key, slug); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->getAlbumInfo: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**AlbumResponseDto**](AlbumResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAlbumMapMarkers** +> List getAlbumMapMarkers(id, key, slug) + +Retrieve album map markers + +Retrieve map marker information for a specific album by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.getAlbumMapMarkers(id, key, slug); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->getAlbumMapMarkers: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**List**](MapMarkerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAlbumStatistics** +> AlbumStatisticsResponseDto getAlbumStatistics() + +Retrieve album statistics + +Returns statistics about the albums available to the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); + +try { + final result = api_instance.getAlbumStatistics(); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->getAlbumStatistics: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**AlbumStatisticsResponseDto**](AlbumStatisticsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAllAlbums** +> List getAllAlbums(assetId, id, isOwned, isShared, name) + +List all albums + +Retrieve a list of albums available to the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter albums containing this asset ID (ignores other parameters) +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Album ID +final isOwned = true; // bool | Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter +final isShared = true; // bool | Filter by shared status: true = only shared, false = not shared, undefined = no filter +final name = name_example; // String | Album name (exact match) + +try { + final result = api_instance.getAllAlbums(assetId, id, isOwned, isShared, name); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->getAllAlbums: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetId** | **String**| Filter albums containing this asset ID (ignores other parameters) | [optional] + **id** | **String**| Album ID | [optional] + **isOwned** | **bool**| Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter | [optional] + **isShared** | **bool**| Filter by shared status: true = only shared, false = not shared, undefined = no filter | [optional] + **name** | **String**| Album name (exact match) | [optional] + +### Return type + +[**List**](AlbumResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeAssetFromAlbum** +> List removeAssetFromAlbum(id, bulkIdsDto) + +Remove assets from an album + +Remove multiple assets from a specific album by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + final result = api_instance.removeAssetFromAlbum(id, bulkIdsDto); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->removeAssetFromAlbum: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeUserFromAlbum** +> removeUserFromAlbum(id, userId) + +Remove user from album + +Remove a user from an album. Use an ID of \"me\" to leave a shared album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Album ID +final userId = userId_example; // String | Album user ID, or \"me\" to reference the current user. + +try { + api_instance.removeUserFromAlbum(id, userId); +} catch (e) { + print('Exception when calling AlbumsApi->removeUserFromAlbum: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Album ID | + **userId** | **String**| Album user ID, or \"me\" to reference the current user. | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAlbumInfo** +> AlbumResponseDto updateAlbumInfo(id, updateAlbumDto) + +Update an album + +Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final updateAlbumDto = UpdateAlbumDto(); // UpdateAlbumDto | + +try { + final result = api_instance.updateAlbumInfo(id, updateAlbumDto); + print(result); +} catch (e) { + print('Exception when calling AlbumsApi->updateAlbumInfo: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **updateAlbumDto** | [**UpdateAlbumDto**](UpdateAlbumDto.md)| | + +### Return type + +[**AlbumResponseDto**](AlbumResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAlbumUser** +> updateAlbumUser(id, userId, updateAlbumUserDto) + +Update user role + +Change the role for a specific user in a specific album. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AlbumsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Album ID +final userId = userId_example; // String | Album user ID, or \"me\" to reference the current user. +final updateAlbumUserDto = UpdateAlbumUserDto(); // UpdateAlbumUserDto | + +try { + api_instance.updateAlbumUser(id, userId, updateAlbumUserDto); +} catch (e) { + print('Exception when calling AlbumsApi->updateAlbumUser: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Album ID | + **userId** | **String**| Album user ID, or \"me\" to reference the current user. | + **updateAlbumUserDto** | [**UpdateAlbumUserDto**](UpdateAlbumUserDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/AlbumsResponse.md b/mobile/openapi/doc/AlbumsResponse.md new file mode 100644 index 0000000000000..a50301c962d04 --- /dev/null +++ b/mobile/openapi/doc/AlbumsResponse.md @@ -0,0 +1,15 @@ +# openapi.model.AlbumsResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**defaultAssetOrder** | [**AssetOrder**](AssetOrder.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AlbumsUpdate.md b/mobile/openapi/doc/AlbumsUpdate.md new file mode 100644 index 0000000000000..65be66456d925 --- /dev/null +++ b/mobile/openapi/doc/AlbumsUpdate.md @@ -0,0 +1,15 @@ +# openapi.model.AlbumsUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**defaultAssetOrder** | [**Optional**](AssetOrder.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ApiKeyCreateDto.md b/mobile/openapi/doc/ApiKeyCreateDto.md new file mode 100644 index 0000000000000..1c97b6080c10f --- /dev/null +++ b/mobile/openapi/doc/ApiKeyCreateDto.md @@ -0,0 +1,16 @@ +# openapi.model.ApiKeyCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Optional** | API key name | [optional] +**permissions** | [**List**](Permission.md) | List of permissions | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ApiKeyCreateResponseDto.md b/mobile/openapi/doc/ApiKeyCreateResponseDto.md new file mode 100644 index 0000000000000..fc1d42ddd2f68 --- /dev/null +++ b/mobile/openapi/doc/ApiKeyCreateResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.ApiKeyCreateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**apiKey** | [**ApiKeyResponseDto**](ApiKeyResponseDto.md) | | +**secret** | **String** | API key secret (only shown once) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ApiKeyResponseDto.md b/mobile/openapi/doc/ApiKeyResponseDto.md new file mode 100644 index 0000000000000..2101f63785eb3 --- /dev/null +++ b/mobile/openapi/doc/ApiKeyResponseDto.md @@ -0,0 +1,19 @@ +# openapi.model.ApiKeyResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**id** | **String** | API key ID | +**name** | **String** | API key name | +**permissions** | [**List**](Permission.md) | List of permissions | [default to const []] +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ApiKeyUpdateDto.md b/mobile/openapi/doc/ApiKeyUpdateDto.md new file mode 100644 index 0000000000000..d3f1608756a71 --- /dev/null +++ b/mobile/openapi/doc/ApiKeyUpdateDto.md @@ -0,0 +1,16 @@ +# openapi.model.ApiKeyUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Optional** | API key name | [optional] +**permissions** | [**Optional?>**](Permission.md) | List of permissions | [optional] [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetBulkDeleteDto.md b/mobile/openapi/doc/AssetBulkDeleteDto.md new file mode 100644 index 0000000000000..fb4c1858105fc --- /dev/null +++ b/mobile/openapi/doc/AssetBulkDeleteDto.md @@ -0,0 +1,16 @@ +# openapi.model.AssetBulkDeleteDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**force** | **Optional** | Force delete even if in use | [optional] +**ids** | **List** | IDs to process | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetBulkUpdateDto.md b/mobile/openapi/doc/AssetBulkUpdateDto.md new file mode 100644 index 0000000000000..8c2117ca7e2ca --- /dev/null +++ b/mobile/openapi/doc/AssetBulkUpdateDto.md @@ -0,0 +1,25 @@ +# openapi.model.AssetBulkUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dateTimeOriginal** | **Optional** | Original date and time | [optional] +**dateTimeRelative** | **Optional** | Relative time offset in minutes | [optional] +**description** | **Optional** | Asset description | [optional] +**duplicateId** | **Optional** | Duplicate ID | [optional] +**ids** | **List** | Asset IDs to update | [default to const []] +**isFavorite** | **Optional** | Mark as favorite | [optional] +**latitude** | **Optional** | Latitude coordinate | [optional] +**longitude** | **Optional** | Longitude coordinate | [optional] +**rating** | **Optional** | Rating in range [1-5] (starred), -1 (rejected), or null (unrated) | [optional] +**timeZone** | **Optional** | Time zone (IANA timezone) | [optional] +**visibility** | [**Optional**](AssetVisibility.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetBulkUploadCheckDto.md b/mobile/openapi/doc/AssetBulkUploadCheckDto.md new file mode 100644 index 0000000000000..2332ae2236af0 --- /dev/null +++ b/mobile/openapi/doc/AssetBulkUploadCheckDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetBulkUploadCheckDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assets** | [**List**](AssetBulkUploadCheckItem.md) | Assets to check | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetBulkUploadCheckItem.md b/mobile/openapi/doc/AssetBulkUploadCheckItem.md new file mode 100644 index 0000000000000..e0b1bc6ab529a --- /dev/null +++ b/mobile/openapi/doc/AssetBulkUploadCheckItem.md @@ -0,0 +1,16 @@ +# openapi.model.AssetBulkUploadCheckItem + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checksum** | **String** | Base64 or hex encoded SHA1 hash | +**id** | **String** | Client-side identifier echoed in the response to match results to inputs (e.g. filename) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetBulkUploadCheckResponseDto.md b/mobile/openapi/doc/AssetBulkUploadCheckResponseDto.md new file mode 100644 index 0000000000000..578c73650212d --- /dev/null +++ b/mobile/openapi/doc/AssetBulkUploadCheckResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetBulkUploadCheckResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**List**](AssetBulkUploadCheckResult.md) | Upload check results | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetBulkUploadCheckResult.md b/mobile/openapi/doc/AssetBulkUploadCheckResult.md new file mode 100644 index 0000000000000..2211db86df74a --- /dev/null +++ b/mobile/openapi/doc/AssetBulkUploadCheckResult.md @@ -0,0 +1,19 @@ +# openapi.model.AssetBulkUploadCheckResult + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**AssetUploadAction**](AssetUploadAction.md) | | +**assetId** | **Optional** | Existing asset ID if duplicate | [optional] +**id** | **String** | Client-side identifier echoed from the request to match results to inputs | +**isTrashed** | **Optional** | Whether existing asset is trashed | [optional] +**reason** | [**Optional**](AssetRejectReason.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetCopyDto.md b/mobile/openapi/doc/AssetCopyDto.md new file mode 100644 index 0000000000000..3c7af31a8371a --- /dev/null +++ b/mobile/openapi/doc/AssetCopyDto.md @@ -0,0 +1,21 @@ +# openapi.model.AssetCopyDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albums** | **Optional** | Copy album associations | [optional] [default to true] +**favorite** | **Optional** | Copy favorite status | [optional] [default to true] +**sharedLinks** | **Optional** | Copy shared links | [optional] [default to true] +**sidecar** | **Optional** | Copy sidecar file | [optional] [default to true] +**sourceId** | **String** | Source asset ID | +**stack** | **Optional** | Copy stack association | [optional] [default to true] +**targetId** | **String** | Target asset ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetEditAction.md b/mobile/openapi/doc/AssetEditAction.md new file mode 100644 index 0000000000000..b9221cab1b5e9 --- /dev/null +++ b/mobile/openapi/doc/AssetEditAction.md @@ -0,0 +1,14 @@ +# openapi.model.AssetEditAction + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetEditActionItemDto.md b/mobile/openapi/doc/AssetEditActionItemDto.md new file mode 100644 index 0000000000000..714e1a406bf24 --- /dev/null +++ b/mobile/openapi/doc/AssetEditActionItemDto.md @@ -0,0 +1,16 @@ +# openapi.model.AssetEditActionItemDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**AssetEditAction**](AssetEditAction.md) | | +**parameters** | [**AssetEditActionItemDtoParameters**](AssetEditActionItemDtoParameters.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetEditActionItemDtoParameters.md b/mobile/openapi/doc/AssetEditActionItemDtoParameters.md new file mode 100644 index 0000000000000..8142a2ff74992 --- /dev/null +++ b/mobile/openapi/doc/AssetEditActionItemDtoParameters.md @@ -0,0 +1,20 @@ +# openapi.model.AssetEditActionItemDtoParameters + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**height** | **int** | Height of the crop | +**width** | **int** | Width of the crop | +**x** | **int** | Top-Left X coordinate of crop | +**y** | **int** | Top-Left Y coordinate of crop | +**angle** | **num** | Rotation angle in degrees | +**axis** | [**MirrorAxis**](MirrorAxis.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetEditActionItemResponseDto.md b/mobile/openapi/doc/AssetEditActionItemResponseDto.md new file mode 100644 index 0000000000000..a4d2cf70a642b --- /dev/null +++ b/mobile/openapi/doc/AssetEditActionItemResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.AssetEditActionItemResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**AssetEditAction**](AssetEditAction.md) | | +**id** | **String** | Asset edit ID | +**parameters** | [**AssetEditActionItemDtoParameters**](AssetEditActionItemDtoParameters.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetEditsCreateDto.md b/mobile/openapi/doc/AssetEditsCreateDto.md new file mode 100644 index 0000000000000..59e9f77fe9648 --- /dev/null +++ b/mobile/openapi/doc/AssetEditsCreateDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetEditsCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**edits** | [**List**](AssetEditActionItemDto.md) | List of edit actions to apply (crop, rotate, or mirror) | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetEditsResponseDto.md b/mobile/openapi/doc/AssetEditsResponseDto.md new file mode 100644 index 0000000000000..6d2dafc820a5e --- /dev/null +++ b/mobile/openapi/doc/AssetEditsResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.AssetEditsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID these edits belong to | +**edits** | [**List**](AssetEditActionItemResponseDto.md) | List of edit actions applied to the asset | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetFaceCreateDto.md b/mobile/openapi/doc/AssetFaceCreateDto.md new file mode 100644 index 0000000000000..991138328d066 --- /dev/null +++ b/mobile/openapi/doc/AssetFaceCreateDto.md @@ -0,0 +1,22 @@ +# openapi.model.AssetFaceCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**height** | **int** | Face bounding box height | +**imageHeight** | **int** | Image height in pixels | +**imageWidth** | **int** | Image width in pixels | +**personId** | **String** | Person ID | +**width** | **int** | Face bounding box width | +**x** | **int** | Face bounding box X coordinate | +**y** | **int** | Face bounding box Y coordinate | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetFaceDeleteDto.md b/mobile/openapi/doc/AssetFaceDeleteDto.md new file mode 100644 index 0000000000000..9af933ffcdcaf --- /dev/null +++ b/mobile/openapi/doc/AssetFaceDeleteDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetFaceDeleteDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**force** | **bool** | Force delete even if person has other faces | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetFaceResponseDto.md b/mobile/openapi/doc/AssetFaceResponseDto.md new file mode 100644 index 0000000000000..fcff7c2001250 --- /dev/null +++ b/mobile/openapi/doc/AssetFaceResponseDto.md @@ -0,0 +1,23 @@ +# openapi.model.AssetFaceResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**boundingBoxX1** | **int** | Bounding box X1 coordinate | +**boundingBoxX2** | **int** | Bounding box X2 coordinate | +**boundingBoxY1** | **int** | Bounding box Y1 coordinate | +**boundingBoxY2** | **int** | Bounding box Y2 coordinate | +**id** | **String** | Face ID | +**imageHeight** | **int** | Image height in pixels | +**imageWidth** | **int** | Image width in pixels | +**person** | [**PersonResponseDto**](PersonResponseDto.md) | | +**sourceType** | [**Optional**](SourceType.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetFaceUpdateDto.md b/mobile/openapi/doc/AssetFaceUpdateDto.md new file mode 100644 index 0000000000000..c74db6f5140d6 --- /dev/null +++ b/mobile/openapi/doc/AssetFaceUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetFaceUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**List**](AssetFaceUpdateItem.md) | Face update items | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetFaceUpdateItem.md b/mobile/openapi/doc/AssetFaceUpdateItem.md new file mode 100644 index 0000000000000..d7c26c2ab506e --- /dev/null +++ b/mobile/openapi/doc/AssetFaceUpdateItem.md @@ -0,0 +1,16 @@ +# openapi.model.AssetFaceUpdateItem + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**personId** | **String** | Person ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetIdErrorReason.md b/mobile/openapi/doc/AssetIdErrorReason.md new file mode 100644 index 0000000000000..1e7c1c7d34635 --- /dev/null +++ b/mobile/openapi/doc/AssetIdErrorReason.md @@ -0,0 +1,14 @@ +# openapi.model.AssetIdErrorReason + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetIdsDto.md b/mobile/openapi/doc/AssetIdsDto.md new file mode 100644 index 0000000000000..151e1a9e16032 --- /dev/null +++ b/mobile/openapi/doc/AssetIdsDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetIdsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetIds** | **List** | Asset IDs | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetIdsResponseDto.md b/mobile/openapi/doc/AssetIdsResponseDto.md new file mode 100644 index 0000000000000..d8d7808936b82 --- /dev/null +++ b/mobile/openapi/doc/AssetIdsResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.AssetIdsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**error** | [**Optional**](AssetIdErrorReason.md) | | [optional] +**success** | **bool** | Whether operation succeeded | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetJobName.md b/mobile/openapi/doc/AssetJobName.md new file mode 100644 index 0000000000000..d9612705ac4bb --- /dev/null +++ b/mobile/openapi/doc/AssetJobName.md @@ -0,0 +1,14 @@ +# openapi.model.AssetJobName + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetJobsDto.md b/mobile/openapi/doc/AssetJobsDto.md new file mode 100644 index 0000000000000..3ff910ba35016 --- /dev/null +++ b/mobile/openapi/doc/AssetJobsDto.md @@ -0,0 +1,16 @@ +# openapi.model.AssetJobsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetIds** | **List** | Asset IDs | [default to const []] +**name** | [**AssetJobName**](AssetJobName.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMediaResponseDto.md b/mobile/openapi/doc/AssetMediaResponseDto.md new file mode 100644 index 0000000000000..7d343737463e4 --- /dev/null +++ b/mobile/openapi/doc/AssetMediaResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.AssetMediaResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Asset media ID | +**status** | [**AssetMediaStatus**](AssetMediaStatus.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMediaSize.md b/mobile/openapi/doc/AssetMediaSize.md new file mode 100644 index 0000000000000..192ac4d9468d4 --- /dev/null +++ b/mobile/openapi/doc/AssetMediaSize.md @@ -0,0 +1,14 @@ +# openapi.model.AssetMediaSize + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMediaStatus.md b/mobile/openapi/doc/AssetMediaStatus.md new file mode 100644 index 0000000000000..3deeee9419ae6 --- /dev/null +++ b/mobile/openapi/doc/AssetMediaStatus.md @@ -0,0 +1,14 @@ +# openapi.model.AssetMediaStatus + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataBulkDeleteDto.md b/mobile/openapi/doc/AssetMetadataBulkDeleteDto.md new file mode 100644 index 0000000000000..e92869a789be7 --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataBulkDeleteDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetMetadataBulkDeleteDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List**](AssetMetadataBulkDeleteItemDto.md) | Metadata items to delete | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataBulkDeleteItemDto.md b/mobile/openapi/doc/AssetMetadataBulkDeleteItemDto.md new file mode 100644 index 0000000000000..84ec108538b31 --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataBulkDeleteItemDto.md @@ -0,0 +1,16 @@ +# openapi.model.AssetMetadataBulkDeleteItemDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**key** | **String** | Metadata key | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataBulkResponseDto.md b/mobile/openapi/doc/AssetMetadataBulkResponseDto.md new file mode 100644 index 0000000000000..07cc2665bf779 --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataBulkResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.AssetMetadataBulkResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**key** | **String** | Metadata key | +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | +**value** | **Map** | Metadata value (object) | [default to const {}] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataBulkUpsertDto.md b/mobile/openapi/doc/AssetMetadataBulkUpsertDto.md new file mode 100644 index 0000000000000..c7cbbf866d084 --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataBulkUpsertDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetMetadataBulkUpsertDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List**](AssetMetadataBulkUpsertItemDto.md) | Metadata items to upsert | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataBulkUpsertItemDto.md b/mobile/openapi/doc/AssetMetadataBulkUpsertItemDto.md new file mode 100644 index 0000000000000..bfbdbabdb8475 --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataBulkUpsertItemDto.md @@ -0,0 +1,17 @@ +# openapi.model.AssetMetadataBulkUpsertItemDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**key** | **String** | Metadata key | +**value** | **Map** | Metadata value (object) | [default to const {}] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataResponseDto.md b/mobile/openapi/doc/AssetMetadataResponseDto.md new file mode 100644 index 0000000000000..e4e1419f1f87f --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.AssetMetadataResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **String** | Metadata key | +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | +**value** | **Map** | Metadata value (object) | [default to const {}] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataUpsertDto.md b/mobile/openapi/doc/AssetMetadataUpsertDto.md new file mode 100644 index 0000000000000..38629983b47ea --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataUpsertDto.md @@ -0,0 +1,15 @@ +# openapi.model.AssetMetadataUpsertDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List**](AssetMetadataUpsertItemDto.md) | Metadata items to upsert | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetMetadataUpsertItemDto.md b/mobile/openapi/doc/AssetMetadataUpsertItemDto.md new file mode 100644 index 0000000000000..73a9a0e021226 --- /dev/null +++ b/mobile/openapi/doc/AssetMetadataUpsertItemDto.md @@ -0,0 +1,16 @@ +# openapi.model.AssetMetadataUpsertItemDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **String** | Metadata key | +**value** | **Map** | Metadata value (object) | [default to const {}] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetOcrResponseDto.md b/mobile/openapi/doc/AssetOcrResponseDto.md new file mode 100644 index 0000000000000..820ee6c630003 --- /dev/null +++ b/mobile/openapi/doc/AssetOcrResponseDto.md @@ -0,0 +1,27 @@ +# openapi.model.AssetOcrResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | | +**boxScore** | **double** | Confidence score for text detection box | +**id** | **String** | | +**text** | **String** | Recognized text | +**textScore** | **double** | Confidence score for text recognition | +**x1** | **double** | Normalized x coordinate of box corner 1 (0-1) | +**x2** | **double** | Normalized x coordinate of box corner 2 (0-1) | +**x3** | **double** | Normalized x coordinate of box corner 3 (0-1) | +**x4** | **double** | Normalized x coordinate of box corner 4 (0-1) | +**y1** | **double** | Normalized y coordinate of box corner 1 (0-1) | +**y2** | **double** | Normalized y coordinate of box corner 2 (0-1) | +**y3** | **double** | Normalized y coordinate of box corner 3 (0-1) | +**y4** | **double** | Normalized y coordinate of box corner 4 (0-1) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetOrder.md b/mobile/openapi/doc/AssetOrder.md new file mode 100644 index 0000000000000..d1460775e0b98 --- /dev/null +++ b/mobile/openapi/doc/AssetOrder.md @@ -0,0 +1,14 @@ +# openapi.model.AssetOrder + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetOrderBy.md b/mobile/openapi/doc/AssetOrderBy.md new file mode 100644 index 0000000000000..89db28aea77d6 --- /dev/null +++ b/mobile/openapi/doc/AssetOrderBy.md @@ -0,0 +1,14 @@ +# openapi.model.AssetOrderBy + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetRejectReason.md b/mobile/openapi/doc/AssetRejectReason.md new file mode 100644 index 0000000000000..9f5e2a4f1ac66 --- /dev/null +++ b/mobile/openapi/doc/AssetRejectReason.md @@ -0,0 +1,14 @@ +# openapi.model.AssetRejectReason + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetResponseDto.md b/mobile/openapi/doc/AssetResponseDto.md new file mode 100644 index 0000000000000..4dd5ace6cb517 --- /dev/null +++ b/mobile/openapi/doc/AssetResponseDto.md @@ -0,0 +1,46 @@ +# openapi.model.AssetResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checksum** | **String** | Base64 encoded SHA1 hash | +**createdAt** | [**DateTime**](DateTime.md) | The UTC timestamp when the asset was originally uploaded to Immich. | +**duplicateId** | **Optional** | Duplicate group ID | [optional] +**duration** | **int** | Video/gif duration in milliseconds (null for static images) | +**exifInfo** | [**Optional**](ExifResponseDto.md) | | [optional] +**fileCreatedAt** | [**DateTime**](DateTime.md) | The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken. | +**fileModifiedAt** | [**DateTime**](DateTime.md) | The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken. | +**hasMetadata** | **bool** | Whether asset has metadata | +**height** | **int** | Asset height | +**id** | **String** | Asset ID | +**isArchived** | **bool** | Is archived | +**isEdited** | **bool** | Is edited | +**isFavorite** | **bool** | Is favorite | +**isOffline** | **bool** | Is offline | +**isTrashed** | **bool** | Is trashed | +**libraryId** | **Optional** | Library ID | [optional] +**livePhotoVideoId** | **Optional** | Live photo video ID | [optional] +**localDateTime** | [**DateTime**](DateTime.md) | The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by \"local\" days and months. | +**originalFileName** | **String** | Original file name | +**originalMimeType** | **Optional** | Original MIME type | [optional] +**originalPath** | **String** | Original file path | +**owner** | [**Optional**](UserResponseDto.md) | | [optional] +**ownerId** | **String** | Owner user ID | +**people** | [**Optional?>**](PersonResponseDto.md) | | [optional] [default to const []] +**resized** | **Optional** | Is resized | [optional] +**stack** | [**Optional**](AssetStackResponseDto.md) | | [optional] +**tags** | [**Optional?>**](TagResponseDto.md) | | [optional] [default to const []] +**thumbhash** | **String** | Thumbhash for thumbnail generation (base64) also used as the c query param for thumbnail cache busting. | +**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | | +**updatedAt** | [**DateTime**](DateTime.md) | The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified. | +**visibility** | [**AssetVisibility**](AssetVisibility.md) | | +**width** | **int** | Asset width | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetStackResponseDto.md b/mobile/openapi/doc/AssetStackResponseDto.md new file mode 100644 index 0000000000000..2a7739f47880f --- /dev/null +++ b/mobile/openapi/doc/AssetStackResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.AssetStackResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetCount** | **int** | Number of assets in stack | +**id** | **String** | Stack ID | +**primaryAssetId** | **String** | Primary asset ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetStatsResponseDto.md b/mobile/openapi/doc/AssetStatsResponseDto.md new file mode 100644 index 0000000000000..5697c5ad175ea --- /dev/null +++ b/mobile/openapi/doc/AssetStatsResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.AssetStatsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**images** | **int** | Number of images | +**total** | **int** | Total number of assets | +**videos** | **int** | Number of videos | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetTypeEnum.md b/mobile/openapi/doc/AssetTypeEnum.md new file mode 100644 index 0000000000000..8d514b090eb32 --- /dev/null +++ b/mobile/openapi/doc/AssetTypeEnum.md @@ -0,0 +1,14 @@ +# openapi.model.AssetTypeEnum + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetUploadAction.md b/mobile/openapi/doc/AssetUploadAction.md new file mode 100644 index 0000000000000..05d13e91a0679 --- /dev/null +++ b/mobile/openapi/doc/AssetUploadAction.md @@ -0,0 +1,14 @@ +# openapi.model.AssetUploadAction + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetVisibility.md b/mobile/openapi/doc/AssetVisibility.md new file mode 100644 index 0000000000000..b1f67e7e1d72f --- /dev/null +++ b/mobile/openapi/doc/AssetVisibility.md @@ -0,0 +1,14 @@ +# openapi.model.AssetVisibility + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AssetsApi.md b/mobile/openapi/doc/AssetsApi.md new file mode 100644 index 0000000000000..323620540445a --- /dev/null +++ b/mobile/openapi/doc/AssetsApi.md @@ -0,0 +1,1605 @@ +# openapi.api.AssetsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**checkBulkUpload**](AssetsApi.md#checkbulkupload) | **POST** /assets/bulk-upload-check | Check bulk upload +[**copyAsset**](AssetsApi.md#copyasset) | **PUT** /assets/copy | Copy asset +[**deleteAssetMetadata**](AssetsApi.md#deleteassetmetadata) | **DELETE** /assets/{id}/metadata/{key} | Delete asset metadata by key +[**deleteAssets**](AssetsApi.md#deleteassets) | **DELETE** /assets | Delete assets +[**deleteBulkAssetMetadata**](AssetsApi.md#deletebulkassetmetadata) | **DELETE** /assets/metadata | Delete asset metadata +[**downloadAsset**](AssetsApi.md#downloadasset) | **GET** /assets/{id}/original | Download original asset +[**editAsset**](AssetsApi.md#editasset) | **PUT** /assets/{id}/edits | Apply edits to an existing asset +[**endSession**](AssetsApi.md#endsession) | **DELETE** /assets/{id}/video/stream/{sessionId} | End HLS streaming session +[**getAssetEdits**](AssetsApi.md#getassetedits) | **GET** /assets/{id}/edits | Retrieve edits for an existing asset +[**getAssetInfo**](AssetsApi.md#getassetinfo) | **GET** /assets/{id} | Retrieve an asset +[**getAssetMetadata**](AssetsApi.md#getassetmetadata) | **GET** /assets/{id}/metadata | Get asset metadata +[**getAssetMetadataByKey**](AssetsApi.md#getassetmetadatabykey) | **GET** /assets/{id}/metadata/{key} | Retrieve asset metadata by key +[**getAssetOcr**](AssetsApi.md#getassetocr) | **GET** /assets/{id}/ocr | Retrieve asset OCR data +[**getAssetStatistics**](AssetsApi.md#getassetstatistics) | **GET** /assets/statistics | Get asset statistics +[**getMainPlaylist**](AssetsApi.md#getmainplaylist) | **GET** /assets/{id}/video/stream/main.m3u8 | Get HLS main playlist +[**getMediaPlaylist**](AssetsApi.md#getmediaplaylist) | **GET** /assets/{id}/video/stream/{sessionId}/{variantIndex}/playlist.m3u8 | Get HLS media playlist +[**getSegment**](AssetsApi.md#getsegment) | **GET** /assets/{id}/video/stream/{sessionId}/{variantIndex}/{filename} | Get HLS segment or init file +[**playAssetVideo**](AssetsApi.md#playassetvideo) | **GET** /assets/{id}/video/playback | Play asset video +[**removeAssetEdits**](AssetsApi.md#removeassetedits) | **DELETE** /assets/{id}/edits | Remove edits from an existing asset +[**runAssetJobs**](AssetsApi.md#runassetjobs) | **POST** /assets/jobs | Run an asset job +[**updateAsset**](AssetsApi.md#updateasset) | **PUT** /assets/{id} | Update an asset +[**updateAssetMetadata**](AssetsApi.md#updateassetmetadata) | **PUT** /assets/{id}/metadata | Update asset metadata +[**updateAssets**](AssetsApi.md#updateassets) | **PUT** /assets | Update assets +[**updateBulkAssetMetadata**](AssetsApi.md#updatebulkassetmetadata) | **PUT** /assets/metadata | Upsert asset metadata +[**uploadAsset**](AssetsApi.md#uploadasset) | **POST** /assets | Upload asset +[**viewAsset**](AssetsApi.md#viewasset) | **GET** /assets/{id}/thumbnail | View asset thumbnail + + +# **checkBulkUpload** +> AssetBulkUploadCheckResponseDto checkBulkUpload(assetBulkUploadCheckDto) + +Check bulk upload + +Determine which assets have already been uploaded to the server based on their SHA1 checksums. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetBulkUploadCheckDto = AssetBulkUploadCheckDto(); // AssetBulkUploadCheckDto | + +try { + final result = api_instance.checkBulkUpload(assetBulkUploadCheckDto); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->checkBulkUpload: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetBulkUploadCheckDto** | [**AssetBulkUploadCheckDto**](AssetBulkUploadCheckDto.md)| | + +### Return type + +[**AssetBulkUploadCheckResponseDto**](AssetBulkUploadCheckResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **copyAsset** +> copyAsset(assetCopyDto) + +Copy asset + +Copy asset information like albums, tags, etc. from one asset to another. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetCopyDto = AssetCopyDto(); // AssetCopyDto | + +try { + api_instance.copyAsset(assetCopyDto); +} catch (e) { + print('Exception when calling AssetsApi->copyAsset: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetCopyDto** | [**AssetCopyDto**](AssetCopyDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteAssetMetadata** +> deleteAssetMetadata(id, key) + +Delete asset metadata by key + +Delete a specific metadata key-value pair associated with the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Asset ID +final key = key_example; // String | Metadata key + +try { + api_instance.deleteAssetMetadata(id, key); +} catch (e) { + print('Exception when calling AssetsApi->deleteAssetMetadata: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Asset ID | + **key** | **String**| Metadata key | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteAssets** +> deleteAssets(assetBulkDeleteDto) + +Delete assets + +Deletes multiple assets at the same time. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetBulkDeleteDto = AssetBulkDeleteDto(); // AssetBulkDeleteDto | + +try { + api_instance.deleteAssets(assetBulkDeleteDto); +} catch (e) { + print('Exception when calling AssetsApi->deleteAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetBulkDeleteDto** | [**AssetBulkDeleteDto**](AssetBulkDeleteDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteBulkAssetMetadata** +> deleteBulkAssetMetadata(assetMetadataBulkDeleteDto) + +Delete asset metadata + +Delete metadata key-value pairs for multiple assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetMetadataBulkDeleteDto = AssetMetadataBulkDeleteDto(); // AssetMetadataBulkDeleteDto | + +try { + api_instance.deleteBulkAssetMetadata(assetMetadataBulkDeleteDto); +} catch (e) { + print('Exception when calling AssetsApi->deleteBulkAssetMetadata: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetMetadataBulkDeleteDto** | [**AssetMetadataBulkDeleteDto**](AssetMetadataBulkDeleteDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **downloadAsset** +> MultipartFile downloadAsset(id, edited, key, slug) + +Download original asset + +Downloads the original file of the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final edited = true; // bool | Return edited asset if available +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.downloadAsset(id, edited, key, slug); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->downloadAsset: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **edited** | **bool**| Return edited asset if available | [optional] [default to false] + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **editAsset** +> AssetEditsResponseDto editAsset(id, assetEditsCreateDto) + +Apply edits to an existing asset + +Apply a series of edit actions (crop, rotate, mirror) to the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final assetEditsCreateDto = AssetEditsCreateDto(); // AssetEditsCreateDto | + +try { + final result = api_instance.editAsset(id, assetEditsCreateDto); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->editAsset: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **assetEditsCreateDto** | [**AssetEditsCreateDto**](AssetEditsCreateDto.md)| | + +### Return type + +[**AssetEditsResponseDto**](AssetEditsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **endSession** +> endSession(id, sessionId, key, slug) + +End HLS streaming session + +Releases server resources for the streaming session. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final sessionId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + api_instance.endSession(id, sessionId, key, slug); +} catch (e) { + print('Exception when calling AssetsApi->endSession: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **sessionId** | **String**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAssetEdits** +> AssetEditsResponseDto getAssetEdits(id) + +Retrieve edits for an existing asset + +Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getAssetEdits(id); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getAssetEdits: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**AssetEditsResponseDto**](AssetEditsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAssetInfo** +> AssetResponseDto getAssetInfo(id, key, slug) + +Retrieve an asset + +Retrieve detailed information about a specific asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.getAssetInfo(id, key, slug); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getAssetInfo: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**AssetResponseDto**](AssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAssetMetadata** +> List getAssetMetadata(id) + +Get asset metadata + +Retrieve all metadata key-value pairs associated with the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getAssetMetadata(id); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getAssetMetadata: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**List**](AssetMetadataResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAssetMetadataByKey** +> AssetMetadataResponseDto getAssetMetadataByKey(id, key) + +Retrieve asset metadata by key + +Retrieve the value of a specific metadata key associated with the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Asset ID +final key = key_example; // String | Metadata key + +try { + final result = api_instance.getAssetMetadataByKey(id, key); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getAssetMetadataByKey: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Asset ID | + **key** | **String**| Metadata key | + +### Return type + +[**AssetMetadataResponseDto**](AssetMetadataResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAssetOcr** +> List getAssetOcr(id) + +Retrieve asset OCR data + +Retrieve all OCR (Optical Character Recognition) data associated with the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getAssetOcr(id); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getAssetOcr: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**List**](AssetOcrResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAssetStatistics** +> AssetStatsResponseDto getAssetStatistics(isFavorite, isTrashed, visibility) + +Get asset statistics + +Retrieve various statistics about the assets owned by the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final isFavorite = true; // bool | Filter by favorite status +final isTrashed = true; // bool | Filter by trash status +final visibility = ; // AssetVisibility | + +try { + final result = api_instance.getAssetStatistics(isFavorite, isTrashed, visibility); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getAssetStatistics: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **isFavorite** | **bool**| Filter by favorite status | [optional] + **isTrashed** | **bool**| Filter by trash status | [optional] + **visibility** | [**AssetVisibility**](.md)| | [optional] + +### Return type + +[**AssetStatsResponseDto**](AssetStatsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMainPlaylist** +> String getMainPlaylist(id, key, slug) + +Get HLS main playlist + +Returns an HLS main playlist with all available variants for the asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.getMainPlaylist(id, key, slug); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getMainPlaylist: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +**String** + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.apple.mpegurl + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMediaPlaylist** +> String getMediaPlaylist(id, sessionId, variantIndex, key, slug, xImmichHlsPos) + +Get HLS media playlist + +Returns an HLS media playlist for one variant of the streaming session. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final sessionId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final variantIndex = 56; // int | +final key = key_example; // String | +final slug = slug_example; // String | +final xImmichHlsPos = 8.14; // num | + +try { + final result = api_instance.getMediaPlaylist(id, sessionId, variantIndex, key, slug, xImmichHlsPos); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getMediaPlaylist: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **sessionId** | **String**| | + **variantIndex** | **int**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + **xImmichHlsPos** | **num**| | [optional] + +### Return type + +**String** + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.apple.mpegurl + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSegment** +> MultipartFile getSegment(filename, id, sessionId, variantIndex, key, slug, xImmichHlsMsn) + +Get HLS segment or init file + +Streams an HLS init segment (init.mp4) or media segment (seg_N.m4s). + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final filename = filename_example; // String | +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final sessionId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final variantIndex = 56; // int | +final key = key_example; // String | +final slug = slug_example; // String | +final xImmichHlsMsn = 56; // int | + +try { + final result = api_instance.getSegment(filename, id, sessionId, variantIndex, key, slug, xImmichHlsMsn); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->getSegment: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filename** | **String**| | + **id** | **String**| | + **sessionId** | **String**| | + **variantIndex** | **int**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + **xImmichHlsMsn** | **int**| | [optional] + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **playAssetVideo** +> MultipartFile playAssetVideo(id, key, slug) + +Play asset video + +Streams the video file for the specified asset. This endpoint also supports byte range requests. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.playAssetVideo(id, key, slug); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->playAssetVideo: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeAssetEdits** +> removeAssetEdits(id) + +Remove edits from an existing asset + +Removes all edit actions (crop, rotate, mirror) associated with the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.removeAssetEdits(id); +} catch (e) { + print('Exception when calling AssetsApi->removeAssetEdits: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **runAssetJobs** +> runAssetJobs(assetJobsDto) + +Run an asset job + +Run a specific job on a set of assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetJobsDto = AssetJobsDto(); // AssetJobsDto | + +try { + api_instance.runAssetJobs(assetJobsDto); +} catch (e) { + print('Exception when calling AssetsApi->runAssetJobs: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetJobsDto** | [**AssetJobsDto**](AssetJobsDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAsset** +> AssetResponseDto updateAsset(id, updateAssetDto) + +Update an asset + +Update information of a specific asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto | + +try { + final result = api_instance.updateAsset(id, updateAssetDto); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->updateAsset: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **updateAssetDto** | [**UpdateAssetDto**](UpdateAssetDto.md)| | + +### Return type + +[**AssetResponseDto**](AssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAssetMetadata** +> List updateAssetMetadata(id, assetMetadataUpsertDto) + +Update asset metadata + +Update or add metadata key-value pairs for the specified asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final assetMetadataUpsertDto = AssetMetadataUpsertDto(); // AssetMetadataUpsertDto | + +try { + final result = api_instance.updateAssetMetadata(id, assetMetadataUpsertDto); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->updateAssetMetadata: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **assetMetadataUpsertDto** | [**AssetMetadataUpsertDto**](AssetMetadataUpsertDto.md)| | + +### Return type + +[**List**](AssetMetadataResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAssets** +> updateAssets(assetBulkUpdateDto) + +Update assets + +Updates multiple assets at the same time. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetBulkUpdateDto = AssetBulkUpdateDto(); // AssetBulkUpdateDto | + +try { + api_instance.updateAssets(assetBulkUpdateDto); +} catch (e) { + print('Exception when calling AssetsApi->updateAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetBulkUpdateDto** | [**AssetBulkUpdateDto**](AssetBulkUpdateDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateBulkAssetMetadata** +> List updateBulkAssetMetadata(assetMetadataBulkUpsertDto) + +Upsert asset metadata + +Upsert metadata key-value pairs for multiple assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetMetadataBulkUpsertDto = AssetMetadataBulkUpsertDto(); // AssetMetadataBulkUpsertDto | + +try { + final result = api_instance.updateBulkAssetMetadata(assetMetadataBulkUpsertDto); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->updateBulkAssetMetadata: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetMetadataBulkUpsertDto** | [**AssetMetadataBulkUpsertDto**](AssetMetadataBulkUpsertDto.md)| | + +### Return type + +[**List**](AssetMetadataBulkResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **uploadAsset** +> AssetMediaResponseDto uploadAsset(assetData, fileCreatedAt, fileModifiedAt, key, slug, xImmichChecksum, duration, filename, isFavorite, livePhotoVideoId, metadata, sidecarData, visibility) + +Upload asset + +Uploads a new asset to the server. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final assetData = BINARY_DATA_HERE; // MultipartFile | Asset file data +final fileCreatedAt = 2013-10-20T19:20:30+01:00; // DateTime | File creation date +final fileModifiedAt = 2013-10-20T19:20:30+01:00; // DateTime | File modification date +final key = key_example; // String | +final slug = slug_example; // String | +final xImmichChecksum = xImmichChecksum_example; // String | sha1 checksum that can be used for duplicate detection before the file is uploaded +final duration = 56; // int | Duration in milliseconds (for videos) +final filename = filename_example; // String | Filename +final isFavorite = true; // bool | Mark as favorite +final livePhotoVideoId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Live photo video ID +final metadata = []; // List | Asset metadata items +final sidecarData = BINARY_DATA_HERE; // MultipartFile | Sidecar file data +final visibility = ; // AssetVisibility | + +try { + final result = api_instance.uploadAsset(assetData, fileCreatedAt, fileModifiedAt, key, slug, xImmichChecksum, duration, filename, isFavorite, livePhotoVideoId, metadata, sidecarData, visibility); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->uploadAsset: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetData** | **MultipartFile**| Asset file data | + **fileCreatedAt** | **DateTime**| File creation date | + **fileModifiedAt** | **DateTime**| File modification date | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + **xImmichChecksum** | **String**| sha1 checksum that can be used for duplicate detection before the file is uploaded | [optional] + **duration** | **int**| Duration in milliseconds (for videos) | [optional] + **filename** | **String**| Filename | [optional] + **isFavorite** | **bool**| Mark as favorite | [optional] + **livePhotoVideoId** | **String**| Live photo video ID | [optional] + **metadata** | [**List**](AssetMetadataUpsertItemDto.md)| Asset metadata items | [optional] + **sidecarData** | **MultipartFile**| Sidecar file data | [optional] + **visibility** | [**AssetVisibility**](AssetVisibility.md)| | [optional] + +### Return type + +[**AssetMediaResponseDto**](AssetMediaResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **viewAsset** +> MultipartFile viewAsset(id, edited, key, size, slug) + +View asset thumbnail + +Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AssetsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final edited = true; // bool | Return edited asset if available +final key = key_example; // String | +final size = ; // AssetMediaSize | +final slug = slug_example; // String | + +try { + final result = api_instance.viewAsset(id, edited, key, size, slug); + print(result); +} catch (e) { + print('Exception when calling AssetsApi->viewAsset: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **edited** | **bool**| Return edited asset if available | [optional] [default to false] + **key** | **String**| | [optional] + **size** | [**AssetMediaSize**](.md)| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/AudioCodec.md b/mobile/openapi/doc/AudioCodec.md new file mode 100644 index 0000000000000..eef8591857f78 --- /dev/null +++ b/mobile/openapi/doc/AudioCodec.md @@ -0,0 +1,14 @@ +# openapi.model.AudioCodec + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AuthApi.md b/mobile/openapi/doc/AuthApi.md new file mode 100644 index 0000000000000..ac91cc3850202 --- /dev/null +++ b/mobile/openapi/doc/AuthApi.md @@ -0,0 +1,51 @@ +# openapi.api.AuthApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**oidcDeviceFlow**](AuthApi.md#oidcdeviceflow) | **GET** /yucca/auth/oidc/device | + + +# **oidcDeviceFlow** +> DeviceFlowResponseDto oidcDeviceFlow() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = AuthApi(); + +try { + final result = api_instance.oidcDeviceFlow(); + print(result); +} catch (e) { + print('Exception when calling AuthApi->oidcDeviceFlow: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**DeviceFlowResponseDto**](DeviceFlowResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/AuthStatusResponseDto.md b/mobile/openapi/doc/AuthStatusResponseDto.md new file mode 100644 index 0000000000000..a82941d396918 --- /dev/null +++ b/mobile/openapi/doc/AuthStatusResponseDto.md @@ -0,0 +1,19 @@ +# openapi.model.AuthStatusResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expiresAt** | **Optional** | Session expiration date | [optional] +**isElevated** | **bool** | Is elevated session | +**password** | **bool** | Has password set | +**pinCode** | **bool** | Has PIN code set | +**pinExpiresAt** | **Optional** | PIN expiration date | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/AuthenticationAdminApi.md b/mobile/openapi/doc/AuthenticationAdminApi.md new file mode 100644 index 0000000000000..fc6d58e0ba44c --- /dev/null +++ b/mobile/openapi/doc/AuthenticationAdminApi.md @@ -0,0 +1,66 @@ +# openapi.api.AuthenticationAdminApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**unlinkAllOAuthAccountsAdmin**](AuthenticationAdminApi.md#unlinkalloauthaccountsadmin) | **POST** /admin/auth/unlink-all | Unlink all OAuth accounts + + +# **unlinkAllOAuthAccountsAdmin** +> unlinkAllOAuthAccountsAdmin() + +Unlink all OAuth accounts + +Unlinks all OAuth accounts associated with user accounts in the system. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationAdminApi(); + +try { + api_instance.unlinkAllOAuthAccountsAdmin(); +} catch (e) { + print('Exception when calling AuthenticationAdminApi->unlinkAllOAuthAccountsAdmin: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/AuthenticationApi.md b/mobile/openapi/doc/AuthenticationApi.md new file mode 100644 index 0000000000000..d9b8f7f80b114 --- /dev/null +++ b/mobile/openapi/doc/AuthenticationApi.md @@ -0,0 +1,884 @@ +# openapi.api.AuthenticationApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**changePassword**](AuthenticationApi.md#changepassword) | **POST** /auth/change-password | Change password +[**changePinCode**](AuthenticationApi.md#changepincode) | **PUT** /auth/pin-code | Change pin code +[**finishOAuth**](AuthenticationApi.md#finishoauth) | **POST** /oauth/callback | Finish OAuth +[**getAuthStatus**](AuthenticationApi.md#getauthstatus) | **GET** /auth/status | Retrieve auth status +[**linkOAuthAccount**](AuthenticationApi.md#linkoauthaccount) | **POST** /oauth/link | Link OAuth account +[**lockAuthSession**](AuthenticationApi.md#lockauthsession) | **POST** /auth/session/lock | Lock auth session +[**login**](AuthenticationApi.md#login) | **POST** /auth/login | Login +[**logout**](AuthenticationApi.md#logout) | **POST** /auth/logout | Logout +[**logoutOAuth**](AuthenticationApi.md#logoutoauth) | **POST** /oauth/backchannel-logout | Backchannel OAuth logout +[**redirectOAuthToMobile**](AuthenticationApi.md#redirectoauthtomobile) | **GET** /oauth/mobile-redirect | Redirect OAuth to mobile +[**resetPinCode**](AuthenticationApi.md#resetpincode) | **DELETE** /auth/pin-code | Reset pin code +[**setupPinCode**](AuthenticationApi.md#setuppincode) | **POST** /auth/pin-code | Setup pin code +[**signUpAdmin**](AuthenticationApi.md#signupadmin) | **POST** /auth/admin-sign-up | Register admin +[**startOAuth**](AuthenticationApi.md#startoauth) | **POST** /oauth/authorize | Start OAuth +[**unlinkOAuthAccount**](AuthenticationApi.md#unlinkoauthaccount) | **POST** /oauth/unlink | Unlink OAuth account +[**unlockAuthSession**](AuthenticationApi.md#unlockauthsession) | **POST** /auth/session/unlock | Unlock auth session +[**validateAccessToken**](AuthenticationApi.md#validateaccesstoken) | **POST** /auth/validateToken | Validate access token + + +# **changePassword** +> UserAdminResponseDto changePassword(changePasswordDto) + +Change password + +Change the password of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); +final changePasswordDto = ChangePasswordDto(); // ChangePasswordDto | + +try { + final result = api_instance.changePassword(changePasswordDto); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->changePassword: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **changePasswordDto** | [**ChangePasswordDto**](ChangePasswordDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **changePinCode** +> changePinCode(pinCodeChangeDto) + +Change pin code + +Change the pin code for the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); +final pinCodeChangeDto = PinCodeChangeDto(); // PinCodeChangeDto | + +try { + api_instance.changePinCode(pinCodeChangeDto); +} catch (e) { + print('Exception when calling AuthenticationApi->changePinCode: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pinCodeChangeDto** | [**PinCodeChangeDto**](PinCodeChangeDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **finishOAuth** +> LoginResponseDto finishOAuth(oAuthCallbackDto) + +Finish OAuth + +Complete the OAuth authorization process by exchanging the authorization code for a session token. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = AuthenticationApi(); +final oAuthCallbackDto = OAuthCallbackDto(); // OAuthCallbackDto | + +try { + final result = api_instance.finishOAuth(oAuthCallbackDto); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->finishOAuth: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **oAuthCallbackDto** | [**OAuthCallbackDto**](OAuthCallbackDto.md)| | + +### Return type + +[**LoginResponseDto**](LoginResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAuthStatus** +> AuthStatusResponseDto getAuthStatus() + +Retrieve auth status + +Get information about the current session, including whether the user has a password, and if the session can access locked assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); + +try { + final result = api_instance.getAuthStatus(); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->getAuthStatus: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**AuthStatusResponseDto**](AuthStatusResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **linkOAuthAccount** +> UserAdminResponseDto linkOAuthAccount(oAuthCallbackDto) + +Link OAuth account + +Link an OAuth account to the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); +final oAuthCallbackDto = OAuthCallbackDto(); // OAuthCallbackDto | + +try { + final result = api_instance.linkOAuthAccount(oAuthCallbackDto); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->linkOAuthAccount: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **oAuthCallbackDto** | [**OAuthCallbackDto**](OAuthCallbackDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **lockAuthSession** +> lockAuthSession() + +Lock auth session + +Remove elevated access to locked assets from the current session. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); + +try { + api_instance.lockAuthSession(); +} catch (e) { + print('Exception when calling AuthenticationApi->lockAuthSession: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **login** +> LoginResponseDto login(loginCredentialDto) + +Login + +Login with username and password and receive a session token. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = AuthenticationApi(); +final loginCredentialDto = LoginCredentialDto(); // LoginCredentialDto | + +try { + final result = api_instance.login(loginCredentialDto); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->login: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **loginCredentialDto** | [**LoginCredentialDto**](LoginCredentialDto.md)| | + +### Return type + +[**LoginResponseDto**](LoginResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **logout** +> LogoutResponseDto logout() + +Logout + +Logout the current user and invalidate the session token. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); + +try { + final result = api_instance.logout(); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->logout: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**LogoutResponseDto**](LogoutResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **logoutOAuth** +> logoutOAuth(logoutToken) + +Backchannel OAuth logout + +Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = AuthenticationApi(); +final logoutToken = logoutToken_example; // String | OAuth logout token + +try { + api_instance.logoutOAuth(logoutToken); +} catch (e) { + print('Exception when calling AuthenticationApi->logoutOAuth: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **logoutToken** | **String**| OAuth logout token | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **redirectOAuthToMobile** +> redirectOAuthToMobile() + +Redirect OAuth to mobile + +Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = AuthenticationApi(); + +try { + api_instance.redirectOAuthToMobile(); +} catch (e) { + print('Exception when calling AuthenticationApi->redirectOAuthToMobile: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resetPinCode** +> resetPinCode(pinCodeResetDto) + +Reset pin code + +Reset the pin code for the current user by providing the account password + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); +final pinCodeResetDto = PinCodeResetDto(); // PinCodeResetDto | + +try { + api_instance.resetPinCode(pinCodeResetDto); +} catch (e) { + print('Exception when calling AuthenticationApi->resetPinCode: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pinCodeResetDto** | [**PinCodeResetDto**](PinCodeResetDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setupPinCode** +> setupPinCode(pinCodeSetupDto) + +Setup pin code + +Setup a new pin code for the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); +final pinCodeSetupDto = PinCodeSetupDto(); // PinCodeSetupDto | + +try { + api_instance.setupPinCode(pinCodeSetupDto); +} catch (e) { + print('Exception when calling AuthenticationApi->setupPinCode: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pinCodeSetupDto** | [**PinCodeSetupDto**](PinCodeSetupDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **signUpAdmin** +> UserAdminResponseDto signUpAdmin(signUpDto) + +Register admin + +Create the first admin user in the system. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = AuthenticationApi(); +final signUpDto = SignUpDto(); // SignUpDto | + +try { + final result = api_instance.signUpAdmin(signUpDto); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->signUpAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **signUpDto** | [**SignUpDto**](SignUpDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **startOAuth** +> OAuthAuthorizeResponseDto startOAuth(oAuthConfigDto) + +Start OAuth + +Initiate the OAuth authorization process. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = AuthenticationApi(); +final oAuthConfigDto = OAuthConfigDto(); // OAuthConfigDto | + +try { + final result = api_instance.startOAuth(oAuthConfigDto); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->startOAuth: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **oAuthConfigDto** | [**OAuthConfigDto**](OAuthConfigDto.md)| | + +### Return type + +[**OAuthAuthorizeResponseDto**](OAuthAuthorizeResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unlinkOAuthAccount** +> UserAdminResponseDto unlinkOAuthAccount() + +Unlink OAuth account + +Unlink the OAuth account from the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); + +try { + final result = api_instance.unlinkOAuthAccount(); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->unlinkOAuthAccount: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **unlockAuthSession** +> unlockAuthSession(sessionUnlockDto) + +Unlock auth session + +Temporarily grant the session elevated access to locked assets by providing the correct PIN code. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); +final sessionUnlockDto = SessionUnlockDto(); // SessionUnlockDto | + +try { + api_instance.unlockAuthSession(sessionUnlockDto); +} catch (e) { + print('Exception when calling AuthenticationApi->unlockAuthSession: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sessionUnlockDto** | [**SessionUnlockDto**](SessionUnlockDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validateAccessToken** +> ValidateAccessTokenResponseDto validateAccessToken() + +Validate access token + +Validate the current authorization method is still valid. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = AuthenticationApi(); + +try { + final result = api_instance.validateAccessToken(); + print(result); +} catch (e) { + print('Exception when calling AuthenticationApi->validateAccessToken: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ValidateAccessTokenResponseDto**](ValidateAccessTokenResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/AvatarUpdate.md b/mobile/openapi/doc/AvatarUpdate.md new file mode 100644 index 0000000000000..59330f0bf486f --- /dev/null +++ b/mobile/openapi/doc/AvatarUpdate.md @@ -0,0 +1,15 @@ +# openapi.model.AvatarUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | [**Optional**](UserAvatarColor.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BackendApi.md b/mobile/openapi/doc/BackendApi.md new file mode 100644 index 0000000000000..10b9bfee90dc5 --- /dev/null +++ b/mobile/openapi/doc/BackendApi.md @@ -0,0 +1,93 @@ +# openapi.api.BackendApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createLocalBackend**](BackendApi.md#createlocalbackend) | **POST** /yucca/backend/local | +[**getBackends**](BackendApi.md#getbackends) | **GET** /yucca/backend | + + +# **createLocalBackend** +> BackendResponseDto createLocalBackend(createLocalBackendRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = BackendApi(); +final createLocalBackendRequestDto = CreateLocalBackendRequestDto(); // CreateLocalBackendRequestDto | + +try { + final result = api_instance.createLocalBackend(createLocalBackendRequestDto); + print(result); +} catch (e) { + print('Exception when calling BackendApi->createLocalBackend: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createLocalBackendRequestDto** | [**CreateLocalBackendRequestDto**](CreateLocalBackendRequestDto.md)| | + +### Return type + +[**BackendResponseDto**](BackendResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getBackends** +> BackendsResponseDto getBackends() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = BackendApi(); + +try { + final result = api_instance.getBackends(); + print(result); +} catch (e) { + print('Exception when calling BackendApi->getBackends: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**BackendsResponseDto**](BackendsResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/BackendDto.md b/mobile/openapi/doc/BackendDto.md new file mode 100644 index 0000000000000..82a4dd2113697 --- /dev/null +++ b/mobile/openapi/doc/BackendDto.md @@ -0,0 +1,19 @@ +# openapi.model.BackendDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | | +**error** | **Optional** | | [optional] +**id** | **String** | | +**isOnline** | **bool** | | +**type** | [**BackendType**](BackendType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BackendResponseDto.md b/mobile/openapi/doc/BackendResponseDto.md new file mode 100644 index 0000000000000..09ff374bab187 --- /dev/null +++ b/mobile/openapi/doc/BackendResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.BackendResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backend** | [**BackendDto**](BackendDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BackendType.md b/mobile/openapi/doc/BackendType.md new file mode 100644 index 0000000000000..0845c8615ac6b --- /dev/null +++ b/mobile/openapi/doc/BackendType.md @@ -0,0 +1,14 @@ +# openapi.model.BackendType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BackendsResponseDto.md b/mobile/openapi/doc/BackendsResponseDto.md new file mode 100644 index 0000000000000..0e6e8f7051495 --- /dev/null +++ b/mobile/openapi/doc/BackendsResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.BackendsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backends** | [**List**](BackendDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BootstrapStatus.md b/mobile/openapi/doc/BootstrapStatus.md new file mode 100644 index 0000000000000..1934e00d65c03 --- /dev/null +++ b/mobile/openapi/doc/BootstrapStatus.md @@ -0,0 +1,14 @@ +# openapi.model.BootstrapStatus + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BulkIdErrorReason.md b/mobile/openapi/doc/BulkIdErrorReason.md new file mode 100644 index 0000000000000..f61af14fb3fd5 --- /dev/null +++ b/mobile/openapi/doc/BulkIdErrorReason.md @@ -0,0 +1,14 @@ +# openapi.model.BulkIdErrorReason + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BulkIdResponseDto.md b/mobile/openapi/doc/BulkIdResponseDto.md new file mode 100644 index 0000000000000..554f1cc7d9629 --- /dev/null +++ b/mobile/openapi/doc/BulkIdResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.BulkIdResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | [**Optional**](BulkIdErrorReason.md) | | [optional] +**errorMessage** | **Optional** | | [optional] +**id** | **String** | ID | +**success** | **bool** | Whether operation succeeded | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/BulkIdsDto.md b/mobile/openapi/doc/BulkIdsDto.md new file mode 100644 index 0000000000000..71e440136ed1b --- /dev/null +++ b/mobile/openapi/doc/BulkIdsDto.md @@ -0,0 +1,15 @@ +# openapi.model.BulkIdsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **List** | IDs to process | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CLIPConfig.md b/mobile/openapi/doc/CLIPConfig.md new file mode 100644 index 0000000000000..bc7083a88451e --- /dev/null +++ b/mobile/openapi/doc/CLIPConfig.md @@ -0,0 +1,16 @@ +# openapi.model.CLIPConfig + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether the task is enabled | +**modelName** | **String** | Name of the model to use | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CQMode.md b/mobile/openapi/doc/CQMode.md new file mode 100644 index 0000000000000..0375443a1fafc --- /dev/null +++ b/mobile/openapi/doc/CQMode.md @@ -0,0 +1,14 @@ +# openapi.model.CQMode + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CalendarHeatmapResponseDto.md b/mobile/openapi/doc/CalendarHeatmapResponseDto.md new file mode 100644 index 0000000000000..f2afe73029416 --- /dev/null +++ b/mobile/openapi/doc/CalendarHeatmapResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.CalendarHeatmapResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**from** | **String** | Start date in UTC | +**series** | [**List**](CalendarHeatmapResponseDtoSeriesInner.md) | | [default to const []] +**to** | **String** | End date in UTC | +**totalCount** | **int** | Total activity count over the period | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CalendarHeatmapResponseDtoSeriesInner.md b/mobile/openapi/doc/CalendarHeatmapResponseDtoSeriesInner.md new file mode 100644 index 0000000000000..9fbdbc460fc03 --- /dev/null +++ b/mobile/openapi/doc/CalendarHeatmapResponseDtoSeriesInner.md @@ -0,0 +1,16 @@ +# openapi.model.CalendarHeatmapResponseDtoSeriesInner + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Activity count | +**date** | **String** | Date in UTC | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CalendarHeatmapType.md b/mobile/openapi/doc/CalendarHeatmapType.md new file mode 100644 index 0000000000000..02a1ad15d3c0c --- /dev/null +++ b/mobile/openapi/doc/CalendarHeatmapType.md @@ -0,0 +1,14 @@ +# openapi.model.CalendarHeatmapType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CastResponse.md b/mobile/openapi/doc/CastResponse.md new file mode 100644 index 0000000000000..0078fa5ce5be8 --- /dev/null +++ b/mobile/openapi/doc/CastResponse.md @@ -0,0 +1,15 @@ +# openapi.model.CastResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gCastEnabled** | **bool** | Whether Google Cast is enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CastUpdate.md b/mobile/openapi/doc/CastUpdate.md new file mode 100644 index 0000000000000..54ba35274f8ef --- /dev/null +++ b/mobile/openapi/doc/CastUpdate.md @@ -0,0 +1,15 @@ +# openapi.model.CastUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gCastEnabled** | **Optional** | Whether Google Cast is enabled | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ChangePasswordDto.md b/mobile/openapi/doc/ChangePasswordDto.md new file mode 100644 index 0000000000000..33ca7d3b8d460 --- /dev/null +++ b/mobile/openapi/doc/ChangePasswordDto.md @@ -0,0 +1,17 @@ +# openapi.model.ChangePasswordDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invalidateSessions** | **Optional** | Invalidate all other sessions | [optional] [default to false] +**newPassword** | **String** | New password (min 8 characters) | +**password** | **String** | Current password | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/Colorspace.md b/mobile/openapi/doc/Colorspace.md new file mode 100644 index 0000000000000..6f49da91f6e40 --- /dev/null +++ b/mobile/openapi/doc/Colorspace.md @@ -0,0 +1,14 @@ +# openapi.model.Colorspace + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ConfigureImmichIntegrationRequestDto.md b/mobile/openapi/doc/ConfigureImmichIntegrationRequestDto.md new file mode 100644 index 0000000000000..c61f719ce7102 --- /dev/null +++ b/mobile/openapi/doc/ConfigureImmichIntegrationRequestDto.md @@ -0,0 +1,21 @@ +# openapi.model.ConfigureImmichIntegrationRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backupConfiguration** | **bool** | | +**cron** | **String** | | +**dataFolders** | **List** | | [default to const []] +**libraries** | [**ConfigureImmichIntegrationRequestDtoLibraries**](ConfigureImmichIntegrationRequestDtoLibraries.md) | | +**name** | **String** | | +**retentionPolicy** | [**Optional**](RetentionPolicyDto.md) | | [optional] +**worm** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ConfigureImmichIntegrationRequestDtoLibraries.md b/mobile/openapi/doc/ConfigureImmichIntegrationRequestDtoLibraries.md new file mode 100644 index 0000000000000..8b9e3fb33630e --- /dev/null +++ b/mobile/openapi/doc/ConfigureImmichIntegrationRequestDtoLibraries.md @@ -0,0 +1,14 @@ +# openapi.model.ConfigureImmichIntegrationRequestDtoLibraries + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ContributorCountResponseDto.md b/mobile/openapi/doc/ContributorCountResponseDto.md new file mode 100644 index 0000000000000..48a56118a46dc --- /dev/null +++ b/mobile/openapi/doc/ContributorCountResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.ContributorCountResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetCount** | **int** | Number of assets contributed | +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CreateAlbumDto.md b/mobile/openapi/doc/CreateAlbumDto.md new file mode 100644 index 0000000000000..ccb5987c9b93f --- /dev/null +++ b/mobile/openapi/doc/CreateAlbumDto.md @@ -0,0 +1,18 @@ +# openapi.model.CreateAlbumDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumName** | **String** | Album name | +**albumUsers** | [**Optional?>**](AlbumUserCreateDto.md) | Album users | [optional] [default to const []] +**assetIds** | **Optional?>** | Initial asset IDs | [optional] [default to const []] +**description** | **Optional** | Album description | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CreateLibraryDto.md b/mobile/openapi/doc/CreateLibraryDto.md new file mode 100644 index 0000000000000..4e5dd7293cfc5 --- /dev/null +++ b/mobile/openapi/doc/CreateLibraryDto.md @@ -0,0 +1,18 @@ +# openapi.model.CreateLibraryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclusionPatterns** | **Optional?>** | Exclusion patterns (max 128) | [optional] [default to const []] +**importPaths** | **Optional?>** | Import paths (max 128) | [optional] [default to const []] +**name** | **Optional** | Library name | [optional] +**ownerId** | **String** | Owner user ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CreateLocalBackendRequestDto.md b/mobile/openapi/doc/CreateLocalBackendRequestDto.md new file mode 100644 index 0000000000000..75b29402039bf --- /dev/null +++ b/mobile/openapi/doc/CreateLocalBackendRequestDto.md @@ -0,0 +1,15 @@ +# openapi.model.CreateLocalBackendRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CreateProfileImageResponseDto.md b/mobile/openapi/doc/CreateProfileImageResponseDto.md new file mode 100644 index 0000000000000..cc86f156f2151 --- /dev/null +++ b/mobile/openapi/doc/CreateProfileImageResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.CreateProfileImageResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**profileChangedAt** | [**DateTime**](DateTime.md) | Profile image change date | +**profileImagePath** | **String** | Profile image file path | +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CropParameters.md b/mobile/openapi/doc/CropParameters.md new file mode 100644 index 0000000000000..131487d8ee397 --- /dev/null +++ b/mobile/openapi/doc/CropParameters.md @@ -0,0 +1,18 @@ +# openapi.model.CropParameters + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**height** | **int** | Height of the crop | +**width** | **int** | Width of the crop | +**x** | **int** | Top-Left X coordinate of crop | +**y** | **int** | Top-Left Y coordinate of crop | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/CurrentRecoveryKeyResponse.md b/mobile/openapi/doc/CurrentRecoveryKeyResponse.md new file mode 100644 index 0000000000000..303010bfa2f92 --- /dev/null +++ b/mobile/openapi/doc/CurrentRecoveryKeyResponse.md @@ -0,0 +1,15 @@ +# openapi.model.CurrentRecoveryKeyResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recoveryKey** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DatabaseBackupConfig.md b/mobile/openapi/doc/DatabaseBackupConfig.md new file mode 100644 index 0000000000000..04da6449e68c4 --- /dev/null +++ b/mobile/openapi/doc/DatabaseBackupConfig.md @@ -0,0 +1,17 @@ +# openapi.model.DatabaseBackupConfig + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cronExpression** | **String** | Cron expression | +**enabled** | **bool** | Enabled | +**keepLastAmount** | **int** | Keep last amount | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DatabaseBackupDeleteDto.md b/mobile/openapi/doc/DatabaseBackupDeleteDto.md new file mode 100644 index 0000000000000..0794d7e8be364 --- /dev/null +++ b/mobile/openapi/doc/DatabaseBackupDeleteDto.md @@ -0,0 +1,15 @@ +# openapi.model.DatabaseBackupDeleteDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backups** | **List** | Backup filenames to delete | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DatabaseBackupDto.md b/mobile/openapi/doc/DatabaseBackupDto.md new file mode 100644 index 0000000000000..0ef18eeeead78 --- /dev/null +++ b/mobile/openapi/doc/DatabaseBackupDto.md @@ -0,0 +1,17 @@ +# openapi.model.DatabaseBackupDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filename** | **String** | Backup filename | +**filesize** | **int** | Backup file size | +**timezone** | **String** | Backup timezone | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DatabaseBackupListResponseDto.md b/mobile/openapi/doc/DatabaseBackupListResponseDto.md new file mode 100644 index 0000000000000..f1618dbc86a4d --- /dev/null +++ b/mobile/openapi/doc/DatabaseBackupListResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.DatabaseBackupListResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backups** | [**List**](DatabaseBackupDto.md) | List of backups | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DatabaseBackupsAdminApi.md b/mobile/openapi/doc/DatabaseBackupsAdminApi.md new file mode 100644 index 0000000000000..b99c7c274f06c --- /dev/null +++ b/mobile/openapi/doc/DatabaseBackupsAdminApi.md @@ -0,0 +1,278 @@ +# openapi.api.DatabaseBackupsAdminApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteDatabaseBackup**](DatabaseBackupsAdminApi.md#deletedatabasebackup) | **DELETE** /admin/database-backups | Delete database backup +[**downloadDatabaseBackup**](DatabaseBackupsAdminApi.md#downloaddatabasebackup) | **GET** /admin/database-backups/{filename} | Download database backup +[**listDatabaseBackups**](DatabaseBackupsAdminApi.md#listdatabasebackups) | **GET** /admin/database-backups | List database backups +[**startDatabaseRestoreFlow**](DatabaseBackupsAdminApi.md#startdatabaserestoreflow) | **POST** /admin/database-backups/start-restore | Start database backup restore flow +[**uploadDatabaseBackup**](DatabaseBackupsAdminApi.md#uploaddatabasebackup) | **POST** /admin/database-backups/upload | Upload database backup + + +# **deleteDatabaseBackup** +> deleteDatabaseBackup(databaseBackupDeleteDto) + +Delete database backup + +Delete a backup by its filename + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DatabaseBackupsAdminApi(); +final databaseBackupDeleteDto = DatabaseBackupDeleteDto(); // DatabaseBackupDeleteDto | + +try { + api_instance.deleteDatabaseBackup(databaseBackupDeleteDto); +} catch (e) { + print('Exception when calling DatabaseBackupsAdminApi->deleteDatabaseBackup: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **databaseBackupDeleteDto** | [**DatabaseBackupDeleteDto**](DatabaseBackupDeleteDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **downloadDatabaseBackup** +> MultipartFile downloadDatabaseBackup(filename) + +Download database backup + +Downloads the database backup file + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DatabaseBackupsAdminApi(); +final filename = filename_example; // String | + +try { + final result = api_instance.downloadDatabaseBackup(filename); + print(result); +} catch (e) { + print('Exception when calling DatabaseBackupsAdminApi->downloadDatabaseBackup: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filename** | **String**| | + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **listDatabaseBackups** +> DatabaseBackupListResponseDto listDatabaseBackups() + +List database backups + +Get the list of the successful and failed backups + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DatabaseBackupsAdminApi(); + +try { + final result = api_instance.listDatabaseBackups(); + print(result); +} catch (e) { + print('Exception when calling DatabaseBackupsAdminApi->listDatabaseBackups: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**DatabaseBackupListResponseDto**](DatabaseBackupListResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **startDatabaseRestoreFlow** +> startDatabaseRestoreFlow() + +Start database backup restore flow + +Put Immich into maintenance mode to restore a backup (Immich must not be configured) + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = DatabaseBackupsAdminApi(); + +try { + api_instance.startDatabaseRestoreFlow(); +} catch (e) { + print('Exception when calling DatabaseBackupsAdminApi->startDatabaseRestoreFlow: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **uploadDatabaseBackup** +> uploadDatabaseBackup(file) + +Upload database backup + +Uploads .sql/.sql.gz file to restore backup from + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DatabaseBackupsAdminApi(); +final file = BINARY_DATA_HERE; // MultipartFile | Database backup file + +try { + api_instance.uploadDatabaseBackup(file); +} catch (e) { + print('Exception when calling DatabaseBackupsAdminApi->uploadDatabaseBackup: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | **MultipartFile**| Database backup file | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/DeprecatedApi.md b/mobile/openapi/doc/DeprecatedApi.md new file mode 100644 index 0000000000000..c04b51f0852a3 --- /dev/null +++ b/mobile/openapi/doc/DeprecatedApi.md @@ -0,0 +1,1018 @@ +# openapi.api.DeprecatedApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createPartnerDeprecated**](DeprecatedApi.md#createpartnerdeprecated) | **POST** /partners/{id} | Create a partner +[**getQueuesLegacy**](DeprecatedApi.md#getqueueslegacy) | **GET** /jobs | Retrieve queue counts and status +[**runQueueCommandLegacy**](DeprecatedApi.md#runqueuecommandlegacy) | **PUT** /jobs/{name} | Run jobs +[**updateApiKey**](DeprecatedApi.md#updateapikey) | **PUT** /api-keys/{id} | Update an API key +[**updateAsset**](DeprecatedApi.md#updateasset) | **PUT** /assets/{id} | Update an asset +[**updateAssets**](DeprecatedApi.md#updateassets) | **PUT** /assets | Update assets +[**updateLibrary**](DeprecatedApi.md#updatelibrary) | **PUT** /libraries/{id} | Update a library +[**updateMemory**](DeprecatedApi.md#updatememory) | **PUT** /memories/{id} | Update a memory +[**updateMyPreferences**](DeprecatedApi.md#updatemypreferences) | **PUT** /users/me/preferences | Update my preferences +[**updateMyUser**](DeprecatedApi.md#updatemyuser) | **PUT** /users/me | Update current user +[**updatePerson**](DeprecatedApi.md#updateperson) | **PUT** /people/{id} | Update person +[**updateSession**](DeprecatedApi.md#updatesession) | **PUT** /sessions/{id} | Update a session +[**updateStack**](DeprecatedApi.md#updatestack) | **PUT** /stacks/{id} | Update a stack +[**updateTag**](DeprecatedApi.md#updatetag) | **PUT** /tags/{id} | Update a tag +[**updateUserAdmin**](DeprecatedApi.md#updateuseradmin) | **PUT** /admin/users/{id} | Update a user +[**updateUserPreferencesAdmin**](DeprecatedApi.md#updateuserpreferencesadmin) | **PUT** /admin/users/{id}/preferences | Update user preferences +[**updateWorkflow**](DeprecatedApi.md#updateworkflow) | **PUT** /workflows/{id} | Update a workflow + + +# **createPartnerDeprecated** +> PartnerResponseDto createPartnerDeprecated(id) + +Create a partner + +Create a new partner to share assets with. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.createPartnerDeprecated(id); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->createPartnerDeprecated: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**PartnerResponseDto**](PartnerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getQueuesLegacy** +> QueuesResponseLegacyDto getQueuesLegacy() + +Retrieve queue counts and status + +Retrieve the counts of the current queue, as well as the current status. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); + +try { + final result = api_instance.getQueuesLegacy(); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->getQueuesLegacy: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**QueuesResponseLegacyDto**](QueuesResponseLegacyDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **runQueueCommandLegacy** +> QueueResponseLegacyDto runQueueCommandLegacy(name, queueCommandDto) + +Run jobs + +Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final name = ; // QueueName | +final queueCommandDto = QueueCommandDto(); // QueueCommandDto | + +try { + final result = api_instance.runQueueCommandLegacy(name, queueCommandDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->runQueueCommandLegacy: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**QueueName**](.md)| | + **queueCommandDto** | [**QueueCommandDto**](QueueCommandDto.md)| | + +### Return type + +[**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateApiKey** +> ApiKeyResponseDto updateApiKey(id, apiKeyUpdateDto) + +Update an API key + +Updates the name and permissions of an API key by its ID. The current user must own this API key. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final apiKeyUpdateDto = ApiKeyUpdateDto(); // ApiKeyUpdateDto | + +try { + final result = api_instance.updateApiKey(id, apiKeyUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateApiKey: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **apiKeyUpdateDto** | [**ApiKeyUpdateDto**](ApiKeyUpdateDto.md)| | + +### Return type + +[**ApiKeyResponseDto**](ApiKeyResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAsset** +> AssetResponseDto updateAsset(id, updateAssetDto) + +Update an asset + +Update information of a specific asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final updateAssetDto = UpdateAssetDto(); // UpdateAssetDto | + +try { + final result = api_instance.updateAsset(id, updateAssetDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateAsset: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **updateAssetDto** | [**UpdateAssetDto**](UpdateAssetDto.md)| | + +### Return type + +[**AssetResponseDto**](AssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAssets** +> updateAssets(assetBulkUpdateDto) + +Update assets + +Updates multiple assets at the same time. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final assetBulkUpdateDto = AssetBulkUpdateDto(); // AssetBulkUpdateDto | + +try { + api_instance.updateAssets(assetBulkUpdateDto); +} catch (e) { + print('Exception when calling DeprecatedApi->updateAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetBulkUpdateDto** | [**AssetBulkUpdateDto**](AssetBulkUpdateDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateLibrary** +> LibraryResponseDto updateLibrary(id, updateLibraryDto) + +Update a library + +Update an existing external library. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final updateLibraryDto = UpdateLibraryDto(); // UpdateLibraryDto | + +try { + final result = api_instance.updateLibrary(id, updateLibraryDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateLibrary: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **updateLibraryDto** | [**UpdateLibraryDto**](UpdateLibraryDto.md)| | + +### Return type + +[**LibraryResponseDto**](LibraryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateMemory** +> MemoryResponseDto updateMemory(id, memoryUpdateDto) + +Update a memory + +Update an existing memory by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final memoryUpdateDto = MemoryUpdateDto(); // MemoryUpdateDto | + +try { + final result = api_instance.updateMemory(id, memoryUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateMemory: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **memoryUpdateDto** | [**MemoryUpdateDto**](MemoryUpdateDto.md)| | + +### Return type + +[**MemoryResponseDto**](MemoryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateMyPreferences** +> UserPreferencesResponseDto updateMyPreferences(userPreferencesUpdateDto) + +Update my preferences + +Update the preferences of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final userPreferencesUpdateDto = UserPreferencesUpdateDto(); // UserPreferencesUpdateDto | + +try { + final result = api_instance.updateMyPreferences(userPreferencesUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateMyPreferences: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **userPreferencesUpdateDto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | + +### Return type + +[**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateMyUser** +> UserAdminResponseDto updateMyUser(userUpdateMeDto) + +Update current user + +Update the current user making the API request. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final userUpdateMeDto = UserUpdateMeDto(); // UserUpdateMeDto | + +try { + final result = api_instance.updateMyUser(userUpdateMeDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateMyUser: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **userUpdateMeDto** | [**UserUpdateMeDto**](UserUpdateMeDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updatePerson** +> PersonResponseDto updatePerson(id, personUpdateDto) + +Update person + +Update an individual person. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final personUpdateDto = PersonUpdateDto(); // PersonUpdateDto | + +try { + final result = api_instance.updatePerson(id, personUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updatePerson: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **personUpdateDto** | [**PersonUpdateDto**](PersonUpdateDto.md)| | + +### Return type + +[**PersonResponseDto**](PersonResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateSession** +> SessionResponseDto updateSession(id, sessionUpdateDto) + +Update a session + +Update a specific session identified by id. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final sessionUpdateDto = SessionUpdateDto(); // SessionUpdateDto | + +try { + final result = api_instance.updateSession(id, sessionUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateSession: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **sessionUpdateDto** | [**SessionUpdateDto**](SessionUpdateDto.md)| | + +### Return type + +[**SessionResponseDto**](SessionResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateStack** +> StackResponseDto updateStack(id, stackUpdateDto) + +Update a stack + +Update an existing stack by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final stackUpdateDto = StackUpdateDto(); // StackUpdateDto | + +try { + final result = api_instance.updateStack(id, stackUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateStack: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **stackUpdateDto** | [**StackUpdateDto**](StackUpdateDto.md)| | + +### Return type + +[**StackResponseDto**](StackResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateTag** +> TagResponseDto updateTag(id, tagUpdateDto) + +Update a tag + +Update an existing tag identified by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final tagUpdateDto = TagUpdateDto(); // TagUpdateDto | + +try { + final result = api_instance.updateTag(id, tagUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateTag: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **tagUpdateDto** | [**TagUpdateDto**](TagUpdateDto.md)| | + +### Return type + +[**TagResponseDto**](TagResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateUserAdmin** +> UserAdminResponseDto updateUserAdmin(id, userAdminUpdateDto) + +Update a user + +Update an existing user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final userAdminUpdateDto = UserAdminUpdateDto(); // UserAdminUpdateDto | + +try { + final result = api_instance.updateUserAdmin(id, userAdminUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateUserAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **userAdminUpdateDto** | [**UserAdminUpdateDto**](UserAdminUpdateDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateUserPreferencesAdmin** +> UserPreferencesResponseDto updateUserPreferencesAdmin(id, userPreferencesUpdateDto) + +Update user preferences + +Update the preferences of a specific user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final userPreferencesUpdateDto = UserPreferencesUpdateDto(); // UserPreferencesUpdateDto | + +try { + final result = api_instance.updateUserPreferencesAdmin(id, userPreferencesUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateUserPreferencesAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **userPreferencesUpdateDto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | + +### Return type + +[**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateWorkflow** +> WorkflowResponseDto updateWorkflow(id, workflowUpdateDto) + +Update a workflow + +Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DeprecatedApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final workflowUpdateDto = WorkflowUpdateDto(); // WorkflowUpdateDto | + +try { + final result = api_instance.updateWorkflow(id, workflowUpdateDto); + print(result); +} catch (e) { + print('Exception when calling DeprecatedApi->updateWorkflow: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **workflowUpdateDto** | [**WorkflowUpdateDto**](WorkflowUpdateDto.md)| | + +### Return type + +[**WorkflowResponseDto**](WorkflowResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/DevelopmentApi.md b/mobile/openapi/doc/DevelopmentApi.md new file mode 100644 index 0000000000000..e404229db20ee --- /dev/null +++ b/mobile/openapi/doc/DevelopmentApi.md @@ -0,0 +1,50 @@ +# openapi.api.DevelopmentApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**resetOrchestrator**](DevelopmentApi.md#resetorchestrator) | **POST** /yucca/debug/reset | + + +# **resetOrchestrator** +> resetOrchestrator() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = DevelopmentApi(); + +try { + api_instance.resetOrchestrator(); +} catch (e) { + print('Exception when calling DevelopmentApi->resetOrchestrator: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/DeviceFlowResponseDto.md b/mobile/openapi/doc/DeviceFlowResponseDto.md new file mode 100644 index 0000000000000..4e81acbe7f70e --- /dev/null +++ b/mobile/openapi/doc/DeviceFlowResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.DeviceFlowResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userCode** | **String** | | +**verificationUri** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DownloadApi.md b/mobile/openapi/doc/DownloadApi.md new file mode 100644 index 0000000000000..dd87c5e9136f2 --- /dev/null +++ b/mobile/openapi/doc/DownloadApi.md @@ -0,0 +1,137 @@ +# openapi.api.DownloadApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**downloadArchive**](DownloadApi.md#downloadarchive) | **POST** /download/archive | Download asset archive +[**getDownloadInfo**](DownloadApi.md#getdownloadinfo) | **POST** /download/info | Retrieve download information + + +# **downloadArchive** +> MultipartFile downloadArchive(downloadArchiveDto, key, slug) + +Download asset archive + +Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DownloadApi(); +final downloadArchiveDto = DownloadArchiveDto(); // DownloadArchiveDto | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.downloadArchive(downloadArchiveDto, key, slug); + print(result); +} catch (e) { + print('Exception when calling DownloadApi->downloadArchive: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **downloadArchiveDto** | [**DownloadArchiveDto**](DownloadArchiveDto.md)| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getDownloadInfo** +> DownloadResponseDto getDownloadInfo(downloadInfoDto, key, slug) + +Retrieve download information + +Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DownloadApi(); +final downloadInfoDto = DownloadInfoDto(); // DownloadInfoDto | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.getDownloadInfo(downloadInfoDto, key, slug); + print(result); +} catch (e) { + print('Exception when calling DownloadApi->getDownloadInfo: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **downloadInfoDto** | [**DownloadInfoDto**](DownloadInfoDto.md)| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**DownloadResponseDto**](DownloadResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/DownloadArchiveDto.md b/mobile/openapi/doc/DownloadArchiveDto.md new file mode 100644 index 0000000000000..c7c41f75c8009 --- /dev/null +++ b/mobile/openapi/doc/DownloadArchiveDto.md @@ -0,0 +1,16 @@ +# openapi.model.DownloadArchiveDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetIds** | **List** | Asset IDs | [default to const []] +**edited** | **Optional** | Download edited asset if available | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DownloadArchiveInfo.md b/mobile/openapi/doc/DownloadArchiveInfo.md new file mode 100644 index 0000000000000..4973b942cc5c6 --- /dev/null +++ b/mobile/openapi/doc/DownloadArchiveInfo.md @@ -0,0 +1,16 @@ +# openapi.model.DownloadArchiveInfo + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetIds** | **List** | Asset IDs in this archive | [default to const []] +**size** | **int** | Archive size in bytes | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DownloadInfoDto.md b/mobile/openapi/doc/DownloadInfoDto.md new file mode 100644 index 0000000000000..2dcb19ab3a0ac --- /dev/null +++ b/mobile/openapi/doc/DownloadInfoDto.md @@ -0,0 +1,18 @@ +# openapi.model.DownloadInfoDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **Optional** | Album ID to download | [optional] +**archiveSize** | **Optional** | Archive size limit in bytes | [optional] +**assetIds** | **Optional?>** | Asset IDs to download | [optional] [default to const []] +**userId** | **Optional** | User ID to download assets from | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DownloadResponse.md b/mobile/openapi/doc/DownloadResponse.md new file mode 100644 index 0000000000000..d9af28647921e --- /dev/null +++ b/mobile/openapi/doc/DownloadResponse.md @@ -0,0 +1,16 @@ +# openapi.model.DownloadResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**archiveSize** | **int** | Maximum archive size in bytes | +**includeEmbeddedVideos** | **bool** | Whether to include embedded videos in downloads | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DownloadResponseDto.md b/mobile/openapi/doc/DownloadResponseDto.md new file mode 100644 index 0000000000000..f275e099749aa --- /dev/null +++ b/mobile/openapi/doc/DownloadResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.DownloadResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**archives** | [**List**](DownloadArchiveInfo.md) | Archive information | [default to const []] +**totalSize** | **int** | Total size in bytes | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DownloadUpdate.md b/mobile/openapi/doc/DownloadUpdate.md new file mode 100644 index 0000000000000..d317c29fd1be5 --- /dev/null +++ b/mobile/openapi/doc/DownloadUpdate.md @@ -0,0 +1,16 @@ +# openapi.model.DownloadUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**archiveSize** | **Optional** | Maximum archive size in bytes | [optional] +**includeEmbeddedVideos** | **Optional** | Whether to include embedded videos in downloads | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DuplicateDetectionConfig.md b/mobile/openapi/doc/DuplicateDetectionConfig.md new file mode 100644 index 0000000000000..dcdcd708b2ca3 --- /dev/null +++ b/mobile/openapi/doc/DuplicateDetectionConfig.md @@ -0,0 +1,16 @@ +# openapi.model.DuplicateDetectionConfig + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether the task is enabled | +**maxDistance** | **double** | Maximum distance threshold for duplicate detection | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DuplicateResolveDto.md b/mobile/openapi/doc/DuplicateResolveDto.md new file mode 100644 index 0000000000000..e4dd40ed54fbb --- /dev/null +++ b/mobile/openapi/doc/DuplicateResolveDto.md @@ -0,0 +1,15 @@ +# openapi.model.DuplicateResolveDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**groups** | [**List**](DuplicateResolveGroupDto.md) | List of duplicate groups to resolve | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DuplicateResolveGroupDto.md b/mobile/openapi/doc/DuplicateResolveGroupDto.md new file mode 100644 index 0000000000000..5a92b75fc4f29 --- /dev/null +++ b/mobile/openapi/doc/DuplicateResolveGroupDto.md @@ -0,0 +1,17 @@ +# openapi.model.DuplicateResolveGroupDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duplicateId** | **String** | | +**keepAssetIds** | **List** | Asset IDs to keep | [default to const []] +**trashAssetIds** | **List** | Asset IDs to trash or delete | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DuplicateResponseDto.md b/mobile/openapi/doc/DuplicateResponseDto.md new file mode 100644 index 0000000000000..daf5936a69fb8 --- /dev/null +++ b/mobile/openapi/doc/DuplicateResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.DuplicateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assets** | [**List**](AssetResponseDto.md) | Duplicate assets | [default to const []] +**duplicateId** | **String** | Duplicate group ID | +**suggestedKeepAssetIds** | **List** | Suggested asset IDs to keep based on file size and EXIF data | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/DuplicatesApi.md b/mobile/openapi/doc/DuplicatesApi.md new file mode 100644 index 0000000000000..8a20ff21472a1 --- /dev/null +++ b/mobile/openapi/doc/DuplicatesApi.md @@ -0,0 +1,239 @@ +# openapi.api.DuplicatesApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteDuplicate**](DuplicatesApi.md#deleteduplicate) | **DELETE** /duplicates/{id} | Dismiss a duplicate group +[**deleteDuplicates**](DuplicatesApi.md#deleteduplicates) | **DELETE** /duplicates | Delete duplicates +[**getAssetDuplicates**](DuplicatesApi.md#getassetduplicates) | **GET** /duplicates | Retrieve duplicates +[**resolveDuplicates**](DuplicatesApi.md#resolveduplicates) | **POST** /duplicates/resolve | Resolve duplicate groups + + +# **deleteDuplicate** +> deleteDuplicate(id) + +Dismiss a duplicate group + +Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DuplicatesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteDuplicate(id); +} catch (e) { + print('Exception when calling DuplicatesApi->deleteDuplicate: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteDuplicates** +> deleteDuplicates(bulkIdsDto) + +Delete duplicates + +Delete multiple duplicate assets specified by their IDs. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DuplicatesApi(); +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + api_instance.deleteDuplicates(bulkIdsDto); +} catch (e) { + print('Exception when calling DuplicatesApi->deleteDuplicates: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAssetDuplicates** +> List getAssetDuplicates() + +Retrieve duplicates + +Retrieve a list of duplicate assets available to the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DuplicatesApi(); + +try { + final result = api_instance.getAssetDuplicates(); + print(result); +} catch (e) { + print('Exception when calling DuplicatesApi->getAssetDuplicates: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](DuplicateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resolveDuplicates** +> List resolveDuplicates(duplicateResolveDto) + +Resolve duplicate groups + +Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = DuplicatesApi(); +final duplicateResolveDto = DuplicateResolveDto(); // DuplicateResolveDto | + +try { + final result = api_instance.resolveDuplicates(duplicateResolveDto); + print(result); +} catch (e) { + print('Exception when calling DuplicatesApi->resolveDuplicates: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **duplicateResolveDto** | [**DuplicateResolveDto**](DuplicateResolveDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/EmailNotificationsResponse.md b/mobile/openapi/doc/EmailNotificationsResponse.md new file mode 100644 index 0000000000000..7d26f71742c33 --- /dev/null +++ b/mobile/openapi/doc/EmailNotificationsResponse.md @@ -0,0 +1,17 @@ +# openapi.model.EmailNotificationsResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumInvite** | **bool** | Whether to receive email notifications for album invites | +**albumUpdate** | **bool** | Whether to receive email notifications for album updates | +**enabled** | **bool** | Whether email notifications are enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/EmailNotificationsUpdate.md b/mobile/openapi/doc/EmailNotificationsUpdate.md new file mode 100644 index 0000000000000..ef86a0515d8a7 --- /dev/null +++ b/mobile/openapi/doc/EmailNotificationsUpdate.md @@ -0,0 +1,17 @@ +# openapi.model.EmailNotificationsUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumInvite** | **Optional** | Whether to receive email notifications for album invites | [optional] +**albumUpdate** | **Optional** | Whether to receive email notifications for album updates | [optional] +**enabled** | **Optional** | Whether email notifications are enabled | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ExifResponseDto.md b/mobile/openapi/doc/ExifResponseDto.md new file mode 100644 index 0000000000000..c1a5e455e88ab --- /dev/null +++ b/mobile/openapi/doc/ExifResponseDto.md @@ -0,0 +1,36 @@ +# openapi.model.ExifResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**city** | **Optional** | City name | [optional] +**country** | **Optional** | Country name | [optional] +**dateTimeOriginal** | [**Optional**](DateTime.md) | Original date/time | [optional] +**description** | **Optional** | Image description | [optional] +**exifImageHeight** | **Optional** | Image height in pixels | [optional] +**exifImageWidth** | **Optional** | Image width in pixels | [optional] +**exposureTime** | **Optional** | Exposure time | [optional] +**fNumber** | **Optional** | F-number (aperture) | [optional] +**fileSizeInByte** | **Optional** | File size in bytes | [optional] +**focalLength** | **Optional** | Focal length in mm | [optional] +**iso** | **Optional** | ISO sensitivity | [optional] +**latitude** | **Optional** | GPS latitude | [optional] +**lensModel** | **Optional** | Lens model | [optional] +**longitude** | **Optional** | GPS longitude | [optional] +**make** | **Optional** | Camera make | [optional] +**model** | **Optional** | Camera model | [optional] +**modifyDate** | [**Optional**](DateTime.md) | Modification date/time | [optional] +**orientation** | **Optional** | Image orientation | [optional] +**projectionType** | **Optional** | Projection type | [optional] +**rating** | **Optional** | Rating | [optional] +**state** | **Optional** | State/province name | [optional] +**timeZone** | **Optional** | Time zone | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/FaceDto.md b/mobile/openapi/doc/FaceDto.md new file mode 100644 index 0000000000000..fc2a439a86bec --- /dev/null +++ b/mobile/openapi/doc/FaceDto.md @@ -0,0 +1,15 @@ +# openapi.model.FaceDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Face ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/FacesApi.md b/mobile/openapi/doc/FacesApi.md new file mode 100644 index 0000000000000..647d5d40d3c63 --- /dev/null +++ b/mobile/openapi/doc/FacesApi.md @@ -0,0 +1,247 @@ +# openapi.api.FacesApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createFace**](FacesApi.md#createface) | **POST** /faces | Create a face +[**deleteFace**](FacesApi.md#deleteface) | **DELETE** /faces/{id} | Delete a face +[**getFaces**](FacesApi.md#getfaces) | **GET** /faces | Retrieve faces for asset +[**reassignFacesById**](FacesApi.md#reassignfacesbyid) | **PUT** /faces/{id} | Re-assign a face to another person + + +# **createFace** +> createFace(assetFaceCreateDto) + +Create a face + +Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = FacesApi(); +final assetFaceCreateDto = AssetFaceCreateDto(); // AssetFaceCreateDto | + +try { + api_instance.createFace(assetFaceCreateDto); +} catch (e) { + print('Exception when calling FacesApi->createFace: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetFaceCreateDto** | [**AssetFaceCreateDto**](AssetFaceCreateDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteFace** +> deleteFace(id, assetFaceDeleteDto) + +Delete a face + +Delete a face identified by the id. Optionally can be force deleted. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = FacesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final assetFaceDeleteDto = AssetFaceDeleteDto(); // AssetFaceDeleteDto | + +try { + api_instance.deleteFace(id, assetFaceDeleteDto); +} catch (e) { + print('Exception when calling FacesApi->deleteFace: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **assetFaceDeleteDto** | [**AssetFaceDeleteDto**](AssetFaceDeleteDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getFaces** +> List getFaces(id) + +Retrieve faces for asset + +Retrieve all faces belonging to an asset. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = FacesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Face ID + +try { + final result = api_instance.getFaces(id); + print(result); +} catch (e) { + print('Exception when calling FacesApi->getFaces: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Face ID | + +### Return type + +[**List**](AssetFaceResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reassignFacesById** +> PersonResponseDto reassignFacesById(id, faceDto) + +Re-assign a face to another person + +Re-assign the face provided in the body to the person identified by the id in the path parameter. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = FacesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final faceDto = FaceDto(); // FaceDto | + +try { + final result = api_instance.reassignFacesById(id, faceDto); + print(result); +} catch (e) { + print('Exception when calling FacesApi->reassignFacesById: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **faceDto** | [**FaceDto**](FaceDto.md)| | + +### Return type + +[**PersonResponseDto**](PersonResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/FacialRecognitionConfig.md b/mobile/openapi/doc/FacialRecognitionConfig.md new file mode 100644 index 0000000000000..488ae0769c5b8 --- /dev/null +++ b/mobile/openapi/doc/FacialRecognitionConfig.md @@ -0,0 +1,19 @@ +# openapi.model.FacialRecognitionConfig + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether the task is enabled | +**maxDistance** | **double** | Maximum distance threshold for face recognition | +**minFaces** | **int** | Minimum number of faces required for recognition | +**minScore** | **double** | Minimum confidence score for face detection | +**modelName** | **String** | Name of the model to use | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/FilesystemApi.md b/mobile/openapi/doc/FilesystemApi.md new file mode 100644 index 0000000000000..b397d0105d26d --- /dev/null +++ b/mobile/openapi/doc/FilesystemApi.md @@ -0,0 +1,55 @@ +# openapi.api.FilesystemApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getFileListing**](FilesystemApi.md#getfilelisting) | **GET** /yucca/fs | + + +# **getFileListing** +> FilesystemListingResponseDto getFileListing(path) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = FilesystemApi(); +final path = path_example; // String | + +try { + final result = api_instance.getFileListing(path); + print(result); +} catch (e) { + print('Exception when calling FilesystemApi->getFileListing: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **String**| | [optional] + +### Return type + +[**FilesystemListingResponseDto**](FilesystemListingResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/FilesystemListingItemDto.md b/mobile/openapi/doc/FilesystemListingItemDto.md new file mode 100644 index 0000000000000..d9275bc00caab --- /dev/null +++ b/mobile/openapi/doc/FilesystemListingItemDto.md @@ -0,0 +1,16 @@ +# openapi.model.FilesystemListingItemDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isDirectory** | **bool** | | +**path** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/FilesystemListingResponseDto.md b/mobile/openapi/doc/FilesystemListingResponseDto.md new file mode 100644 index 0000000000000..dfbbf6c9be72d --- /dev/null +++ b/mobile/openapi/doc/FilesystemListingResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.FilesystemListingResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List**](FilesystemListingItemDto.md) | | [default to const []] +**parent** | **String** | | +**path** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/FoldersResponse.md b/mobile/openapi/doc/FoldersResponse.md new file mode 100644 index 0000000000000..a7d6ebf50a973 --- /dev/null +++ b/mobile/openapi/doc/FoldersResponse.md @@ -0,0 +1,16 @@ +# openapi.model.FoldersResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether folders are enabled | +**sidebarWeb** | **bool** | Whether folders appear in web sidebar | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/FoldersUpdate.md b/mobile/openapi/doc/FoldersUpdate.md new file mode 100644 index 0000000000000..f27ee4a0bf143 --- /dev/null +++ b/mobile/openapi/doc/FoldersUpdate.md @@ -0,0 +1,16 @@ +# openapi.model.FoldersUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **Optional** | Whether folders are enabled | [optional] +**sidebarWeb** | **Optional** | Whether folders appear in web sidebar | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/HlsVideoResolution.md b/mobile/openapi/doc/HlsVideoResolution.md new file mode 100644 index 0000000000000..2b376db7205f3 --- /dev/null +++ b/mobile/openapi/doc/HlsVideoResolution.md @@ -0,0 +1,14 @@ +# openapi.model.HlsVideoResolution + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ImageFormat.md b/mobile/openapi/doc/ImageFormat.md new file mode 100644 index 0000000000000..312e501c17f36 --- /dev/null +++ b/mobile/openapi/doc/ImageFormat.md @@ -0,0 +1,14 @@ +# openapi.model.ImageFormat + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ImmichIntegrationConfigurationDto.md b/mobile/openapi/doc/ImmichIntegrationConfigurationDto.md new file mode 100644 index 0000000000000..c34e725ba5ceb --- /dev/null +++ b/mobile/openapi/doc/ImmichIntegrationConfigurationDto.md @@ -0,0 +1,17 @@ +# openapi.model.ImmichIntegrationConfigurationDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backupConfiguration** | **bool** | | +**dataFolders** | **List** | | [default to const []] +**libraries** | [**ConfigureImmichIntegrationRequestDtoLibraries**](ConfigureImmichIntegrationRequestDtoLibraries.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ImmichIntegrationDto.md b/mobile/openapi/doc/ImmichIntegrationDto.md new file mode 100644 index 0000000000000..1eb14424b9e42 --- /dev/null +++ b/mobile/openapi/doc/ImmichIntegrationDto.md @@ -0,0 +1,17 @@ +# openapi.model.ImmichIntegrationDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**configuration** | [**ImmichIntegrationConfigurationDto**](ImmichIntegrationConfigurationDto.md) | | +**id** | **String** | | +**scheduleId** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ImmichLibraryDto.md b/mobile/openapi/doc/ImmichLibraryDto.md new file mode 100644 index 0000000000000..1877656935a37 --- /dev/null +++ b/mobile/openapi/doc/ImmichLibraryDto.md @@ -0,0 +1,18 @@ +# openapi.model.ImmichLibraryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclusionPatterns** | **List** | | [default to const []] +**id** | **String** | | +**importPaths** | **List** | | [default to const []] +**name** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ImmichRollbackRequestDto.md b/mobile/openapi/doc/ImmichRollbackRequestDto.md new file mode 100644 index 0000000000000..5e8c01aeddccc --- /dev/null +++ b/mobile/openapi/doc/ImmichRollbackRequestDto.md @@ -0,0 +1,17 @@ +# openapi.model.ImmichRollbackRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backupFileName** | **Optional** | | [optional] +**repositoryId** | **String** | | +**snapshotId** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ImmichStateDto.md b/mobile/openapi/doc/ImmichStateDto.md new file mode 100644 index 0000000000000..688b524951803 --- /dev/null +++ b/mobile/openapi/doc/ImmichStateDto.md @@ -0,0 +1,17 @@ +# openapi.model.ImmichStateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dataFolders** | **List** | | [default to const []] +**dataPath** | **String** | | +**libraries** | [**List**](ImmichLibraryDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ImportRecoveryKeyRequest.md b/mobile/openapi/doc/ImportRecoveryKeyRequest.md new file mode 100644 index 0000000000000..205f1b4148ad0 --- /dev/null +++ b/mobile/openapi/doc/ImportRecoveryKeyRequest.md @@ -0,0 +1,15 @@ +# openapi.model.ImportRecoveryKeyRequest + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recoveryKey** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/InspectedLocalRepositoryDto.md b/mobile/openapi/doc/InspectedLocalRepositoryDto.md new file mode 100644 index 0000000000000..a0cb15e150b6d --- /dev/null +++ b/mobile/openapi/doc/InspectedLocalRepositoryDto.md @@ -0,0 +1,22 @@ +# openapi.model.InspectedLocalRepositoryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backends** | [**Optional**](RepositoryBackendsDto.md) | | [optional] +**configuration** | [**Optional**](RepositoryConfigurationDto.md) | | [optional] +**id** | **String** | | +**meter** | [**Optional**](RepositoryMeterDto.md) | | [optional] +**metrics** | [**RepositoryMetricsDto**](RepositoryMetricsDto.md) | | +**name** | **String** | | +**snapshots** | [**List**](SnapshotDto.md) | | [default to const []] +**worm** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/IntegrationsApi.md b/mobile/openapi/doc/IntegrationsApi.md new file mode 100644 index 0000000000000..c9a502cc2f158 --- /dev/null +++ b/mobile/openapi/doc/IntegrationsApi.md @@ -0,0 +1,133 @@ +# openapi.api.IntegrationsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**configureImmichIntegration**](IntegrationsApi.md#configureimmichintegration) | **POST** /yucca/integrations/immich | +[**getIntegrations**](IntegrationsApi.md#getintegrations) | **GET** /yucca/integrations | +[**startImmichRollback**](IntegrationsApi.md#startimmichrollback) | **POST** /yucca/integrations/immich/rollback | + + +# **configureImmichIntegration** +> configureImmichIntegration(configureImmichIntegrationRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = IntegrationsApi(); +final configureImmichIntegrationRequestDto = ConfigureImmichIntegrationRequestDto(); // ConfigureImmichIntegrationRequestDto | + +try { + api_instance.configureImmichIntegration(configureImmichIntegrationRequestDto); +} catch (e) { + print('Exception when calling IntegrationsApi->configureImmichIntegration: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **configureImmichIntegrationRequestDto** | [**ConfigureImmichIntegrationRequestDto**](ConfigureImmichIntegrationRequestDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getIntegrations** +> IntegrationsResponseDto getIntegrations() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = IntegrationsApi(); + +try { + final result = api_instance.getIntegrations(); + print(result); +} catch (e) { + print('Exception when calling IntegrationsApi->getIntegrations: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**IntegrationsResponseDto**](IntegrationsResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **startImmichRollback** +> startImmichRollback(immichRollbackRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = IntegrationsApi(); +final immichRollbackRequestDto = ImmichRollbackRequestDto(); // ImmichRollbackRequestDto | + +try { + api_instance.startImmichRollback(immichRollbackRequestDto); +} catch (e) { + print('Exception when calling IntegrationsApi->startImmichRollback: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **immichRollbackRequestDto** | [**ImmichRollbackRequestDto**](ImmichRollbackRequestDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/IntegrationsResponseDto.md b/mobile/openapi/doc/IntegrationsResponseDto.md new file mode 100644 index 0000000000000..9be8a021e18c4 --- /dev/null +++ b/mobile/openapi/doc/IntegrationsResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.IntegrationsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**immichIntegration** | [**Optional**](ImmichIntegrationDto.md) | | [optional] +**immichState** | [**Optional**](ImmichStateDto.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/IntegrityReport.md b/mobile/openapi/doc/IntegrityReport.md new file mode 100644 index 0000000000000..da17c7b708857 --- /dev/null +++ b/mobile/openapi/doc/IntegrityReport.md @@ -0,0 +1,14 @@ +# openapi.model.IntegrityReport + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/IntegrityReportResponseDto.md b/mobile/openapi/doc/IntegrityReportResponseDto.md new file mode 100644 index 0000000000000..b368f00422d0b --- /dev/null +++ b/mobile/openapi/doc/IntegrityReportResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.IntegrityReportResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**List**](IntegrityReportResponseDtoItemsInner.md) | | [default to const []] +**nextCursor** | **Optional** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/IntegrityReportResponseDtoItemsInner.md b/mobile/openapi/doc/IntegrityReportResponseDtoItemsInner.md new file mode 100644 index 0000000000000..6117644587b9e --- /dev/null +++ b/mobile/openapi/doc/IntegrityReportResponseDtoItemsInner.md @@ -0,0 +1,17 @@ +# openapi.model.IntegrityReportResponseDtoItemsInner + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Integrity report item id | +**path** | **String** | Integrity report item path | +**type** | [**IntegrityReport**](IntegrityReport.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/IntegrityReportSummaryResponseDto.md b/mobile/openapi/doc/IntegrityReportSummaryResponseDto.md new file mode 100644 index 0000000000000..2567c14ed25e6 --- /dev/null +++ b/mobile/openapi/doc/IntegrityReportSummaryResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.IntegrityReportSummaryResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checksumMismatch** | **int** | | +**missingFile** | **int** | | +**untrackedFile** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/JobCreateDto.md b/mobile/openapi/doc/JobCreateDto.md new file mode 100644 index 0000000000000..071e15471b7a2 --- /dev/null +++ b/mobile/openapi/doc/JobCreateDto.md @@ -0,0 +1,15 @@ +# openapi.model.JobCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | [**ManualJobName**](ManualJobName.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/JobName.md b/mobile/openapi/doc/JobName.md new file mode 100644 index 0000000000000..43fb27c79401f --- /dev/null +++ b/mobile/openapi/doc/JobName.md @@ -0,0 +1,14 @@ +# openapi.model.JobName + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/JobSettingsDto.md b/mobile/openapi/doc/JobSettingsDto.md new file mode 100644 index 0000000000000..b2a494912247e --- /dev/null +++ b/mobile/openapi/doc/JobSettingsDto.md @@ -0,0 +1,15 @@ +# openapi.model.JobSettingsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**concurrency** | **int** | Concurrency | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/JobsApi.md b/mobile/openapi/doc/JobsApi.md new file mode 100644 index 0000000000000..f4f24417d6dc7 --- /dev/null +++ b/mobile/openapi/doc/JobsApi.md @@ -0,0 +1,184 @@ +# openapi.api.JobsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createJob**](JobsApi.md#createjob) | **POST** /jobs | Create a manual job +[**getQueuesLegacy**](JobsApi.md#getqueueslegacy) | **GET** /jobs | Retrieve queue counts and status +[**runQueueCommandLegacy**](JobsApi.md#runqueuecommandlegacy) | **PUT** /jobs/{name} | Run jobs + + +# **createJob** +> createJob(jobCreateDto) + +Create a manual job + +Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = JobsApi(); +final jobCreateDto = JobCreateDto(); // JobCreateDto | + +try { + api_instance.createJob(jobCreateDto); +} catch (e) { + print('Exception when calling JobsApi->createJob: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jobCreateDto** | [**JobCreateDto**](JobCreateDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getQueuesLegacy** +> QueuesResponseLegacyDto getQueuesLegacy() + +Retrieve queue counts and status + +Retrieve the counts of the current queue, as well as the current status. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = JobsApi(); + +try { + final result = api_instance.getQueuesLegacy(); + print(result); +} catch (e) { + print('Exception when calling JobsApi->getQueuesLegacy: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**QueuesResponseLegacyDto**](QueuesResponseLegacyDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **runQueueCommandLegacy** +> QueueResponseLegacyDto runQueueCommandLegacy(name, queueCommandDto) + +Run jobs + +Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = JobsApi(); +final name = ; // QueueName | +final queueCommandDto = QueueCommandDto(); // QueueCommandDto | + +try { + final result = api_instance.runQueueCommandLegacy(name, queueCommandDto); + print(result); +} catch (e) { + print('Exception when calling JobsApi->runQueueCommandLegacy: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**QueueName**](.md)| | + **queueCommandDto** | [**QueueCommandDto**](QueueCommandDto.md)| | + +### Return type + +[**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/LibrariesApi.md b/mobile/openapi/doc/LibrariesApi.md new file mode 100644 index 0000000000000..ce40d4f8d56e6 --- /dev/null +++ b/mobile/openapi/doc/LibrariesApi.md @@ -0,0 +1,475 @@ +# openapi.api.LibrariesApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createLibrary**](LibrariesApi.md#createlibrary) | **POST** /libraries | Create a library +[**deleteLibrary**](LibrariesApi.md#deletelibrary) | **DELETE** /libraries/{id} | Delete a library +[**getAllLibraries**](LibrariesApi.md#getalllibraries) | **GET** /libraries | Retrieve libraries +[**getLibrary**](LibrariesApi.md#getlibrary) | **GET** /libraries/{id} | Retrieve a library +[**getLibraryStatistics**](LibrariesApi.md#getlibrarystatistics) | **GET** /libraries/{id}/statistics | Retrieve library statistics +[**scanLibrary**](LibrariesApi.md#scanlibrary) | **POST** /libraries/{id}/scan | Scan a library +[**updateLibrary**](LibrariesApi.md#updatelibrary) | **PUT** /libraries/{id} | Update a library +[**validate**](LibrariesApi.md#validate) | **POST** /libraries/{id}/validate | Validate library settings + + +# **createLibrary** +> LibraryResponseDto createLibrary(createLibraryDto) + +Create a library + +Create a new external library. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); +final createLibraryDto = CreateLibraryDto(); // CreateLibraryDto | + +try { + final result = api_instance.createLibrary(createLibraryDto); + print(result); +} catch (e) { + print('Exception when calling LibrariesApi->createLibrary: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createLibraryDto** | [**CreateLibraryDto**](CreateLibraryDto.md)| | + +### Return type + +[**LibraryResponseDto**](LibraryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteLibrary** +> deleteLibrary(id) + +Delete a library + +Delete an external library by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteLibrary(id); +} catch (e) { + print('Exception when calling LibrariesApi->deleteLibrary: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAllLibraries** +> List getAllLibraries() + +Retrieve libraries + +Retrieve a list of external libraries. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); + +try { + final result = api_instance.getAllLibraries(); + print(result); +} catch (e) { + print('Exception when calling LibrariesApi->getAllLibraries: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](LibraryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getLibrary** +> LibraryResponseDto getLibrary(id) + +Retrieve a library + +Retrieve an external library by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getLibrary(id); + print(result); +} catch (e) { + print('Exception when calling LibrariesApi->getLibrary: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**LibraryResponseDto**](LibraryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getLibraryStatistics** +> LibraryStatsResponseDto getLibraryStatistics(id) + +Retrieve library statistics + +Retrieve statistics for a specific external library, including number of videos, images, and storage usage. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getLibraryStatistics(id); + print(result); +} catch (e) { + print('Exception when calling LibrariesApi->getLibraryStatistics: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**LibraryStatsResponseDto**](LibraryStatsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **scanLibrary** +> scanLibrary(id) + +Scan a library + +Queue a scan for the external library to find and import new assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.scanLibrary(id); +} catch (e) { + print('Exception when calling LibrariesApi->scanLibrary: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateLibrary** +> LibraryResponseDto updateLibrary(id, updateLibraryDto) + +Update a library + +Update an existing external library. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final updateLibraryDto = UpdateLibraryDto(); // UpdateLibraryDto | + +try { + final result = api_instance.updateLibrary(id, updateLibraryDto); + print(result); +} catch (e) { + print('Exception when calling LibrariesApi->updateLibrary: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **updateLibraryDto** | [**UpdateLibraryDto**](UpdateLibraryDto.md)| | + +### Return type + +[**LibraryResponseDto**](LibraryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **validate** +> ValidateLibraryResponseDto validate(id, validateLibraryDto) + +Validate library settings + +Validate the settings of an external library. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = LibrariesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final validateLibraryDto = ValidateLibraryDto(); // ValidateLibraryDto | + +try { + final result = api_instance.validate(id, validateLibraryDto); + print(result); +} catch (e) { + print('Exception when calling LibrariesApi->validate: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **validateLibraryDto** | [**ValidateLibraryDto**](ValidateLibraryDto.md)| | + +### Return type + +[**ValidateLibraryResponseDto**](ValidateLibraryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/LibraryResponseDto.md b/mobile/openapi/doc/LibraryResponseDto.md new file mode 100644 index 0000000000000..589a8d8278078 --- /dev/null +++ b/mobile/openapi/doc/LibraryResponseDto.md @@ -0,0 +1,23 @@ +# openapi.model.LibraryResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetCount** | **int** | Number of assets | +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**exclusionPatterns** | **List** | Exclusion patterns | [default to const []] +**id** | **String** | Library ID | +**importPaths** | **List** | Import paths | [default to const []] +**name** | **String** | Library name | +**ownerId** | **String** | Owner user ID | +**refreshedAt** | [**DateTime**](DateTime.md) | Last refresh date | +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LibraryStatsResponseDto.md b/mobile/openapi/doc/LibraryStatsResponseDto.md new file mode 100644 index 0000000000000..b09b50bcb58e7 --- /dev/null +++ b/mobile/openapi/doc/LibraryStatsResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.LibraryStatsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**photos** | **int** | Number of photos | +**total** | **int** | Total number of assets | +**usage** | **int** | Storage usage in bytes | +**videos** | **int** | Number of videos | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LicenseKeyDto.md b/mobile/openapi/doc/LicenseKeyDto.md new file mode 100644 index 0000000000000..c15f698f8aa39 --- /dev/null +++ b/mobile/openapi/doc/LicenseKeyDto.md @@ -0,0 +1,16 @@ +# openapi.model.LicenseKeyDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**activationKey** | **String** | Activation key | +**licenseKey** | **String** | License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ListSnapshotsResponseDto.md b/mobile/openapi/doc/ListSnapshotsResponseDto.md new file mode 100644 index 0000000000000..d1b1ad684350c --- /dev/null +++ b/mobile/openapi/doc/ListSnapshotsResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.ListSnapshotsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**snapshots** | [**List**](SnapshotDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LocalRepositoryDto.md b/mobile/openapi/doc/LocalRepositoryDto.md new file mode 100644 index 0000000000000..70973b4ec954e --- /dev/null +++ b/mobile/openapi/doc/LocalRepositoryDto.md @@ -0,0 +1,21 @@ +# openapi.model.LocalRepositoryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backends** | [**Optional**](RepositoryBackendsDto.md) | | [optional] +**configuration** | [**Optional**](RepositoryConfigurationDto.md) | | [optional] +**id** | **String** | | +**meter** | [**Optional**](RepositoryMeterDto.md) | | [optional] +**metrics** | [**RepositoryMetricsDto**](RepositoryMetricsDto.md) | | +**name** | **String** | | +**worm** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LogLevel.md b/mobile/openapi/doc/LogLevel.md new file mode 100644 index 0000000000000..84b40e5d80e0f --- /dev/null +++ b/mobile/openapi/doc/LogLevel.md @@ -0,0 +1,14 @@ +# openapi.model.LogLevel + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LogResponseDto.md b/mobile/openapi/doc/LogResponseDto.md new file mode 100644 index 0000000000000..aba8d10003083 --- /dev/null +++ b/mobile/openapi/doc/LogResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.LogResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**logId** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LoginCredentialDto.md b/mobile/openapi/doc/LoginCredentialDto.md new file mode 100644 index 0000000000000..f664f8f2edc48 --- /dev/null +++ b/mobile/openapi/doc/LoginCredentialDto.md @@ -0,0 +1,16 @@ +# openapi.model.LoginCredentialDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **String** | User email | +**password** | **String** | User password | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LoginResponseDto.md b/mobile/openapi/doc/LoginResponseDto.md new file mode 100644 index 0000000000000..ff53f5308220f --- /dev/null +++ b/mobile/openapi/doc/LoginResponseDto.md @@ -0,0 +1,22 @@ +# openapi.model.LoginResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessToken** | **String** | Access token | +**isAdmin** | **bool** | Is admin user | +**isOnboarded** | **bool** | Is onboarded | +**name** | **String** | User name | +**profileImagePath** | **String** | Profile image path | +**shouldChangePassword** | **bool** | Should change password | +**userEmail** | **String** | User email | +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/LogoutResponseDto.md b/mobile/openapi/doc/LogoutResponseDto.md new file mode 100644 index 0000000000000..1a10399b96496 --- /dev/null +++ b/mobile/openapi/doc/LogoutResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.LogoutResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**redirectUri** | **String** | Redirect URI | +**successful** | **bool** | Logout successful | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MachineLearningAvailabilityChecksDto.md b/mobile/openapi/doc/MachineLearningAvailabilityChecksDto.md new file mode 100644 index 0000000000000..f53eac9cb2949 --- /dev/null +++ b/mobile/openapi/doc/MachineLearningAvailabilityChecksDto.md @@ -0,0 +1,17 @@ +# openapi.model.MachineLearningAvailabilityChecksDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enabled | +**interval** | **int** | | +**timeout** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MaintenanceAction.md b/mobile/openapi/doc/MaintenanceAction.md new file mode 100644 index 0000000000000..9f279b6d98935 --- /dev/null +++ b/mobile/openapi/doc/MaintenanceAction.md @@ -0,0 +1,14 @@ +# openapi.model.MaintenanceAction + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MaintenanceAdminApi.md b/mobile/openapi/doc/MaintenanceAdminApi.md new file mode 100644 index 0000000000000..edf7dec481dc0 --- /dev/null +++ b/mobile/openapi/doc/MaintenanceAdminApi.md @@ -0,0 +1,497 @@ +# openapi.api.MaintenanceAdminApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteIntegrityReport**](MaintenanceAdminApi.md#deleteintegrityreport) | **DELETE** /admin/integrity/report/{id} | Delete integrity report item +[**detectPriorInstall**](MaintenanceAdminApi.md#detectpriorinstall) | **GET** /admin/maintenance/detect-install | Detect existing install +[**getIntegrityReport**](MaintenanceAdminApi.md#getintegrityreport) | **GET** /admin/integrity/report | Get integrity report by type +[**getIntegrityReportCsv**](MaintenanceAdminApi.md#getintegrityreportcsv) | **GET** /admin/integrity/report/{type}/csv | Export integrity report by type as CSV +[**getIntegrityReportFile**](MaintenanceAdminApi.md#getintegrityreportfile) | **GET** /admin/integrity/report/{id}/file | Download flagged file +[**getIntegrityReportSummary**](MaintenanceAdminApi.md#getintegrityreportsummary) | **GET** /admin/integrity/summary | Get integrity report summary +[**getMaintenanceStatus**](MaintenanceAdminApi.md#getmaintenancestatus) | **GET** /admin/maintenance/status | Get maintenance mode status +[**maintenanceLogin**](MaintenanceAdminApi.md#maintenancelogin) | **POST** /admin/maintenance/login | Log into maintenance mode +[**setMaintenanceMode**](MaintenanceAdminApi.md#setmaintenancemode) | **POST** /admin/maintenance | Set maintenance mode + + +# **deleteIntegrityReport** +> deleteIntegrityReport(id) + +Delete integrity report item + +Delete a given report item and perform corresponding deletion (e.g. trash asset, delete file) + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MaintenanceAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteIntegrityReport(id); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->deleteIntegrityReport: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **detectPriorInstall** +> MaintenanceDetectInstallResponseDto detectPriorInstall() + +Detect existing install + +Collect integrity checks and other heuristics about local data. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MaintenanceAdminApi(); + +try { + final result = api_instance.detectPriorInstall(); + print(result); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->detectPriorInstall: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**MaintenanceDetectInstallResponseDto**](MaintenanceDetectInstallResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getIntegrityReport** +> IntegrityReportResponseDto getIntegrityReport(type, cursor, limit) + +Get integrity report by type + +Get all flagged items by integrity report type + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MaintenanceAdminApi(); +final type = ; // IntegrityReport | +final cursor = cursor_example; // String | Cursor for pagination +final limit = 56; // int | Number of items per page + +try { + final result = api_instance.getIntegrityReport(type, cursor, limit); + print(result); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->getIntegrityReport: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | [**IntegrityReport**](.md)| | + **cursor** | **String**| Cursor for pagination | [optional] + **limit** | **int**| Number of items per page | [optional] [default to 500] + +### Return type + +[**IntegrityReportResponseDto**](IntegrityReportResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getIntegrityReportCsv** +> MultipartFile getIntegrityReportCsv(type) + +Export integrity report by type as CSV + +Get all integrity report entries for a given type as a CSV + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MaintenanceAdminApi(); +final type = ; // IntegrityReport | + +try { + final result = api_instance.getIntegrityReportCsv(type); + print(result); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->getIntegrityReportCsv: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | [**IntegrityReport**](.md)| | + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getIntegrityReportFile** +> MultipartFile getIntegrityReportFile(id) + +Download flagged file + +Download the untracked/broken file if one exists + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MaintenanceAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getIntegrityReportFile(id); + print(result); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->getIntegrityReportFile: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getIntegrityReportSummary** +> IntegrityReportSummaryResponseDto getIntegrityReportSummary() + +Get integrity report summary + +Get a count of the items flagged in each integrity report + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MaintenanceAdminApi(); + +try { + final result = api_instance.getIntegrityReportSummary(); + print(result); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->getIntegrityReportSummary: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**IntegrityReportSummaryResponseDto**](IntegrityReportSummaryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMaintenanceStatus** +> MaintenanceStatusResponseDto getMaintenanceStatus() + +Get maintenance mode status + +Fetch information about the currently running maintenance action. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = MaintenanceAdminApi(); + +try { + final result = api_instance.getMaintenanceStatus(); + print(result); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->getMaintenanceStatus: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**MaintenanceStatusResponseDto**](MaintenanceStatusResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **maintenanceLogin** +> MaintenanceAuthDto maintenanceLogin(maintenanceLoginDto) + +Log into maintenance mode + +Login with maintenance token or cookie to receive current information and perform further actions. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = MaintenanceAdminApi(); +final maintenanceLoginDto = MaintenanceLoginDto(); // MaintenanceLoginDto | + +try { + final result = api_instance.maintenanceLogin(maintenanceLoginDto); + print(result); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->maintenanceLogin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **maintenanceLoginDto** | [**MaintenanceLoginDto**](MaintenanceLoginDto.md)| | + +### Return type + +[**MaintenanceAuthDto**](MaintenanceAuthDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setMaintenanceMode** +> setMaintenanceMode(setMaintenanceModeDto) + +Set maintenance mode + +Put Immich into or take it out of maintenance mode + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MaintenanceAdminApi(); +final setMaintenanceModeDto = SetMaintenanceModeDto(); // SetMaintenanceModeDto | + +try { + api_instance.setMaintenanceMode(setMaintenanceModeDto); +} catch (e) { + print('Exception when calling MaintenanceAdminApi->setMaintenanceMode: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setMaintenanceModeDto** | [**SetMaintenanceModeDto**](SetMaintenanceModeDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/MaintenanceAuthDto.md b/mobile/openapi/doc/MaintenanceAuthDto.md new file mode 100644 index 0000000000000..7964129ee3083 --- /dev/null +++ b/mobile/openapi/doc/MaintenanceAuthDto.md @@ -0,0 +1,15 @@ +# openapi.model.MaintenanceAuthDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**username** | **String** | Maintenance username | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MaintenanceDetectInstallResponseDto.md b/mobile/openapi/doc/MaintenanceDetectInstallResponseDto.md new file mode 100644 index 0000000000000..aae4d2824e9f3 --- /dev/null +++ b/mobile/openapi/doc/MaintenanceDetectInstallResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.MaintenanceDetectInstallResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**storage** | [**List**](MaintenanceDetectInstallStorageFolderDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MaintenanceDetectInstallStorageFolderDto.md b/mobile/openapi/doc/MaintenanceDetectInstallStorageFolderDto.md new file mode 100644 index 0000000000000..1a4f6a884daca --- /dev/null +++ b/mobile/openapi/doc/MaintenanceDetectInstallStorageFolderDto.md @@ -0,0 +1,18 @@ +# openapi.model.MaintenanceDetectInstallStorageFolderDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**files** | **int** | Number of files in the folder | +**folder** | [**StorageFolder**](StorageFolder.md) | | +**readable** | **bool** | Whether the folder is readable | +**writable** | **bool** | Whether the folder is writable | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MaintenanceLoginDto.md b/mobile/openapi/doc/MaintenanceLoginDto.md new file mode 100644 index 0000000000000..2587ffc856198 --- /dev/null +++ b/mobile/openapi/doc/MaintenanceLoginDto.md @@ -0,0 +1,15 @@ +# openapi.model.MaintenanceLoginDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token** | **Optional** | Maintenance token | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MaintenanceStatusResponseDto.md b/mobile/openapi/doc/MaintenanceStatusResponseDto.md new file mode 100644 index 0000000000000..157c81e687204 --- /dev/null +++ b/mobile/openapi/doc/MaintenanceStatusResponseDto.md @@ -0,0 +1,20 @@ +# openapi.model.MaintenanceStatusResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**MaintenanceAction**](MaintenanceAction.md) | | +**active** | **bool** | | +**error** | **Optional** | | [optional] +**progress** | **Optional** | | [optional] +**task** | **Optional** | | [optional] +**yuccaLogId** | **Optional** | Yucca log ID | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ManualJobName.md b/mobile/openapi/doc/ManualJobName.md new file mode 100644 index 0000000000000..b484b80b3b211 --- /dev/null +++ b/mobile/openapi/doc/ManualJobName.md @@ -0,0 +1,14 @@ +# openapi.model.ManualJobName + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MapApi.md b/mobile/openapi/doc/MapApi.md new file mode 100644 index 0000000000000..689aa542556e7 --- /dev/null +++ b/mobile/openapi/doc/MapApi.md @@ -0,0 +1,141 @@ +# openapi.api.MapApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getMapMarkers**](MapApi.md#getmapmarkers) | **GET** /map/markers | Retrieve map markers +[**reverseGeocode**](MapApi.md#reversegeocode) | **GET** /map/reverse-geocode | Reverse geocode coordinates + + +# **getMapMarkers** +> List getMapMarkers(fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite, withPartners, withSharedAlbums) + +Retrieve map markers + +Retrieve a list of latitude and longitude coordinates for every asset with location data. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MapApi(); +final fileCreatedAfter = 2024-01-01T00:00Z; // DateTime | Filter assets created after this date +final fileCreatedBefore = 2024-01-01T00:00Z; // DateTime | Filter assets created before this date +final isArchived = true; // bool | Filter by archived status +final isFavorite = true; // bool | Filter by favorite status +final withPartners = true; // bool | Include partner assets +final withSharedAlbums = true; // bool | Include shared album assets + +try { + final result = api_instance.getMapMarkers(fileCreatedAfter, fileCreatedBefore, isArchived, isFavorite, withPartners, withSharedAlbums); + print(result); +} catch (e) { + print('Exception when calling MapApi->getMapMarkers: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **fileCreatedAfter** | **DateTime**| Filter assets created after this date | [optional] + **fileCreatedBefore** | **DateTime**| Filter assets created before this date | [optional] + **isArchived** | **bool**| Filter by archived status | [optional] + **isFavorite** | **bool**| Filter by favorite status | [optional] + **withPartners** | **bool**| Include partner assets | [optional] + **withSharedAlbums** | **bool**| Include shared album assets | [optional] + +### Return type + +[**List**](MapMarkerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reverseGeocode** +> List reverseGeocode(lat, lon) + +Reverse geocode coordinates + +Retrieve location information (e.g., city, country) for given latitude and longitude coordinates. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MapApi(); +final lat = 1.2; // double | Latitude (-90 to 90) +final lon = 1.2; // double | Longitude (-180 to 180) + +try { + final result = api_instance.reverseGeocode(lat, lon); + print(result); +} catch (e) { + print('Exception when calling MapApi->reverseGeocode: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **lat** | **double**| Latitude (-90 to 90) | + **lon** | **double**| Longitude (-180 to 180) | + +### Return type + +[**List**](MapReverseGeocodeResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/MapMarkerResponseDto.md b/mobile/openapi/doc/MapMarkerResponseDto.md new file mode 100644 index 0000000000000..903d6355e0ee1 --- /dev/null +++ b/mobile/openapi/doc/MapMarkerResponseDto.md @@ -0,0 +1,20 @@ +# openapi.model.MapMarkerResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**city** | **String** | City name | +**country** | **String** | Country name | +**id** | **String** | Asset ID | +**lat** | **double** | Latitude | +**lon** | **double** | Longitude | +**state** | **String** | State/Province name | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MapReverseGeocodeResponseDto.md b/mobile/openapi/doc/MapReverseGeocodeResponseDto.md new file mode 100644 index 0000000000000..460309f8dc601 --- /dev/null +++ b/mobile/openapi/doc/MapReverseGeocodeResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.MapReverseGeocodeResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**city** | **String** | City name | +**country** | **String** | Country name | +**state** | **String** | State/Province name | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemoriesApi.md b/mobile/openapi/doc/MemoriesApi.md new file mode 100644 index 0000000000000..d83d038b70d42 --- /dev/null +++ b/mobile/openapi/doc/MemoriesApi.md @@ -0,0 +1,502 @@ +# openapi.api.MemoriesApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**addMemoryAssets**](MemoriesApi.md#addmemoryassets) | **PUT** /memories/{id}/assets | Add assets to a memory +[**createMemory**](MemoriesApi.md#creatememory) | **POST** /memories | Create a memory +[**deleteMemory**](MemoriesApi.md#deletememory) | **DELETE** /memories/{id} | Delete a memory +[**getMemory**](MemoriesApi.md#getmemory) | **GET** /memories/{id} | Retrieve a memory +[**memoriesStatistics**](MemoriesApi.md#memoriesstatistics) | **GET** /memories/statistics | Retrieve memories statistics +[**removeMemoryAssets**](MemoriesApi.md#removememoryassets) | **DELETE** /memories/{id}/assets | Remove assets from a memory +[**searchMemories**](MemoriesApi.md#searchmemories) | **GET** /memories | Retrieve memories +[**updateMemory**](MemoriesApi.md#updatememory) | **PUT** /memories/{id} | Update a memory + + +# **addMemoryAssets** +> List addMemoryAssets(id, bulkIdsDto) + +Add assets to a memory + +Add a list of asset IDs to a specific memory. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + final result = api_instance.addMemoryAssets(id, bulkIdsDto); + print(result); +} catch (e) { + print('Exception when calling MemoriesApi->addMemoryAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createMemory** +> MemoryResponseDto createMemory(memoryCreateDto) + +Create a memory + +Create a new memory by providing a name, description, and a list of asset IDs to include in the memory. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final memoryCreateDto = MemoryCreateDto(); // MemoryCreateDto | + +try { + final result = api_instance.createMemory(memoryCreateDto); + print(result); +} catch (e) { + print('Exception when calling MemoriesApi->createMemory: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **memoryCreateDto** | [**MemoryCreateDto**](MemoryCreateDto.md)| | + +### Return type + +[**MemoryResponseDto**](MemoryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteMemory** +> deleteMemory(id) + +Delete a memory + +Delete a specific memory by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteMemory(id); +} catch (e) { + print('Exception when calling MemoriesApi->deleteMemory: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMemory** +> MemoryResponseDto getMemory(id) + +Retrieve a memory + +Retrieve a specific memory by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getMemory(id); + print(result); +} catch (e) { + print('Exception when calling MemoriesApi->getMemory: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**MemoryResponseDto**](MemoryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **memoriesStatistics** +> MemoryStatisticsResponseDto memoriesStatistics(for_, isSaved, isTrashed, order, size, type) + +Retrieve memories statistics + +Retrieve statistics about memories, such as total count and other relevant metrics. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final for_ = Mon Jan 01 00:00:00 UTC 2024; // DateTime | Filter by date +final isSaved = true; // bool | Filter by saved status +final isTrashed = true; // bool | Include trashed memories +final order = ; // MemorySearchOrder | +final size = 56; // int | Number of memories to return +final type = ; // MemoryType | + +try { + final result = api_instance.memoriesStatistics(for_, isSaved, isTrashed, order, size, type); + print(result); +} catch (e) { + print('Exception when calling MemoriesApi->memoriesStatistics: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **for_** | **DateTime**| Filter by date | [optional] + **isSaved** | **bool**| Filter by saved status | [optional] + **isTrashed** | **bool**| Include trashed memories | [optional] + **order** | [**MemorySearchOrder**](.md)| | [optional] + **size** | **int**| Number of memories to return | [optional] + **type** | [**MemoryType**](.md)| | [optional] + +### Return type + +[**MemoryStatisticsResponseDto**](MemoryStatisticsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeMemoryAssets** +> List removeMemoryAssets(id, bulkIdsDto) + +Remove assets from a memory + +Remove a list of asset IDs from a specific memory. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + final result = api_instance.removeMemoryAssets(id, bulkIdsDto); + print(result); +} catch (e) { + print('Exception when calling MemoriesApi->removeMemoryAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchMemories** +> List searchMemories(for_, isSaved, isTrashed, order, size, type) + +Retrieve memories + +Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final for_ = Mon Jan 01 00:00:00 UTC 2024; // DateTime | Filter by date +final isSaved = true; // bool | Filter by saved status +final isTrashed = true; // bool | Include trashed memories +final order = ; // MemorySearchOrder | +final size = 56; // int | Number of memories to return +final type = ; // MemoryType | + +try { + final result = api_instance.searchMemories(for_, isSaved, isTrashed, order, size, type); + print(result); +} catch (e) { + print('Exception when calling MemoriesApi->searchMemories: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **for_** | **DateTime**| Filter by date | [optional] + **isSaved** | **bool**| Filter by saved status | [optional] + **isTrashed** | **bool**| Include trashed memories | [optional] + **order** | [**MemorySearchOrder**](.md)| | [optional] + **size** | **int**| Number of memories to return | [optional] + **type** | [**MemoryType**](.md)| | [optional] + +### Return type + +[**List**](MemoryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateMemory** +> MemoryResponseDto updateMemory(id, memoryUpdateDto) + +Update a memory + +Update an existing memory by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = MemoriesApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final memoryUpdateDto = MemoryUpdateDto(); // MemoryUpdateDto | + +try { + final result = api_instance.updateMemory(id, memoryUpdateDto); + print(result); +} catch (e) { + print('Exception when calling MemoriesApi->updateMemory: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **memoryUpdateDto** | [**MemoryUpdateDto**](MemoryUpdateDto.md)| | + +### Return type + +[**MemoryResponseDto**](MemoryResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/MemoriesResponse.md b/mobile/openapi/doc/MemoriesResponse.md new file mode 100644 index 0000000000000..dea9a41d60a92 --- /dev/null +++ b/mobile/openapi/doc/MemoriesResponse.md @@ -0,0 +1,16 @@ +# openapi.model.MemoriesResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **int** | Memory duration in seconds | +**enabled** | **bool** | Whether memories are enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemoriesUpdate.md b/mobile/openapi/doc/MemoriesUpdate.md new file mode 100644 index 0000000000000..2b0d3e5c8cfb3 --- /dev/null +++ b/mobile/openapi/doc/MemoriesUpdate.md @@ -0,0 +1,16 @@ +# openapi.model.MemoriesUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **Optional** | Memory duration in seconds | [optional] +**enabled** | **Optional** | Whether memories are enabled | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemoryCreateDto.md b/mobile/openapi/doc/MemoryCreateDto.md new file mode 100644 index 0000000000000..1820248d64486 --- /dev/null +++ b/mobile/openapi/doc/MemoryCreateDto.md @@ -0,0 +1,22 @@ +# openapi.model.MemoryCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetIds** | **Optional?>** | Asset IDs to associate with memory | [optional] [default to const []] +**data** | [**OnThisDayDto**](OnThisDayDto.md) | | +**hideAt** | [**Optional**](DateTime.md) | Date when memory should be hidden | [optional] +**isSaved** | **Optional** | Is memory saved | [optional] +**memoryAt** | [**DateTime**](DateTime.md) | Memory date | +**seenAt** | [**Optional**](DateTime.md) | Date when memory was seen | [optional] +**showAt** | [**Optional**](DateTime.md) | Date when memory should be shown | [optional] +**type** | [**MemoryType**](MemoryType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemoryResponseDto.md b/mobile/openapi/doc/MemoryResponseDto.md new file mode 100644 index 0000000000000..8a19042ddc7f0 --- /dev/null +++ b/mobile/openapi/doc/MemoryResponseDto.md @@ -0,0 +1,27 @@ +# openapi.model.MemoryResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assets** | [**List**](AssetResponseDto.md) | | [default to const []] +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**data** | [**OnThisDayDto**](OnThisDayDto.md) | | +**deletedAt** | [**Optional**](DateTime.md) | Deletion date | [optional] +**hideAt** | [**Optional**](DateTime.md) | Date when memory should be hidden | [optional] +**id** | **String** | Memory ID | +**isSaved** | **bool** | Is memory saved | +**memoryAt** | [**DateTime**](DateTime.md) | Memory date | +**ownerId** | **String** | Owner user ID | +**seenAt** | [**Optional**](DateTime.md) | Date when memory was seen | [optional] +**showAt** | [**Optional**](DateTime.md) | Date when memory should be shown | [optional] +**type** | [**MemoryType**](MemoryType.md) | | +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemorySearchOrder.md b/mobile/openapi/doc/MemorySearchOrder.md new file mode 100644 index 0000000000000..82726aaf3f43d --- /dev/null +++ b/mobile/openapi/doc/MemorySearchOrder.md @@ -0,0 +1,14 @@ +# openapi.model.MemorySearchOrder + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemoryStatisticsResponseDto.md b/mobile/openapi/doc/MemoryStatisticsResponseDto.md new file mode 100644 index 0000000000000..57f4ef3e03377 --- /dev/null +++ b/mobile/openapi/doc/MemoryStatisticsResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.MemoryStatisticsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **int** | Total number of memories | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemoryType.md b/mobile/openapi/doc/MemoryType.md new file mode 100644 index 0000000000000..c8dea25bed12e --- /dev/null +++ b/mobile/openapi/doc/MemoryType.md @@ -0,0 +1,14 @@ +# openapi.model.MemoryType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MemoryUpdateDto.md b/mobile/openapi/doc/MemoryUpdateDto.md new file mode 100644 index 0000000000000..c4009b9635c3b --- /dev/null +++ b/mobile/openapi/doc/MemoryUpdateDto.md @@ -0,0 +1,17 @@ +# openapi.model.MemoryUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isSaved** | **Optional** | Is memory saved | [optional] +**memoryAt** | [**Optional**](DateTime.md) | Memory date | [optional] +**seenAt** | [**Optional**](DateTime.md) | Date when memory was seen | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MergePersonDto.md b/mobile/openapi/doc/MergePersonDto.md new file mode 100644 index 0000000000000..38374404f188f --- /dev/null +++ b/mobile/openapi/doc/MergePersonDto.md @@ -0,0 +1,15 @@ +# openapi.model.MergePersonDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **List** | Person IDs to merge | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MetadataSearchDto.md b/mobile/openapi/doc/MetadataSearchDto.md new file mode 100644 index 0000000000000..62c358ee369d0 --- /dev/null +++ b/mobile/openapi/doc/MetadataSearchDto.md @@ -0,0 +1,56 @@ +# openapi.model.MetadataSearchDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumIds** | **Optional?>** | Filter by album IDs | [optional] [default to const []] +**checksum** | **Optional** | Filter by file checksum | [optional] +**city** | **Optional** | Filter by city name | [optional] +**country** | **Optional** | Filter by country name | [optional] +**createdAfter** | [**Optional**](DateTime.md) | Filter by creation date (after) | [optional] +**createdBefore** | [**Optional**](DateTime.md) | Filter by creation date (before) | [optional] +**description** | **Optional** | Filter by description text | [optional] +**encodedVideoPath** | **Optional** | Filter by encoded video file path | [optional] +**id** | **Optional** | Filter by asset ID | [optional] +**isEncoded** | **Optional** | Filter by encoded status | [optional] +**isFavorite** | **Optional** | Filter by favorite status | [optional] +**isMotion** | **Optional** | Filter by motion photo status | [optional] +**isNotInAlbum** | **Optional** | Filter assets not in any album | [optional] +**isOffline** | **Optional** | Filter by offline status | [optional] +**lensModel** | **Optional** | Filter by lens model | [optional] +**libraryId** | **Optional** | Library ID to filter by | [optional] +**make** | **Optional** | Filter by camera make | [optional] +**model** | **Optional** | Filter by camera model | [optional] +**ocr** | **Optional** | Filter by OCR text content | [optional] +**order** | [**Optional**](AssetOrder.md) | | [optional] +**originalFileName** | **Optional** | Filter by original file name | [optional] +**originalPath** | **Optional** | Filter by original file path | [optional] +**page** | **Optional** | Page number | [optional] +**personIds** | **Optional?>** | Filter by person IDs | [optional] [default to const []] +**previewPath** | **Optional** | Filter by preview file path | [optional] +**rating** | **Optional** | Filter by rating [1-5], or null for unrated | [optional] +**size** | **Optional** | Number of results to return | [optional] +**state** | **Optional** | Filter by state/province name | [optional] +**tagIds** | **Optional?>** | Filter by tag IDs | [optional] [default to const []] +**takenAfter** | [**Optional**](DateTime.md) | Filter by taken date (after) | [optional] +**takenBefore** | [**Optional**](DateTime.md) | Filter by taken date (before) | [optional] +**thumbnailPath** | **Optional** | Filter by thumbnail file path | [optional] +**trashedAfter** | [**Optional**](DateTime.md) | Filter by trash date (after) | [optional] +**trashedBefore** | [**Optional**](DateTime.md) | Filter by trash date (before) | [optional] +**type** | [**Optional**](AssetTypeEnum.md) | | [optional] +**updatedAfter** | [**Optional**](DateTime.md) | Filter by update date (after) | [optional] +**updatedBefore** | [**Optional**](DateTime.md) | Filter by update date (before) | [optional] +**visibility** | [**Optional**](AssetVisibility.md) | | [optional] +**withDeleted** | **Optional** | Include deleted assets | [optional] +**withExif** | **Optional** | Include EXIF data in response | [optional] +**withPeople** | **Optional** | Include people data in response | [optional] +**withStacked** | **Optional** | Include stacked assets | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MirrorAxis.md b/mobile/openapi/doc/MirrorAxis.md new file mode 100644 index 0000000000000..800d291d247cf --- /dev/null +++ b/mobile/openapi/doc/MirrorAxis.md @@ -0,0 +1,14 @@ +# openapi.model.MirrorAxis + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/MirrorParameters.md b/mobile/openapi/doc/MirrorParameters.md new file mode 100644 index 0000000000000..ed621fb7e7cb7 --- /dev/null +++ b/mobile/openapi/doc/MirrorParameters.md @@ -0,0 +1,15 @@ +# openapi.model.MirrorParameters + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**axis** | [**MirrorAxis**](MirrorAxis.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationCreateDto.md b/mobile/openapi/doc/NotificationCreateDto.md new file mode 100644 index 0000000000000..c160cedd48224 --- /dev/null +++ b/mobile/openapi/doc/NotificationCreateDto.md @@ -0,0 +1,21 @@ +# openapi.model.NotificationCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **Optional?>** | Additional notification data | [optional] [default to const {}] +**description** | **Optional** | Notification description | [optional] +**level** | [**Optional**](NotificationLevel.md) | | [optional] +**readAt** | [**Optional**](DateTime.md) | Date when notification was read | [optional] +**title** | **String** | Notification title | +**type** | [**Optional**](NotificationType.md) | | [optional] +**userId** | **String** | User ID to send notification to | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationDeleteAllDto.md b/mobile/openapi/doc/NotificationDeleteAllDto.md new file mode 100644 index 0000000000000..19535802da17c --- /dev/null +++ b/mobile/openapi/doc/NotificationDeleteAllDto.md @@ -0,0 +1,15 @@ +# openapi.model.NotificationDeleteAllDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **List** | Notification IDs to delete | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationDto.md b/mobile/openapi/doc/NotificationDto.md new file mode 100644 index 0000000000000..db7116a58d21b --- /dev/null +++ b/mobile/openapi/doc/NotificationDto.md @@ -0,0 +1,22 @@ +# openapi.model.NotificationDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**data** | **Optional?>** | Additional notification data | [optional] [default to const {}] +**description** | **Optional** | Notification description | [optional] +**id** | **String** | Notification ID | +**level** | [**NotificationLevel**](NotificationLevel.md) | | +**readAt** | [**Optional**](DateTime.md) | Date when notification was read | [optional] +**title** | **String** | Notification title | +**type** | [**NotificationType**](NotificationType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationLevel.md b/mobile/openapi/doc/NotificationLevel.md new file mode 100644 index 0000000000000..daf4d048d5cc1 --- /dev/null +++ b/mobile/openapi/doc/NotificationLevel.md @@ -0,0 +1,14 @@ +# openapi.model.NotificationLevel + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationType.md b/mobile/openapi/doc/NotificationType.md new file mode 100644 index 0000000000000..fcf9ef365a44d --- /dev/null +++ b/mobile/openapi/doc/NotificationType.md @@ -0,0 +1,14 @@ +# openapi.model.NotificationType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationUpdateAllDto.md b/mobile/openapi/doc/NotificationUpdateAllDto.md new file mode 100644 index 0000000000000..27f045dfffa81 --- /dev/null +++ b/mobile/openapi/doc/NotificationUpdateAllDto.md @@ -0,0 +1,16 @@ +# openapi.model.NotificationUpdateAllDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **List** | Notification IDs to update | [default to const []] +**readAt** | [**Optional**](DateTime.md) | Date when notifications were read | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationUpdateDto.md b/mobile/openapi/doc/NotificationUpdateDto.md new file mode 100644 index 0000000000000..a150e011c49de --- /dev/null +++ b/mobile/openapi/doc/NotificationUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.NotificationUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**readAt** | [**Optional**](DateTime.md) | Date when notification was read | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/NotificationsAdminApi.md b/mobile/openapi/doc/NotificationsAdminApi.md new file mode 100644 index 0000000000000..84a6a3a29fd50 --- /dev/null +++ b/mobile/openapi/doc/NotificationsAdminApi.md @@ -0,0 +1,189 @@ +# openapi.api.NotificationsAdminApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createNotification**](NotificationsAdminApi.md#createnotification) | **POST** /admin/notifications | Create a notification +[**getNotificationTemplateAdmin**](NotificationsAdminApi.md#getnotificationtemplateadmin) | **POST** /admin/notifications/templates/{name} | Render email template +[**sendTestEmailAdmin**](NotificationsAdminApi.md#sendtestemailadmin) | **POST** /admin/notifications/test-email | Send test email + + +# **createNotification** +> NotificationDto createNotification(notificationCreateDto) + +Create a notification + +Create a new notification for a specific user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsAdminApi(); +final notificationCreateDto = NotificationCreateDto(); // NotificationCreateDto | + +try { + final result = api_instance.createNotification(notificationCreateDto); + print(result); +} catch (e) { + print('Exception when calling NotificationsAdminApi->createNotification: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **notificationCreateDto** | [**NotificationCreateDto**](NotificationCreateDto.md)| | + +### Return type + +[**NotificationDto**](NotificationDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getNotificationTemplateAdmin** +> TemplateResponseDto getNotificationTemplateAdmin(name, templateDto) + +Render email template + +Retrieve a preview of the provided email template. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsAdminApi(); +final name = name_example; // String | +final templateDto = TemplateDto(); // TemplateDto | + +try { + final result = api_instance.getNotificationTemplateAdmin(name, templateDto); + print(result); +} catch (e) { + print('Exception when calling NotificationsAdminApi->getNotificationTemplateAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **String**| | + **templateDto** | [**TemplateDto**](TemplateDto.md)| | + +### Return type + +[**TemplateResponseDto**](TemplateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sendTestEmailAdmin** +> TestEmailResponseDto sendTestEmailAdmin(systemConfigSmtpDto) + +Send test email + +Send a test email using the provided SMTP configuration. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsAdminApi(); +final systemConfigSmtpDto = SystemConfigSmtpDto(); // SystemConfigSmtpDto | + +try { + final result = api_instance.sendTestEmailAdmin(systemConfigSmtpDto); + print(result); +} catch (e) { + print('Exception when calling NotificationsAdminApi->sendTestEmailAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **systemConfigSmtpDto** | [**SystemConfigSmtpDto**](SystemConfigSmtpDto.md)| | + +### Return type + +[**TestEmailResponseDto**](TestEmailResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/NotificationsApi.md b/mobile/openapi/doc/NotificationsApi.md new file mode 100644 index 0000000000000..1db7f5ccc3e20 --- /dev/null +++ b/mobile/openapi/doc/NotificationsApi.md @@ -0,0 +1,366 @@ +# openapi.api.NotificationsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteNotification**](NotificationsApi.md#deletenotification) | **DELETE** /notifications/{id} | Delete a notification +[**deleteNotifications**](NotificationsApi.md#deletenotifications) | **DELETE** /notifications | Delete notifications +[**getNotification**](NotificationsApi.md#getnotification) | **GET** /notifications/{id} | Get a notification +[**getNotifications**](NotificationsApi.md#getnotifications) | **GET** /notifications | Retrieve notifications +[**updateNotification**](NotificationsApi.md#updatenotification) | **PUT** /notifications/{id} | Update a notification +[**updateNotifications**](NotificationsApi.md#updatenotifications) | **PUT** /notifications | Update notifications + + +# **deleteNotification** +> deleteNotification(id) + +Delete a notification + +Delete a specific notification. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteNotification(id); +} catch (e) { + print('Exception when calling NotificationsApi->deleteNotification: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteNotifications** +> deleteNotifications(notificationDeleteAllDto) + +Delete notifications + +Delete a list of notifications at once. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsApi(); +final notificationDeleteAllDto = NotificationDeleteAllDto(); // NotificationDeleteAllDto | + +try { + api_instance.deleteNotifications(notificationDeleteAllDto); +} catch (e) { + print('Exception when calling NotificationsApi->deleteNotifications: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **notificationDeleteAllDto** | [**NotificationDeleteAllDto**](NotificationDeleteAllDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getNotification** +> NotificationDto getNotification(id) + +Get a notification + +Retrieve a specific notification identified by id. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getNotification(id); + print(result); +} catch (e) { + print('Exception when calling NotificationsApi->getNotification: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**NotificationDto**](NotificationDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getNotifications** +> List getNotifications(id, level, type, unread) + +Retrieve notifications + +Retrieve a list of notifications. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter by notification ID +final level = ; // NotificationLevel | +final type = ; // NotificationType | +final unread = true; // bool | Filter by unread status + +try { + final result = api_instance.getNotifications(id, level, type, unread); + print(result); +} catch (e) { + print('Exception when calling NotificationsApi->getNotifications: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| Filter by notification ID | [optional] + **level** | [**NotificationLevel**](.md)| | [optional] + **type** | [**NotificationType**](.md)| | [optional] + **unread** | **bool**| Filter by unread status | [optional] + +### Return type + +[**List**](NotificationDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateNotification** +> NotificationDto updateNotification(id, notificationUpdateDto) + +Update a notification + +Update a specific notification to set its read status. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final notificationUpdateDto = NotificationUpdateDto(); // NotificationUpdateDto | + +try { + final result = api_instance.updateNotification(id, notificationUpdateDto); + print(result); +} catch (e) { + print('Exception when calling NotificationsApi->updateNotification: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **notificationUpdateDto** | [**NotificationUpdateDto**](NotificationUpdateDto.md)| | + +### Return type + +[**NotificationDto**](NotificationDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateNotifications** +> updateNotifications(notificationUpdateAllDto) + +Update notifications + +Update a list of notifications. Allows to bulk-set the read status of notifications. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = NotificationsApi(); +final notificationUpdateAllDto = NotificationUpdateAllDto(); // NotificationUpdateAllDto | + +try { + api_instance.updateNotifications(notificationUpdateAllDto); +} catch (e) { + print('Exception when calling NotificationsApi->updateNotifications: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **notificationUpdateAllDto** | [**NotificationUpdateAllDto**](NotificationUpdateAllDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/OAuthAuthorizeResponseDto.md b/mobile/openapi/doc/OAuthAuthorizeResponseDto.md new file mode 100644 index 0000000000000..695d90ec276f3 --- /dev/null +++ b/mobile/openapi/doc/OAuthAuthorizeResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.OAuthAuthorizeResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **String** | OAuth authorization URL | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OAuthCallbackDto.md b/mobile/openapi/doc/OAuthCallbackDto.md new file mode 100644 index 0000000000000..8925dbce6e8b5 --- /dev/null +++ b/mobile/openapi/doc/OAuthCallbackDto.md @@ -0,0 +1,17 @@ +# openapi.model.OAuthCallbackDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**codeVerifier** | **Optional** | OAuth code verifier (PKCE) | [optional] +**state** | **Optional** | OAuth state parameter | [optional] +**url** | **String** | OAuth callback URL | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OAuthConfigDto.md b/mobile/openapi/doc/OAuthConfigDto.md new file mode 100644 index 0000000000000..63c82b5de08ae --- /dev/null +++ b/mobile/openapi/doc/OAuthConfigDto.md @@ -0,0 +1,17 @@ +# openapi.model.OAuthConfigDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**codeChallenge** | **Optional** | OAuth code challenge (PKCE) | [optional] +**redirectUri** | **String** | OAuth redirect URI | +**state** | **Optional** | OAuth state parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OAuthTokenEndpointAuthMethod.md b/mobile/openapi/doc/OAuthTokenEndpointAuthMethod.md new file mode 100644 index 0000000000000..95e5f46d403c3 --- /dev/null +++ b/mobile/openapi/doc/OAuthTokenEndpointAuthMethod.md @@ -0,0 +1,14 @@ +# openapi.model.OAuthTokenEndpointAuthMethod + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OcrConfig.md b/mobile/openapi/doc/OcrConfig.md new file mode 100644 index 0000000000000..1b7d19cfa9877 --- /dev/null +++ b/mobile/openapi/doc/OcrConfig.md @@ -0,0 +1,19 @@ +# openapi.model.OcrConfig + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether the task is enabled | +**maxResolution** | **int** | Maximum resolution for OCR processing | +**minDetectionScore** | **double** | Minimum confidence score for text detection | +**minRecognitionScore** | **double** | Minimum confidence score for text recognition | +**modelName** | **String** | Name of the model to use | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OnThisDayDto.md b/mobile/openapi/doc/OnThisDayDto.md new file mode 100644 index 0000000000000..ab8638e07c724 --- /dev/null +++ b/mobile/openapi/doc/OnThisDayDto.md @@ -0,0 +1,15 @@ +# openapi.model.OnThisDayDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**year** | **int** | Year for on this day memory | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OnboardingApi.md b/mobile/openapi/doc/OnboardingApi.md new file mode 100644 index 0000000000000..a7892b7490f62 --- /dev/null +++ b/mobile/openapi/doc/OnboardingApi.md @@ -0,0 +1,278 @@ +# openapi.api.OnboardingApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**confirmRecoveryKey**](OnboardingApi.md#confirmrecoverykey) | **POST** /yucca/onboarding/recovery-key | +[**currentRecoveryKey**](OnboardingApi.md#currentrecoverykey) | **GET** /yucca/onboarding/recovery-key | +[**enableTelemetry**](OnboardingApi.md#enabletelemetry) | **POST** /yucca/onboarding/telemetry | +[**importRecoveryKey**](OnboardingApi.md#importrecoverykey) | **PUT** /yucca/onboarding/recovery-key | +[**onboardingStatus**](OnboardingApi.md#onboardingstatus) | **GET** /yucca/onboarding | +[**reportError**](OnboardingApi.md#reporterror) | **POST** /yucca/onboarding/report-error | +[**skipOnboardingExtraConfig**](OnboardingApi.md#skiponboardingextraconfig) | **POST** /yucca/onboarding/skip | + + +# **confirmRecoveryKey** +> confirmRecoveryKey() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = OnboardingApi(); + +try { + api_instance.confirmRecoveryKey(); +} catch (e) { + print('Exception when calling OnboardingApi->confirmRecoveryKey: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **currentRecoveryKey** +> CurrentRecoveryKeyResponse currentRecoveryKey() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = OnboardingApi(); + +try { + final result = api_instance.currentRecoveryKey(); + print(result); +} catch (e) { + print('Exception when calling OnboardingApi->currentRecoveryKey: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**CurrentRecoveryKeyResponse**](CurrentRecoveryKeyResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enableTelemetry** +> enableTelemetry() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = OnboardingApi(); + +try { + api_instance.enableTelemetry(); +} catch (e) { + print('Exception when calling OnboardingApi->enableTelemetry: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **importRecoveryKey** +> importRecoveryKey(importRecoveryKeyRequest) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = OnboardingApi(); +final importRecoveryKeyRequest = ImportRecoveryKeyRequest(); // ImportRecoveryKeyRequest | + +try { + api_instance.importRecoveryKey(importRecoveryKeyRequest); +} catch (e) { + print('Exception when calling OnboardingApi->importRecoveryKey: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **importRecoveryKeyRequest** | [**ImportRecoveryKeyRequest**](ImportRecoveryKeyRequest.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **onboardingStatus** +> OnboardingStatusResponseDto onboardingStatus() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = OnboardingApi(); + +try { + final result = api_instance.onboardingStatus(); + print(result); +} catch (e) { + print('Exception when calling OnboardingApi->onboardingStatus: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**OnboardingStatusResponseDto**](OnboardingStatusResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reportError** +> reportError() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = OnboardingApi(); + +try { + api_instance.reportError(); +} catch (e) { + print('Exception when calling OnboardingApi->reportError: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **skipOnboardingExtraConfig** +> skipOnboardingExtraConfig() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = OnboardingApi(); + +try { + api_instance.skipOnboardingExtraConfig(); +} catch (e) { + print('Exception when calling OnboardingApi->skipOnboardingExtraConfig: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/OnboardingDto.md b/mobile/openapi/doc/OnboardingDto.md new file mode 100644 index 0000000000000..e0c12c9f895b1 --- /dev/null +++ b/mobile/openapi/doc/OnboardingDto.md @@ -0,0 +1,15 @@ +# openapi.model.OnboardingDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isOnboarded** | **bool** | Is user onboarded | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OnboardingResponseDto.md b/mobile/openapi/doc/OnboardingResponseDto.md new file mode 100644 index 0000000000000..b571243ebbdcd --- /dev/null +++ b/mobile/openapi/doc/OnboardingResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.OnboardingResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isOnboarded** | **bool** | Is user onboarded | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/OnboardingStatusResponseDto.md b/mobile/openapi/doc/OnboardingStatusResponseDto.md new file mode 100644 index 0000000000000..ff053e14cb039 --- /dev/null +++ b/mobile/openapi/doc/OnboardingStatusResponseDto.md @@ -0,0 +1,22 @@ +# openapi.model.OnboardingStatusResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **Optional** | | [optional] +**hasBackend** | **bool** | | +**hasBackup** | **bool** | | +**hasOnboardedKey** | **bool** | | +**hasSchedule** | **bool** | | +**hasSkippedExtraConfig** | **bool** | | +**hasTelemetry** | [**TelemetryLevel**](TelemetryLevel.md) | | +**status** | [**BootstrapStatus**](BootstrapStatus.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PartnerCreateDto.md b/mobile/openapi/doc/PartnerCreateDto.md new file mode 100644 index 0000000000000..05ec08c72ac04 --- /dev/null +++ b/mobile/openapi/doc/PartnerCreateDto.md @@ -0,0 +1,15 @@ +# openapi.model.PartnerCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sharedWithId** | **String** | User ID to share with | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PartnerDirection.md b/mobile/openapi/doc/PartnerDirection.md new file mode 100644 index 0000000000000..a663c163e2b73 --- /dev/null +++ b/mobile/openapi/doc/PartnerDirection.md @@ -0,0 +1,14 @@ +# openapi.model.PartnerDirection + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PartnerResponseDto.md b/mobile/openapi/doc/PartnerResponseDto.md new file mode 100644 index 0000000000000..53e96c1e18715 --- /dev/null +++ b/mobile/openapi/doc/PartnerResponseDto.md @@ -0,0 +1,21 @@ +# openapi.model.PartnerResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**UserAvatarColor**](UserAvatarColor.md) | | +**email** | **String** | User email | +**id** | **String** | User ID | +**inTimeline** | **Optional** | Show in timeline | [optional] +**name** | **String** | User name | +**profileChangedAt** | [**DateTime**](DateTime.md) | Profile change date | +**profileImagePath** | **String** | Profile image path | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PartnerUpdateDto.md b/mobile/openapi/doc/PartnerUpdateDto.md new file mode 100644 index 0000000000000..06e6679d25997 --- /dev/null +++ b/mobile/openapi/doc/PartnerUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.PartnerUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inTimeline** | **bool** | Show partner assets in timeline | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PartnersApi.md b/mobile/openapi/doc/PartnersApi.md new file mode 100644 index 0000000000000..53c30fb10c227 --- /dev/null +++ b/mobile/openapi/doc/PartnersApi.md @@ -0,0 +1,304 @@ +# openapi.api.PartnersApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createPartner**](PartnersApi.md#createpartner) | **POST** /partners | Create a partner +[**createPartnerDeprecated**](PartnersApi.md#createpartnerdeprecated) | **POST** /partners/{id} | Create a partner +[**getPartners**](PartnersApi.md#getpartners) | **GET** /partners | Retrieve partners +[**removePartner**](PartnersApi.md#removepartner) | **DELETE** /partners/{id} | Remove a partner +[**updatePartner**](PartnersApi.md#updatepartner) | **PUT** /partners/{id} | Update a partner + + +# **createPartner** +> PartnerResponseDto createPartner(partnerCreateDto) + +Create a partner + +Create a new partner to share assets with. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PartnersApi(); +final partnerCreateDto = PartnerCreateDto(); // PartnerCreateDto | + +try { + final result = api_instance.createPartner(partnerCreateDto); + print(result); +} catch (e) { + print('Exception when calling PartnersApi->createPartner: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partnerCreateDto** | [**PartnerCreateDto**](PartnerCreateDto.md)| | + +### Return type + +[**PartnerResponseDto**](PartnerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createPartnerDeprecated** +> PartnerResponseDto createPartnerDeprecated(id) + +Create a partner + +Create a new partner to share assets with. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PartnersApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.createPartnerDeprecated(id); + print(result); +} catch (e) { + print('Exception when calling PartnersApi->createPartnerDeprecated: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**PartnerResponseDto**](PartnerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getPartners** +> List getPartners(direction) + +Retrieve partners + +Retrieve a list of partners with whom assets are shared. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PartnersApi(); +final direction = ; // PartnerDirection | + +try { + final result = api_instance.getPartners(direction); + print(result); +} catch (e) { + print('Exception when calling PartnersApi->getPartners: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **direction** | [**PartnerDirection**](.md)| | + +### Return type + +[**List**](PartnerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removePartner** +> removePartner(id) + +Remove a partner + +Stop sharing assets with a partner. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PartnersApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.removePartner(id); +} catch (e) { + print('Exception when calling PartnersApi->removePartner: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updatePartner** +> PartnerResponseDto updatePartner(id, partnerUpdateDto) + +Update a partner + +Specify whether a partner's assets should appear in the user's timeline. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PartnersApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final partnerUpdateDto = PartnerUpdateDto(); // PartnerUpdateDto | + +try { + final result = api_instance.updatePartner(id, partnerUpdateDto); + print(result); +} catch (e) { + print('Exception when calling PartnersApi->updatePartner: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **partnerUpdateDto** | [**PartnerUpdateDto**](PartnerUpdateDto.md)| | + +### Return type + +[**PartnerResponseDto**](PartnerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/PeopleApi.md b/mobile/openapi/doc/PeopleApi.md new file mode 100644 index 0000000000000..2efaac6c4885a --- /dev/null +++ b/mobile/openapi/doc/PeopleApi.md @@ -0,0 +1,663 @@ +# openapi.api.PeopleApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createPerson**](PeopleApi.md#createperson) | **POST** /people | Create a person +[**deletePeople**](PeopleApi.md#deletepeople) | **DELETE** /people | Delete people +[**deletePerson**](PeopleApi.md#deleteperson) | **DELETE** /people/{id} | Delete person +[**getAllPeople**](PeopleApi.md#getallpeople) | **GET** /people | Get all people +[**getPerson**](PeopleApi.md#getperson) | **GET** /people/{id} | Get a person +[**getPersonStatistics**](PeopleApi.md#getpersonstatistics) | **GET** /people/{id}/statistics | Get person statistics +[**getPersonThumbnail**](PeopleApi.md#getpersonthumbnail) | **GET** /people/{id}/thumbnail | Get person thumbnail +[**mergePerson**](PeopleApi.md#mergeperson) | **POST** /people/{id}/merge | Merge people +[**reassignFaces**](PeopleApi.md#reassignfaces) | **PUT** /people/{id}/reassign | Reassign faces +[**updatePeople**](PeopleApi.md#updatepeople) | **PUT** /people | Update people +[**updatePerson**](PeopleApi.md#updateperson) | **PUT** /people/{id} | Update person + + +# **createPerson** +> PersonResponseDto createPerson(personCreateDto) + +Create a person + +Create a new person that can have multiple faces assigned to them. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final personCreateDto = PersonCreateDto(); // PersonCreateDto | + +try { + final result = api_instance.createPerson(personCreateDto); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->createPerson: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **personCreateDto** | [**PersonCreateDto**](PersonCreateDto.md)| | + +### Return type + +[**PersonResponseDto**](PersonResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deletePeople** +> deletePeople(bulkIdsDto) + +Delete people + +Bulk delete a list of people at once. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + api_instance.deletePeople(bulkIdsDto); +} catch (e) { + print('Exception when calling PeopleApi->deletePeople: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deletePerson** +> deletePerson(id) + +Delete person + +Delete an individual person. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deletePerson(id); +} catch (e) { + print('Exception when calling PeopleApi->deletePerson: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAllPeople** +> PeopleResponseDto getAllPeople(closestAssetId, closestPersonId, page, size, withHidden) + +Get all people + +Retrieve a list of all people. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final closestAssetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Closest asset ID for similarity search +final closestPersonId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Closest person ID for similarity search +final page = 56; // int | Page number for pagination +final size = 56; // int | Number of items per page +final withHidden = true; // bool | Include hidden people + +try { + final result = api_instance.getAllPeople(closestAssetId, closestPersonId, page, size, withHidden); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->getAllPeople: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **closestAssetId** | **String**| Closest asset ID for similarity search | [optional] + **closestPersonId** | **String**| Closest person ID for similarity search | [optional] + **page** | **int**| Page number for pagination | [optional] [default to 1] + **size** | **int**| Number of items per page | [optional] [default to 500] + **withHidden** | **bool**| Include hidden people | [optional] + +### Return type + +[**PeopleResponseDto**](PeopleResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getPerson** +> PersonResponseDto getPerson(id) + +Get a person + +Retrieve a person by id. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getPerson(id); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->getPerson: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**PersonResponseDto**](PersonResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getPersonStatistics** +> PersonStatisticsResponseDto getPersonStatistics(id) + +Get person statistics + +Retrieve statistics about a specific person. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getPersonStatistics(id); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->getPersonStatistics: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**PersonStatisticsResponseDto**](PersonStatisticsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getPersonThumbnail** +> MultipartFile getPersonThumbnail(id) + +Get person thumbnail + +Retrieve the thumbnail file for a person. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getPersonThumbnail(id); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->getPersonThumbnail: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **mergePerson** +> List mergePerson(id, mergePersonDto) + +Merge people + +Merge a list of people into the person specified in the path parameter. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final mergePersonDto = MergePersonDto(); // MergePersonDto | + +try { + final result = api_instance.mergePerson(id, mergePersonDto); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->mergePerson: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **mergePersonDto** | [**MergePersonDto**](MergePersonDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reassignFaces** +> List reassignFaces(id, assetFaceUpdateDto) + +Reassign faces + +Bulk reassign a list of faces to a different person. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final assetFaceUpdateDto = AssetFaceUpdateDto(); // AssetFaceUpdateDto | + +try { + final result = api_instance.reassignFaces(id, assetFaceUpdateDto); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->reassignFaces: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **assetFaceUpdateDto** | [**AssetFaceUpdateDto**](AssetFaceUpdateDto.md)| | + +### Return type + +[**List**](PersonResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updatePeople** +> List updatePeople(peopleUpdateDto) + +Update people + +Bulk update multiple people at once. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final peopleUpdateDto = PeopleUpdateDto(); // PeopleUpdateDto | + +try { + final result = api_instance.updatePeople(peopleUpdateDto); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->updatePeople: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **peopleUpdateDto** | [**PeopleUpdateDto**](PeopleUpdateDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updatePerson** +> PersonResponseDto updatePerson(id, personUpdateDto) + +Update person + +Update an individual person. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PeopleApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final personUpdateDto = PersonUpdateDto(); // PersonUpdateDto | + +try { + final result = api_instance.updatePerson(id, personUpdateDto); + print(result); +} catch (e) { + print('Exception when calling PeopleApi->updatePerson: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **personUpdateDto** | [**PersonUpdateDto**](PersonUpdateDto.md)| | + +### Return type + +[**PersonResponseDto**](PersonResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/PeopleResponse.md b/mobile/openapi/doc/PeopleResponse.md new file mode 100644 index 0000000000000..90d88f9d7c858 --- /dev/null +++ b/mobile/openapi/doc/PeopleResponse.md @@ -0,0 +1,17 @@ +# openapi.model.PeopleResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether people are enabled | +**minimumFaces** | **Optional** | People face threshold | [optional] +**sidebarWeb** | **bool** | Whether people appear in web sidebar | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PeopleResponseDto.md b/mobile/openapi/doc/PeopleResponseDto.md new file mode 100644 index 0000000000000..0a8dcd35a2216 --- /dev/null +++ b/mobile/openapi/doc/PeopleResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.PeopleResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hasNextPage** | **Optional** | Whether there are more pages | [optional] +**hidden** | **int** | Number of hidden people | +**people** | [**List**](PersonResponseDto.md) | | [default to const []] +**total** | **int** | Total number of people | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PeopleUpdate.md b/mobile/openapi/doc/PeopleUpdate.md new file mode 100644 index 0000000000000..0cd84ee4d5d0d --- /dev/null +++ b/mobile/openapi/doc/PeopleUpdate.md @@ -0,0 +1,17 @@ +# openapi.model.PeopleUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **Optional** | Whether people are enabled | [optional] +**minimumFaces** | **Optional** | People face threshold | [optional] +**sidebarWeb** | **Optional** | Whether people appear in web sidebar | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PeopleUpdateDto.md b/mobile/openapi/doc/PeopleUpdateDto.md new file mode 100644 index 0000000000000..952271ae9f2d9 --- /dev/null +++ b/mobile/openapi/doc/PeopleUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.PeopleUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**people** | [**List**](PeopleUpdateItem.md) | People to update | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PeopleUpdateItem.md b/mobile/openapi/doc/PeopleUpdateItem.md new file mode 100644 index 0000000000000..a921d2cf56f36 --- /dev/null +++ b/mobile/openapi/doc/PeopleUpdateItem.md @@ -0,0 +1,21 @@ +# openapi.model.PeopleUpdateItem + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**birthDate** | [**Optional**](DateTime.md) | Person date of birth | [optional] +**color** | **Optional** | Person color (hex) | [optional] +**featureFaceAssetId** | **Optional** | Asset ID used for feature face thumbnail | [optional] +**id** | **String** | Person ID | +**isFavorite** | **Optional** | Mark as favorite | [optional] +**isHidden** | **Optional** | Person visibility (hidden) | [optional] +**name** | **Optional** | Person name | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/Permission.md b/mobile/openapi/doc/Permission.md new file mode 100644 index 0000000000000..f0b9ff187425b --- /dev/null +++ b/mobile/openapi/doc/Permission.md @@ -0,0 +1,14 @@ +# openapi.model.Permission + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PersonCreateDto.md b/mobile/openapi/doc/PersonCreateDto.md new file mode 100644 index 0000000000000..c3904bae4f96c --- /dev/null +++ b/mobile/openapi/doc/PersonCreateDto.md @@ -0,0 +1,19 @@ +# openapi.model.PersonCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**birthDate** | [**Optional**](DateTime.md) | Person date of birth | [optional] +**color** | **Optional** | Person color (hex) | [optional] +**isFavorite** | **Optional** | Mark as favorite | [optional] +**isHidden** | **Optional** | Person visibility (hidden) | [optional] +**name** | **Optional** | Person name | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PersonResponseDto.md b/mobile/openapi/doc/PersonResponseDto.md new file mode 100644 index 0000000000000..fa2103cb53786 --- /dev/null +++ b/mobile/openapi/doc/PersonResponseDto.md @@ -0,0 +1,22 @@ +# openapi.model.PersonResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**birthDate** | [**DateTime**](DateTime.md) | Person date of birth | +**color** | **Optional** | Person color (hex) | [optional] +**id** | **String** | Person ID | +**isFavorite** | **Optional** | Is favorite | [optional] +**isHidden** | **bool** | Is hidden | +**name** | **String** | Person name | +**thumbnailPath** | **String** | Thumbnail path | +**updatedAt** | [**Optional**](DateTime.md) | Last update date | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PersonStatisticsResponseDto.md b/mobile/openapi/doc/PersonStatisticsResponseDto.md new file mode 100644 index 0000000000000..5835248ffe56a --- /dev/null +++ b/mobile/openapi/doc/PersonStatisticsResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.PersonStatisticsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assets** | **int** | Number of assets | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PersonUpdateDto.md b/mobile/openapi/doc/PersonUpdateDto.md new file mode 100644 index 0000000000000..e41a3b26bb87a --- /dev/null +++ b/mobile/openapi/doc/PersonUpdateDto.md @@ -0,0 +1,20 @@ +# openapi.model.PersonUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**birthDate** | [**Optional**](DateTime.md) | Person date of birth | [optional] +**color** | **Optional** | Person color (hex) | [optional] +**featureFaceAssetId** | **Optional** | Asset ID used for feature face thumbnail | [optional] +**isFavorite** | **Optional** | Mark as favorite | [optional] +**isHidden** | **Optional** | Person visibility (hidden) | [optional] +**name** | **Optional** | Person name | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PinCodeChangeDto.md b/mobile/openapi/doc/PinCodeChangeDto.md new file mode 100644 index 0000000000000..4d7f8fe418f78 --- /dev/null +++ b/mobile/openapi/doc/PinCodeChangeDto.md @@ -0,0 +1,17 @@ +# openapi.model.PinCodeChangeDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**newPinCode** | **String** | New PIN code (4-6 digits) | +**password** | **Optional** | User password (required if PIN code is not provided) | [optional] +**pinCode** | **Optional** | New PIN code (4-6 digits) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PinCodeResetDto.md b/mobile/openapi/doc/PinCodeResetDto.md new file mode 100644 index 0000000000000..0545288f5c0a2 --- /dev/null +++ b/mobile/openapi/doc/PinCodeResetDto.md @@ -0,0 +1,16 @@ +# openapi.model.PinCodeResetDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **Optional** | User password (required if PIN code is not provided) | [optional] +**pinCode** | **Optional** | New PIN code (4-6 digits) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PinCodeSetupDto.md b/mobile/openapi/doc/PinCodeSetupDto.md new file mode 100644 index 0000000000000..2f79a48247e3f --- /dev/null +++ b/mobile/openapi/doc/PinCodeSetupDto.md @@ -0,0 +1,15 @@ +# openapi.model.PinCodeSetupDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pinCode** | **String** | PIN code (4-6 digits) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PlacesResponseDto.md b/mobile/openapi/doc/PlacesResponseDto.md new file mode 100644 index 0000000000000..8269b3effc175 --- /dev/null +++ b/mobile/openapi/doc/PlacesResponseDto.md @@ -0,0 +1,19 @@ +# openapi.model.PlacesResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**admin1name** | **Optional** | Administrative level 1 name (state/province) | [optional] +**admin2name** | **Optional** | Administrative level 2 name (county/district) | [optional] +**latitude** | **num** | Latitude coordinate | +**longitude** | **num** | Longitude coordinate | +**name** | **String** | Place name | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PluginMethodResponseDto.md b/mobile/openapi/doc/PluginMethodResponseDto.md new file mode 100644 index 0000000000000..2867c8a3630ad --- /dev/null +++ b/mobile/openapi/doc/PluginMethodResponseDto.md @@ -0,0 +1,22 @@ +# openapi.model.PluginMethodResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Description | +**hostFunctions** | **bool** | | +**key** | **String** | Key | +**name** | **String** | Name | +**schema** | **Optional** | | [optional] +**title** | **String** | Title | +**types** | [**List**](WorkflowType.md) | Workflow types | [default to const []] +**uiHints** | **List** | Ui hints | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PluginResponseDto.md b/mobile/openapi/doc/PluginResponseDto.md new file mode 100644 index 0000000000000..55f8488ab73d8 --- /dev/null +++ b/mobile/openapi/doc/PluginResponseDto.md @@ -0,0 +1,23 @@ +# openapi.model.PluginResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**author** | **String** | Plugin author | +**createdAt** | **String** | Creation date | +**description** | **String** | Plugin description | +**id** | **String** | Plugin ID | +**methods** | [**List**](PluginMethodResponseDto.md) | Plugin methods | [default to const []] +**name** | **String** | Plugin name | +**title** | **String** | Plugin title | +**updatedAt** | **String** | Last update date | +**version** | **String** | Plugin version | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PluginTemplateResponseDto.md b/mobile/openapi/doc/PluginTemplateResponseDto.md new file mode 100644 index 0000000000000..8539575a89575 --- /dev/null +++ b/mobile/openapi/doc/PluginTemplateResponseDto.md @@ -0,0 +1,20 @@ +# openapi.model.PluginTemplateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Template description | +**key** | **String** | Template key (unique across all templates) | +**steps** | [**List**](PluginTemplateStepResponseDto.md) | Workflow steps | [default to const []] +**title** | **String** | Template title | +**trigger** | [**WorkflowTrigger**](WorkflowTrigger.md) | | +**uiHints** | **List** | Ui hints, for example \"smart-album\" | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PluginTemplateStepResponseDto.md b/mobile/openapi/doc/PluginTemplateStepResponseDto.md new file mode 100644 index 0000000000000..3bcb753f6f2eb --- /dev/null +++ b/mobile/openapi/doc/PluginTemplateStepResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.PluginTemplateStepResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | **Map** | Step configuration | [default to const {}] +**enabled** | **Optional** | Whether the step is enabled | [optional] +**method** | **String** | Step plugin method | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PluginsApi.md b/mobile/openapi/doc/PluginsApi.md new file mode 100644 index 0000000000000..1484b2a64dd20 --- /dev/null +++ b/mobile/openapi/doc/PluginsApi.md @@ -0,0 +1,267 @@ +# openapi.api.PluginsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getPlugin**](PluginsApi.md#getplugin) | **GET** /plugins/{id} | Retrieve a plugin +[**searchPluginMethods**](PluginsApi.md#searchpluginmethods) | **GET** /plugins/methods | Retrieve plugin methods +[**searchPluginTemplates**](PluginsApi.md#searchplugintemplates) | **GET** /plugins/templates | Retrieve workflow templates +[**searchPlugins**](PluginsApi.md#searchplugins) | **GET** /plugins | List all plugins + + +# **getPlugin** +> PluginResponseDto getPlugin(id) + +Retrieve a plugin + +Retrieve information about a specific plugin by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PluginsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getPlugin(id); + print(result); +} catch (e) { + print('Exception when calling PluginsApi->getPlugin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**PluginResponseDto**](PluginResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchPluginMethods** +> List searchPluginMethods(description, enabled, id, name, pluginName, pluginVersion, title, trigger, type) + +Retrieve plugin methods + +Retrieve a list of plugin methods + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PluginsApi(); +final description = description_example; // String | +final enabled = true; // bool | Whether the plugin method is enabled +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Plugin method ID +final name = name_example; // String | +final pluginName = pluginName_example; // String | Plugin name +final pluginVersion = pluginVersion_example; // String | Plugin version +final title = title_example; // String | +final trigger = ; // WorkflowTrigger | Workflow trigger +final type = ; // WorkflowType | Workflow types + +try { + final result = api_instance.searchPluginMethods(description, enabled, id, name, pluginName, pluginVersion, title, trigger, type); + print(result); +} catch (e) { + print('Exception when calling PluginsApi->searchPluginMethods: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **description** | **String**| | [optional] + **enabled** | **bool**| Whether the plugin method is enabled | [optional] + **id** | **String**| Plugin method ID | [optional] + **name** | **String**| | [optional] + **pluginName** | **String**| Plugin name | [optional] + **pluginVersion** | **String**| Plugin version | [optional] + **title** | **String**| | [optional] + **trigger** | [**WorkflowTrigger**](.md)| Workflow trigger | [optional] + **type** | [**WorkflowType**](.md)| Workflow types | [optional] + +### Return type + +[**List**](PluginMethodResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchPluginTemplates** +> List searchPluginTemplates() + +Retrieve workflow templates + +Retrieve workflow templates provided by installed plugins + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PluginsApi(); + +try { + final result = api_instance.searchPluginTemplates(); + print(result); +} catch (e) { + print('Exception when calling PluginsApi->searchPluginTemplates: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](PluginTemplateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchPlugins** +> List searchPlugins(description, enabled, id, name, title, version) + +List all plugins + +Retrieve a list of plugins available to the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = PluginsApi(); +final description = description_example; // String | +final enabled = true; // bool | Whether the plugin is enabled +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Plugin ID +final name = name_example; // String | +final title = title_example; // String | +final version = version_example; // String | + +try { + final result = api_instance.searchPlugins(description, enabled, id, name, title, version); + print(result); +} catch (e) { + print('Exception when calling PluginsApi->searchPlugins: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **description** | **String**| | [optional] + **enabled** | **bool**| Whether the plugin is enabled | [optional] + **id** | **String**| Plugin ID | [optional] + **name** | **String**| | [optional] + **title** | **String**| | [optional] + **version** | **String**| | [optional] + +### Return type + +[**List**](PluginResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/PurchaseResponse.md b/mobile/openapi/doc/PurchaseResponse.md new file mode 100644 index 0000000000000..047b5c5a2091b --- /dev/null +++ b/mobile/openapi/doc/PurchaseResponse.md @@ -0,0 +1,16 @@ +# openapi.model.PurchaseResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hideBuyButtonUntil** | **String** | Date until which to hide buy button | +**showSupportBadge** | **bool** | Whether to show support badge | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/PurchaseUpdate.md b/mobile/openapi/doc/PurchaseUpdate.md new file mode 100644 index 0000000000000..20c1f49f30645 --- /dev/null +++ b/mobile/openapi/doc/PurchaseUpdate.md @@ -0,0 +1,16 @@ +# openapi.model.PurchaseUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hideBuyButtonUntil** | **Optional** | Date until which to hide buy button | [optional] +**showSupportBadge** | **Optional** | Whether to show support badge | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueCommand.md b/mobile/openapi/doc/QueueCommand.md new file mode 100644 index 0000000000000..8e7692b61d252 --- /dev/null +++ b/mobile/openapi/doc/QueueCommand.md @@ -0,0 +1,14 @@ +# openapi.model.QueueCommand + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueCommandDto.md b/mobile/openapi/doc/QueueCommandDto.md new file mode 100644 index 0000000000000..4b1e852132f50 --- /dev/null +++ b/mobile/openapi/doc/QueueCommandDto.md @@ -0,0 +1,16 @@ +# openapi.model.QueueCommandDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**command** | [**QueueCommand**](QueueCommand.md) | | +**force** | **Optional** | Force the command execution (if applicable) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueDeleteDto.md b/mobile/openapi/doc/QueueDeleteDto.md new file mode 100644 index 0000000000000..2db20cccd45d1 --- /dev/null +++ b/mobile/openapi/doc/QueueDeleteDto.md @@ -0,0 +1,15 @@ +# openapi.model.QueueDeleteDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**failed** | **Optional** | If true, will also remove failed jobs from the queue. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueJobResponseDto.md b/mobile/openapi/doc/QueueJobResponseDto.md new file mode 100644 index 0000000000000..b5069466de4bb --- /dev/null +++ b/mobile/openapi/doc/QueueJobResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.QueueJobResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **Map** | Job data payload | [default to const {}] +**id** | **Optional** | Job ID | [optional] +**name** | [**JobName**](JobName.md) | | +**timestamp** | **int** | Job creation timestamp | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueJobStatus.md b/mobile/openapi/doc/QueueJobStatus.md new file mode 100644 index 0000000000000..bb5cf12fd48bc --- /dev/null +++ b/mobile/openapi/doc/QueueJobStatus.md @@ -0,0 +1,14 @@ +# openapi.model.QueueJobStatus + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueName.md b/mobile/openapi/doc/QueueName.md new file mode 100644 index 0000000000000..b3dedc7337511 --- /dev/null +++ b/mobile/openapi/doc/QueueName.md @@ -0,0 +1,14 @@ +# openapi.model.QueueName + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueResponseDto.md b/mobile/openapi/doc/QueueResponseDto.md new file mode 100644 index 0000000000000..92d1d414d66b8 --- /dev/null +++ b/mobile/openapi/doc/QueueResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.QueueResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isPaused** | **bool** | Whether the queue is paused | +**name** | [**QueueName**](QueueName.md) | | +**statistics** | [**QueueStatisticsDto**](QueueStatisticsDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueResponseLegacyDto.md b/mobile/openapi/doc/QueueResponseLegacyDto.md new file mode 100644 index 0000000000000..59775847efbd4 --- /dev/null +++ b/mobile/openapi/doc/QueueResponseLegacyDto.md @@ -0,0 +1,16 @@ +# openapi.model.QueueResponseLegacyDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobCounts** | [**QueueStatisticsDto**](QueueStatisticsDto.md) | | +**queueStatus** | [**QueueStatusLegacyDto**](QueueStatusLegacyDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueStatisticsDto.md b/mobile/openapi/doc/QueueStatisticsDto.md new file mode 100644 index 0000000000000..24b7b0cd88876 --- /dev/null +++ b/mobile/openapi/doc/QueueStatisticsDto.md @@ -0,0 +1,20 @@ +# openapi.model.QueueStatisticsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**active** | **int** | Number of active jobs | +**completed** | **int** | Number of completed jobs | +**delayed** | **int** | Number of delayed jobs | +**failed** | **int** | Number of failed jobs | +**paused** | **int** | Number of paused jobs | +**waiting** | **int** | Number of waiting jobs | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueStatusLegacyDto.md b/mobile/openapi/doc/QueueStatusLegacyDto.md new file mode 100644 index 0000000000000..1e6dc21883c2f --- /dev/null +++ b/mobile/openapi/doc/QueueStatusLegacyDto.md @@ -0,0 +1,16 @@ +# openapi.model.QueueStatusLegacyDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isActive** | **bool** | Whether the queue is currently active (has running jobs) | +**isPaused** | **bool** | Whether the queue is paused | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueueUpdateDto.md b/mobile/openapi/doc/QueueUpdateDto.md new file mode 100644 index 0000000000000..1624959c05ded --- /dev/null +++ b/mobile/openapi/doc/QueueUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.QueueUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isPaused** | **Optional** | Whether to pause the queue | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/QueuesApi.md b/mobile/openapi/doc/QueuesApi.md new file mode 100644 index 0000000000000..a2f47cdb73b04 --- /dev/null +++ b/mobile/openapi/doc/QueuesApi.md @@ -0,0 +1,304 @@ +# openapi.api.QueuesApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**emptyQueue**](QueuesApi.md#emptyqueue) | **DELETE** /queues/{name}/jobs | Empty a queue +[**getQueue**](QueuesApi.md#getqueue) | **GET** /queues/{name} | Retrieve a queue +[**getQueueJobs**](QueuesApi.md#getqueuejobs) | **GET** /queues/{name}/jobs | Retrieve queue jobs +[**getQueues**](QueuesApi.md#getqueues) | **GET** /queues | List all queues +[**updateQueue**](QueuesApi.md#updatequeue) | **PUT** /queues/{name} | Update a queue + + +# **emptyQueue** +> emptyQueue(name, queueDeleteDto) + +Empty a queue + +Removes all jobs from the specified queue. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = QueuesApi(); +final name = ; // QueueName | +final queueDeleteDto = QueueDeleteDto(); // QueueDeleteDto | + +try { + api_instance.emptyQueue(name, queueDeleteDto); +} catch (e) { + print('Exception when calling QueuesApi->emptyQueue: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**QueueName**](.md)| | + **queueDeleteDto** | [**QueueDeleteDto**](QueueDeleteDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getQueue** +> QueueResponseDto getQueue(name) + +Retrieve a queue + +Retrieves a specific queue by its name. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = QueuesApi(); +final name = ; // QueueName | + +try { + final result = api_instance.getQueue(name); + print(result); +} catch (e) { + print('Exception when calling QueuesApi->getQueue: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**QueueName**](.md)| | + +### Return type + +[**QueueResponseDto**](QueueResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getQueueJobs** +> List getQueueJobs(name, status) + +Retrieve queue jobs + +Retrieves a list of queue jobs from the specified queue. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = QueuesApi(); +final name = ; // QueueName | +final status = []; // List | Filter jobs by status + +try { + final result = api_instance.getQueueJobs(name, status); + print(result); +} catch (e) { + print('Exception when calling QueuesApi->getQueueJobs: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**QueueName**](.md)| | + **status** | [**List**](QueueJobStatus.md)| Filter jobs by status | [optional] [default to const []] + +### Return type + +[**List**](QueueJobResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getQueues** +> List getQueues() + +List all queues + +Retrieves a list of queues. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = QueuesApi(); + +try { + final result = api_instance.getQueues(); + print(result); +} catch (e) { + print('Exception when calling QueuesApi->getQueues: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](QueueResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateQueue** +> QueueResponseDto updateQueue(name, queueUpdateDto) + +Update a queue + +Change the paused status of a specific queue. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = QueuesApi(); +final name = ; // QueueName | +final queueUpdateDto = QueueUpdateDto(); // QueueUpdateDto | + +try { + final result = api_instance.updateQueue(name, queueUpdateDto); + print(result); +} catch (e) { + print('Exception when calling QueuesApi->updateQueue: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | [**QueueName**](.md)| | + **queueUpdateDto** | [**QueueUpdateDto**](QueueUpdateDto.md)| | + +### Return type + +[**QueueResponseDto**](QueueResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/QueuesResponseLegacyDto.md b/mobile/openapi/doc/QueuesResponseLegacyDto.md new file mode 100644 index 0000000000000..dbb37df9bdf53 --- /dev/null +++ b/mobile/openapi/doc/QueuesResponseLegacyDto.md @@ -0,0 +1,33 @@ +# openapi.model.QueuesResponseLegacyDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backgroundTask** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**backupDatabase** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**duplicateDetection** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**editor** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**faceDetection** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**facialRecognition** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**integrityCheck** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**library_** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**metadataExtraction** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**migration** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**notifications** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**ocr** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**search** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**sidecar** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**smartSearch** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**storageTemplateMigration** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**thumbnailGeneration** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**videoConversion** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | +**workflow** | [**QueueResponseLegacyDto**](QueueResponseLegacyDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RandomSearchDto.md b/mobile/openapi/doc/RandomSearchDto.md new file mode 100644 index 0000000000000..fb44a9493da68 --- /dev/null +++ b/mobile/openapi/doc/RandomSearchDto.md @@ -0,0 +1,46 @@ +# openapi.model.RandomSearchDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumIds** | **Optional?>** | Filter by album IDs | [optional] [default to const []] +**city** | **Optional** | Filter by city name | [optional] +**country** | **Optional** | Filter by country name | [optional] +**createdAfter** | [**Optional**](DateTime.md) | Filter by creation date (after) | [optional] +**createdBefore** | [**Optional**](DateTime.md) | Filter by creation date (before) | [optional] +**isEncoded** | **Optional** | Filter by encoded status | [optional] +**isFavorite** | **Optional** | Filter by favorite status | [optional] +**isMotion** | **Optional** | Filter by motion photo status | [optional] +**isNotInAlbum** | **Optional** | Filter assets not in any album | [optional] +**isOffline** | **Optional** | Filter by offline status | [optional] +**lensModel** | **Optional** | Filter by lens model | [optional] +**libraryId** | **Optional** | Library ID to filter by | [optional] +**make** | **Optional** | Filter by camera make | [optional] +**model** | **Optional** | Filter by camera model | [optional] +**ocr** | **Optional** | Filter by OCR text content | [optional] +**personIds** | **Optional?>** | Filter by person IDs | [optional] [default to const []] +**rating** | **Optional** | Filter by rating [1-5], or null for unrated | [optional] +**size** | **Optional** | Number of results to return | [optional] +**state** | **Optional** | Filter by state/province name | [optional] +**tagIds** | **Optional?>** | Filter by tag IDs | [optional] [default to const []] +**takenAfter** | [**Optional**](DateTime.md) | Filter by taken date (after) | [optional] +**takenBefore** | [**Optional**](DateTime.md) | Filter by taken date (before) | [optional] +**trashedAfter** | [**Optional**](DateTime.md) | Filter by trash date (after) | [optional] +**trashedBefore** | [**Optional**](DateTime.md) | Filter by trash date (before) | [optional] +**type** | [**Optional**](AssetTypeEnum.md) | | [optional] +**updatedAfter** | [**Optional**](DateTime.md) | Filter by update date (after) | [optional] +**updatedBefore** | [**Optional**](DateTime.md) | Filter by update date (before) | [optional] +**visibility** | [**Optional**](AssetVisibility.md) | | [optional] +**withDeleted** | **Optional** | Include deleted assets | [optional] +**withExif** | **Optional** | Include EXIF data in response | [optional] +**withPeople** | **Optional** | Include people data in response | [optional] +**withStacked** | **Optional** | Include stacked assets | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RatingsResponse.md b/mobile/openapi/doc/RatingsResponse.md new file mode 100644 index 0000000000000..5f0513812fc87 --- /dev/null +++ b/mobile/openapi/doc/RatingsResponse.md @@ -0,0 +1,15 @@ +# openapi.model.RatingsResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether ratings are enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RatingsUpdate.md b/mobile/openapi/doc/RatingsUpdate.md new file mode 100644 index 0000000000000..051957801de07 --- /dev/null +++ b/mobile/openapi/doc/RatingsUpdate.md @@ -0,0 +1,15 @@ +# openapi.model.RatingsUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **Optional** | Whether ratings are enabled | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ReactionLevel.md b/mobile/openapi/doc/ReactionLevel.md new file mode 100644 index 0000000000000..a53955cb0a101 --- /dev/null +++ b/mobile/openapi/doc/ReactionLevel.md @@ -0,0 +1,14 @@ +# openapi.model.ReactionLevel + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ReactionType.md b/mobile/openapi/doc/ReactionType.md new file mode 100644 index 0000000000000..0cc41e23a940c --- /dev/null +++ b/mobile/openapi/doc/ReactionType.md @@ -0,0 +1,14 @@ +# openapi.model.ReactionType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RecentlyAddedResponse.md b/mobile/openapi/doc/RecentlyAddedResponse.md new file mode 100644 index 0000000000000..c28b38bc1ad20 --- /dev/null +++ b/mobile/openapi/doc/RecentlyAddedResponse.md @@ -0,0 +1,15 @@ +# openapi.model.RecentlyAddedResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sidebarWeb** | **bool** | Whether the recently added page appears in the web sidebar | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RecentlyAddedUpdate.md b/mobile/openapi/doc/RecentlyAddedUpdate.md new file mode 100644 index 0000000000000..7225d05829cca --- /dev/null +++ b/mobile/openapi/doc/RecentlyAddedUpdate.md @@ -0,0 +1,15 @@ +# openapi.model.RecentlyAddedUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sidebarWeb** | **Optional** | Whether the recently added page appears in the web sidebar | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ReleaseChannel.md b/mobile/openapi/doc/ReleaseChannel.md new file mode 100644 index 0000000000000..032d4adde998b --- /dev/null +++ b/mobile/openapi/doc/ReleaseChannel.md @@ -0,0 +1,14 @@ +# openapi.model.ReleaseChannel + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ReleaseEventV1.md b/mobile/openapi/doc/ReleaseEventV1.md new file mode 100644 index 0000000000000..fb3d9922198a0 --- /dev/null +++ b/mobile/openapi/doc/ReleaseEventV1.md @@ -0,0 +1,19 @@ +# openapi.model.ReleaseEventV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checkedAt** | **String** | When the server last checked for a latest version. As an ISO timestamp | +**isAvailable** | **bool** | Whether a new version is available | +**releaseVersion** | [**ServerVersionResponseDto**](ServerVersionResponseDto.md) | | +**serverVersion** | [**ServerVersionResponseDto**](ServerVersionResponseDto.md) | | +**type** | [**ReleaseType**](ReleaseType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ReleaseType.md b/mobile/openapi/doc/ReleaseType.md new file mode 100644 index 0000000000000..94b2b6579b5b2 --- /dev/null +++ b/mobile/openapi/doc/ReleaseType.md @@ -0,0 +1,14 @@ +# openapi.model.ReleaseType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryApi.md b/mobile/openapi/doc/RepositoryApi.md new file mode 100644 index 0000000000000..591325a2ead59 --- /dev/null +++ b/mobile/openapi/doc/RepositoryApi.md @@ -0,0 +1,708 @@ +# openapi.api.RepositoryApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**checkImportRepository**](RepositoryApi.md#checkimportrepository) | **GET** /yucca/repository/{id}/import | +[**createBackup**](RepositoryApi.md#createbackup) | **POST** /yucca/repository/{id} | +[**createRepository**](RepositoryApi.md#createrepository) | **POST** /yucca/repository | +[**deleteRepository**](RepositoryApi.md#deleterepository) | **DELETE** /yucca/repository/{id} | +[**forgetSnapshot**](RepositoryApi.md#forgetsnapshot) | **DELETE** /yucca/repository/{id}/snapshots/{snapshot} | +[**getRepositories**](RepositoryApi.md#getrepositories) | **GET** /yucca/repository | +[**getRunHistory**](RepositoryApi.md#getrunhistory) | **GET** /yucca/repository/{id}/runs | +[**getSnapshotListing**](RepositoryApi.md#getsnapshotlisting) | **GET** /yucca/repository/{id}/snapshots/{snapshot}/listing | +[**getSnapshots**](RepositoryApi.md#getsnapshots) | **GET** /yucca/repository/{id}/snapshots | +[**importRepository**](RepositoryApi.md#importrepository) | **POST** /yucca/repository/{id}/import | +[**inspectRepositories**](RepositoryApi.md#inspectrepositories) | **GET** /yucca/repository/inspect | +[**pruneRepository**](RepositoryApi.md#prunerepository) | **POST** /yucca/repository/{id}/snapshots/prune | +[**reconfigureRepositoryPrimaryBackend**](RepositoryApi.md#reconfigurerepositoryprimarybackend) | **PUT** /yucca/repository/{id}/backend | +[**restoreFromPoint**](RepositoryApi.md#restorefrompoint) | **POST** /yucca/repository/{id}/snapshots/{snapshot}/restore-from-point | +[**restoreSnapshot**](RepositoryApi.md#restoresnapshot) | **POST** /yucca/repository/{id}/snapshots/{snapshot} | +[**updateRepository**](RepositoryApi.md#updaterepository) | **PATCH** /yucca/repository/{id} | + + +# **checkImportRepository** +> RepositoryCheckImportResponseDto checkImportRepository(backend, id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final backend = backend_example; // String | +final id = id_example; // String | + +try { + final result = api_instance.checkImportRepository(backend, id); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->checkImportRepository: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **backend** | **String**| | + **id** | **String**| | + +### Return type + +[**RepositoryCheckImportResponseDto**](RepositoryCheckImportResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createBackup** +> LogResponseDto createBackup(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | + +try { + final result = api_instance.createBackup(id); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->createBackup: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**LogResponseDto**](LogResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createRepository** +> RepositoryCreateResponseDto createRepository(repositoryCreateRequestDto, backend) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final repositoryCreateRequestDto = RepositoryCreateRequestDto(); // RepositoryCreateRequestDto | +final backend = backend_example; // String | + +try { + final result = api_instance.createRepository(repositoryCreateRequestDto, backend); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->createRepository: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repositoryCreateRequestDto** | [**RepositoryCreateRequestDto**](RepositoryCreateRequestDto.md)| | + **backend** | **String**| | [optional] + +### Return type + +[**RepositoryCreateResponseDto**](RepositoryCreateResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteRepository** +> deleteRepository(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | + +try { + api_instance.deleteRepository(id); +} catch (e) { + print('Exception when calling RepositoryApi->deleteRepository: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **forgetSnapshot** +> ListSnapshotsResponseDto forgetSnapshot(id, snapshot) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | +final snapshot = snapshot_example; // String | + +try { + final result = api_instance.forgetSnapshot(id, snapshot); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->forgetSnapshot: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **snapshot** | **String**| | + +### Return type + +[**ListSnapshotsResponseDto**](ListSnapshotsResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getRepositories** +> RepositoryListResponseDto getRepositories() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); + +try { + final result = api_instance.getRepositories(); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->getRepositories: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**RepositoryListResponseDto**](RepositoryListResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getRunHistory** +> RunHistoryResponseDto getRunHistory(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | + +try { + final result = api_instance.getRunHistory(id); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->getRunHistory: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**RunHistoryResponseDto**](RunHistoryResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSnapshotListing** +> FilesystemListingResponseDto getSnapshotListing(id, snapshot, path) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | +final snapshot = snapshot_example; // String | +final path = path_example; // String | + +try { + final result = api_instance.getSnapshotListing(id, snapshot, path); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->getSnapshotListing: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **snapshot** | **String**| | + **path** | **String**| | [optional] + +### Return type + +[**FilesystemListingResponseDto**](FilesystemListingResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSnapshots** +> ListSnapshotsResponseDto getSnapshots(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | + +try { + final result = api_instance.getSnapshots(id); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->getSnapshots: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**ListSnapshotsResponseDto**](ListSnapshotsResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **importRepository** +> RepositoryCreateResponseDto importRepository(backend, id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final backend = backend_example; // String | +final id = id_example; // String | + +try { + final result = api_instance.importRepository(backend, id); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->importRepository: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **backend** | **String**| | + **id** | **String**| | + +### Return type + +[**RepositoryCreateResponseDto**](RepositoryCreateResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **inspectRepositories** +> RepositoryInspectResponseDto inspectRepositories(backend) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final backend = backend_example; // String | + +try { + final result = api_instance.inspectRepositories(backend); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->inspectRepositories: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **backend** | **String**| | [optional] + +### Return type + +[**RepositoryInspectResponseDto**](RepositoryInspectResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pruneRepository** +> LogResponseDto pruneRepository(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | + +try { + final result = api_instance.pruneRepository(id); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->pruneRepository: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**LogResponseDto**](LogResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **reconfigureRepositoryPrimaryBackend** +> RepositoryCreateResponseDto reconfigureRepositoryPrimaryBackend(id, repositoryPrimaryBackendReconfigureRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | +final repositoryPrimaryBackendReconfigureRequestDto = RepositoryPrimaryBackendReconfigureRequestDto(); // RepositoryPrimaryBackendReconfigureRequestDto | + +try { + final result = api_instance.reconfigureRepositoryPrimaryBackend(id, repositoryPrimaryBackendReconfigureRequestDto); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->reconfigureRepositoryPrimaryBackend: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **repositoryPrimaryBackendReconfigureRequestDto** | [**RepositoryPrimaryBackendReconfigureRequestDto**](RepositoryPrimaryBackendReconfigureRequestDto.md)| | + +### Return type + +[**RepositoryCreateResponseDto**](RepositoryCreateResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restoreFromPoint** +> LogResponseDto restoreFromPoint(backend, id, snapshot, repositorySnapshotRestoreFromPointRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final backend = backend_example; // String | +final id = id_example; // String | +final snapshot = snapshot_example; // String | +final repositorySnapshotRestoreFromPointRequestDto = RepositorySnapshotRestoreFromPointRequestDto(); // RepositorySnapshotRestoreFromPointRequestDto | + +try { + final result = api_instance.restoreFromPoint(backend, id, snapshot, repositorySnapshotRestoreFromPointRequestDto); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->restoreFromPoint: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **backend** | **String**| | + **id** | **String**| | + **snapshot** | **String**| | + **repositorySnapshotRestoreFromPointRequestDto** | [**RepositorySnapshotRestoreFromPointRequestDto**](RepositorySnapshotRestoreFromPointRequestDto.md)| | + +### Return type + +[**LogResponseDto**](LogResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restoreSnapshot** +> LogResponseDto restoreSnapshot(id, snapshot, repositorySnapshotRestoreRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | +final snapshot = snapshot_example; // String | +final repositorySnapshotRestoreRequestDto = RepositorySnapshotRestoreRequestDto(); // RepositorySnapshotRestoreRequestDto | + +try { + final result = api_instance.restoreSnapshot(id, snapshot, repositorySnapshotRestoreRequestDto); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->restoreSnapshot: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **snapshot** | **String**| | + **repositorySnapshotRestoreRequestDto** | [**RepositorySnapshotRestoreRequestDto**](RepositorySnapshotRestoreRequestDto.md)| | + +### Return type + +[**LogResponseDto**](LogResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateRepository** +> RepositoryUpdateResponseDto updateRepository(id, repositoryUpdateRequestDto, backend) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RepositoryApi(); +final id = id_example; // String | +final repositoryUpdateRequestDto = RepositoryUpdateRequestDto(); // RepositoryUpdateRequestDto | +final backend = backend_example; // String | + +try { + final result = api_instance.updateRepository(id, repositoryUpdateRequestDto, backend); + print(result); +} catch (e) { + print('Exception when calling RepositoryApi->updateRepository: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **repositoryUpdateRequestDto** | [**RepositoryUpdateRequestDto**](RepositoryUpdateRequestDto.md)| | + **backend** | **String**| | [optional] + +### Return type + +[**RepositoryUpdateResponseDto**](RepositoryUpdateResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/RepositoryBackendDto.md b/mobile/openapi/doc/RepositoryBackendDto.md new file mode 100644 index 0000000000000..3ffe5369bcdfe --- /dev/null +++ b/mobile/openapi/doc/RepositoryBackendDto.md @@ -0,0 +1,17 @@ +# openapi.model.RepositoryBackendDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**online** | **bool** | | +**type** | [**BackendType**](BackendType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryBackendsDto.md b/mobile/openapi/doc/RepositoryBackendsDto.md new file mode 100644 index 0000000000000..b594c2c69de70 --- /dev/null +++ b/mobile/openapi/doc/RepositoryBackendsDto.md @@ -0,0 +1,16 @@ +# openapi.model.RepositoryBackendsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**primary** | [**RepositoryBackendDto**](RepositoryBackendDto.md) | | +**secondary** | [**List**](RepositoryBackendDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryCheckImportResponseDto.md b/mobile/openapi/doc/RepositoryCheckImportResponseDto.md new file mode 100644 index 0000000000000..4729f2aaca681 --- /dev/null +++ b/mobile/openapi/doc/RepositoryCheckImportResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.RepositoryCheckImportResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**readable** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryConfigurationDto.md b/mobile/openapi/doc/RepositoryConfigurationDto.md new file mode 100644 index 0000000000000..54fcebd52a816 --- /dev/null +++ b/mobile/openapi/doc/RepositoryConfigurationDto.md @@ -0,0 +1,16 @@ +# openapi.model.RepositoryConfigurationDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**paths** | **List** | | [default to const []] +**retentionPolicy** | [**Optional**](RetentionPolicyDto.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryCreateRequestDto.md b/mobile/openapi/doc/RepositoryCreateRequestDto.md new file mode 100644 index 0000000000000..5cf6dcfee0fa2 --- /dev/null +++ b/mobile/openapi/doc/RepositoryCreateRequestDto.md @@ -0,0 +1,17 @@ +# openapi.model.RepositoryCreateRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | +**paths** | **Optional?>** | | [optional] [default to const []] +**worm** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryCreateResponseDto.md b/mobile/openapi/doc/RepositoryCreateResponseDto.md new file mode 100644 index 0000000000000..98afce9b60ba5 --- /dev/null +++ b/mobile/openapi/doc/RepositoryCreateResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.RepositoryCreateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**repository** | [**LocalRepositoryDto**](LocalRepositoryDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryInspectResponseDto.md b/mobile/openapi/doc/RepositoryInspectResponseDto.md new file mode 100644 index 0000000000000..59405272d19be --- /dev/null +++ b/mobile/openapi/doc/RepositoryInspectResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.RepositoryInspectResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**repositories** | [**List**](InspectedLocalRepositoryDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryListResponseDto.md b/mobile/openapi/doc/RepositoryListResponseDto.md new file mode 100644 index 0000000000000..2f1fb0055610d --- /dev/null +++ b/mobile/openapi/doc/RepositoryListResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.RepositoryListResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**repositories** | [**List**](LocalRepositoryDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryMeterDto.md b/mobile/openapi/doc/RepositoryMeterDto.md new file mode 100644 index 0000000000000..ddadd9277e52a --- /dev/null +++ b/mobile/openapi/doc/RepositoryMeterDto.md @@ -0,0 +1,17 @@ +# openapi.model.RepositoryMeterDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lastUpdated** | **Optional** | | [optional] +**objectCount** | **num** | | +**sizeBytes** | **num** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryMetricsDto.md b/mobile/openapi/doc/RepositoryMetricsDto.md new file mode 100644 index 0000000000000..899c20d822d88 --- /dev/null +++ b/mobile/openapi/doc/RepositoryMetricsDto.md @@ -0,0 +1,18 @@ +# openapi.model.RepositoryMetricsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lastBackup** | **Optional** | | [optional] +**lastBackupDuration** | **Optional** | | [optional] +**lastSuccessfulBackup** | **Optional** | | [optional] +**sizeBytes** | **num** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryPrimaryBackendReconfigureRequestDto.md b/mobile/openapi/doc/RepositoryPrimaryBackendReconfigureRequestDto.md new file mode 100644 index 0000000000000..cdf07d8213a13 --- /dev/null +++ b/mobile/openapi/doc/RepositoryPrimaryBackendReconfigureRequestDto.md @@ -0,0 +1,15 @@ +# openapi.model.RepositoryPrimaryBackendReconfigureRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backendId** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositorySnapshotRestoreFromPointRequestDto.md b/mobile/openapi/doc/RepositorySnapshotRestoreFromPointRequestDto.md new file mode 100644 index 0000000000000..3e087aeb06f8e --- /dev/null +++ b/mobile/openapi/doc/RepositorySnapshotRestoreFromPointRequestDto.md @@ -0,0 +1,16 @@ +# openapi.model.RepositorySnapshotRestoreFromPointRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**include** | **Optional?>** | | [optional] [default to const []] +**yuccaConfig** | **Optional** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositorySnapshotRestoreRequestDto.md b/mobile/openapi/doc/RepositorySnapshotRestoreRequestDto.md new file mode 100644 index 0000000000000..8227104bd44f1 --- /dev/null +++ b/mobile/openapi/doc/RepositorySnapshotRestoreRequestDto.md @@ -0,0 +1,16 @@ +# openapi.model.RepositorySnapshotRestoreRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**include** | **Optional?>** | | [optional] [default to const []] +**target** | **Optional** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryUpdateRequestDto.md b/mobile/openapi/doc/RepositoryUpdateRequestDto.md new file mode 100644 index 0000000000000..98c2da893efc2 --- /dev/null +++ b/mobile/openapi/doc/RepositoryUpdateRequestDto.md @@ -0,0 +1,17 @@ +# openapi.model.RepositoryUpdateRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **Optional** | | [optional] +**paths** | **Optional?>** | | [optional] [default to const []] +**retentionPolicy** | [**Optional**](RetentionPolicyDto.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RepositoryUpdateResponseDto.md b/mobile/openapi/doc/RepositoryUpdateResponseDto.md new file mode 100644 index 0000000000000..daf56becf226f --- /dev/null +++ b/mobile/openapi/doc/RepositoryUpdateResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.RepositoryUpdateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**repository** | [**LocalRepositoryDto**](LocalRepositoryDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RetentionPolicyDto.md b/mobile/openapi/doc/RetentionPolicyDto.md new file mode 100644 index 0000000000000..0b491b66f9698 --- /dev/null +++ b/mobile/openapi/doc/RetentionPolicyDto.md @@ -0,0 +1,21 @@ +# openapi.model.RetentionPolicyDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keepLast** | **Optional** | | [optional] +**keepWithin** | **Optional** | | [optional] +**keepWithinDaily** | **Optional** | | [optional] +**keepWithinHourly** | **Optional** | | [optional] +**keepWithinMonthly** | **Optional** | | [optional] +**keepWithinWeekly** | **Optional** | | [optional] +**keepWithinYearly** | **Optional** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ReverseGeocodingStateResponseDto.md b/mobile/openapi/doc/ReverseGeocodingStateResponseDto.md new file mode 100644 index 0000000000000..f8199b23b850f --- /dev/null +++ b/mobile/openapi/doc/ReverseGeocodingStateResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.ReverseGeocodingStateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lastImportFileName** | **String** | Last import file name | +**lastUpdate** | **String** | Last update timestamp | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RotateParameters.md b/mobile/openapi/doc/RotateParameters.md new file mode 100644 index 0000000000000..08c6c2c9c4d7f --- /dev/null +++ b/mobile/openapi/doc/RotateParameters.md @@ -0,0 +1,15 @@ +# openapi.model.RotateParameters + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**angle** | **num** | Rotation angle in degrees | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunDto.md b/mobile/openapi/doc/RunDto.md new file mode 100644 index 0000000000000..e614918634a6c --- /dev/null +++ b/mobile/openapi/doc/RunDto.md @@ -0,0 +1,21 @@ +# openapi.model.RunDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**end** | **String** | | +**id** | **String** | | +**logFilePath** | **String** | | +**repositoryId** | **String** | | +**start** | **String** | | +**status** | [**RunStatus**](RunStatus.md) | | +**type** | [**RunType**](RunType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunHistoryApi.md b/mobile/openapi/doc/RunHistoryApi.md new file mode 100644 index 0000000000000..64d6bbeb9cb5d --- /dev/null +++ b/mobile/openapi/doc/RunHistoryApi.md @@ -0,0 +1,96 @@ +# openapi.api.RunHistoryApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getRun**](RunHistoryApi.md#getrun) | **GET** /yucca/logs/{id} | +[**logStreamSse**](RunHistoryApi.md#logstreamsse) | **GET** /yucca/logs/{id}/stream | + + +# **getRun** +> RunResponseDto getRun(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RunHistoryApi(); +final id = id_example; // String | + +try { + final result = api_instance.getRun(id); + print(result); +} catch (e) { + print('Exception when calling RunHistoryApi->getRun: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**RunResponseDto**](RunResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **logStreamSse** +> logStreamSse(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RunHistoryApi(); +final id = id_example; // String | + +try { + api_instance.logStreamSse(id); +} catch (e) { + print('Exception when calling RunHistoryApi->logStreamSse: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/RunHistoryResponseDto.md b/mobile/openapi/doc/RunHistoryResponseDto.md new file mode 100644 index 0000000000000..f78eb0db4749d --- /dev/null +++ b/mobile/openapi/doc/RunHistoryResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.RunHistoryResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**runs** | [**List**](RunDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunResponseDto.md b/mobile/openapi/doc/RunResponseDto.md new file mode 100644 index 0000000000000..b5550cbf55b41 --- /dev/null +++ b/mobile/openapi/doc/RunResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.RunResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**run** | [**RunDto**](RunDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunStatus.md b/mobile/openapi/doc/RunStatus.md new file mode 100644 index 0000000000000..55bddb1c4fbf4 --- /dev/null +++ b/mobile/openapi/doc/RunStatus.md @@ -0,0 +1,14 @@ +# openapi.model.RunStatus + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunType.md b/mobile/openapi/doc/RunType.md new file mode 100644 index 0000000000000..7ad4ae8f46a07 --- /dev/null +++ b/mobile/openapi/doc/RunType.md @@ -0,0 +1,14 @@ +# openapi.model.RunType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunningTaskDto.md b/mobile/openapi/doc/RunningTaskDto.md new file mode 100644 index 0000000000000..f42632175f861 --- /dev/null +++ b/mobile/openapi/doc/RunningTaskDto.md @@ -0,0 +1,18 @@ +# openapi.model.RunningTaskDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**logId** | **Optional** | | [optional] +**parentId** | **String** | | +**scheduleStatus** | [**Optional?>**](ActiveScheduleItemDto.md) | | [optional] [default to const []] +**type** | [**TaskType**](TaskType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunningTaskListResponse.md b/mobile/openapi/doc/RunningTaskListResponse.md new file mode 100644 index 0000000000000..d0a47c1ecef28 --- /dev/null +++ b/mobile/openapi/doc/RunningTaskListResponse.md @@ -0,0 +1,15 @@ +# openapi.model.RunningTaskListResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tasks** | [**List**](RunningTaskDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/RunningTasksApi.md b/mobile/openapi/doc/RunningTasksApi.md new file mode 100644 index 0000000000000..7b8e1910233fa --- /dev/null +++ b/mobile/openapi/doc/RunningTasksApi.md @@ -0,0 +1,92 @@ +# openapi.api.RunningTasksApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancelTask**](RunningTasksApi.md#canceltask) | **POST** /yucca/tasks/{parentId}/cancel | +[**getRunningTasks**](RunningTasksApi.md#getrunningtasks) | **GET** /yucca/tasks | + + +# **cancelTask** +> cancelTask(parentId) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RunningTasksApi(); +final parentId = parentId_example; // String | + +try { + api_instance.cancelTask(parentId); +} catch (e) { + print('Exception when calling RunningTasksApi->cancelTask: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **parentId** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getRunningTasks** +> RunningTaskListResponse getRunningTasks() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = RunningTasksApi(); + +try { + final result = api_instance.getRunningTasks(); + print(result); +} catch (e) { + print('Exception when calling RunningTasksApi->getRunningTasks: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**RunningTaskListResponse**](RunningTaskListResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/ScheduleApi.md b/mobile/openapi/doc/ScheduleApi.md new file mode 100644 index 0000000000000..4c8b17e9108f5 --- /dev/null +++ b/mobile/openapi/doc/ScheduleApi.md @@ -0,0 +1,178 @@ +# openapi.api.ScheduleApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createSchedule**](ScheduleApi.md#createschedule) | **POST** /yucca/schedule | +[**getSchedules**](ScheduleApi.md#getschedules) | **GET** /yucca/schedule | +[**removeSchedule**](ScheduleApi.md#removeschedule) | **DELETE** /yucca/schedule/{id} | +[**updateSchedule**](ScheduleApi.md#updateschedule) | **PATCH** /yucca/schedule/{id} | + + +# **createSchedule** +> ScheduleCreateResponseDto createSchedule(scheduleCreateRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ScheduleApi(); +final scheduleCreateRequestDto = ScheduleCreateRequestDto(); // ScheduleCreateRequestDto | + +try { + final result = api_instance.createSchedule(scheduleCreateRequestDto); + print(result); +} catch (e) { + print('Exception when calling ScheduleApi->createSchedule: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **scheduleCreateRequestDto** | [**ScheduleCreateRequestDto**](ScheduleCreateRequestDto.md)| | + +### Return type + +[**ScheduleCreateResponseDto**](ScheduleCreateResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSchedules** +> ScheduleListResponseDto getSchedules() + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ScheduleApi(); + +try { + final result = api_instance.getSchedules(); + print(result); +} catch (e) { + print('Exception when calling ScheduleApi->getSchedules: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ScheduleListResponseDto**](ScheduleListResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeSchedule** +> removeSchedule(id) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ScheduleApi(); +final id = id_example; // String | + +try { + api_instance.removeSchedule(id); +} catch (e) { + print('Exception when calling ScheduleApi->removeSchedule: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateSchedule** +> ScheduleUpdateResponseDto updateSchedule(id, scheduleUpdateRequestDto) + + + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ScheduleApi(); +final id = id_example; // String | +final scheduleUpdateRequestDto = ScheduleUpdateRequestDto(); // ScheduleUpdateRequestDto | + +try { + final result = api_instance.updateSchedule(id, scheduleUpdateRequestDto); + print(result); +} catch (e) { + print('Exception when calling ScheduleApi->updateSchedule: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **scheduleUpdateRequestDto** | [**ScheduleUpdateRequestDto**](ScheduleUpdateRequestDto.md)| | + +### Return type + +[**ScheduleUpdateResponseDto**](ScheduleUpdateResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/ScheduleCreateRequestDto.md b/mobile/openapi/doc/ScheduleCreateRequestDto.md new file mode 100644 index 0000000000000..20384c1dd592c --- /dev/null +++ b/mobile/openapi/doc/ScheduleCreateRequestDto.md @@ -0,0 +1,17 @@ +# openapi.model.ScheduleCreateRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cron** | **String** | | +**name** | **String** | | +**repositories** | **List** | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ScheduleCreateResponseDto.md b/mobile/openapi/doc/ScheduleCreateResponseDto.md new file mode 100644 index 0000000000000..bb120366a9d45 --- /dev/null +++ b/mobile/openapi/doc/ScheduleCreateResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.ScheduleCreateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schedule** | [**ScheduleDto**](ScheduleDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ScheduleDto.md b/mobile/openapi/doc/ScheduleDto.md new file mode 100644 index 0000000000000..a44d8250d7fa5 --- /dev/null +++ b/mobile/openapi/doc/ScheduleDto.md @@ -0,0 +1,21 @@ +# openapi.model.ScheduleDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cron** | **String** | | +**id** | **String** | | +**lastFinished** | **Optional** | | [optional] +**lastRun** | **Optional** | | [optional] +**name** | **String** | | +**paused** | **bool** | | +**repositories** | **List** | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ScheduleListResponseDto.md b/mobile/openapi/doc/ScheduleListResponseDto.md new file mode 100644 index 0000000000000..09b68d7a7838f --- /dev/null +++ b/mobile/openapi/doc/ScheduleListResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.ScheduleListResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schedules** | [**List**](ScheduleDto.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ScheduleUpdateRequestDto.md b/mobile/openapi/doc/ScheduleUpdateRequestDto.md new file mode 100644 index 0000000000000..54a1e67aaadfc --- /dev/null +++ b/mobile/openapi/doc/ScheduleUpdateRequestDto.md @@ -0,0 +1,18 @@ +# openapi.model.ScheduleUpdateRequestDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cron** | **Optional** | | [optional] +**name** | **Optional** | | [optional] +**paused** | **Optional** | | [optional] +**repositories** | **Optional?>** | | [optional] [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ScheduleUpdateResponseDto.md b/mobile/openapi/doc/ScheduleUpdateResponseDto.md new file mode 100644 index 0000000000000..d44d5d45dca24 --- /dev/null +++ b/mobile/openapi/doc/ScheduleUpdateResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.ScheduleUpdateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**schedule** | [**ScheduleDto**](ScheduleDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchAlbumResponseDto.md b/mobile/openapi/doc/SearchAlbumResponseDto.md new file mode 100644 index 0000000000000..a8d7aca3f0243 --- /dev/null +++ b/mobile/openapi/doc/SearchAlbumResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.SearchAlbumResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Number of albums in this page | +**facets** | [**List**](SearchFacetResponseDto.md) | | [default to const []] +**items** | [**List**](AlbumResponseDto.md) | | [default to const []] +**total** | **int** | Total number of matching albums | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchApi.md b/mobile/openapi/doc/SearchApi.md new file mode 100644 index 0000000000000..7373b0c14df64 --- /dev/null +++ b/mobile/openapi/doc/SearchApi.md @@ -0,0 +1,663 @@ +# openapi.api.SearchApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAssetsByCity**](SearchApi.md#getassetsbycity) | **GET** /search/cities | Retrieve assets by city +[**getExploreData**](SearchApi.md#getexploredata) | **GET** /search/explore | Retrieve explore data +[**getSearchSuggestions**](SearchApi.md#getsearchsuggestions) | **GET** /search/suggestions | Retrieve search suggestions +[**searchAssetStatistics**](SearchApi.md#searchassetstatistics) | **POST** /search/statistics | Search asset statistics +[**searchAssets**](SearchApi.md#searchassets) | **POST** /search/metadata | Search assets by metadata +[**searchLargeAssets**](SearchApi.md#searchlargeassets) | **POST** /search/large-assets | Search large assets +[**searchPerson**](SearchApi.md#searchperson) | **GET** /search/person | Search people +[**searchPlaces**](SearchApi.md#searchplaces) | **GET** /search/places | Search places +[**searchRandom**](SearchApi.md#searchrandom) | **POST** /search/random | Search random assets +[**searchSmart**](SearchApi.md#searchsmart) | **POST** /search/smart | Smart asset search + + +# **getAssetsByCity** +> List getAssetsByCity() + +Retrieve assets by city + +Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); + +try { + final result = api_instance.getAssetsByCity(); + print(result); +} catch (e) { + print('Exception when calling SearchApi->getAssetsByCity: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](AssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getExploreData** +> List getExploreData() + +Retrieve explore data + +Retrieve data for the explore section, such as popular people and places. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); + +try { + final result = api_instance.getExploreData(); + print(result); +} catch (e) { + print('Exception when calling SearchApi->getExploreData: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](SearchExploreResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSearchSuggestions** +> List getSearchSuggestions(type, country, includeNull, lensModel, make, model, state) + +Retrieve search suggestions + +Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final type = ; // SearchSuggestionType | +final country = country_example; // String | Filter by country +final includeNull = true; // bool | Include null values in suggestions +final lensModel = lensModel_example; // String | Filter by lens model +final make = make_example; // String | Filter by camera make +final model = model_example; // String | Filter by camera model +final state = state_example; // String | Filter by state/province + +try { + final result = api_instance.getSearchSuggestions(type, country, includeNull, lensModel, make, model, state); + print(result); +} catch (e) { + print('Exception when calling SearchApi->getSearchSuggestions: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **type** | [**SearchSuggestionType**](.md)| | + **country** | **String**| Filter by country | [optional] + **includeNull** | **bool**| Include null values in suggestions | [optional] + **lensModel** | **String**| Filter by lens model | [optional] + **make** | **String**| Filter by camera make | [optional] + **model** | **String**| Filter by camera model | [optional] + **state** | **String**| Filter by state/province | [optional] + +### Return type + +**List** + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchAssetStatistics** +> SearchStatisticsResponseDto searchAssetStatistics(statisticsSearchDto) + +Search asset statistics + +Retrieve statistical data about assets based on search criteria, such as the total matching count. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final statisticsSearchDto = StatisticsSearchDto(); // StatisticsSearchDto | + +try { + final result = api_instance.searchAssetStatistics(statisticsSearchDto); + print(result); +} catch (e) { + print('Exception when calling SearchApi->searchAssetStatistics: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **statisticsSearchDto** | [**StatisticsSearchDto**](StatisticsSearchDto.md)| | + +### Return type + +[**SearchStatisticsResponseDto**](SearchStatisticsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchAssets** +> SearchResponseDto searchAssets(metadataSearchDto, key, slug) + +Search assets by metadata + +Search for assets based on various metadata criteria. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final metadataSearchDto = MetadataSearchDto(); // MetadataSearchDto | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.searchAssets(metadataSearchDto, key, slug); + print(result); +} catch (e) { + print('Exception when calling SearchApi->searchAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **metadataSearchDto** | [**MetadataSearchDto**](MetadataSearchDto.md)| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**SearchResponseDto**](SearchResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchLargeAssets** +> List searchLargeAssets(albumIds, city, country, createdAfter, createdBefore, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, ocr, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, type, updatedAfter, updatedBefore, visibility, withDeleted, withExif) + +Search large assets + +Search for assets that are considered large based on specified criteria. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final albumIds = []; // List | Filter by album IDs +final city = city_example; // String | Filter by city name +final country = country_example; // String | Filter by country name +final createdAfter = 2024-01-01T00:00Z; // DateTime | Filter by creation date (after) +final createdBefore = 2024-01-01T00:00Z; // DateTime | Filter by creation date (before) +final isEncoded = true; // bool | Filter by encoded status +final isFavorite = true; // bool | Filter by favorite status +final isMotion = true; // bool | Filter by motion photo status +final isNotInAlbum = true; // bool | Filter assets not in any album +final isOffline = true; // bool | Filter by offline status +final lensModel = lensModel_example; // String | Filter by lens model +final libraryId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Library ID to filter by +final make = make_example; // String | Filter by camera make +final minFileSize = 56; // int | Minimum file size in bytes +final model = model_example; // String | Filter by camera model +final ocr = ocr_example; // String | Filter by OCR text content +final personIds = []; // List | Filter by person IDs +final rating = 56; // int | Filter by rating [1-5], or null for unrated +final size = 56; // int | Number of results to return +final state = state_example; // String | Filter by state/province name +final tagIds = []; // List | Filter by tag IDs +final takenAfter = 2024-01-01T00:00Z; // DateTime | Filter by taken date (after) +final takenBefore = 2024-01-01T00:00Z; // DateTime | Filter by taken date (before) +final trashedAfter = 2024-01-01T00:00Z; // DateTime | Filter by trash date (after) +final trashedBefore = 2024-01-01T00:00Z; // DateTime | Filter by trash date (before) +final type = ; // AssetTypeEnum | +final updatedAfter = 2024-01-01T00:00Z; // DateTime | Filter by update date (after) +final updatedBefore = 2024-01-01T00:00Z; // DateTime | Filter by update date (before) +final visibility = ; // AssetVisibility | +final withDeleted = true; // bool | Include deleted assets +final withExif = true; // bool | Include EXIF data in response + +try { + final result = api_instance.searchLargeAssets(albumIds, city, country, createdAfter, createdBefore, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, ocr, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, type, updatedAfter, updatedBefore, visibility, withDeleted, withExif); + print(result); +} catch (e) { + print('Exception when calling SearchApi->searchLargeAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **albumIds** | [**List**](String.md)| Filter by album IDs | [optional] [default to const []] + **city** | **String**| Filter by city name | [optional] + **country** | **String**| Filter by country name | [optional] + **createdAfter** | **DateTime**| Filter by creation date (after) | [optional] + **createdBefore** | **DateTime**| Filter by creation date (before) | [optional] + **isEncoded** | **bool**| Filter by encoded status | [optional] + **isFavorite** | **bool**| Filter by favorite status | [optional] + **isMotion** | **bool**| Filter by motion photo status | [optional] + **isNotInAlbum** | **bool**| Filter assets not in any album | [optional] + **isOffline** | **bool**| Filter by offline status | [optional] + **lensModel** | **String**| Filter by lens model | [optional] + **libraryId** | **String**| Library ID to filter by | [optional] + **make** | **String**| Filter by camera make | [optional] + **minFileSize** | **int**| Minimum file size in bytes | [optional] + **model** | **String**| Filter by camera model | [optional] + **ocr** | **String**| Filter by OCR text content | [optional] + **personIds** | [**List**](String.md)| Filter by person IDs | [optional] [default to const []] + **rating** | **int**| Filter by rating [1-5], or null for unrated | [optional] + **size** | **int**| Number of results to return | [optional] + **state** | **String**| Filter by state/province name | [optional] + **tagIds** | [**List**](String.md)| Filter by tag IDs | [optional] [default to const []] + **takenAfter** | **DateTime**| Filter by taken date (after) | [optional] + **takenBefore** | **DateTime**| Filter by taken date (before) | [optional] + **trashedAfter** | **DateTime**| Filter by trash date (after) | [optional] + **trashedBefore** | **DateTime**| Filter by trash date (before) | [optional] + **type** | [**AssetTypeEnum**](.md)| | [optional] + **updatedAfter** | **DateTime**| Filter by update date (after) | [optional] + **updatedBefore** | **DateTime**| Filter by update date (before) | [optional] + **visibility** | [**AssetVisibility**](.md)| | [optional] + **withDeleted** | **bool**| Include deleted assets | [optional] + **withExif** | **bool**| Include EXIF data in response | [optional] + +### Return type + +[**List**](AssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchPerson** +> List searchPerson(name, withHidden) + +Search people + +Search for people by name. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final name = name_example; // String | Person name to search for +final withHidden = true; // bool | Include hidden people + +try { + final result = api_instance.searchPerson(name, withHidden); + print(result); +} catch (e) { + print('Exception when calling SearchApi->searchPerson: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **String**| Person name to search for | + **withHidden** | **bool**| Include hidden people | [optional] + +### Return type + +[**List**](PersonResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchPlaces** +> List searchPlaces(name) + +Search places + +Search for places by name. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final name = name_example; // String | Place name to search for + +try { + final result = api_instance.searchPlaces(name); + print(result); +} catch (e) { + print('Exception when calling SearchApi->searchPlaces: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **name** | **String**| Place name to search for | + +### Return type + +[**List**](PlacesResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchRandom** +> List searchRandom(randomSearchDto) + +Search random assets + +Retrieve a random selection of assets based on the provided criteria. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final randomSearchDto = RandomSearchDto(); // RandomSearchDto | + +try { + final result = api_instance.searchRandom(randomSearchDto); + print(result); +} catch (e) { + print('Exception when calling SearchApi->searchRandom: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **randomSearchDto** | [**RandomSearchDto**](RandomSearchDto.md)| | + +### Return type + +[**List**](AssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchSmart** +> SearchResponseDto searchSmart(smartSearchDto) + +Smart asset search + +Perform a smart search for assets by using machine learning vectors to determine relevance. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SearchApi(); +final smartSearchDto = SmartSearchDto(); // SmartSearchDto | + +try { + final result = api_instance.searchSmart(smartSearchDto); + print(result); +} catch (e) { + print('Exception when calling SearchApi->searchSmart: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **smartSearchDto** | [**SmartSearchDto**](SmartSearchDto.md)| | + +### Return type + +[**SearchResponseDto**](SearchResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/SearchAssetResponseDto.md b/mobile/openapi/doc/SearchAssetResponseDto.md new file mode 100644 index 0000000000000..baa26a251b8d7 --- /dev/null +++ b/mobile/openapi/doc/SearchAssetResponseDto.md @@ -0,0 +1,19 @@ +# openapi.model.SearchAssetResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Number of assets in this page | +**facets** | [**List**](SearchFacetResponseDto.md) | | [default to const []] +**items** | [**List**](AssetResponseDto.md) | | [default to const []] +**nextPage** | **String** | Next page token | +**total** | **int** | Total number of matching assets | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchExploreItem.md b/mobile/openapi/doc/SearchExploreItem.md new file mode 100644 index 0000000000000..0bc674c9851f1 --- /dev/null +++ b/mobile/openapi/doc/SearchExploreItem.md @@ -0,0 +1,16 @@ +# openapi.model.SearchExploreItem + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**AssetResponseDto**](AssetResponseDto.md) | | +**value** | **String** | Explore value | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchExploreResponseDto.md b/mobile/openapi/doc/SearchExploreResponseDto.md new file mode 100644 index 0000000000000..4efd3280c1c73 --- /dev/null +++ b/mobile/openapi/doc/SearchExploreResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.SearchExploreResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fieldName** | **String** | Explore field name | +**items** | [**List**](SearchExploreItem.md) | | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchFacetCountResponseDto.md b/mobile/openapi/doc/SearchFacetCountResponseDto.md new file mode 100644 index 0000000000000..b4dbb1753701f --- /dev/null +++ b/mobile/openapi/doc/SearchFacetCountResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.SearchFacetCountResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Number of assets with this facet value | +**value** | **String** | Facet value | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchFacetResponseDto.md b/mobile/openapi/doc/SearchFacetResponseDto.md new file mode 100644 index 0000000000000..182a807ce8d74 --- /dev/null +++ b/mobile/openapi/doc/SearchFacetResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.SearchFacetResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**counts** | [**List**](SearchFacetCountResponseDto.md) | | [default to const []] +**fieldName** | **String** | Facet field name | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchResponseDto.md b/mobile/openapi/doc/SearchResponseDto.md new file mode 100644 index 0000000000000..3b8ce07fdd4bd --- /dev/null +++ b/mobile/openapi/doc/SearchResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.SearchResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albums** | [**SearchAlbumResponseDto**](SearchAlbumResponseDto.md) | | +**assets** | [**SearchAssetResponseDto**](SearchAssetResponseDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchStatisticsResponseDto.md b/mobile/openapi/doc/SearchStatisticsResponseDto.md new file mode 100644 index 0000000000000..c4c79f1eb8379 --- /dev/null +++ b/mobile/openapi/doc/SearchStatisticsResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.SearchStatisticsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **int** | Total number of matching assets | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SearchSuggestionType.md b/mobile/openapi/doc/SearchSuggestionType.md new file mode 100644 index 0000000000000..e37b3f0de5df2 --- /dev/null +++ b/mobile/openapi/doc/SearchSuggestionType.md @@ -0,0 +1,14 @@ +# openapi.model.SearchSuggestionType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerAboutResponseDto.md b/mobile/openapi/doc/ServerAboutResponseDto.md new file mode 100644 index 0000000000000..d6b893f5cb42b --- /dev/null +++ b/mobile/openapi/doc/ServerAboutResponseDto.md @@ -0,0 +1,35 @@ +# openapi.model.ServerAboutResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**build** | **Optional** | Build identifier | [optional] +**buildImage** | **Optional** | Build image name | [optional] +**buildImageUrl** | **Optional** | Build image URL | [optional] +**buildUrl** | **Optional** | Build URL | [optional] +**exiftool** | **Optional** | ExifTool version | [optional] +**ffmpeg** | **Optional** | FFmpeg version | [optional] +**imagemagick** | **Optional** | ImageMagick version | [optional] +**libvips** | **Optional** | libvips version | [optional] +**licensed** | **bool** | Whether the server is licensed | +**nodejs** | **Optional** | Node.js version | [optional] +**repository** | **Optional** | Repository name | [optional] +**repositoryUrl** | **Optional** | Repository URL | [optional] +**sourceCommit** | **Optional** | Source commit hash | [optional] +**sourceRef** | **Optional** | Source reference (branch/tag) | [optional] +**sourceUrl** | **Optional** | Source URL | [optional] +**thirdPartyBugFeatureUrl** | **Optional** | Third-party bug/feature URL | [optional] +**thirdPartyDocumentationUrl** | **Optional** | Third-party documentation URL | [optional] +**thirdPartySourceUrl** | **Optional** | Third-party source URL | [optional] +**thirdPartySupportUrl** | **Optional** | Third-party support URL | [optional] +**version** | **String** | Server version | +**versionUrl** | **String** | URL to version information | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerApi.md b/mobile/openapi/doc/ServerApi.md new file mode 100644 index 0000000000000..ae18519da1679 --- /dev/null +++ b/mobile/openapi/doc/ServerApi.md @@ -0,0 +1,688 @@ +# openapi.api.ServerApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteServerLicense**](ServerApi.md#deleteserverlicense) | **DELETE** /server/license | Delete server product key +[**getAboutInfo**](ServerApi.md#getaboutinfo) | **GET** /server/about | Get server information +[**getApkLinks**](ServerApi.md#getapklinks) | **GET** /server/apk-links | Get APK links +[**getServerConfig**](ServerApi.md#getserverconfig) | **GET** /server/config | Get config +[**getServerFeatures**](ServerApi.md#getserverfeatures) | **GET** /server/features | Get features +[**getServerLicense**](ServerApi.md#getserverlicense) | **GET** /server/license | Get product key +[**getServerStatistics**](ServerApi.md#getserverstatistics) | **GET** /server/statistics | Get statistics +[**getServerVersion**](ServerApi.md#getserverversion) | **GET** /server/version | Get server version +[**getStorage**](ServerApi.md#getstorage) | **GET** /server/storage | Get storage +[**getSupportedMediaTypes**](ServerApi.md#getsupportedmediatypes) | **GET** /server/media-types | Get supported media types +[**getVersionCheck**](ServerApi.md#getversioncheck) | **GET** /server/version-check | Get version check status +[**getVersionHistory**](ServerApi.md#getversionhistory) | **GET** /server/version-history | Get version history +[**pingServer**](ServerApi.md#pingserver) | **GET** /server/ping | Ping +[**setServerLicense**](ServerApi.md#setserverlicense) | **PUT** /server/license | Set server product key + + +# **deleteServerLicense** +> deleteServerLicense() + +Delete server product key + +Delete the currently set server product key. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); + +try { + api_instance.deleteServerLicense(); +} catch (e) { + print('Exception when calling ServerApi->deleteServerLicense: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAboutInfo** +> ServerAboutResponseDto getAboutInfo() + +Get server information + +Retrieve a list of information about the server. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); + +try { + final result = api_instance.getAboutInfo(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getAboutInfo: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerAboutResponseDto**](ServerAboutResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getApkLinks** +> ServerApkLinksDto getApkLinks() + +Get APK links + +Retrieve links to the APKs for the current server version. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); + +try { + final result = api_instance.getApkLinks(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getApkLinks: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerApkLinksDto**](ServerApkLinksDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getServerConfig** +> ServerConfigDto getServerConfig() + +Get config + +Retrieve the current server configuration. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ServerApi(); + +try { + final result = api_instance.getServerConfig(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getServerConfig: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerConfigDto**](ServerConfigDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getServerFeatures** +> ServerFeaturesDto getServerFeatures() + +Get features + +Retrieve available features supported by this server. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ServerApi(); + +try { + final result = api_instance.getServerFeatures(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getServerFeatures: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerFeaturesDto**](ServerFeaturesDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getServerLicense** +> UserLicense getServerLicense() + +Get product key + +Retrieve information about whether the server currently has a product key registered. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); + +try { + final result = api_instance.getServerLicense(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getServerLicense: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UserLicense**](UserLicense.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getServerStatistics** +> ServerStatsResponseDto getServerStatistics() + +Get statistics + +Retrieve statistics about the entire Immich instance such as asset counts. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); + +try { + final result = api_instance.getServerStatistics(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getServerStatistics: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerStatsResponseDto**](ServerStatsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getServerVersion** +> ServerVersionResponseDto getServerVersion() + +Get server version + +Retrieve the current server version in semantic versioning (semver) format. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ServerApi(); + +try { + final result = api_instance.getServerVersion(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getServerVersion: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerVersionResponseDto**](ServerVersionResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getStorage** +> ServerStorageResponseDto getStorage() + +Get storage + +Retrieve the current storage utilization information of the server. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); + +try { + final result = api_instance.getStorage(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getStorage: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerStorageResponseDto**](ServerStorageResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSupportedMediaTypes** +> ServerMediaTypesResponseDto getSupportedMediaTypes() + +Get supported media types + +Retrieve all media types supported by the server. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ServerApi(); + +try { + final result = api_instance.getSupportedMediaTypes(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getSupportedMediaTypes: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerMediaTypesResponseDto**](ServerMediaTypesResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getVersionCheck** +> VersionCheckStateResponseDto getVersionCheck() + +Get version check status + +Retrieve information about the last time the version check ran. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); + +try { + final result = api_instance.getVersionCheck(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getVersionCheck: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**VersionCheckStateResponseDto**](VersionCheckStateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getVersionHistory** +> List getVersionHistory() + +Get version history + +Retrieve a list of past versions the server has been on. + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ServerApi(); + +try { + final result = api_instance.getVersionHistory(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->getVersionHistory: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](ServerVersionHistoryResponseDto.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pingServer** +> ServerPingResponse pingServer() + +Ping + +Pong + +### Example +```dart +import 'package:openapi/api.dart'; + +final api_instance = ServerApi(); + +try { + final result = api_instance.pingServer(); + print(result); +} catch (e) { + print('Exception when calling ServerApi->pingServer: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ServerPingResponse**](ServerPingResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setServerLicense** +> UserLicense setServerLicense(licenseKeyDto) + +Set server product key + +Validate and set the server product key if successful. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ServerApi(); +final licenseKeyDto = LicenseKeyDto(); // LicenseKeyDto | + +try { + final result = api_instance.setServerLicense(licenseKeyDto); + print(result); +} catch (e) { + print('Exception when calling ServerApi->setServerLicense: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **licenseKeyDto** | [**LicenseKeyDto**](LicenseKeyDto.md)| | + +### Return type + +[**UserLicense**](UserLicense.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/ServerApkLinksDto.md b/mobile/openapi/doc/ServerApkLinksDto.md new file mode 100644 index 0000000000000..436d659e320e2 --- /dev/null +++ b/mobile/openapi/doc/ServerApkLinksDto.md @@ -0,0 +1,18 @@ +# openapi.model.ServerApkLinksDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**arm64v8a** | **String** | APK download link for ARM64 v8a architecture | +**armeabiv7a** | **String** | APK download link for ARM EABI v7a architecture | +**universal** | **String** | APK download link for universal architecture | +**x8664** | **String** | APK download link for x86_64 architecture | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerConfigDto.md b/mobile/openapi/doc/ServerConfigDto.md new file mode 100644 index 0000000000000..00eeadc948e7c --- /dev/null +++ b/mobile/openapi/doc/ServerConfigDto.md @@ -0,0 +1,26 @@ +# openapi.model.ServerConfigDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**externalDomain** | **String** | External domain URL | +**isInitialized** | **bool** | Whether the server has been initialized | +**isOnboarded** | **bool** | Whether the admin has completed onboarding | +**loginPageMessage** | **String** | Login page message | +**maintenanceMode** | **bool** | Whether maintenance mode is active | +**mapDarkStyleUrl** | **String** | Map dark style URL | +**mapLightStyleUrl** | **String** | Map light style URL | +**minFaces** | **int** | People min faces server default | +**oauthButtonText** | **String** | OAuth button text | +**publicUsers** | **bool** | Whether public user registration is enabled | +**trashDays** | **int** | Number of days before trashed assets are permanently deleted | +**userDeleteDelay** | **int** | Delay in days before deleted users are permanently removed | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerFeaturesDto.md b/mobile/openapi/doc/ServerFeaturesDto.md new file mode 100644 index 0000000000000..37a8920b1541b --- /dev/null +++ b/mobile/openapi/doc/ServerFeaturesDto.md @@ -0,0 +1,31 @@ +# openapi.model.ServerFeaturesDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backups** | **bool** | Whether the backups feature is enabled | +**configFile** | **bool** | Whether config file is available | +**duplicateDetection** | **bool** | Whether duplicate detection is enabled | +**email** | **bool** | Whether email notifications are enabled | +**facialRecognition** | **bool** | Whether facial recognition is enabled | +**importFaces** | **bool** | Whether face import is enabled | +**map** | **bool** | Whether map feature is enabled | +**oauth** | **bool** | Whether OAuth is enabled | +**oauthAutoLaunch** | **bool** | Whether OAuth auto-launch is enabled | +**ocr** | **bool** | Whether OCR is enabled | +**passwordLogin** | **bool** | Whether password login is enabled | +**realtimeTranscoding** | **bool** | Whether real-time transcoding is enabled | +**reverseGeocoding** | **bool** | Whether reverse geocoding is enabled | +**search** | **bool** | Whether search is enabled | +**sidecar** | **bool** | Whether sidecar files are supported | +**smartSearch** | **bool** | Whether smart search is enabled | +**trash** | **bool** | Whether trash feature is enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerMediaTypesResponseDto.md b/mobile/openapi/doc/ServerMediaTypesResponseDto.md new file mode 100644 index 0000000000000..dc46df8e0cdf7 --- /dev/null +++ b/mobile/openapi/doc/ServerMediaTypesResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.ServerMediaTypesResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image** | **List** | Supported image MIME types | [default to const []] +**sidecar** | **List** | Supported sidecar MIME types | [default to const []] +**video** | **List** | Supported video MIME types | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerPingResponse.md b/mobile/openapi/doc/ServerPingResponse.md new file mode 100644 index 0000000000000..f5a15128e92f5 --- /dev/null +++ b/mobile/openapi/doc/ServerPingResponse.md @@ -0,0 +1,15 @@ +# openapi.model.ServerPingResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**res** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerStatsResponseDto.md b/mobile/openapi/doc/ServerStatsResponseDto.md new file mode 100644 index 0000000000000..d0269f1bcd644 --- /dev/null +++ b/mobile/openapi/doc/ServerStatsResponseDto.md @@ -0,0 +1,20 @@ +# openapi.model.ServerStatsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**photos** | **int** | Total number of photos | +**usage** | **int** | Total storage usage in bytes | +**usageByUser** | [**List**](UsageByUserDto.md) | Array of usage for each user | [default to const []] +**usagePhotos** | **int** | Storage usage for photos in bytes | +**usageVideos** | **int** | Storage usage for videos in bytes | +**videos** | **int** | Total number of videos | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerStorageResponseDto.md b/mobile/openapi/doc/ServerStorageResponseDto.md new file mode 100644 index 0000000000000..58d200828f2dc --- /dev/null +++ b/mobile/openapi/doc/ServerStorageResponseDto.md @@ -0,0 +1,21 @@ +# openapi.model.ServerStorageResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**diskAvailable** | **String** | Available disk space (human-readable format) | +**diskAvailableRaw** | **int** | Available disk space in bytes | +**diskSize** | **String** | Total disk size (human-readable format) | +**diskSizeRaw** | **int** | Total disk size in bytes | +**diskUsagePercentage** | **double** | Disk usage percentage (0-100) | +**diskUse** | **String** | Used disk space (human-readable format) | +**diskUseRaw** | **int** | Used disk space in bytes | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerVersionHistoryResponseDto.md b/mobile/openapi/doc/ServerVersionHistoryResponseDto.md new file mode 100644 index 0000000000000..9e9813ba345ca --- /dev/null +++ b/mobile/openapi/doc/ServerVersionHistoryResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.ServerVersionHistoryResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | [**DateTime**](DateTime.md) | When this version was first seen | +**id** | **String** | Version history entry ID | +**version** | **String** | Version string | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ServerVersionResponseDto.md b/mobile/openapi/doc/ServerVersionResponseDto.md new file mode 100644 index 0000000000000..539a415980fa3 --- /dev/null +++ b/mobile/openapi/doc/ServerVersionResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.ServerVersionResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**major** | **int** | Major version number | +**minor** | **int** | Minor version number | +**patch_** | **int** | Patch version number | +**prerelease** | **int** | Pre-release version number | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SessionCreateDto.md b/mobile/openapi/doc/SessionCreateDto.md new file mode 100644 index 0000000000000..9c94761874d55 --- /dev/null +++ b/mobile/openapi/doc/SessionCreateDto.md @@ -0,0 +1,17 @@ +# openapi.model.SessionCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deviceOS** | **Optional** | Device OS | [optional] +**deviceType** | **Optional** | Device type | [optional] +**duration** | **Optional** | Session duration in seconds | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SessionCreateResponseDto.md b/mobile/openapi/doc/SessionCreateResponseDto.md new file mode 100644 index 0000000000000..83789bdc6d171 --- /dev/null +++ b/mobile/openapi/doc/SessionCreateResponseDto.md @@ -0,0 +1,24 @@ +# openapi.model.SessionCreateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**appVersion** | **String** | App version | +**createdAt** | **String** | Creation date | +**current** | **bool** | Is current session | +**deviceOS** | **String** | Device OS | +**deviceType** | **String** | Device type | +**expiresAt** | **Optional** | Expiration date | [optional] +**id** | **String** | Session ID | +**isPendingSyncReset** | **bool** | Is pending sync reset | +**token** | **String** | Session token | +**updatedAt** | **String** | Last update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SessionResponseDto.md b/mobile/openapi/doc/SessionResponseDto.md new file mode 100644 index 0000000000000..d8ced8b458ae9 --- /dev/null +++ b/mobile/openapi/doc/SessionResponseDto.md @@ -0,0 +1,23 @@ +# openapi.model.SessionResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**appVersion** | **String** | App version | +**createdAt** | **String** | Creation date | +**current** | **bool** | Is current session | +**deviceOS** | **String** | Device OS | +**deviceType** | **String** | Device type | +**expiresAt** | **Optional** | Expiration date | [optional] +**id** | **String** | Session ID | +**isPendingSyncReset** | **bool** | Is pending sync reset | +**updatedAt** | **String** | Last update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SessionUnlockDto.md b/mobile/openapi/doc/SessionUnlockDto.md new file mode 100644 index 0000000000000..19340ad7910ff --- /dev/null +++ b/mobile/openapi/doc/SessionUnlockDto.md @@ -0,0 +1,16 @@ +# openapi.model.SessionUnlockDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **Optional** | User password (required if PIN code is not provided) | [optional] +**pinCode** | **Optional** | New PIN code (4-6 digits) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SessionUpdateDto.md b/mobile/openapi/doc/SessionUpdateDto.md new file mode 100644 index 0000000000000..edbcdf25e4413 --- /dev/null +++ b/mobile/openapi/doc/SessionUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.SessionUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isPendingSyncReset** | **Optional** | Reset pending sync state | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SessionsApi.md b/mobile/openapi/doc/SessionsApi.md new file mode 100644 index 0000000000000..75c037ebf9ee6 --- /dev/null +++ b/mobile/openapi/doc/SessionsApi.md @@ -0,0 +1,352 @@ +# openapi.api.SessionsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createSession**](SessionsApi.md#createsession) | **POST** /sessions | Create a session +[**deleteAllSessions**](SessionsApi.md#deleteallsessions) | **DELETE** /sessions | Delete all sessions +[**deleteSession**](SessionsApi.md#deletesession) | **DELETE** /sessions/{id} | Delete a session +[**getSessions**](SessionsApi.md#getsessions) | **GET** /sessions | Retrieve sessions +[**lockSession**](SessionsApi.md#locksession) | **POST** /sessions/{id}/lock | Lock a session +[**updateSession**](SessionsApi.md#updatesession) | **PUT** /sessions/{id} | Update a session + + +# **createSession** +> SessionCreateResponseDto createSession(sessionCreateDto) + +Create a session + +Create a session as a child to the current session. This endpoint is used for casting. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SessionsApi(); +final sessionCreateDto = SessionCreateDto(); // SessionCreateDto | + +try { + final result = api_instance.createSession(sessionCreateDto); + print(result); +} catch (e) { + print('Exception when calling SessionsApi->createSession: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sessionCreateDto** | [**SessionCreateDto**](SessionCreateDto.md)| | + +### Return type + +[**SessionCreateResponseDto**](SessionCreateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteAllSessions** +> deleteAllSessions() + +Delete all sessions + +Delete all sessions for the user. This will not delete the current session. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SessionsApi(); + +try { + api_instance.deleteAllSessions(); +} catch (e) { + print('Exception when calling SessionsApi->deleteAllSessions: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteSession** +> deleteSession(id) + +Delete a session + +Delete a specific session by id. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SessionsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteSession(id); +} catch (e) { + print('Exception when calling SessionsApi->deleteSession: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSessions** +> List getSessions() + +Retrieve sessions + +Retrieve a list of sessions for the user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SessionsApi(); + +try { + final result = api_instance.getSessions(); + print(result); +} catch (e) { + print('Exception when calling SessionsApi->getSessions: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](SessionResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **lockSession** +> lockSession(id) + +Lock a session + +Lock a specific session by id. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SessionsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.lockSession(id); +} catch (e) { + print('Exception when calling SessionsApi->lockSession: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateSession** +> SessionResponseDto updateSession(id, sessionUpdateDto) + +Update a session + +Update a specific session identified by id. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SessionsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final sessionUpdateDto = SessionUpdateDto(); // SessionUpdateDto | + +try { + final result = api_instance.updateSession(id, sessionUpdateDto); + print(result); +} catch (e) { + print('Exception when calling SessionsApi->updateSession: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **sessionUpdateDto** | [**SessionUpdateDto**](SessionUpdateDto.md)| | + +### Return type + +[**SessionResponseDto**](SessionResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/SetMaintenanceModeDto.md b/mobile/openapi/doc/SetMaintenanceModeDto.md new file mode 100644 index 0000000000000..912f5e861c784 --- /dev/null +++ b/mobile/openapi/doc/SetMaintenanceModeDto.md @@ -0,0 +1,18 @@ +# openapi.model.SetMaintenanceModeDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**MaintenanceAction**](MaintenanceAction.md) | | +**restoreBackupFilename** | **Optional** | Restore backup filename | [optional] +**rollbackRepositoryId** | **Optional** | Rollback repository ID | [optional] +**rollbackSnapshotId** | **Optional** | Rollback snapshot ID | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SharedLinkCreateDto.md b/mobile/openapi/doc/SharedLinkCreateDto.md new file mode 100644 index 0000000000000..0cb127b25f5df --- /dev/null +++ b/mobile/openapi/doc/SharedLinkCreateDto.md @@ -0,0 +1,24 @@ +# openapi.model.SharedLinkCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **Optional** | Album ID (for album sharing) | [optional] +**allowDownload** | **Optional** | Allow downloads | [optional] [default to true] +**allowUpload** | **Optional** | Allow uploads | [optional] +**assetIds** | **Optional?>** | Asset IDs (for individual assets) | [optional] [default to const []] +**description** | **Optional** | Link description | [optional] +**expiresAt** | [**Optional**](DateTime.md) | Expiration date | [optional] +**password** | **Optional** | Link password | [optional] +**showMetadata** | **Optional** | Show metadata | [optional] [default to true] +**slug** | **Optional** | Custom URL slug | [optional] +**type** | [**SharedLinkType**](SharedLinkType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SharedLinkEditDto.md b/mobile/openapi/doc/SharedLinkEditDto.md new file mode 100644 index 0000000000000..3f5ddab2f7e2b --- /dev/null +++ b/mobile/openapi/doc/SharedLinkEditDto.md @@ -0,0 +1,21 @@ +# openapi.model.SharedLinkEditDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowDownload** | **Optional** | Allow downloads | [optional] +**allowUpload** | **Optional** | Allow uploads | [optional] +**description** | **Optional** | Link description | [optional] +**expiresAt** | [**Optional**](DateTime.md) | Expiration date | [optional] +**password** | **Optional** | Link password | [optional] +**showMetadata** | **Optional** | Show metadata | [optional] +**slug** | **Optional** | Custom URL slug | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SharedLinkLoginDto.md b/mobile/openapi/doc/SharedLinkLoginDto.md new file mode 100644 index 0000000000000..c73f823daab90 --- /dev/null +++ b/mobile/openapi/doc/SharedLinkLoginDto.md @@ -0,0 +1,15 @@ +# openapi.model.SharedLinkLoginDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **String** | Shared link password | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SharedLinkResponseDto.md b/mobile/openapi/doc/SharedLinkResponseDto.md new file mode 100644 index 0000000000000..5848c6bac0c50 --- /dev/null +++ b/mobile/openapi/doc/SharedLinkResponseDto.md @@ -0,0 +1,28 @@ +# openapi.model.SharedLinkResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**album** | [**Optional**](AlbumResponseDto.md) | | [optional] +**allowDownload** | **bool** | Allow downloads | +**allowUpload** | **bool** | Allow uploads | +**assets** | [**List**](AssetResponseDto.md) | | [default to const []] +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**description** | **String** | Link description | +**expiresAt** | [**DateTime**](DateTime.md) | Expiration date | +**id** | **String** | Shared link ID | +**key** | **String** | Encryption key (base64url) | +**password** | **String** | Has password | +**showMetadata** | **bool** | Show metadata | +**slug** | **String** | Custom URL slug | +**type** | [**SharedLinkType**](SharedLinkType.md) | | +**userId** | **String** | Owner user ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SharedLinkType.md b/mobile/openapi/doc/SharedLinkType.md new file mode 100644 index 0000000000000..78d7604682d6a --- /dev/null +++ b/mobile/openapi/doc/SharedLinkType.md @@ -0,0 +1,14 @@ +# openapi.model.SharedLinkType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SharedLinksApi.md b/mobile/openapi/doc/SharedLinksApi.md new file mode 100644 index 0000000000000..264a89529df15 --- /dev/null +++ b/mobile/openapi/doc/SharedLinksApi.md @@ -0,0 +1,548 @@ +# openapi.api.SharedLinksApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**addSharedLinkAssets**](SharedLinksApi.md#addsharedlinkassets) | **PUT** /shared-links/{id}/assets | Add assets to a shared link +[**createSharedLink**](SharedLinksApi.md#createsharedlink) | **POST** /shared-links | Create a shared link +[**getAllSharedLinks**](SharedLinksApi.md#getallsharedlinks) | **GET** /shared-links | Retrieve all shared links +[**getMySharedLink**](SharedLinksApi.md#getmysharedlink) | **GET** /shared-links/me | Retrieve current shared link +[**getSharedLinkById**](SharedLinksApi.md#getsharedlinkbyid) | **GET** /shared-links/{id} | Retrieve a shared link +[**removeSharedLink**](SharedLinksApi.md#removesharedlink) | **DELETE** /shared-links/{id} | Delete a shared link +[**removeSharedLinkAssets**](SharedLinksApi.md#removesharedlinkassets) | **DELETE** /shared-links/{id}/assets | Remove assets from a shared link +[**sharedLinkLogin**](SharedLinksApi.md#sharedlinklogin) | **POST** /shared-links/login | Shared link login +[**updateSharedLink**](SharedLinksApi.md#updatesharedlink) | **PATCH** /shared-links/{id} | Update a shared link + + +# **addSharedLinkAssets** +> List addSharedLinkAssets(id, assetIdsDto) + +Add assets to a shared link + +Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final assetIdsDto = AssetIdsDto(); // AssetIdsDto | + +try { + final result = api_instance.addSharedLinkAssets(id, assetIdsDto); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->addSharedLinkAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **assetIdsDto** | [**AssetIdsDto**](AssetIdsDto.md)| | + +### Return type + +[**List**](AssetIdsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createSharedLink** +> SharedLinkResponseDto createSharedLink(sharedLinkCreateDto) + +Create a shared link + +Create a new shared link. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final sharedLinkCreateDto = SharedLinkCreateDto(); // SharedLinkCreateDto | + +try { + final result = api_instance.createSharedLink(sharedLinkCreateDto); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->createSharedLink: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sharedLinkCreateDto** | [**SharedLinkCreateDto**](SharedLinkCreateDto.md)| | + +### Return type + +[**SharedLinkResponseDto**](SharedLinkResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAllSharedLinks** +> List getAllSharedLinks(albumId, id) + +Retrieve all shared links + +Retrieve a list of all shared links. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter by album ID +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter by shared link ID + +try { + final result = api_instance.getAllSharedLinks(albumId, id); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->getAllSharedLinks: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **albumId** | **String**| Filter by album ID | [optional] + **id** | **String**| Filter by shared link ID | [optional] + +### Return type + +[**List**](SharedLinkResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMySharedLink** +> SharedLinkResponseDto getMySharedLink(key, slug) + +Retrieve current shared link + +Retrieve the current shared link associated with authentication method. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.getMySharedLink(key, slug); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->getMySharedLink: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**SharedLinkResponseDto**](SharedLinkResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSharedLinkById** +> SharedLinkResponseDto getSharedLinkById(id) + +Retrieve a shared link + +Retrieve a specific shared link by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getSharedLinkById(id); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->getSharedLinkById: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**SharedLinkResponseDto**](SharedLinkResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeSharedLink** +> removeSharedLink(id) + +Delete a shared link + +Delete a specific shared link by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.removeSharedLink(id); +} catch (e) { + print('Exception when calling SharedLinksApi->removeSharedLink: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeSharedLinkAssets** +> List removeSharedLinkAssets(id, assetIdsDto) + +Remove assets from a shared link + +Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final assetIdsDto = AssetIdsDto(); // AssetIdsDto | + +try { + final result = api_instance.removeSharedLinkAssets(id, assetIdsDto); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->removeSharedLinkAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **assetIdsDto** | [**AssetIdsDto**](AssetIdsDto.md)| | + +### Return type + +[**List**](AssetIdsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sharedLinkLogin** +> SharedLinkResponseDto sharedLinkLogin(sharedLinkLoginDto, key, slug) + +Shared link login + +Login to a password protected shared link + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final sharedLinkLoginDto = SharedLinkLoginDto(); // SharedLinkLoginDto | +final key = key_example; // String | +final slug = slug_example; // String | + +try { + final result = api_instance.sharedLinkLogin(sharedLinkLoginDto, key, slug); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->sharedLinkLogin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sharedLinkLoginDto** | [**SharedLinkLoginDto**](SharedLinkLoginDto.md)| | + **key** | **String**| | [optional] + **slug** | **String**| | [optional] + +### Return type + +[**SharedLinkResponseDto**](SharedLinkResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateSharedLink** +> SharedLinkResponseDto updateSharedLink(id, sharedLinkEditDto) + +Update a shared link + +Update an existing shared link by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SharedLinksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final sharedLinkEditDto = SharedLinkEditDto(); // SharedLinkEditDto | + +try { + final result = api_instance.updateSharedLink(id, sharedLinkEditDto); + print(result); +} catch (e) { + print('Exception when calling SharedLinksApi->updateSharedLink: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **sharedLinkEditDto** | [**SharedLinkEditDto**](SharedLinkEditDto.md)| | + +### Return type + +[**SharedLinkResponseDto**](SharedLinkResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/SharedLinksResponse.md b/mobile/openapi/doc/SharedLinksResponse.md new file mode 100644 index 0000000000000..a6263ba25826f --- /dev/null +++ b/mobile/openapi/doc/SharedLinksResponse.md @@ -0,0 +1,16 @@ +# openapi.model.SharedLinksResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether shared links are enabled | +**sidebarWeb** | **bool** | Whether shared links appear in web sidebar | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SharedLinksUpdate.md b/mobile/openapi/doc/SharedLinksUpdate.md new file mode 100644 index 0000000000000..4ce507dfed34d --- /dev/null +++ b/mobile/openapi/doc/SharedLinksUpdate.md @@ -0,0 +1,16 @@ +# openapi.model.SharedLinksUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **Optional** | Whether shared links are enabled | [optional] +**sidebarWeb** | **Optional** | Whether shared links appear in web sidebar | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SignUpDto.md b/mobile/openapi/doc/SignUpDto.md new file mode 100644 index 0000000000000..c41d91bd62d1c --- /dev/null +++ b/mobile/openapi/doc/SignUpDto.md @@ -0,0 +1,17 @@ +# openapi.model.SignUpDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **String** | User email | +**name** | **String** | User name | +**password** | **String** | User password | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SmartSearchDto.md b/mobile/openapi/doc/SmartSearchDto.md new file mode 100644 index 0000000000000..eef3e04684cab --- /dev/null +++ b/mobile/openapi/doc/SmartSearchDto.md @@ -0,0 +1,48 @@ +# openapi.model.SmartSearchDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumIds** | **Optional?>** | Filter by album IDs | [optional] [default to const []] +**city** | **Optional** | Filter by city name | [optional] +**country** | **Optional** | Filter by country name | [optional] +**createdAfter** | [**Optional**](DateTime.md) | Filter by creation date (after) | [optional] +**createdBefore** | [**Optional**](DateTime.md) | Filter by creation date (before) | [optional] +**isEncoded** | **Optional** | Filter by encoded status | [optional] +**isFavorite** | **Optional** | Filter by favorite status | [optional] +**isMotion** | **Optional** | Filter by motion photo status | [optional] +**isNotInAlbum** | **Optional** | Filter assets not in any album | [optional] +**isOffline** | **Optional** | Filter by offline status | [optional] +**language** | **Optional** | Search language code | [optional] +**lensModel** | **Optional** | Filter by lens model | [optional] +**libraryId** | **Optional** | Library ID to filter by | [optional] +**make** | **Optional** | Filter by camera make | [optional] +**model** | **Optional** | Filter by camera model | [optional] +**ocr** | **Optional** | Filter by OCR text content | [optional] +**page** | **Optional** | Page number | [optional] +**personIds** | **Optional?>** | Filter by person IDs | [optional] [default to const []] +**query** | **Optional** | Natural language search query | [optional] +**queryAssetId** | **Optional** | Asset ID to use as search reference | [optional] +**rating** | **Optional** | Filter by rating [1-5], or null for unrated | [optional] +**size** | **Optional** | Number of results to return | [optional] +**state** | **Optional** | Filter by state/province name | [optional] +**tagIds** | **Optional?>** | Filter by tag IDs | [optional] [default to const []] +**takenAfter** | [**Optional**](DateTime.md) | Filter by taken date (after) | [optional] +**takenBefore** | [**Optional**](DateTime.md) | Filter by taken date (before) | [optional] +**trashedAfter** | [**Optional**](DateTime.md) | Filter by trash date (after) | [optional] +**trashedBefore** | [**Optional**](DateTime.md) | Filter by trash date (before) | [optional] +**type** | [**Optional**](AssetTypeEnum.md) | | [optional] +**updatedAfter** | [**Optional**](DateTime.md) | Filter by update date (after) | [optional] +**updatedBefore** | [**Optional**](DateTime.md) | Filter by update date (before) | [optional] +**visibility** | [**Optional**](AssetVisibility.md) | | [optional] +**withDeleted** | **Optional** | Include deleted assets | [optional] +**withExif** | **Optional** | Include EXIF data in response | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SnapshotDto.md b/mobile/openapi/doc/SnapshotDto.md new file mode 100644 index 0000000000000..aafbebdfe645c --- /dev/null +++ b/mobile/openapi/doc/SnapshotDto.md @@ -0,0 +1,18 @@ +# openapi.model.SnapshotDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | +**paths** | **List** | | [default to const []] +**summary** | [**Optional**](SnapshotSummaryDto.md) | | [optional] +**time** | **String** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SnapshotSummaryDto.md b/mobile/openapi/doc/SnapshotSummaryDto.md new file mode 100644 index 0000000000000..320018bf40481 --- /dev/null +++ b/mobile/openapi/doc/SnapshotSummaryDto.md @@ -0,0 +1,20 @@ +# openapi.model.SnapshotSummaryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dataAdded** | **num** | | +**filesChanged** | **num** | | +**filesNew** | **num** | | +**filesUnmodified** | **num** | | +**totalBytes** | **num** | | +**totalFiles** | **num** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SourceType.md b/mobile/openapi/doc/SourceType.md new file mode 100644 index 0000000000000..d5875347dc2ab --- /dev/null +++ b/mobile/openapi/doc/SourceType.md @@ -0,0 +1,14 @@ +# openapi.model.SourceType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/StackCreateDto.md b/mobile/openapi/doc/StackCreateDto.md new file mode 100644 index 0000000000000..b094e3bf55c0c --- /dev/null +++ b/mobile/openapi/doc/StackCreateDto.md @@ -0,0 +1,15 @@ +# openapi.model.StackCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetIds** | **List** | Asset IDs (first becomes primary, min 2) | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/StackResponseDto.md b/mobile/openapi/doc/StackResponseDto.md new file mode 100644 index 0000000000000..6c5107686af5a --- /dev/null +++ b/mobile/openapi/doc/StackResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.StackResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assets** | [**List**](AssetResponseDto.md) | | [default to const []] +**id** | **String** | Stack ID | +**primaryAssetId** | **String** | Primary asset ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/StackUpdateDto.md b/mobile/openapi/doc/StackUpdateDto.md new file mode 100644 index 0000000000000..fa0416a576a8a --- /dev/null +++ b/mobile/openapi/doc/StackUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.StackUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**primaryAssetId** | **Optional** | Primary asset ID | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/StacksApi.md b/mobile/openapi/doc/StacksApi.md new file mode 100644 index 0000000000000..62a7abf9d8343 --- /dev/null +++ b/mobile/openapi/doc/StacksApi.md @@ -0,0 +1,420 @@ +# openapi.api.StacksApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createStack**](StacksApi.md#createstack) | **POST** /stacks | Create a stack +[**deleteStack**](StacksApi.md#deletestack) | **DELETE** /stacks/{id} | Delete a stack +[**deleteStacks**](StacksApi.md#deletestacks) | **DELETE** /stacks | Delete stacks +[**getStack**](StacksApi.md#getstack) | **GET** /stacks/{id} | Retrieve a stack +[**removeAssetFromStack**](StacksApi.md#removeassetfromstack) | **DELETE** /stacks/{id}/assets/{assetId} | Remove an asset from a stack +[**searchStacks**](StacksApi.md#searchstacks) | **GET** /stacks | Retrieve stacks +[**updateStack**](StacksApi.md#updatestack) | **PUT** /stacks/{id} | Update a stack + + +# **createStack** +> StackResponseDto createStack(stackCreateDto) + +Create a stack + +Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = StacksApi(); +final stackCreateDto = StackCreateDto(); // StackCreateDto | + +try { + final result = api_instance.createStack(stackCreateDto); + print(result); +} catch (e) { + print('Exception when calling StacksApi->createStack: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **stackCreateDto** | [**StackCreateDto**](StackCreateDto.md)| | + +### Return type + +[**StackResponseDto**](StackResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteStack** +> deleteStack(id) + +Delete a stack + +Delete a specific stack by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = StacksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteStack(id); +} catch (e) { + print('Exception when calling StacksApi->deleteStack: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteStacks** +> deleteStacks(bulkIdsDto) + +Delete stacks + +Delete multiple stacks by providing a list of stack IDs. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = StacksApi(); +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + api_instance.deleteStacks(bulkIdsDto); +} catch (e) { + print('Exception when calling StacksApi->deleteStacks: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getStack** +> StackResponseDto getStack(id) + +Retrieve a stack + +Retrieve a specific stack by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = StacksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getStack(id); + print(result); +} catch (e) { + print('Exception when calling StacksApi->getStack: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**StackResponseDto**](StackResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **removeAssetFromStack** +> removeAssetFromStack(assetId, id) + +Remove an asset from a stack + +Remove a specific asset from a stack by providing the stack ID and asset ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = StacksApi(); +final assetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.removeAssetFromStack(assetId, id); +} catch (e) { + print('Exception when calling StacksApi->removeAssetFromStack: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **assetId** | **String**| | + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchStacks** +> List searchStacks(primaryAssetId) + +Retrieve stacks + +Retrieve a list of stacks. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = StacksApi(); +final primaryAssetId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter by primary asset ID + +try { + final result = api_instance.searchStacks(primaryAssetId); + print(result); +} catch (e) { + print('Exception when calling StacksApi->searchStacks: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **primaryAssetId** | **String**| Filter by primary asset ID | [optional] + +### Return type + +[**List**](StackResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateStack** +> StackResponseDto updateStack(id, stackUpdateDto) + +Update a stack + +Update an existing stack by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = StacksApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final stackUpdateDto = StackUpdateDto(); // StackUpdateDto | + +try { + final result = api_instance.updateStack(id, stackUpdateDto); + print(result); +} catch (e) { + print('Exception when calling StacksApi->updateStack: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **stackUpdateDto** | [**StackUpdateDto**](StackUpdateDto.md)| | + +### Return type + +[**StackResponseDto**](StackResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/StatisticsSearchDto.md b/mobile/openapi/doc/StatisticsSearchDto.md new file mode 100644 index 0000000000000..2c5e10fe4e9a9 --- /dev/null +++ b/mobile/openapi/doc/StatisticsSearchDto.md @@ -0,0 +1,42 @@ +# openapi.model.StatisticsSearchDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumIds** | **Optional?>** | Filter by album IDs | [optional] [default to const []] +**city** | **Optional** | Filter by city name | [optional] +**country** | **Optional** | Filter by country name | [optional] +**createdAfter** | [**Optional**](DateTime.md) | Filter by creation date (after) | [optional] +**createdBefore** | [**Optional**](DateTime.md) | Filter by creation date (before) | [optional] +**description** | **Optional** | Filter by description text | [optional] +**isEncoded** | **Optional** | Filter by encoded status | [optional] +**isFavorite** | **Optional** | Filter by favorite status | [optional] +**isMotion** | **Optional** | Filter by motion photo status | [optional] +**isNotInAlbum** | **Optional** | Filter assets not in any album | [optional] +**isOffline** | **Optional** | Filter by offline status | [optional] +**lensModel** | **Optional** | Filter by lens model | [optional] +**libraryId** | **Optional** | Library ID to filter by | [optional] +**make** | **Optional** | Filter by camera make | [optional] +**model** | **Optional** | Filter by camera model | [optional] +**ocr** | **Optional** | Filter by OCR text content | [optional] +**personIds** | **Optional?>** | Filter by person IDs | [optional] [default to const []] +**rating** | **Optional** | Filter by rating [1-5], or null for unrated | [optional] +**state** | **Optional** | Filter by state/province name | [optional] +**tagIds** | **Optional?>** | Filter by tag IDs | [optional] [default to const []] +**takenAfter** | [**Optional**](DateTime.md) | Filter by taken date (after) | [optional] +**takenBefore** | [**Optional**](DateTime.md) | Filter by taken date (before) | [optional] +**trashedAfter** | [**Optional**](DateTime.md) | Filter by trash date (after) | [optional] +**trashedBefore** | [**Optional**](DateTime.md) | Filter by trash date (before) | [optional] +**type** | [**Optional**](AssetTypeEnum.md) | | [optional] +**updatedAfter** | [**Optional**](DateTime.md) | Filter by update date (after) | [optional] +**updatedBefore** | [**Optional**](DateTime.md) | Filter by update date (before) | [optional] +**visibility** | [**Optional**](AssetVisibility.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/StorageFolder.md b/mobile/openapi/doc/StorageFolder.md new file mode 100644 index 0000000000000..2ca7949fba93b --- /dev/null +++ b/mobile/openapi/doc/StorageFolder.md @@ -0,0 +1,14 @@ +# openapi.model.StorageFolder + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAckDeleteDto.md b/mobile/openapi/doc/SyncAckDeleteDto.md new file mode 100644 index 0000000000000..f833050059d91 --- /dev/null +++ b/mobile/openapi/doc/SyncAckDeleteDto.md @@ -0,0 +1,15 @@ +# openapi.model.SyncAckDeleteDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**types** | [**Optional?>**](SyncEntityType.md) | Sync entity types to delete acks for | [optional] [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAckDto.md b/mobile/openapi/doc/SyncAckDto.md new file mode 100644 index 0000000000000..58ebd121233f7 --- /dev/null +++ b/mobile/openapi/doc/SyncAckDto.md @@ -0,0 +1,16 @@ +# openapi.model.SyncAckDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ack** | **String** | Acknowledgment ID | +**type** | [**SyncEntityType**](SyncEntityType.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAckSetDto.md b/mobile/openapi/doc/SyncAckSetDto.md new file mode 100644 index 0000000000000..e1b3436d779ae --- /dev/null +++ b/mobile/openapi/doc/SyncAckSetDto.md @@ -0,0 +1,15 @@ +# openapi.model.SyncAckSetDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acks** | **List** | Acknowledgment IDs (max 1000) | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAlbumDeleteV1.md b/mobile/openapi/doc/SyncAlbumDeleteV1.md new file mode 100644 index 0000000000000..5d73426f24bf5 --- /dev/null +++ b/mobile/openapi/doc/SyncAlbumDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncAlbumDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **String** | Album ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAlbumToAssetDeleteV1.md b/mobile/openapi/doc/SyncAlbumToAssetDeleteV1.md new file mode 100644 index 0000000000000..058e9e5fd9053 --- /dev/null +++ b/mobile/openapi/doc/SyncAlbumToAssetDeleteV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncAlbumToAssetDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **String** | Album ID | +**assetId** | **String** | Asset ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAlbumToAssetV1.md b/mobile/openapi/doc/SyncAlbumToAssetV1.md new file mode 100644 index 0000000000000..150b8c488102b --- /dev/null +++ b/mobile/openapi/doc/SyncAlbumToAssetV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncAlbumToAssetV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **String** | Album ID | +**assetId** | **String** | Asset ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAlbumUserDeleteV1.md b/mobile/openapi/doc/SyncAlbumUserDeleteV1.md new file mode 100644 index 0000000000000..bb6e12a921f7b --- /dev/null +++ b/mobile/openapi/doc/SyncAlbumUserDeleteV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncAlbumUserDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **String** | Album ID | +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAlbumUserV1.md b/mobile/openapi/doc/SyncAlbumUserV1.md new file mode 100644 index 0000000000000..2d66e8621ba93 --- /dev/null +++ b/mobile/openapi/doc/SyncAlbumUserV1.md @@ -0,0 +1,17 @@ +# openapi.model.SyncAlbumUserV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumId** | **String** | Album ID | +**role** | [**AlbumUserRole**](AlbumUserRole.md) | | +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAlbumV1.md b/mobile/openapi/doc/SyncAlbumV1.md new file mode 100644 index 0000000000000..0725eb2fcf1ff --- /dev/null +++ b/mobile/openapi/doc/SyncAlbumV1.md @@ -0,0 +1,23 @@ +# openapi.model.SyncAlbumV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | [**DateTime**](DateTime.md) | Created at | +**description** | **String** | Album description | +**id** | **String** | Album ID | +**isActivityEnabled** | **bool** | Is activity enabled | +**name** | **String** | Album name | +**order** | [**AssetOrder**](AssetOrder.md) | | +**ownerId** | **String** | Owner ID | +**thumbnailAssetId** | **String** | Thumbnail asset ID | +**updatedAt** | [**DateTime**](DateTime.md) | Updated at | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAlbumV2.md b/mobile/openapi/doc/SyncAlbumV2.md new file mode 100644 index 0000000000000..a60ae13dbc19d --- /dev/null +++ b/mobile/openapi/doc/SyncAlbumV2.md @@ -0,0 +1,22 @@ +# openapi.model.SyncAlbumV2 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | [**DateTime**](DateTime.md) | Created at | +**description** | **String** | Album description | +**id** | **String** | Album ID | +**isActivityEnabled** | **bool** | Is activity enabled | +**name** | **String** | Album name | +**order** | [**AssetOrder**](AssetOrder.md) | | +**thumbnailAssetId** | **String** | Thumbnail asset ID | +**updatedAt** | [**DateTime**](DateTime.md) | Updated at | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncApi.md b/mobile/openapi/doc/SyncApi.md new file mode 100644 index 0000000000000..6dfae143785a0 --- /dev/null +++ b/mobile/openapi/doc/SyncApi.md @@ -0,0 +1,238 @@ +# openapi.api.SyncApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteSyncAck**](SyncApi.md#deletesyncack) | **DELETE** /sync/ack | Delete acknowledgements +[**getSyncAck**](SyncApi.md#getsyncack) | **GET** /sync/ack | Retrieve acknowledgements +[**getSyncStream**](SyncApi.md#getsyncstream) | **POST** /sync/stream | Stream sync changes +[**sendSyncAck**](SyncApi.md#sendsyncack) | **POST** /sync/ack | Acknowledge changes + + +# **deleteSyncAck** +> deleteSyncAck(syncAckDeleteDto) + +Delete acknowledgements + +Delete specific synchronization acknowledgments. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SyncApi(); +final syncAckDeleteDto = SyncAckDeleteDto(); // SyncAckDeleteDto | + +try { + api_instance.deleteSyncAck(syncAckDeleteDto); +} catch (e) { + print('Exception when calling SyncApi->deleteSyncAck: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **syncAckDeleteDto** | [**SyncAckDeleteDto**](SyncAckDeleteDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSyncAck** +> List getSyncAck() + +Retrieve acknowledgements + +Retrieve the synchronization acknowledgments for the current session. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SyncApi(); + +try { + final result = api_instance.getSyncAck(); + print(result); +} catch (e) { + print('Exception when calling SyncApi->getSyncAck: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](SyncAckDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getSyncStream** +> getSyncStream(syncStreamDto) + +Stream sync changes + +Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SyncApi(); +final syncStreamDto = SyncStreamDto(); // SyncStreamDto | + +try { + api_instance.getSyncStream(syncStreamDto); +} catch (e) { + print('Exception when calling SyncApi->getSyncStream: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **syncStreamDto** | [**SyncStreamDto**](SyncStreamDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sendSyncAck** +> sendSyncAck(syncAckSetDto) + +Acknowledge changes + +Send a list of synchronization acknowledgements to confirm that the latest changes have been received. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SyncApi(); +final syncAckSetDto = SyncAckSetDto(); // SyncAckSetDto | + +try { + api_instance.sendSyncAck(syncAckSetDto); +} catch (e) { + print('Exception when calling SyncApi->sendSyncAck: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **syncAckSetDto** | [**SyncAckSetDto**](SyncAckSetDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/SyncAssetDeleteV1.md b/mobile/openapi/doc/SyncAssetDeleteV1.md new file mode 100644 index 0000000000000..68aa2f9740755 --- /dev/null +++ b/mobile/openapi/doc/SyncAssetDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncAssetDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetEditDeleteV1.md b/mobile/openapi/doc/SyncAssetEditDeleteV1.md new file mode 100644 index 0000000000000..a27ee95a7b98a --- /dev/null +++ b/mobile/openapi/doc/SyncAssetEditDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncAssetEditDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**editId** | **String** | Edit ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetEditV1.md b/mobile/openapi/doc/SyncAssetEditV1.md new file mode 100644 index 0000000000000..8997f87c5cf7e --- /dev/null +++ b/mobile/openapi/doc/SyncAssetEditV1.md @@ -0,0 +1,19 @@ +# openapi.model.SyncAssetEditV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | [**AssetEditAction**](AssetEditAction.md) | | +**assetId** | **String** | Asset ID | +**id** | **String** | Edit ID | +**parameters** | **Map** | Edit parameters | [default to const {}] +**sequence** | **int** | Edit sequence | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetExifV1.md b/mobile/openapi/doc/SyncAssetExifV1.md new file mode 100644 index 0000000000000..775e0605ce527 --- /dev/null +++ b/mobile/openapi/doc/SyncAssetExifV1.md @@ -0,0 +1,39 @@ +# openapi.model.SyncAssetExifV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**city** | **String** | City | +**country** | **String** | Country | +**dateTimeOriginal** | [**DateTime**](DateTime.md) | Date time original | +**description** | **String** | Description | +**exifImageHeight** | **int** | Exif image height | +**exifImageWidth** | **int** | Exif image width | +**exposureTime** | **String** | Exposure time | +**fNumber** | **double** | F number | +**fileSizeInByte** | **int** | File size in byte | +**focalLength** | **double** | Focal length | +**fps** | **double** | FPS | +**iso** | **int** | ISO | +**latitude** | **double** | Latitude | +**lensModel** | **String** | Lens model | +**longitude** | **double** | Longitude | +**make** | **String** | Make | +**model** | **String** | Model | +**modifyDate** | [**DateTime**](DateTime.md) | Modify date | +**orientation** | **String** | Orientation | +**profileDescription** | **String** | Profile description | +**projectionType** | **String** | Projection type | +**rating** | **int** | Rating | +**state** | **String** | State | +**timeZone** | **String** | Time zone | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetFaceDeleteV1.md b/mobile/openapi/doc/SyncAssetFaceDeleteV1.md new file mode 100644 index 0000000000000..10acb3fc2be0f --- /dev/null +++ b/mobile/openapi/doc/SyncAssetFaceDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncAssetFaceDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetFaceId** | **String** | Asset face ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetFaceV1.md b/mobile/openapi/doc/SyncAssetFaceV1.md new file mode 100644 index 0000000000000..58045b8f3eb79 --- /dev/null +++ b/mobile/openapi/doc/SyncAssetFaceV1.md @@ -0,0 +1,24 @@ +# openapi.model.SyncAssetFaceV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**boundingBoxX1** | **int** | Bounding box X1 | +**boundingBoxX2** | **int** | Bounding box X2 | +**boundingBoxY1** | **int** | Bounding box Y1 | +**boundingBoxY2** | **int** | Bounding box Y2 | +**id** | **String** | Asset face ID | +**imageHeight** | **int** | Image height | +**imageWidth** | **int** | Image width | +**personId** | **String** | Person ID | +**sourceType** | **String** | Source type | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetFaceV2.md b/mobile/openapi/doc/SyncAssetFaceV2.md new file mode 100644 index 0000000000000..20ff04b9de9cb --- /dev/null +++ b/mobile/openapi/doc/SyncAssetFaceV2.md @@ -0,0 +1,26 @@ +# openapi.model.SyncAssetFaceV2 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**boundingBoxX1** | **int** | Bounding box X1 | +**boundingBoxX2** | **int** | Bounding box X2 | +**boundingBoxY1** | **int** | Bounding box Y1 | +**boundingBoxY2** | **int** | Bounding box Y2 | +**deletedAt** | [**DateTime**](DateTime.md) | Face deleted at | +**id** | **String** | Asset face ID | +**imageHeight** | **int** | Image height | +**imageWidth** | **int** | Image width | +**isVisible** | **bool** | Is the face visible in the asset | +**personId** | **String** | Person ID | +**sourceType** | **String** | Source type | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetMetadataDeleteV1.md b/mobile/openapi/doc/SyncAssetMetadataDeleteV1.md new file mode 100644 index 0000000000000..28925fba86c52 --- /dev/null +++ b/mobile/openapi/doc/SyncAssetMetadataDeleteV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncAssetMetadataDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**key** | **String** | Key | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetMetadataV1.md b/mobile/openapi/doc/SyncAssetMetadataV1.md new file mode 100644 index 0000000000000..26cd1b367761f --- /dev/null +++ b/mobile/openapi/doc/SyncAssetMetadataV1.md @@ -0,0 +1,17 @@ +# openapi.model.SyncAssetMetadataV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**key** | **String** | Key | +**value** | **Map** | Value | [default to const {}] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetOcrDeleteV1.md b/mobile/openapi/doc/SyncAssetOcrDeleteV1.md new file mode 100644 index 0000000000000..faf58910c1e5a --- /dev/null +++ b/mobile/openapi/doc/SyncAssetOcrDeleteV1.md @@ -0,0 +1,17 @@ +# openapi.model.SyncAssetOcrDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Original asset ID of the deleted OCR entry | +**deletedAt** | [**DateTime**](DateTime.md) | Timestamp when the OCR entry was deleted | +**id** | **String** | Audit row ID of the deleted OCR entry | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetOcrV1.md b/mobile/openapi/doc/SyncAssetOcrV1.md new file mode 100644 index 0000000000000..829a255fd1778 --- /dev/null +++ b/mobile/openapi/doc/SyncAssetOcrV1.md @@ -0,0 +1,28 @@ +# openapi.model.SyncAssetOcrV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**boxScore** | **double** | Confidence score of the bounding box | +**id** | **String** | OCR entry ID | +**isVisible** | **bool** | Whether the OCR entry is visible | +**text** | **String** | Recognized text content | +**textScore** | **double** | Confidence score of the recognized text | +**x1** | **double** | Top-left X coordinate (normalized 0–1) | +**x2** | **double** | Top-right X coordinate (normalized 0–1) | +**x3** | **double** | Bottom-right X coordinate (normalized 0–1) | +**x4** | **double** | Bottom-left X coordinate (normalized 0–1) | +**y1** | **double** | Top-left Y coordinate (normalized 0–1) | +**y2** | **double** | Top-right Y coordinate (normalized 0–1) | +**y3** | **double** | Bottom-right Y coordinate (normalized 0–1) | +**y4** | **double** | Bottom-left Y coordinate (normalized 0–1) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetV1.md b/mobile/openapi/doc/SyncAssetV1.md new file mode 100644 index 0000000000000..f3259e375e87f --- /dev/null +++ b/mobile/openapi/doc/SyncAssetV1.md @@ -0,0 +1,34 @@ +# openapi.model.SyncAssetV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checksum** | **String** | Checksum | +**createdAt** | [**DateTime**](DateTime.md) | Uploaded to Immich at | +**deletedAt** | [**DateTime**](DateTime.md) | Deleted at | +**duration** | **String** | Duration | +**fileCreatedAt** | [**DateTime**](DateTime.md) | File created at | +**fileModifiedAt** | [**DateTime**](DateTime.md) | File modified at | +**height** | **int** | Asset height | +**id** | **String** | Asset ID | +**isEdited** | **bool** | Is edited | +**isFavorite** | **bool** | Is favorite | +**libraryId** | **String** | Library ID | +**livePhotoVideoId** | **String** | Live photo video ID | +**localDateTime** | [**DateTime**](DateTime.md) | Local date time | +**originalFileName** | **String** | Original file name | +**ownerId** | **String** | Owner ID | +**stackId** | **String** | Stack ID | +**thumbhash** | **String** | Thumbhash | +**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | | +**visibility** | [**AssetVisibility**](AssetVisibility.md) | | +**width** | **int** | Asset width | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAssetV2.md b/mobile/openapi/doc/SyncAssetV2.md new file mode 100644 index 0000000000000..653b3e91d5042 --- /dev/null +++ b/mobile/openapi/doc/SyncAssetV2.md @@ -0,0 +1,34 @@ +# openapi.model.SyncAssetV2 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checksum** | **String** | Checksum | +**createdAt** | [**DateTime**](DateTime.md) | Uploaded to Immich at | +**deletedAt** | [**DateTime**](DateTime.md) | Deleted at | +**duration** | **int** | Duration | +**fileCreatedAt** | [**DateTime**](DateTime.md) | File created at | +**fileModifiedAt** | [**DateTime**](DateTime.md) | File modified at | +**height** | **int** | Asset height | +**id** | **String** | Asset ID | +**isEdited** | **bool** | Is edited | +**isFavorite** | **bool** | Is favorite | +**libraryId** | **String** | Library ID | +**livePhotoVideoId** | **String** | Live photo video ID | +**localDateTime** | [**DateTime**](DateTime.md) | Local date time | +**originalFileName** | **String** | Original file name | +**ownerId** | **String** | Owner ID | +**stackId** | **String** | Stack ID | +**thumbhash** | **String** | Thumbhash | +**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | | +**visibility** | [**AssetVisibility**](AssetVisibility.md) | | +**width** | **int** | Asset width | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncAuthUserV1.md b/mobile/openapi/doc/SyncAuthUserV1.md new file mode 100644 index 0000000000000..8939bddd9ca2c --- /dev/null +++ b/mobile/openapi/doc/SyncAuthUserV1.md @@ -0,0 +1,27 @@ +# openapi.model.SyncAuthUserV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**Optional**](UserAvatarColor.md) | | [optional] +**deletedAt** | [**DateTime**](DateTime.md) | User deleted at | +**email** | **String** | User email | +**hasProfileImage** | **bool** | User has profile image | +**id** | **String** | User ID | +**isAdmin** | **bool** | User is admin | +**name** | **String** | User name | +**oauthId** | **String** | User OAuth ID | +**pinCode** | **String** | User pin code | +**profileChangedAt** | [**DateTime**](DateTime.md) | User profile changed at | +**quotaSizeInBytes** | **int** | Quota size in bytes | +**quotaUsageInBytes** | **int** | Quota usage in bytes | +**storageLabel** | **String** | User storage label | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncEntityType.md b/mobile/openapi/doc/SyncEntityType.md new file mode 100644 index 0000000000000..99a67de48696e --- /dev/null +++ b/mobile/openapi/doc/SyncEntityType.md @@ -0,0 +1,14 @@ +# openapi.model.SyncEntityType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncMemoryAssetDeleteV1.md b/mobile/openapi/doc/SyncMemoryAssetDeleteV1.md new file mode 100644 index 0000000000000..bb7e74f841c95 --- /dev/null +++ b/mobile/openapi/doc/SyncMemoryAssetDeleteV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncMemoryAssetDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**memoryId** | **String** | Memory ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncMemoryAssetV1.md b/mobile/openapi/doc/SyncMemoryAssetV1.md new file mode 100644 index 0000000000000..a604c717de856 --- /dev/null +++ b/mobile/openapi/doc/SyncMemoryAssetV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncMemoryAssetV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetId** | **String** | Asset ID | +**memoryId** | **String** | Memory ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncMemoryDeleteV1.md b/mobile/openapi/doc/SyncMemoryDeleteV1.md new file mode 100644 index 0000000000000..d7cde4c62b05b --- /dev/null +++ b/mobile/openapi/doc/SyncMemoryDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncMemoryDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**memoryId** | **String** | Memory ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncMemoryV1.md b/mobile/openapi/doc/SyncMemoryV1.md new file mode 100644 index 0000000000000..1e363aa9d6321 --- /dev/null +++ b/mobile/openapi/doc/SyncMemoryV1.md @@ -0,0 +1,26 @@ +# openapi.model.SyncMemoryV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | [**DateTime**](DateTime.md) | Created at | +**data** | **Map** | Data | [default to const {}] +**deletedAt** | [**DateTime**](DateTime.md) | Deleted at | +**hideAt** | [**DateTime**](DateTime.md) | Hide at | +**id** | **String** | Memory ID | +**isSaved** | **bool** | Is saved | +**memoryAt** | [**DateTime**](DateTime.md) | Memory at | +**ownerId** | **String** | Owner ID | +**seenAt** | [**DateTime**](DateTime.md) | Seen at | +**showAt** | [**DateTime**](DateTime.md) | Show at | +**type** | [**MemoryType**](MemoryType.md) | | +**updatedAt** | [**DateTime**](DateTime.md) | Updated at | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncPartnerDeleteV1.md b/mobile/openapi/doc/SyncPartnerDeleteV1.md new file mode 100644 index 0000000000000..ee414b7a89298 --- /dev/null +++ b/mobile/openapi/doc/SyncPartnerDeleteV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncPartnerDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sharedById** | **String** | Shared by ID | +**sharedWithId** | **String** | Shared with ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncPartnerV1.md b/mobile/openapi/doc/SyncPartnerV1.md new file mode 100644 index 0000000000000..c18094187e829 --- /dev/null +++ b/mobile/openapi/doc/SyncPartnerV1.md @@ -0,0 +1,17 @@ +# openapi.model.SyncPartnerV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inTimeline** | **bool** | In timeline | +**sharedById** | **String** | Shared by ID | +**sharedWithId** | **String** | Shared with ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncPersonDeleteV1.md b/mobile/openapi/doc/SyncPersonDeleteV1.md new file mode 100644 index 0000000000000..0cff300528c1c --- /dev/null +++ b/mobile/openapi/doc/SyncPersonDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncPersonDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**personId** | **String** | Person ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncPersonV1.md b/mobile/openapi/doc/SyncPersonV1.md new file mode 100644 index 0000000000000..994b305db9156 --- /dev/null +++ b/mobile/openapi/doc/SyncPersonV1.md @@ -0,0 +1,24 @@ +# openapi.model.SyncPersonV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**birthDate** | [**DateTime**](DateTime.md) | Birth date | +**color** | **String** | Color | +**createdAt** | [**DateTime**](DateTime.md) | Created at | +**faceAssetId** | **String** | Face asset ID | +**id** | **String** | Person ID | +**isFavorite** | **bool** | Is favorite | +**isHidden** | **bool** | Is hidden | +**name** | **String** | Person name | +**ownerId** | **String** | Owner ID | +**updatedAt** | [**DateTime**](DateTime.md) | Updated at | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncRequestType.md b/mobile/openapi/doc/SyncRequestType.md new file mode 100644 index 0000000000000..afcbe12545fda --- /dev/null +++ b/mobile/openapi/doc/SyncRequestType.md @@ -0,0 +1,14 @@ +# openapi.model.SyncRequestType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncStackDeleteV1.md b/mobile/openapi/doc/SyncStackDeleteV1.md new file mode 100644 index 0000000000000..d637e87bf0256 --- /dev/null +++ b/mobile/openapi/doc/SyncStackDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncStackDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stackId** | **String** | Stack ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncStackV1.md b/mobile/openapi/doc/SyncStackV1.md new file mode 100644 index 0000000000000..78355ad04eecf --- /dev/null +++ b/mobile/openapi/doc/SyncStackV1.md @@ -0,0 +1,19 @@ +# openapi.model.SyncStackV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | [**DateTime**](DateTime.md) | Created at | +**id** | **String** | Stack ID | +**ownerId** | **String** | Owner ID | +**primaryAssetId** | **String** | Primary asset ID | +**updatedAt** | [**DateTime**](DateTime.md) | Updated at | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncStreamDto.md b/mobile/openapi/doc/SyncStreamDto.md new file mode 100644 index 0000000000000..88cbc9c14bf75 --- /dev/null +++ b/mobile/openapi/doc/SyncStreamDto.md @@ -0,0 +1,16 @@ +# openapi.model.SyncStreamDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reset** | **Optional** | Reset sync state | [optional] +**types** | [**List**](SyncRequestType.md) | Sync request types | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncUserDeleteV1.md b/mobile/openapi/doc/SyncUserDeleteV1.md new file mode 100644 index 0000000000000..5bbe396931227 --- /dev/null +++ b/mobile/openapi/doc/SyncUserDeleteV1.md @@ -0,0 +1,15 @@ +# openapi.model.SyncUserDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncUserMetadataDeleteV1.md b/mobile/openapi/doc/SyncUserMetadataDeleteV1.md new file mode 100644 index 0000000000000..c505cd29e71c4 --- /dev/null +++ b/mobile/openapi/doc/SyncUserMetadataDeleteV1.md @@ -0,0 +1,16 @@ +# openapi.model.SyncUserMetadataDeleteV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | [**UserMetadataKey**](UserMetadataKey.md) | | +**userId** | **String** | User ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncUserMetadataV1.md b/mobile/openapi/doc/SyncUserMetadataV1.md new file mode 100644 index 0000000000000..bdf4965034a1b --- /dev/null +++ b/mobile/openapi/doc/SyncUserMetadataV1.md @@ -0,0 +1,17 @@ +# openapi.model.SyncUserMetadataV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | [**UserMetadataKey**](UserMetadataKey.md) | | +**userId** | **String** | User ID | +**value** | **Map** | User metadata value | [default to const {}] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SyncUserV1.md b/mobile/openapi/doc/SyncUserV1.md new file mode 100644 index 0000000000000..ba17074e9cc24 --- /dev/null +++ b/mobile/openapi/doc/SyncUserV1.md @@ -0,0 +1,21 @@ +# openapi.model.SyncUserV1 + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**Optional**](UserAvatarColor.md) | | [optional] +**deletedAt** | [**DateTime**](DateTime.md) | User deleted at | +**email** | **String** | User email | +**hasProfileImage** | **bool** | User has profile image | +**id** | **String** | User ID | +**name** | **String** | User name | +**profileChangedAt** | [**DateTime**](DateTime.md) | User profile changed at | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigApi.md b/mobile/openapi/doc/SystemConfigApi.md new file mode 100644 index 0000000000000..22772f3313fc0 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigApi.md @@ -0,0 +1,233 @@ +# openapi.api.SystemConfigApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getConfig**](SystemConfigApi.md#getconfig) | **GET** /system-config | Get system configuration +[**getConfigDefaults**](SystemConfigApi.md#getconfigdefaults) | **GET** /system-config/defaults | Get system configuration defaults +[**getStorageTemplateOptions**](SystemConfigApi.md#getstoragetemplateoptions) | **GET** /system-config/storage-template-options | Get storage template options +[**updateConfig**](SystemConfigApi.md#updateconfig) | **PUT** /system-config | Update system configuration + + +# **getConfig** +> SystemConfigDto getConfig() + +Get system configuration + +Retrieve the current system configuration. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemConfigApi(); + +try { + final result = api_instance.getConfig(); + print(result); +} catch (e) { + print('Exception when calling SystemConfigApi->getConfig: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**SystemConfigDto**](SystemConfigDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getConfigDefaults** +> SystemConfigDto getConfigDefaults() + +Get system configuration defaults + +Retrieve the default values for the system configuration. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemConfigApi(); + +try { + final result = api_instance.getConfigDefaults(); + print(result); +} catch (e) { + print('Exception when calling SystemConfigApi->getConfigDefaults: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**SystemConfigDto**](SystemConfigDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getStorageTemplateOptions** +> SystemConfigTemplateStorageOptionDto getStorageTemplateOptions() + +Get storage template options + +Retrieve exemplary storage template options. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemConfigApi(); + +try { + final result = api_instance.getStorageTemplateOptions(); + print(result); +} catch (e) { + print('Exception when calling SystemConfigApi->getStorageTemplateOptions: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**SystemConfigTemplateStorageOptionDto**](SystemConfigTemplateStorageOptionDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateConfig** +> SystemConfigDto updateConfig(systemConfigDto) + +Update system configuration + +Update the system configuration with a new system configuration. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemConfigApi(); +final systemConfigDto = SystemConfigDto(); // SystemConfigDto | + +try { + final result = api_instance.updateConfig(systemConfigDto); + print(result); +} catch (e) { + print('Exception when calling SystemConfigApi->updateConfig: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **systemConfigDto** | [**SystemConfigDto**](SystemConfigDto.md)| | + +### Return type + +[**SystemConfigDto**](SystemConfigDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/SystemConfigBackupsDto.md b/mobile/openapi/doc/SystemConfigBackupsDto.md new file mode 100644 index 0000000000000..ff57576821ed6 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigBackupsDto.md @@ -0,0 +1,16 @@ +# openapi.model.SystemConfigBackupsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**beta** | **bool** | Whether the backups feature is enabled | +**database** | [**DatabaseBackupConfig**](DatabaseBackupConfig.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigDto.md b/mobile/openapi/doc/SystemConfigDto.md new file mode 100644 index 0000000000000..1b7644f052b32 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigDto.md @@ -0,0 +1,36 @@ +# openapi.model.SystemConfigDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backup** | [**SystemConfigBackupsDto**](SystemConfigBackupsDto.md) | | +**ffmpeg** | [**SystemConfigFFmpegDto**](SystemConfigFFmpegDto.md) | | +**image** | [**SystemConfigImageDto**](SystemConfigImageDto.md) | | +**integrityChecks** | [**SystemConfigIntegrityChecks**](SystemConfigIntegrityChecks.md) | | +**job** | [**SystemConfigJobDto**](SystemConfigJobDto.md) | | +**library_** | [**SystemConfigLibraryDto**](SystemConfigLibraryDto.md) | | +**logging** | [**SystemConfigLoggingDto**](SystemConfigLoggingDto.md) | | +**machineLearning** | [**SystemConfigMachineLearningDto**](SystemConfigMachineLearningDto.md) | | +**map** | [**SystemConfigMapDto**](SystemConfigMapDto.md) | | +**metadata** | [**SystemConfigMetadataDto**](SystemConfigMetadataDto.md) | | +**newVersionCheck** | [**SystemConfigNewVersionCheckDto**](SystemConfigNewVersionCheckDto.md) | | +**nightlyTasks** | [**SystemConfigNightlyTasksDto**](SystemConfigNightlyTasksDto.md) | | +**notifications** | [**SystemConfigNotificationsDto**](SystemConfigNotificationsDto.md) | | +**oauth** | [**SystemConfigOAuthDto**](SystemConfigOAuthDto.md) | | +**passwordLogin** | [**SystemConfigPasswordLoginDto**](SystemConfigPasswordLoginDto.md) | | +**reverseGeocoding** | [**SystemConfigReverseGeocodingDto**](SystemConfigReverseGeocodingDto.md) | | +**server** | [**SystemConfigServerDto**](SystemConfigServerDto.md) | | +**storageTemplate** | [**SystemConfigStorageTemplateDto**](SystemConfigStorageTemplateDto.md) | | +**templates** | [**SystemConfigTemplatesDto**](SystemConfigTemplatesDto.md) | | +**theme** | [**SystemConfigThemeDto**](SystemConfigThemeDto.md) | | +**trash** | [**SystemConfigTrashDto**](SystemConfigTrashDto.md) | | +**user** | [**SystemConfigUserDto**](SystemConfigUserDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigFFmpegDto.md b/mobile/openapi/doc/SystemConfigFFmpegDto.md new file mode 100644 index 0000000000000..e91cbecd19bb5 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigFFmpegDto.md @@ -0,0 +1,36 @@ +# openapi.model.SystemConfigFFmpegDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accel** | [**TranscodeHWAccel**](TranscodeHWAccel.md) | | +**accelDecode** | **bool** | Accelerated decode | +**acceptedAudioCodecs** | [**List**](AudioCodec.md) | Accepted audio codecs | [default to const []] +**acceptedContainers** | [**List**](VideoContainer.md) | Accepted containers | [default to const []] +**acceptedVideoCodecs** | [**List**](VideoCodec.md) | Accepted video codecs | [default to const []] +**bframes** | **int** | B-frames | +**cqMode** | [**CQMode**](CQMode.md) | | +**crf** | **int** | CRF | +**gopSize** | **int** | GOP size | +**maxBitrate** | **String** | Max bitrate | +**preferredHwDevice** | **String** | Preferred hardware device | +**preset** | **String** | Preset | +**realtime** | [**SystemConfigFFmpegRealtimeDto**](SystemConfigFFmpegRealtimeDto.md) | | +**refs** | **int** | References | +**targetAudioCodec** | [**AudioCodec**](AudioCodec.md) | | +**targetResolution** | **String** | Target resolution | +**targetVideoCodec** | [**VideoCodec**](VideoCodec.md) | | +**temporalAQ** | **bool** | Temporal AQ | +**threads** | **int** | Threads | +**tonemap** | [**ToneMapping**](ToneMapping.md) | | +**transcode** | [**TranscodePolicy**](TranscodePolicy.md) | | +**twoPass** | **bool** | Two pass | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigFFmpegRealtimeDto.md b/mobile/openapi/doc/SystemConfigFFmpegRealtimeDto.md new file mode 100644 index 0000000000000..564ad8f9514f0 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigFFmpegRealtimeDto.md @@ -0,0 +1,17 @@ +# openapi.model.SystemConfigFFmpegRealtimeDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enable real-time HLS transcoding (alpha) | +**resolutions** | [**List**](HlsVideoResolution.md) | Resolutions to use for real-time HLS transcoding | [default to const []] +**videoCodecs** | [**List**](VideoCodec.md) | Video codecs to use for real-time HLS transcoding | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigFacesDto.md b/mobile/openapi/doc/SystemConfigFacesDto.md new file mode 100644 index 0000000000000..f7a0a09fcaaf7 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigFacesDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigFacesDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**import_** | **bool** | Import | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigGeneratedFullsizeImageDto.md b/mobile/openapi/doc/SystemConfigGeneratedFullsizeImageDto.md new file mode 100644 index 0000000000000..aea0df24f841a --- /dev/null +++ b/mobile/openapi/doc/SystemConfigGeneratedFullsizeImageDto.md @@ -0,0 +1,18 @@ +# openapi.model.SystemConfigGeneratedFullsizeImageDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enabled | +**format** | [**ImageFormat**](ImageFormat.md) | | +**progressive** | **Optional** | Progressive | [optional] +**quality** | **int** | Quality | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigGeneratedImageDto.md b/mobile/openapi/doc/SystemConfigGeneratedImageDto.md new file mode 100644 index 0000000000000..11a404234ade5 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigGeneratedImageDto.md @@ -0,0 +1,18 @@ +# openapi.model.SystemConfigGeneratedImageDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**format** | [**ImageFormat**](ImageFormat.md) | | +**progressive** | **Optional** | Progressive | [optional] +**quality** | **int** | Quality | +**size** | **int** | Size | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigImageDto.md b/mobile/openapi/doc/SystemConfigImageDto.md new file mode 100644 index 0000000000000..b5c70d1dab5fb --- /dev/null +++ b/mobile/openapi/doc/SystemConfigImageDto.md @@ -0,0 +1,19 @@ +# openapi.model.SystemConfigImageDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**colorspace** | [**Colorspace**](Colorspace.md) | | +**extractEmbedded** | **bool** | Extract embedded | +**fullsize** | [**SystemConfigGeneratedFullsizeImageDto**](SystemConfigGeneratedFullsizeImageDto.md) | | +**preview** | [**SystemConfigGeneratedImageDto**](SystemConfigGeneratedImageDto.md) | | +**thumbnail** | [**SystemConfigGeneratedImageDto**](SystemConfigGeneratedImageDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigIntegrityChecks.md b/mobile/openapi/doc/SystemConfigIntegrityChecks.md new file mode 100644 index 0000000000000..15d166e738fc0 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigIntegrityChecks.md @@ -0,0 +1,17 @@ +# openapi.model.SystemConfigIntegrityChecks + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checksumFiles** | [**SystemConfigIntegrityChecksumJob**](SystemConfigIntegrityChecksumJob.md) | | +**missingFiles** | [**SystemConfigIntegrityJob**](SystemConfigIntegrityJob.md) | | +**untrackedFiles** | [**SystemConfigIntegrityJob**](SystemConfigIntegrityJob.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigIntegrityChecksumJob.md b/mobile/openapi/doc/SystemConfigIntegrityChecksumJob.md new file mode 100644 index 0000000000000..9ea49a1ed5b92 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigIntegrityChecksumJob.md @@ -0,0 +1,18 @@ +# openapi.model.SystemConfigIntegrityChecksumJob + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cronExpression** | **String** | Cron expression for when the integrity check should run | +**enabled** | **bool** | Enabled | +**percentageLimit** | **double** | Percentage limit of the integrity checksum job | +**timeLimit** | **int** | How long the integrity checksum job may run for | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigIntegrityJob.md b/mobile/openapi/doc/SystemConfigIntegrityJob.md new file mode 100644 index 0000000000000..d1f7a9fd48fd4 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigIntegrityJob.md @@ -0,0 +1,16 @@ +# openapi.model.SystemConfigIntegrityJob + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cronExpression** | **String** | Cron expression for when the integrity check should run | +**enabled** | **bool** | Enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigJobDto.md b/mobile/openapi/doc/SystemConfigJobDto.md new file mode 100644 index 0000000000000..a631967ea4435 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigJobDto.md @@ -0,0 +1,29 @@ +# openapi.model.SystemConfigJobDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**backgroundTask** | [**JobSettingsDto**](JobSettingsDto.md) | | +**editor** | [**JobSettingsDto**](JobSettingsDto.md) | | +**faceDetection** | [**JobSettingsDto**](JobSettingsDto.md) | | +**integrityCheck** | [**JobSettingsDto**](JobSettingsDto.md) | | +**library_** | [**JobSettingsDto**](JobSettingsDto.md) | | +**metadataExtraction** | [**JobSettingsDto**](JobSettingsDto.md) | | +**migration** | [**JobSettingsDto**](JobSettingsDto.md) | | +**notifications** | [**JobSettingsDto**](JobSettingsDto.md) | | +**ocr** | [**JobSettingsDto**](JobSettingsDto.md) | | +**search** | [**JobSettingsDto**](JobSettingsDto.md) | | +**sidecar** | [**JobSettingsDto**](JobSettingsDto.md) | | +**smartSearch** | [**JobSettingsDto**](JobSettingsDto.md) | | +**thumbnailGeneration** | [**JobSettingsDto**](JobSettingsDto.md) | | +**videoConversion** | [**JobSettingsDto**](JobSettingsDto.md) | | +**workflow** | [**JobSettingsDto**](JobSettingsDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigLibraryDto.md b/mobile/openapi/doc/SystemConfigLibraryDto.md new file mode 100644 index 0000000000000..919ac367466bb --- /dev/null +++ b/mobile/openapi/doc/SystemConfigLibraryDto.md @@ -0,0 +1,16 @@ +# openapi.model.SystemConfigLibraryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scan** | [**SystemConfigLibraryScanDto**](SystemConfigLibraryScanDto.md) | | +**watch** | [**SystemConfigLibraryWatchDto**](SystemConfigLibraryWatchDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigLibraryScanDto.md b/mobile/openapi/doc/SystemConfigLibraryScanDto.md new file mode 100644 index 0000000000000..9b6dc3aef170e --- /dev/null +++ b/mobile/openapi/doc/SystemConfigLibraryScanDto.md @@ -0,0 +1,16 @@ +# openapi.model.SystemConfigLibraryScanDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cronExpression** | **String** | Cron expression | +**enabled** | **bool** | Enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigLibraryWatchDto.md b/mobile/openapi/doc/SystemConfigLibraryWatchDto.md new file mode 100644 index 0000000000000..6f319245435bd --- /dev/null +++ b/mobile/openapi/doc/SystemConfigLibraryWatchDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigLibraryWatchDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigLoggingDto.md b/mobile/openapi/doc/SystemConfigLoggingDto.md new file mode 100644 index 0000000000000..f7b32e5171cda --- /dev/null +++ b/mobile/openapi/doc/SystemConfigLoggingDto.md @@ -0,0 +1,16 @@ +# openapi.model.SystemConfigLoggingDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enabled | +**level** | [**LogLevel**](LogLevel.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigMachineLearningDto.md b/mobile/openapi/doc/SystemConfigMachineLearningDto.md new file mode 100644 index 0000000000000..f0627f0005f30 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigMachineLearningDto.md @@ -0,0 +1,21 @@ +# openapi.model.SystemConfigMachineLearningDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**availabilityChecks** | [**MachineLearningAvailabilityChecksDto**](MachineLearningAvailabilityChecksDto.md) | | +**clip** | [**CLIPConfig**](CLIPConfig.md) | | +**duplicateDetection** | [**DuplicateDetectionConfig**](DuplicateDetectionConfig.md) | | +**enabled** | **bool** | Enabled | +**facialRecognition** | [**FacialRecognitionConfig**](FacialRecognitionConfig.md) | | +**ocr** | [**OcrConfig**](OcrConfig.md) | | +**urls** | **List** | ML service URLs | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigMapDto.md b/mobile/openapi/doc/SystemConfigMapDto.md new file mode 100644 index 0000000000000..b004d3581e396 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigMapDto.md @@ -0,0 +1,17 @@ +# openapi.model.SystemConfigMapDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**darkStyle** | **String** | Dark map style URL | +**enabled** | **bool** | Enabled | +**lightStyle** | **String** | Light map style URL | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigMetadataDto.md b/mobile/openapi/doc/SystemConfigMetadataDto.md new file mode 100644 index 0000000000000..30999081a8bdb --- /dev/null +++ b/mobile/openapi/doc/SystemConfigMetadataDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigMetadataDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**faces** | [**SystemConfigFacesDto**](SystemConfigFacesDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigNewVersionCheckDto.md b/mobile/openapi/doc/SystemConfigNewVersionCheckDto.md new file mode 100644 index 0000000000000..374645ca41460 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigNewVersionCheckDto.md @@ -0,0 +1,16 @@ +# openapi.model.SystemConfigNewVersionCheckDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**channel** | [**ReleaseChannel**](ReleaseChannel.md) | | +**enabled** | **bool** | Enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigNightlyTasksDto.md b/mobile/openapi/doc/SystemConfigNightlyTasksDto.md new file mode 100644 index 0000000000000..cb6f7cabff33f --- /dev/null +++ b/mobile/openapi/doc/SystemConfigNightlyTasksDto.md @@ -0,0 +1,20 @@ +# openapi.model.SystemConfigNightlyTasksDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clusterNewFaces** | **bool** | Cluster new faces | +**databaseCleanup** | **bool** | Database cleanup | +**generateMemories** | **bool** | Generate memories | +**missingThumbnails** | **bool** | Missing thumbnails | +**startTime** | **String** | Start time (HH:MM) | +**syncQuotaUsage** | **bool** | Sync quota usage | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigNotificationsDto.md b/mobile/openapi/doc/SystemConfigNotificationsDto.md new file mode 100644 index 0000000000000..6d91c18c839f0 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigNotificationsDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigNotificationsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**smtp** | [**SystemConfigSmtpDto**](SystemConfigSmtpDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigOAuthDto.md b/mobile/openapi/doc/SystemConfigOAuthDto.md new file mode 100644 index 0000000000000..35a385a7ed4ba --- /dev/null +++ b/mobile/openapi/doc/SystemConfigOAuthDto.md @@ -0,0 +1,35 @@ +# openapi.model.SystemConfigOAuthDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowInsecureRequests** | **bool** | Allow insecure requests | +**autoLaunch** | **bool** | Auto launch | +**autoRegister** | **bool** | Auto register | +**buttonText** | **String** | Button text | +**clientId** | **String** | Client ID | +**clientSecret** | **String** | Client secret | +**defaultStorageQuota** | **int** | Default storage quota | +**enabled** | **bool** | Enabled | +**endSessionEndpoint** | **String** | End session endpoint | +**issuerUrl** | **String** | Issuer URL | +**mobileOverrideEnabled** | **bool** | Mobile override enabled | +**mobileRedirectUri** | **String** | Mobile redirect URI (set to empty string to disable) | +**profileSigningAlgorithm** | **String** | Profile signing algorithm | +**prompt** | **String** | OAuth prompt parameter (e.g. select_account, login, consent) | +**roleClaim** | **String** | Role claim | +**scope** | **String** | Scope | +**signingAlgorithm** | **String** | Signing algorithm | +**storageLabelClaim** | **String** | Storage label claim | +**storageQuotaClaim** | **String** | Storage quota claim | +**timeout** | **int** | Timeout | +**tokenEndpointAuthMethod** | [**OAuthTokenEndpointAuthMethod**](OAuthTokenEndpointAuthMethod.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigPasswordLoginDto.md b/mobile/openapi/doc/SystemConfigPasswordLoginDto.md new file mode 100644 index 0000000000000..30a9228c2d58e --- /dev/null +++ b/mobile/openapi/doc/SystemConfigPasswordLoginDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigPasswordLoginDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigReverseGeocodingDto.md b/mobile/openapi/doc/SystemConfigReverseGeocodingDto.md new file mode 100644 index 0000000000000..59ffe10205293 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigReverseGeocodingDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigReverseGeocodingDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigServerDto.md b/mobile/openapi/doc/SystemConfigServerDto.md new file mode 100644 index 0000000000000..20d800652b5f5 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigServerDto.md @@ -0,0 +1,17 @@ +# openapi.model.SystemConfigServerDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**externalDomain** | **String** | External domain | +**loginPageMessage** | **String** | Login page message | +**publicUsers** | **bool** | Public users | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigSmtpDto.md b/mobile/openapi/doc/SystemConfigSmtpDto.md new file mode 100644 index 0000000000000..037dd44e03d2b --- /dev/null +++ b/mobile/openapi/doc/SystemConfigSmtpDto.md @@ -0,0 +1,18 @@ +# openapi.model.SystemConfigSmtpDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether SMTP email notifications are enabled | +**from** | **String** | Email address to send from | +**replyTo** | **String** | Email address for replies | +**transport** | [**SystemConfigSmtpTransportDto**](SystemConfigSmtpTransportDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigSmtpTransportDto.md b/mobile/openapi/doc/SystemConfigSmtpTransportDto.md new file mode 100644 index 0000000000000..69edb9d177fd9 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigSmtpTransportDto.md @@ -0,0 +1,20 @@ +# openapi.model.SystemConfigSmtpTransportDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**host** | **String** | SMTP server hostname | +**ignoreCert** | **bool** | Whether to ignore SSL certificate errors | +**password** | **String** | SMTP password | +**port** | **int** | SMTP server port | +**secure** | **bool** | Whether to use secure connection (TLS/SSL) | +**username** | **String** | SMTP username | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigStorageTemplateDto.md b/mobile/openapi/doc/SystemConfigStorageTemplateDto.md new file mode 100644 index 0000000000000..fb72a617ed135 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigStorageTemplateDto.md @@ -0,0 +1,17 @@ +# openapi.model.SystemConfigStorageTemplateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Enabled | +**hashVerificationEnabled** | **bool** | Hash verification enabled | +**template** | **String** | Template | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigTemplateEmailsDto.md b/mobile/openapi/doc/SystemConfigTemplateEmailsDto.md new file mode 100644 index 0000000000000..d842436940945 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigTemplateEmailsDto.md @@ -0,0 +1,17 @@ +# openapi.model.SystemConfigTemplateEmailsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumInviteTemplate** | **String** | Album invite template | +**albumUpdateTemplate** | **String** | Album update template | +**welcomeTemplate** | **String** | Welcome template | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigTemplateStorageOptionDto.md b/mobile/openapi/doc/SystemConfigTemplateStorageOptionDto.md new file mode 100644 index 0000000000000..876beebe41b38 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigTemplateStorageOptionDto.md @@ -0,0 +1,22 @@ +# openapi.model.SystemConfigTemplateStorageOptionDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dayOptions** | **List** | Available day format options for storage template | [default to const []] +**hourOptions** | **List** | Available hour format options for storage template | [default to const []] +**minuteOptions** | **List** | Available minute format options for storage template | [default to const []] +**monthOptions** | **List** | Available month format options for storage template | [default to const []] +**presetOptions** | **List** | Available preset template options | [default to const []] +**secondOptions** | **List** | Available second format options for storage template | [default to const []] +**weekOptions** | **List** | Available week format options for storage template | [default to const []] +**yearOptions** | **List** | Available year format options for storage template | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigTemplatesDto.md b/mobile/openapi/doc/SystemConfigTemplatesDto.md new file mode 100644 index 0000000000000..843a3713fb096 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigTemplatesDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigTemplatesDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | [**SystemConfigTemplateEmailsDto**](SystemConfigTemplateEmailsDto.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigThemeDto.md b/mobile/openapi/doc/SystemConfigThemeDto.md new file mode 100644 index 0000000000000..7e6b597e8300e --- /dev/null +++ b/mobile/openapi/doc/SystemConfigThemeDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigThemeDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customCss** | **String** | Custom CSS for theming | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigTrashDto.md b/mobile/openapi/doc/SystemConfigTrashDto.md new file mode 100644 index 0000000000000..4390fbc9d9745 --- /dev/null +++ b/mobile/openapi/doc/SystemConfigTrashDto.md @@ -0,0 +1,16 @@ +# openapi.model.SystemConfigTrashDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**days** | **int** | Days | +**enabled** | **bool** | Enabled | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemConfigUserDto.md b/mobile/openapi/doc/SystemConfigUserDto.md new file mode 100644 index 0000000000000..331218224310d --- /dev/null +++ b/mobile/openapi/doc/SystemConfigUserDto.md @@ -0,0 +1,15 @@ +# openapi.model.SystemConfigUserDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deleteDelay** | **int** | Delete delay | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/SystemMetadataApi.md b/mobile/openapi/doc/SystemMetadataApi.md new file mode 100644 index 0000000000000..52e9982c7a31d --- /dev/null +++ b/mobile/openapi/doc/SystemMetadataApi.md @@ -0,0 +1,232 @@ +# openapi.api.SystemMetadataApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAdminOnboarding**](SystemMetadataApi.md#getadminonboarding) | **GET** /system-metadata/admin-onboarding | Retrieve admin onboarding +[**getReverseGeocodingState**](SystemMetadataApi.md#getreversegeocodingstate) | **GET** /system-metadata/reverse-geocoding-state | Retrieve reverse geocoding state +[**getVersionCheckState**](SystemMetadataApi.md#getversioncheckstate) | **GET** /system-metadata/version-check-state | Retrieve version check state +[**updateAdminOnboarding**](SystemMetadataApi.md#updateadminonboarding) | **POST** /system-metadata/admin-onboarding | Update admin onboarding + + +# **getAdminOnboarding** +> AdminOnboardingUpdateDto getAdminOnboarding() + +Retrieve admin onboarding + +Retrieve the current admin onboarding status. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemMetadataApi(); + +try { + final result = api_instance.getAdminOnboarding(); + print(result); +} catch (e) { + print('Exception when calling SystemMetadataApi->getAdminOnboarding: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**AdminOnboardingUpdateDto**](AdminOnboardingUpdateDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getReverseGeocodingState** +> ReverseGeocodingStateResponseDto getReverseGeocodingState() + +Retrieve reverse geocoding state + +Retrieve the current state of the reverse geocoding import. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemMetadataApi(); + +try { + final result = api_instance.getReverseGeocodingState(); + print(result); +} catch (e) { + print('Exception when calling SystemMetadataApi->getReverseGeocodingState: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**ReverseGeocodingStateResponseDto**](ReverseGeocodingStateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getVersionCheckState** +> VersionCheckStateResponseDto getVersionCheckState() + +Retrieve version check state + +Retrieve the current state of the version check process. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemMetadataApi(); + +try { + final result = api_instance.getVersionCheckState(); + print(result); +} catch (e) { + print('Exception when calling SystemMetadataApi->getVersionCheckState: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**VersionCheckStateResponseDto**](VersionCheckStateResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateAdminOnboarding** +> updateAdminOnboarding(adminOnboardingUpdateDto) + +Update admin onboarding + +Update the admin onboarding status. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = SystemMetadataApi(); +final adminOnboardingUpdateDto = AdminOnboardingUpdateDto(); // AdminOnboardingUpdateDto | + +try { + api_instance.updateAdminOnboarding(adminOnboardingUpdateDto); +} catch (e) { + print('Exception when calling SystemMetadataApi->updateAdminOnboarding: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **adminOnboardingUpdateDto** | [**AdminOnboardingUpdateDto**](AdminOnboardingUpdateDto.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/TagBulkAssetsDto.md b/mobile/openapi/doc/TagBulkAssetsDto.md new file mode 100644 index 0000000000000..edb05945d0a49 --- /dev/null +++ b/mobile/openapi/doc/TagBulkAssetsDto.md @@ -0,0 +1,16 @@ +# openapi.model.TagBulkAssetsDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assetIds** | **List** | Asset IDs | [default to const []] +**tagIds** | **List** | Tag IDs | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TagBulkAssetsResponseDto.md b/mobile/openapi/doc/TagBulkAssetsResponseDto.md new file mode 100644 index 0000000000000..dc9930800f5b3 --- /dev/null +++ b/mobile/openapi/doc/TagBulkAssetsResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.TagBulkAssetsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Number of assets tagged | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TagCreateDto.md b/mobile/openapi/doc/TagCreateDto.md new file mode 100644 index 0000000000000..56538b26e0818 --- /dev/null +++ b/mobile/openapi/doc/TagCreateDto.md @@ -0,0 +1,17 @@ +# openapi.model.TagCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | **Optional** | Tag color (hex) | [optional] +**name** | **String** | Tag name | +**parentId** | **Optional** | Parent tag ID | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TagResponseDto.md b/mobile/openapi/doc/TagResponseDto.md new file mode 100644 index 0000000000000..28240bd68e1fc --- /dev/null +++ b/mobile/openapi/doc/TagResponseDto.md @@ -0,0 +1,21 @@ +# openapi.model.TagResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | **Optional** | Tag color (hex) | [optional] +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**id** | **String** | Tag ID | +**name** | **String** | Tag name | +**parentId** | **Optional** | Parent tag ID | [optional] +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | +**value** | **String** | Tag value (full path) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TagUpdateDto.md b/mobile/openapi/doc/TagUpdateDto.md new file mode 100644 index 0000000000000..60bafb76453d3 --- /dev/null +++ b/mobile/openapi/doc/TagUpdateDto.md @@ -0,0 +1,15 @@ +# openapi.model.TagUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | **Optional** | Tag color (hex) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TagUpsertDto.md b/mobile/openapi/doc/TagUpsertDto.md new file mode 100644 index 0000000000000..8aae221dd2394 --- /dev/null +++ b/mobile/openapi/doc/TagUpsertDto.md @@ -0,0 +1,15 @@ +# openapi.model.TagUpsertDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tags** | **List** | Tag names to upsert | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TagsApi.md b/mobile/openapi/doc/TagsApi.md new file mode 100644 index 0000000000000..ec54ace768137 --- /dev/null +++ b/mobile/openapi/doc/TagsApi.md @@ -0,0 +1,536 @@ +# openapi.api.TagsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**bulkTagAssets**](TagsApi.md#bulktagassets) | **PUT** /tags/assets | Tag assets +[**createTag**](TagsApi.md#createtag) | **POST** /tags | Create a tag +[**deleteTag**](TagsApi.md#deletetag) | **DELETE** /tags/{id} | Delete a tag +[**getAllTags**](TagsApi.md#getalltags) | **GET** /tags | Retrieve tags +[**getTagById**](TagsApi.md#gettagbyid) | **GET** /tags/{id} | Retrieve a tag +[**tagAssets**](TagsApi.md#tagassets) | **PUT** /tags/{id}/assets | Tag assets +[**untagAssets**](TagsApi.md#untagassets) | **DELETE** /tags/{id}/assets | Untag assets +[**updateTag**](TagsApi.md#updatetag) | **PUT** /tags/{id} | Update a tag +[**upsertTags**](TagsApi.md#upserttags) | **PUT** /tags | Upsert tags + + +# **bulkTagAssets** +> TagBulkAssetsResponseDto bulkTagAssets(tagBulkAssetsDto) + +Tag assets + +Add multiple tags to multiple assets in a single request. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final tagBulkAssetsDto = TagBulkAssetsDto(); // TagBulkAssetsDto | + +try { + final result = api_instance.bulkTagAssets(tagBulkAssetsDto); + print(result); +} catch (e) { + print('Exception when calling TagsApi->bulkTagAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tagBulkAssetsDto** | [**TagBulkAssetsDto**](TagBulkAssetsDto.md)| | + +### Return type + +[**TagBulkAssetsResponseDto**](TagBulkAssetsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **createTag** +> TagResponseDto createTag(tagCreateDto) + +Create a tag + +Create a new tag by providing a name and optional color. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final tagCreateDto = TagCreateDto(); // TagCreateDto | + +try { + final result = api_instance.createTag(tagCreateDto); + print(result); +} catch (e) { + print('Exception when calling TagsApi->createTag: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tagCreateDto** | [**TagCreateDto**](TagCreateDto.md)| | + +### Return type + +[**TagResponseDto**](TagResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteTag** +> deleteTag(id) + +Delete a tag + +Delete a specific tag by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteTag(id); +} catch (e) { + print('Exception when calling TagsApi->deleteTag: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getAllTags** +> List getAllTags() + +Retrieve tags + +Retrieve a list of all tags. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); + +try { + final result = api_instance.getAllTags(); + print(result); +} catch (e) { + print('Exception when calling TagsApi->getAllTags: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](TagResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getTagById** +> TagResponseDto getTagById(id) + +Retrieve a tag + +Retrieve a specific tag by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getTagById(id); + print(result); +} catch (e) { + print('Exception when calling TagsApi->getTagById: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**TagResponseDto**](TagResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **tagAssets** +> List tagAssets(id, bulkIdsDto) + +Tag assets + +Add a tag to all the specified assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + final result = api_instance.tagAssets(id, bulkIdsDto); + print(result); +} catch (e) { + print('Exception when calling TagsApi->tagAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **untagAssets** +> List untagAssets(id, bulkIdsDto) + +Untag assets + +Remove a tag from all the specified assets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + final result = api_instance.untagAssets(id, bulkIdsDto); + print(result); +} catch (e) { + print('Exception when calling TagsApi->untagAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +[**List**](BulkIdResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateTag** +> TagResponseDto updateTag(id, tagUpdateDto) + +Update a tag + +Update an existing tag identified by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final tagUpdateDto = TagUpdateDto(); // TagUpdateDto | + +try { + final result = api_instance.updateTag(id, tagUpdateDto); + print(result); +} catch (e) { + print('Exception when calling TagsApi->updateTag: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **tagUpdateDto** | [**TagUpdateDto**](TagUpdateDto.md)| | + +### Return type + +[**TagResponseDto**](TagResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upsertTags** +> List upsertTags(tagUpsertDto) + +Upsert tags + +Create or update multiple tags in a single request. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TagsApi(); +final tagUpsertDto = TagUpsertDto(); // TagUpsertDto | + +try { + final result = api_instance.upsertTags(tagUpsertDto); + print(result); +} catch (e) { + print('Exception when calling TagsApi->upsertTags: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tagUpsertDto** | [**TagUpsertDto**](TagUpsertDto.md)| | + +### Return type + +[**List**](TagResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/TagsResponse.md b/mobile/openapi/doc/TagsResponse.md new file mode 100644 index 0000000000000..6f503b8eb4d63 --- /dev/null +++ b/mobile/openapi/doc/TagsResponse.md @@ -0,0 +1,16 @@ +# openapi.model.TagsResponse + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether tags are enabled | +**sidebarWeb** | **bool** | Whether tags appear in web sidebar | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TagsUpdate.md b/mobile/openapi/doc/TagsUpdate.md new file mode 100644 index 0000000000000..f9eee7d717563 --- /dev/null +++ b/mobile/openapi/doc/TagsUpdate.md @@ -0,0 +1,16 @@ +# openapi.model.TagsUpdate + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **Optional** | Whether tags are enabled | [optional] +**sidebarWeb** | **Optional** | Whether tags appear in web sidebar | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TaskStatus.md b/mobile/openapi/doc/TaskStatus.md new file mode 100644 index 0000000000000..af5f3adabb600 --- /dev/null +++ b/mobile/openapi/doc/TaskStatus.md @@ -0,0 +1,14 @@ +# openapi.model.TaskStatus + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TaskType.md b/mobile/openapi/doc/TaskType.md new file mode 100644 index 0000000000000..fab06af362df8 --- /dev/null +++ b/mobile/openapi/doc/TaskType.md @@ -0,0 +1,14 @@ +# openapi.model.TaskType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TelemetryLevel.md b/mobile/openapi/doc/TelemetryLevel.md new file mode 100644 index 0000000000000..f2a573625e149 --- /dev/null +++ b/mobile/openapi/doc/TelemetryLevel.md @@ -0,0 +1,14 @@ +# openapi.model.TelemetryLevel + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TemplateDto.md b/mobile/openapi/doc/TemplateDto.md new file mode 100644 index 0000000000000..28c7c93d0f690 --- /dev/null +++ b/mobile/openapi/doc/TemplateDto.md @@ -0,0 +1,15 @@ +# openapi.model.TemplateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**template** | **String** | Template name | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TemplateResponseDto.md b/mobile/openapi/doc/TemplateResponseDto.md new file mode 100644 index 0000000000000..8fdb716852586 --- /dev/null +++ b/mobile/openapi/doc/TemplateResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.TemplateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**html** | **String** | Template HTML content | +**name** | **String** | Template name | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TestEmailResponseDto.md b/mobile/openapi/doc/TestEmailResponseDto.md new file mode 100644 index 0000000000000..b5a456aeed016 --- /dev/null +++ b/mobile/openapi/doc/TestEmailResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.TestEmailResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**messageId** | **String** | Email message ID | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TimeBucketAssetResponseDto.md b/mobile/openapi/doc/TimeBucketAssetResponseDto.md new file mode 100644 index 0000000000000..e47826e29cf54 --- /dev/null +++ b/mobile/openapi/doc/TimeBucketAssetResponseDto.md @@ -0,0 +1,33 @@ +# openapi.model.TimeBucketAssetResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**city** | **Optional?>** | Array of city names extracted from EXIF GPS data | [optional] [default to const []] +**country** | **Optional?>** | Array of country names extracted from EXIF GPS data | [optional] [default to const []] +**createdAt** | **List** | Array of UTC timestamps when each asset was originally uploaded to Immich | [default to const []] +**duration** | **List** | Array of video/gif durations in milliseconds (null for static images) | [default to const []] +**fileCreatedAt** | **List** | Array of file creation timestamps in UTC | [default to const []] +**id** | **List** | Array of asset IDs in the time bucket | [default to const []] +**isFavorite** | **List** | Array indicating whether each asset is favorited | [default to const []] +**isImage** | **List** | Array indicating whether each asset is an image (false for videos) | [default to const []] +**isTrashed** | **List** | Array indicating whether each asset is in the trash | [default to const []] +**latitude** | **Optional?>** | Array of latitude coordinates extracted from EXIF GPS data | [optional] [default to const []] +**livePhotoVideoId** | **List** | Array of live photo video asset IDs (null for non-live photos) | [default to const []] +**localOffsetHours** | **List** | Array of UTC offset hours at the time each photo was taken. Positive values are east of UTC, negative values are west of UTC. Values may be fractional (e.g., 5.5 for +05:30, -9.75 for -09:45). Applying this offset to 'fileCreatedAt' will give you the time the photo was taken from the photographer's perspective. | [default to const []] +**longitude** | **Optional?>** | Array of longitude coordinates extracted from EXIF GPS data | [optional] [default to const []] +**ownerId** | **List** | Array of owner IDs for each asset | [default to const []] +**projectionType** | **List** | Array of projection types for 360° content (e.g., \"EQUIRECTANGULAR\", \"CUBEFACE\", \"CYLINDRICAL\") | [default to const []] +**ratio** | **List** | Array of aspect ratios (width/height) for each asset | [default to const []] +**stack** | [**Optional?>?>**](List.md) | Array of stack information as [stackId, assetCount] tuples (null for non-stacked assets) | [optional] [default to const []] +**thumbhash** | **List** | Array of BlurHash strings for generating asset previews (base64 encoded) | [default to const []] +**visibility** | [**List**](AssetVisibility.md) | Array of visibility statuses for each asset (e.g., ARCHIVE, TIMELINE, HIDDEN, LOCKED) | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TimeBucketsResponseDto.md b/mobile/openapi/doc/TimeBucketsResponseDto.md new file mode 100644 index 0000000000000..0318c121f7bef --- /dev/null +++ b/mobile/openapi/doc/TimeBucketsResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.TimeBucketsResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Number of assets in this time bucket | +**timeBucket** | **String** | Time bucket identifier in YYYY-MM-DD format representing the start of the time period | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TimelineApi.md b/mobile/openapi/doc/TimelineApi.md new file mode 100644 index 0000000000000..40a20794401a4 --- /dev/null +++ b/mobile/openapi/doc/TimelineApi.md @@ -0,0 +1,187 @@ +# openapi.api.TimelineApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getTimeBucket**](TimelineApi.md#gettimebucket) | **GET** /timeline/bucket | Get time bucket +[**getTimeBuckets**](TimelineApi.md#gettimebuckets) | **GET** /timeline/buckets | Get time buckets + + +# **getTimeBucket** +> TimeBucketAssetResponseDto getTimeBucket(timeBucket, albumId, bbox, isFavorite, isTrashed, key, order, orderBy, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked) + +Get time bucket + +Retrieve a string of all asset ids in a given time bucket. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TimelineApi(); +final timeBucket = 2024-01-01; // String | Time bucket identifier in YYYY-MM-DD format +final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets belonging to a specific album +final bbox = 11.075683,49.416711,11.117589,49.454875; // String | Bounding box coordinates as west,south,east,north (WGS84) +final isFavorite = true; // bool | Filter by favorite status (true for favorites only, false for non-favorites only) +final isTrashed = true; // bool | Filter by trash status (true for trashed assets only, false for non-trashed only) +final key = key_example; // String | +final order = ; // AssetOrder | Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) +final orderBy = ; // AssetOrderBy | Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) +final personId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets containing a specific person (face recognition) +final slug = slug_example; // String | +final tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets with a specific tag +final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets by specific user ID +final visibility = ; // AssetVisibility | Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) +final withCoordinates = true; // bool | Include location data in the response +final withPartners = true; // bool | Include assets shared by partners +final withStacked = true; // bool | Include stacked assets in the response. When true, only primary assets from stacks are returned. + +try { + final result = api_instance.getTimeBucket(timeBucket, albumId, bbox, isFavorite, isTrashed, key, order, orderBy, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked); + print(result); +} catch (e) { + print('Exception when calling TimelineApi->getTimeBucket: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **timeBucket** | **String**| Time bucket identifier in YYYY-MM-DD format | + **albumId** | **String**| Filter assets belonging to a specific album | [optional] + **bbox** | **String**| Bounding box coordinates as west,south,east,north (WGS84) | [optional] + **isFavorite** | **bool**| Filter by favorite status (true for favorites only, false for non-favorites only) | [optional] + **isTrashed** | **bool**| Filter by trash status (true for trashed assets only, false for non-trashed only) | [optional] + **key** | **String**| | [optional] + **order** | [**AssetOrder**](.md)| Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) | [optional] + **orderBy** | [**AssetOrderBy**](.md)| Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) | [optional] + **personId** | **String**| Filter assets containing a specific person (face recognition) | [optional] + **slug** | **String**| | [optional] + **tagId** | **String**| Filter assets with a specific tag | [optional] + **userId** | **String**| Filter assets by specific user ID | [optional] + **visibility** | [**AssetVisibility**](.md)| Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) | [optional] + **withCoordinates** | **bool**| Include location data in the response | [optional] + **withPartners** | **bool**| Include assets shared by partners | [optional] + **withStacked** | **bool**| Include stacked assets in the response. When true, only primary assets from stacks are returned. | [optional] + +### Return type + +[**TimeBucketAssetResponseDto**](TimeBucketAssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getTimeBuckets** +> List getTimeBuckets(albumId, bbox, isFavorite, isTrashed, key, order, orderBy, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked) + +Get time buckets + +Retrieve a list of all minimal time buckets. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TimelineApi(); +final albumId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets belonging to a specific album +final bbox = 11.075683,49.416711,11.117589,49.454875; // String | Bounding box coordinates as west,south,east,north (WGS84) +final isFavorite = true; // bool | Filter by favorite status (true for favorites only, false for non-favorites only) +final isTrashed = true; // bool | Filter by trash status (true for trashed assets only, false for non-trashed only) +final key = key_example; // String | +final order = ; // AssetOrder | Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) +final orderBy = ; // AssetOrderBy | Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) +final personId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets containing a specific person (face recognition) +final slug = slug_example; // String | +final tagId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets with a specific tag +final userId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter assets by specific user ID +final visibility = ; // AssetVisibility | Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) +final withCoordinates = true; // bool | Include location data in the response +final withPartners = true; // bool | Include assets shared by partners +final withStacked = true; // bool | Include stacked assets in the response. When true, only primary assets from stacks are returned. + +try { + final result = api_instance.getTimeBuckets(albumId, bbox, isFavorite, isTrashed, key, order, orderBy, personId, slug, tagId, userId, visibility, withCoordinates, withPartners, withStacked); + print(result); +} catch (e) { + print('Exception when calling TimelineApi->getTimeBuckets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **albumId** | **String**| Filter assets belonging to a specific album | [optional] + **bbox** | **String**| Bounding box coordinates as west,south,east,north (WGS84) | [optional] + **isFavorite** | **bool**| Filter by favorite status (true for favorites only, false for non-favorites only) | [optional] + **isTrashed** | **bool**| Filter by trash status (true for trashed assets only, false for non-trashed only) | [optional] + **key** | **String**| | [optional] + **order** | [**AssetOrder**](.md)| Sort order for assets within time buckets (ASC for oldest first, DESC for newest first) | [optional] + **orderBy** | [**AssetOrderBy**](.md)| Date to group and order assets by (takenAt for date taken, createdAt for date added to Immich) | [optional] + **personId** | **String**| Filter assets containing a specific person (face recognition) | [optional] + **slug** | **String**| | [optional] + **tagId** | **String**| Filter assets with a specific tag | [optional] + **userId** | **String**| Filter assets by specific user ID | [optional] + **visibility** | [**AssetVisibility**](.md)| Filter by asset visibility status (ARCHIVE, TIMELINE, HIDDEN, LOCKED) | [optional] + **withCoordinates** | **bool**| Include location data in the response | [optional] + **withPartners** | **bool**| Include assets shared by partners | [optional] + **withStacked** | **bool**| Include stacked assets in the response. When true, only primary assets from stacks are returned. | [optional] + +### Return type + +[**List**](TimeBucketsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/ToneMapping.md b/mobile/openapi/doc/ToneMapping.md new file mode 100644 index 0000000000000..5f3575c45f3a1 --- /dev/null +++ b/mobile/openapi/doc/ToneMapping.md @@ -0,0 +1,14 @@ +# openapi.model.ToneMapping + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TranscodeHWAccel.md b/mobile/openapi/doc/TranscodeHWAccel.md new file mode 100644 index 0000000000000..c03f561660c0c --- /dev/null +++ b/mobile/openapi/doc/TranscodeHWAccel.md @@ -0,0 +1,14 @@ +# openapi.model.TranscodeHWAccel + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TranscodePolicy.md b/mobile/openapi/doc/TranscodePolicy.md new file mode 100644 index 0000000000000..bf6b88cd3afcd --- /dev/null +++ b/mobile/openapi/doc/TranscodePolicy.md @@ -0,0 +1,14 @@ +# openapi.model.TranscodePolicy + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/TrashApi.md b/mobile/openapi/doc/TrashApi.md new file mode 100644 index 0000000000000..119abd92beea6 --- /dev/null +++ b/mobile/openapi/doc/TrashApi.md @@ -0,0 +1,179 @@ +# openapi.api.TrashApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**emptyTrash**](TrashApi.md#emptytrash) | **POST** /trash/empty | Empty trash +[**restoreAssets**](TrashApi.md#restoreassets) | **POST** /trash/restore/assets | Restore assets +[**restoreTrash**](TrashApi.md#restoretrash) | **POST** /trash/restore | Restore trash + + +# **emptyTrash** +> TrashResponseDto emptyTrash() + +Empty trash + +Permanently delete all items in the trash. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TrashApi(); + +try { + final result = api_instance.emptyTrash(); + print(result); +} catch (e) { + print('Exception when calling TrashApi->emptyTrash: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**TrashResponseDto**](TrashResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restoreAssets** +> TrashResponseDto restoreAssets(bulkIdsDto) + +Restore assets + +Restore specific assets from the trash. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TrashApi(); +final bulkIdsDto = BulkIdsDto(); // BulkIdsDto | + +try { + final result = api_instance.restoreAssets(bulkIdsDto); + print(result); +} catch (e) { + print('Exception when calling TrashApi->restoreAssets: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulkIdsDto** | [**BulkIdsDto**](BulkIdsDto.md)| | + +### Return type + +[**TrashResponseDto**](TrashResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restoreTrash** +> TrashResponseDto restoreTrash() + +Restore trash + +Restore all items in the trash. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = TrashApi(); + +try { + final result = api_instance.restoreTrash(); + print(result); +} catch (e) { + print('Exception when calling TrashApi->restoreTrash: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**TrashResponseDto**](TrashResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/TrashResponseDto.md b/mobile/openapi/doc/TrashResponseDto.md new file mode 100644 index 0000000000000..7cd7521f171a8 --- /dev/null +++ b/mobile/openapi/doc/TrashResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.TrashResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | Number of items in trash | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UpdateAlbumDto.md b/mobile/openapi/doc/UpdateAlbumDto.md new file mode 100644 index 0000000000000..3c37865a36e9c --- /dev/null +++ b/mobile/openapi/doc/UpdateAlbumDto.md @@ -0,0 +1,19 @@ +# openapi.model.UpdateAlbumDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albumName** | **Optional** | Album name | [optional] +**albumThumbnailAssetId** | **Optional** | Album thumbnail asset ID | [optional] +**description** | **Optional** | Album description | [optional] +**isActivityEnabled** | **Optional** | Enable activity feed | [optional] +**order** | [**Optional**](AssetOrder.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UpdateAlbumUserDto.md b/mobile/openapi/doc/UpdateAlbumUserDto.md new file mode 100644 index 0000000000000..1a1050b4db8cb --- /dev/null +++ b/mobile/openapi/doc/UpdateAlbumUserDto.md @@ -0,0 +1,15 @@ +# openapi.model.UpdateAlbumUserDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | [**AlbumUserRole**](AlbumUserRole.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UpdateAssetDto.md b/mobile/openapi/doc/UpdateAssetDto.md new file mode 100644 index 0000000000000..59164b9aafbf7 --- /dev/null +++ b/mobile/openapi/doc/UpdateAssetDto.md @@ -0,0 +1,22 @@ +# openapi.model.UpdateAssetDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dateTimeOriginal** | **Optional** | Original date and time | [optional] +**description** | **Optional** | Asset description | [optional] +**isFavorite** | **Optional** | Mark as favorite | [optional] +**latitude** | **Optional** | Latitude coordinate | [optional] +**livePhotoVideoId** | **Optional** | Live photo video ID | [optional] +**longitude** | **Optional** | Longitude coordinate | [optional] +**rating** | **Optional** | Rating in range [1-5] (starred), -1 (rejected), or null (unrated) | [optional] +**visibility** | [**Optional**](AssetVisibility.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UpdateLibraryDto.md b/mobile/openapi/doc/UpdateLibraryDto.md new file mode 100644 index 0000000000000..26addb508f003 --- /dev/null +++ b/mobile/openapi/doc/UpdateLibraryDto.md @@ -0,0 +1,17 @@ +# openapi.model.UpdateLibraryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclusionPatterns** | **Optional?>** | Exclusion patterns (max 128) | [optional] [default to const []] +**importPaths** | **Optional?>** | Import paths (max 128) | [optional] [default to const []] +**name** | **Optional** | Library name | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UsageByUserDto.md b/mobile/openapi/doc/UsageByUserDto.md new file mode 100644 index 0000000000000..0018012c4f46c --- /dev/null +++ b/mobile/openapi/doc/UsageByUserDto.md @@ -0,0 +1,22 @@ +# openapi.model.UsageByUserDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**photos** | **int** | Number of photos | +**quotaSizeInBytes** | **int** | User quota size in bytes (null if unlimited) | +**usage** | **int** | Total storage usage in bytes | +**usagePhotos** | **int** | Storage usage for photos in bytes | +**usageVideos** | **int** | Storage usage for videos in bytes | +**userId** | **String** | User ID | +**userName** | **String** | User name | +**videos** | **int** | Number of videos | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserAdminCreateDto.md b/mobile/openapi/doc/UserAdminCreateDto.md new file mode 100644 index 0000000000000..14be12a4e22ad --- /dev/null +++ b/mobile/openapi/doc/UserAdminCreateDto.md @@ -0,0 +1,24 @@ +# openapi.model.UserAdminCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**Optional**](UserAvatarColor.md) | | [optional] +**email** | **String** | User email | +**isAdmin** | **Optional** | Grant admin privileges | [optional] +**name** | **String** | User name | +**notify** | **Optional** | Send notification email | [optional] +**password** | **String** | User password | +**pinCode** | **Optional** | PIN code | [optional] +**quotaSizeInBytes** | **Optional** | Storage quota in bytes | [optional] +**shouldChangePassword** | **Optional** | Require password change on next login | [optional] +**storageLabel** | **Optional** | Storage label | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserAdminDeleteDto.md b/mobile/openapi/doc/UserAdminDeleteDto.md new file mode 100644 index 0000000000000..4c6a73d4ffe1b --- /dev/null +++ b/mobile/openapi/doc/UserAdminDeleteDto.md @@ -0,0 +1,15 @@ +# openapi.model.UserAdminDeleteDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**force** | **Optional** | Force delete even if user has assets | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserAdminResponseDto.md b/mobile/openapi/doc/UserAdminResponseDto.md new file mode 100644 index 0000000000000..108bd4b1ea0b8 --- /dev/null +++ b/mobile/openapi/doc/UserAdminResponseDto.md @@ -0,0 +1,31 @@ +# openapi.model.UserAdminResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**UserAvatarColor**](UserAvatarColor.md) | | +**createdAt** | [**DateTime**](DateTime.md) | Creation date | +**deletedAt** | [**DateTime**](DateTime.md) | Deletion date | +**email** | **String** | User email | +**id** | **String** | User ID | +**isAdmin** | **bool** | Is admin user | +**license** | [**UserLicense**](UserLicense.md) | | +**name** | **String** | User name | +**oauthId** | **String** | OAuth ID | +**profileChangedAt** | [**DateTime**](DateTime.md) | Profile change date | +**profileImagePath** | **String** | Profile image path | +**quotaSizeInBytes** | **int** | Storage quota in bytes | +**quotaUsageInBytes** | **int** | Storage usage in bytes | +**shouldChangePassword** | **bool** | Require password change on next login | +**status** | [**UserStatus**](UserStatus.md) | | +**storageLabel** | **String** | Storage label | +**updatedAt** | [**DateTime**](DateTime.md) | Last update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserAdminUpdateDto.md b/mobile/openapi/doc/UserAdminUpdateDto.md new file mode 100644 index 0000000000000..0ae63d0d609ad --- /dev/null +++ b/mobile/openapi/doc/UserAdminUpdateDto.md @@ -0,0 +1,23 @@ +# openapi.model.UserAdminUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**Optional**](UserAvatarColor.md) | | [optional] +**email** | **Optional** | User email | [optional] +**isAdmin** | **Optional** | Grant admin privileges | [optional] +**name** | **Optional** | User name | [optional] +**password** | **Optional** | User password | [optional] +**pinCode** | **Optional** | PIN code | [optional] +**quotaSizeInBytes** | **Optional** | Storage quota in bytes | [optional] +**shouldChangePassword** | **Optional** | Require password change on next login | [optional] +**storageLabel** | **Optional** | Storage label | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserAvatarColor.md b/mobile/openapi/doc/UserAvatarColor.md new file mode 100644 index 0000000000000..a07350de124a5 --- /dev/null +++ b/mobile/openapi/doc/UserAvatarColor.md @@ -0,0 +1,14 @@ +# openapi.model.UserAvatarColor + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserLicense.md b/mobile/openapi/doc/UserLicense.md new file mode 100644 index 0000000000000..ad9c09ab7b3c1 --- /dev/null +++ b/mobile/openapi/doc/UserLicense.md @@ -0,0 +1,17 @@ +# openapi.model.UserLicense + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**activatedAt** | [**DateTime**](DateTime.md) | Activation date | +**activationKey** | **String** | Activation key | +**licenseKey** | **String** | License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserMetadataKey.md b/mobile/openapi/doc/UserMetadataKey.md new file mode 100644 index 0000000000000..1a9e7a083548d --- /dev/null +++ b/mobile/openapi/doc/UserMetadataKey.md @@ -0,0 +1,14 @@ +# openapi.model.UserMetadataKey + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserPreferencesResponseDto.md b/mobile/openapi/doc/UserPreferencesResponseDto.md new file mode 100644 index 0000000000000..201f74f3ba58d --- /dev/null +++ b/mobile/openapi/doc/UserPreferencesResponseDto.md @@ -0,0 +1,26 @@ +# openapi.model.UserPreferencesResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albums** | [**AlbumsResponse**](AlbumsResponse.md) | | +**cast** | [**CastResponse**](CastResponse.md) | | +**download** | [**DownloadResponse**](DownloadResponse.md) | | +**emailNotifications** | [**EmailNotificationsResponse**](EmailNotificationsResponse.md) | | +**folders** | [**FoldersResponse**](FoldersResponse.md) | | +**memories** | [**MemoriesResponse**](MemoriesResponse.md) | | +**people** | [**PeopleResponse**](PeopleResponse.md) | | +**purchase** | [**PurchaseResponse**](PurchaseResponse.md) | | +**ratings** | [**RatingsResponse**](RatingsResponse.md) | | +**recentlyAdded** | [**RecentlyAddedResponse**](RecentlyAddedResponse.md) | | +**sharedLinks** | [**SharedLinksResponse**](SharedLinksResponse.md) | | +**tags** | [**TagsResponse**](TagsResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserPreferencesUpdateDto.md b/mobile/openapi/doc/UserPreferencesUpdateDto.md new file mode 100644 index 0000000000000..4a7a318852983 --- /dev/null +++ b/mobile/openapi/doc/UserPreferencesUpdateDto.md @@ -0,0 +1,27 @@ +# openapi.model.UserPreferencesUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**albums** | [**Optional**](AlbumsUpdate.md) | | [optional] +**avatar** | [**Optional**](AvatarUpdate.md) | | [optional] +**cast** | [**Optional**](CastUpdate.md) | | [optional] +**download** | [**Optional**](DownloadUpdate.md) | | [optional] +**emailNotifications** | [**Optional**](EmailNotificationsUpdate.md) | | [optional] +**folders** | [**Optional**](FoldersUpdate.md) | | [optional] +**memories** | [**Optional**](MemoriesUpdate.md) | | [optional] +**people** | [**Optional**](PeopleUpdate.md) | | [optional] +**purchase** | [**Optional**](PurchaseUpdate.md) | | [optional] +**ratings** | [**Optional**](RatingsUpdate.md) | | [optional] +**recentlyAdded** | [**Optional**](RecentlyAddedUpdate.md) | | [optional] +**sharedLinks** | [**Optional**](SharedLinksUpdate.md) | | [optional] +**tags** | [**Optional**](TagsUpdate.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserResponseDto.md b/mobile/openapi/doc/UserResponseDto.md new file mode 100644 index 0000000000000..ebbeb08db8f3f --- /dev/null +++ b/mobile/openapi/doc/UserResponseDto.md @@ -0,0 +1,20 @@ +# openapi.model.UserResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**UserAvatarColor**](UserAvatarColor.md) | | +**email** | **String** | User email | +**id** | **String** | User ID | +**name** | **String** | User name | +**profileChangedAt** | [**DateTime**](DateTime.md) | Profile change date | +**profileImagePath** | **String** | Profile image path | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserStatus.md b/mobile/openapi/doc/UserStatus.md new file mode 100644 index 0000000000000..02abb4eff9385 --- /dev/null +++ b/mobile/openapi/doc/UserStatus.md @@ -0,0 +1,14 @@ +# openapi.model.UserStatus + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UserUpdateMeDto.md b/mobile/openapi/doc/UserUpdateMeDto.md new file mode 100644 index 0000000000000..3ab8b7e79fc8f --- /dev/null +++ b/mobile/openapi/doc/UserUpdateMeDto.md @@ -0,0 +1,18 @@ +# openapi.model.UserUpdateMeDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avatarColor** | [**Optional**](UserAvatarColor.md) | | [optional] +**email** | **Optional** | User email | [optional] +**name** | **Optional** | User name | [optional] +**password** | **Optional** | User password (deprecated, use change password endpoint) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/UsersAdminApi.md b/mobile/openapi/doc/UsersAdminApi.md new file mode 100644 index 0000000000000..34a5ea6192995 --- /dev/null +++ b/mobile/openapi/doc/UsersAdminApi.md @@ -0,0 +1,671 @@ +# openapi.api.UsersAdminApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createUserAdmin**](UsersAdminApi.md#createuseradmin) | **POST** /admin/users | Create a user +[**deleteUserAdmin**](UsersAdminApi.md#deleteuseradmin) | **DELETE** /admin/users/{id} | Delete a user +[**getUserAdmin**](UsersAdminApi.md#getuseradmin) | **GET** /admin/users/{id} | Retrieve a user +[**getUserCalendarHeatmapAdmin**](UsersAdminApi.md#getusercalendarheatmapadmin) | **GET** /admin/users/{id}/calendar-heatmap | Retrieve calendar heatmap activity +[**getUserPreferencesAdmin**](UsersAdminApi.md#getuserpreferencesadmin) | **GET** /admin/users/{id}/preferences | Retrieve user preferences +[**getUserSessionsAdmin**](UsersAdminApi.md#getusersessionsadmin) | **GET** /admin/users/{id}/sessions | Retrieve user sessions +[**getUserStatisticsAdmin**](UsersAdminApi.md#getuserstatisticsadmin) | **GET** /admin/users/{id}/statistics | Retrieve user statistics +[**restoreUserAdmin**](UsersAdminApi.md#restoreuseradmin) | **POST** /admin/users/{id}/restore | Restore a deleted user +[**searchUsersAdmin**](UsersAdminApi.md#searchusersadmin) | **GET** /admin/users | Search users +[**updateUserAdmin**](UsersAdminApi.md#updateuseradmin) | **PUT** /admin/users/{id} | Update a user +[**updateUserPreferencesAdmin**](UsersAdminApi.md#updateuserpreferencesadmin) | **PUT** /admin/users/{id}/preferences | Update user preferences + + +# **createUserAdmin** +> UserAdminResponseDto createUserAdmin(userAdminCreateDto) + +Create a user + +Create a new user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final userAdminCreateDto = UserAdminCreateDto(); // UserAdminCreateDto | + +try { + final result = api_instance.createUserAdmin(userAdminCreateDto); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->createUserAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **userAdminCreateDto** | [**UserAdminCreateDto**](UserAdminCreateDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteUserAdmin** +> UserAdminResponseDto deleteUserAdmin(id, userAdminDeleteDto) + +Delete a user + +Delete a user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final userAdminDeleteDto = UserAdminDeleteDto(); // UserAdminDeleteDto | + +try { + final result = api_instance.deleteUserAdmin(id, userAdminDeleteDto); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->deleteUserAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **userAdminDeleteDto** | [**UserAdminDeleteDto**](UserAdminDeleteDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserAdmin** +> UserAdminResponseDto getUserAdmin(id) + +Retrieve a user + +Retrieve a specific user by their ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getUserAdmin(id); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->getUserAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserCalendarHeatmapAdmin** +> CalendarHeatmapResponseDto getUserCalendarHeatmapAdmin(id, from, to, type) + +Retrieve calendar heatmap activity + +Retrieve activity counts for a specified period, in a calendar heatmap format. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final from = Mon Jan 01 00:00:00 UTC 2024; // DateTime | Start date in UTC +final to = Mon Jan 01 00:00:00 UTC 2024; // DateTime | End date in UTC +final type = ; // CalendarHeatmapType | + +try { + final result = api_instance.getUserCalendarHeatmapAdmin(id, from, to, type); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->getUserCalendarHeatmapAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **from** | **DateTime**| Start date in UTC | [optional] + **to** | **DateTime**| End date in UTC | [optional] + **type** | [**CalendarHeatmapType**](.md)| | [optional] + +### Return type + +[**CalendarHeatmapResponseDto**](CalendarHeatmapResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserPreferencesAdmin** +> UserPreferencesResponseDto getUserPreferencesAdmin(id) + +Retrieve user preferences + +Retrieve the preferences of a specific user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getUserPreferencesAdmin(id); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->getUserPreferencesAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserSessionsAdmin** +> List getUserSessionsAdmin(id) + +Retrieve user sessions + +Retrieve all sessions for a specific user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getUserSessionsAdmin(id); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->getUserSessionsAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**List**](SessionResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserStatisticsAdmin** +> AssetStatsResponseDto getUserStatisticsAdmin(id, isFavorite, isTrashed, visibility) + +Retrieve user statistics + +Retrieve asset statistics for a specific user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final isFavorite = true; // bool | Filter by favorite status +final isTrashed = true; // bool | Filter by trash status +final visibility = ; // AssetVisibility | + +try { + final result = api_instance.getUserStatisticsAdmin(id, isFavorite, isTrashed, visibility); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->getUserStatisticsAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **isFavorite** | **bool**| Filter by favorite status | [optional] + **isTrashed** | **bool**| Filter by trash status | [optional] + **visibility** | [**AssetVisibility**](.md)| | [optional] + +### Return type + +[**AssetStatsResponseDto**](AssetStatsResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **restoreUserAdmin** +> UserAdminResponseDto restoreUserAdmin(id) + +Restore a deleted user + +Restore a previously deleted user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.restoreUserAdmin(id); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->restoreUserAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchUsersAdmin** +> List searchUsersAdmin(id, withDeleted) + +Search users + +Search for users. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | User ID filter +final withDeleted = true; // bool | Include deleted users + +try { + final result = api_instance.searchUsersAdmin(id, withDeleted); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->searchUsersAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| User ID filter | [optional] + **withDeleted** | **bool**| Include deleted users | [optional] + +### Return type + +[**List**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateUserAdmin** +> UserAdminResponseDto updateUserAdmin(id, userAdminUpdateDto) + +Update a user + +Update an existing user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final userAdminUpdateDto = UserAdminUpdateDto(); // UserAdminUpdateDto | + +try { + final result = api_instance.updateUserAdmin(id, userAdminUpdateDto); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->updateUserAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **userAdminUpdateDto** | [**UserAdminUpdateDto**](UserAdminUpdateDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateUserPreferencesAdmin** +> UserPreferencesResponseDto updateUserPreferencesAdmin(id, userPreferencesUpdateDto) + +Update user preferences + +Update the preferences of a specific user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersAdminApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final userPreferencesUpdateDto = UserPreferencesUpdateDto(); // UserPreferencesUpdateDto | + +try { + final result = api_instance.updateUserPreferencesAdmin(id, userPreferencesUpdateDto); + print(result); +} catch (e) { + print('Exception when calling UsersAdminApi->updateUserPreferencesAdmin: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **userPreferencesUpdateDto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | + +### Return type + +[**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/UsersApi.md b/mobile/openapi/doc/UsersApi.md new file mode 100644 index 0000000000000..4352858eac0f0 --- /dev/null +++ b/mobile/openapi/doc/UsersApi.md @@ -0,0 +1,910 @@ +# openapi.api.UsersApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createProfileImage**](UsersApi.md#createprofileimage) | **POST** /users/profile-image | Create user profile image +[**deleteProfileImage**](UsersApi.md#deleteprofileimage) | **DELETE** /users/profile-image | Delete user profile image +[**deleteUserLicense**](UsersApi.md#deleteuserlicense) | **DELETE** /users/me/license | Delete user product key +[**deleteUserOnboarding**](UsersApi.md#deleteuseronboarding) | **DELETE** /users/me/onboarding | Delete user onboarding +[**getMyCalendarHeatmap**](UsersApi.md#getmycalendarheatmap) | **GET** /users/me/calendar-heatmap | Retrieve calendar heatmap activity +[**getMyPreferences**](UsersApi.md#getmypreferences) | **GET** /users/me/preferences | Get my preferences +[**getMyUser**](UsersApi.md#getmyuser) | **GET** /users/me | Get current user +[**getProfileImage**](UsersApi.md#getprofileimage) | **GET** /users/{id}/profile-image | Retrieve user profile image +[**getUser**](UsersApi.md#getuser) | **GET** /users/{id} | Retrieve a user +[**getUserLicense**](UsersApi.md#getuserlicense) | **GET** /users/me/license | Retrieve user product key +[**getUserOnboarding**](UsersApi.md#getuseronboarding) | **GET** /users/me/onboarding | Retrieve user onboarding +[**searchUsers**](UsersApi.md#searchusers) | **GET** /users | Get all users +[**setUserLicense**](UsersApi.md#setuserlicense) | **PUT** /users/me/license | Set user product key +[**setUserOnboarding**](UsersApi.md#setuseronboarding) | **PUT** /users/me/onboarding | Update user onboarding +[**updateMyPreferences**](UsersApi.md#updatemypreferences) | **PUT** /users/me/preferences | Update my preferences +[**updateMyUser**](UsersApi.md#updatemyuser) | **PUT** /users/me | Update current user + + +# **createProfileImage** +> CreateProfileImageResponseDto createProfileImage(file) + +Create user profile image + +Upload and set a new profile image for the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final file = BINARY_DATA_HERE; // MultipartFile | Profile image file + +try { + final result = api_instance.createProfileImage(file); + print(result); +} catch (e) { + print('Exception when calling UsersApi->createProfileImage: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **file** | **MultipartFile**| Profile image file | + +### Return type + +[**CreateProfileImageResponseDto**](CreateProfileImageResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteProfileImage** +> deleteProfileImage() + +Delete user profile image + +Delete the profile image of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + api_instance.deleteProfileImage(); +} catch (e) { + print('Exception when calling UsersApi->deleteProfileImage: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteUserLicense** +> deleteUserLicense() + +Delete user product key + +Delete the registered product key for the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + api_instance.deleteUserLicense(); +} catch (e) { + print('Exception when calling UsersApi->deleteUserLicense: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteUserOnboarding** +> deleteUserOnboarding() + +Delete user onboarding + +Delete the onboarding status of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + api_instance.deleteUserOnboarding(); +} catch (e) { + print('Exception when calling UsersApi->deleteUserOnboarding: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMyCalendarHeatmap** +> CalendarHeatmapResponseDto getMyCalendarHeatmap(from, to, type) + +Retrieve calendar heatmap activity + +Retrieve activity counts for a specified period, in a calendar heatmap format. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final from = Mon Jan 01 00:00:00 UTC 2024; // DateTime | Start date in UTC +final to = Mon Jan 01 00:00:00 UTC 2024; // DateTime | End date in UTC +final type = ; // CalendarHeatmapType | + +try { + final result = api_instance.getMyCalendarHeatmap(from, to, type); + print(result); +} catch (e) { + print('Exception when calling UsersApi->getMyCalendarHeatmap: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **from** | **DateTime**| Start date in UTC | [optional] + **to** | **DateTime**| End date in UTC | [optional] + **type** | [**CalendarHeatmapType**](.md)| | [optional] + +### Return type + +[**CalendarHeatmapResponseDto**](CalendarHeatmapResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMyPreferences** +> UserPreferencesResponseDto getMyPreferences() + +Get my preferences + +Retrieve the preferences for the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + final result = api_instance.getMyPreferences(); + print(result); +} catch (e) { + print('Exception when calling UsersApi->getMyPreferences: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getMyUser** +> UserAdminResponseDto getMyUser() + +Get current user + +Retrieve information about the user making the API request. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + final result = api_instance.getMyUser(); + print(result); +} catch (e) { + print('Exception when calling UsersApi->getMyUser: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getProfileImage** +> MultipartFile getProfileImage(id) + +Retrieve user profile image + +Retrieve the profile image file for a user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getProfileImage(id); + print(result); +} catch (e) { + print('Exception when calling UsersApi->getProfileImage: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**MultipartFile**](MultipartFile.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/octet-stream + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUser** +> UserResponseDto getUser(id) + +Retrieve a user + +Retrieve a specific user by their ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getUser(id); + print(result); +} catch (e) { + print('Exception when calling UsersApi->getUser: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**UserResponseDto**](UserResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserLicense** +> UserLicense getUserLicense() + +Retrieve user product key + +Retrieve information about whether the current user has a registered product key. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + final result = api_instance.getUserLicense(); + print(result); +} catch (e) { + print('Exception when calling UsersApi->getUserLicense: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**UserLicense**](UserLicense.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUserOnboarding** +> OnboardingResponseDto getUserOnboarding() + +Retrieve user onboarding + +Retrieve the onboarding status of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + final result = api_instance.getUserOnboarding(); + print(result); +} catch (e) { + print('Exception when calling UsersApi->getUserOnboarding: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**OnboardingResponseDto**](OnboardingResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchUsers** +> List searchUsers() + +Get all users + +Retrieve a list of all users on the server. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); + +try { + final result = api_instance.searchUsers(); + print(result); +} catch (e) { + print('Exception when calling UsersApi->searchUsers: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](UserResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setUserLicense** +> UserLicense setUserLicense(licenseKeyDto) + +Set user product key + +Register a product key for the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final licenseKeyDto = LicenseKeyDto(); // LicenseKeyDto | + +try { + final result = api_instance.setUserLicense(licenseKeyDto); + print(result); +} catch (e) { + print('Exception when calling UsersApi->setUserLicense: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **licenseKeyDto** | [**LicenseKeyDto**](LicenseKeyDto.md)| | + +### Return type + +[**UserLicense**](UserLicense.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setUserOnboarding** +> OnboardingResponseDto setUserOnboarding(onboardingDto) + +Update user onboarding + +Update the onboarding status of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final onboardingDto = OnboardingDto(); // OnboardingDto | + +try { + final result = api_instance.setUserOnboarding(onboardingDto); + print(result); +} catch (e) { + print('Exception when calling UsersApi->setUserOnboarding: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **onboardingDto** | [**OnboardingDto**](OnboardingDto.md)| | + +### Return type + +[**OnboardingResponseDto**](OnboardingResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateMyPreferences** +> UserPreferencesResponseDto updateMyPreferences(userPreferencesUpdateDto) + +Update my preferences + +Update the preferences of the current user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final userPreferencesUpdateDto = UserPreferencesUpdateDto(); // UserPreferencesUpdateDto | + +try { + final result = api_instance.updateMyPreferences(userPreferencesUpdateDto); + print(result); +} catch (e) { + print('Exception when calling UsersApi->updateMyPreferences: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **userPreferencesUpdateDto** | [**UserPreferencesUpdateDto**](UserPreferencesUpdateDto.md)| | + +### Return type + +[**UserPreferencesResponseDto**](UserPreferencesResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateMyUser** +> UserAdminResponseDto updateMyUser(userUpdateMeDto) + +Update current user + +Update the current user making the API request. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = UsersApi(); +final userUpdateMeDto = UserUpdateMeDto(); // UserUpdateMeDto | + +try { + final result = api_instance.updateMyUser(userUpdateMeDto); + print(result); +} catch (e) { + print('Exception when calling UsersApi->updateMyUser: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **userUpdateMeDto** | [**UserUpdateMeDto**](UserUpdateMeDto.md)| | + +### Return type + +[**UserAdminResponseDto**](UserAdminResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/ValidateAccessTokenResponseDto.md b/mobile/openapi/doc/ValidateAccessTokenResponseDto.md new file mode 100644 index 0000000000000..9b1d64f6cb278 --- /dev/null +++ b/mobile/openapi/doc/ValidateAccessTokenResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.ValidateAccessTokenResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authStatus** | **bool** | Authentication status | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ValidateLibraryDto.md b/mobile/openapi/doc/ValidateLibraryDto.md new file mode 100644 index 0000000000000..753ade8ddaec2 --- /dev/null +++ b/mobile/openapi/doc/ValidateLibraryDto.md @@ -0,0 +1,16 @@ +# openapi.model.ValidateLibraryDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclusionPatterns** | **Optional?>** | Exclusion patterns (max 128) | [optional] [default to const []] +**importPaths** | **Optional?>** | Import paths to validate (max 128) | [optional] [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ValidateLibraryImportPathResponseDto.md b/mobile/openapi/doc/ValidateLibraryImportPathResponseDto.md new file mode 100644 index 0000000000000..b68eb4ace6005 --- /dev/null +++ b/mobile/openapi/doc/ValidateLibraryImportPathResponseDto.md @@ -0,0 +1,17 @@ +# openapi.model.ValidateLibraryImportPathResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**importPath** | **String** | Import path | +**isValid** | **bool** | Is valid | +**message** | **Optional** | Validation message | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ValidateLibraryResponseDto.md b/mobile/openapi/doc/ValidateLibraryResponseDto.md new file mode 100644 index 0000000000000..9cf183250cbd4 --- /dev/null +++ b/mobile/openapi/doc/ValidateLibraryResponseDto.md @@ -0,0 +1,15 @@ +# openapi.model.ValidateLibraryResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**importPaths** | [**Optional?>**](ValidateLibraryImportPathResponseDto.md) | Validation results for import paths | [optional] [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/VersionCheckStateResponseDto.md b/mobile/openapi/doc/VersionCheckStateResponseDto.md new file mode 100644 index 0000000000000..e863cd740de0d --- /dev/null +++ b/mobile/openapi/doc/VersionCheckStateResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.VersionCheckStateResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checkedAt** | **String** | Last check timestamp | +**releaseVersion** | **String** | Release version | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/VideoCodec.md b/mobile/openapi/doc/VideoCodec.md new file mode 100644 index 0000000000000..7b7d95798984c --- /dev/null +++ b/mobile/openapi/doc/VideoCodec.md @@ -0,0 +1,14 @@ +# openapi.model.VideoCodec + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/VideoContainer.md b/mobile/openapi/doc/VideoContainer.md new file mode 100644 index 0000000000000..157dd2e2316b5 --- /dev/null +++ b/mobile/openapi/doc/VideoContainer.md @@ -0,0 +1,14 @@ +# openapi.model.VideoContainer + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/ViewsApi.md b/mobile/openapi/doc/ViewsApi.md new file mode 100644 index 0000000000000..52378a8a51f27 --- /dev/null +++ b/mobile/openapi/doc/ViewsApi.md @@ -0,0 +1,125 @@ +# openapi.api.ViewsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getAssetsByOriginalPath**](ViewsApi.md#getassetsbyoriginalpath) | **GET** /view/folder | Retrieve assets by original path +[**getUniqueOriginalPaths**](ViewsApi.md#getuniqueoriginalpaths) | **GET** /view/folder/unique-paths | Retrieve unique paths + + +# **getAssetsByOriginalPath** +> List getAssetsByOriginalPath(path) + +Retrieve assets by original path + +Retrieve assets that are children of a specific folder. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ViewsApi(); +final path = path_example; // String | + +try { + final result = api_instance.getAssetsByOriginalPath(path); + print(result); +} catch (e) { + print('Exception when calling ViewsApi->getAssetsByOriginalPath: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **String**| | + +### Return type + +[**List**](AssetResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getUniqueOriginalPaths** +> List getUniqueOriginalPaths() + +Retrieve unique paths + +Retrieve a list of unique folder paths from asset original paths. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = ViewsApi(); + +try { + final result = api_instance.getUniqueOriginalPaths(); + print(result); +} catch (e) { + print('Exception when calling ViewsApi->getUniqueOriginalPaths: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**List** + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/doc/WorkflowCreateDto.md b/mobile/openapi/doc/WorkflowCreateDto.md new file mode 100644 index 0000000000000..5ce82c654d9fc --- /dev/null +++ b/mobile/openapi/doc/WorkflowCreateDto.md @@ -0,0 +1,19 @@ +# openapi.model.WorkflowCreateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **Optional** | Workflow description | [optional] +**enabled** | **Optional** | Workflow enabled | [optional] +**name** | **Optional** | Workflow name | [optional] +**steps** | [**Optional?>**](WorkflowStepDto.md) | | [optional] [default to const []] +**trigger** | [**WorkflowTrigger**](WorkflowTrigger.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowResponseDto.md b/mobile/openapi/doc/WorkflowResponseDto.md new file mode 100644 index 0000000000000..587c6a1ab2953 --- /dev/null +++ b/mobile/openapi/doc/WorkflowResponseDto.md @@ -0,0 +1,22 @@ +# openapi.model.WorkflowResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdAt** | **String** | Creation date | +**description** | **String** | Workflow description | +**enabled** | **bool** | Workflow enabled | +**id** | **String** | Workflow ID | +**name** | **String** | Workflow name | +**steps** | [**List**](WorkflowStepDto.md) | Workflow steps | [default to const []] +**trigger** | [**WorkflowTrigger**](WorkflowTrigger.md) | | +**updatedAt** | **String** | Update date | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowShareResponseDto.md b/mobile/openapi/doc/WorkflowShareResponseDto.md new file mode 100644 index 0000000000000..7de40bfe5e821 --- /dev/null +++ b/mobile/openapi/doc/WorkflowShareResponseDto.md @@ -0,0 +1,18 @@ +# openapi.model.WorkflowShareResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **String** | Workflow description | +**name** | **String** | Workflow name | +**steps** | [**List**](WorkflowShareStepDto.md) | Workflow steps | [default to const []] +**trigger** | [**WorkflowTrigger**](WorkflowTrigger.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowShareStepDto.md b/mobile/openapi/doc/WorkflowShareStepDto.md new file mode 100644 index 0000000000000..033e364416268 --- /dev/null +++ b/mobile/openapi/doc/WorkflowShareStepDto.md @@ -0,0 +1,17 @@ +# openapi.model.WorkflowShareStepDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | **Map** | Step configuration | [default to const {}] +**enabled** | **Optional** | Step is enabled | [optional] +**method** | **String** | Step plugin method | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowStepDto.md b/mobile/openapi/doc/WorkflowStepDto.md new file mode 100644 index 0000000000000..61bdd9c7e43da --- /dev/null +++ b/mobile/openapi/doc/WorkflowStepDto.md @@ -0,0 +1,17 @@ +# openapi.model.WorkflowStepDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | **Map** | Step configuration | [default to const {}] +**enabled** | **Optional** | Step is enabled | [optional] +**method** | **String** | Step plugin method | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowTrigger.md b/mobile/openapi/doc/WorkflowTrigger.md new file mode 100644 index 0000000000000..ade13b59c8761 --- /dev/null +++ b/mobile/openapi/doc/WorkflowTrigger.md @@ -0,0 +1,14 @@ +# openapi.model.WorkflowTrigger + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowTriggerResponseDto.md b/mobile/openapi/doc/WorkflowTriggerResponseDto.md new file mode 100644 index 0000000000000..f4770c8397fd6 --- /dev/null +++ b/mobile/openapi/doc/WorkflowTriggerResponseDto.md @@ -0,0 +1,16 @@ +# openapi.model.WorkflowTriggerResponseDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trigger** | [**WorkflowTrigger**](WorkflowTrigger.md) | | +**types** | [**List**](WorkflowType.md) | Workflow types | [default to const []] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowType.md b/mobile/openapi/doc/WorkflowType.md new file mode 100644 index 0000000000000..aa62b137cad61 --- /dev/null +++ b/mobile/openapi/doc/WorkflowType.md @@ -0,0 +1,14 @@ +# openapi.model.WorkflowType + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowUpdateDto.md b/mobile/openapi/doc/WorkflowUpdateDto.md new file mode 100644 index 0000000000000..c6a9d9f5f9d4c --- /dev/null +++ b/mobile/openapi/doc/WorkflowUpdateDto.md @@ -0,0 +1,19 @@ +# openapi.model.WorkflowUpdateDto + +## Load the model package +```dart +import 'package:openapi/api.dart'; +``` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **Optional** | Workflow description | [optional] +**enabled** | **Optional** | Workflow enabled | [optional] +**name** | **Optional** | Workflow name | [optional] +**steps** | [**Optional?>**](WorkflowStepDto.md) | | [optional] [default to const []] +**trigger** | [**Optional**](WorkflowTrigger.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/mobile/openapi/doc/WorkflowsApi.md b/mobile/openapi/doc/WorkflowsApi.md new file mode 100644 index 0000000000000..3377c65637e4e --- /dev/null +++ b/mobile/openapi/doc/WorkflowsApi.md @@ -0,0 +1,424 @@ +# openapi.api.WorkflowsApi + +## Load the API package +```dart +import 'package:openapi/api.dart'; +``` + +All URIs are relative to */api* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createWorkflow**](WorkflowsApi.md#createworkflow) | **POST** /workflows | Create a workflow +[**deleteWorkflow**](WorkflowsApi.md#deleteworkflow) | **DELETE** /workflows/{id} | Delete a workflow +[**getWorkflow**](WorkflowsApi.md#getworkflow) | **GET** /workflows/{id} | Retrieve a workflow +[**getWorkflowForShare**](WorkflowsApi.md#getworkflowforshare) | **GET** /workflows/{id}/share | Retrieve a workflow +[**getWorkflowTriggers**](WorkflowsApi.md#getworkflowtriggers) | **GET** /workflows/triggers | List all workflow triggers +[**searchWorkflows**](WorkflowsApi.md#searchworkflows) | **GET** /workflows | List all workflows +[**updateWorkflow**](WorkflowsApi.md#updateworkflow) | **PUT** /workflows/{id} | Update a workflow + + +# **createWorkflow** +> WorkflowResponseDto createWorkflow(workflowCreateDto) + +Create a workflow + +Create a new workflow, the workflow can also be created with empty filters and actions. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = WorkflowsApi(); +final workflowCreateDto = WorkflowCreateDto(); // WorkflowCreateDto | + +try { + final result = api_instance.createWorkflow(workflowCreateDto); + print(result); +} catch (e) { + print('Exception when calling WorkflowsApi->createWorkflow: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workflowCreateDto** | [**WorkflowCreateDto**](WorkflowCreateDto.md)| | + +### Return type + +[**WorkflowResponseDto**](WorkflowResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **deleteWorkflow** +> deleteWorkflow(id) + +Delete a workflow + +Delete a workflow by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = WorkflowsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + api_instance.deleteWorkflow(id); +} catch (e) { + print('Exception when calling WorkflowsApi->deleteWorkflow: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +void (empty response body) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getWorkflow** +> WorkflowResponseDto getWorkflow(id) + +Retrieve a workflow + +Retrieve information about a specific workflow by its ID. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = WorkflowsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getWorkflow(id); + print(result); +} catch (e) { + print('Exception when calling WorkflowsApi->getWorkflow: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**WorkflowResponseDto**](WorkflowResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getWorkflowForShare** +> WorkflowShareResponseDto getWorkflowForShare(id) + +Retrieve a workflow + +Retrieve a workflow details without ids, default values, etc. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = WorkflowsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | + +try { + final result = api_instance.getWorkflowForShare(id); + print(result); +} catch (e) { + print('Exception when calling WorkflowsApi->getWorkflowForShare: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + +### Return type + +[**WorkflowShareResponseDto**](WorkflowShareResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getWorkflowTriggers** +> List getWorkflowTriggers() + +List all workflow triggers + +Retrieve a list of all available workflow triggers. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = WorkflowsApi(); + +try { + final result = api_instance.getWorkflowTriggers(); + print(result); +} catch (e) { + print('Exception when calling WorkflowsApi->getWorkflowTriggers: $e\n'); +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List**](WorkflowTriggerResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **searchWorkflows** +> List searchWorkflows(description, enabled, id, name, trigger) + +List all workflows + +Retrieve a list of workflows available to the authenticated user. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = WorkflowsApi(); +final description = description_example; // String | Workflow description +final enabled = true; // bool | Workflow enabled +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Workflow ID +final name = name_example; // String | Workflow name +final trigger = ; // WorkflowTrigger | Workflow trigger type + +try { + final result = api_instance.searchWorkflows(description, enabled, id, name, trigger); + print(result); +} catch (e) { + print('Exception when calling WorkflowsApi->searchWorkflows: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **description** | **String**| Workflow description | [optional] + **enabled** | **bool**| Workflow enabled | [optional] + **id** | **String**| Workflow ID | [optional] + **name** | **String**| Workflow name | [optional] + **trigger** | [**WorkflowTrigger**](.md)| Workflow trigger type | [optional] + +### Return type + +[**List**](WorkflowResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **updateWorkflow** +> WorkflowResponseDto updateWorkflow(id, workflowUpdateDto) + +Update a workflow + +Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. + +### Example +```dart +import 'package:openapi/api.dart'; +// TODO Configure API key authorization: cookie +//defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; +// TODO Configure API key authorization: api_key +//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; +// uncomment below to setup prefix (e.g. Bearer) for API key, if needed +//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; +// TODO Configure HTTP Bearer authorization: bearer +// Case 1. Use String Token +//defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); +// Case 2. Use Function which generate token. +// String yourTokenGeneratorFunction() { ... } +//defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); + +final api_instance = WorkflowsApi(); +final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | +final workflowUpdateDto = WorkflowUpdateDto(); // WorkflowUpdateDto | + +try { + final result = api_instance.updateWorkflow(id, workflowUpdateDto); + print(result); +} catch (e) { + print('Exception when calling WorkflowsApi->updateWorkflow: $e\n'); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| | + **workflowUpdateDto** | [**WorkflowUpdateDto**](WorkflowUpdateDto.md)| | + +### Return type + +[**WorkflowResponseDto**](WorkflowResponseDto.md) + +### Authorization + +[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/mobile/openapi/test/active_schedule_item_dto_test.dart b/mobile/openapi/test/active_schedule_item_dto_test.dart new file mode 100644 index 0000000000000..7af1ce26d2954 --- /dev/null +++ b/mobile/openapi/test/active_schedule_item_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ActiveScheduleItemDto +void main() { + // final instance = ActiveScheduleItemDto(); + + group('test ActiveScheduleItemDto', () { + // String repositoryId + test('to test the property `repositoryId`', () async { + // TODO + }); + + // TaskStatus status + test('to test the property `status`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/activities_api_test.dart b/mobile/openapi/test/activities_api_test.dart new file mode 100644 index 0000000000000..9658b0f1836ac --- /dev/null +++ b/mobile/openapi/test/activities_api_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for ActivitiesApi +void main() { + // final instance = ActivitiesApi(); + + group('tests for ActivitiesApi', () { + // Create an activity + // + // Create a like or a comment for an album, or an asset in an album. + // + //Future createActivity(ActivityCreateDto activityCreateDto) async + test('test createActivity', () async { + // TODO + }); + + // Delete an activity + // + // Removes a like or comment from a given album or asset in an album. + // + //Future deleteActivity(String id) async + test('test deleteActivity', () async { + // TODO + }); + + // List all activities + // + // Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first. + // + //Future> getActivities(String albumId, { String assetId, ReactionLevel level, ReactionType type, String userId }) async + test('test getActivities', () async { + // TODO + }); + + // Retrieve activity statistics + // + // Returns the number of likes and comments for a given album or asset in an album. + // + //Future getActivityStatistics(String albumId, { String assetId }) async + test('test getActivityStatistics', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/activity_create_dto_test.dart b/mobile/openapi/test/activity_create_dto_test.dart new file mode 100644 index 0000000000000..f77f3cf85f664 --- /dev/null +++ b/mobile/openapi/test/activity_create_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ActivityCreateDto +void main() { + // final instance = ActivityCreateDto(); + + group('test ActivityCreateDto', () { + // Album ID + // String albumId + test('to test the property `albumId`', () async { + // TODO + }); + + // Asset ID (if activity is for an asset) + // Optional assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Comment text (required if type is comment) + // Optional comment + test('to test the property `comment`', () async { + // TODO + }); + + // ReactionType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/activity_response_dto_test.dart b/mobile/openapi/test/activity_response_dto_test.dart new file mode 100644 index 0000000000000..a51c70df18b17 --- /dev/null +++ b/mobile/openapi/test/activity_response_dto_test.dart @@ -0,0 +1,56 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ActivityResponseDto +void main() { + // final instance = ActivityResponseDto(); + + group('test ActivityResponseDto', () { + // Asset ID (if activity is for an asset) + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Comment text (for comment activities) + // Optional comment + test('to test the property `comment`', () async { + // TODO + }); + + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Activity ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // ReactionType type + test('to test the property `type`', () async { + // TODO + }); + + // UserResponseDto user + test('to test the property `user`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/activity_statistics_response_dto_test.dart b/mobile/openapi/test/activity_statistics_response_dto_test.dart new file mode 100644 index 0000000000000..0aba66412aaae --- /dev/null +++ b/mobile/openapi/test/activity_statistics_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ActivityStatisticsResponseDto +void main() { + // final instance = ActivityStatisticsResponseDto(); + + group('test ActivityStatisticsResponseDto', () { + // Number of comments + // int comments + test('to test the property `comments`', () async { + // TODO + }); + + // Number of likes + // int likes + test('to test the property `likes`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/add_users_dto_test.dart b/mobile/openapi/test/add_users_dto_test.dart new file mode 100644 index 0000000000000..9eed2c0f3508d --- /dev/null +++ b/mobile/openapi/test/add_users_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AddUsersDto +void main() { + // final instance = AddUsersDto(); + + group('test AddUsersDto', () { + // Album users to add + // List albumUsers (default value: const []) + test('to test the property `albumUsers`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/admin_onboarding_update_dto_test.dart b/mobile/openapi/test/admin_onboarding_update_dto_test.dart new file mode 100644 index 0000000000000..cc25a443424f2 --- /dev/null +++ b/mobile/openapi/test/admin_onboarding_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AdminOnboardingUpdateDto +void main() { + // final instance = AdminOnboardingUpdateDto(); + + group('test AdminOnboardingUpdateDto', () { + // Is admin onboarded + // bool isOnboarded + test('to test the property `isOnboarded`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/album_response_dto_test.dart b/mobile/openapi/test/album_response_dto_test.dart new file mode 100644 index 0000000000000..300925c64317f --- /dev/null +++ b/mobile/openapi/test/album_response_dto_test.dart @@ -0,0 +1,116 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumResponseDto +void main() { + // final instance = AlbumResponseDto(); + + group('test AlbumResponseDto', () { + // Album name + // String albumName + test('to test the property `albumName`', () async { + // TODO + }); + + // Thumbnail asset ID + // String albumThumbnailAssetId + test('to test the property `albumThumbnailAssetId`', () async { + // TODO + }); + + // First entry is always the album owner. Second entry is the auth user, if it differs from the owner. The rest are ordered alphabetically. + // List albumUsers (default value: const []) + test('to test the property `albumUsers`', () async { + // TODO + }); + + // Number of assets + // int assetCount + test('to test the property `assetCount`', () async { + // TODO + }); + + // Optional?> contributorCounts (default value: const []) + test('to test the property `contributorCounts`', () async { + // TODO + }); + + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Album description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // End date (latest asset) + // Optional endDate + test('to test the property `endDate`', () async { + // TODO + }); + + // Has shared link + // bool hasSharedLink + test('to test the property `hasSharedLink`', () async { + // TODO + }); + + // Album ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Activity feed enabled + // bool isActivityEnabled + test('to test the property `isActivityEnabled`', () async { + // TODO + }); + + // Last modified asset timestamp + // Optional lastModifiedAssetTimestamp + test('to test the property `lastModifiedAssetTimestamp`', () async { + // TODO + }); + + // Optional order + test('to test the property `order`', () async { + // TODO + }); + + // Is shared album + // bool shared + test('to test the property `shared`', () async { + // TODO + }); + + // Start date (earliest asset) + // Optional startDate + test('to test the property `startDate`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/album_statistics_response_dto_test.dart b/mobile/openapi/test/album_statistics_response_dto_test.dart new file mode 100644 index 0000000000000..2166edd754386 --- /dev/null +++ b/mobile/openapi/test/album_statistics_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumStatisticsResponseDto +void main() { + // final instance = AlbumStatisticsResponseDto(); + + group('test AlbumStatisticsResponseDto', () { + // Number of non-shared albums + // int notShared + test('to test the property `notShared`', () async { + // TODO + }); + + // Number of owned albums + // int owned + test('to test the property `owned`', () async { + // TODO + }); + + // Number of shared albums + // int shared + test('to test the property `shared`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/album_user_add_dto_test.dart b/mobile/openapi/test/album_user_add_dto_test.dart new file mode 100644 index 0000000000000..71cc1fb1eca05 --- /dev/null +++ b/mobile/openapi/test/album_user_add_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumUserAddDto +void main() { + // final instance = AlbumUserAddDto(); + + group('test AlbumUserAddDto', () { + // Optional role + test('to test the property `role`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/album_user_create_dto_test.dart b/mobile/openapi/test/album_user_create_dto_test.dart new file mode 100644 index 0000000000000..0091327a928f9 --- /dev/null +++ b/mobile/openapi/test/album_user_create_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumUserCreateDto +void main() { + // final instance = AlbumUserCreateDto(); + + group('test AlbumUserCreateDto', () { + // AlbumUserRole role + test('to test the property `role`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/album_user_response_dto_test.dart b/mobile/openapi/test/album_user_response_dto_test.dart new file mode 100644 index 0000000000000..6693ff8ead5fb --- /dev/null +++ b/mobile/openapi/test/album_user_response_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumUserResponseDto +void main() { + // final instance = AlbumUserResponseDto(); + + group('test AlbumUserResponseDto', () { + // AlbumUserRole role + test('to test the property `role`', () async { + // TODO + }); + + // UserResponseDto user + test('to test the property `user`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/album_user_role_test.dart b/mobile/openapi/test/album_user_role_test.dart new file mode 100644 index 0000000000000..f4e6e3c8959e0 --- /dev/null +++ b/mobile/openapi/test/album_user_role_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumUserRole +void main() { + + group('test AlbumUserRole', () { + + }); + +} diff --git a/mobile/openapi/test/albums_add_assets_dto_test.dart b/mobile/openapi/test/albums_add_assets_dto_test.dart new file mode 100644 index 0000000000000..acb54c8a104a5 --- /dev/null +++ b/mobile/openapi/test/albums_add_assets_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumsAddAssetsDto +void main() { + // final instance = AlbumsAddAssetsDto(); + + group('test AlbumsAddAssetsDto', () { + // Album IDs + // List albumIds (default value: const []) + test('to test the property `albumIds`', () async { + // TODO + }); + + // Asset IDs + // List assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/albums_add_assets_response_dto_test.dart b/mobile/openapi/test/albums_add_assets_response_dto_test.dart new file mode 100644 index 0000000000000..65b206eeb0ebf --- /dev/null +++ b/mobile/openapi/test/albums_add_assets_response_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumsAddAssetsResponseDto +void main() { + // final instance = AlbumsAddAssetsResponseDto(); + + group('test AlbumsAddAssetsResponseDto', () { + // Optional error + test('to test the property `error`', () async { + // TODO + }); + + // Operation success + // bool success + test('to test the property `success`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/albums_api_test.dart b/mobile/openapi/test/albums_api_test.dart new file mode 100644 index 0000000000000..586c265dc61e6 --- /dev/null +++ b/mobile/openapi/test/albums_api_test.dart @@ -0,0 +1,138 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for AlbumsApi +void main() { + // final instance = AlbumsApi(); + + group('tests for AlbumsApi', () { + // Add assets to an album + // + // Add multiple assets to a specific album by its ID. + // + //Future> addAssetsToAlbum(String id, BulkIdsDto bulkIdsDto) async + test('test addAssetsToAlbum', () async { + // TODO + }); + + // Add assets to albums + // + // Send a list of asset IDs and album IDs to add each asset to each album. + // + //Future addAssetsToAlbums(AlbumsAddAssetsDto albumsAddAssetsDto) async + test('test addAssetsToAlbums', () async { + // TODO + }); + + // Share album with users + // + // Share an album with multiple users. Each user can be given a specific role in the album. + // + //Future addUsersToAlbum(String id, AddUsersDto addUsersDto) async + test('test addUsersToAlbum', () async { + // TODO + }); + + // Create an album + // + // Create a new album. The album can also be created with initial users and assets. + // + //Future createAlbum(CreateAlbumDto createAlbumDto) async + test('test createAlbum', () async { + // TODO + }); + + // Delete an album + // + // Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process. + // + //Future deleteAlbum(String id) async + test('test deleteAlbum', () async { + // TODO + }); + + // Retrieve an album + // + // Retrieve information about a specific album by its ID. + // + //Future getAlbumInfo(String id, { String key, String slug }) async + test('test getAlbumInfo', () async { + // TODO + }); + + // Retrieve album map markers + // + // Retrieve map marker information for a specific album by its ID. + // + //Future> getAlbumMapMarkers(String id, { String key, String slug }) async + test('test getAlbumMapMarkers', () async { + // TODO + }); + + // Retrieve album statistics + // + // Returns statistics about the albums available to the authenticated user. + // + //Future getAlbumStatistics() async + test('test getAlbumStatistics', () async { + // TODO + }); + + // List all albums + // + // Retrieve a list of albums available to the authenticated user. + // + //Future> getAllAlbums({ String assetId, String id, bool isOwned, bool isShared, String name }) async + test('test getAllAlbums', () async { + // TODO + }); + + // Remove assets from an album + // + // Remove multiple assets from a specific album by its ID. + // + //Future> removeAssetFromAlbum(String id, BulkIdsDto bulkIdsDto) async + test('test removeAssetFromAlbum', () async { + // TODO + }); + + // Remove user from album + // + // Remove a user from an album. Use an ID of \"me\" to leave a shared album. + // + //Future removeUserFromAlbum(String id, String userId) async + test('test removeUserFromAlbum', () async { + // TODO + }); + + // Update an album + // + // Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album. + // + //Future updateAlbumInfo(String id, UpdateAlbumDto updateAlbumDto) async + test('test updateAlbumInfo', () async { + // TODO + }); + + // Update user role + // + // Change the role for a specific user in a specific album. + // + //Future updateAlbumUser(String id, String userId, UpdateAlbumUserDto updateAlbumUserDto) async + test('test updateAlbumUser', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/albums_response_test.dart b/mobile/openapi/test/albums_response_test.dart new file mode 100644 index 0000000000000..65efe69250f59 --- /dev/null +++ b/mobile/openapi/test/albums_response_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumsResponse +void main() { + // final instance = AlbumsResponse(); + + group('test AlbumsResponse', () { + // AssetOrder defaultAssetOrder + test('to test the property `defaultAssetOrder`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/albums_update_test.dart b/mobile/openapi/test/albums_update_test.dart new file mode 100644 index 0000000000000..7b0323b74a70f --- /dev/null +++ b/mobile/openapi/test/albums_update_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AlbumsUpdate +void main() { + // final instance = AlbumsUpdate(); + + group('test AlbumsUpdate', () { + // Optional defaultAssetOrder + test('to test the property `defaultAssetOrder`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/api_key_create_dto_test.dart b/mobile/openapi/test/api_key_create_dto_test.dart new file mode 100644 index 0000000000000..baec0de5197b7 --- /dev/null +++ b/mobile/openapi/test/api_key_create_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ApiKeyCreateDto +void main() { + // final instance = ApiKeyCreateDto(); + + group('test ApiKeyCreateDto', () { + // API key name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // List of permissions + // List permissions (default value: const []) + test('to test the property `permissions`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/api_key_create_response_dto_test.dart b/mobile/openapi/test/api_key_create_response_dto_test.dart new file mode 100644 index 0000000000000..9c5e163c249b8 --- /dev/null +++ b/mobile/openapi/test/api_key_create_response_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ApiKeyCreateResponseDto +void main() { + // final instance = ApiKeyCreateResponseDto(); + + group('test ApiKeyCreateResponseDto', () { + // ApiKeyResponseDto apiKey + test('to test the property `apiKey`', () async { + // TODO + }); + + // API key secret (only shown once) + // String secret + test('to test the property `secret`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/api_key_response_dto_test.dart b/mobile/openapi/test/api_key_response_dto_test.dart new file mode 100644 index 0000000000000..6b975cd5f2827 --- /dev/null +++ b/mobile/openapi/test/api_key_response_dto_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ApiKeyResponseDto +void main() { + // final instance = ApiKeyResponseDto(); + + group('test ApiKeyResponseDto', () { + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // API key ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // API key name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // List of permissions + // List permissions (default value: const []) + test('to test the property `permissions`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/api_key_update_dto_test.dart b/mobile/openapi/test/api_key_update_dto_test.dart new file mode 100644 index 0000000000000..8bc6ff18fcb2f --- /dev/null +++ b/mobile/openapi/test/api_key_update_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ApiKeyUpdateDto +void main() { + // final instance = ApiKeyUpdateDto(); + + group('test ApiKeyUpdateDto', () { + // API key name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // List of permissions + // Optional?> permissions (default value: const []) + test('to test the property `permissions`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/api_keys_api_test.dart b/mobile/openapi/test/api_keys_api_test.dart new file mode 100644 index 0000000000000..03f9d3aa75157 --- /dev/null +++ b/mobile/openapi/test/api_keys_api_test.dart @@ -0,0 +1,75 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for APIKeysApi +void main() { + // final instance = APIKeysApi(); + + group('tests for APIKeysApi', () { + // Create an API key + // + // Creates a new API key. It will be limited to the permissions specified. + // + //Future createApiKey(ApiKeyCreateDto apiKeyCreateDto) async + test('test createApiKey', () async { + // TODO + }); + + // Delete an API key + // + // Deletes an API key identified by its ID. The current user must own this API key. + // + //Future deleteApiKey(String id) async + test('test deleteApiKey', () async { + // TODO + }); + + // Retrieve an API key + // + // Retrieve an API key by its ID. The current user must own this API key. + // + //Future getApiKey(String id) async + test('test getApiKey', () async { + // TODO + }); + + // List all API keys + // + // Retrieve all API keys of the current user. + // + //Future> getApiKeys() async + test('test getApiKeys', () async { + // TODO + }); + + // Retrieve the current API key + // + // Retrieve the API key that is used to access this endpoint. + // + //Future getMyApiKey() async + test('test getMyApiKey', () async { + // TODO + }); + + // Update an API key + // + // Updates the name and permissions of an API key by its ID. The current user must own this API key. + // + //Future updateApiKey(String id, ApiKeyUpdateDto apiKeyUpdateDto) async + test('test updateApiKey', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/asset_bulk_delete_dto_test.dart b/mobile/openapi/test/asset_bulk_delete_dto_test.dart new file mode 100644 index 0000000000000..ef3d4b4f7446a --- /dev/null +++ b/mobile/openapi/test/asset_bulk_delete_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetBulkDeleteDto +void main() { + // final instance = AssetBulkDeleteDto(); + + group('test AssetBulkDeleteDto', () { + // Force delete even if in use + // Optional force + test('to test the property `force`', () async { + // TODO + }); + + // IDs to process + // List ids (default value: const []) + test('to test the property `ids`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_bulk_update_dto_test.dart b/mobile/openapi/test/asset_bulk_update_dto_test.dart new file mode 100644 index 0000000000000..22c2b77d61f4c --- /dev/null +++ b/mobile/openapi/test/asset_bulk_update_dto_test.dart @@ -0,0 +1,87 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetBulkUpdateDto +void main() { + // final instance = AssetBulkUpdateDto(); + + group('test AssetBulkUpdateDto', () { + // Original date and time + // Optional dateTimeOriginal + test('to test the property `dateTimeOriginal`', () async { + // TODO + }); + + // Relative time offset in minutes + // Optional dateTimeRelative + test('to test the property `dateTimeRelative`', () async { + // TODO + }); + + // Asset description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Duplicate ID + // Optional duplicateId + test('to test the property `duplicateId`', () async { + // TODO + }); + + // Asset IDs to update + // List ids (default value: const []) + test('to test the property `ids`', () async { + // TODO + }); + + // Mark as favorite + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Latitude coordinate + // Optional latitude + test('to test the property `latitude`', () async { + // TODO + }); + + // Longitude coordinate + // Optional longitude + test('to test the property `longitude`', () async { + // TODO + }); + + // Rating in range [1-5] (starred), -1 (rejected), or null (unrated) + // Optional rating + test('to test the property `rating`', () async { + // TODO + }); + + // Time zone (IANA timezone) + // Optional timeZone + test('to test the property `timeZone`', () async { + // TODO + }); + + // Optional visibility + test('to test the property `visibility`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_bulk_upload_check_dto_test.dart b/mobile/openapi/test/asset_bulk_upload_check_dto_test.dart new file mode 100644 index 0000000000000..204145bffc6c9 --- /dev/null +++ b/mobile/openapi/test/asset_bulk_upload_check_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetBulkUploadCheckDto +void main() { + // final instance = AssetBulkUploadCheckDto(); + + group('test AssetBulkUploadCheckDto', () { + // Assets to check + // List assets (default value: const []) + test('to test the property `assets`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_bulk_upload_check_item_test.dart b/mobile/openapi/test/asset_bulk_upload_check_item_test.dart new file mode 100644 index 0000000000000..a796d3682baaf --- /dev/null +++ b/mobile/openapi/test/asset_bulk_upload_check_item_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetBulkUploadCheckItem +void main() { + // final instance = AssetBulkUploadCheckItem(); + + group('test AssetBulkUploadCheckItem', () { + // Base64 or hex encoded SHA1 hash + // String checksum + test('to test the property `checksum`', () async { + // TODO + }); + + // Client-side identifier echoed in the response to match results to inputs (e.g. filename) + // String id + test('to test the property `id`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_bulk_upload_check_response_dto_test.dart b/mobile/openapi/test/asset_bulk_upload_check_response_dto_test.dart new file mode 100644 index 0000000000000..0719ad0c91bfb --- /dev/null +++ b/mobile/openapi/test/asset_bulk_upload_check_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetBulkUploadCheckResponseDto +void main() { + // final instance = AssetBulkUploadCheckResponseDto(); + + group('test AssetBulkUploadCheckResponseDto', () { + // Upload check results + // List results (default value: const []) + test('to test the property `results`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_bulk_upload_check_result_test.dart b/mobile/openapi/test/asset_bulk_upload_check_result_test.dart new file mode 100644 index 0000000000000..fcf093d9b2ecd --- /dev/null +++ b/mobile/openapi/test/asset_bulk_upload_check_result_test.dart @@ -0,0 +1,50 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetBulkUploadCheckResult +void main() { + // final instance = AssetBulkUploadCheckResult(); + + group('test AssetBulkUploadCheckResult', () { + // AssetUploadAction action + test('to test the property `action`', () async { + // TODO + }); + + // Existing asset ID if duplicate + // Optional assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Client-side identifier echoed from the request to match results to inputs + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Whether existing asset is trashed + // Optional isTrashed + test('to test the property `isTrashed`', () async { + // TODO + }); + + // Optional reason + test('to test the property `reason`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_copy_dto_test.dart b/mobile/openapi/test/asset_copy_dto_test.dart new file mode 100644 index 0000000000000..f2fa84a049af1 --- /dev/null +++ b/mobile/openapi/test/asset_copy_dto_test.dart @@ -0,0 +1,64 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetCopyDto +void main() { + // final instance = AssetCopyDto(); + + group('test AssetCopyDto', () { + // Copy album associations + // Optional albums (default value: true) + test('to test the property `albums`', () async { + // TODO + }); + + // Copy favorite status + // Optional favorite (default value: true) + test('to test the property `favorite`', () async { + // TODO + }); + + // Copy shared links + // Optional sharedLinks (default value: true) + test('to test the property `sharedLinks`', () async { + // TODO + }); + + // Copy sidecar file + // Optional sidecar (default value: true) + test('to test the property `sidecar`', () async { + // TODO + }); + + // Source asset ID + // String sourceId + test('to test the property `sourceId`', () async { + // TODO + }); + + // Copy stack association + // Optional stack (default value: true) + test('to test the property `stack`', () async { + // TODO + }); + + // Target asset ID + // String targetId + test('to test the property `targetId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_edit_action_item_dto_parameters_test.dart b/mobile/openapi/test/asset_edit_action_item_dto_parameters_test.dart new file mode 100644 index 0000000000000..a61f633324124 --- /dev/null +++ b/mobile/openapi/test/asset_edit_action_item_dto_parameters_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetEditActionItemDtoParameters +void main() { + // final instance = AssetEditActionItemDtoParameters(); + + group('test AssetEditActionItemDtoParameters', () { + // Height of the crop + // int height + test('to test the property `height`', () async { + // TODO + }); + + // Width of the crop + // int width + test('to test the property `width`', () async { + // TODO + }); + + // Top-Left X coordinate of crop + // int x + test('to test the property `x`', () async { + // TODO + }); + + // Top-Left Y coordinate of crop + // int y + test('to test the property `y`', () async { + // TODO + }); + + // Rotation angle in degrees + // num angle + test('to test the property `angle`', () async { + // TODO + }); + + // MirrorAxis axis + test('to test the property `axis`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_edit_action_item_dto_test.dart b/mobile/openapi/test/asset_edit_action_item_dto_test.dart new file mode 100644 index 0000000000000..dc7f5c8dee33f --- /dev/null +++ b/mobile/openapi/test/asset_edit_action_item_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetEditActionItemDto +void main() { + // final instance = AssetEditActionItemDto(); + + group('test AssetEditActionItemDto', () { + // AssetEditAction action + test('to test the property `action`', () async { + // TODO + }); + + // AssetEditActionItemDtoParameters parameters + test('to test the property `parameters`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_edit_action_item_response_dto_test.dart b/mobile/openapi/test/asset_edit_action_item_response_dto_test.dart new file mode 100644 index 0000000000000..38c5f87443fd0 --- /dev/null +++ b/mobile/openapi/test/asset_edit_action_item_response_dto_test.dart @@ -0,0 +1,38 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetEditActionItemResponseDto +void main() { + // final instance = AssetEditActionItemResponseDto(); + + group('test AssetEditActionItemResponseDto', () { + // AssetEditAction action + test('to test the property `action`', () async { + // TODO + }); + + // Asset edit ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // AssetEditActionItemDtoParameters parameters + test('to test the property `parameters`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_edit_action_test.dart b/mobile/openapi/test/asset_edit_action_test.dart new file mode 100644 index 0000000000000..9a4f7599dde3d --- /dev/null +++ b/mobile/openapi/test/asset_edit_action_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetEditAction +void main() { + + group('test AssetEditAction', () { + + }); + +} diff --git a/mobile/openapi/test/asset_edits_create_dto_test.dart b/mobile/openapi/test/asset_edits_create_dto_test.dart new file mode 100644 index 0000000000000..cf83008e8b3e8 --- /dev/null +++ b/mobile/openapi/test/asset_edits_create_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetEditsCreateDto +void main() { + // final instance = AssetEditsCreateDto(); + + group('test AssetEditsCreateDto', () { + // List of edit actions to apply (crop, rotate, or mirror) + // List edits (default value: const []) + test('to test the property `edits`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_edits_response_dto_test.dart b/mobile/openapi/test/asset_edits_response_dto_test.dart new file mode 100644 index 0000000000000..58b80d84812be --- /dev/null +++ b/mobile/openapi/test/asset_edits_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetEditsResponseDto +void main() { + // final instance = AssetEditsResponseDto(); + + group('test AssetEditsResponseDto', () { + // Asset ID these edits belong to + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // List of edit actions applied to the asset + // List edits (default value: const []) + test('to test the property `edits`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_face_create_dto_test.dart b/mobile/openapi/test/asset_face_create_dto_test.dart new file mode 100644 index 0000000000000..54181fa000d3f --- /dev/null +++ b/mobile/openapi/test/asset_face_create_dto_test.dart @@ -0,0 +1,70 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetFaceCreateDto +void main() { + // final instance = AssetFaceCreateDto(); + + group('test AssetFaceCreateDto', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Face bounding box height + // int height + test('to test the property `height`', () async { + // TODO + }); + + // Image height in pixels + // int imageHeight + test('to test the property `imageHeight`', () async { + // TODO + }); + + // Image width in pixels + // int imageWidth + test('to test the property `imageWidth`', () async { + // TODO + }); + + // Person ID + // String personId + test('to test the property `personId`', () async { + // TODO + }); + + // Face bounding box width + // int width + test('to test the property `width`', () async { + // TODO + }); + + // Face bounding box X coordinate + // int x + test('to test the property `x`', () async { + // TODO + }); + + // Face bounding box Y coordinate + // int y + test('to test the property `y`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_face_delete_dto_test.dart b/mobile/openapi/test/asset_face_delete_dto_test.dart new file mode 100644 index 0000000000000..381e6f745c225 --- /dev/null +++ b/mobile/openapi/test/asset_face_delete_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetFaceDeleteDto +void main() { + // final instance = AssetFaceDeleteDto(); + + group('test AssetFaceDeleteDto', () { + // Force delete even if person has other faces + // bool force + test('to test the property `force`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_face_response_dto_test.dart b/mobile/openapi/test/asset_face_response_dto_test.dart new file mode 100644 index 0000000000000..7b23da1f67c08 --- /dev/null +++ b/mobile/openapi/test/asset_face_response_dto_test.dart @@ -0,0 +1,74 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetFaceResponseDto +void main() { + // final instance = AssetFaceResponseDto(); + + group('test AssetFaceResponseDto', () { + // Bounding box X1 coordinate + // int boundingBoxX1 + test('to test the property `boundingBoxX1`', () async { + // TODO + }); + + // Bounding box X2 coordinate + // int boundingBoxX2 + test('to test the property `boundingBoxX2`', () async { + // TODO + }); + + // Bounding box Y1 coordinate + // int boundingBoxY1 + test('to test the property `boundingBoxY1`', () async { + // TODO + }); + + // Bounding box Y2 coordinate + // int boundingBoxY2 + test('to test the property `boundingBoxY2`', () async { + // TODO + }); + + // Face ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Image height in pixels + // int imageHeight + test('to test the property `imageHeight`', () async { + // TODO + }); + + // Image width in pixels + // int imageWidth + test('to test the property `imageWidth`', () async { + // TODO + }); + + // PersonResponseDto person + test('to test the property `person`', () async { + // TODO + }); + + // Optional sourceType + test('to test the property `sourceType`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_face_update_dto_test.dart b/mobile/openapi/test/asset_face_update_dto_test.dart new file mode 100644 index 0000000000000..0b4b4bd41963e --- /dev/null +++ b/mobile/openapi/test/asset_face_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetFaceUpdateDto +void main() { + // final instance = AssetFaceUpdateDto(); + + group('test AssetFaceUpdateDto', () { + // Face update items + // List data (default value: const []) + test('to test the property `data`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_face_update_item_test.dart b/mobile/openapi/test/asset_face_update_item_test.dart new file mode 100644 index 0000000000000..3a4fa57919c99 --- /dev/null +++ b/mobile/openapi/test/asset_face_update_item_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetFaceUpdateItem +void main() { + // final instance = AssetFaceUpdateItem(); + + group('test AssetFaceUpdateItem', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Person ID + // String personId + test('to test the property `personId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_id_error_reason_test.dart b/mobile/openapi/test/asset_id_error_reason_test.dart new file mode 100644 index 0000000000000..c47b2fafdf775 --- /dev/null +++ b/mobile/openapi/test/asset_id_error_reason_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetIdErrorReason +void main() { + + group('test AssetIdErrorReason', () { + + }); + +} diff --git a/mobile/openapi/test/asset_ids_dto_test.dart b/mobile/openapi/test/asset_ids_dto_test.dart new file mode 100644 index 0000000000000..58c64e39c0b7a --- /dev/null +++ b/mobile/openapi/test/asset_ids_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetIdsDto +void main() { + // final instance = AssetIdsDto(); + + group('test AssetIdsDto', () { + // Asset IDs + // List assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_ids_response_dto_test.dart b/mobile/openapi/test/asset_ids_response_dto_test.dart new file mode 100644 index 0000000000000..e8bb3a24b67df --- /dev/null +++ b/mobile/openapi/test/asset_ids_response_dto_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetIdsResponseDto +void main() { + // final instance = AssetIdsResponseDto(); + + group('test AssetIdsResponseDto', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Optional error + test('to test the property `error`', () async { + // TODO + }); + + // Whether operation succeeded + // bool success + test('to test the property `success`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_job_name_test.dart b/mobile/openapi/test/asset_job_name_test.dart new file mode 100644 index 0000000000000..0a8a74cb8e923 --- /dev/null +++ b/mobile/openapi/test/asset_job_name_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetJobName +void main() { + + group('test AssetJobName', () { + + }); + +} diff --git a/mobile/openapi/test/asset_jobs_dto_test.dart b/mobile/openapi/test/asset_jobs_dto_test.dart new file mode 100644 index 0000000000000..f071a73cc6c6a --- /dev/null +++ b/mobile/openapi/test/asset_jobs_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetJobsDto +void main() { + // final instance = AssetJobsDto(); + + group('test AssetJobsDto', () { + // Asset IDs + // List assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // AssetJobName name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_media_response_dto_test.dart b/mobile/openapi/test/asset_media_response_dto_test.dart new file mode 100644 index 0000000000000..cedf6566eef39 --- /dev/null +++ b/mobile/openapi/test/asset_media_response_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMediaResponseDto +void main() { + // final instance = AssetMediaResponseDto(); + + group('test AssetMediaResponseDto', () { + // Asset media ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // AssetMediaStatus status + test('to test the property `status`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_media_size_test.dart b/mobile/openapi/test/asset_media_size_test.dart new file mode 100644 index 0000000000000..f56d3550b0657 --- /dev/null +++ b/mobile/openapi/test/asset_media_size_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMediaSize +void main() { + + group('test AssetMediaSize', () { + + }); + +} diff --git a/mobile/openapi/test/asset_media_status_test.dart b/mobile/openapi/test/asset_media_status_test.dart new file mode 100644 index 0000000000000..5b165ca22cba0 --- /dev/null +++ b/mobile/openapi/test/asset_media_status_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMediaStatus +void main() { + + group('test AssetMediaStatus', () { + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_bulk_delete_dto_test.dart b/mobile/openapi/test/asset_metadata_bulk_delete_dto_test.dart new file mode 100644 index 0000000000000..8b1b0f62f4457 --- /dev/null +++ b/mobile/openapi/test/asset_metadata_bulk_delete_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataBulkDeleteDto +void main() { + // final instance = AssetMetadataBulkDeleteDto(); + + group('test AssetMetadataBulkDeleteDto', () { + // Metadata items to delete + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_bulk_delete_item_dto_test.dart b/mobile/openapi/test/asset_metadata_bulk_delete_item_dto_test.dart new file mode 100644 index 0000000000000..cfa8c0062f689 --- /dev/null +++ b/mobile/openapi/test/asset_metadata_bulk_delete_item_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataBulkDeleteItemDto +void main() { + // final instance = AssetMetadataBulkDeleteItemDto(); + + group('test AssetMetadataBulkDeleteItemDto', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Metadata key + // String key + test('to test the property `key`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_bulk_response_dto_test.dart b/mobile/openapi/test/asset_metadata_bulk_response_dto_test.dart new file mode 100644 index 0000000000000..b9ab34029c2c9 --- /dev/null +++ b/mobile/openapi/test/asset_metadata_bulk_response_dto_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataBulkResponseDto +void main() { + // final instance = AssetMetadataBulkResponseDto(); + + group('test AssetMetadataBulkResponseDto', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Metadata key + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + // Metadata value (object) + // Map value (default value: const {}) + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_bulk_upsert_dto_test.dart b/mobile/openapi/test/asset_metadata_bulk_upsert_dto_test.dart new file mode 100644 index 0000000000000..81fc607adc7df --- /dev/null +++ b/mobile/openapi/test/asset_metadata_bulk_upsert_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataBulkUpsertDto +void main() { + // final instance = AssetMetadataBulkUpsertDto(); + + group('test AssetMetadataBulkUpsertDto', () { + // Metadata items to upsert + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_bulk_upsert_item_dto_test.dart b/mobile/openapi/test/asset_metadata_bulk_upsert_item_dto_test.dart new file mode 100644 index 0000000000000..29e54195a3abf --- /dev/null +++ b/mobile/openapi/test/asset_metadata_bulk_upsert_item_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataBulkUpsertItemDto +void main() { + // final instance = AssetMetadataBulkUpsertItemDto(); + + group('test AssetMetadataBulkUpsertItemDto', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Metadata key + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Metadata value (object) + // Map value (default value: const {}) + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_response_dto_test.dart b/mobile/openapi/test/asset_metadata_response_dto_test.dart new file mode 100644 index 0000000000000..38080ababb404 --- /dev/null +++ b/mobile/openapi/test/asset_metadata_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataResponseDto +void main() { + // final instance = AssetMetadataResponseDto(); + + group('test AssetMetadataResponseDto', () { + // Metadata key + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + // Metadata value (object) + // Map value (default value: const {}) + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_upsert_dto_test.dart b/mobile/openapi/test/asset_metadata_upsert_dto_test.dart new file mode 100644 index 0000000000000..1225656583c58 --- /dev/null +++ b/mobile/openapi/test/asset_metadata_upsert_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataUpsertDto +void main() { + // final instance = AssetMetadataUpsertDto(); + + group('test AssetMetadataUpsertDto', () { + // Metadata items to upsert + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_metadata_upsert_item_dto_test.dart b/mobile/openapi/test/asset_metadata_upsert_item_dto_test.dart new file mode 100644 index 0000000000000..acce29b17b3ca --- /dev/null +++ b/mobile/openapi/test/asset_metadata_upsert_item_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetMetadataUpsertItemDto +void main() { + // final instance = AssetMetadataUpsertItemDto(); + + group('test AssetMetadataUpsertItemDto', () { + // Metadata key + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Metadata value (object) + // Map value (default value: const {}) + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_ocr_response_dto_test.dart b/mobile/openapi/test/asset_ocr_response_dto_test.dart new file mode 100644 index 0000000000000..b3f7d7fb83c6e --- /dev/null +++ b/mobile/openapi/test/asset_ocr_response_dto_test.dart @@ -0,0 +1,98 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetOcrResponseDto +void main() { + // final instance = AssetOcrResponseDto(); + + group('test AssetOcrResponseDto', () { + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Confidence score for text detection box + // double boxScore + test('to test the property `boxScore`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Recognized text + // String text + test('to test the property `text`', () async { + // TODO + }); + + // Confidence score for text recognition + // double textScore + test('to test the property `textScore`', () async { + // TODO + }); + + // Normalized x coordinate of box corner 1 (0-1) + // double x1 + test('to test the property `x1`', () async { + // TODO + }); + + // Normalized x coordinate of box corner 2 (0-1) + // double x2 + test('to test the property `x2`', () async { + // TODO + }); + + // Normalized x coordinate of box corner 3 (0-1) + // double x3 + test('to test the property `x3`', () async { + // TODO + }); + + // Normalized x coordinate of box corner 4 (0-1) + // double x4 + test('to test the property `x4`', () async { + // TODO + }); + + // Normalized y coordinate of box corner 1 (0-1) + // double y1 + test('to test the property `y1`', () async { + // TODO + }); + + // Normalized y coordinate of box corner 2 (0-1) + // double y2 + test('to test the property `y2`', () async { + // TODO + }); + + // Normalized y coordinate of box corner 3 (0-1) + // double y3 + test('to test the property `y3`', () async { + // TODO + }); + + // Normalized y coordinate of box corner 4 (0-1) + // double y4 + test('to test the property `y4`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_order_by_test.dart b/mobile/openapi/test/asset_order_by_test.dart new file mode 100644 index 0000000000000..462bfb2b2a37b --- /dev/null +++ b/mobile/openapi/test/asset_order_by_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetOrderBy +void main() { + + group('test AssetOrderBy', () { + + }); + +} diff --git a/mobile/openapi/test/asset_order_test.dart b/mobile/openapi/test/asset_order_test.dart new file mode 100644 index 0000000000000..6c9c0004503ea --- /dev/null +++ b/mobile/openapi/test/asset_order_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetOrder +void main() { + + group('test AssetOrder', () { + + }); + +} diff --git a/mobile/openapi/test/asset_reject_reason_test.dart b/mobile/openapi/test/asset_reject_reason_test.dart new file mode 100644 index 0000000000000..4e2883f933e24 --- /dev/null +++ b/mobile/openapi/test/asset_reject_reason_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetRejectReason +void main() { + + group('test AssetRejectReason', () { + + }); + +} diff --git a/mobile/openapi/test/asset_response_dto_test.dart b/mobile/openapi/test/asset_response_dto_test.dart new file mode 100644 index 0000000000000..ba92e20feced7 --- /dev/null +++ b/mobile/openapi/test/asset_response_dto_test.dart @@ -0,0 +1,207 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetResponseDto +void main() { + // final instance = AssetResponseDto(); + + group('test AssetResponseDto', () { + // Base64 encoded SHA1 hash + // String checksum + test('to test the property `checksum`', () async { + // TODO + }); + + // The UTC timestamp when the asset was originally uploaded to Immich. + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Duplicate group ID + // Optional duplicateId + test('to test the property `duplicateId`', () async { + // TODO + }); + + // Video/gif duration in milliseconds (null for static images) + // int duration + test('to test the property `duration`', () async { + // TODO + }); + + // Optional exifInfo + test('to test the property `exifInfo`', () async { + // TODO + }); + + // The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken. + // DateTime fileCreatedAt + test('to test the property `fileCreatedAt`', () async { + // TODO + }); + + // The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken. + // DateTime fileModifiedAt + test('to test the property `fileModifiedAt`', () async { + // TODO + }); + + // Whether asset has metadata + // bool hasMetadata + test('to test the property `hasMetadata`', () async { + // TODO + }); + + // Asset height + // int height + test('to test the property `height`', () async { + // TODO + }); + + // Asset ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is archived + // bool isArchived + test('to test the property `isArchived`', () async { + // TODO + }); + + // Is edited + // bool isEdited + test('to test the property `isEdited`', () async { + // TODO + }); + + // Is favorite + // bool isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Is offline + // bool isOffline + test('to test the property `isOffline`', () async { + // TODO + }); + + // Is trashed + // bool isTrashed + test('to test the property `isTrashed`', () async { + // TODO + }); + + // Library ID + // Optional libraryId + test('to test the property `libraryId`', () async { + // TODO + }); + + // Live photo video ID + // Optional livePhotoVideoId + test('to test the property `livePhotoVideoId`', () async { + // TODO + }); + + // The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by \"local\" days and months. + // DateTime localDateTime + test('to test the property `localDateTime`', () async { + // TODO + }); + + // Original file name + // String originalFileName + test('to test the property `originalFileName`', () async { + // TODO + }); + + // Original MIME type + // Optional originalMimeType + test('to test the property `originalMimeType`', () async { + // TODO + }); + + // Original file path + // String originalPath + test('to test the property `originalPath`', () async { + // TODO + }); + + // Optional owner + test('to test the property `owner`', () async { + // TODO + }); + + // Owner user ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Optional?> people (default value: const []) + test('to test the property `people`', () async { + // TODO + }); + + // Is resized + // Optional resized + test('to test the property `resized`', () async { + // TODO + }); + + // Optional stack + test('to test the property `stack`', () async { + // TODO + }); + + // Optional?> tags (default value: const []) + test('to test the property `tags`', () async { + // TODO + }); + + // Thumbhash for thumbnail generation (base64) also used as the c query param for thumbnail cache busting. + // String thumbhash + test('to test the property `thumbhash`', () async { + // TODO + }); + + // AssetTypeEnum type + test('to test the property `type`', () async { + // TODO + }); + + // The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified. + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + // AssetVisibility visibility + test('to test the property `visibility`', () async { + // TODO + }); + + // Asset width + // int width + test('to test the property `width`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_stack_response_dto_test.dart b/mobile/openapi/test/asset_stack_response_dto_test.dart new file mode 100644 index 0000000000000..cfc1d26b0a425 --- /dev/null +++ b/mobile/openapi/test/asset_stack_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetStackResponseDto +void main() { + // final instance = AssetStackResponseDto(); + + group('test AssetStackResponseDto', () { + // Number of assets in stack + // int assetCount + test('to test the property `assetCount`', () async { + // TODO + }); + + // Stack ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Primary asset ID + // String primaryAssetId + test('to test the property `primaryAssetId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_stats_response_dto_test.dart b/mobile/openapi/test/asset_stats_response_dto_test.dart new file mode 100644 index 0000000000000..0861f878e4870 --- /dev/null +++ b/mobile/openapi/test/asset_stats_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetStatsResponseDto +void main() { + // final instance = AssetStatsResponseDto(); + + group('test AssetStatsResponseDto', () { + // Number of images + // int images + test('to test the property `images`', () async { + // TODO + }); + + // Total number of assets + // int total + test('to test the property `total`', () async { + // TODO + }); + + // Number of videos + // int videos + test('to test the property `videos`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/asset_type_enum_test.dart b/mobile/openapi/test/asset_type_enum_test.dart new file mode 100644 index 0000000000000..deabc07169f95 --- /dev/null +++ b/mobile/openapi/test/asset_type_enum_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetTypeEnum +void main() { + + group('test AssetTypeEnum', () { + + }); + +} diff --git a/mobile/openapi/test/asset_upload_action_test.dart b/mobile/openapi/test/asset_upload_action_test.dart new file mode 100644 index 0000000000000..f87e3fbe5392e --- /dev/null +++ b/mobile/openapi/test/asset_upload_action_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetUploadAction +void main() { + + group('test AssetUploadAction', () { + + }); + +} diff --git a/mobile/openapi/test/asset_visibility_test.dart b/mobile/openapi/test/asset_visibility_test.dart new file mode 100644 index 0000000000000..d9329842af760 --- /dev/null +++ b/mobile/openapi/test/asset_visibility_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AssetVisibility +void main() { + + group('test AssetVisibility', () { + + }); + +} diff --git a/mobile/openapi/test/assets_api_test.dart b/mobile/openapi/test/assets_api_test.dart new file mode 100644 index 0000000000000..7177b4073c44c --- /dev/null +++ b/mobile/openapi/test/assets_api_test.dart @@ -0,0 +1,255 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for AssetsApi +void main() { + // final instance = AssetsApi(); + + group('tests for AssetsApi', () { + // Check bulk upload + // + // Determine which assets have already been uploaded to the server based on their SHA1 checksums. + // + //Future checkBulkUpload(AssetBulkUploadCheckDto assetBulkUploadCheckDto) async + test('test checkBulkUpload', () async { + // TODO + }); + + // Copy asset + // + // Copy asset information like albums, tags, etc. from one asset to another. + // + //Future copyAsset(AssetCopyDto assetCopyDto) async + test('test copyAsset', () async { + // TODO + }); + + // Delete asset metadata by key + // + // Delete a specific metadata key-value pair associated with the specified asset. + // + //Future deleteAssetMetadata(String id, String key) async + test('test deleteAssetMetadata', () async { + // TODO + }); + + // Delete assets + // + // Deletes multiple assets at the same time. + // + //Future deleteAssets(AssetBulkDeleteDto assetBulkDeleteDto) async + test('test deleteAssets', () async { + // TODO + }); + + // Delete asset metadata + // + // Delete metadata key-value pairs for multiple assets. + // + //Future deleteBulkAssetMetadata(AssetMetadataBulkDeleteDto assetMetadataBulkDeleteDto) async + test('test deleteBulkAssetMetadata', () async { + // TODO + }); + + // Download original asset + // + // Downloads the original file of the specified asset. + // + //Future downloadAsset(String id, { bool edited, String key, String slug }) async + test('test downloadAsset', () async { + // TODO + }); + + // Apply edits to an existing asset + // + // Apply a series of edit actions (crop, rotate, mirror) to the specified asset. + // + //Future editAsset(String id, AssetEditsCreateDto assetEditsCreateDto) async + test('test editAsset', () async { + // TODO + }); + + // End HLS streaming session + // + // Releases server resources for the streaming session. + // + //Future endSession(String id, String sessionId, { String key, String slug }) async + test('test endSession', () async { + // TODO + }); + + // Retrieve edits for an existing asset + // + // Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset. + // + //Future getAssetEdits(String id) async + test('test getAssetEdits', () async { + // TODO + }); + + // Retrieve an asset + // + // Retrieve detailed information about a specific asset. + // + //Future getAssetInfo(String id, { String key, String slug }) async + test('test getAssetInfo', () async { + // TODO + }); + + // Get asset metadata + // + // Retrieve all metadata key-value pairs associated with the specified asset. + // + //Future> getAssetMetadata(String id) async + test('test getAssetMetadata', () async { + // TODO + }); + + // Retrieve asset metadata by key + // + // Retrieve the value of a specific metadata key associated with the specified asset. + // + //Future getAssetMetadataByKey(String id, String key) async + test('test getAssetMetadataByKey', () async { + // TODO + }); + + // Retrieve asset OCR data + // + // Retrieve all OCR (Optical Character Recognition) data associated with the specified asset. + // + //Future> getAssetOcr(String id) async + test('test getAssetOcr', () async { + // TODO + }); + + // Get asset statistics + // + // Retrieve various statistics about the assets owned by the authenticated user. + // + //Future getAssetStatistics({ bool isFavorite, bool isTrashed, AssetVisibility visibility }) async + test('test getAssetStatistics', () async { + // TODO + }); + + // Get HLS main playlist + // + // Returns an HLS main playlist with all available variants for the asset. + // + //Future getMainPlaylist(String id, { String key, String slug }) async + test('test getMainPlaylist', () async { + // TODO + }); + + // Get HLS media playlist + // + // Returns an HLS media playlist for one variant of the streaming session. + // + //Future getMediaPlaylist(String id, String sessionId, int variantIndex, { String key, String slug, num xImmichHlsPos }) async + test('test getMediaPlaylist', () async { + // TODO + }); + + // Get HLS segment or init file + // + // Streams an HLS init segment (init.mp4) or media segment (seg_N.m4s). + // + //Future getSegment(String filename, String id, String sessionId, int variantIndex, { String key, String slug, int xImmichHlsMsn }) async + test('test getSegment', () async { + // TODO + }); + + // Play asset video + // + // Streams the video file for the specified asset. This endpoint also supports byte range requests. + // + //Future playAssetVideo(String id, { String key, String slug }) async + test('test playAssetVideo', () async { + // TODO + }); + + // Remove edits from an existing asset + // + // Removes all edit actions (crop, rotate, mirror) associated with the specified asset. + // + //Future removeAssetEdits(String id) async + test('test removeAssetEdits', () async { + // TODO + }); + + // Run an asset job + // + // Run a specific job on a set of assets. + // + //Future runAssetJobs(AssetJobsDto assetJobsDto) async + test('test runAssetJobs', () async { + // TODO + }); + + // Update an asset + // + // Update information of a specific asset. + // + //Future updateAsset(String id, UpdateAssetDto updateAssetDto) async + test('test updateAsset', () async { + // TODO + }); + + // Update asset metadata + // + // Update or add metadata key-value pairs for the specified asset. + // + //Future> updateAssetMetadata(String id, AssetMetadataUpsertDto assetMetadataUpsertDto) async + test('test updateAssetMetadata', () async { + // TODO + }); + + // Update assets + // + // Updates multiple assets at the same time. + // + //Future updateAssets(AssetBulkUpdateDto assetBulkUpdateDto) async + test('test updateAssets', () async { + // TODO + }); + + // Upsert asset metadata + // + // Upsert metadata key-value pairs for multiple assets. + // + //Future> updateBulkAssetMetadata(AssetMetadataBulkUpsertDto assetMetadataBulkUpsertDto) async + test('test updateBulkAssetMetadata', () async { + // TODO + }); + + // Upload asset + // + // Uploads a new asset to the server. + // + //Future uploadAsset(MultipartFile assetData, DateTime fileCreatedAt, DateTime fileModifiedAt, { String key, String slug, String xImmichChecksum, int duration, String filename, bool isFavorite, String livePhotoVideoId, List metadata, MultipartFile sidecarData, AssetVisibility visibility }) async + test('test uploadAsset', () async { + // TODO + }); + + // View asset thumbnail + // + // Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission. + // + //Future viewAsset(String id, { bool edited, String key, AssetMediaSize size, String slug }) async + test('test viewAsset', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/audio_codec_test.dart b/mobile/openapi/test/audio_codec_test.dart new file mode 100644 index 0000000000000..0905ef8c4f85a --- /dev/null +++ b/mobile/openapi/test/audio_codec_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AudioCodec +void main() { + + group('test AudioCodec', () { + + }); + +} diff --git a/mobile/openapi/test/auth_api_test.dart b/mobile/openapi/test/auth_api_test.dart new file mode 100644 index 0000000000000..d938ae50c7451 --- /dev/null +++ b/mobile/openapi/test/auth_api_test.dart @@ -0,0 +1,26 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for AuthApi +void main() { + // final instance = AuthApi(); + + group('tests for AuthApi', () { + //Future oidcDeviceFlow() async + test('test oidcDeviceFlow', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/auth_status_response_dto_test.dart b/mobile/openapi/test/auth_status_response_dto_test.dart new file mode 100644 index 0000000000000..f606a30e51f42 --- /dev/null +++ b/mobile/openapi/test/auth_status_response_dto_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AuthStatusResponseDto +void main() { + // final instance = AuthStatusResponseDto(); + + group('test AuthStatusResponseDto', () { + // Session expiration date + // Optional expiresAt + test('to test the property `expiresAt`', () async { + // TODO + }); + + // Is elevated session + // bool isElevated + test('to test the property `isElevated`', () async { + // TODO + }); + + // Has password set + // bool password + test('to test the property `password`', () async { + // TODO + }); + + // Has PIN code set + // bool pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + // PIN expiration date + // Optional pinExpiresAt + test('to test the property `pinExpiresAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/authentication_admin_api_test.dart b/mobile/openapi/test/authentication_admin_api_test.dart new file mode 100644 index 0000000000000..d69ef93ed6a61 --- /dev/null +++ b/mobile/openapi/test/authentication_admin_api_test.dart @@ -0,0 +1,30 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for AuthenticationAdminApi +void main() { + // final instance = AuthenticationAdminApi(); + + group('tests for AuthenticationAdminApi', () { + // Unlink all OAuth accounts + // + // Unlinks all OAuth accounts associated with user accounts in the system. + // + //Future unlinkAllOAuthAccountsAdmin() async + test('test unlinkAllOAuthAccountsAdmin', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/authentication_api_test.dart b/mobile/openapi/test/authentication_api_test.dart new file mode 100644 index 0000000000000..9c02058e8e57d --- /dev/null +++ b/mobile/openapi/test/authentication_api_test.dart @@ -0,0 +1,174 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for AuthenticationApi +void main() { + // final instance = AuthenticationApi(); + + group('tests for AuthenticationApi', () { + // Change password + // + // Change the password of the current user. + // + //Future changePassword(ChangePasswordDto changePasswordDto) async + test('test changePassword', () async { + // TODO + }); + + // Change pin code + // + // Change the pin code for the current user. + // + //Future changePinCode(PinCodeChangeDto pinCodeChangeDto) async + test('test changePinCode', () async { + // TODO + }); + + // Finish OAuth + // + // Complete the OAuth authorization process by exchanging the authorization code for a session token. + // + //Future finishOAuth(OAuthCallbackDto oAuthCallbackDto) async + test('test finishOAuth', () async { + // TODO + }); + + // Retrieve auth status + // + // Get information about the current session, including whether the user has a password, and if the session can access locked assets. + // + //Future getAuthStatus() async + test('test getAuthStatus', () async { + // TODO + }); + + // Link OAuth account + // + // Link an OAuth account to the authenticated user. + // + //Future linkOAuthAccount(OAuthCallbackDto oAuthCallbackDto) async + test('test linkOAuthAccount', () async { + // TODO + }); + + // Lock auth session + // + // Remove elevated access to locked assets from the current session. + // + //Future lockAuthSession() async + test('test lockAuthSession', () async { + // TODO + }); + + // Login + // + // Login with username and password and receive a session token. + // + //Future login(LoginCredentialDto loginCredentialDto) async + test('test login', () async { + // TODO + }); + + // Logout + // + // Logout the current user and invalidate the session token. + // + //Future logout() async + test('test logout', () async { + // TODO + }); + + // Backchannel OAuth logout + // + // Logout the OAuth account and invalidate the session specified by the sid claim or all sessions if the sid claim is not present. + // + //Future logoutOAuth(String logoutToken) async + test('test logoutOAuth', () async { + // TODO + }); + + // Redirect OAuth to mobile + // + // Requests to this URL are automatically forwarded to the mobile app, and is used in some cases for OAuth redirecting. + // + //Future redirectOAuthToMobile() async + test('test redirectOAuthToMobile', () async { + // TODO + }); + + // Reset pin code + // + // Reset the pin code for the current user by providing the account password + // + //Future resetPinCode(PinCodeResetDto pinCodeResetDto) async + test('test resetPinCode', () async { + // TODO + }); + + // Setup pin code + // + // Setup a new pin code for the current user. + // + //Future setupPinCode(PinCodeSetupDto pinCodeSetupDto) async + test('test setupPinCode', () async { + // TODO + }); + + // Register admin + // + // Create the first admin user in the system. + // + //Future signUpAdmin(SignUpDto signUpDto) async + test('test signUpAdmin', () async { + // TODO + }); + + // Start OAuth + // + // Initiate the OAuth authorization process. + // + //Future startOAuth(OAuthConfigDto oAuthConfigDto) async + test('test startOAuth', () async { + // TODO + }); + + // Unlink OAuth account + // + // Unlink the OAuth account from the authenticated user. + // + //Future unlinkOAuthAccount() async + test('test unlinkOAuthAccount', () async { + // TODO + }); + + // Unlock auth session + // + // Temporarily grant the session elevated access to locked assets by providing the correct PIN code. + // + //Future unlockAuthSession(SessionUnlockDto sessionUnlockDto) async + test('test unlockAuthSession', () async { + // TODO + }); + + // Validate access token + // + // Validate the current authorization method is still valid. + // + //Future validateAccessToken() async + test('test validateAccessToken', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/avatar_update_test.dart b/mobile/openapi/test/avatar_update_test.dart new file mode 100644 index 0000000000000..99597a5618bf1 --- /dev/null +++ b/mobile/openapi/test/avatar_update_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for AvatarUpdate +void main() { + // final instance = AvatarUpdate(); + + group('test AvatarUpdate', () { + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/backend_api_test.dart b/mobile/openapi/test/backend_api_test.dart new file mode 100644 index 0000000000000..061dc862b2b93 --- /dev/null +++ b/mobile/openapi/test/backend_api_test.dart @@ -0,0 +1,31 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for BackendApi +void main() { + // final instance = BackendApi(); + + group('tests for BackendApi', () { + //Future createLocalBackend(CreateLocalBackendRequestDto createLocalBackendRequestDto) async + test('test createLocalBackend', () async { + // TODO + }); + + //Future getBackends() async + test('test getBackends', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/backend_dto_test.dart b/mobile/openapi/test/backend_dto_test.dart new file mode 100644 index 0000000000000..4e5eb88f5d386 --- /dev/null +++ b/mobile/openapi/test/backend_dto_test.dart @@ -0,0 +1,47 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BackendDto +void main() { + // final instance = BackendDto(); + + group('test BackendDto', () { + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Optional error + test('to test the property `error`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // bool isOnline + test('to test the property `isOnline`', () async { + // TODO + }); + + // BackendType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/backend_response_dto_test.dart b/mobile/openapi/test/backend_response_dto_test.dart new file mode 100644 index 0000000000000..e425e89ab0887 --- /dev/null +++ b/mobile/openapi/test/backend_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BackendResponseDto +void main() { + // final instance = BackendResponseDto(); + + group('test BackendResponseDto', () { + // BackendDto backend + test('to test the property `backend`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/backend_type_test.dart b/mobile/openapi/test/backend_type_test.dart new file mode 100644 index 0000000000000..e97dc1ad17180 --- /dev/null +++ b/mobile/openapi/test/backend_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BackendType +void main() { + + group('test BackendType', () { + + }); + +} diff --git a/mobile/openapi/test/backends_response_dto_test.dart b/mobile/openapi/test/backends_response_dto_test.dart new file mode 100644 index 0000000000000..9dcada1655dd2 --- /dev/null +++ b/mobile/openapi/test/backends_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BackendsResponseDto +void main() { + // final instance = BackendsResponseDto(); + + group('test BackendsResponseDto', () { + // List backends (default value: const []) + test('to test the property `backends`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/bootstrap_status_test.dart b/mobile/openapi/test/bootstrap_status_test.dart new file mode 100644 index 0000000000000..3d8df74f23ac0 --- /dev/null +++ b/mobile/openapi/test/bootstrap_status_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BootstrapStatus +void main() { + + group('test BootstrapStatus', () { + + }); + +} diff --git a/mobile/openapi/test/bulk_id_error_reason_test.dart b/mobile/openapi/test/bulk_id_error_reason_test.dart new file mode 100644 index 0000000000000..684ad7f03ef1e --- /dev/null +++ b/mobile/openapi/test/bulk_id_error_reason_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BulkIdErrorReason +void main() { + + group('test BulkIdErrorReason', () { + + }); + +} diff --git a/mobile/openapi/test/bulk_id_response_dto_test.dart b/mobile/openapi/test/bulk_id_response_dto_test.dart new file mode 100644 index 0000000000000..6d32670202eb9 --- /dev/null +++ b/mobile/openapi/test/bulk_id_response_dto_test.dart @@ -0,0 +1,44 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BulkIdResponseDto +void main() { + // final instance = BulkIdResponseDto(); + + group('test BulkIdResponseDto', () { + // Optional error + test('to test the property `error`', () async { + // TODO + }); + + // Optional errorMessage + test('to test the property `errorMessage`', () async { + // TODO + }); + + // ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Whether operation succeeded + // bool success + test('to test the property `success`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/bulk_ids_dto_test.dart b/mobile/openapi/test/bulk_ids_dto_test.dart new file mode 100644 index 0000000000000..18c5b829dc8fc --- /dev/null +++ b/mobile/openapi/test/bulk_ids_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for BulkIdsDto +void main() { + // final instance = BulkIdsDto(); + + group('test BulkIdsDto', () { + // IDs to process + // List ids (default value: const []) + test('to test the property `ids`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/calendar_heatmap_response_dto_series_inner_test.dart b/mobile/openapi/test/calendar_heatmap_response_dto_series_inner_test.dart new file mode 100644 index 0000000000000..907cc9c5ca7f3 --- /dev/null +++ b/mobile/openapi/test/calendar_heatmap_response_dto_series_inner_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CalendarHeatmapResponseDtoSeriesInner +void main() { + // final instance = CalendarHeatmapResponseDtoSeriesInner(); + + group('test CalendarHeatmapResponseDtoSeriesInner', () { + // Activity count + // int count + test('to test the property `count`', () async { + // TODO + }); + + // Date in UTC + // String date + test('to test the property `date`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/calendar_heatmap_response_dto_test.dart b/mobile/openapi/test/calendar_heatmap_response_dto_test.dart new file mode 100644 index 0000000000000..13f099f63a5e4 --- /dev/null +++ b/mobile/openapi/test/calendar_heatmap_response_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CalendarHeatmapResponseDto +void main() { + // final instance = CalendarHeatmapResponseDto(); + + group('test CalendarHeatmapResponseDto', () { + // Start date in UTC + // String from + test('to test the property `from`', () async { + // TODO + }); + + // List series (default value: const []) + test('to test the property `series`', () async { + // TODO + }); + + // End date in UTC + // String to + test('to test the property `to`', () async { + // TODO + }); + + // Total activity count over the period + // int totalCount + test('to test the property `totalCount`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/calendar_heatmap_type_test.dart b/mobile/openapi/test/calendar_heatmap_type_test.dart new file mode 100644 index 0000000000000..848a735984968 --- /dev/null +++ b/mobile/openapi/test/calendar_heatmap_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CalendarHeatmapType +void main() { + + group('test CalendarHeatmapType', () { + + }); + +} diff --git a/mobile/openapi/test/cast_response_test.dart b/mobile/openapi/test/cast_response_test.dart new file mode 100644 index 0000000000000..497458bfbcc53 --- /dev/null +++ b/mobile/openapi/test/cast_response_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CastResponse +void main() { + // final instance = CastResponse(); + + group('test CastResponse', () { + // Whether Google Cast is enabled + // bool gCastEnabled + test('to test the property `gCastEnabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/cast_update_test.dart b/mobile/openapi/test/cast_update_test.dart new file mode 100644 index 0000000000000..0d0f80ae66d4a --- /dev/null +++ b/mobile/openapi/test/cast_update_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CastUpdate +void main() { + // final instance = CastUpdate(); + + group('test CastUpdate', () { + // Whether Google Cast is enabled + // Optional gCastEnabled + test('to test the property `gCastEnabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/change_password_dto_test.dart b/mobile/openapi/test/change_password_dto_test.dart new file mode 100644 index 0000000000000..0394ba8043b51 --- /dev/null +++ b/mobile/openapi/test/change_password_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ChangePasswordDto +void main() { + // final instance = ChangePasswordDto(); + + group('test ChangePasswordDto', () { + // Invalidate all other sessions + // Optional invalidateSessions (default value: false) + test('to test the property `invalidateSessions`', () async { + // TODO + }); + + // New password (min 8 characters) + // String newPassword + test('to test the property `newPassword`', () async { + // TODO + }); + + // Current password + // String password + test('to test the property `password`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/clip_config_test.dart b/mobile/openapi/test/clip_config_test.dart new file mode 100644 index 0000000000000..9bfdb7fb06ed6 --- /dev/null +++ b/mobile/openapi/test/clip_config_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CLIPConfig +void main() { + // final instance = CLIPConfig(); + + group('test CLIPConfig', () { + // Whether the task is enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Name of the model to use + // String modelName + test('to test the property `modelName`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/colorspace_test.dart b/mobile/openapi/test/colorspace_test.dart new file mode 100644 index 0000000000000..9dc37aa56abdd --- /dev/null +++ b/mobile/openapi/test/colorspace_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for Colorspace +void main() { + + group('test Colorspace', () { + + }); + +} diff --git a/mobile/openapi/test/configure_immich_integration_request_dto_libraries_test.dart b/mobile/openapi/test/configure_immich_integration_request_dto_libraries_test.dart new file mode 100644 index 0000000000000..fc03c5290e87a --- /dev/null +++ b/mobile/openapi/test/configure_immich_integration_request_dto_libraries_test.dart @@ -0,0 +1,22 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ConfigureImmichIntegrationRequestDtoLibraries +void main() { + // final instance = ConfigureImmichIntegrationRequestDtoLibraries(); + + group('test ConfigureImmichIntegrationRequestDtoLibraries', () { + + }); + +} diff --git a/mobile/openapi/test/configure_immich_integration_request_dto_test.dart b/mobile/openapi/test/configure_immich_integration_request_dto_test.dart new file mode 100644 index 0000000000000..879e17a0653dd --- /dev/null +++ b/mobile/openapi/test/configure_immich_integration_request_dto_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ConfigureImmichIntegrationRequestDto +void main() { + // final instance = ConfigureImmichIntegrationRequestDto(); + + group('test ConfigureImmichIntegrationRequestDto', () { + // bool backupConfiguration + test('to test the property `backupConfiguration`', () async { + // TODO + }); + + // String cron + test('to test the property `cron`', () async { + // TODO + }); + + // List dataFolders (default value: const []) + test('to test the property `dataFolders`', () async { + // TODO + }); + + // ConfigureImmichIntegrationRequestDtoLibraries libraries + test('to test the property `libraries`', () async { + // TODO + }); + + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Optional retentionPolicy + test('to test the property `retentionPolicy`', () async { + // TODO + }); + + // bool worm + test('to test the property `worm`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/contributor_count_response_dto_test.dart b/mobile/openapi/test/contributor_count_response_dto_test.dart new file mode 100644 index 0000000000000..9838e941c5e77 --- /dev/null +++ b/mobile/openapi/test/contributor_count_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ContributorCountResponseDto +void main() { + // final instance = ContributorCountResponseDto(); + + group('test ContributorCountResponseDto', () { + // Number of assets contributed + // int assetCount + test('to test the property `assetCount`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/cq_mode_test.dart b/mobile/openapi/test/cq_mode_test.dart new file mode 100644 index 0000000000000..95fb52cdad4ac --- /dev/null +++ b/mobile/openapi/test/cq_mode_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CQMode +void main() { + + group('test CQMode', () { + + }); + +} diff --git a/mobile/openapi/test/create_album_dto_test.dart b/mobile/openapi/test/create_album_dto_test.dart new file mode 100644 index 0000000000000..9e338b7a3d047 --- /dev/null +++ b/mobile/openapi/test/create_album_dto_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CreateAlbumDto +void main() { + // final instance = CreateAlbumDto(); + + group('test CreateAlbumDto', () { + // Album name + // String albumName + test('to test the property `albumName`', () async { + // TODO + }); + + // Album users + // Optional?> albumUsers (default value: const []) + test('to test the property `albumUsers`', () async { + // TODO + }); + + // Initial asset IDs + // Optional?> assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // Album description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/create_library_dto_test.dart b/mobile/openapi/test/create_library_dto_test.dart new file mode 100644 index 0000000000000..30477c5527814 --- /dev/null +++ b/mobile/openapi/test/create_library_dto_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CreateLibraryDto +void main() { + // final instance = CreateLibraryDto(); + + group('test CreateLibraryDto', () { + // Exclusion patterns (max 128) + // Optional?> exclusionPatterns (default value: const []) + test('to test the property `exclusionPatterns`', () async { + // TODO + }); + + // Import paths (max 128) + // Optional?> importPaths (default value: const []) + test('to test the property `importPaths`', () async { + // TODO + }); + + // Library name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // Owner user ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/create_local_backend_request_dto_test.dart b/mobile/openapi/test/create_local_backend_request_dto_test.dart new file mode 100644 index 0000000000000..f28a1a226e356 --- /dev/null +++ b/mobile/openapi/test/create_local_backend_request_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CreateLocalBackendRequestDto +void main() { + // final instance = CreateLocalBackendRequestDto(); + + group('test CreateLocalBackendRequestDto', () { + // String path + test('to test the property `path`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/create_profile_image_response_dto_test.dart b/mobile/openapi/test/create_profile_image_response_dto_test.dart new file mode 100644 index 0000000000000..235e6fa0b01c2 --- /dev/null +++ b/mobile/openapi/test/create_profile_image_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CreateProfileImageResponseDto +void main() { + // final instance = CreateProfileImageResponseDto(); + + group('test CreateProfileImageResponseDto', () { + // Profile image change date + // DateTime profileChangedAt + test('to test the property `profileChangedAt`', () async { + // TODO + }); + + // Profile image file path + // String profileImagePath + test('to test the property `profileImagePath`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/crop_parameters_test.dart b/mobile/openapi/test/crop_parameters_test.dart new file mode 100644 index 0000000000000..884eea9e30637 --- /dev/null +++ b/mobile/openapi/test/crop_parameters_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CropParameters +void main() { + // final instance = CropParameters(); + + group('test CropParameters', () { + // Height of the crop + // int height + test('to test the property `height`', () async { + // TODO + }); + + // Width of the crop + // int width + test('to test the property `width`', () async { + // TODO + }); + + // Top-Left X coordinate of crop + // int x + test('to test the property `x`', () async { + // TODO + }); + + // Top-Left Y coordinate of crop + // int y + test('to test the property `y`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/current_recovery_key_response_test.dart b/mobile/openapi/test/current_recovery_key_response_test.dart new file mode 100644 index 0000000000000..4f325f279d6ad --- /dev/null +++ b/mobile/openapi/test/current_recovery_key_response_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for CurrentRecoveryKeyResponse +void main() { + // final instance = CurrentRecoveryKeyResponse(); + + group('test CurrentRecoveryKeyResponse', () { + // String recoveryKey + test('to test the property `recoveryKey`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/database_backup_config_test.dart b/mobile/openapi/test/database_backup_config_test.dart new file mode 100644 index 0000000000000..1cd040ac56104 --- /dev/null +++ b/mobile/openapi/test/database_backup_config_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DatabaseBackupConfig +void main() { + // final instance = DatabaseBackupConfig(); + + group('test DatabaseBackupConfig', () { + // Cron expression + // String cronExpression + test('to test the property `cronExpression`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Keep last amount + // int keepLastAmount + test('to test the property `keepLastAmount`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/database_backup_delete_dto_test.dart b/mobile/openapi/test/database_backup_delete_dto_test.dart new file mode 100644 index 0000000000000..daf16f8695c9e --- /dev/null +++ b/mobile/openapi/test/database_backup_delete_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DatabaseBackupDeleteDto +void main() { + // final instance = DatabaseBackupDeleteDto(); + + group('test DatabaseBackupDeleteDto', () { + // Backup filenames to delete + // List backups (default value: const []) + test('to test the property `backups`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/database_backup_dto_test.dart b/mobile/openapi/test/database_backup_dto_test.dart new file mode 100644 index 0000000000000..e82c41cff2bc2 --- /dev/null +++ b/mobile/openapi/test/database_backup_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DatabaseBackupDto +void main() { + // final instance = DatabaseBackupDto(); + + group('test DatabaseBackupDto', () { + // Backup filename + // String filename + test('to test the property `filename`', () async { + // TODO + }); + + // Backup file size + // int filesize + test('to test the property `filesize`', () async { + // TODO + }); + + // Backup timezone + // String timezone + test('to test the property `timezone`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/database_backup_list_response_dto_test.dart b/mobile/openapi/test/database_backup_list_response_dto_test.dart new file mode 100644 index 0000000000000..2c14b31f2eb8a --- /dev/null +++ b/mobile/openapi/test/database_backup_list_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DatabaseBackupListResponseDto +void main() { + // final instance = DatabaseBackupListResponseDto(); + + group('test DatabaseBackupListResponseDto', () { + // List of backups + // List backups (default value: const []) + test('to test the property `backups`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/database_backups_admin_api_test.dart b/mobile/openapi/test/database_backups_admin_api_test.dart new file mode 100644 index 0000000000000..0f6df37249fe2 --- /dev/null +++ b/mobile/openapi/test/database_backups_admin_api_test.dart @@ -0,0 +1,66 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for DatabaseBackupsAdminApi +void main() { + // final instance = DatabaseBackupsAdminApi(); + + group('tests for DatabaseBackupsAdminApi', () { + // Delete database backup + // + // Delete a backup by its filename + // + //Future deleteDatabaseBackup(DatabaseBackupDeleteDto databaseBackupDeleteDto) async + test('test deleteDatabaseBackup', () async { + // TODO + }); + + // Download database backup + // + // Downloads the database backup file + // + //Future downloadDatabaseBackup(String filename) async + test('test downloadDatabaseBackup', () async { + // TODO + }); + + // List database backups + // + // Get the list of the successful and failed backups + // + //Future listDatabaseBackups() async + test('test listDatabaseBackups', () async { + // TODO + }); + + // Start database backup restore flow + // + // Put Immich into maintenance mode to restore a backup (Immich must not be configured) + // + //Future startDatabaseRestoreFlow() async + test('test startDatabaseRestoreFlow', () async { + // TODO + }); + + // Upload database backup + // + // Uploads .sql/.sql.gz file to restore backup from + // + //Future uploadDatabaseBackup({ MultipartFile file }) async + test('test uploadDatabaseBackup', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/deprecated_api_test.dart b/mobile/openapi/test/deprecated_api_test.dart new file mode 100644 index 0000000000000..3b2342802e4b6 --- /dev/null +++ b/mobile/openapi/test/deprecated_api_test.dart @@ -0,0 +1,174 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for DeprecatedApi +void main() { + // final instance = DeprecatedApi(); + + group('tests for DeprecatedApi', () { + // Create a partner + // + // Create a new partner to share assets with. + // + //Future createPartnerDeprecated(String id) async + test('test createPartnerDeprecated', () async { + // TODO + }); + + // Retrieve queue counts and status + // + // Retrieve the counts of the current queue, as well as the current status. + // + //Future getQueuesLegacy() async + test('test getQueuesLegacy', () async { + // TODO + }); + + // Run jobs + // + // Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets. + // + //Future runQueueCommandLegacy(QueueName name, QueueCommandDto queueCommandDto) async + test('test runQueueCommandLegacy', () async { + // TODO + }); + + // Update an API key + // + // Updates the name and permissions of an API key by its ID. The current user must own this API key. + // + //Future updateApiKey(String id, ApiKeyUpdateDto apiKeyUpdateDto) async + test('test updateApiKey', () async { + // TODO + }); + + // Update an asset + // + // Update information of a specific asset. + // + //Future updateAsset(String id, UpdateAssetDto updateAssetDto) async + test('test updateAsset', () async { + // TODO + }); + + // Update assets + // + // Updates multiple assets at the same time. + // + //Future updateAssets(AssetBulkUpdateDto assetBulkUpdateDto) async + test('test updateAssets', () async { + // TODO + }); + + // Update a library + // + // Update an existing external library. + // + //Future updateLibrary(String id, UpdateLibraryDto updateLibraryDto) async + test('test updateLibrary', () async { + // TODO + }); + + // Update a memory + // + // Update an existing memory by its ID. + // + //Future updateMemory(String id, MemoryUpdateDto memoryUpdateDto) async + test('test updateMemory', () async { + // TODO + }); + + // Update my preferences + // + // Update the preferences of the current user. + // + //Future updateMyPreferences(UserPreferencesUpdateDto userPreferencesUpdateDto) async + test('test updateMyPreferences', () async { + // TODO + }); + + // Update current user + // + // Update the current user making the API request. + // + //Future updateMyUser(UserUpdateMeDto userUpdateMeDto) async + test('test updateMyUser', () async { + // TODO + }); + + // Update person + // + // Update an individual person. + // + //Future updatePerson(String id, PersonUpdateDto personUpdateDto) async + test('test updatePerson', () async { + // TODO + }); + + // Update a session + // + // Update a specific session identified by id. + // + //Future updateSession(String id, SessionUpdateDto sessionUpdateDto) async + test('test updateSession', () async { + // TODO + }); + + // Update a stack + // + // Update an existing stack by its ID. + // + //Future updateStack(String id, StackUpdateDto stackUpdateDto) async + test('test updateStack', () async { + // TODO + }); + + // Update a tag + // + // Update an existing tag identified by its ID. + // + //Future updateTag(String id, TagUpdateDto tagUpdateDto) async + test('test updateTag', () async { + // TODO + }); + + // Update a user + // + // Update an existing user. + // + //Future updateUserAdmin(String id, UserAdminUpdateDto userAdminUpdateDto) async + test('test updateUserAdmin', () async { + // TODO + }); + + // Update user preferences + // + // Update the preferences of a specific user. + // + //Future updateUserPreferencesAdmin(String id, UserPreferencesUpdateDto userPreferencesUpdateDto) async + test('test updateUserPreferencesAdmin', () async { + // TODO + }); + + // Update a workflow + // + // Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. + // + //Future updateWorkflow(String id, WorkflowUpdateDto workflowUpdateDto) async + test('test updateWorkflow', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/development_api_test.dart b/mobile/openapi/test/development_api_test.dart new file mode 100644 index 0000000000000..5e0b41ea2b8d1 --- /dev/null +++ b/mobile/openapi/test/development_api_test.dart @@ -0,0 +1,26 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for DevelopmentApi +void main() { + // final instance = DevelopmentApi(); + + group('tests for DevelopmentApi', () { + //Future resetOrchestrator() async + test('test resetOrchestrator', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/device_flow_response_dto_test.dart b/mobile/openapi/test/device_flow_response_dto_test.dart new file mode 100644 index 0000000000000..5ff23765581e8 --- /dev/null +++ b/mobile/openapi/test/device_flow_response_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DeviceFlowResponseDto +void main() { + // final instance = DeviceFlowResponseDto(); + + group('test DeviceFlowResponseDto', () { + // String userCode + test('to test the property `userCode`', () async { + // TODO + }); + + // String verificationUri + test('to test the property `verificationUri`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/download_api_test.dart b/mobile/openapi/test/download_api_test.dart new file mode 100644 index 0000000000000..7f1d36d8d8650 --- /dev/null +++ b/mobile/openapi/test/download_api_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for DownloadApi +void main() { + // final instance = DownloadApi(); + + group('tests for DownloadApi', () { + // Download asset archive + // + // Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint. + // + //Future downloadArchive(DownloadArchiveDto downloadArchiveDto, { String key, String slug }) async + test('test downloadArchive', () async { + // TODO + }); + + // Retrieve download information + // + // Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together. + // + //Future getDownloadInfo(DownloadInfoDto downloadInfoDto, { String key, String slug }) async + test('test getDownloadInfo', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/download_archive_dto_test.dart b/mobile/openapi/test/download_archive_dto_test.dart new file mode 100644 index 0000000000000..891e4dd0a2a6b --- /dev/null +++ b/mobile/openapi/test/download_archive_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DownloadArchiveDto +void main() { + // final instance = DownloadArchiveDto(); + + group('test DownloadArchiveDto', () { + // Asset IDs + // List assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // Download edited asset if available + // Optional edited + test('to test the property `edited`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/download_archive_info_test.dart b/mobile/openapi/test/download_archive_info_test.dart new file mode 100644 index 0000000000000..079b2b984e631 --- /dev/null +++ b/mobile/openapi/test/download_archive_info_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DownloadArchiveInfo +void main() { + // final instance = DownloadArchiveInfo(); + + group('test DownloadArchiveInfo', () { + // Asset IDs in this archive + // List assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // Archive size in bytes + // int size + test('to test the property `size`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/download_info_dto_test.dart b/mobile/openapi/test/download_info_dto_test.dart new file mode 100644 index 0000000000000..3365158f9a14e --- /dev/null +++ b/mobile/openapi/test/download_info_dto_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DownloadInfoDto +void main() { + // final instance = DownloadInfoDto(); + + group('test DownloadInfoDto', () { + // Album ID to download + // Optional albumId + test('to test the property `albumId`', () async { + // TODO + }); + + // Archive size limit in bytes + // Optional archiveSize + test('to test the property `archiveSize`', () async { + // TODO + }); + + // Asset IDs to download + // Optional?> assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // User ID to download assets from + // Optional userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/download_response_dto_test.dart b/mobile/openapi/test/download_response_dto_test.dart new file mode 100644 index 0000000000000..7a71d1488d181 --- /dev/null +++ b/mobile/openapi/test/download_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DownloadResponseDto +void main() { + // final instance = DownloadResponseDto(); + + group('test DownloadResponseDto', () { + // Archive information + // List archives (default value: const []) + test('to test the property `archives`', () async { + // TODO + }); + + // Total size in bytes + // int totalSize + test('to test the property `totalSize`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/download_response_test.dart b/mobile/openapi/test/download_response_test.dart new file mode 100644 index 0000000000000..2df9f98680aa6 --- /dev/null +++ b/mobile/openapi/test/download_response_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DownloadResponse +void main() { + // final instance = DownloadResponse(); + + group('test DownloadResponse', () { + // Maximum archive size in bytes + // int archiveSize + test('to test the property `archiveSize`', () async { + // TODO + }); + + // Whether to include embedded videos in downloads + // bool includeEmbeddedVideos + test('to test the property `includeEmbeddedVideos`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/download_update_test.dart b/mobile/openapi/test/download_update_test.dart new file mode 100644 index 0000000000000..b10574266ba1c --- /dev/null +++ b/mobile/openapi/test/download_update_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DownloadUpdate +void main() { + // final instance = DownloadUpdate(); + + group('test DownloadUpdate', () { + // Maximum archive size in bytes + // Optional archiveSize + test('to test the property `archiveSize`', () async { + // TODO + }); + + // Whether to include embedded videos in downloads + // Optional includeEmbeddedVideos + test('to test the property `includeEmbeddedVideos`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/duplicate_detection_config_test.dart b/mobile/openapi/test/duplicate_detection_config_test.dart new file mode 100644 index 0000000000000..b35d7a415202a --- /dev/null +++ b/mobile/openapi/test/duplicate_detection_config_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DuplicateDetectionConfig +void main() { + // final instance = DuplicateDetectionConfig(); + + group('test DuplicateDetectionConfig', () { + // Whether the task is enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Maximum distance threshold for duplicate detection + // double maxDistance + test('to test the property `maxDistance`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/duplicate_resolve_dto_test.dart b/mobile/openapi/test/duplicate_resolve_dto_test.dart new file mode 100644 index 0000000000000..0079638e030b7 --- /dev/null +++ b/mobile/openapi/test/duplicate_resolve_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DuplicateResolveDto +void main() { + // final instance = DuplicateResolveDto(); + + group('test DuplicateResolveDto', () { + // List of duplicate groups to resolve + // List groups (default value: const []) + test('to test the property `groups`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/duplicate_resolve_group_dto_test.dart b/mobile/openapi/test/duplicate_resolve_group_dto_test.dart new file mode 100644 index 0000000000000..a07e8476f7d5b --- /dev/null +++ b/mobile/openapi/test/duplicate_resolve_group_dto_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DuplicateResolveGroupDto +void main() { + // final instance = DuplicateResolveGroupDto(); + + group('test DuplicateResolveGroupDto', () { + // String duplicateId + test('to test the property `duplicateId`', () async { + // TODO + }); + + // Asset IDs to keep + // List keepAssetIds (default value: const []) + test('to test the property `keepAssetIds`', () async { + // TODO + }); + + // Asset IDs to trash or delete + // List trashAssetIds (default value: const []) + test('to test the property `trashAssetIds`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/duplicate_response_dto_test.dart b/mobile/openapi/test/duplicate_response_dto_test.dart new file mode 100644 index 0000000000000..fe902571560a0 --- /dev/null +++ b/mobile/openapi/test/duplicate_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for DuplicateResponseDto +void main() { + // final instance = DuplicateResponseDto(); + + group('test DuplicateResponseDto', () { + // Duplicate assets + // List assets (default value: const []) + test('to test the property `assets`', () async { + // TODO + }); + + // Duplicate group ID + // String duplicateId + test('to test the property `duplicateId`', () async { + // TODO + }); + + // Suggested asset IDs to keep based on file size and EXIF data + // List suggestedKeepAssetIds (default value: const []) + test('to test the property `suggestedKeepAssetIds`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/duplicates_api_test.dart b/mobile/openapi/test/duplicates_api_test.dart new file mode 100644 index 0000000000000..77e4a99bd68ac --- /dev/null +++ b/mobile/openapi/test/duplicates_api_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for DuplicatesApi +void main() { + // final instance = DuplicatesApi(); + + group('tests for DuplicatesApi', () { + // Dismiss a duplicate group + // + // Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them. + // + //Future deleteDuplicate(String id) async + test('test deleteDuplicate', () async { + // TODO + }); + + // Delete duplicates + // + // Delete multiple duplicate assets specified by their IDs. + // + //Future deleteDuplicates(BulkIdsDto bulkIdsDto) async + test('test deleteDuplicates', () async { + // TODO + }); + + // Retrieve duplicates + // + // Retrieve a list of duplicate assets available to the authenticated user. + // + //Future> getAssetDuplicates() async + test('test getAssetDuplicates', () async { + // TODO + }); + + // Resolve duplicate groups + // + // Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates. + // + //Future> resolveDuplicates(DuplicateResolveDto duplicateResolveDto) async + test('test resolveDuplicates', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/email_notifications_response_test.dart b/mobile/openapi/test/email_notifications_response_test.dart new file mode 100644 index 0000000000000..943fbe22b7301 --- /dev/null +++ b/mobile/openapi/test/email_notifications_response_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for EmailNotificationsResponse +void main() { + // final instance = EmailNotificationsResponse(); + + group('test EmailNotificationsResponse', () { + // Whether to receive email notifications for album invites + // bool albumInvite + test('to test the property `albumInvite`', () async { + // TODO + }); + + // Whether to receive email notifications for album updates + // bool albumUpdate + test('to test the property `albumUpdate`', () async { + // TODO + }); + + // Whether email notifications are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/email_notifications_update_test.dart b/mobile/openapi/test/email_notifications_update_test.dart new file mode 100644 index 0000000000000..47e5fc1b1ded9 --- /dev/null +++ b/mobile/openapi/test/email_notifications_update_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for EmailNotificationsUpdate +void main() { + // final instance = EmailNotificationsUpdate(); + + group('test EmailNotificationsUpdate', () { + // Whether to receive email notifications for album invites + // Optional albumInvite + test('to test the property `albumInvite`', () async { + // TODO + }); + + // Whether to receive email notifications for album updates + // Optional albumUpdate + test('to test the property `albumUpdate`', () async { + // TODO + }); + + // Whether email notifications are enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/exif_response_dto_test.dart b/mobile/openapi/test/exif_response_dto_test.dart new file mode 100644 index 0000000000000..f24030a89a6aa --- /dev/null +++ b/mobile/openapi/test/exif_response_dto_test.dart @@ -0,0 +1,154 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ExifResponseDto +void main() { + // final instance = ExifResponseDto(); + + group('test ExifResponseDto', () { + // City name + // Optional city + test('to test the property `city`', () async { + // TODO + }); + + // Country name + // Optional country + test('to test the property `country`', () async { + // TODO + }); + + // Original date/time + // Optional dateTimeOriginal + test('to test the property `dateTimeOriginal`', () async { + // TODO + }); + + // Image description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Image height in pixels + // Optional exifImageHeight + test('to test the property `exifImageHeight`', () async { + // TODO + }); + + // Image width in pixels + // Optional exifImageWidth + test('to test the property `exifImageWidth`', () async { + // TODO + }); + + // Exposure time + // Optional exposureTime + test('to test the property `exposureTime`', () async { + // TODO + }); + + // F-number (aperture) + // Optional fNumber + test('to test the property `fNumber`', () async { + // TODO + }); + + // File size in bytes + // Optional fileSizeInByte + test('to test the property `fileSizeInByte`', () async { + // TODO + }); + + // Focal length in mm + // Optional focalLength + test('to test the property `focalLength`', () async { + // TODO + }); + + // ISO sensitivity + // Optional iso + test('to test the property `iso`', () async { + // TODO + }); + + // GPS latitude + // Optional latitude + test('to test the property `latitude`', () async { + // TODO + }); + + // Lens model + // Optional lensModel + test('to test the property `lensModel`', () async { + // TODO + }); + + // GPS longitude + // Optional longitude + test('to test the property `longitude`', () async { + // TODO + }); + + // Camera make + // Optional make + test('to test the property `make`', () async { + // TODO + }); + + // Camera model + // Optional model + test('to test the property `model`', () async { + // TODO + }); + + // Modification date/time + // Optional modifyDate + test('to test the property `modifyDate`', () async { + // TODO + }); + + // Image orientation + // Optional orientation + test('to test the property `orientation`', () async { + // TODO + }); + + // Projection type + // Optional projectionType + test('to test the property `projectionType`', () async { + // TODO + }); + + // Rating + // Optional rating + test('to test the property `rating`', () async { + // TODO + }); + + // State/province name + // Optional state + test('to test the property `state`', () async { + // TODO + }); + + // Time zone + // Optional timeZone + test('to test the property `timeZone`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/face_dto_test.dart b/mobile/openapi/test/face_dto_test.dart new file mode 100644 index 0000000000000..3d93653445b90 --- /dev/null +++ b/mobile/openapi/test/face_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for FaceDto +void main() { + // final instance = FaceDto(); + + group('test FaceDto', () { + // Face ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/faces_api_test.dart b/mobile/openapi/test/faces_api_test.dart new file mode 100644 index 0000000000000..5ff7012fb4212 --- /dev/null +++ b/mobile/openapi/test/faces_api_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for FacesApi +void main() { + // final instance = FacesApi(); + + group('tests for FacesApi', () { + // Create a face + // + // Create a new face that has not been discovered by facial recognition. The content of the bounding box is considered a face. + // + //Future createFace(AssetFaceCreateDto assetFaceCreateDto) async + test('test createFace', () async { + // TODO + }); + + // Delete a face + // + // Delete a face identified by the id. Optionally can be force deleted. + // + //Future deleteFace(String id, AssetFaceDeleteDto assetFaceDeleteDto) async + test('test deleteFace', () async { + // TODO + }); + + // Retrieve faces for asset + // + // Retrieve all faces belonging to an asset. + // + //Future> getFaces(String id) async + test('test getFaces', () async { + // TODO + }); + + // Re-assign a face to another person + // + // Re-assign the face provided in the body to the person identified by the id in the path parameter. + // + //Future reassignFacesById(String id, FaceDto faceDto) async + test('test reassignFacesById', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/facial_recognition_config_test.dart b/mobile/openapi/test/facial_recognition_config_test.dart new file mode 100644 index 0000000000000..7fd55f06be77f --- /dev/null +++ b/mobile/openapi/test/facial_recognition_config_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for FacialRecognitionConfig +void main() { + // final instance = FacialRecognitionConfig(); + + group('test FacialRecognitionConfig', () { + // Whether the task is enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Maximum distance threshold for face recognition + // double maxDistance + test('to test the property `maxDistance`', () async { + // TODO + }); + + // Minimum number of faces required for recognition + // int minFaces + test('to test the property `minFaces`', () async { + // TODO + }); + + // Minimum confidence score for face detection + // double minScore + test('to test the property `minScore`', () async { + // TODO + }); + + // Name of the model to use + // String modelName + test('to test the property `modelName`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/filesystem_api_test.dart b/mobile/openapi/test/filesystem_api_test.dart new file mode 100644 index 0000000000000..e7c7fc2c778b2 --- /dev/null +++ b/mobile/openapi/test/filesystem_api_test.dart @@ -0,0 +1,26 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for FilesystemApi +void main() { + // final instance = FilesystemApi(); + + group('tests for FilesystemApi', () { + //Future getFileListing({ String path }) async + test('test getFileListing', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/filesystem_listing_item_dto_test.dart b/mobile/openapi/test/filesystem_listing_item_dto_test.dart new file mode 100644 index 0000000000000..4131a12e59fd0 --- /dev/null +++ b/mobile/openapi/test/filesystem_listing_item_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for FilesystemListingItemDto +void main() { + // final instance = FilesystemListingItemDto(); + + group('test FilesystemListingItemDto', () { + // bool isDirectory + test('to test the property `isDirectory`', () async { + // TODO + }); + + // String path + test('to test the property `path`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/filesystem_listing_response_dto_test.dart b/mobile/openapi/test/filesystem_listing_response_dto_test.dart new file mode 100644 index 0000000000000..7925697457b80 --- /dev/null +++ b/mobile/openapi/test/filesystem_listing_response_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for FilesystemListingResponseDto +void main() { + // final instance = FilesystemListingResponseDto(); + + group('test FilesystemListingResponseDto', () { + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + // String parent + test('to test the property `parent`', () async { + // TODO + }); + + // String path + test('to test the property `path`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/folders_response_test.dart b/mobile/openapi/test/folders_response_test.dart new file mode 100644 index 0000000000000..d535841a842f8 --- /dev/null +++ b/mobile/openapi/test/folders_response_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for FoldersResponse +void main() { + // final instance = FoldersResponse(); + + group('test FoldersResponse', () { + // Whether folders are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Whether folders appear in web sidebar + // bool sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/folders_update_test.dart b/mobile/openapi/test/folders_update_test.dart new file mode 100644 index 0000000000000..212e1fa23a0f9 --- /dev/null +++ b/mobile/openapi/test/folders_update_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for FoldersUpdate +void main() { + // final instance = FoldersUpdate(); + + group('test FoldersUpdate', () { + // Whether folders are enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Whether folders appear in web sidebar + // Optional sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/hls_video_resolution_test.dart b/mobile/openapi/test/hls_video_resolution_test.dart new file mode 100644 index 0000000000000..6d477663f2c93 --- /dev/null +++ b/mobile/openapi/test/hls_video_resolution_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for HlsVideoResolution +void main() { + + group('test HlsVideoResolution', () { + + }); + +} diff --git a/mobile/openapi/test/image_format_test.dart b/mobile/openapi/test/image_format_test.dart new file mode 100644 index 0000000000000..44575af138d9a --- /dev/null +++ b/mobile/openapi/test/image_format_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ImageFormat +void main() { + + group('test ImageFormat', () { + + }); + +} diff --git a/mobile/openapi/test/immich_integration_configuration_dto_test.dart b/mobile/openapi/test/immich_integration_configuration_dto_test.dart new file mode 100644 index 0000000000000..49e889b189a06 --- /dev/null +++ b/mobile/openapi/test/immich_integration_configuration_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ImmichIntegrationConfigurationDto +void main() { + // final instance = ImmichIntegrationConfigurationDto(); + + group('test ImmichIntegrationConfigurationDto', () { + // bool backupConfiguration + test('to test the property `backupConfiguration`', () async { + // TODO + }); + + // List dataFolders (default value: const []) + test('to test the property `dataFolders`', () async { + // TODO + }); + + // ConfigureImmichIntegrationRequestDtoLibraries libraries + test('to test the property `libraries`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/immich_integration_dto_test.dart b/mobile/openapi/test/immich_integration_dto_test.dart new file mode 100644 index 0000000000000..76bb2541f5d12 --- /dev/null +++ b/mobile/openapi/test/immich_integration_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ImmichIntegrationDto +void main() { + // final instance = ImmichIntegrationDto(); + + group('test ImmichIntegrationDto', () { + // ImmichIntegrationConfigurationDto configuration + test('to test the property `configuration`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // String scheduleId + test('to test the property `scheduleId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/immich_library_dto_test.dart b/mobile/openapi/test/immich_library_dto_test.dart new file mode 100644 index 0000000000000..fb236a214a761 --- /dev/null +++ b/mobile/openapi/test/immich_library_dto_test.dart @@ -0,0 +1,42 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ImmichLibraryDto +void main() { + // final instance = ImmichLibraryDto(); + + group('test ImmichLibraryDto', () { + // List exclusionPatterns (default value: const []) + test('to test the property `exclusionPatterns`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // List importPaths (default value: const []) + test('to test the property `importPaths`', () async { + // TODO + }); + + // String name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/immich_rollback_request_dto_test.dart b/mobile/openapi/test/immich_rollback_request_dto_test.dart new file mode 100644 index 0000000000000..7ad0b867cafd2 --- /dev/null +++ b/mobile/openapi/test/immich_rollback_request_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ImmichRollbackRequestDto +void main() { + // final instance = ImmichRollbackRequestDto(); + + group('test ImmichRollbackRequestDto', () { + // Optional backupFileName + test('to test the property `backupFileName`', () async { + // TODO + }); + + // String repositoryId + test('to test the property `repositoryId`', () async { + // TODO + }); + + // String snapshotId + test('to test the property `snapshotId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/immich_state_dto_test.dart b/mobile/openapi/test/immich_state_dto_test.dart new file mode 100644 index 0000000000000..8a35eb8654b69 --- /dev/null +++ b/mobile/openapi/test/immich_state_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ImmichStateDto +void main() { + // final instance = ImmichStateDto(); + + group('test ImmichStateDto', () { + // List dataFolders (default value: const []) + test('to test the property `dataFolders`', () async { + // TODO + }); + + // String dataPath + test('to test the property `dataPath`', () async { + // TODO + }); + + // List libraries (default value: const []) + test('to test the property `libraries`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/import_recovery_key_request_test.dart b/mobile/openapi/test/import_recovery_key_request_test.dart new file mode 100644 index 0000000000000..0253549dd63ca --- /dev/null +++ b/mobile/openapi/test/import_recovery_key_request_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ImportRecoveryKeyRequest +void main() { + // final instance = ImportRecoveryKeyRequest(); + + group('test ImportRecoveryKeyRequest', () { + // String recoveryKey + test('to test the property `recoveryKey`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/inspected_local_repository_dto_test.dart b/mobile/openapi/test/inspected_local_repository_dto_test.dart new file mode 100644 index 0000000000000..8eef5480ed17e --- /dev/null +++ b/mobile/openapi/test/inspected_local_repository_dto_test.dart @@ -0,0 +1,62 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for InspectedLocalRepositoryDto +void main() { + // final instance = InspectedLocalRepositoryDto(); + + group('test InspectedLocalRepositoryDto', () { + // Optional backends + test('to test the property `backends`', () async { + // TODO + }); + + // Optional configuration + test('to test the property `configuration`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Optional meter + test('to test the property `meter`', () async { + // TODO + }); + + // RepositoryMetricsDto metrics + test('to test the property `metrics`', () async { + // TODO + }); + + // String name + test('to test the property `name`', () async { + // TODO + }); + + // List snapshots (default value: const []) + test('to test the property `snapshots`', () async { + // TODO + }); + + // bool worm + test('to test the property `worm`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/integrations_api_test.dart b/mobile/openapi/test/integrations_api_test.dart new file mode 100644 index 0000000000000..b797b233e589e --- /dev/null +++ b/mobile/openapi/test/integrations_api_test.dart @@ -0,0 +1,36 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for IntegrationsApi +void main() { + // final instance = IntegrationsApi(); + + group('tests for IntegrationsApi', () { + //Future configureImmichIntegration(ConfigureImmichIntegrationRequestDto configureImmichIntegrationRequestDto) async + test('test configureImmichIntegration', () async { + // TODO + }); + + //Future getIntegrations() async + test('test getIntegrations', () async { + // TODO + }); + + //Future startImmichRollback(ImmichRollbackRequestDto immichRollbackRequestDto) async + test('test startImmichRollback', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/integrations_response_dto_test.dart b/mobile/openapi/test/integrations_response_dto_test.dart new file mode 100644 index 0000000000000..fc6dfe9055b77 --- /dev/null +++ b/mobile/openapi/test/integrations_response_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for IntegrationsResponseDto +void main() { + // final instance = IntegrationsResponseDto(); + + group('test IntegrationsResponseDto', () { + // Optional immichIntegration + test('to test the property `immichIntegration`', () async { + // TODO + }); + + // Optional immichState + test('to test the property `immichState`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/integrity_report_response_dto_items_inner_test.dart b/mobile/openapi/test/integrity_report_response_dto_items_inner_test.dart new file mode 100644 index 0000000000000..98573b43fd98e --- /dev/null +++ b/mobile/openapi/test/integrity_report_response_dto_items_inner_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for IntegrityReportResponseDtoItemsInner +void main() { + // final instance = IntegrityReportResponseDtoItemsInner(); + + group('test IntegrityReportResponseDtoItemsInner', () { + // Integrity report item id + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Integrity report item path + // String path + test('to test the property `path`', () async { + // TODO + }); + + // IntegrityReport type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/integrity_report_response_dto_test.dart b/mobile/openapi/test/integrity_report_response_dto_test.dart new file mode 100644 index 0000000000000..cfa53037fb476 --- /dev/null +++ b/mobile/openapi/test/integrity_report_response_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for IntegrityReportResponseDto +void main() { + // final instance = IntegrityReportResponseDto(); + + group('test IntegrityReportResponseDto', () { + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + // Optional nextCursor + test('to test the property `nextCursor`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/integrity_report_summary_response_dto_test.dart b/mobile/openapi/test/integrity_report_summary_response_dto_test.dart new file mode 100644 index 0000000000000..af542463d6793 --- /dev/null +++ b/mobile/openapi/test/integrity_report_summary_response_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for IntegrityReportSummaryResponseDto +void main() { + // final instance = IntegrityReportSummaryResponseDto(); + + group('test IntegrityReportSummaryResponseDto', () { + // int checksumMismatch + test('to test the property `checksumMismatch`', () async { + // TODO + }); + + // int missingFile + test('to test the property `missingFile`', () async { + // TODO + }); + + // int untrackedFile + test('to test the property `untrackedFile`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/integrity_report_test.dart b/mobile/openapi/test/integrity_report_test.dart new file mode 100644 index 0000000000000..90eb738c79302 --- /dev/null +++ b/mobile/openapi/test/integrity_report_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for IntegrityReport +void main() { + + group('test IntegrityReport', () { + + }); + +} diff --git a/mobile/openapi/test/job_create_dto_test.dart b/mobile/openapi/test/job_create_dto_test.dart new file mode 100644 index 0000000000000..d20354b994b91 --- /dev/null +++ b/mobile/openapi/test/job_create_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for JobCreateDto +void main() { + // final instance = JobCreateDto(); + + group('test JobCreateDto', () { + // ManualJobName name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/job_name_test.dart b/mobile/openapi/test/job_name_test.dart new file mode 100644 index 0000000000000..74581df1d50d8 --- /dev/null +++ b/mobile/openapi/test/job_name_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for JobName +void main() { + + group('test JobName', () { + + }); + +} diff --git a/mobile/openapi/test/job_settings_dto_test.dart b/mobile/openapi/test/job_settings_dto_test.dart new file mode 100644 index 0000000000000..def1b3f4207fa --- /dev/null +++ b/mobile/openapi/test/job_settings_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for JobSettingsDto +void main() { + // final instance = JobSettingsDto(); + + group('test JobSettingsDto', () { + // Concurrency + // int concurrency + test('to test the property `concurrency`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/jobs_api_test.dart b/mobile/openapi/test/jobs_api_test.dart new file mode 100644 index 0000000000000..1750421a5798b --- /dev/null +++ b/mobile/openapi/test/jobs_api_test.dart @@ -0,0 +1,48 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for JobsApi +void main() { + // final instance = JobsApi(); + + group('tests for JobsApi', () { + // Create a manual job + // + // Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup. + // + //Future createJob(JobCreateDto jobCreateDto) async + test('test createJob', () async { + // TODO + }); + + // Retrieve queue counts and status + // + // Retrieve the counts of the current queue, as well as the current status. + // + //Future getQueuesLegacy() async + test('test getQueuesLegacy', () async { + // TODO + }); + + // Run jobs + // + // Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets. + // + //Future runQueueCommandLegacy(QueueName name, QueueCommandDto queueCommandDto) async + test('test runQueueCommandLegacy', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/libraries_api_test.dart b/mobile/openapi/test/libraries_api_test.dart new file mode 100644 index 0000000000000..8d43ebdeaa432 --- /dev/null +++ b/mobile/openapi/test/libraries_api_test.dart @@ -0,0 +1,93 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for LibrariesApi +void main() { + // final instance = LibrariesApi(); + + group('tests for LibrariesApi', () { + // Create a library + // + // Create a new external library. + // + //Future createLibrary(CreateLibraryDto createLibraryDto) async + test('test createLibrary', () async { + // TODO + }); + + // Delete a library + // + // Delete an external library by its ID. + // + //Future deleteLibrary(String id) async + test('test deleteLibrary', () async { + // TODO + }); + + // Retrieve libraries + // + // Retrieve a list of external libraries. + // + //Future> getAllLibraries() async + test('test getAllLibraries', () async { + // TODO + }); + + // Retrieve a library + // + // Retrieve an external library by its ID. + // + //Future getLibrary(String id) async + test('test getLibrary', () async { + // TODO + }); + + // Retrieve library statistics + // + // Retrieve statistics for a specific external library, including number of videos, images, and storage usage. + // + //Future getLibraryStatistics(String id) async + test('test getLibraryStatistics', () async { + // TODO + }); + + // Scan a library + // + // Queue a scan for the external library to find and import new assets. + // + //Future scanLibrary(String id) async + test('test scanLibrary', () async { + // TODO + }); + + // Update a library + // + // Update an existing external library. + // + //Future updateLibrary(String id, UpdateLibraryDto updateLibraryDto) async + test('test updateLibrary', () async { + // TODO + }); + + // Validate library settings + // + // Validate the settings of an external library. + // + //Future validate(String id, ValidateLibraryDto validateLibraryDto) async + test('test validate', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/library_response_dto_test.dart b/mobile/openapi/test/library_response_dto_test.dart new file mode 100644 index 0000000000000..0d8824f039913 --- /dev/null +++ b/mobile/openapi/test/library_response_dto_test.dart @@ -0,0 +1,76 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LibraryResponseDto +void main() { + // final instance = LibraryResponseDto(); + + group('test LibraryResponseDto', () { + // Number of assets + // int assetCount + test('to test the property `assetCount`', () async { + // TODO + }); + + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Exclusion patterns + // List exclusionPatterns (default value: const []) + test('to test the property `exclusionPatterns`', () async { + // TODO + }); + + // Library ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Import paths + // List importPaths (default value: const []) + test('to test the property `importPaths`', () async { + // TODO + }); + + // Library name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Owner user ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Last refresh date + // DateTime refreshedAt + test('to test the property `refreshedAt`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/library_stats_response_dto_test.dart b/mobile/openapi/test/library_stats_response_dto_test.dart new file mode 100644 index 0000000000000..829abd7091811 --- /dev/null +++ b/mobile/openapi/test/library_stats_response_dto_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LibraryStatsResponseDto +void main() { + // final instance = LibraryStatsResponseDto(); + + group('test LibraryStatsResponseDto', () { + // Number of photos + // int photos + test('to test the property `photos`', () async { + // TODO + }); + + // Total number of assets + // int total + test('to test the property `total`', () async { + // TODO + }); + + // Storage usage in bytes + // int usage + test('to test the property `usage`', () async { + // TODO + }); + + // Number of videos + // int videos + test('to test the property `videos`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/license_key_dto_test.dart b/mobile/openapi/test/license_key_dto_test.dart new file mode 100644 index 0000000000000..97cc47c566b7b --- /dev/null +++ b/mobile/openapi/test/license_key_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LicenseKeyDto +void main() { + // final instance = LicenseKeyDto(); + + group('test LicenseKeyDto', () { + // Activation key + // String activationKey + test('to test the property `activationKey`', () async { + // TODO + }); + + // License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/) + // String licenseKey + test('to test the property `licenseKey`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/list_snapshots_response_dto_test.dart b/mobile/openapi/test/list_snapshots_response_dto_test.dart new file mode 100644 index 0000000000000..6719782fd184a --- /dev/null +++ b/mobile/openapi/test/list_snapshots_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ListSnapshotsResponseDto +void main() { + // final instance = ListSnapshotsResponseDto(); + + group('test ListSnapshotsResponseDto', () { + // List snapshots (default value: const []) + test('to test the property `snapshots`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/local_repository_dto_test.dart b/mobile/openapi/test/local_repository_dto_test.dart new file mode 100644 index 0000000000000..9665e50b1243b --- /dev/null +++ b/mobile/openapi/test/local_repository_dto_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LocalRepositoryDto +void main() { + // final instance = LocalRepositoryDto(); + + group('test LocalRepositoryDto', () { + // Optional backends + test('to test the property `backends`', () async { + // TODO + }); + + // Optional configuration + test('to test the property `configuration`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Optional meter + test('to test the property `meter`', () async { + // TODO + }); + + // RepositoryMetricsDto metrics + test('to test the property `metrics`', () async { + // TODO + }); + + // String name + test('to test the property `name`', () async { + // TODO + }); + + // bool worm + test('to test the property `worm`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/log_level_test.dart b/mobile/openapi/test/log_level_test.dart new file mode 100644 index 0000000000000..094beffe87f48 --- /dev/null +++ b/mobile/openapi/test/log_level_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LogLevel +void main() { + + group('test LogLevel', () { + + }); + +} diff --git a/mobile/openapi/test/log_response_dto_test.dart b/mobile/openapi/test/log_response_dto_test.dart new file mode 100644 index 0000000000000..53cc9128dda7d --- /dev/null +++ b/mobile/openapi/test/log_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LogResponseDto +void main() { + // final instance = LogResponseDto(); + + group('test LogResponseDto', () { + // String logId + test('to test the property `logId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/login_credential_dto_test.dart b/mobile/openapi/test/login_credential_dto_test.dart new file mode 100644 index 0000000000000..ea2e9c978b1be --- /dev/null +++ b/mobile/openapi/test/login_credential_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LoginCredentialDto +void main() { + // final instance = LoginCredentialDto(); + + group('test LoginCredentialDto', () { + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // User password + // String password + test('to test the property `password`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/login_response_dto_test.dart b/mobile/openapi/test/login_response_dto_test.dart new file mode 100644 index 0000000000000..90985a3f22d4c --- /dev/null +++ b/mobile/openapi/test/login_response_dto_test.dart @@ -0,0 +1,70 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LoginResponseDto +void main() { + // final instance = LoginResponseDto(); + + group('test LoginResponseDto', () { + // Access token + // String accessToken + test('to test the property `accessToken`', () async { + // TODO + }); + + // Is admin user + // bool isAdmin + test('to test the property `isAdmin`', () async { + // TODO + }); + + // Is onboarded + // bool isOnboarded + test('to test the property `isOnboarded`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Profile image path + // String profileImagePath + test('to test the property `profileImagePath`', () async { + // TODO + }); + + // Should change password + // bool shouldChangePassword + test('to test the property `shouldChangePassword`', () async { + // TODO + }); + + // User email + // String userEmail + test('to test the property `userEmail`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/logout_response_dto_test.dart b/mobile/openapi/test/logout_response_dto_test.dart new file mode 100644 index 0000000000000..9b85dc6f9d582 --- /dev/null +++ b/mobile/openapi/test/logout_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for LogoutResponseDto +void main() { + // final instance = LogoutResponseDto(); + + group('test LogoutResponseDto', () { + // Redirect URI + // String redirectUri + test('to test the property `redirectUri`', () async { + // TODO + }); + + // Logout successful + // bool successful + test('to test the property `successful`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/machine_learning_availability_checks_dto_test.dart b/mobile/openapi/test/machine_learning_availability_checks_dto_test.dart new file mode 100644 index 0000000000000..125d1ac742554 --- /dev/null +++ b/mobile/openapi/test/machine_learning_availability_checks_dto_test.dart @@ -0,0 +1,38 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MachineLearningAvailabilityChecksDto +void main() { + // final instance = MachineLearningAvailabilityChecksDto(); + + group('test MachineLearningAvailabilityChecksDto', () { + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // int interval + test('to test the property `interval`', () async { + // TODO + }); + + // int timeout + test('to test the property `timeout`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/maintenance_action_test.dart b/mobile/openapi/test/maintenance_action_test.dart new file mode 100644 index 0000000000000..9e2afe40f40b4 --- /dev/null +++ b/mobile/openapi/test/maintenance_action_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MaintenanceAction +void main() { + + group('test MaintenanceAction', () { + + }); + +} diff --git a/mobile/openapi/test/maintenance_admin_api_test.dart b/mobile/openapi/test/maintenance_admin_api_test.dart new file mode 100644 index 0000000000000..78ef4b93215ac --- /dev/null +++ b/mobile/openapi/test/maintenance_admin_api_test.dart @@ -0,0 +1,102 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for MaintenanceAdminApi +void main() { + // final instance = MaintenanceAdminApi(); + + group('tests for MaintenanceAdminApi', () { + // Delete integrity report item + // + // Delete a given report item and perform corresponding deletion (e.g. trash asset, delete file) + // + //Future deleteIntegrityReport(String id) async + test('test deleteIntegrityReport', () async { + // TODO + }); + + // Detect existing install + // + // Collect integrity checks and other heuristics about local data. + // + //Future detectPriorInstall() async + test('test detectPriorInstall', () async { + // TODO + }); + + // Get integrity report by type + // + // Get all flagged items by integrity report type + // + //Future getIntegrityReport(IntegrityReport type, { String cursor, int limit }) async + test('test getIntegrityReport', () async { + // TODO + }); + + // Export integrity report by type as CSV + // + // Get all integrity report entries for a given type as a CSV + // + //Future getIntegrityReportCsv(IntegrityReport type) async + test('test getIntegrityReportCsv', () async { + // TODO + }); + + // Download flagged file + // + // Download the untracked/broken file if one exists + // + //Future getIntegrityReportFile(String id) async + test('test getIntegrityReportFile', () async { + // TODO + }); + + // Get integrity report summary + // + // Get a count of the items flagged in each integrity report + // + //Future getIntegrityReportSummary() async + test('test getIntegrityReportSummary', () async { + // TODO + }); + + // Get maintenance mode status + // + // Fetch information about the currently running maintenance action. + // + //Future getMaintenanceStatus() async + test('test getMaintenanceStatus', () async { + // TODO + }); + + // Log into maintenance mode + // + // Login with maintenance token or cookie to receive current information and perform further actions. + // + //Future maintenanceLogin(MaintenanceLoginDto maintenanceLoginDto) async + test('test maintenanceLogin', () async { + // TODO + }); + + // Set maintenance mode + // + // Put Immich into or take it out of maintenance mode + // + //Future setMaintenanceMode(SetMaintenanceModeDto setMaintenanceModeDto) async + test('test setMaintenanceMode', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/maintenance_auth_dto_test.dart b/mobile/openapi/test/maintenance_auth_dto_test.dart new file mode 100644 index 0000000000000..584cbeba38d79 --- /dev/null +++ b/mobile/openapi/test/maintenance_auth_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MaintenanceAuthDto +void main() { + // final instance = MaintenanceAuthDto(); + + group('test MaintenanceAuthDto', () { + // Maintenance username + // String username + test('to test the property `username`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/maintenance_detect_install_response_dto_test.dart b/mobile/openapi/test/maintenance_detect_install_response_dto_test.dart new file mode 100644 index 0000000000000..e722b2ee2ce71 --- /dev/null +++ b/mobile/openapi/test/maintenance_detect_install_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MaintenanceDetectInstallResponseDto +void main() { + // final instance = MaintenanceDetectInstallResponseDto(); + + group('test MaintenanceDetectInstallResponseDto', () { + // List storage (default value: const []) + test('to test the property `storage`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/maintenance_detect_install_storage_folder_dto_test.dart b/mobile/openapi/test/maintenance_detect_install_storage_folder_dto_test.dart new file mode 100644 index 0000000000000..5b203993cb2ac --- /dev/null +++ b/mobile/openapi/test/maintenance_detect_install_storage_folder_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MaintenanceDetectInstallStorageFolderDto +void main() { + // final instance = MaintenanceDetectInstallStorageFolderDto(); + + group('test MaintenanceDetectInstallStorageFolderDto', () { + // Number of files in the folder + // int files + test('to test the property `files`', () async { + // TODO + }); + + // StorageFolder folder + test('to test the property `folder`', () async { + // TODO + }); + + // Whether the folder is readable + // bool readable + test('to test the property `readable`', () async { + // TODO + }); + + // Whether the folder is writable + // bool writable + test('to test the property `writable`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/maintenance_login_dto_test.dart b/mobile/openapi/test/maintenance_login_dto_test.dart new file mode 100644 index 0000000000000..94772a7ff4182 --- /dev/null +++ b/mobile/openapi/test/maintenance_login_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MaintenanceLoginDto +void main() { + // final instance = MaintenanceLoginDto(); + + group('test MaintenanceLoginDto', () { + // Maintenance token + // Optional token + test('to test the property `token`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/maintenance_status_response_dto_test.dart b/mobile/openapi/test/maintenance_status_response_dto_test.dart new file mode 100644 index 0000000000000..ecc052d93f490 --- /dev/null +++ b/mobile/openapi/test/maintenance_status_response_dto_test.dart @@ -0,0 +1,53 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MaintenanceStatusResponseDto +void main() { + // final instance = MaintenanceStatusResponseDto(); + + group('test MaintenanceStatusResponseDto', () { + // MaintenanceAction action + test('to test the property `action`', () async { + // TODO + }); + + // bool active + test('to test the property `active`', () async { + // TODO + }); + + // Optional error + test('to test the property `error`', () async { + // TODO + }); + + // Optional progress + test('to test the property `progress`', () async { + // TODO + }); + + // Optional task + test('to test the property `task`', () async { + // TODO + }); + + // Yucca log ID + // Optional yuccaLogId + test('to test the property `yuccaLogId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/manual_job_name_test.dart b/mobile/openapi/test/manual_job_name_test.dart new file mode 100644 index 0000000000000..49ac3e0606364 --- /dev/null +++ b/mobile/openapi/test/manual_job_name_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ManualJobName +void main() { + + group('test ManualJobName', () { + + }); + +} diff --git a/mobile/openapi/test/map_api_test.dart b/mobile/openapi/test/map_api_test.dart new file mode 100644 index 0000000000000..faebec4572af6 --- /dev/null +++ b/mobile/openapi/test/map_api_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for MapApi +void main() { + // final instance = MapApi(); + + group('tests for MapApi', () { + // Retrieve map markers + // + // Retrieve a list of latitude and longitude coordinates for every asset with location data. + // + //Future> getMapMarkers({ DateTime fileCreatedAfter, DateTime fileCreatedBefore, bool isArchived, bool isFavorite, bool withPartners, bool withSharedAlbums }) async + test('test getMapMarkers', () async { + // TODO + }); + + // Reverse geocode coordinates + // + // Retrieve location information (e.g., city, country) for given latitude and longitude coordinates. + // + //Future> reverseGeocode(double lat, double lon) async + test('test reverseGeocode', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/map_marker_response_dto_test.dart b/mobile/openapi/test/map_marker_response_dto_test.dart new file mode 100644 index 0000000000000..1ee800187492f --- /dev/null +++ b/mobile/openapi/test/map_marker_response_dto_test.dart @@ -0,0 +1,58 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MapMarkerResponseDto +void main() { + // final instance = MapMarkerResponseDto(); + + group('test MapMarkerResponseDto', () { + // City name + // String city + test('to test the property `city`', () async { + // TODO + }); + + // Country name + // String country + test('to test the property `country`', () async { + // TODO + }); + + // Asset ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Latitude + // double lat + test('to test the property `lat`', () async { + // TODO + }); + + // Longitude + // double lon + test('to test the property `lon`', () async { + // TODO + }); + + // State/Province name + // String state + test('to test the property `state`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/map_reverse_geocode_response_dto_test.dart b/mobile/openapi/test/map_reverse_geocode_response_dto_test.dart new file mode 100644 index 0000000000000..224227eda6706 --- /dev/null +++ b/mobile/openapi/test/map_reverse_geocode_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MapReverseGeocodeResponseDto +void main() { + // final instance = MapReverseGeocodeResponseDto(); + + group('test MapReverseGeocodeResponseDto', () { + // City name + // String city + test('to test the property `city`', () async { + // TODO + }); + + // Country name + // String country + test('to test the property `country`', () async { + // TODO + }); + + // State/Province name + // String state + test('to test the property `state`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/memories_api_test.dart b/mobile/openapi/test/memories_api_test.dart new file mode 100644 index 0000000000000..90be8527ac21a --- /dev/null +++ b/mobile/openapi/test/memories_api_test.dart @@ -0,0 +1,93 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for MemoriesApi +void main() { + // final instance = MemoriesApi(); + + group('tests for MemoriesApi', () { + // Add assets to a memory + // + // Add a list of asset IDs to a specific memory. + // + //Future> addMemoryAssets(String id, BulkIdsDto bulkIdsDto) async + test('test addMemoryAssets', () async { + // TODO + }); + + // Create a memory + // + // Create a new memory by providing a name, description, and a list of asset IDs to include in the memory. + // + //Future createMemory(MemoryCreateDto memoryCreateDto) async + test('test createMemory', () async { + // TODO + }); + + // Delete a memory + // + // Delete a specific memory by its ID. + // + //Future deleteMemory(String id) async + test('test deleteMemory', () async { + // TODO + }); + + // Retrieve a memory + // + // Retrieve a specific memory by its ID. + // + //Future getMemory(String id) async + test('test getMemory', () async { + // TODO + }); + + // Retrieve memories statistics + // + // Retrieve statistics about memories, such as total count and other relevant metrics. + // + //Future memoriesStatistics({ DateTime for_, bool isSaved, bool isTrashed, MemorySearchOrder order, int size, MemoryType type }) async + test('test memoriesStatistics', () async { + // TODO + }); + + // Remove assets from a memory + // + // Remove a list of asset IDs from a specific memory. + // + //Future> removeMemoryAssets(String id, BulkIdsDto bulkIdsDto) async + test('test removeMemoryAssets', () async { + // TODO + }); + + // Retrieve memories + // + // Retrieve a list of memories. Memories are sorted descending by creation date by default, although they can also be sorted in ascending order, or randomly. + // + //Future> searchMemories({ DateTime for_, bool isSaved, bool isTrashed, MemorySearchOrder order, int size, MemoryType type }) async + test('test searchMemories', () async { + // TODO + }); + + // Update a memory + // + // Update an existing memory by its ID. + // + //Future updateMemory(String id, MemoryUpdateDto memoryUpdateDto) async + test('test updateMemory', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/memories_response_test.dart b/mobile/openapi/test/memories_response_test.dart new file mode 100644 index 0000000000000..6429d4170a084 --- /dev/null +++ b/mobile/openapi/test/memories_response_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemoriesResponse +void main() { + // final instance = MemoriesResponse(); + + group('test MemoriesResponse', () { + // Memory duration in seconds + // int duration + test('to test the property `duration`', () async { + // TODO + }); + + // Whether memories are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/memories_update_test.dart b/mobile/openapi/test/memories_update_test.dart new file mode 100644 index 0000000000000..7d3a24c2cf4e1 --- /dev/null +++ b/mobile/openapi/test/memories_update_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemoriesUpdate +void main() { + // final instance = MemoriesUpdate(); + + group('test MemoriesUpdate', () { + // Memory duration in seconds + // Optional duration + test('to test the property `duration`', () async { + // TODO + }); + + // Whether memories are enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/memory_create_dto_test.dart b/mobile/openapi/test/memory_create_dto_test.dart new file mode 100644 index 0000000000000..7ca5837923615 --- /dev/null +++ b/mobile/openapi/test/memory_create_dto_test.dart @@ -0,0 +1,68 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemoryCreateDto +void main() { + // final instance = MemoryCreateDto(); + + group('test MemoryCreateDto', () { + // Asset IDs to associate with memory + // Optional?> assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // OnThisDayDto data + test('to test the property `data`', () async { + // TODO + }); + + // Date when memory should be hidden + // Optional hideAt + test('to test the property `hideAt`', () async { + // TODO + }); + + // Is memory saved + // Optional isSaved + test('to test the property `isSaved`', () async { + // TODO + }); + + // Memory date + // DateTime memoryAt + test('to test the property `memoryAt`', () async { + // TODO + }); + + // Date when memory was seen + // Optional seenAt + test('to test the property `seenAt`', () async { + // TODO + }); + + // Date when memory should be shown + // Optional showAt + test('to test the property `showAt`', () async { + // TODO + }); + + // MemoryType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/memory_response_dto_test.dart b/mobile/openapi/test/memory_response_dto_test.dart new file mode 100644 index 0000000000000..b6f21930cd2d6 --- /dev/null +++ b/mobile/openapi/test/memory_response_dto_test.dart @@ -0,0 +1,97 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemoryResponseDto +void main() { + // final instance = MemoryResponseDto(); + + group('test MemoryResponseDto', () { + // List assets (default value: const []) + test('to test the property `assets`', () async { + // TODO + }); + + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // OnThisDayDto data + test('to test the property `data`', () async { + // TODO + }); + + // Deletion date + // Optional deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // Date when memory should be hidden + // Optional hideAt + test('to test the property `hideAt`', () async { + // TODO + }); + + // Memory ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is memory saved + // bool isSaved + test('to test the property `isSaved`', () async { + // TODO + }); + + // Memory date + // DateTime memoryAt + test('to test the property `memoryAt`', () async { + // TODO + }); + + // Owner user ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Date when memory was seen + // Optional seenAt + test('to test the property `seenAt`', () async { + // TODO + }); + + // Date when memory should be shown + // Optional showAt + test('to test the property `showAt`', () async { + // TODO + }); + + // MemoryType type + test('to test the property `type`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/memory_search_order_test.dart b/mobile/openapi/test/memory_search_order_test.dart new file mode 100644 index 0000000000000..f9374398c98ef --- /dev/null +++ b/mobile/openapi/test/memory_search_order_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemorySearchOrder +void main() { + + group('test MemorySearchOrder', () { + + }); + +} diff --git a/mobile/openapi/test/memory_statistics_response_dto_test.dart b/mobile/openapi/test/memory_statistics_response_dto_test.dart new file mode 100644 index 0000000000000..da370b9b2981e --- /dev/null +++ b/mobile/openapi/test/memory_statistics_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemoryStatisticsResponseDto +void main() { + // final instance = MemoryStatisticsResponseDto(); + + group('test MemoryStatisticsResponseDto', () { + // Total number of memories + // int total + test('to test the property `total`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/memory_type_test.dart b/mobile/openapi/test/memory_type_test.dart new file mode 100644 index 0000000000000..9dd1d9318f475 --- /dev/null +++ b/mobile/openapi/test/memory_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemoryType +void main() { + + group('test MemoryType', () { + + }); + +} diff --git a/mobile/openapi/test/memory_update_dto_test.dart b/mobile/openapi/test/memory_update_dto_test.dart new file mode 100644 index 0000000000000..b4a939c4f0a8c --- /dev/null +++ b/mobile/openapi/test/memory_update_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MemoryUpdateDto +void main() { + // final instance = MemoryUpdateDto(); + + group('test MemoryUpdateDto', () { + // Is memory saved + // Optional isSaved + test('to test the property `isSaved`', () async { + // TODO + }); + + // Memory date + // Optional memoryAt + test('to test the property `memoryAt`', () async { + // TODO + }); + + // Date when memory was seen + // Optional seenAt + test('to test the property `seenAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/merge_person_dto_test.dart b/mobile/openapi/test/merge_person_dto_test.dart new file mode 100644 index 0000000000000..4c348c5137a50 --- /dev/null +++ b/mobile/openapi/test/merge_person_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MergePersonDto +void main() { + // final instance = MergePersonDto(); + + group('test MergePersonDto', () { + // Person IDs to merge + // List ids (default value: const []) + test('to test the property `ids`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/metadata_search_dto_test.dart b/mobile/openapi/test/metadata_search_dto_test.dart new file mode 100644 index 0000000000000..62cce1994d774 --- /dev/null +++ b/mobile/openapi/test/metadata_search_dto_test.dart @@ -0,0 +1,271 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MetadataSearchDto +void main() { + // final instance = MetadataSearchDto(); + + group('test MetadataSearchDto', () { + // Filter by album IDs + // Optional?> albumIds (default value: const []) + test('to test the property `albumIds`', () async { + // TODO + }); + + // Filter by file checksum + // Optional checksum + test('to test the property `checksum`', () async { + // TODO + }); + + // Filter by city name + // Optional city + test('to test the property `city`', () async { + // TODO + }); + + // Filter by country name + // Optional country + test('to test the property `country`', () async { + // TODO + }); + + // Filter by creation date (after) + // Optional createdAfter + test('to test the property `createdAfter`', () async { + // TODO + }); + + // Filter by creation date (before) + // Optional createdBefore + test('to test the property `createdBefore`', () async { + // TODO + }); + + // Filter by description text + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Filter by encoded video file path + // Optional encodedVideoPath + test('to test the property `encodedVideoPath`', () async { + // TODO + }); + + // Filter by asset ID + // Optional id + test('to test the property `id`', () async { + // TODO + }); + + // Filter by encoded status + // Optional isEncoded + test('to test the property `isEncoded`', () async { + // TODO + }); + + // Filter by favorite status + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Filter by motion photo status + // Optional isMotion + test('to test the property `isMotion`', () async { + // TODO + }); + + // Filter assets not in any album + // Optional isNotInAlbum + test('to test the property `isNotInAlbum`', () async { + // TODO + }); + + // Filter by offline status + // Optional isOffline + test('to test the property `isOffline`', () async { + // TODO + }); + + // Filter by lens model + // Optional lensModel + test('to test the property `lensModel`', () async { + // TODO + }); + + // Library ID to filter by + // Optional libraryId + test('to test the property `libraryId`', () async { + // TODO + }); + + // Filter by camera make + // Optional make + test('to test the property `make`', () async { + // TODO + }); + + // Filter by camera model + // Optional model + test('to test the property `model`', () async { + // TODO + }); + + // Filter by OCR text content + // Optional ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // Optional order + test('to test the property `order`', () async { + // TODO + }); + + // Filter by original file name + // Optional originalFileName + test('to test the property `originalFileName`', () async { + // TODO + }); + + // Filter by original file path + // Optional originalPath + test('to test the property `originalPath`', () async { + // TODO + }); + + // Page number + // Optional page + test('to test the property `page`', () async { + // TODO + }); + + // Filter by person IDs + // Optional?> personIds (default value: const []) + test('to test the property `personIds`', () async { + // TODO + }); + + // Filter by preview file path + // Optional previewPath + test('to test the property `previewPath`', () async { + // TODO + }); + + // Filter by rating [1-5], or null for unrated + // Optional rating + test('to test the property `rating`', () async { + // TODO + }); + + // Number of results to return + // Optional size + test('to test the property `size`', () async { + // TODO + }); + + // Filter by state/province name + // Optional state + test('to test the property `state`', () async { + // TODO + }); + + // Filter by tag IDs + // Optional?> tagIds (default value: const []) + test('to test the property `tagIds`', () async { + // TODO + }); + + // Filter by taken date (after) + // Optional takenAfter + test('to test the property `takenAfter`', () async { + // TODO + }); + + // Filter by taken date (before) + // Optional takenBefore + test('to test the property `takenBefore`', () async { + // TODO + }); + + // Filter by thumbnail file path + // Optional thumbnailPath + test('to test the property `thumbnailPath`', () async { + // TODO + }); + + // Filter by trash date (after) + // Optional trashedAfter + test('to test the property `trashedAfter`', () async { + // TODO + }); + + // Filter by trash date (before) + // Optional trashedBefore + test('to test the property `trashedBefore`', () async { + // TODO + }); + + // Optional type + test('to test the property `type`', () async { + // TODO + }); + + // Filter by update date (after) + // Optional updatedAfter + test('to test the property `updatedAfter`', () async { + // TODO + }); + + // Filter by update date (before) + // Optional updatedBefore + test('to test the property `updatedBefore`', () async { + // TODO + }); + + // Optional visibility + test('to test the property `visibility`', () async { + // TODO + }); + + // Include deleted assets + // Optional withDeleted + test('to test the property `withDeleted`', () async { + // TODO + }); + + // Include EXIF data in response + // Optional withExif + test('to test the property `withExif`', () async { + // TODO + }); + + // Include people data in response + // Optional withPeople + test('to test the property `withPeople`', () async { + // TODO + }); + + // Include stacked assets + // Optional withStacked + test('to test the property `withStacked`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/mirror_axis_test.dart b/mobile/openapi/test/mirror_axis_test.dart new file mode 100644 index 0000000000000..1feb5c18b0e66 --- /dev/null +++ b/mobile/openapi/test/mirror_axis_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MirrorAxis +void main() { + + group('test MirrorAxis', () { + + }); + +} diff --git a/mobile/openapi/test/mirror_parameters_test.dart b/mobile/openapi/test/mirror_parameters_test.dart new file mode 100644 index 0000000000000..3bb62c9bbbb25 --- /dev/null +++ b/mobile/openapi/test/mirror_parameters_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for MirrorParameters +void main() { + // final instance = MirrorParameters(); + + group('test MirrorParameters', () { + // MirrorAxis axis + test('to test the property `axis`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/notification_create_dto_test.dart b/mobile/openapi/test/notification_create_dto_test.dart new file mode 100644 index 0000000000000..d465db4a769be --- /dev/null +++ b/mobile/openapi/test/notification_create_dto_test.dart @@ -0,0 +1,62 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for NotificationCreateDto +void main() { + // final instance = NotificationCreateDto(); + + group('test NotificationCreateDto', () { + // Additional notification data + // Optional?> data (default value: const {}) + test('to test the property `data`', () async { + // TODO + }); + + // Notification description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Optional level + test('to test the property `level`', () async { + // TODO + }); + + // Date when notification was read + // Optional readAt + test('to test the property `readAt`', () async { + // TODO + }); + + // Notification title + // String title + test('to test the property `title`', () async { + // TODO + }); + + // Optional type + test('to test the property `type`', () async { + // TODO + }); + + // User ID to send notification to + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/notification_delete_all_dto_test.dart b/mobile/openapi/test/notification_delete_all_dto_test.dart new file mode 100644 index 0000000000000..6d32e5ab07df7 --- /dev/null +++ b/mobile/openapi/test/notification_delete_all_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for NotificationDeleteAllDto +void main() { + // final instance = NotificationDeleteAllDto(); + + group('test NotificationDeleteAllDto', () { + // Notification IDs to delete + // List ids (default value: const []) + test('to test the property `ids`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/notification_dto_test.dart b/mobile/openapi/test/notification_dto_test.dart new file mode 100644 index 0000000000000..de684fca54e13 --- /dev/null +++ b/mobile/openapi/test/notification_dto_test.dart @@ -0,0 +1,68 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for NotificationDto +void main() { + // final instance = NotificationDto(); + + group('test NotificationDto', () { + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Additional notification data + // Optional?> data (default value: const {}) + test('to test the property `data`', () async { + // TODO + }); + + // Notification description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Notification ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // NotificationLevel level + test('to test the property `level`', () async { + // TODO + }); + + // Date when notification was read + // Optional readAt + test('to test the property `readAt`', () async { + // TODO + }); + + // Notification title + // String title + test('to test the property `title`', () async { + // TODO + }); + + // NotificationType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/notification_level_test.dart b/mobile/openapi/test/notification_level_test.dart new file mode 100644 index 0000000000000..1dac3b28119b6 --- /dev/null +++ b/mobile/openapi/test/notification_level_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for NotificationLevel +void main() { + + group('test NotificationLevel', () { + + }); + +} diff --git a/mobile/openapi/test/notification_type_test.dart b/mobile/openapi/test/notification_type_test.dart new file mode 100644 index 0000000000000..cd84c777a954b --- /dev/null +++ b/mobile/openapi/test/notification_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for NotificationType +void main() { + + group('test NotificationType', () { + + }); + +} diff --git a/mobile/openapi/test/notification_update_all_dto_test.dart b/mobile/openapi/test/notification_update_all_dto_test.dart new file mode 100644 index 0000000000000..5efecefa87f66 --- /dev/null +++ b/mobile/openapi/test/notification_update_all_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for NotificationUpdateAllDto +void main() { + // final instance = NotificationUpdateAllDto(); + + group('test NotificationUpdateAllDto', () { + // Notification IDs to update + // List ids (default value: const []) + test('to test the property `ids`', () async { + // TODO + }); + + // Date when notifications were read + // Optional readAt + test('to test the property `readAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/notification_update_dto_test.dart b/mobile/openapi/test/notification_update_dto_test.dart new file mode 100644 index 0000000000000..d600d6c71755a --- /dev/null +++ b/mobile/openapi/test/notification_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for NotificationUpdateDto +void main() { + // final instance = NotificationUpdateDto(); + + group('test NotificationUpdateDto', () { + // Date when notification was read + // Optional readAt + test('to test the property `readAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/notifications_admin_api_test.dart b/mobile/openapi/test/notifications_admin_api_test.dart new file mode 100644 index 0000000000000..af37df79ecc96 --- /dev/null +++ b/mobile/openapi/test/notifications_admin_api_test.dart @@ -0,0 +1,48 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for NotificationsAdminApi +void main() { + // final instance = NotificationsAdminApi(); + + group('tests for NotificationsAdminApi', () { + // Create a notification + // + // Create a new notification for a specific user. + // + //Future createNotification(NotificationCreateDto notificationCreateDto) async + test('test createNotification', () async { + // TODO + }); + + // Render email template + // + // Retrieve a preview of the provided email template. + // + //Future getNotificationTemplateAdmin(String name, TemplateDto templateDto) async + test('test getNotificationTemplateAdmin', () async { + // TODO + }); + + // Send test email + // + // Send a test email using the provided SMTP configuration. + // + //Future sendTestEmailAdmin(SystemConfigSmtpDto systemConfigSmtpDto) async + test('test sendTestEmailAdmin', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/notifications_api_test.dart b/mobile/openapi/test/notifications_api_test.dart new file mode 100644 index 0000000000000..0440bd46c5146 --- /dev/null +++ b/mobile/openapi/test/notifications_api_test.dart @@ -0,0 +1,75 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for NotificationsApi +void main() { + // final instance = NotificationsApi(); + + group('tests for NotificationsApi', () { + // Delete a notification + // + // Delete a specific notification. + // + //Future deleteNotification(String id) async + test('test deleteNotification', () async { + // TODO + }); + + // Delete notifications + // + // Delete a list of notifications at once. + // + //Future deleteNotifications(NotificationDeleteAllDto notificationDeleteAllDto) async + test('test deleteNotifications', () async { + // TODO + }); + + // Get a notification + // + // Retrieve a specific notification identified by id. + // + //Future getNotification(String id) async + test('test getNotification', () async { + // TODO + }); + + // Retrieve notifications + // + // Retrieve a list of notifications. + // + //Future> getNotifications({ String id, NotificationLevel level, NotificationType type, bool unread }) async + test('test getNotifications', () async { + // TODO + }); + + // Update a notification + // + // Update a specific notification to set its read status. + // + //Future updateNotification(String id, NotificationUpdateDto notificationUpdateDto) async + test('test updateNotification', () async { + // TODO + }); + + // Update notifications + // + // Update a list of notifications. Allows to bulk-set the read status of notifications. + // + //Future updateNotifications(NotificationUpdateAllDto notificationUpdateAllDto) async + test('test updateNotifications', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/o_auth_authorize_response_dto_test.dart b/mobile/openapi/test/o_auth_authorize_response_dto_test.dart new file mode 100644 index 0000000000000..4940a112f714d --- /dev/null +++ b/mobile/openapi/test/o_auth_authorize_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OAuthAuthorizeResponseDto +void main() { + // final instance = OAuthAuthorizeResponseDto(); + + group('test OAuthAuthorizeResponseDto', () { + // OAuth authorization URL + // String url + test('to test the property `url`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/o_auth_callback_dto_test.dart b/mobile/openapi/test/o_auth_callback_dto_test.dart new file mode 100644 index 0000000000000..b69546694d1f3 --- /dev/null +++ b/mobile/openapi/test/o_auth_callback_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OAuthCallbackDto +void main() { + // final instance = OAuthCallbackDto(); + + group('test OAuthCallbackDto', () { + // OAuth code verifier (PKCE) + // Optional codeVerifier + test('to test the property `codeVerifier`', () async { + // TODO + }); + + // OAuth state parameter + // Optional state + test('to test the property `state`', () async { + // TODO + }); + + // OAuth callback URL + // String url + test('to test the property `url`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/o_auth_config_dto_test.dart b/mobile/openapi/test/o_auth_config_dto_test.dart new file mode 100644 index 0000000000000..fadd814f538f1 --- /dev/null +++ b/mobile/openapi/test/o_auth_config_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OAuthConfigDto +void main() { + // final instance = OAuthConfigDto(); + + group('test OAuthConfigDto', () { + // OAuth code challenge (PKCE) + // Optional codeChallenge + test('to test the property `codeChallenge`', () async { + // TODO + }); + + // OAuth redirect URI + // String redirectUri + test('to test the property `redirectUri`', () async { + // TODO + }); + + // OAuth state parameter + // Optional state + test('to test the property `state`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/o_auth_token_endpoint_auth_method_test.dart b/mobile/openapi/test/o_auth_token_endpoint_auth_method_test.dart new file mode 100644 index 0000000000000..3bdb516d6acb6 --- /dev/null +++ b/mobile/openapi/test/o_auth_token_endpoint_auth_method_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OAuthTokenEndpointAuthMethod +void main() { + + group('test OAuthTokenEndpointAuthMethod', () { + + }); + +} diff --git a/mobile/openapi/test/ocr_config_test.dart b/mobile/openapi/test/ocr_config_test.dart new file mode 100644 index 0000000000000..cb804191b6b13 --- /dev/null +++ b/mobile/openapi/test/ocr_config_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OcrConfig +void main() { + // final instance = OcrConfig(); + + group('test OcrConfig', () { + // Whether the task is enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Maximum resolution for OCR processing + // int maxResolution + test('to test the property `maxResolution`', () async { + // TODO + }); + + // Minimum confidence score for text detection + // double minDetectionScore + test('to test the property `minDetectionScore`', () async { + // TODO + }); + + // Minimum confidence score for text recognition + // double minRecognitionScore + test('to test the property `minRecognitionScore`', () async { + // TODO + }); + + // Name of the model to use + // String modelName + test('to test the property `modelName`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/on_this_day_dto_test.dart b/mobile/openapi/test/on_this_day_dto_test.dart new file mode 100644 index 0000000000000..f504bee9b9243 --- /dev/null +++ b/mobile/openapi/test/on_this_day_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OnThisDayDto +void main() { + // final instance = OnThisDayDto(); + + group('test OnThisDayDto', () { + // Year for on this day memory + // int year + test('to test the property `year`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/onboarding_api_test.dart b/mobile/openapi/test/onboarding_api_test.dart new file mode 100644 index 0000000000000..f73223f9716ea --- /dev/null +++ b/mobile/openapi/test/onboarding_api_test.dart @@ -0,0 +1,56 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for OnboardingApi +void main() { + // final instance = OnboardingApi(); + + group('tests for OnboardingApi', () { + //Future confirmRecoveryKey() async + test('test confirmRecoveryKey', () async { + // TODO + }); + + //Future currentRecoveryKey() async + test('test currentRecoveryKey', () async { + // TODO + }); + + //Future enableTelemetry() async + test('test enableTelemetry', () async { + // TODO + }); + + //Future importRecoveryKey(ImportRecoveryKeyRequest importRecoveryKeyRequest) async + test('test importRecoveryKey', () async { + // TODO + }); + + //Future onboardingStatus() async + test('test onboardingStatus', () async { + // TODO + }); + + //Future reportError() async + test('test reportError', () async { + // TODO + }); + + //Future skipOnboardingExtraConfig() async + test('test skipOnboardingExtraConfig', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/onboarding_dto_test.dart b/mobile/openapi/test/onboarding_dto_test.dart new file mode 100644 index 0000000000000..36bb82d0f71ad --- /dev/null +++ b/mobile/openapi/test/onboarding_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OnboardingDto +void main() { + // final instance = OnboardingDto(); + + group('test OnboardingDto', () { + // Is user onboarded + // bool isOnboarded + test('to test the property `isOnboarded`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/onboarding_response_dto_test.dart b/mobile/openapi/test/onboarding_response_dto_test.dart new file mode 100644 index 0000000000000..6ebe9c46cb216 --- /dev/null +++ b/mobile/openapi/test/onboarding_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OnboardingResponseDto +void main() { + // final instance = OnboardingResponseDto(); + + group('test OnboardingResponseDto', () { + // Is user onboarded + // bool isOnboarded + test('to test the property `isOnboarded`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/onboarding_status_response_dto_test.dart b/mobile/openapi/test/onboarding_status_response_dto_test.dart new file mode 100644 index 0000000000000..aa6a220f3aef3 --- /dev/null +++ b/mobile/openapi/test/onboarding_status_response_dto_test.dart @@ -0,0 +1,62 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for OnboardingStatusResponseDto +void main() { + // final instance = OnboardingStatusResponseDto(); + + group('test OnboardingStatusResponseDto', () { + // Optional error + test('to test the property `error`', () async { + // TODO + }); + + // bool hasBackend + test('to test the property `hasBackend`', () async { + // TODO + }); + + // bool hasBackup + test('to test the property `hasBackup`', () async { + // TODO + }); + + // bool hasOnboardedKey + test('to test the property `hasOnboardedKey`', () async { + // TODO + }); + + // bool hasSchedule + test('to test the property `hasSchedule`', () async { + // TODO + }); + + // bool hasSkippedExtraConfig + test('to test the property `hasSkippedExtraConfig`', () async { + // TODO + }); + + // TelemetryLevel hasTelemetry + test('to test the property `hasTelemetry`', () async { + // TODO + }); + + // BootstrapStatus status + test('to test the property `status`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/partner_create_dto_test.dart b/mobile/openapi/test/partner_create_dto_test.dart new file mode 100644 index 0000000000000..5b7c6ad4a32f6 --- /dev/null +++ b/mobile/openapi/test/partner_create_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PartnerCreateDto +void main() { + // final instance = PartnerCreateDto(); + + group('test PartnerCreateDto', () { + // User ID to share with + // String sharedWithId + test('to test the property `sharedWithId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/partner_direction_test.dart b/mobile/openapi/test/partner_direction_test.dart new file mode 100644 index 0000000000000..0a95824be5dba --- /dev/null +++ b/mobile/openapi/test/partner_direction_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PartnerDirection +void main() { + + group('test PartnerDirection', () { + + }); + +} diff --git a/mobile/openapi/test/partner_response_dto_test.dart b/mobile/openapi/test/partner_response_dto_test.dart new file mode 100644 index 0000000000000..b8d84c4718135 --- /dev/null +++ b/mobile/openapi/test/partner_response_dto_test.dart @@ -0,0 +1,63 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PartnerResponseDto +void main() { + // final instance = PartnerResponseDto(); + + group('test PartnerResponseDto', () { + // UserAvatarColor avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // User ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Show in timeline + // Optional inTimeline + test('to test the property `inTimeline`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Profile change date + // DateTime profileChangedAt + test('to test the property `profileChangedAt`', () async { + // TODO + }); + + // Profile image path + // String profileImagePath + test('to test the property `profileImagePath`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/partner_update_dto_test.dart b/mobile/openapi/test/partner_update_dto_test.dart new file mode 100644 index 0000000000000..d586ef399b3ca --- /dev/null +++ b/mobile/openapi/test/partner_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PartnerUpdateDto +void main() { + // final instance = PartnerUpdateDto(); + + group('test PartnerUpdateDto', () { + // Show partner assets in timeline + // bool inTimeline + test('to test the property `inTimeline`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/partners_api_test.dart b/mobile/openapi/test/partners_api_test.dart new file mode 100644 index 0000000000000..8e81275af0ded --- /dev/null +++ b/mobile/openapi/test/partners_api_test.dart @@ -0,0 +1,66 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for PartnersApi +void main() { + // final instance = PartnersApi(); + + group('tests for PartnersApi', () { + // Create a partner + // + // Create a new partner to share assets with. + // + //Future createPartner(PartnerCreateDto partnerCreateDto) async + test('test createPartner', () async { + // TODO + }); + + // Create a partner + // + // Create a new partner to share assets with. + // + //Future createPartnerDeprecated(String id) async + test('test createPartnerDeprecated', () async { + // TODO + }); + + // Retrieve partners + // + // Retrieve a list of partners with whom assets are shared. + // + //Future> getPartners(PartnerDirection direction) async + test('test getPartners', () async { + // TODO + }); + + // Remove a partner + // + // Stop sharing assets with a partner. + // + //Future removePartner(String id) async + test('test removePartner', () async { + // TODO + }); + + // Update a partner + // + // Specify whether a partner's assets should appear in the user's timeline. + // + //Future updatePartner(String id, PartnerUpdateDto partnerUpdateDto) async + test('test updatePartner', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/people_api_test.dart b/mobile/openapi/test/people_api_test.dart new file mode 100644 index 0000000000000..7c641e92d5a28 --- /dev/null +++ b/mobile/openapi/test/people_api_test.dart @@ -0,0 +1,120 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for PeopleApi +void main() { + // final instance = PeopleApi(); + + group('tests for PeopleApi', () { + // Create a person + // + // Create a new person that can have multiple faces assigned to them. + // + //Future createPerson(PersonCreateDto personCreateDto) async + test('test createPerson', () async { + // TODO + }); + + // Delete people + // + // Bulk delete a list of people at once. + // + //Future deletePeople(BulkIdsDto bulkIdsDto) async + test('test deletePeople', () async { + // TODO + }); + + // Delete person + // + // Delete an individual person. + // + //Future deletePerson(String id) async + test('test deletePerson', () async { + // TODO + }); + + // Get all people + // + // Retrieve a list of all people. + // + //Future getAllPeople({ String closestAssetId, String closestPersonId, int page, int size, bool withHidden }) async + test('test getAllPeople', () async { + // TODO + }); + + // Get a person + // + // Retrieve a person by id. + // + //Future getPerson(String id) async + test('test getPerson', () async { + // TODO + }); + + // Get person statistics + // + // Retrieve statistics about a specific person. + // + //Future getPersonStatistics(String id) async + test('test getPersonStatistics', () async { + // TODO + }); + + // Get person thumbnail + // + // Retrieve the thumbnail file for a person. + // + //Future getPersonThumbnail(String id) async + test('test getPersonThumbnail', () async { + // TODO + }); + + // Merge people + // + // Merge a list of people into the person specified in the path parameter. + // + //Future> mergePerson(String id, MergePersonDto mergePersonDto) async + test('test mergePerson', () async { + // TODO + }); + + // Reassign faces + // + // Bulk reassign a list of faces to a different person. + // + //Future> reassignFaces(String id, AssetFaceUpdateDto assetFaceUpdateDto) async + test('test reassignFaces', () async { + // TODO + }); + + // Update people + // + // Bulk update multiple people at once. + // + //Future> updatePeople(PeopleUpdateDto peopleUpdateDto) async + test('test updatePeople', () async { + // TODO + }); + + // Update person + // + // Update an individual person. + // + //Future updatePerson(String id, PersonUpdateDto personUpdateDto) async + test('test updatePerson', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/people_response_dto_test.dart b/mobile/openapi/test/people_response_dto_test.dart new file mode 100644 index 0000000000000..b1ad3bd2be152 --- /dev/null +++ b/mobile/openapi/test/people_response_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PeopleResponseDto +void main() { + // final instance = PeopleResponseDto(); + + group('test PeopleResponseDto', () { + // Whether there are more pages + // Optional hasNextPage + test('to test the property `hasNextPage`', () async { + // TODO + }); + + // Number of hidden people + // int hidden + test('to test the property `hidden`', () async { + // TODO + }); + + // List people (default value: const []) + test('to test the property `people`', () async { + // TODO + }); + + // Total number of people + // int total + test('to test the property `total`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/people_response_test.dart b/mobile/openapi/test/people_response_test.dart new file mode 100644 index 0000000000000..6ddd73438f824 --- /dev/null +++ b/mobile/openapi/test/people_response_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PeopleResponse +void main() { + // final instance = PeopleResponse(); + + group('test PeopleResponse', () { + // Whether people are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // People face threshold + // Optional minimumFaces + test('to test the property `minimumFaces`', () async { + // TODO + }); + + // Whether people appear in web sidebar + // bool sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/people_update_dto_test.dart b/mobile/openapi/test/people_update_dto_test.dart new file mode 100644 index 0000000000000..0e4c0727ae687 --- /dev/null +++ b/mobile/openapi/test/people_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PeopleUpdateDto +void main() { + // final instance = PeopleUpdateDto(); + + group('test PeopleUpdateDto', () { + // People to update + // List people (default value: const []) + test('to test the property `people`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/people_update_item_test.dart b/mobile/openapi/test/people_update_item_test.dart new file mode 100644 index 0000000000000..fed22b7a85fb7 --- /dev/null +++ b/mobile/openapi/test/people_update_item_test.dart @@ -0,0 +1,64 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PeopleUpdateItem +void main() { + // final instance = PeopleUpdateItem(); + + group('test PeopleUpdateItem', () { + // Person date of birth + // Optional birthDate + test('to test the property `birthDate`', () async { + // TODO + }); + + // Person color (hex) + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + // Asset ID used for feature face thumbnail + // Optional featureFaceAssetId + test('to test the property `featureFaceAssetId`', () async { + // TODO + }); + + // Person ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Mark as favorite + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Person visibility (hidden) + // Optional isHidden + test('to test the property `isHidden`', () async { + // TODO + }); + + // Person name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/people_update_test.dart b/mobile/openapi/test/people_update_test.dart new file mode 100644 index 0000000000000..32f6297b82881 --- /dev/null +++ b/mobile/openapi/test/people_update_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PeopleUpdate +void main() { + // final instance = PeopleUpdate(); + + group('test PeopleUpdate', () { + // Whether people are enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // People face threshold + // Optional minimumFaces + test('to test the property `minimumFaces`', () async { + // TODO + }); + + // Whether people appear in web sidebar + // Optional sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/permission_test.dart b/mobile/openapi/test/permission_test.dart new file mode 100644 index 0000000000000..293f7a9f7101e --- /dev/null +++ b/mobile/openapi/test/permission_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for Permission +void main() { + + group('test Permission', () { + + }); + +} diff --git a/mobile/openapi/test/person_create_dto_test.dart b/mobile/openapi/test/person_create_dto_test.dart new file mode 100644 index 0000000000000..e200465d009da --- /dev/null +++ b/mobile/openapi/test/person_create_dto_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PersonCreateDto +void main() { + // final instance = PersonCreateDto(); + + group('test PersonCreateDto', () { + // Person date of birth + // Optional birthDate + test('to test the property `birthDate`', () async { + // TODO + }); + + // Person color (hex) + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + // Mark as favorite + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Person visibility (hidden) + // Optional isHidden + test('to test the property `isHidden`', () async { + // TODO + }); + + // Person name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/person_response_dto_test.dart b/mobile/openapi/test/person_response_dto_test.dart new file mode 100644 index 0000000000000..9eb3603ab9af6 --- /dev/null +++ b/mobile/openapi/test/person_response_dto_test.dart @@ -0,0 +1,70 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PersonResponseDto +void main() { + // final instance = PersonResponseDto(); + + group('test PersonResponseDto', () { + // Person date of birth + // DateTime birthDate + test('to test the property `birthDate`', () async { + // TODO + }); + + // Person color (hex) + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + // Person ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is favorite + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Is hidden + // bool isHidden + test('to test the property `isHidden`', () async { + // TODO + }); + + // Person name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Thumbnail path + // String thumbnailPath + test('to test the property `thumbnailPath`', () async { + // TODO + }); + + // Last update date + // Optional updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/person_statistics_response_dto_test.dart b/mobile/openapi/test/person_statistics_response_dto_test.dart new file mode 100644 index 0000000000000..d44eb969e400d --- /dev/null +++ b/mobile/openapi/test/person_statistics_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PersonStatisticsResponseDto +void main() { + // final instance = PersonStatisticsResponseDto(); + + group('test PersonStatisticsResponseDto', () { + // Number of assets + // int assets + test('to test the property `assets`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/person_update_dto_test.dart b/mobile/openapi/test/person_update_dto_test.dart new file mode 100644 index 0000000000000..833e65b6a549e --- /dev/null +++ b/mobile/openapi/test/person_update_dto_test.dart @@ -0,0 +1,58 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PersonUpdateDto +void main() { + // final instance = PersonUpdateDto(); + + group('test PersonUpdateDto', () { + // Person date of birth + // Optional birthDate + test('to test the property `birthDate`', () async { + // TODO + }); + + // Person color (hex) + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + // Asset ID used for feature face thumbnail + // Optional featureFaceAssetId + test('to test the property `featureFaceAssetId`', () async { + // TODO + }); + + // Mark as favorite + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Person visibility (hidden) + // Optional isHidden + test('to test the property `isHidden`', () async { + // TODO + }); + + // Person name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/pin_code_change_dto_test.dart b/mobile/openapi/test/pin_code_change_dto_test.dart new file mode 100644 index 0000000000000..53ec2d644fa11 --- /dev/null +++ b/mobile/openapi/test/pin_code_change_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PinCodeChangeDto +void main() { + // final instance = PinCodeChangeDto(); + + group('test PinCodeChangeDto', () { + // New PIN code (4-6 digits) + // String newPinCode + test('to test the property `newPinCode`', () async { + // TODO + }); + + // User password (required if PIN code is not provided) + // Optional password + test('to test the property `password`', () async { + // TODO + }); + + // New PIN code (4-6 digits) + // Optional pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/pin_code_reset_dto_test.dart b/mobile/openapi/test/pin_code_reset_dto_test.dart new file mode 100644 index 0000000000000..f86d5558b2c25 --- /dev/null +++ b/mobile/openapi/test/pin_code_reset_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PinCodeResetDto +void main() { + // final instance = PinCodeResetDto(); + + group('test PinCodeResetDto', () { + // User password (required if PIN code is not provided) + // Optional password + test('to test the property `password`', () async { + // TODO + }); + + // New PIN code (4-6 digits) + // Optional pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/pin_code_setup_dto_test.dart b/mobile/openapi/test/pin_code_setup_dto_test.dart new file mode 100644 index 0000000000000..2c082307300e1 --- /dev/null +++ b/mobile/openapi/test/pin_code_setup_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PinCodeSetupDto +void main() { + // final instance = PinCodeSetupDto(); + + group('test PinCodeSetupDto', () { + // PIN code (4-6 digits) + // String pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/places_response_dto_test.dart b/mobile/openapi/test/places_response_dto_test.dart new file mode 100644 index 0000000000000..3957827e2df57 --- /dev/null +++ b/mobile/openapi/test/places_response_dto_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PlacesResponseDto +void main() { + // final instance = PlacesResponseDto(); + + group('test PlacesResponseDto', () { + // Administrative level 1 name (state/province) + // Optional admin1name + test('to test the property `admin1name`', () async { + // TODO + }); + + // Administrative level 2 name (county/district) + // Optional admin2name + test('to test the property `admin2name`', () async { + // TODO + }); + + // Latitude coordinate + // num latitude + test('to test the property `latitude`', () async { + // TODO + }); + + // Longitude coordinate + // num longitude + test('to test the property `longitude`', () async { + // TODO + }); + + // Place name + // String name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/plugin_method_response_dto_test.dart b/mobile/openapi/test/plugin_method_response_dto_test.dart new file mode 100644 index 0000000000000..a21c369b9696a --- /dev/null +++ b/mobile/openapi/test/plugin_method_response_dto_test.dart @@ -0,0 +1,68 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PluginMethodResponseDto +void main() { + // final instance = PluginMethodResponseDto(); + + group('test PluginMethodResponseDto', () { + // Description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // bool hostFunctions + test('to test the property `hostFunctions`', () async { + // TODO + }); + + // Key + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Optional schema + test('to test the property `schema`', () async { + // TODO + }); + + // Title + // String title + test('to test the property `title`', () async { + // TODO + }); + + // Workflow types + // List types (default value: const []) + test('to test the property `types`', () async { + // TODO + }); + + // Ui hints + // List uiHints (default value: const []) + test('to test the property `uiHints`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/plugin_response_dto_test.dart b/mobile/openapi/test/plugin_response_dto_test.dart new file mode 100644 index 0000000000000..ccdf1d5129653 --- /dev/null +++ b/mobile/openapi/test/plugin_response_dto_test.dart @@ -0,0 +1,76 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PluginResponseDto +void main() { + // final instance = PluginResponseDto(); + + group('test PluginResponseDto', () { + // Plugin author + // String author + test('to test the property `author`', () async { + // TODO + }); + + // Creation date + // String createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Plugin description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Plugin ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Plugin methods + // List methods (default value: const []) + test('to test the property `methods`', () async { + // TODO + }); + + // Plugin name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Plugin title + // String title + test('to test the property `title`', () async { + // TODO + }); + + // Last update date + // String updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + // Plugin version + // String version + test('to test the property `version`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/plugin_template_response_dto_test.dart b/mobile/openapi/test/plugin_template_response_dto_test.dart new file mode 100644 index 0000000000000..dbca4f8810b66 --- /dev/null +++ b/mobile/openapi/test/plugin_template_response_dto_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PluginTemplateResponseDto +void main() { + // final instance = PluginTemplateResponseDto(); + + group('test PluginTemplateResponseDto', () { + // Template description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Template key (unique across all templates) + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Workflow steps + // List steps (default value: const []) + test('to test the property `steps`', () async { + // TODO + }); + + // Template title + // String title + test('to test the property `title`', () async { + // TODO + }); + + // WorkflowTrigger trigger + test('to test the property `trigger`', () async { + // TODO + }); + + // Ui hints, for example \"smart-album\" + // List uiHints (default value: const []) + test('to test the property `uiHints`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/plugin_template_step_response_dto_test.dart b/mobile/openapi/test/plugin_template_step_response_dto_test.dart new file mode 100644 index 0000000000000..3e1bbcb838814 --- /dev/null +++ b/mobile/openapi/test/plugin_template_step_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PluginTemplateStepResponseDto +void main() { + // final instance = PluginTemplateStepResponseDto(); + + group('test PluginTemplateStepResponseDto', () { + // Step configuration + // Map config (default value: const {}) + test('to test the property `config`', () async { + // TODO + }); + + // Whether the step is enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Step plugin method + // String method + test('to test the property `method`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/plugins_api_test.dart b/mobile/openapi/test/plugins_api_test.dart new file mode 100644 index 0000000000000..25ed8135da256 --- /dev/null +++ b/mobile/openapi/test/plugins_api_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for PluginsApi +void main() { + // final instance = PluginsApi(); + + group('tests for PluginsApi', () { + // Retrieve a plugin + // + // Retrieve information about a specific plugin by its ID. + // + //Future getPlugin(String id) async + test('test getPlugin', () async { + // TODO + }); + + // Retrieve plugin methods + // + // Retrieve a list of plugin methods + // + //Future> searchPluginMethods({ String description, bool enabled, String id, String name, String pluginName, String pluginVersion, String title, WorkflowTrigger trigger, WorkflowType type }) async + test('test searchPluginMethods', () async { + // TODO + }); + + // Retrieve workflow templates + // + // Retrieve workflow templates provided by installed plugins + // + //Future> searchPluginTemplates() async + test('test searchPluginTemplates', () async { + // TODO + }); + + // List all plugins + // + // Retrieve a list of plugins available to the authenticated user. + // + //Future> searchPlugins({ String description, bool enabled, String id, String name, String title, String version }) async + test('test searchPlugins', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/purchase_response_test.dart b/mobile/openapi/test/purchase_response_test.dart new file mode 100644 index 0000000000000..92ae6c379a236 --- /dev/null +++ b/mobile/openapi/test/purchase_response_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PurchaseResponse +void main() { + // final instance = PurchaseResponse(); + + group('test PurchaseResponse', () { + // Date until which to hide buy button + // String hideBuyButtonUntil + test('to test the property `hideBuyButtonUntil`', () async { + // TODO + }); + + // Whether to show support badge + // bool showSupportBadge + test('to test the property `showSupportBadge`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/purchase_update_test.dart b/mobile/openapi/test/purchase_update_test.dart new file mode 100644 index 0000000000000..ed136f921a151 --- /dev/null +++ b/mobile/openapi/test/purchase_update_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for PurchaseUpdate +void main() { + // final instance = PurchaseUpdate(); + + group('test PurchaseUpdate', () { + // Date until which to hide buy button + // Optional hideBuyButtonUntil + test('to test the property `hideBuyButtonUntil`', () async { + // TODO + }); + + // Whether to show support badge + // Optional showSupportBadge + test('to test the property `showSupportBadge`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_command_dto_test.dart b/mobile/openapi/test/queue_command_dto_test.dart new file mode 100644 index 0000000000000..88fbad505f502 --- /dev/null +++ b/mobile/openapi/test/queue_command_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueCommandDto +void main() { + // final instance = QueueCommandDto(); + + group('test QueueCommandDto', () { + // QueueCommand command + test('to test the property `command`', () async { + // TODO + }); + + // Force the command execution (if applicable) + // Optional force + test('to test the property `force`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_command_test.dart b/mobile/openapi/test/queue_command_test.dart new file mode 100644 index 0000000000000..0f4f7638332a5 --- /dev/null +++ b/mobile/openapi/test/queue_command_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueCommand +void main() { + + group('test QueueCommand', () { + + }); + +} diff --git a/mobile/openapi/test/queue_delete_dto_test.dart b/mobile/openapi/test/queue_delete_dto_test.dart new file mode 100644 index 0000000000000..0160d0e9f68b1 --- /dev/null +++ b/mobile/openapi/test/queue_delete_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueDeleteDto +void main() { + // final instance = QueueDeleteDto(); + + group('test QueueDeleteDto', () { + // If true, will also remove failed jobs from the queue. + // Optional failed + test('to test the property `failed`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_job_response_dto_test.dart b/mobile/openapi/test/queue_job_response_dto_test.dart new file mode 100644 index 0000000000000..698190bd7e2e7 --- /dev/null +++ b/mobile/openapi/test/queue_job_response_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueJobResponseDto +void main() { + // final instance = QueueJobResponseDto(); + + group('test QueueJobResponseDto', () { + // Job data payload + // Map data (default value: const {}) + test('to test the property `data`', () async { + // TODO + }); + + // Job ID + // Optional id + test('to test the property `id`', () async { + // TODO + }); + + // JobName name + test('to test the property `name`', () async { + // TODO + }); + + // Job creation timestamp + // int timestamp + test('to test the property `timestamp`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_job_status_test.dart b/mobile/openapi/test/queue_job_status_test.dart new file mode 100644 index 0000000000000..dd5e8ef09ef0a --- /dev/null +++ b/mobile/openapi/test/queue_job_status_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueJobStatus +void main() { + + group('test QueueJobStatus', () { + + }); + +} diff --git a/mobile/openapi/test/queue_name_test.dart b/mobile/openapi/test/queue_name_test.dart new file mode 100644 index 0000000000000..2d7ae125fdc95 --- /dev/null +++ b/mobile/openapi/test/queue_name_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueName +void main() { + + group('test QueueName', () { + + }); + +} diff --git a/mobile/openapi/test/queue_response_dto_test.dart b/mobile/openapi/test/queue_response_dto_test.dart new file mode 100644 index 0000000000000..7cf82acc2289e --- /dev/null +++ b/mobile/openapi/test/queue_response_dto_test.dart @@ -0,0 +1,38 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueResponseDto +void main() { + // final instance = QueueResponseDto(); + + group('test QueueResponseDto', () { + // Whether the queue is paused + // bool isPaused + test('to test the property `isPaused`', () async { + // TODO + }); + + // QueueName name + test('to test the property `name`', () async { + // TODO + }); + + // QueueStatisticsDto statistics + test('to test the property `statistics`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_response_legacy_dto_test.dart b/mobile/openapi/test/queue_response_legacy_dto_test.dart new file mode 100644 index 0000000000000..a25ed068388f0 --- /dev/null +++ b/mobile/openapi/test/queue_response_legacy_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueResponseLegacyDto +void main() { + // final instance = QueueResponseLegacyDto(); + + group('test QueueResponseLegacyDto', () { + // QueueStatisticsDto jobCounts + test('to test the property `jobCounts`', () async { + // TODO + }); + + // QueueStatusLegacyDto queueStatus + test('to test the property `queueStatus`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_statistics_dto_test.dart b/mobile/openapi/test/queue_statistics_dto_test.dart new file mode 100644 index 0000000000000..ec017153536e6 --- /dev/null +++ b/mobile/openapi/test/queue_statistics_dto_test.dart @@ -0,0 +1,58 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueStatisticsDto +void main() { + // final instance = QueueStatisticsDto(); + + group('test QueueStatisticsDto', () { + // Number of active jobs + // int active + test('to test the property `active`', () async { + // TODO + }); + + // Number of completed jobs + // int completed + test('to test the property `completed`', () async { + // TODO + }); + + // Number of delayed jobs + // int delayed + test('to test the property `delayed`', () async { + // TODO + }); + + // Number of failed jobs + // int failed + test('to test the property `failed`', () async { + // TODO + }); + + // Number of paused jobs + // int paused + test('to test the property `paused`', () async { + // TODO + }); + + // Number of waiting jobs + // int waiting + test('to test the property `waiting`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_status_legacy_dto_test.dart b/mobile/openapi/test/queue_status_legacy_dto_test.dart new file mode 100644 index 0000000000000..fc8d8209eee71 --- /dev/null +++ b/mobile/openapi/test/queue_status_legacy_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueStatusLegacyDto +void main() { + // final instance = QueueStatusLegacyDto(); + + group('test QueueStatusLegacyDto', () { + // Whether the queue is currently active (has running jobs) + // bool isActive + test('to test the property `isActive`', () async { + // TODO + }); + + // Whether the queue is paused + // bool isPaused + test('to test the property `isPaused`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queue_update_dto_test.dart b/mobile/openapi/test/queue_update_dto_test.dart new file mode 100644 index 0000000000000..99787c3e88b1a --- /dev/null +++ b/mobile/openapi/test/queue_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueueUpdateDto +void main() { + // final instance = QueueUpdateDto(); + + group('test QueueUpdateDto', () { + // Whether to pause the queue + // Optional isPaused + test('to test the property `isPaused`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/queues_api_test.dart b/mobile/openapi/test/queues_api_test.dart new file mode 100644 index 0000000000000..b9b72145158d8 --- /dev/null +++ b/mobile/openapi/test/queues_api_test.dart @@ -0,0 +1,66 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for QueuesApi +void main() { + // final instance = QueuesApi(); + + group('tests for QueuesApi', () { + // Empty a queue + // + // Removes all jobs from the specified queue. + // + //Future emptyQueue(QueueName name, QueueDeleteDto queueDeleteDto) async + test('test emptyQueue', () async { + // TODO + }); + + // Retrieve a queue + // + // Retrieves a specific queue by its name. + // + //Future getQueue(QueueName name) async + test('test getQueue', () async { + // TODO + }); + + // Retrieve queue jobs + // + // Retrieves a list of queue jobs from the specified queue. + // + //Future> getQueueJobs(QueueName name, { List status }) async + test('test getQueueJobs', () async { + // TODO + }); + + // List all queues + // + // Retrieves a list of queues. + // + //Future> getQueues() async + test('test getQueues', () async { + // TODO + }); + + // Update a queue + // + // Change the paused status of a specific queue. + // + //Future updateQueue(QueueName name, QueueUpdateDto queueUpdateDto) async + test('test updateQueue', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/queues_response_legacy_dto_test.dart b/mobile/openapi/test/queues_response_legacy_dto_test.dart new file mode 100644 index 0000000000000..847a42abc0202 --- /dev/null +++ b/mobile/openapi/test/queues_response_legacy_dto_test.dart @@ -0,0 +1,117 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for QueuesResponseLegacyDto +void main() { + // final instance = QueuesResponseLegacyDto(); + + group('test QueuesResponseLegacyDto', () { + // QueueResponseLegacyDto backgroundTask + test('to test the property `backgroundTask`', () async { + // TODO + }); + + // QueueResponseLegacyDto backupDatabase + test('to test the property `backupDatabase`', () async { + // TODO + }); + + // QueueResponseLegacyDto duplicateDetection + test('to test the property `duplicateDetection`', () async { + // TODO + }); + + // QueueResponseLegacyDto editor + test('to test the property `editor`', () async { + // TODO + }); + + // QueueResponseLegacyDto faceDetection + test('to test the property `faceDetection`', () async { + // TODO + }); + + // QueueResponseLegacyDto facialRecognition + test('to test the property `facialRecognition`', () async { + // TODO + }); + + // QueueResponseLegacyDto integrityCheck + test('to test the property `integrityCheck`', () async { + // TODO + }); + + // QueueResponseLegacyDto library_ + test('to test the property `library_`', () async { + // TODO + }); + + // QueueResponseLegacyDto metadataExtraction + test('to test the property `metadataExtraction`', () async { + // TODO + }); + + // QueueResponseLegacyDto migration + test('to test the property `migration`', () async { + // TODO + }); + + // QueueResponseLegacyDto notifications + test('to test the property `notifications`', () async { + // TODO + }); + + // QueueResponseLegacyDto ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // QueueResponseLegacyDto search + test('to test the property `search`', () async { + // TODO + }); + + // QueueResponseLegacyDto sidecar + test('to test the property `sidecar`', () async { + // TODO + }); + + // QueueResponseLegacyDto smartSearch + test('to test the property `smartSearch`', () async { + // TODO + }); + + // QueueResponseLegacyDto storageTemplateMigration + test('to test the property `storageTemplateMigration`', () async { + // TODO + }); + + // QueueResponseLegacyDto thumbnailGeneration + test('to test the property `thumbnailGeneration`', () async { + // TODO + }); + + // QueueResponseLegacyDto videoConversion + test('to test the property `videoConversion`', () async { + // TODO + }); + + // QueueResponseLegacyDto workflow + test('to test the property `workflow`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/random_search_dto_test.dart b/mobile/openapi/test/random_search_dto_test.dart new file mode 100644 index 0000000000000..3196955da110f --- /dev/null +++ b/mobile/openapi/test/random_search_dto_test.dart @@ -0,0 +1,212 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RandomSearchDto +void main() { + // final instance = RandomSearchDto(); + + group('test RandomSearchDto', () { + // Filter by album IDs + // Optional?> albumIds (default value: const []) + test('to test the property `albumIds`', () async { + // TODO + }); + + // Filter by city name + // Optional city + test('to test the property `city`', () async { + // TODO + }); + + // Filter by country name + // Optional country + test('to test the property `country`', () async { + // TODO + }); + + // Filter by creation date (after) + // Optional createdAfter + test('to test the property `createdAfter`', () async { + // TODO + }); + + // Filter by creation date (before) + // Optional createdBefore + test('to test the property `createdBefore`', () async { + // TODO + }); + + // Filter by encoded status + // Optional isEncoded + test('to test the property `isEncoded`', () async { + // TODO + }); + + // Filter by favorite status + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Filter by motion photo status + // Optional isMotion + test('to test the property `isMotion`', () async { + // TODO + }); + + // Filter assets not in any album + // Optional isNotInAlbum + test('to test the property `isNotInAlbum`', () async { + // TODO + }); + + // Filter by offline status + // Optional isOffline + test('to test the property `isOffline`', () async { + // TODO + }); + + // Filter by lens model + // Optional lensModel + test('to test the property `lensModel`', () async { + // TODO + }); + + // Library ID to filter by + // Optional libraryId + test('to test the property `libraryId`', () async { + // TODO + }); + + // Filter by camera make + // Optional make + test('to test the property `make`', () async { + // TODO + }); + + // Filter by camera model + // Optional model + test('to test the property `model`', () async { + // TODO + }); + + // Filter by OCR text content + // Optional ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // Filter by person IDs + // Optional?> personIds (default value: const []) + test('to test the property `personIds`', () async { + // TODO + }); + + // Filter by rating [1-5], or null for unrated + // Optional rating + test('to test the property `rating`', () async { + // TODO + }); + + // Number of results to return + // Optional size + test('to test the property `size`', () async { + // TODO + }); + + // Filter by state/province name + // Optional state + test('to test the property `state`', () async { + // TODO + }); + + // Filter by tag IDs + // Optional?> tagIds (default value: const []) + test('to test the property `tagIds`', () async { + // TODO + }); + + // Filter by taken date (after) + // Optional takenAfter + test('to test the property `takenAfter`', () async { + // TODO + }); + + // Filter by taken date (before) + // Optional takenBefore + test('to test the property `takenBefore`', () async { + // TODO + }); + + // Filter by trash date (after) + // Optional trashedAfter + test('to test the property `trashedAfter`', () async { + // TODO + }); + + // Filter by trash date (before) + // Optional trashedBefore + test('to test the property `trashedBefore`', () async { + // TODO + }); + + // Optional type + test('to test the property `type`', () async { + // TODO + }); + + // Filter by update date (after) + // Optional updatedAfter + test('to test the property `updatedAfter`', () async { + // TODO + }); + + // Filter by update date (before) + // Optional updatedBefore + test('to test the property `updatedBefore`', () async { + // TODO + }); + + // Optional visibility + test('to test the property `visibility`', () async { + // TODO + }); + + // Include deleted assets + // Optional withDeleted + test('to test the property `withDeleted`', () async { + // TODO + }); + + // Include EXIF data in response + // Optional withExif + test('to test the property `withExif`', () async { + // TODO + }); + + // Include people data in response + // Optional withPeople + test('to test the property `withPeople`', () async { + // TODO + }); + + // Include stacked assets + // Optional withStacked + test('to test the property `withStacked`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/ratings_response_test.dart b/mobile/openapi/test/ratings_response_test.dart new file mode 100644 index 0000000000000..840766e02d291 --- /dev/null +++ b/mobile/openapi/test/ratings_response_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RatingsResponse +void main() { + // final instance = RatingsResponse(); + + group('test RatingsResponse', () { + // Whether ratings are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/ratings_update_test.dart b/mobile/openapi/test/ratings_update_test.dart new file mode 100644 index 0000000000000..223faac4599c7 --- /dev/null +++ b/mobile/openapi/test/ratings_update_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RatingsUpdate +void main() { + // final instance = RatingsUpdate(); + + group('test RatingsUpdate', () { + // Whether ratings are enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/reaction_level_test.dart b/mobile/openapi/test/reaction_level_test.dart new file mode 100644 index 0000000000000..aec882c65922e --- /dev/null +++ b/mobile/openapi/test/reaction_level_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ReactionLevel +void main() { + + group('test ReactionLevel', () { + + }); + +} diff --git a/mobile/openapi/test/reaction_type_test.dart b/mobile/openapi/test/reaction_type_test.dart new file mode 100644 index 0000000000000..2adc0a549bf18 --- /dev/null +++ b/mobile/openapi/test/reaction_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ReactionType +void main() { + + group('test ReactionType', () { + + }); + +} diff --git a/mobile/openapi/test/recently_added_response_test.dart b/mobile/openapi/test/recently_added_response_test.dart new file mode 100644 index 0000000000000..f6c00b1360dc9 --- /dev/null +++ b/mobile/openapi/test/recently_added_response_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RecentlyAddedResponse +void main() { + // final instance = RecentlyAddedResponse(); + + group('test RecentlyAddedResponse', () { + // Whether the recently added page appears in the web sidebar + // bool sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/recently_added_update_test.dart b/mobile/openapi/test/recently_added_update_test.dart new file mode 100644 index 0000000000000..9495efeb94558 --- /dev/null +++ b/mobile/openapi/test/recently_added_update_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RecentlyAddedUpdate +void main() { + // final instance = RecentlyAddedUpdate(); + + group('test RecentlyAddedUpdate', () { + // Whether the recently added page appears in the web sidebar + // Optional sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/release_channel_test.dart b/mobile/openapi/test/release_channel_test.dart new file mode 100644 index 0000000000000..aadbb65a24d68 --- /dev/null +++ b/mobile/openapi/test/release_channel_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ReleaseChannel +void main() { + + group('test ReleaseChannel', () { + + }); + +} diff --git a/mobile/openapi/test/release_event_v1_test.dart b/mobile/openapi/test/release_event_v1_test.dart new file mode 100644 index 0000000000000..73597754cc8fc --- /dev/null +++ b/mobile/openapi/test/release_event_v1_test.dart @@ -0,0 +1,49 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ReleaseEventV1 +void main() { + // final instance = ReleaseEventV1(); + + group('test ReleaseEventV1', () { + // When the server last checked for a latest version. As an ISO timestamp + // String checkedAt + test('to test the property `checkedAt`', () async { + // TODO + }); + + // Whether a new version is available + // bool isAvailable + test('to test the property `isAvailable`', () async { + // TODO + }); + + // ServerVersionResponseDto releaseVersion + test('to test the property `releaseVersion`', () async { + // TODO + }); + + // ServerVersionResponseDto serverVersion + test('to test the property `serverVersion`', () async { + // TODO + }); + + // ReleaseType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/release_type_test.dart b/mobile/openapi/test/release_type_test.dart new file mode 100644 index 0000000000000..62b2f07576283 --- /dev/null +++ b/mobile/openapi/test/release_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ReleaseType +void main() { + + group('test ReleaseType', () { + + }); + +} diff --git a/mobile/openapi/test/repository_api_test.dart b/mobile/openapi/test/repository_api_test.dart new file mode 100644 index 0000000000000..842a876bd7d2b --- /dev/null +++ b/mobile/openapi/test/repository_api_test.dart @@ -0,0 +1,101 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for RepositoryApi +void main() { + // final instance = RepositoryApi(); + + group('tests for RepositoryApi', () { + //Future checkImportRepository(String backend, String id) async + test('test checkImportRepository', () async { + // TODO + }); + + //Future createBackup(String id) async + test('test createBackup', () async { + // TODO + }); + + //Future createRepository(RepositoryCreateRequestDto repositoryCreateRequestDto, { String backend }) async + test('test createRepository', () async { + // TODO + }); + + //Future deleteRepository(String id) async + test('test deleteRepository', () async { + // TODO + }); + + //Future forgetSnapshot(String id, String snapshot) async + test('test forgetSnapshot', () async { + // TODO + }); + + //Future getRepositories() async + test('test getRepositories', () async { + // TODO + }); + + //Future getRunHistory(String id) async + test('test getRunHistory', () async { + // TODO + }); + + //Future getSnapshotListing(String id, String snapshot, { String path }) async + test('test getSnapshotListing', () async { + // TODO + }); + + //Future getSnapshots(String id) async + test('test getSnapshots', () async { + // TODO + }); + + //Future importRepository(String backend, String id) async + test('test importRepository', () async { + // TODO + }); + + //Future inspectRepositories({ String backend }) async + test('test inspectRepositories', () async { + // TODO + }); + + //Future pruneRepository(String id) async + test('test pruneRepository', () async { + // TODO + }); + + //Future reconfigureRepositoryPrimaryBackend(String id, RepositoryPrimaryBackendReconfigureRequestDto repositoryPrimaryBackendReconfigureRequestDto) async + test('test reconfigureRepositoryPrimaryBackend', () async { + // TODO + }); + + //Future restoreFromPoint(String backend, String id, String snapshot, RepositorySnapshotRestoreFromPointRequestDto repositorySnapshotRestoreFromPointRequestDto) async + test('test restoreFromPoint', () async { + // TODO + }); + + //Future restoreSnapshot(String id, String snapshot, RepositorySnapshotRestoreRequestDto repositorySnapshotRestoreRequestDto) async + test('test restoreSnapshot', () async { + // TODO + }); + + //Future updateRepository(String id, RepositoryUpdateRequestDto repositoryUpdateRequestDto, { String backend }) async + test('test updateRepository', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/repository_backend_dto_test.dart b/mobile/openapi/test/repository_backend_dto_test.dart new file mode 100644 index 0000000000000..9e36fc8730e26 --- /dev/null +++ b/mobile/openapi/test/repository_backend_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryBackendDto +void main() { + // final instance = RepositoryBackendDto(); + + group('test RepositoryBackendDto', () { + // String id + test('to test the property `id`', () async { + // TODO + }); + + // bool online + test('to test the property `online`', () async { + // TODO + }); + + // BackendType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_backends_dto_test.dart b/mobile/openapi/test/repository_backends_dto_test.dart new file mode 100644 index 0000000000000..68c78d0fa5d56 --- /dev/null +++ b/mobile/openapi/test/repository_backends_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryBackendsDto +void main() { + // final instance = RepositoryBackendsDto(); + + group('test RepositoryBackendsDto', () { + // RepositoryBackendDto primary + test('to test the property `primary`', () async { + // TODO + }); + + // List secondary (default value: const []) + test('to test the property `secondary`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_check_import_response_dto_test.dart b/mobile/openapi/test/repository_check_import_response_dto_test.dart new file mode 100644 index 0000000000000..c4fa261942055 --- /dev/null +++ b/mobile/openapi/test/repository_check_import_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryCheckImportResponseDto +void main() { + // final instance = RepositoryCheckImportResponseDto(); + + group('test RepositoryCheckImportResponseDto', () { + // bool readable + test('to test the property `readable`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_configuration_dto_test.dart b/mobile/openapi/test/repository_configuration_dto_test.dart new file mode 100644 index 0000000000000..1dce463c7fcca --- /dev/null +++ b/mobile/openapi/test/repository_configuration_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryConfigurationDto +void main() { + // final instance = RepositoryConfigurationDto(); + + group('test RepositoryConfigurationDto', () { + // List paths (default value: const []) + test('to test the property `paths`', () async { + // TODO + }); + + // Optional retentionPolicy + test('to test the property `retentionPolicy`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_create_request_dto_test.dart b/mobile/openapi/test/repository_create_request_dto_test.dart new file mode 100644 index 0000000000000..a576d3680884e --- /dev/null +++ b/mobile/openapi/test/repository_create_request_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryCreateRequestDto +void main() { + // final instance = RepositoryCreateRequestDto(); + + group('test RepositoryCreateRequestDto', () { + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Optional?> paths (default value: const []) + test('to test the property `paths`', () async { + // TODO + }); + + // bool worm + test('to test the property `worm`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_create_response_dto_test.dart b/mobile/openapi/test/repository_create_response_dto_test.dart new file mode 100644 index 0000000000000..38ed977e56413 --- /dev/null +++ b/mobile/openapi/test/repository_create_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryCreateResponseDto +void main() { + // final instance = RepositoryCreateResponseDto(); + + group('test RepositoryCreateResponseDto', () { + // LocalRepositoryDto repository + test('to test the property `repository`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_inspect_response_dto_test.dart b/mobile/openapi/test/repository_inspect_response_dto_test.dart new file mode 100644 index 0000000000000..512d1e31869ec --- /dev/null +++ b/mobile/openapi/test/repository_inspect_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryInspectResponseDto +void main() { + // final instance = RepositoryInspectResponseDto(); + + group('test RepositoryInspectResponseDto', () { + // List repositories (default value: const []) + test('to test the property `repositories`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_list_response_dto_test.dart b/mobile/openapi/test/repository_list_response_dto_test.dart new file mode 100644 index 0000000000000..04bdd801929a9 --- /dev/null +++ b/mobile/openapi/test/repository_list_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryListResponseDto +void main() { + // final instance = RepositoryListResponseDto(); + + group('test RepositoryListResponseDto', () { + // List repositories (default value: const []) + test('to test the property `repositories`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_meter_dto_test.dart b/mobile/openapi/test/repository_meter_dto_test.dart new file mode 100644 index 0000000000000..dec742d3d6f7a --- /dev/null +++ b/mobile/openapi/test/repository_meter_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryMeterDto +void main() { + // final instance = RepositoryMeterDto(); + + group('test RepositoryMeterDto', () { + // Optional lastUpdated + test('to test the property `lastUpdated`', () async { + // TODO + }); + + // num objectCount + test('to test the property `objectCount`', () async { + // TODO + }); + + // num sizeBytes + test('to test the property `sizeBytes`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_metrics_dto_test.dart b/mobile/openapi/test/repository_metrics_dto_test.dart new file mode 100644 index 0000000000000..b29b88de19da2 --- /dev/null +++ b/mobile/openapi/test/repository_metrics_dto_test.dart @@ -0,0 +1,42 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryMetricsDto +void main() { + // final instance = RepositoryMetricsDto(); + + group('test RepositoryMetricsDto', () { + // Optional lastBackup + test('to test the property `lastBackup`', () async { + // TODO + }); + + // Optional lastBackupDuration + test('to test the property `lastBackupDuration`', () async { + // TODO + }); + + // Optional lastSuccessfulBackup + test('to test the property `lastSuccessfulBackup`', () async { + // TODO + }); + + // num sizeBytes + test('to test the property `sizeBytes`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_primary_backend_reconfigure_request_dto_test.dart b/mobile/openapi/test/repository_primary_backend_reconfigure_request_dto_test.dart new file mode 100644 index 0000000000000..2cd4fd8e4002a --- /dev/null +++ b/mobile/openapi/test/repository_primary_backend_reconfigure_request_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryPrimaryBackendReconfigureRequestDto +void main() { + // final instance = RepositoryPrimaryBackendReconfigureRequestDto(); + + group('test RepositoryPrimaryBackendReconfigureRequestDto', () { + // String backendId + test('to test the property `backendId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_snapshot_restore_from_point_request_dto_test.dart b/mobile/openapi/test/repository_snapshot_restore_from_point_request_dto_test.dart new file mode 100644 index 0000000000000..f12acef3729ff --- /dev/null +++ b/mobile/openapi/test/repository_snapshot_restore_from_point_request_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositorySnapshotRestoreFromPointRequestDto +void main() { + // final instance = RepositorySnapshotRestoreFromPointRequestDto(); + + group('test RepositorySnapshotRestoreFromPointRequestDto', () { + // Optional?> include (default value: const []) + test('to test the property `include`', () async { + // TODO + }); + + // Optional yuccaConfig + test('to test the property `yuccaConfig`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_snapshot_restore_request_dto_test.dart b/mobile/openapi/test/repository_snapshot_restore_request_dto_test.dart new file mode 100644 index 0000000000000..6562887766b15 --- /dev/null +++ b/mobile/openapi/test/repository_snapshot_restore_request_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositorySnapshotRestoreRequestDto +void main() { + // final instance = RepositorySnapshotRestoreRequestDto(); + + group('test RepositorySnapshotRestoreRequestDto', () { + // Optional?> include (default value: const []) + test('to test the property `include`', () async { + // TODO + }); + + // Optional target + test('to test the property `target`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_update_request_dto_test.dart b/mobile/openapi/test/repository_update_request_dto_test.dart new file mode 100644 index 0000000000000..9cb449eb89f43 --- /dev/null +++ b/mobile/openapi/test/repository_update_request_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryUpdateRequestDto +void main() { + // final instance = RepositoryUpdateRequestDto(); + + group('test RepositoryUpdateRequestDto', () { + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // Optional?> paths (default value: const []) + test('to test the property `paths`', () async { + // TODO + }); + + // Optional retentionPolicy + test('to test the property `retentionPolicy`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/repository_update_response_dto_test.dart b/mobile/openapi/test/repository_update_response_dto_test.dart new file mode 100644 index 0000000000000..257f993a358da --- /dev/null +++ b/mobile/openapi/test/repository_update_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RepositoryUpdateResponseDto +void main() { + // final instance = RepositoryUpdateResponseDto(); + + group('test RepositoryUpdateResponseDto', () { + // LocalRepositoryDto repository + test('to test the property `repository`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/retention_policy_dto_test.dart b/mobile/openapi/test/retention_policy_dto_test.dart new file mode 100644 index 0000000000000..dd7cdfe57f512 --- /dev/null +++ b/mobile/openapi/test/retention_policy_dto_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RetentionPolicyDto +void main() { + // final instance = RetentionPolicyDto(); + + group('test RetentionPolicyDto', () { + // Optional keepLast + test('to test the property `keepLast`', () async { + // TODO + }); + + // Optional keepWithin + test('to test the property `keepWithin`', () async { + // TODO + }); + + // Optional keepWithinDaily + test('to test the property `keepWithinDaily`', () async { + // TODO + }); + + // Optional keepWithinHourly + test('to test the property `keepWithinHourly`', () async { + // TODO + }); + + // Optional keepWithinMonthly + test('to test the property `keepWithinMonthly`', () async { + // TODO + }); + + // Optional keepWithinWeekly + test('to test the property `keepWithinWeekly`', () async { + // TODO + }); + + // Optional keepWithinYearly + test('to test the property `keepWithinYearly`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/reverse_geocoding_state_response_dto_test.dart b/mobile/openapi/test/reverse_geocoding_state_response_dto_test.dart new file mode 100644 index 0000000000000..06ecafd4d5f2f --- /dev/null +++ b/mobile/openapi/test/reverse_geocoding_state_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ReverseGeocodingStateResponseDto +void main() { + // final instance = ReverseGeocodingStateResponseDto(); + + group('test ReverseGeocodingStateResponseDto', () { + // Last import file name + // String lastImportFileName + test('to test the property `lastImportFileName`', () async { + // TODO + }); + + // Last update timestamp + // String lastUpdate + test('to test the property `lastUpdate`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/rotate_parameters_test.dart b/mobile/openapi/test/rotate_parameters_test.dart new file mode 100644 index 0000000000000..45c88c75878ab --- /dev/null +++ b/mobile/openapi/test/rotate_parameters_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RotateParameters +void main() { + // final instance = RotateParameters(); + + group('test RotateParameters', () { + // Rotation angle in degrees + // num angle + test('to test the property `angle`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/run_dto_test.dart b/mobile/openapi/test/run_dto_test.dart new file mode 100644 index 0000000000000..1406afe835d44 --- /dev/null +++ b/mobile/openapi/test/run_dto_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RunDto +void main() { + // final instance = RunDto(); + + group('test RunDto', () { + // String end + test('to test the property `end`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // String logFilePath + test('to test the property `logFilePath`', () async { + // TODO + }); + + // String repositoryId + test('to test the property `repositoryId`', () async { + // TODO + }); + + // String start + test('to test the property `start`', () async { + // TODO + }); + + // RunStatus status + test('to test the property `status`', () async { + // TODO + }); + + // RunType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/run_history_api_test.dart b/mobile/openapi/test/run_history_api_test.dart new file mode 100644 index 0000000000000..b403dda39e0d5 --- /dev/null +++ b/mobile/openapi/test/run_history_api_test.dart @@ -0,0 +1,31 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for RunHistoryApi +void main() { + // final instance = RunHistoryApi(); + + group('tests for RunHistoryApi', () { + //Future getRun(String id) async + test('test getRun', () async { + // TODO + }); + + //Future logStreamSse(String id) async + test('test logStreamSse', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/run_history_response_dto_test.dart b/mobile/openapi/test/run_history_response_dto_test.dart new file mode 100644 index 0000000000000..87fca668cdb56 --- /dev/null +++ b/mobile/openapi/test/run_history_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RunHistoryResponseDto +void main() { + // final instance = RunHistoryResponseDto(); + + group('test RunHistoryResponseDto', () { + // List runs (default value: const []) + test('to test the property `runs`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/run_response_dto_test.dart b/mobile/openapi/test/run_response_dto_test.dart new file mode 100644 index 0000000000000..81f629e327767 --- /dev/null +++ b/mobile/openapi/test/run_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RunResponseDto +void main() { + // final instance = RunResponseDto(); + + group('test RunResponseDto', () { + // RunDto run + test('to test the property `run`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/run_status_test.dart b/mobile/openapi/test/run_status_test.dart new file mode 100644 index 0000000000000..666283eccd097 --- /dev/null +++ b/mobile/openapi/test/run_status_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RunStatus +void main() { + + group('test RunStatus', () { + + }); + +} diff --git a/mobile/openapi/test/run_type_test.dart b/mobile/openapi/test/run_type_test.dart new file mode 100644 index 0000000000000..0973cf11f2c4d --- /dev/null +++ b/mobile/openapi/test/run_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RunType +void main() { + + group('test RunType', () { + + }); + +} diff --git a/mobile/openapi/test/running_task_dto_test.dart b/mobile/openapi/test/running_task_dto_test.dart new file mode 100644 index 0000000000000..9bc9c5bebf109 --- /dev/null +++ b/mobile/openapi/test/running_task_dto_test.dart @@ -0,0 +1,42 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RunningTaskDto +void main() { + // final instance = RunningTaskDto(); + + group('test RunningTaskDto', () { + // Optional logId + test('to test the property `logId`', () async { + // TODO + }); + + // String parentId + test('to test the property `parentId`', () async { + // TODO + }); + + // Optional?> scheduleStatus (default value: const []) + test('to test the property `scheduleStatus`', () async { + // TODO + }); + + // TaskType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/running_task_list_response_test.dart b/mobile/openapi/test/running_task_list_response_test.dart new file mode 100644 index 0000000000000..0a6406b8d322e --- /dev/null +++ b/mobile/openapi/test/running_task_list_response_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for RunningTaskListResponse +void main() { + // final instance = RunningTaskListResponse(); + + group('test RunningTaskListResponse', () { + // List tasks (default value: const []) + test('to test the property `tasks`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/running_tasks_api_test.dart b/mobile/openapi/test/running_tasks_api_test.dart new file mode 100644 index 0000000000000..d8b1ca0f8e29f --- /dev/null +++ b/mobile/openapi/test/running_tasks_api_test.dart @@ -0,0 +1,31 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for RunningTasksApi +void main() { + // final instance = RunningTasksApi(); + + group('tests for RunningTasksApi', () { + //Future cancelTask(String parentId) async + test('test cancelTask', () async { + // TODO + }); + + //Future getRunningTasks() async + test('test getRunningTasks', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/schedule_api_test.dart b/mobile/openapi/test/schedule_api_test.dart new file mode 100644 index 0000000000000..f588d54f7be18 --- /dev/null +++ b/mobile/openapi/test/schedule_api_test.dart @@ -0,0 +1,41 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for ScheduleApi +void main() { + // final instance = ScheduleApi(); + + group('tests for ScheduleApi', () { + //Future createSchedule(ScheduleCreateRequestDto scheduleCreateRequestDto) async + test('test createSchedule', () async { + // TODO + }); + + //Future getSchedules() async + test('test getSchedules', () async { + // TODO + }); + + //Future removeSchedule(String id) async + test('test removeSchedule', () async { + // TODO + }); + + //Future updateSchedule(String id, ScheduleUpdateRequestDto scheduleUpdateRequestDto) async + test('test updateSchedule', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/schedule_create_request_dto_test.dart b/mobile/openapi/test/schedule_create_request_dto_test.dart new file mode 100644 index 0000000000000..111381dada707 --- /dev/null +++ b/mobile/openapi/test/schedule_create_request_dto_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ScheduleCreateRequestDto +void main() { + // final instance = ScheduleCreateRequestDto(); + + group('test ScheduleCreateRequestDto', () { + // String cron + test('to test the property `cron`', () async { + // TODO + }); + + // String name + test('to test the property `name`', () async { + // TODO + }); + + // List repositories (default value: const []) + test('to test the property `repositories`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/schedule_create_response_dto_test.dart b/mobile/openapi/test/schedule_create_response_dto_test.dart new file mode 100644 index 0000000000000..60ca038de1d00 --- /dev/null +++ b/mobile/openapi/test/schedule_create_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ScheduleCreateResponseDto +void main() { + // final instance = ScheduleCreateResponseDto(); + + group('test ScheduleCreateResponseDto', () { + // ScheduleDto schedule + test('to test the property `schedule`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/schedule_dto_test.dart b/mobile/openapi/test/schedule_dto_test.dart new file mode 100644 index 0000000000000..285bd1b5ab85a --- /dev/null +++ b/mobile/openapi/test/schedule_dto_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ScheduleDto +void main() { + // final instance = ScheduleDto(); + + group('test ScheduleDto', () { + // String cron + test('to test the property `cron`', () async { + // TODO + }); + + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Optional lastFinished + test('to test the property `lastFinished`', () async { + // TODO + }); + + // Optional lastRun + test('to test the property `lastRun`', () async { + // TODO + }); + + // String name + test('to test the property `name`', () async { + // TODO + }); + + // bool paused + test('to test the property `paused`', () async { + // TODO + }); + + // List repositories (default value: const []) + test('to test the property `repositories`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/schedule_list_response_dto_test.dart b/mobile/openapi/test/schedule_list_response_dto_test.dart new file mode 100644 index 0000000000000..f65d1ccbd9938 --- /dev/null +++ b/mobile/openapi/test/schedule_list_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ScheduleListResponseDto +void main() { + // final instance = ScheduleListResponseDto(); + + group('test ScheduleListResponseDto', () { + // List schedules (default value: const []) + test('to test the property `schedules`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/schedule_update_request_dto_test.dart b/mobile/openapi/test/schedule_update_request_dto_test.dart new file mode 100644 index 0000000000000..0c0900dff7f66 --- /dev/null +++ b/mobile/openapi/test/schedule_update_request_dto_test.dart @@ -0,0 +1,42 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ScheduleUpdateRequestDto +void main() { + // final instance = ScheduleUpdateRequestDto(); + + group('test ScheduleUpdateRequestDto', () { + // Optional cron + test('to test the property `cron`', () async { + // TODO + }); + + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // Optional paused + test('to test the property `paused`', () async { + // TODO + }); + + // Optional?> repositories (default value: const []) + test('to test the property `repositories`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/schedule_update_response_dto_test.dart b/mobile/openapi/test/schedule_update_response_dto_test.dart new file mode 100644 index 0000000000000..5c512b3344a85 --- /dev/null +++ b/mobile/openapi/test/schedule_update_response_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ScheduleUpdateResponseDto +void main() { + // final instance = ScheduleUpdateResponseDto(); + + group('test ScheduleUpdateResponseDto', () { + // ScheduleDto schedule + test('to test the property `schedule`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_album_response_dto_test.dart b/mobile/openapi/test/search_album_response_dto_test.dart new file mode 100644 index 0000000000000..79d7b4c122799 --- /dev/null +++ b/mobile/openapi/test/search_album_response_dto_test.dart @@ -0,0 +1,44 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchAlbumResponseDto +void main() { + // final instance = SearchAlbumResponseDto(); + + group('test SearchAlbumResponseDto', () { + // Number of albums in this page + // int count + test('to test the property `count`', () async { + // TODO + }); + + // List facets (default value: const []) + test('to test the property `facets`', () async { + // TODO + }); + + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + // Total number of matching albums + // int total + test('to test the property `total`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_api_test.dart b/mobile/openapi/test/search_api_test.dart new file mode 100644 index 0000000000000..f0cc01ca3cfce --- /dev/null +++ b/mobile/openapi/test/search_api_test.dart @@ -0,0 +1,111 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for SearchApi +void main() { + // final instance = SearchApi(); + + group('tests for SearchApi', () { + // Retrieve assets by city + // + // Retrieve a list of assets with each asset belonging to a different city. This endpoint is used on the places pages to show a single thumbnail for each city the user has assets in. + // + //Future> getAssetsByCity() async + test('test getAssetsByCity', () async { + // TODO + }); + + // Retrieve explore data + // + // Retrieve data for the explore section, such as popular people and places. + // + //Future> getExploreData() async + test('test getExploreData', () async { + // TODO + }); + + // Retrieve search suggestions + // + // Retrieve search suggestions based on partial input. This endpoint is used for typeahead search features. + // + //Future> getSearchSuggestions(SearchSuggestionType type, { String country, bool includeNull, String lensModel, String make, String model, String state }) async + test('test getSearchSuggestions', () async { + // TODO + }); + + // Search asset statistics + // + // Retrieve statistical data about assets based on search criteria, such as the total matching count. + // + //Future searchAssetStatistics(StatisticsSearchDto statisticsSearchDto) async + test('test searchAssetStatistics', () async { + // TODO + }); + + // Search assets by metadata + // + // Search for assets based on various metadata criteria. + // + //Future searchAssets(MetadataSearchDto metadataSearchDto, { String key, String slug }) async + test('test searchAssets', () async { + // TODO + }); + + // Search large assets + // + // Search for assets that are considered large based on specified criteria. + // + //Future> searchLargeAssets({ List albumIds, String city, String country, DateTime createdAfter, DateTime createdBefore, bool isEncoded, bool isFavorite, bool isMotion, bool isNotInAlbum, bool isOffline, String lensModel, String libraryId, String make, int minFileSize, String model, String ocr, List personIds, int rating, int size, String state, List tagIds, DateTime takenAfter, DateTime takenBefore, DateTime trashedAfter, DateTime trashedBefore, AssetTypeEnum type, DateTime updatedAfter, DateTime updatedBefore, AssetVisibility visibility, bool withDeleted, bool withExif }) async + test('test searchLargeAssets', () async { + // TODO + }); + + // Search people + // + // Search for people by name. + // + //Future> searchPerson(String name, { bool withHidden }) async + test('test searchPerson', () async { + // TODO + }); + + // Search places + // + // Search for places by name. + // + //Future> searchPlaces(String name) async + test('test searchPlaces', () async { + // TODO + }); + + // Search random assets + // + // Retrieve a random selection of assets based on the provided criteria. + // + //Future> searchRandom(RandomSearchDto randomSearchDto) async + test('test searchRandom', () async { + // TODO + }); + + // Smart asset search + // + // Perform a smart search for assets by using machine learning vectors to determine relevance. + // + //Future searchSmart(SmartSearchDto smartSearchDto) async + test('test searchSmart', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/search_asset_response_dto_test.dart b/mobile/openapi/test/search_asset_response_dto_test.dart new file mode 100644 index 0000000000000..f09f7afb64bb0 --- /dev/null +++ b/mobile/openapi/test/search_asset_response_dto_test.dart @@ -0,0 +1,50 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchAssetResponseDto +void main() { + // final instance = SearchAssetResponseDto(); + + group('test SearchAssetResponseDto', () { + // Number of assets in this page + // int count + test('to test the property `count`', () async { + // TODO + }); + + // List facets (default value: const []) + test('to test the property `facets`', () async { + // TODO + }); + + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + // Next page token + // String nextPage + test('to test the property `nextPage`', () async { + // TODO + }); + + // Total number of matching assets + // int total + test('to test the property `total`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_explore_item_test.dart b/mobile/openapi/test/search_explore_item_test.dart new file mode 100644 index 0000000000000..642545ce4c9da --- /dev/null +++ b/mobile/openapi/test/search_explore_item_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchExploreItem +void main() { + // final instance = SearchExploreItem(); + + group('test SearchExploreItem', () { + // AssetResponseDto data + test('to test the property `data`', () async { + // TODO + }); + + // Explore value + // String value + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_explore_response_dto_test.dart b/mobile/openapi/test/search_explore_response_dto_test.dart new file mode 100644 index 0000000000000..46ced0e6a5621 --- /dev/null +++ b/mobile/openapi/test/search_explore_response_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchExploreResponseDto +void main() { + // final instance = SearchExploreResponseDto(); + + group('test SearchExploreResponseDto', () { + // Explore field name + // String fieldName + test('to test the property `fieldName`', () async { + // TODO + }); + + // List items (default value: const []) + test('to test the property `items`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_facet_count_response_dto_test.dart b/mobile/openapi/test/search_facet_count_response_dto_test.dart new file mode 100644 index 0000000000000..08fce00d6b8f2 --- /dev/null +++ b/mobile/openapi/test/search_facet_count_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchFacetCountResponseDto +void main() { + // final instance = SearchFacetCountResponseDto(); + + group('test SearchFacetCountResponseDto', () { + // Number of assets with this facet value + // int count + test('to test the property `count`', () async { + // TODO + }); + + // Facet value + // String value + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_facet_response_dto_test.dart b/mobile/openapi/test/search_facet_response_dto_test.dart new file mode 100644 index 0000000000000..2ab1502809c13 --- /dev/null +++ b/mobile/openapi/test/search_facet_response_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchFacetResponseDto +void main() { + // final instance = SearchFacetResponseDto(); + + group('test SearchFacetResponseDto', () { + // List counts (default value: const []) + test('to test the property `counts`', () async { + // TODO + }); + + // Facet field name + // String fieldName + test('to test the property `fieldName`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_response_dto_test.dart b/mobile/openapi/test/search_response_dto_test.dart new file mode 100644 index 0000000000000..e2ba5e73595fe --- /dev/null +++ b/mobile/openapi/test/search_response_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchResponseDto +void main() { + // final instance = SearchResponseDto(); + + group('test SearchResponseDto', () { + // SearchAlbumResponseDto albums + test('to test the property `albums`', () async { + // TODO + }); + + // SearchAssetResponseDto assets + test('to test the property `assets`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_statistics_response_dto_test.dart b/mobile/openapi/test/search_statistics_response_dto_test.dart new file mode 100644 index 0000000000000..ea8407b108912 --- /dev/null +++ b/mobile/openapi/test/search_statistics_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchStatisticsResponseDto +void main() { + // final instance = SearchStatisticsResponseDto(); + + group('test SearchStatisticsResponseDto', () { + // Total number of matching assets + // int total + test('to test the property `total`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/search_suggestion_type_test.dart b/mobile/openapi/test/search_suggestion_type_test.dart new file mode 100644 index 0000000000000..8f46ca13cfb5b --- /dev/null +++ b/mobile/openapi/test/search_suggestion_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SearchSuggestionType +void main() { + + group('test SearchSuggestionType', () { + + }); + +} diff --git a/mobile/openapi/test/server_about_response_dto_test.dart b/mobile/openapi/test/server_about_response_dto_test.dart new file mode 100644 index 0000000000000..cc168bbf6025c --- /dev/null +++ b/mobile/openapi/test/server_about_response_dto_test.dart @@ -0,0 +1,148 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerAboutResponseDto +void main() { + // final instance = ServerAboutResponseDto(); + + group('test ServerAboutResponseDto', () { + // Build identifier + // Optional build + test('to test the property `build`', () async { + // TODO + }); + + // Build image name + // Optional buildImage + test('to test the property `buildImage`', () async { + // TODO + }); + + // Build image URL + // Optional buildImageUrl + test('to test the property `buildImageUrl`', () async { + // TODO + }); + + // Build URL + // Optional buildUrl + test('to test the property `buildUrl`', () async { + // TODO + }); + + // ExifTool version + // Optional exiftool + test('to test the property `exiftool`', () async { + // TODO + }); + + // FFmpeg version + // Optional ffmpeg + test('to test the property `ffmpeg`', () async { + // TODO + }); + + // ImageMagick version + // Optional imagemagick + test('to test the property `imagemagick`', () async { + // TODO + }); + + // libvips version + // Optional libvips + test('to test the property `libvips`', () async { + // TODO + }); + + // Whether the server is licensed + // bool licensed + test('to test the property `licensed`', () async { + // TODO + }); + + // Node.js version + // Optional nodejs + test('to test the property `nodejs`', () async { + // TODO + }); + + // Repository name + // Optional repository + test('to test the property `repository`', () async { + // TODO + }); + + // Repository URL + // Optional repositoryUrl + test('to test the property `repositoryUrl`', () async { + // TODO + }); + + // Source commit hash + // Optional sourceCommit + test('to test the property `sourceCommit`', () async { + // TODO + }); + + // Source reference (branch/tag) + // Optional sourceRef + test('to test the property `sourceRef`', () async { + // TODO + }); + + // Source URL + // Optional sourceUrl + test('to test the property `sourceUrl`', () async { + // TODO + }); + + // Third-party bug/feature URL + // Optional thirdPartyBugFeatureUrl + test('to test the property `thirdPartyBugFeatureUrl`', () async { + // TODO + }); + + // Third-party documentation URL + // Optional thirdPartyDocumentationUrl + test('to test the property `thirdPartyDocumentationUrl`', () async { + // TODO + }); + + // Third-party source URL + // Optional thirdPartySourceUrl + test('to test the property `thirdPartySourceUrl`', () async { + // TODO + }); + + // Third-party support URL + // Optional thirdPartySupportUrl + test('to test the property `thirdPartySupportUrl`', () async { + // TODO + }); + + // Server version + // String version + test('to test the property `version`', () async { + // TODO + }); + + // URL to version information + // String versionUrl + test('to test the property `versionUrl`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_api_test.dart b/mobile/openapi/test/server_api_test.dart new file mode 100644 index 0000000000000..1f81edd12f8ce --- /dev/null +++ b/mobile/openapi/test/server_api_test.dart @@ -0,0 +1,147 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for ServerApi +void main() { + // final instance = ServerApi(); + + group('tests for ServerApi', () { + // Delete server product key + // + // Delete the currently set server product key. + // + //Future deleteServerLicense() async + test('test deleteServerLicense', () async { + // TODO + }); + + // Get server information + // + // Retrieve a list of information about the server. + // + //Future getAboutInfo() async + test('test getAboutInfo', () async { + // TODO + }); + + // Get APK links + // + // Retrieve links to the APKs for the current server version. + // + //Future getApkLinks() async + test('test getApkLinks', () async { + // TODO + }); + + // Get config + // + // Retrieve the current server configuration. + // + //Future getServerConfig() async + test('test getServerConfig', () async { + // TODO + }); + + // Get features + // + // Retrieve available features supported by this server. + // + //Future getServerFeatures() async + test('test getServerFeatures', () async { + // TODO + }); + + // Get product key + // + // Retrieve information about whether the server currently has a product key registered. + // + //Future getServerLicense() async + test('test getServerLicense', () async { + // TODO + }); + + // Get statistics + // + // Retrieve statistics about the entire Immich instance such as asset counts. + // + //Future getServerStatistics() async + test('test getServerStatistics', () async { + // TODO + }); + + // Get server version + // + // Retrieve the current server version in semantic versioning (semver) format. + // + //Future getServerVersion() async + test('test getServerVersion', () async { + // TODO + }); + + // Get storage + // + // Retrieve the current storage utilization information of the server. + // + //Future getStorage() async + test('test getStorage', () async { + // TODO + }); + + // Get supported media types + // + // Retrieve all media types supported by the server. + // + //Future getSupportedMediaTypes() async + test('test getSupportedMediaTypes', () async { + // TODO + }); + + // Get version check status + // + // Retrieve information about the last time the version check ran. + // + //Future getVersionCheck() async + test('test getVersionCheck', () async { + // TODO + }); + + // Get version history + // + // Retrieve a list of past versions the server has been on. + // + //Future> getVersionHistory() async + test('test getVersionHistory', () async { + // TODO + }); + + // Ping + // + // Pong + // + //Future pingServer() async + test('test pingServer', () async { + // TODO + }); + + // Set server product key + // + // Validate and set the server product key if successful. + // + //Future setServerLicense(LicenseKeyDto licenseKeyDto) async + test('test setServerLicense', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/server_apk_links_dto_test.dart b/mobile/openapi/test/server_apk_links_dto_test.dart new file mode 100644 index 0000000000000..a847eedf2003b --- /dev/null +++ b/mobile/openapi/test/server_apk_links_dto_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerApkLinksDto +void main() { + // final instance = ServerApkLinksDto(); + + group('test ServerApkLinksDto', () { + // APK download link for ARM64 v8a architecture + // String arm64v8a + test('to test the property `arm64v8a`', () async { + // TODO + }); + + // APK download link for ARM EABI v7a architecture + // String armeabiv7a + test('to test the property `armeabiv7a`', () async { + // TODO + }); + + // APK download link for universal architecture + // String universal + test('to test the property `universal`', () async { + // TODO + }); + + // APK download link for x86_64 architecture + // String x8664 + test('to test the property `x8664`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_config_dto_test.dart b/mobile/openapi/test/server_config_dto_test.dart new file mode 100644 index 0000000000000..e1bccf55f5495 --- /dev/null +++ b/mobile/openapi/test/server_config_dto_test.dart @@ -0,0 +1,94 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerConfigDto +void main() { + // final instance = ServerConfigDto(); + + group('test ServerConfigDto', () { + // External domain URL + // String externalDomain + test('to test the property `externalDomain`', () async { + // TODO + }); + + // Whether the server has been initialized + // bool isInitialized + test('to test the property `isInitialized`', () async { + // TODO + }); + + // Whether the admin has completed onboarding + // bool isOnboarded + test('to test the property `isOnboarded`', () async { + // TODO + }); + + // Login page message + // String loginPageMessage + test('to test the property `loginPageMessage`', () async { + // TODO + }); + + // Whether maintenance mode is active + // bool maintenanceMode + test('to test the property `maintenanceMode`', () async { + // TODO + }); + + // Map dark style URL + // String mapDarkStyleUrl + test('to test the property `mapDarkStyleUrl`', () async { + // TODO + }); + + // Map light style URL + // String mapLightStyleUrl + test('to test the property `mapLightStyleUrl`', () async { + // TODO + }); + + // People min faces server default + // int minFaces + test('to test the property `minFaces`', () async { + // TODO + }); + + // OAuth button text + // String oauthButtonText + test('to test the property `oauthButtonText`', () async { + // TODO + }); + + // Whether public user registration is enabled + // bool publicUsers + test('to test the property `publicUsers`', () async { + // TODO + }); + + // Number of days before trashed assets are permanently deleted + // int trashDays + test('to test the property `trashDays`', () async { + // TODO + }); + + // Delay in days before deleted users are permanently removed + // int userDeleteDelay + test('to test the property `userDeleteDelay`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_features_dto_test.dart b/mobile/openapi/test/server_features_dto_test.dart new file mode 100644 index 0000000000000..2f70676c28bae --- /dev/null +++ b/mobile/openapi/test/server_features_dto_test.dart @@ -0,0 +1,124 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerFeaturesDto +void main() { + // final instance = ServerFeaturesDto(); + + group('test ServerFeaturesDto', () { + // Whether the backups feature is enabled + // bool backups + test('to test the property `backups`', () async { + // TODO + }); + + // Whether config file is available + // bool configFile + test('to test the property `configFile`', () async { + // TODO + }); + + // Whether duplicate detection is enabled + // bool duplicateDetection + test('to test the property `duplicateDetection`', () async { + // TODO + }); + + // Whether email notifications are enabled + // bool email + test('to test the property `email`', () async { + // TODO + }); + + // Whether facial recognition is enabled + // bool facialRecognition + test('to test the property `facialRecognition`', () async { + // TODO + }); + + // Whether face import is enabled + // bool importFaces + test('to test the property `importFaces`', () async { + // TODO + }); + + // Whether map feature is enabled + // bool map + test('to test the property `map`', () async { + // TODO + }); + + // Whether OAuth is enabled + // bool oauth + test('to test the property `oauth`', () async { + // TODO + }); + + // Whether OAuth auto-launch is enabled + // bool oauthAutoLaunch + test('to test the property `oauthAutoLaunch`', () async { + // TODO + }); + + // Whether OCR is enabled + // bool ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // Whether password login is enabled + // bool passwordLogin + test('to test the property `passwordLogin`', () async { + // TODO + }); + + // Whether real-time transcoding is enabled + // bool realtimeTranscoding + test('to test the property `realtimeTranscoding`', () async { + // TODO + }); + + // Whether reverse geocoding is enabled + // bool reverseGeocoding + test('to test the property `reverseGeocoding`', () async { + // TODO + }); + + // Whether search is enabled + // bool search + test('to test the property `search`', () async { + // TODO + }); + + // Whether sidecar files are supported + // bool sidecar + test('to test the property `sidecar`', () async { + // TODO + }); + + // Whether smart search is enabled + // bool smartSearch + test('to test the property `smartSearch`', () async { + // TODO + }); + + // Whether trash feature is enabled + // bool trash + test('to test the property `trash`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_media_types_response_dto_test.dart b/mobile/openapi/test/server_media_types_response_dto_test.dart new file mode 100644 index 0000000000000..632dd405dd88c --- /dev/null +++ b/mobile/openapi/test/server_media_types_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerMediaTypesResponseDto +void main() { + // final instance = ServerMediaTypesResponseDto(); + + group('test ServerMediaTypesResponseDto', () { + // Supported image MIME types + // List image (default value: const []) + test('to test the property `image`', () async { + // TODO + }); + + // Supported sidecar MIME types + // List sidecar (default value: const []) + test('to test the property `sidecar`', () async { + // TODO + }); + + // Supported video MIME types + // List video (default value: const []) + test('to test the property `video`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_ping_response_test.dart b/mobile/openapi/test/server_ping_response_test.dart new file mode 100644 index 0000000000000..dc76005d01040 --- /dev/null +++ b/mobile/openapi/test/server_ping_response_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerPingResponse +void main() { + // final instance = ServerPingResponse(); + + group('test ServerPingResponse', () { + // String res + test('to test the property `res`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_stats_response_dto_test.dart b/mobile/openapi/test/server_stats_response_dto_test.dart new file mode 100644 index 0000000000000..26bb585d6eb3d --- /dev/null +++ b/mobile/openapi/test/server_stats_response_dto_test.dart @@ -0,0 +1,58 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerStatsResponseDto +void main() { + // final instance = ServerStatsResponseDto(); + + group('test ServerStatsResponseDto', () { + // Total number of photos + // int photos + test('to test the property `photos`', () async { + // TODO + }); + + // Total storage usage in bytes + // int usage + test('to test the property `usage`', () async { + // TODO + }); + + // Array of usage for each user + // List usageByUser (default value: const []) + test('to test the property `usageByUser`', () async { + // TODO + }); + + // Storage usage for photos in bytes + // int usagePhotos + test('to test the property `usagePhotos`', () async { + // TODO + }); + + // Storage usage for videos in bytes + // int usageVideos + test('to test the property `usageVideos`', () async { + // TODO + }); + + // Total number of videos + // int videos + test('to test the property `videos`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_storage_response_dto_test.dart b/mobile/openapi/test/server_storage_response_dto_test.dart new file mode 100644 index 0000000000000..0ab1c591a1808 --- /dev/null +++ b/mobile/openapi/test/server_storage_response_dto_test.dart @@ -0,0 +1,64 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerStorageResponseDto +void main() { + // final instance = ServerStorageResponseDto(); + + group('test ServerStorageResponseDto', () { + // Available disk space (human-readable format) + // String diskAvailable + test('to test the property `diskAvailable`', () async { + // TODO + }); + + // Available disk space in bytes + // int diskAvailableRaw + test('to test the property `diskAvailableRaw`', () async { + // TODO + }); + + // Total disk size (human-readable format) + // String diskSize + test('to test the property `diskSize`', () async { + // TODO + }); + + // Total disk size in bytes + // int diskSizeRaw + test('to test the property `diskSizeRaw`', () async { + // TODO + }); + + // Disk usage percentage (0-100) + // double diskUsagePercentage + test('to test the property `diskUsagePercentage`', () async { + // TODO + }); + + // Used disk space (human-readable format) + // String diskUse + test('to test the property `diskUse`', () async { + // TODO + }); + + // Used disk space in bytes + // int diskUseRaw + test('to test the property `diskUseRaw`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_version_history_response_dto_test.dart b/mobile/openapi/test/server_version_history_response_dto_test.dart new file mode 100644 index 0000000000000..c9886429258ad --- /dev/null +++ b/mobile/openapi/test/server_version_history_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerVersionHistoryResponseDto +void main() { + // final instance = ServerVersionHistoryResponseDto(); + + group('test ServerVersionHistoryResponseDto', () { + // When this version was first seen + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Version history entry ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Version string + // String version + test('to test the property `version`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/server_version_response_dto_test.dart b/mobile/openapi/test/server_version_response_dto_test.dart new file mode 100644 index 0000000000000..549985492e8e5 --- /dev/null +++ b/mobile/openapi/test/server_version_response_dto_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ServerVersionResponseDto +void main() { + // final instance = ServerVersionResponseDto(); + + group('test ServerVersionResponseDto', () { + // Major version number + // int major + test('to test the property `major`', () async { + // TODO + }); + + // Minor version number + // int minor + test('to test the property `minor`', () async { + // TODO + }); + + // Patch version number + // int patch_ + test('to test the property `patch_`', () async { + // TODO + }); + + // Pre-release version number + // int prerelease + test('to test the property `prerelease`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/session_create_dto_test.dart b/mobile/openapi/test/session_create_dto_test.dart new file mode 100644 index 0000000000000..97cb461e87165 --- /dev/null +++ b/mobile/openapi/test/session_create_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SessionCreateDto +void main() { + // final instance = SessionCreateDto(); + + group('test SessionCreateDto', () { + // Device OS + // Optional deviceOS + test('to test the property `deviceOS`', () async { + // TODO + }); + + // Device type + // Optional deviceType + test('to test the property `deviceType`', () async { + // TODO + }); + + // Session duration in seconds + // Optional duration + test('to test the property `duration`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/session_create_response_dto_test.dart b/mobile/openapi/test/session_create_response_dto_test.dart new file mode 100644 index 0000000000000..83b8c92009fdd --- /dev/null +++ b/mobile/openapi/test/session_create_response_dto_test.dart @@ -0,0 +1,82 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SessionCreateResponseDto +void main() { + // final instance = SessionCreateResponseDto(); + + group('test SessionCreateResponseDto', () { + // App version + // String appVersion + test('to test the property `appVersion`', () async { + // TODO + }); + + // Creation date + // String createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Is current session + // bool current + test('to test the property `current`', () async { + // TODO + }); + + // Device OS + // String deviceOS + test('to test the property `deviceOS`', () async { + // TODO + }); + + // Device type + // String deviceType + test('to test the property `deviceType`', () async { + // TODO + }); + + // Expiration date + // Optional expiresAt + test('to test the property `expiresAt`', () async { + // TODO + }); + + // Session ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is pending sync reset + // bool isPendingSyncReset + test('to test the property `isPendingSyncReset`', () async { + // TODO + }); + + // Session token + // String token + test('to test the property `token`', () async { + // TODO + }); + + // Last update date + // String updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/session_response_dto_test.dart b/mobile/openapi/test/session_response_dto_test.dart new file mode 100644 index 0000000000000..9b206195fe735 --- /dev/null +++ b/mobile/openapi/test/session_response_dto_test.dart @@ -0,0 +1,76 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SessionResponseDto +void main() { + // final instance = SessionResponseDto(); + + group('test SessionResponseDto', () { + // App version + // String appVersion + test('to test the property `appVersion`', () async { + // TODO + }); + + // Creation date + // String createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Is current session + // bool current + test('to test the property `current`', () async { + // TODO + }); + + // Device OS + // String deviceOS + test('to test the property `deviceOS`', () async { + // TODO + }); + + // Device type + // String deviceType + test('to test the property `deviceType`', () async { + // TODO + }); + + // Expiration date + // Optional expiresAt + test('to test the property `expiresAt`', () async { + // TODO + }); + + // Session ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is pending sync reset + // bool isPendingSyncReset + test('to test the property `isPendingSyncReset`', () async { + // TODO + }); + + // Last update date + // String updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/session_unlock_dto_test.dart b/mobile/openapi/test/session_unlock_dto_test.dart new file mode 100644 index 0000000000000..0093fd7a5933e --- /dev/null +++ b/mobile/openapi/test/session_unlock_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SessionUnlockDto +void main() { + // final instance = SessionUnlockDto(); + + group('test SessionUnlockDto', () { + // User password (required if PIN code is not provided) + // Optional password + test('to test the property `password`', () async { + // TODO + }); + + // New PIN code (4-6 digits) + // Optional pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/session_update_dto_test.dart b/mobile/openapi/test/session_update_dto_test.dart new file mode 100644 index 0000000000000..f5c5480ceda5f --- /dev/null +++ b/mobile/openapi/test/session_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SessionUpdateDto +void main() { + // final instance = SessionUpdateDto(); + + group('test SessionUpdateDto', () { + // Reset pending sync state + // Optional isPendingSyncReset + test('to test the property `isPendingSyncReset`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sessions_api_test.dart b/mobile/openapi/test/sessions_api_test.dart new file mode 100644 index 0000000000000..89331883f1cf7 --- /dev/null +++ b/mobile/openapi/test/sessions_api_test.dart @@ -0,0 +1,75 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for SessionsApi +void main() { + // final instance = SessionsApi(); + + group('tests for SessionsApi', () { + // Create a session + // + // Create a session as a child to the current session. This endpoint is used for casting. + // + //Future createSession(SessionCreateDto sessionCreateDto) async + test('test createSession', () async { + // TODO + }); + + // Delete all sessions + // + // Delete all sessions for the user. This will not delete the current session. + // + //Future deleteAllSessions() async + test('test deleteAllSessions', () async { + // TODO + }); + + // Delete a session + // + // Delete a specific session by id. + // + //Future deleteSession(String id) async + test('test deleteSession', () async { + // TODO + }); + + // Retrieve sessions + // + // Retrieve a list of sessions for the user. + // + //Future> getSessions() async + test('test getSessions', () async { + // TODO + }); + + // Lock a session + // + // Lock a specific session by id. + // + //Future lockSession(String id) async + test('test lockSession', () async { + // TODO + }); + + // Update a session + // + // Update a specific session identified by id. + // + //Future updateSession(String id, SessionUpdateDto sessionUpdateDto) async + test('test updateSession', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/set_maintenance_mode_dto_test.dart b/mobile/openapi/test/set_maintenance_mode_dto_test.dart new file mode 100644 index 0000000000000..369e4e10af1b6 --- /dev/null +++ b/mobile/openapi/test/set_maintenance_mode_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SetMaintenanceModeDto +void main() { + // final instance = SetMaintenanceModeDto(); + + group('test SetMaintenanceModeDto', () { + // MaintenanceAction action + test('to test the property `action`', () async { + // TODO + }); + + // Restore backup filename + // Optional restoreBackupFilename + test('to test the property `restoreBackupFilename`', () async { + // TODO + }); + + // Rollback repository ID + // Optional rollbackRepositoryId + test('to test the property `rollbackRepositoryId`', () async { + // TODO + }); + + // Rollback snapshot ID + // Optional rollbackSnapshotId + test('to test the property `rollbackSnapshotId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/shared_link_create_dto_test.dart b/mobile/openapi/test/shared_link_create_dto_test.dart new file mode 100644 index 0000000000000..3777006b5d133 --- /dev/null +++ b/mobile/openapi/test/shared_link_create_dto_test.dart @@ -0,0 +1,81 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SharedLinkCreateDto +void main() { + // final instance = SharedLinkCreateDto(); + + group('test SharedLinkCreateDto', () { + // Album ID (for album sharing) + // Optional albumId + test('to test the property `albumId`', () async { + // TODO + }); + + // Allow downloads + // Optional allowDownload (default value: true) + test('to test the property `allowDownload`', () async { + // TODO + }); + + // Allow uploads + // Optional allowUpload + test('to test the property `allowUpload`', () async { + // TODO + }); + + // Asset IDs (for individual assets) + // Optional?> assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // Link description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Expiration date + // Optional expiresAt + test('to test the property `expiresAt`', () async { + // TODO + }); + + // Link password + // Optional password + test('to test the property `password`', () async { + // TODO + }); + + // Show metadata + // Optional showMetadata (default value: true) + test('to test the property `showMetadata`', () async { + // TODO + }); + + // Custom URL slug + // Optional slug + test('to test the property `slug`', () async { + // TODO + }); + + // SharedLinkType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/shared_link_edit_dto_test.dart b/mobile/openapi/test/shared_link_edit_dto_test.dart new file mode 100644 index 0000000000000..d5ade75793f60 --- /dev/null +++ b/mobile/openapi/test/shared_link_edit_dto_test.dart @@ -0,0 +1,64 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SharedLinkEditDto +void main() { + // final instance = SharedLinkEditDto(); + + group('test SharedLinkEditDto', () { + // Allow downloads + // Optional allowDownload + test('to test the property `allowDownload`', () async { + // TODO + }); + + // Allow uploads + // Optional allowUpload + test('to test the property `allowUpload`', () async { + // TODO + }); + + // Link description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Expiration date + // Optional expiresAt + test('to test the property `expiresAt`', () async { + // TODO + }); + + // Link password + // Optional password + test('to test the property `password`', () async { + // TODO + }); + + // Show metadata + // Optional showMetadata + test('to test the property `showMetadata`', () async { + // TODO + }); + + // Custom URL slug + // Optional slug + test('to test the property `slug`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/shared_link_login_dto_test.dart b/mobile/openapi/test/shared_link_login_dto_test.dart new file mode 100644 index 0000000000000..c599620135700 --- /dev/null +++ b/mobile/openapi/test/shared_link_login_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SharedLinkLoginDto +void main() { + // final instance = SharedLinkLoginDto(); + + group('test SharedLinkLoginDto', () { + // Shared link password + // String password + test('to test the property `password`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/shared_link_response_dto_test.dart b/mobile/openapi/test/shared_link_response_dto_test.dart new file mode 100644 index 0000000000000..b49b4d00ec618 --- /dev/null +++ b/mobile/openapi/test/shared_link_response_dto_test.dart @@ -0,0 +1,103 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SharedLinkResponseDto +void main() { + // final instance = SharedLinkResponseDto(); + + group('test SharedLinkResponseDto', () { + // Optional album + test('to test the property `album`', () async { + // TODO + }); + + // Allow downloads + // bool allowDownload + test('to test the property `allowDownload`', () async { + // TODO + }); + + // Allow uploads + // bool allowUpload + test('to test the property `allowUpload`', () async { + // TODO + }); + + // List assets (default value: const []) + test('to test the property `assets`', () async { + // TODO + }); + + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Link description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Expiration date + // DateTime expiresAt + test('to test the property `expiresAt`', () async { + // TODO + }); + + // Shared link ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Encryption key (base64url) + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Has password + // String password + test('to test the property `password`', () async { + // TODO + }); + + // Show metadata + // bool showMetadata + test('to test the property `showMetadata`', () async { + // TODO + }); + + // Custom URL slug + // String slug + test('to test the property `slug`', () async { + // TODO + }); + + // SharedLinkType type + test('to test the property `type`', () async { + // TODO + }); + + // Owner user ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/shared_link_type_test.dart b/mobile/openapi/test/shared_link_type_test.dart new file mode 100644 index 0000000000000..427d027eba85b --- /dev/null +++ b/mobile/openapi/test/shared_link_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SharedLinkType +void main() { + + group('test SharedLinkType', () { + + }); + +} diff --git a/mobile/openapi/test/shared_links_api_test.dart b/mobile/openapi/test/shared_links_api_test.dart new file mode 100644 index 0000000000000..1a3ec99fb6375 --- /dev/null +++ b/mobile/openapi/test/shared_links_api_test.dart @@ -0,0 +1,102 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for SharedLinksApi +void main() { + // final instance = SharedLinksApi(); + + group('tests for SharedLinksApi', () { + // Add assets to a shared link + // + // Add assets to a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. + // + //Future> addSharedLinkAssets(String id, AssetIdsDto assetIdsDto) async + test('test addSharedLinkAssets', () async { + // TODO + }); + + // Create a shared link + // + // Create a new shared link. + // + //Future createSharedLink(SharedLinkCreateDto sharedLinkCreateDto) async + test('test createSharedLink', () async { + // TODO + }); + + // Retrieve all shared links + // + // Retrieve a list of all shared links. + // + //Future> getAllSharedLinks({ String albumId, String id }) async + test('test getAllSharedLinks', () async { + // TODO + }); + + // Retrieve current shared link + // + // Retrieve the current shared link associated with authentication method. + // + //Future getMySharedLink({ String key, String slug }) async + test('test getMySharedLink', () async { + // TODO + }); + + // Retrieve a shared link + // + // Retrieve a specific shared link by its ID. + // + //Future getSharedLinkById(String id) async + test('test getSharedLinkById', () async { + // TODO + }); + + // Delete a shared link + // + // Delete a specific shared link by its ID. + // + //Future removeSharedLink(String id) async + test('test removeSharedLink', () async { + // TODO + }); + + // Remove assets from a shared link + // + // Remove assets from a specific shared link by its ID. This endpoint is only relevant for shared link of type individual. + // + //Future> removeSharedLinkAssets(String id, AssetIdsDto assetIdsDto) async + test('test removeSharedLinkAssets', () async { + // TODO + }); + + // Shared link login + // + // Login to a password protected shared link + // + //Future sharedLinkLogin(SharedLinkLoginDto sharedLinkLoginDto, { String key, String slug }) async + test('test sharedLinkLogin', () async { + // TODO + }); + + // Update a shared link + // + // Update an existing shared link by its ID. + // + //Future updateSharedLink(String id, SharedLinkEditDto sharedLinkEditDto) async + test('test updateSharedLink', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/shared_links_response_test.dart b/mobile/openapi/test/shared_links_response_test.dart new file mode 100644 index 0000000000000..39669587e09ca --- /dev/null +++ b/mobile/openapi/test/shared_links_response_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SharedLinksResponse +void main() { + // final instance = SharedLinksResponse(); + + group('test SharedLinksResponse', () { + // Whether shared links are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Whether shared links appear in web sidebar + // bool sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/shared_links_update_test.dart b/mobile/openapi/test/shared_links_update_test.dart new file mode 100644 index 0000000000000..b518cff9550d7 --- /dev/null +++ b/mobile/openapi/test/shared_links_update_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SharedLinksUpdate +void main() { + // final instance = SharedLinksUpdate(); + + group('test SharedLinksUpdate', () { + // Whether shared links are enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Whether shared links appear in web sidebar + // Optional sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sign_up_dto_test.dart b/mobile/openapi/test/sign_up_dto_test.dart new file mode 100644 index 0000000000000..867c66c736b38 --- /dev/null +++ b/mobile/openapi/test/sign_up_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SignUpDto +void main() { + // final instance = SignUpDto(); + + group('test SignUpDto', () { + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // User password + // String password + test('to test the property `password`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/smart_search_dto_test.dart b/mobile/openapi/test/smart_search_dto_test.dart new file mode 100644 index 0000000000000..b90d085e8e614 --- /dev/null +++ b/mobile/openapi/test/smart_search_dto_test.dart @@ -0,0 +1,224 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SmartSearchDto +void main() { + // final instance = SmartSearchDto(); + + group('test SmartSearchDto', () { + // Filter by album IDs + // Optional?> albumIds (default value: const []) + test('to test the property `albumIds`', () async { + // TODO + }); + + // Filter by city name + // Optional city + test('to test the property `city`', () async { + // TODO + }); + + // Filter by country name + // Optional country + test('to test the property `country`', () async { + // TODO + }); + + // Filter by creation date (after) + // Optional createdAfter + test('to test the property `createdAfter`', () async { + // TODO + }); + + // Filter by creation date (before) + // Optional createdBefore + test('to test the property `createdBefore`', () async { + // TODO + }); + + // Filter by encoded status + // Optional isEncoded + test('to test the property `isEncoded`', () async { + // TODO + }); + + // Filter by favorite status + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Filter by motion photo status + // Optional isMotion + test('to test the property `isMotion`', () async { + // TODO + }); + + // Filter assets not in any album + // Optional isNotInAlbum + test('to test the property `isNotInAlbum`', () async { + // TODO + }); + + // Filter by offline status + // Optional isOffline + test('to test the property `isOffline`', () async { + // TODO + }); + + // Search language code + // Optional language + test('to test the property `language`', () async { + // TODO + }); + + // Filter by lens model + // Optional lensModel + test('to test the property `lensModel`', () async { + // TODO + }); + + // Library ID to filter by + // Optional libraryId + test('to test the property `libraryId`', () async { + // TODO + }); + + // Filter by camera make + // Optional make + test('to test the property `make`', () async { + // TODO + }); + + // Filter by camera model + // Optional model + test('to test the property `model`', () async { + // TODO + }); + + // Filter by OCR text content + // Optional ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // Page number + // Optional page + test('to test the property `page`', () async { + // TODO + }); + + // Filter by person IDs + // Optional?> personIds (default value: const []) + test('to test the property `personIds`', () async { + // TODO + }); + + // Natural language search query + // Optional query + test('to test the property `query`', () async { + // TODO + }); + + // Asset ID to use as search reference + // Optional queryAssetId + test('to test the property `queryAssetId`', () async { + // TODO + }); + + // Filter by rating [1-5], or null for unrated + // Optional rating + test('to test the property `rating`', () async { + // TODO + }); + + // Number of results to return + // Optional size + test('to test the property `size`', () async { + // TODO + }); + + // Filter by state/province name + // Optional state + test('to test the property `state`', () async { + // TODO + }); + + // Filter by tag IDs + // Optional?> tagIds (default value: const []) + test('to test the property `tagIds`', () async { + // TODO + }); + + // Filter by taken date (after) + // Optional takenAfter + test('to test the property `takenAfter`', () async { + // TODO + }); + + // Filter by taken date (before) + // Optional takenBefore + test('to test the property `takenBefore`', () async { + // TODO + }); + + // Filter by trash date (after) + // Optional trashedAfter + test('to test the property `trashedAfter`', () async { + // TODO + }); + + // Filter by trash date (before) + // Optional trashedBefore + test('to test the property `trashedBefore`', () async { + // TODO + }); + + // Optional type + test('to test the property `type`', () async { + // TODO + }); + + // Filter by update date (after) + // Optional updatedAfter + test('to test the property `updatedAfter`', () async { + // TODO + }); + + // Filter by update date (before) + // Optional updatedBefore + test('to test the property `updatedBefore`', () async { + // TODO + }); + + // Optional visibility + test('to test the property `visibility`', () async { + // TODO + }); + + // Include deleted assets + // Optional withDeleted + test('to test the property `withDeleted`', () async { + // TODO + }); + + // Include EXIF data in response + // Optional withExif + test('to test the property `withExif`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/snapshot_dto_test.dart b/mobile/openapi/test/snapshot_dto_test.dart new file mode 100644 index 0000000000000..3e56f60b164cc --- /dev/null +++ b/mobile/openapi/test/snapshot_dto_test.dart @@ -0,0 +1,42 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SnapshotDto +void main() { + // final instance = SnapshotDto(); + + group('test SnapshotDto', () { + // String id + test('to test the property `id`', () async { + // TODO + }); + + // List paths (default value: const []) + test('to test the property `paths`', () async { + // TODO + }); + + // Optional summary + test('to test the property `summary`', () async { + // TODO + }); + + // String time + test('to test the property `time`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/snapshot_summary_dto_test.dart b/mobile/openapi/test/snapshot_summary_dto_test.dart new file mode 100644 index 0000000000000..e08fd71e8038a --- /dev/null +++ b/mobile/openapi/test/snapshot_summary_dto_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SnapshotSummaryDto +void main() { + // final instance = SnapshotSummaryDto(); + + group('test SnapshotSummaryDto', () { + // num dataAdded + test('to test the property `dataAdded`', () async { + // TODO + }); + + // num filesChanged + test('to test the property `filesChanged`', () async { + // TODO + }); + + // num filesNew + test('to test the property `filesNew`', () async { + // TODO + }); + + // num filesUnmodified + test('to test the property `filesUnmodified`', () async { + // TODO + }); + + // num totalBytes + test('to test the property `totalBytes`', () async { + // TODO + }); + + // num totalFiles + test('to test the property `totalFiles`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/source_type_test.dart b/mobile/openapi/test/source_type_test.dart new file mode 100644 index 0000000000000..2af33d03a87e0 --- /dev/null +++ b/mobile/openapi/test/source_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SourceType +void main() { + + group('test SourceType', () { + + }); + +} diff --git a/mobile/openapi/test/stack_create_dto_test.dart b/mobile/openapi/test/stack_create_dto_test.dart new file mode 100644 index 0000000000000..a122d4ec94e73 --- /dev/null +++ b/mobile/openapi/test/stack_create_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for StackCreateDto +void main() { + // final instance = StackCreateDto(); + + group('test StackCreateDto', () { + // Asset IDs (first becomes primary, min 2) + // List assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/stack_response_dto_test.dart b/mobile/openapi/test/stack_response_dto_test.dart new file mode 100644 index 0000000000000..b9aa58de91e44 --- /dev/null +++ b/mobile/openapi/test/stack_response_dto_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for StackResponseDto +void main() { + // final instance = StackResponseDto(); + + group('test StackResponseDto', () { + // List assets (default value: const []) + test('to test the property `assets`', () async { + // TODO + }); + + // Stack ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Primary asset ID + // String primaryAssetId + test('to test the property `primaryAssetId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/stack_update_dto_test.dart b/mobile/openapi/test/stack_update_dto_test.dart new file mode 100644 index 0000000000000..2143bbda586a3 --- /dev/null +++ b/mobile/openapi/test/stack_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for StackUpdateDto +void main() { + // final instance = StackUpdateDto(); + + group('test StackUpdateDto', () { + // Primary asset ID + // Optional primaryAssetId + test('to test the property `primaryAssetId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/stacks_api_test.dart b/mobile/openapi/test/stacks_api_test.dart new file mode 100644 index 0000000000000..c9b09492adb78 --- /dev/null +++ b/mobile/openapi/test/stacks_api_test.dart @@ -0,0 +1,84 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for StacksApi +void main() { + // final instance = StacksApi(); + + group('tests for StacksApi', () { + // Create a stack + // + // Create a new stack by providing a name and a list of asset IDs to include in the stack. If any of the provided asset IDs are primary assets of an existing stack, the existing stack will be merged into the newly created stack. + // + //Future createStack(StackCreateDto stackCreateDto) async + test('test createStack', () async { + // TODO + }); + + // Delete a stack + // + // Delete a specific stack by its ID. + // + //Future deleteStack(String id) async + test('test deleteStack', () async { + // TODO + }); + + // Delete stacks + // + // Delete multiple stacks by providing a list of stack IDs. + // + //Future deleteStacks(BulkIdsDto bulkIdsDto) async + test('test deleteStacks', () async { + // TODO + }); + + // Retrieve a stack + // + // Retrieve a specific stack by its ID. + // + //Future getStack(String id) async + test('test getStack', () async { + // TODO + }); + + // Remove an asset from a stack + // + // Remove a specific asset from a stack by providing the stack ID and asset ID. + // + //Future removeAssetFromStack(String assetId, String id) async + test('test removeAssetFromStack', () async { + // TODO + }); + + // Retrieve stacks + // + // Retrieve a list of stacks. + // + //Future> searchStacks({ String primaryAssetId }) async + test('test searchStacks', () async { + // TODO + }); + + // Update a stack + // + // Update an existing stack by its ID. + // + //Future updateStack(String id, StackUpdateDto stackUpdateDto) async + test('test updateStack', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/statistics_search_dto_test.dart b/mobile/openapi/test/statistics_search_dto_test.dart new file mode 100644 index 0000000000000..42e93211174d8 --- /dev/null +++ b/mobile/openapi/test/statistics_search_dto_test.dart @@ -0,0 +1,188 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for StatisticsSearchDto +void main() { + // final instance = StatisticsSearchDto(); + + group('test StatisticsSearchDto', () { + // Filter by album IDs + // Optional?> albumIds (default value: const []) + test('to test the property `albumIds`', () async { + // TODO + }); + + // Filter by city name + // Optional city + test('to test the property `city`', () async { + // TODO + }); + + // Filter by country name + // Optional country + test('to test the property `country`', () async { + // TODO + }); + + // Filter by creation date (after) + // Optional createdAfter + test('to test the property `createdAfter`', () async { + // TODO + }); + + // Filter by creation date (before) + // Optional createdBefore + test('to test the property `createdBefore`', () async { + // TODO + }); + + // Filter by description text + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Filter by encoded status + // Optional isEncoded + test('to test the property `isEncoded`', () async { + // TODO + }); + + // Filter by favorite status + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Filter by motion photo status + // Optional isMotion + test('to test the property `isMotion`', () async { + // TODO + }); + + // Filter assets not in any album + // Optional isNotInAlbum + test('to test the property `isNotInAlbum`', () async { + // TODO + }); + + // Filter by offline status + // Optional isOffline + test('to test the property `isOffline`', () async { + // TODO + }); + + // Filter by lens model + // Optional lensModel + test('to test the property `lensModel`', () async { + // TODO + }); + + // Library ID to filter by + // Optional libraryId + test('to test the property `libraryId`', () async { + // TODO + }); + + // Filter by camera make + // Optional make + test('to test the property `make`', () async { + // TODO + }); + + // Filter by camera model + // Optional model + test('to test the property `model`', () async { + // TODO + }); + + // Filter by OCR text content + // Optional ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // Filter by person IDs + // Optional?> personIds (default value: const []) + test('to test the property `personIds`', () async { + // TODO + }); + + // Filter by rating [1-5], or null for unrated + // Optional rating + test('to test the property `rating`', () async { + // TODO + }); + + // Filter by state/province name + // Optional state + test('to test the property `state`', () async { + // TODO + }); + + // Filter by tag IDs + // Optional?> tagIds (default value: const []) + test('to test the property `tagIds`', () async { + // TODO + }); + + // Filter by taken date (after) + // Optional takenAfter + test('to test the property `takenAfter`', () async { + // TODO + }); + + // Filter by taken date (before) + // Optional takenBefore + test('to test the property `takenBefore`', () async { + // TODO + }); + + // Filter by trash date (after) + // Optional trashedAfter + test('to test the property `trashedAfter`', () async { + // TODO + }); + + // Filter by trash date (before) + // Optional trashedBefore + test('to test the property `trashedBefore`', () async { + // TODO + }); + + // Optional type + test('to test the property `type`', () async { + // TODO + }); + + // Filter by update date (after) + // Optional updatedAfter + test('to test the property `updatedAfter`', () async { + // TODO + }); + + // Filter by update date (before) + // Optional updatedBefore + test('to test the property `updatedBefore`', () async { + // TODO + }); + + // Optional visibility + test('to test the property `visibility`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/storage_folder_test.dart b/mobile/openapi/test/storage_folder_test.dart new file mode 100644 index 0000000000000..74bf413ea4119 --- /dev/null +++ b/mobile/openapi/test/storage_folder_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for StorageFolder +void main() { + + group('test StorageFolder', () { + + }); + +} diff --git a/mobile/openapi/test/sync_ack_delete_dto_test.dart b/mobile/openapi/test/sync_ack_delete_dto_test.dart new file mode 100644 index 0000000000000..5a124efc7e5e7 --- /dev/null +++ b/mobile/openapi/test/sync_ack_delete_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAckDeleteDto +void main() { + // final instance = SyncAckDeleteDto(); + + group('test SyncAckDeleteDto', () { + // Sync entity types to delete acks for + // Optional?> types (default value: const []) + test('to test the property `types`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_ack_dto_test.dart b/mobile/openapi/test/sync_ack_dto_test.dart new file mode 100644 index 0000000000000..76806d531c017 --- /dev/null +++ b/mobile/openapi/test/sync_ack_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAckDto +void main() { + // final instance = SyncAckDto(); + + group('test SyncAckDto', () { + // Acknowledgment ID + // String ack + test('to test the property `ack`', () async { + // TODO + }); + + // SyncEntityType type + test('to test the property `type`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_ack_set_dto_test.dart b/mobile/openapi/test/sync_ack_set_dto_test.dart new file mode 100644 index 0000000000000..d360000392527 --- /dev/null +++ b/mobile/openapi/test/sync_ack_set_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAckSetDto +void main() { + // final instance = SyncAckSetDto(); + + group('test SyncAckSetDto', () { + // Acknowledgment IDs (max 1000) + // List acks (default value: const []) + test('to test the property `acks`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_album_delete_v1_test.dart b/mobile/openapi/test/sync_album_delete_v1_test.dart new file mode 100644 index 0000000000000..5ee39474afd0c --- /dev/null +++ b/mobile/openapi/test/sync_album_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAlbumDeleteV1 +void main() { + // final instance = SyncAlbumDeleteV1(); + + group('test SyncAlbumDeleteV1', () { + // Album ID + // String albumId + test('to test the property `albumId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_album_to_asset_delete_v1_test.dart b/mobile/openapi/test/sync_album_to_asset_delete_v1_test.dart new file mode 100644 index 0000000000000..822747bc4def9 --- /dev/null +++ b/mobile/openapi/test/sync_album_to_asset_delete_v1_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAlbumToAssetDeleteV1 +void main() { + // final instance = SyncAlbumToAssetDeleteV1(); + + group('test SyncAlbumToAssetDeleteV1', () { + // Album ID + // String albumId + test('to test the property `albumId`', () async { + // TODO + }); + + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_album_to_asset_v1_test.dart b/mobile/openapi/test/sync_album_to_asset_v1_test.dart new file mode 100644 index 0000000000000..590ebe13c3ec0 --- /dev/null +++ b/mobile/openapi/test/sync_album_to_asset_v1_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAlbumToAssetV1 +void main() { + // final instance = SyncAlbumToAssetV1(); + + group('test SyncAlbumToAssetV1', () { + // Album ID + // String albumId + test('to test the property `albumId`', () async { + // TODO + }); + + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_album_user_delete_v1_test.dart b/mobile/openapi/test/sync_album_user_delete_v1_test.dart new file mode 100644 index 0000000000000..9bcaf4c164953 --- /dev/null +++ b/mobile/openapi/test/sync_album_user_delete_v1_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAlbumUserDeleteV1 +void main() { + // final instance = SyncAlbumUserDeleteV1(); + + group('test SyncAlbumUserDeleteV1', () { + // Album ID + // String albumId + test('to test the property `albumId`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_album_user_v1_test.dart b/mobile/openapi/test/sync_album_user_v1_test.dart new file mode 100644 index 0000000000000..a8fe76f781bbb --- /dev/null +++ b/mobile/openapi/test/sync_album_user_v1_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAlbumUserV1 +void main() { + // final instance = SyncAlbumUserV1(); + + group('test SyncAlbumUserV1', () { + // Album ID + // String albumId + test('to test the property `albumId`', () async { + // TODO + }); + + // AlbumUserRole role + test('to test the property `role`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_album_v1_test.dart b/mobile/openapi/test/sync_album_v1_test.dart new file mode 100644 index 0000000000000..3df5649d32b7e --- /dev/null +++ b/mobile/openapi/test/sync_album_v1_test.dart @@ -0,0 +1,75 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAlbumV1 +void main() { + // final instance = SyncAlbumV1(); + + group('test SyncAlbumV1', () { + // Created at + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Album description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Album ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is activity enabled + // bool isActivityEnabled + test('to test the property `isActivityEnabled`', () async { + // TODO + }); + + // Album name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // AssetOrder order + test('to test the property `order`', () async { + // TODO + }); + + // Owner ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Thumbnail asset ID + // String thumbnailAssetId + test('to test the property `thumbnailAssetId`', () async { + // TODO + }); + + // Updated at + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_album_v2_test.dart b/mobile/openapi/test/sync_album_v2_test.dart new file mode 100644 index 0000000000000..89b447972fdc2 --- /dev/null +++ b/mobile/openapi/test/sync_album_v2_test.dart @@ -0,0 +1,69 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAlbumV2 +void main() { + // final instance = SyncAlbumV2(); + + group('test SyncAlbumV2', () { + // Created at + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Album description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Album ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is activity enabled + // bool isActivityEnabled + test('to test the property `isActivityEnabled`', () async { + // TODO + }); + + // Album name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // AssetOrder order + test('to test the property `order`', () async { + // TODO + }); + + // Thumbnail asset ID + // String thumbnailAssetId + test('to test the property `thumbnailAssetId`', () async { + // TODO + }); + + // Updated at + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_api_test.dart b/mobile/openapi/test/sync_api_test.dart new file mode 100644 index 0000000000000..ff68bca4c7202 --- /dev/null +++ b/mobile/openapi/test/sync_api_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for SyncApi +void main() { + // final instance = SyncApi(); + + group('tests for SyncApi', () { + // Delete acknowledgements + // + // Delete specific synchronization acknowledgments. + // + //Future deleteSyncAck(SyncAckDeleteDto syncAckDeleteDto) async + test('test deleteSyncAck', () async { + // TODO + }); + + // Retrieve acknowledgements + // + // Retrieve the synchronization acknowledgments for the current session. + // + //Future> getSyncAck() async + test('test getSyncAck', () async { + // TODO + }); + + // Stream sync changes + // + // Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes. + // + //Future getSyncStream(SyncStreamDto syncStreamDto) async + test('test getSyncStream', () async { + // TODO + }); + + // Acknowledge changes + // + // Send a list of synchronization acknowledgements to confirm that the latest changes have been received. + // + //Future sendSyncAck(SyncAckSetDto syncAckSetDto) async + test('test sendSyncAck', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/sync_asset_delete_v1_test.dart b/mobile/openapi/test/sync_asset_delete_v1_test.dart new file mode 100644 index 0000000000000..5f83d9e1d85fd --- /dev/null +++ b/mobile/openapi/test/sync_asset_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetDeleteV1 +void main() { + // final instance = SyncAssetDeleteV1(); + + group('test SyncAssetDeleteV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_edit_delete_v1_test.dart b/mobile/openapi/test/sync_asset_edit_delete_v1_test.dart new file mode 100644 index 0000000000000..e3560f4da59f5 --- /dev/null +++ b/mobile/openapi/test/sync_asset_edit_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetEditDeleteV1 +void main() { + // final instance = SyncAssetEditDeleteV1(); + + group('test SyncAssetEditDeleteV1', () { + // Edit ID + // String editId + test('to test the property `editId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_edit_v1_test.dart b/mobile/openapi/test/sync_asset_edit_v1_test.dart new file mode 100644 index 0000000000000..1a84ff97f3c57 --- /dev/null +++ b/mobile/openapi/test/sync_asset_edit_v1_test.dart @@ -0,0 +1,51 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetEditV1 +void main() { + // final instance = SyncAssetEditV1(); + + group('test SyncAssetEditV1', () { + // AssetEditAction action + test('to test the property `action`', () async { + // TODO + }); + + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Edit ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Edit parameters + // Map parameters (default value: const {}) + test('to test the property `parameters`', () async { + // TODO + }); + + // Edit sequence + // int sequence + test('to test the property `sequence`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_exif_v1_test.dart b/mobile/openapi/test/sync_asset_exif_v1_test.dart new file mode 100644 index 0000000000000..ad9a98bbfecd6 --- /dev/null +++ b/mobile/openapi/test/sync_asset_exif_v1_test.dart @@ -0,0 +1,172 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetExifV1 +void main() { + // final instance = SyncAssetExifV1(); + + group('test SyncAssetExifV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // City + // String city + test('to test the property `city`', () async { + // TODO + }); + + // Country + // String country + test('to test the property `country`', () async { + // TODO + }); + + // Date time original + // DateTime dateTimeOriginal + test('to test the property `dateTimeOriginal`', () async { + // TODO + }); + + // Description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Exif image height + // int exifImageHeight + test('to test the property `exifImageHeight`', () async { + // TODO + }); + + // Exif image width + // int exifImageWidth + test('to test the property `exifImageWidth`', () async { + // TODO + }); + + // Exposure time + // String exposureTime + test('to test the property `exposureTime`', () async { + // TODO + }); + + // F number + // double fNumber + test('to test the property `fNumber`', () async { + // TODO + }); + + // File size in byte + // int fileSizeInByte + test('to test the property `fileSizeInByte`', () async { + // TODO + }); + + // Focal length + // double focalLength + test('to test the property `focalLength`', () async { + // TODO + }); + + // FPS + // double fps + test('to test the property `fps`', () async { + // TODO + }); + + // ISO + // int iso + test('to test the property `iso`', () async { + // TODO + }); + + // Latitude + // double latitude + test('to test the property `latitude`', () async { + // TODO + }); + + // Lens model + // String lensModel + test('to test the property `lensModel`', () async { + // TODO + }); + + // Longitude + // double longitude + test('to test the property `longitude`', () async { + // TODO + }); + + // Make + // String make + test('to test the property `make`', () async { + // TODO + }); + + // Model + // String model + test('to test the property `model`', () async { + // TODO + }); + + // Modify date + // DateTime modifyDate + test('to test the property `modifyDate`', () async { + // TODO + }); + + // Orientation + // String orientation + test('to test the property `orientation`', () async { + // TODO + }); + + // Profile description + // String profileDescription + test('to test the property `profileDescription`', () async { + // TODO + }); + + // Projection type + // String projectionType + test('to test the property `projectionType`', () async { + // TODO + }); + + // Rating + // int rating + test('to test the property `rating`', () async { + // TODO + }); + + // State + // String state + test('to test the property `state`', () async { + // TODO + }); + + // Time zone + // String timeZone + test('to test the property `timeZone`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_face_delete_v1_test.dart b/mobile/openapi/test/sync_asset_face_delete_v1_test.dart new file mode 100644 index 0000000000000..403bbd2a4ee59 --- /dev/null +++ b/mobile/openapi/test/sync_asset_face_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetFaceDeleteV1 +void main() { + // final instance = SyncAssetFaceDeleteV1(); + + group('test SyncAssetFaceDeleteV1', () { + // Asset face ID + // String assetFaceId + test('to test the property `assetFaceId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_face_v1_test.dart b/mobile/openapi/test/sync_asset_face_v1_test.dart new file mode 100644 index 0000000000000..4d1d45e141141 --- /dev/null +++ b/mobile/openapi/test/sync_asset_face_v1_test.dart @@ -0,0 +1,82 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetFaceV1 +void main() { + // final instance = SyncAssetFaceV1(); + + group('test SyncAssetFaceV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Bounding box X1 + // int boundingBoxX1 + test('to test the property `boundingBoxX1`', () async { + // TODO + }); + + // Bounding box X2 + // int boundingBoxX2 + test('to test the property `boundingBoxX2`', () async { + // TODO + }); + + // Bounding box Y1 + // int boundingBoxY1 + test('to test the property `boundingBoxY1`', () async { + // TODO + }); + + // Bounding box Y2 + // int boundingBoxY2 + test('to test the property `boundingBoxY2`', () async { + // TODO + }); + + // Asset face ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Image height + // int imageHeight + test('to test the property `imageHeight`', () async { + // TODO + }); + + // Image width + // int imageWidth + test('to test the property `imageWidth`', () async { + // TODO + }); + + // Person ID + // String personId + test('to test the property `personId`', () async { + // TODO + }); + + // Source type + // String sourceType + test('to test the property `sourceType`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_face_v2_test.dart b/mobile/openapi/test/sync_asset_face_v2_test.dart new file mode 100644 index 0000000000000..9bb9617edc852 --- /dev/null +++ b/mobile/openapi/test/sync_asset_face_v2_test.dart @@ -0,0 +1,94 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetFaceV2 +void main() { + // final instance = SyncAssetFaceV2(); + + group('test SyncAssetFaceV2', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Bounding box X1 + // int boundingBoxX1 + test('to test the property `boundingBoxX1`', () async { + // TODO + }); + + // Bounding box X2 + // int boundingBoxX2 + test('to test the property `boundingBoxX2`', () async { + // TODO + }); + + // Bounding box Y1 + // int boundingBoxY1 + test('to test the property `boundingBoxY1`', () async { + // TODO + }); + + // Bounding box Y2 + // int boundingBoxY2 + test('to test the property `boundingBoxY2`', () async { + // TODO + }); + + // Face deleted at + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // Asset face ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Image height + // int imageHeight + test('to test the property `imageHeight`', () async { + // TODO + }); + + // Image width + // int imageWidth + test('to test the property `imageWidth`', () async { + // TODO + }); + + // Is the face visible in the asset + // bool isVisible + test('to test the property `isVisible`', () async { + // TODO + }); + + // Person ID + // String personId + test('to test the property `personId`', () async { + // TODO + }); + + // Source type + // String sourceType + test('to test the property `sourceType`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_metadata_delete_v1_test.dart b/mobile/openapi/test/sync_asset_metadata_delete_v1_test.dart new file mode 100644 index 0000000000000..eb24fcc860e5f --- /dev/null +++ b/mobile/openapi/test/sync_asset_metadata_delete_v1_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetMetadataDeleteV1 +void main() { + // final instance = SyncAssetMetadataDeleteV1(); + + group('test SyncAssetMetadataDeleteV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Key + // String key + test('to test the property `key`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_metadata_v1_test.dart b/mobile/openapi/test/sync_asset_metadata_v1_test.dart new file mode 100644 index 0000000000000..ecab27cfc669a --- /dev/null +++ b/mobile/openapi/test/sync_asset_metadata_v1_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetMetadataV1 +void main() { + // final instance = SyncAssetMetadataV1(); + + group('test SyncAssetMetadataV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Key + // String key + test('to test the property `key`', () async { + // TODO + }); + + // Value + // Map value (default value: const {}) + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_ocr_delete_v1_test.dart b/mobile/openapi/test/sync_asset_ocr_delete_v1_test.dart new file mode 100644 index 0000000000000..57885523289e3 --- /dev/null +++ b/mobile/openapi/test/sync_asset_ocr_delete_v1_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetOcrDeleteV1 +void main() { + // final instance = SyncAssetOcrDeleteV1(); + + group('test SyncAssetOcrDeleteV1', () { + // Original asset ID of the deleted OCR entry + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Timestamp when the OCR entry was deleted + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // Audit row ID of the deleted OCR entry + // String id + test('to test the property `id`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_ocr_v1_test.dart b/mobile/openapi/test/sync_asset_ocr_v1_test.dart new file mode 100644 index 0000000000000..64cf961e97ffe --- /dev/null +++ b/mobile/openapi/test/sync_asset_ocr_v1_test.dart @@ -0,0 +1,106 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetOcrV1 +void main() { + // final instance = SyncAssetOcrV1(); + + group('test SyncAssetOcrV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Confidence score of the bounding box + // double boxScore + test('to test the property `boxScore`', () async { + // TODO + }); + + // OCR entry ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Whether the OCR entry is visible + // bool isVisible + test('to test the property `isVisible`', () async { + // TODO + }); + + // Recognized text content + // String text + test('to test the property `text`', () async { + // TODO + }); + + // Confidence score of the recognized text + // double textScore + test('to test the property `textScore`', () async { + // TODO + }); + + // Top-left X coordinate (normalized 0–1) + // double x1 + test('to test the property `x1`', () async { + // TODO + }); + + // Top-right X coordinate (normalized 0–1) + // double x2 + test('to test the property `x2`', () async { + // TODO + }); + + // Bottom-right X coordinate (normalized 0–1) + // double x3 + test('to test the property `x3`', () async { + // TODO + }); + + // Bottom-left X coordinate (normalized 0–1) + // double x4 + test('to test the property `x4`', () async { + // TODO + }); + + // Top-left Y coordinate (normalized 0–1) + // double y1 + test('to test the property `y1`', () async { + // TODO + }); + + // Top-right Y coordinate (normalized 0–1) + // double y2 + test('to test the property `y2`', () async { + // TODO + }); + + // Bottom-right Y coordinate (normalized 0–1) + // double y3 + test('to test the property `y3`', () async { + // TODO + }); + + // Bottom-left Y coordinate (normalized 0–1) + // double y4 + test('to test the property `y4`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_v1_test.dart b/mobile/openapi/test/sync_asset_v1_test.dart new file mode 100644 index 0000000000000..5c22a0af81a0c --- /dev/null +++ b/mobile/openapi/test/sync_asset_v1_test.dart @@ -0,0 +1,140 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetV1 +void main() { + // final instance = SyncAssetV1(); + + group('test SyncAssetV1', () { + // Checksum + // String checksum + test('to test the property `checksum`', () async { + // TODO + }); + + // Uploaded to Immich at + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Deleted at + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // Duration + // String duration + test('to test the property `duration`', () async { + // TODO + }); + + // File created at + // DateTime fileCreatedAt + test('to test the property `fileCreatedAt`', () async { + // TODO + }); + + // File modified at + // DateTime fileModifiedAt + test('to test the property `fileModifiedAt`', () async { + // TODO + }); + + // Asset height + // int height + test('to test the property `height`', () async { + // TODO + }); + + // Asset ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is edited + // bool isEdited + test('to test the property `isEdited`', () async { + // TODO + }); + + // Is favorite + // bool isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Library ID + // String libraryId + test('to test the property `libraryId`', () async { + // TODO + }); + + // Live photo video ID + // String livePhotoVideoId + test('to test the property `livePhotoVideoId`', () async { + // TODO + }); + + // Local date time + // DateTime localDateTime + test('to test the property `localDateTime`', () async { + // TODO + }); + + // Original file name + // String originalFileName + test('to test the property `originalFileName`', () async { + // TODO + }); + + // Owner ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Stack ID + // String stackId + test('to test the property `stackId`', () async { + // TODO + }); + + // Thumbhash + // String thumbhash + test('to test the property `thumbhash`', () async { + // TODO + }); + + // AssetTypeEnum type + test('to test the property `type`', () async { + // TODO + }); + + // AssetVisibility visibility + test('to test the property `visibility`', () async { + // TODO + }); + + // Asset width + // int width + test('to test the property `width`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_asset_v2_test.dart b/mobile/openapi/test/sync_asset_v2_test.dart new file mode 100644 index 0000000000000..eac785987134c --- /dev/null +++ b/mobile/openapi/test/sync_asset_v2_test.dart @@ -0,0 +1,140 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAssetV2 +void main() { + // final instance = SyncAssetV2(); + + group('test SyncAssetV2', () { + // Checksum + // String checksum + test('to test the property `checksum`', () async { + // TODO + }); + + // Uploaded to Immich at + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Deleted at + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // Duration + // int duration + test('to test the property `duration`', () async { + // TODO + }); + + // File created at + // DateTime fileCreatedAt + test('to test the property `fileCreatedAt`', () async { + // TODO + }); + + // File modified at + // DateTime fileModifiedAt + test('to test the property `fileModifiedAt`', () async { + // TODO + }); + + // Asset height + // int height + test('to test the property `height`', () async { + // TODO + }); + + // Asset ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is edited + // bool isEdited + test('to test the property `isEdited`', () async { + // TODO + }); + + // Is favorite + // bool isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Library ID + // String libraryId + test('to test the property `libraryId`', () async { + // TODO + }); + + // Live photo video ID + // String livePhotoVideoId + test('to test the property `livePhotoVideoId`', () async { + // TODO + }); + + // Local date time + // DateTime localDateTime + test('to test the property `localDateTime`', () async { + // TODO + }); + + // Original file name + // String originalFileName + test('to test the property `originalFileName`', () async { + // TODO + }); + + // Owner ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Stack ID + // String stackId + test('to test the property `stackId`', () async { + // TODO + }); + + // Thumbhash + // String thumbhash + test('to test the property `thumbhash`', () async { + // TODO + }); + + // AssetTypeEnum type + test('to test the property `type`', () async { + // TODO + }); + + // AssetVisibility visibility + test('to test the property `visibility`', () async { + // TODO + }); + + // Asset width + // int width + test('to test the property `width`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_auth_user_v1_test.dart b/mobile/openapi/test/sync_auth_user_v1_test.dart new file mode 100644 index 0000000000000..a58824be11f8f --- /dev/null +++ b/mobile/openapi/test/sync_auth_user_v1_test.dart @@ -0,0 +1,99 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncAuthUserV1 +void main() { + // final instance = SyncAuthUserV1(); + + group('test SyncAuthUserV1', () { + // Optional avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // User deleted at + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // User has profile image + // bool hasProfileImage + test('to test the property `hasProfileImage`', () async { + // TODO + }); + + // User ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // User is admin + // bool isAdmin + test('to test the property `isAdmin`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // User OAuth ID + // String oauthId + test('to test the property `oauthId`', () async { + // TODO + }); + + // User pin code + // String pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + // User profile changed at + // DateTime profileChangedAt + test('to test the property `profileChangedAt`', () async { + // TODO + }); + + // Quota size in bytes + // int quotaSizeInBytes + test('to test the property `quotaSizeInBytes`', () async { + // TODO + }); + + // Quota usage in bytes + // int quotaUsageInBytes + test('to test the property `quotaUsageInBytes`', () async { + // TODO + }); + + // User storage label + // String storageLabel + test('to test the property `storageLabel`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_entity_type_test.dart b/mobile/openapi/test/sync_entity_type_test.dart new file mode 100644 index 0000000000000..c7de65dbdd30a --- /dev/null +++ b/mobile/openapi/test/sync_entity_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncEntityType +void main() { + + group('test SyncEntityType', () { + + }); + +} diff --git a/mobile/openapi/test/sync_memory_asset_delete_v1_test.dart b/mobile/openapi/test/sync_memory_asset_delete_v1_test.dart new file mode 100644 index 0000000000000..d0d2fc3eb69c6 --- /dev/null +++ b/mobile/openapi/test/sync_memory_asset_delete_v1_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncMemoryAssetDeleteV1 +void main() { + // final instance = SyncMemoryAssetDeleteV1(); + + group('test SyncMemoryAssetDeleteV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Memory ID + // String memoryId + test('to test the property `memoryId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_memory_asset_v1_test.dart b/mobile/openapi/test/sync_memory_asset_v1_test.dart new file mode 100644 index 0000000000000..dd318e5b57fbe --- /dev/null +++ b/mobile/openapi/test/sync_memory_asset_v1_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncMemoryAssetV1 +void main() { + // final instance = SyncMemoryAssetV1(); + + group('test SyncMemoryAssetV1', () { + // Asset ID + // String assetId + test('to test the property `assetId`', () async { + // TODO + }); + + // Memory ID + // String memoryId + test('to test the property `memoryId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_memory_delete_v1_test.dart b/mobile/openapi/test/sync_memory_delete_v1_test.dart new file mode 100644 index 0000000000000..ee0e3be9ccd97 --- /dev/null +++ b/mobile/openapi/test/sync_memory_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncMemoryDeleteV1 +void main() { + // final instance = SyncMemoryDeleteV1(); + + group('test SyncMemoryDeleteV1', () { + // Memory ID + // String memoryId + test('to test the property `memoryId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_memory_v1_test.dart b/mobile/openapi/test/sync_memory_v1_test.dart new file mode 100644 index 0000000000000..13dd3d01aaaa5 --- /dev/null +++ b/mobile/openapi/test/sync_memory_v1_test.dart @@ -0,0 +1,93 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncMemoryV1 +void main() { + // final instance = SyncMemoryV1(); + + group('test SyncMemoryV1', () { + // Created at + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Data + // Map data (default value: const {}) + test('to test the property `data`', () async { + // TODO + }); + + // Deleted at + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // Hide at + // DateTime hideAt + test('to test the property `hideAt`', () async { + // TODO + }); + + // Memory ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is saved + // bool isSaved + test('to test the property `isSaved`', () async { + // TODO + }); + + // Memory at + // DateTime memoryAt + test('to test the property `memoryAt`', () async { + // TODO + }); + + // Owner ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Seen at + // DateTime seenAt + test('to test the property `seenAt`', () async { + // TODO + }); + + // Show at + // DateTime showAt + test('to test the property `showAt`', () async { + // TODO + }); + + // MemoryType type + test('to test the property `type`', () async { + // TODO + }); + + // Updated at + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_partner_delete_v1_test.dart b/mobile/openapi/test/sync_partner_delete_v1_test.dart new file mode 100644 index 0000000000000..3b290c6ca44ab --- /dev/null +++ b/mobile/openapi/test/sync_partner_delete_v1_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncPartnerDeleteV1 +void main() { + // final instance = SyncPartnerDeleteV1(); + + group('test SyncPartnerDeleteV1', () { + // Shared by ID + // String sharedById + test('to test the property `sharedById`', () async { + // TODO + }); + + // Shared with ID + // String sharedWithId + test('to test the property `sharedWithId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_partner_v1_test.dart b/mobile/openapi/test/sync_partner_v1_test.dart new file mode 100644 index 0000000000000..1d1df4c23a6cd --- /dev/null +++ b/mobile/openapi/test/sync_partner_v1_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncPartnerV1 +void main() { + // final instance = SyncPartnerV1(); + + group('test SyncPartnerV1', () { + // In timeline + // bool inTimeline + test('to test the property `inTimeline`', () async { + // TODO + }); + + // Shared by ID + // String sharedById + test('to test the property `sharedById`', () async { + // TODO + }); + + // Shared with ID + // String sharedWithId + test('to test the property `sharedWithId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_person_delete_v1_test.dart b/mobile/openapi/test/sync_person_delete_v1_test.dart new file mode 100644 index 0000000000000..eb0aa06d9e24f --- /dev/null +++ b/mobile/openapi/test/sync_person_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncPersonDeleteV1 +void main() { + // final instance = SyncPersonDeleteV1(); + + group('test SyncPersonDeleteV1', () { + // Person ID + // String personId + test('to test the property `personId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_person_v1_test.dart b/mobile/openapi/test/sync_person_v1_test.dart new file mode 100644 index 0000000000000..97c7d0f622d69 --- /dev/null +++ b/mobile/openapi/test/sync_person_v1_test.dart @@ -0,0 +1,82 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncPersonV1 +void main() { + // final instance = SyncPersonV1(); + + group('test SyncPersonV1', () { + // Birth date + // DateTime birthDate + test('to test the property `birthDate`', () async { + // TODO + }); + + // Color + // String color + test('to test the property `color`', () async { + // TODO + }); + + // Created at + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Face asset ID + // String faceAssetId + test('to test the property `faceAssetId`', () async { + // TODO + }); + + // Person ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is favorite + // bool isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Is hidden + // bool isHidden + test('to test the property `isHidden`', () async { + // TODO + }); + + // Person name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Owner ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Updated at + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_request_type_test.dart b/mobile/openapi/test/sync_request_type_test.dart new file mode 100644 index 0000000000000..ce7796075ecbf --- /dev/null +++ b/mobile/openapi/test/sync_request_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncRequestType +void main() { + + group('test SyncRequestType', () { + + }); + +} diff --git a/mobile/openapi/test/sync_stack_delete_v1_test.dart b/mobile/openapi/test/sync_stack_delete_v1_test.dart new file mode 100644 index 0000000000000..074753c0e30c9 --- /dev/null +++ b/mobile/openapi/test/sync_stack_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncStackDeleteV1 +void main() { + // final instance = SyncStackDeleteV1(); + + group('test SyncStackDeleteV1', () { + // Stack ID + // String stackId + test('to test the property `stackId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_stack_v1_test.dart b/mobile/openapi/test/sync_stack_v1_test.dart new file mode 100644 index 0000000000000..aea956a7b06cb --- /dev/null +++ b/mobile/openapi/test/sync_stack_v1_test.dart @@ -0,0 +1,52 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncStackV1 +void main() { + // final instance = SyncStackV1(); + + group('test SyncStackV1', () { + // Created at + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Stack ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Owner ID + // String ownerId + test('to test the property `ownerId`', () async { + // TODO + }); + + // Primary asset ID + // String primaryAssetId + test('to test the property `primaryAssetId`', () async { + // TODO + }); + + // Updated at + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_stream_dto_test.dart b/mobile/openapi/test/sync_stream_dto_test.dart new file mode 100644 index 0000000000000..3fb939743d9e9 --- /dev/null +++ b/mobile/openapi/test/sync_stream_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncStreamDto +void main() { + // final instance = SyncStreamDto(); + + group('test SyncStreamDto', () { + // Reset sync state + // Optional reset + test('to test the property `reset`', () async { + // TODO + }); + + // Sync request types + // List types (default value: const []) + test('to test the property `types`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_user_delete_v1_test.dart b/mobile/openapi/test/sync_user_delete_v1_test.dart new file mode 100644 index 0000000000000..f42379e1a1fcd --- /dev/null +++ b/mobile/openapi/test/sync_user_delete_v1_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncUserDeleteV1 +void main() { + // final instance = SyncUserDeleteV1(); + + group('test SyncUserDeleteV1', () { + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_user_metadata_delete_v1_test.dart b/mobile/openapi/test/sync_user_metadata_delete_v1_test.dart new file mode 100644 index 0000000000000..a512f17a3933f --- /dev/null +++ b/mobile/openapi/test/sync_user_metadata_delete_v1_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncUserMetadataDeleteV1 +void main() { + // final instance = SyncUserMetadataDeleteV1(); + + group('test SyncUserMetadataDeleteV1', () { + // UserMetadataKey key + test('to test the property `key`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_user_metadata_v1_test.dart b/mobile/openapi/test/sync_user_metadata_v1_test.dart new file mode 100644 index 0000000000000..c275c0662053f --- /dev/null +++ b/mobile/openapi/test/sync_user_metadata_v1_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncUserMetadataV1 +void main() { + // final instance = SyncUserMetadataV1(); + + group('test SyncUserMetadataV1', () { + // UserMetadataKey key + test('to test the property `key`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + // User metadata value + // Map value (default value: const {}) + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/sync_user_v1_test.dart b/mobile/openapi/test/sync_user_v1_test.dart new file mode 100644 index 0000000000000..48019861d3a1d --- /dev/null +++ b/mobile/openapi/test/sync_user_v1_test.dart @@ -0,0 +1,63 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SyncUserV1 +void main() { + // final instance = SyncUserV1(); + + group('test SyncUserV1', () { + // Optional avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // User deleted at + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // User has profile image + // bool hasProfileImage + test('to test the property `hasProfileImage`', () async { + // TODO + }); + + // User ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // User profile changed at + // DateTime profileChangedAt + test('to test the property `profileChangedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_api_test.dart b/mobile/openapi/test/system_config_api_test.dart new file mode 100644 index 0000000000000..3da67247fb739 --- /dev/null +++ b/mobile/openapi/test/system_config_api_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for SystemConfigApi +void main() { + // final instance = SystemConfigApi(); + + group('tests for SystemConfigApi', () { + // Get system configuration + // + // Retrieve the current system configuration. + // + //Future getConfig() async + test('test getConfig', () async { + // TODO + }); + + // Get system configuration defaults + // + // Retrieve the default values for the system configuration. + // + //Future getConfigDefaults() async + test('test getConfigDefaults', () async { + // TODO + }); + + // Get storage template options + // + // Retrieve exemplary storage template options. + // + //Future getStorageTemplateOptions() async + test('test getStorageTemplateOptions', () async { + // TODO + }); + + // Update system configuration + // + // Update the system configuration with a new system configuration. + // + //Future updateConfig(SystemConfigDto systemConfigDto) async + test('test updateConfig', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/system_config_backups_dto_test.dart b/mobile/openapi/test/system_config_backups_dto_test.dart new file mode 100644 index 0000000000000..2c61acbd87031 --- /dev/null +++ b/mobile/openapi/test/system_config_backups_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigBackupsDto +void main() { + // final instance = SystemConfigBackupsDto(); + + group('test SystemConfigBackupsDto', () { + // Whether the backups feature is enabled + // bool beta + test('to test the property `beta`', () async { + // TODO + }); + + // DatabaseBackupConfig database + test('to test the property `database`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_dto_test.dart b/mobile/openapi/test/system_config_dto_test.dart new file mode 100644 index 0000000000000..b7afcaf10caab --- /dev/null +++ b/mobile/openapi/test/system_config_dto_test.dart @@ -0,0 +1,132 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigDto +void main() { + // final instance = SystemConfigDto(); + + group('test SystemConfigDto', () { + // SystemConfigBackupsDto backup + test('to test the property `backup`', () async { + // TODO + }); + + // SystemConfigFFmpegDto ffmpeg + test('to test the property `ffmpeg`', () async { + // TODO + }); + + // SystemConfigImageDto image + test('to test the property `image`', () async { + // TODO + }); + + // SystemConfigIntegrityChecks integrityChecks + test('to test the property `integrityChecks`', () async { + // TODO + }); + + // SystemConfigJobDto job + test('to test the property `job`', () async { + // TODO + }); + + // SystemConfigLibraryDto library_ + test('to test the property `library_`', () async { + // TODO + }); + + // SystemConfigLoggingDto logging + test('to test the property `logging`', () async { + // TODO + }); + + // SystemConfigMachineLearningDto machineLearning + test('to test the property `machineLearning`', () async { + // TODO + }); + + // SystemConfigMapDto map + test('to test the property `map`', () async { + // TODO + }); + + // SystemConfigMetadataDto metadata + test('to test the property `metadata`', () async { + // TODO + }); + + // SystemConfigNewVersionCheckDto newVersionCheck + test('to test the property `newVersionCheck`', () async { + // TODO + }); + + // SystemConfigNightlyTasksDto nightlyTasks + test('to test the property `nightlyTasks`', () async { + // TODO + }); + + // SystemConfigNotificationsDto notifications + test('to test the property `notifications`', () async { + // TODO + }); + + // SystemConfigOAuthDto oauth + test('to test the property `oauth`', () async { + // TODO + }); + + // SystemConfigPasswordLoginDto passwordLogin + test('to test the property `passwordLogin`', () async { + // TODO + }); + + // SystemConfigReverseGeocodingDto reverseGeocoding + test('to test the property `reverseGeocoding`', () async { + // TODO + }); + + // SystemConfigServerDto server + test('to test the property `server`', () async { + // TODO + }); + + // SystemConfigStorageTemplateDto storageTemplate + test('to test the property `storageTemplate`', () async { + // TODO + }); + + // SystemConfigTemplatesDto templates + test('to test the property `templates`', () async { + // TODO + }); + + // SystemConfigThemeDto theme + test('to test the property `theme`', () async { + // TODO + }); + + // SystemConfigTrashDto trash + test('to test the property `trash`', () async { + // TODO + }); + + // SystemConfigUserDto user + test('to test the property `user`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_f_fmpeg_dto_test.dart b/mobile/openapi/test/system_config_f_fmpeg_dto_test.dart new file mode 100644 index 0000000000000..5f399a319f0be --- /dev/null +++ b/mobile/openapi/test/system_config_f_fmpeg_dto_test.dart @@ -0,0 +1,147 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigFFmpegDto +void main() { + // final instance = SystemConfigFFmpegDto(); + + group('test SystemConfigFFmpegDto', () { + // TranscodeHWAccel accel + test('to test the property `accel`', () async { + // TODO + }); + + // Accelerated decode + // bool accelDecode + test('to test the property `accelDecode`', () async { + // TODO + }); + + // Accepted audio codecs + // List acceptedAudioCodecs (default value: const []) + test('to test the property `acceptedAudioCodecs`', () async { + // TODO + }); + + // Accepted containers + // List acceptedContainers (default value: const []) + test('to test the property `acceptedContainers`', () async { + // TODO + }); + + // Accepted video codecs + // List acceptedVideoCodecs (default value: const []) + test('to test the property `acceptedVideoCodecs`', () async { + // TODO + }); + + // B-frames + // int bframes + test('to test the property `bframes`', () async { + // TODO + }); + + // CQMode cqMode + test('to test the property `cqMode`', () async { + // TODO + }); + + // CRF + // int crf + test('to test the property `crf`', () async { + // TODO + }); + + // GOP size + // int gopSize + test('to test the property `gopSize`', () async { + // TODO + }); + + // Max bitrate + // String maxBitrate + test('to test the property `maxBitrate`', () async { + // TODO + }); + + // Preferred hardware device + // String preferredHwDevice + test('to test the property `preferredHwDevice`', () async { + // TODO + }); + + // Preset + // String preset + test('to test the property `preset`', () async { + // TODO + }); + + // SystemConfigFFmpegRealtimeDto realtime + test('to test the property `realtime`', () async { + // TODO + }); + + // References + // int refs + test('to test the property `refs`', () async { + // TODO + }); + + // AudioCodec targetAudioCodec + test('to test the property `targetAudioCodec`', () async { + // TODO + }); + + // Target resolution + // String targetResolution + test('to test the property `targetResolution`', () async { + // TODO + }); + + // VideoCodec targetVideoCodec + test('to test the property `targetVideoCodec`', () async { + // TODO + }); + + // Temporal AQ + // bool temporalAQ + test('to test the property `temporalAQ`', () async { + // TODO + }); + + // Threads + // int threads + test('to test the property `threads`', () async { + // TODO + }); + + // ToneMapping tonemap + test('to test the property `tonemap`', () async { + // TODO + }); + + // TranscodePolicy transcode + test('to test the property `transcode`', () async { + // TODO + }); + + // Two pass + // bool twoPass + test('to test the property `twoPass`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_f_fmpeg_realtime_dto_test.dart b/mobile/openapi/test/system_config_f_fmpeg_realtime_dto_test.dart new file mode 100644 index 0000000000000..c16685ab04a6a --- /dev/null +++ b/mobile/openapi/test/system_config_f_fmpeg_realtime_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigFFmpegRealtimeDto +void main() { + // final instance = SystemConfigFFmpegRealtimeDto(); + + group('test SystemConfigFFmpegRealtimeDto', () { + // Enable real-time HLS transcoding (alpha) + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Resolutions to use for real-time HLS transcoding + // List resolutions (default value: const []) + test('to test the property `resolutions`', () async { + // TODO + }); + + // Video codecs to use for real-time HLS transcoding + // List videoCodecs (default value: const []) + test('to test the property `videoCodecs`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_faces_dto_test.dart b/mobile/openapi/test/system_config_faces_dto_test.dart new file mode 100644 index 0000000000000..6778e1748a32d --- /dev/null +++ b/mobile/openapi/test/system_config_faces_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigFacesDto +void main() { + // final instance = SystemConfigFacesDto(); + + group('test SystemConfigFacesDto', () { + // Import + // bool import_ + test('to test the property `import_`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_generated_fullsize_image_dto_test.dart b/mobile/openapi/test/system_config_generated_fullsize_image_dto_test.dart new file mode 100644 index 0000000000000..09803dbcd3fd6 --- /dev/null +++ b/mobile/openapi/test/system_config_generated_fullsize_image_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigGeneratedFullsizeImageDto +void main() { + // final instance = SystemConfigGeneratedFullsizeImageDto(); + + group('test SystemConfigGeneratedFullsizeImageDto', () { + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // ImageFormat format + test('to test the property `format`', () async { + // TODO + }); + + // Progressive + // Optional progressive + test('to test the property `progressive`', () async { + // TODO + }); + + // Quality + // int quality + test('to test the property `quality`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_generated_image_dto_test.dart b/mobile/openapi/test/system_config_generated_image_dto_test.dart new file mode 100644 index 0000000000000..71687a7860ae0 --- /dev/null +++ b/mobile/openapi/test/system_config_generated_image_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigGeneratedImageDto +void main() { + // final instance = SystemConfigGeneratedImageDto(); + + group('test SystemConfigGeneratedImageDto', () { + // ImageFormat format + test('to test the property `format`', () async { + // TODO + }); + + // Progressive + // Optional progressive + test('to test the property `progressive`', () async { + // TODO + }); + + // Quality + // int quality + test('to test the property `quality`', () async { + // TODO + }); + + // Size + // int size + test('to test the property `size`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_image_dto_test.dart b/mobile/openapi/test/system_config_image_dto_test.dart new file mode 100644 index 0000000000000..2c3bd2128b18a --- /dev/null +++ b/mobile/openapi/test/system_config_image_dto_test.dart @@ -0,0 +1,48 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigImageDto +void main() { + // final instance = SystemConfigImageDto(); + + group('test SystemConfigImageDto', () { + // Colorspace colorspace + test('to test the property `colorspace`', () async { + // TODO + }); + + // Extract embedded + // bool extractEmbedded + test('to test the property `extractEmbedded`', () async { + // TODO + }); + + // SystemConfigGeneratedFullsizeImageDto fullsize + test('to test the property `fullsize`', () async { + // TODO + }); + + // SystemConfigGeneratedImageDto preview + test('to test the property `preview`', () async { + // TODO + }); + + // SystemConfigGeneratedImageDto thumbnail + test('to test the property `thumbnail`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_integrity_checks_test.dart b/mobile/openapi/test/system_config_integrity_checks_test.dart new file mode 100644 index 0000000000000..511c952e55533 --- /dev/null +++ b/mobile/openapi/test/system_config_integrity_checks_test.dart @@ -0,0 +1,37 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigIntegrityChecks +void main() { + // final instance = SystemConfigIntegrityChecks(); + + group('test SystemConfigIntegrityChecks', () { + // SystemConfigIntegrityChecksumJob checksumFiles + test('to test the property `checksumFiles`', () async { + // TODO + }); + + // SystemConfigIntegrityJob missingFiles + test('to test the property `missingFiles`', () async { + // TODO + }); + + // SystemConfigIntegrityJob untrackedFiles + test('to test the property `untrackedFiles`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_integrity_checksum_job_test.dart b/mobile/openapi/test/system_config_integrity_checksum_job_test.dart new file mode 100644 index 0000000000000..99fcb029b3f9e --- /dev/null +++ b/mobile/openapi/test/system_config_integrity_checksum_job_test.dart @@ -0,0 +1,46 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigIntegrityChecksumJob +void main() { + // final instance = SystemConfigIntegrityChecksumJob(); + + group('test SystemConfigIntegrityChecksumJob', () { + // Cron expression for when the integrity check should run + // String cronExpression + test('to test the property `cronExpression`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Percentage limit of the integrity checksum job + // double percentageLimit + test('to test the property `percentageLimit`', () async { + // TODO + }); + + // How long the integrity checksum job may run for + // int timeLimit + test('to test the property `timeLimit`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_integrity_job_test.dart b/mobile/openapi/test/system_config_integrity_job_test.dart new file mode 100644 index 0000000000000..e20431e525937 --- /dev/null +++ b/mobile/openapi/test/system_config_integrity_job_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigIntegrityJob +void main() { + // final instance = SystemConfigIntegrityJob(); + + group('test SystemConfigIntegrityJob', () { + // Cron expression for when the integrity check should run + // String cronExpression + test('to test the property `cronExpression`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_job_dto_test.dart b/mobile/openapi/test/system_config_job_dto_test.dart new file mode 100644 index 0000000000000..30e1a7ffa43d1 --- /dev/null +++ b/mobile/openapi/test/system_config_job_dto_test.dart @@ -0,0 +1,97 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigJobDto +void main() { + // final instance = SystemConfigJobDto(); + + group('test SystemConfigJobDto', () { + // JobSettingsDto backgroundTask + test('to test the property `backgroundTask`', () async { + // TODO + }); + + // JobSettingsDto editor + test('to test the property `editor`', () async { + // TODO + }); + + // JobSettingsDto faceDetection + test('to test the property `faceDetection`', () async { + // TODO + }); + + // JobSettingsDto integrityCheck + test('to test the property `integrityCheck`', () async { + // TODO + }); + + // JobSettingsDto library_ + test('to test the property `library_`', () async { + // TODO + }); + + // JobSettingsDto metadataExtraction + test('to test the property `metadataExtraction`', () async { + // TODO + }); + + // JobSettingsDto migration + test('to test the property `migration`', () async { + // TODO + }); + + // JobSettingsDto notifications + test('to test the property `notifications`', () async { + // TODO + }); + + // JobSettingsDto ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // JobSettingsDto search + test('to test the property `search`', () async { + // TODO + }); + + // JobSettingsDto sidecar + test('to test the property `sidecar`', () async { + // TODO + }); + + // JobSettingsDto smartSearch + test('to test the property `smartSearch`', () async { + // TODO + }); + + // JobSettingsDto thumbnailGeneration + test('to test the property `thumbnailGeneration`', () async { + // TODO + }); + + // JobSettingsDto videoConversion + test('to test the property `videoConversion`', () async { + // TODO + }); + + // JobSettingsDto workflow + test('to test the property `workflow`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_library_dto_test.dart b/mobile/openapi/test/system_config_library_dto_test.dart new file mode 100644 index 0000000000000..9f92a4e0c984c --- /dev/null +++ b/mobile/openapi/test/system_config_library_dto_test.dart @@ -0,0 +1,32 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigLibraryDto +void main() { + // final instance = SystemConfigLibraryDto(); + + group('test SystemConfigLibraryDto', () { + // SystemConfigLibraryScanDto scan + test('to test the property `scan`', () async { + // TODO + }); + + // SystemConfigLibraryWatchDto watch + test('to test the property `watch`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_library_scan_dto_test.dart b/mobile/openapi/test/system_config_library_scan_dto_test.dart new file mode 100644 index 0000000000000..4ae9a4d7223e7 --- /dev/null +++ b/mobile/openapi/test/system_config_library_scan_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigLibraryScanDto +void main() { + // final instance = SystemConfigLibraryScanDto(); + + group('test SystemConfigLibraryScanDto', () { + // Cron expression + // String cronExpression + test('to test the property `cronExpression`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_library_watch_dto_test.dart b/mobile/openapi/test/system_config_library_watch_dto_test.dart new file mode 100644 index 0000000000000..e20bcca95fcfc --- /dev/null +++ b/mobile/openapi/test/system_config_library_watch_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigLibraryWatchDto +void main() { + // final instance = SystemConfigLibraryWatchDto(); + + group('test SystemConfigLibraryWatchDto', () { + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_logging_dto_test.dart b/mobile/openapi/test/system_config_logging_dto_test.dart new file mode 100644 index 0000000000000..34bd466721bfd --- /dev/null +++ b/mobile/openapi/test/system_config_logging_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigLoggingDto +void main() { + // final instance = SystemConfigLoggingDto(); + + group('test SystemConfigLoggingDto', () { + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // LogLevel level + test('to test the property `level`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_machine_learning_dto_test.dart b/mobile/openapi/test/system_config_machine_learning_dto_test.dart new file mode 100644 index 0000000000000..3cfe9088a4017 --- /dev/null +++ b/mobile/openapi/test/system_config_machine_learning_dto_test.dart @@ -0,0 +1,59 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigMachineLearningDto +void main() { + // final instance = SystemConfigMachineLearningDto(); + + group('test SystemConfigMachineLearningDto', () { + // MachineLearningAvailabilityChecksDto availabilityChecks + test('to test the property `availabilityChecks`', () async { + // TODO + }); + + // CLIPConfig clip + test('to test the property `clip`', () async { + // TODO + }); + + // DuplicateDetectionConfig duplicateDetection + test('to test the property `duplicateDetection`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // FacialRecognitionConfig facialRecognition + test('to test the property `facialRecognition`', () async { + // TODO + }); + + // OcrConfig ocr + test('to test the property `ocr`', () async { + // TODO + }); + + // ML service URLs + // List urls (default value: const []) + test('to test the property `urls`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_map_dto_test.dart b/mobile/openapi/test/system_config_map_dto_test.dart new file mode 100644 index 0000000000000..e117605bbb28f --- /dev/null +++ b/mobile/openapi/test/system_config_map_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigMapDto +void main() { + // final instance = SystemConfigMapDto(); + + group('test SystemConfigMapDto', () { + // Dark map style URL + // String darkStyle + test('to test the property `darkStyle`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Light map style URL + // String lightStyle + test('to test the property `lightStyle`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_metadata_dto_test.dart b/mobile/openapi/test/system_config_metadata_dto_test.dart new file mode 100644 index 0000000000000..237003f69d328 --- /dev/null +++ b/mobile/openapi/test/system_config_metadata_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigMetadataDto +void main() { + // final instance = SystemConfigMetadataDto(); + + group('test SystemConfigMetadataDto', () { + // SystemConfigFacesDto faces + test('to test the property `faces`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_new_version_check_dto_test.dart b/mobile/openapi/test/system_config_new_version_check_dto_test.dart new file mode 100644 index 0000000000000..52343b084d75d --- /dev/null +++ b/mobile/openapi/test/system_config_new_version_check_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigNewVersionCheckDto +void main() { + // final instance = SystemConfigNewVersionCheckDto(); + + group('test SystemConfigNewVersionCheckDto', () { + // ReleaseChannel channel + test('to test the property `channel`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_nightly_tasks_dto_test.dart b/mobile/openapi/test/system_config_nightly_tasks_dto_test.dart new file mode 100644 index 0000000000000..7a845d07053f6 --- /dev/null +++ b/mobile/openapi/test/system_config_nightly_tasks_dto_test.dart @@ -0,0 +1,58 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigNightlyTasksDto +void main() { + // final instance = SystemConfigNightlyTasksDto(); + + group('test SystemConfigNightlyTasksDto', () { + // Cluster new faces + // bool clusterNewFaces + test('to test the property `clusterNewFaces`', () async { + // TODO + }); + + // Database cleanup + // bool databaseCleanup + test('to test the property `databaseCleanup`', () async { + // TODO + }); + + // Generate memories + // bool generateMemories + test('to test the property `generateMemories`', () async { + // TODO + }); + + // Missing thumbnails + // bool missingThumbnails + test('to test the property `missingThumbnails`', () async { + // TODO + }); + + // Start time (HH:MM) + // String startTime + test('to test the property `startTime`', () async { + // TODO + }); + + // Sync quota usage + // bool syncQuotaUsage + test('to test the property `syncQuotaUsage`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_notifications_dto_test.dart b/mobile/openapi/test/system_config_notifications_dto_test.dart new file mode 100644 index 0000000000000..01d0acd4b901d --- /dev/null +++ b/mobile/openapi/test/system_config_notifications_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigNotificationsDto +void main() { + // final instance = SystemConfigNotificationsDto(); + + group('test SystemConfigNotificationsDto', () { + // SystemConfigSmtpDto smtp + test('to test the property `smtp`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_o_auth_dto_test.dart b/mobile/openapi/test/system_config_o_auth_dto_test.dart new file mode 100644 index 0000000000000..be7519589d975 --- /dev/null +++ b/mobile/openapi/test/system_config_o_auth_dto_test.dart @@ -0,0 +1,147 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigOAuthDto +void main() { + // final instance = SystemConfigOAuthDto(); + + group('test SystemConfigOAuthDto', () { + // Allow insecure requests + // bool allowInsecureRequests + test('to test the property `allowInsecureRequests`', () async { + // TODO + }); + + // Auto launch + // bool autoLaunch + test('to test the property `autoLaunch`', () async { + // TODO + }); + + // Auto register + // bool autoRegister + test('to test the property `autoRegister`', () async { + // TODO + }); + + // Button text + // String buttonText + test('to test the property `buttonText`', () async { + // TODO + }); + + // Client ID + // String clientId + test('to test the property `clientId`', () async { + // TODO + }); + + // Client secret + // String clientSecret + test('to test the property `clientSecret`', () async { + // TODO + }); + + // Default storage quota + // int defaultStorageQuota + test('to test the property `defaultStorageQuota`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // End session endpoint + // String endSessionEndpoint + test('to test the property `endSessionEndpoint`', () async { + // TODO + }); + + // Issuer URL + // String issuerUrl + test('to test the property `issuerUrl`', () async { + // TODO + }); + + // Mobile override enabled + // bool mobileOverrideEnabled + test('to test the property `mobileOverrideEnabled`', () async { + // TODO + }); + + // Mobile redirect URI (set to empty string to disable) + // String mobileRedirectUri + test('to test the property `mobileRedirectUri`', () async { + // TODO + }); + + // Profile signing algorithm + // String profileSigningAlgorithm + test('to test the property `profileSigningAlgorithm`', () async { + // TODO + }); + + // OAuth prompt parameter (e.g. select_account, login, consent) + // String prompt + test('to test the property `prompt`', () async { + // TODO + }); + + // Role claim + // String roleClaim + test('to test the property `roleClaim`', () async { + // TODO + }); + + // Scope + // String scope + test('to test the property `scope`', () async { + // TODO + }); + + // Signing algorithm + // String signingAlgorithm + test('to test the property `signingAlgorithm`', () async { + // TODO + }); + + // Storage label claim + // String storageLabelClaim + test('to test the property `storageLabelClaim`', () async { + // TODO + }); + + // Storage quota claim + // String storageQuotaClaim + test('to test the property `storageQuotaClaim`', () async { + // TODO + }); + + // Timeout + // int timeout + test('to test the property `timeout`', () async { + // TODO + }); + + // OAuthTokenEndpointAuthMethod tokenEndpointAuthMethod + test('to test the property `tokenEndpointAuthMethod`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_password_login_dto_test.dart b/mobile/openapi/test/system_config_password_login_dto_test.dart new file mode 100644 index 0000000000000..9a629e22099b2 --- /dev/null +++ b/mobile/openapi/test/system_config_password_login_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigPasswordLoginDto +void main() { + // final instance = SystemConfigPasswordLoginDto(); + + group('test SystemConfigPasswordLoginDto', () { + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_reverse_geocoding_dto_test.dart b/mobile/openapi/test/system_config_reverse_geocoding_dto_test.dart new file mode 100644 index 0000000000000..308727fe056aa --- /dev/null +++ b/mobile/openapi/test/system_config_reverse_geocoding_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigReverseGeocodingDto +void main() { + // final instance = SystemConfigReverseGeocodingDto(); + + group('test SystemConfigReverseGeocodingDto', () { + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_server_dto_test.dart b/mobile/openapi/test/system_config_server_dto_test.dart new file mode 100644 index 0000000000000..f33f9fe77b8f1 --- /dev/null +++ b/mobile/openapi/test/system_config_server_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigServerDto +void main() { + // final instance = SystemConfigServerDto(); + + group('test SystemConfigServerDto', () { + // External domain + // String externalDomain + test('to test the property `externalDomain`', () async { + // TODO + }); + + // Login page message + // String loginPageMessage + test('to test the property `loginPageMessage`', () async { + // TODO + }); + + // Public users + // bool publicUsers + test('to test the property `publicUsers`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_smtp_dto_test.dart b/mobile/openapi/test/system_config_smtp_dto_test.dart new file mode 100644 index 0000000000000..1898e4a33935b --- /dev/null +++ b/mobile/openapi/test/system_config_smtp_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigSmtpDto +void main() { + // final instance = SystemConfigSmtpDto(); + + group('test SystemConfigSmtpDto', () { + // Whether SMTP email notifications are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Email address to send from + // String from + test('to test the property `from`', () async { + // TODO + }); + + // Email address for replies + // String replyTo + test('to test the property `replyTo`', () async { + // TODO + }); + + // SystemConfigSmtpTransportDto transport + test('to test the property `transport`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_smtp_transport_dto_test.dart b/mobile/openapi/test/system_config_smtp_transport_dto_test.dart new file mode 100644 index 0000000000000..da2fe175a00b3 --- /dev/null +++ b/mobile/openapi/test/system_config_smtp_transport_dto_test.dart @@ -0,0 +1,58 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigSmtpTransportDto +void main() { + // final instance = SystemConfigSmtpTransportDto(); + + group('test SystemConfigSmtpTransportDto', () { + // SMTP server hostname + // String host + test('to test the property `host`', () async { + // TODO + }); + + // Whether to ignore SSL certificate errors + // bool ignoreCert + test('to test the property `ignoreCert`', () async { + // TODO + }); + + // SMTP password + // String password + test('to test the property `password`', () async { + // TODO + }); + + // SMTP server port + // int port + test('to test the property `port`', () async { + // TODO + }); + + // Whether to use secure connection (TLS/SSL) + // bool secure + test('to test the property `secure`', () async { + // TODO + }); + + // SMTP username + // String username + test('to test the property `username`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_storage_template_dto_test.dart b/mobile/openapi/test/system_config_storage_template_dto_test.dart new file mode 100644 index 0000000000000..a269549462e2a --- /dev/null +++ b/mobile/openapi/test/system_config_storage_template_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigStorageTemplateDto +void main() { + // final instance = SystemConfigStorageTemplateDto(); + + group('test SystemConfigStorageTemplateDto', () { + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Hash verification enabled + // bool hashVerificationEnabled + test('to test the property `hashVerificationEnabled`', () async { + // TODO + }); + + // Template + // String template + test('to test the property `template`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_template_emails_dto_test.dart b/mobile/openapi/test/system_config_template_emails_dto_test.dart new file mode 100644 index 0000000000000..01aa2f2160283 --- /dev/null +++ b/mobile/openapi/test/system_config_template_emails_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigTemplateEmailsDto +void main() { + // final instance = SystemConfigTemplateEmailsDto(); + + group('test SystemConfigTemplateEmailsDto', () { + // Album invite template + // String albumInviteTemplate + test('to test the property `albumInviteTemplate`', () async { + // TODO + }); + + // Album update template + // String albumUpdateTemplate + test('to test the property `albumUpdateTemplate`', () async { + // TODO + }); + + // Welcome template + // String welcomeTemplate + test('to test the property `welcomeTemplate`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_template_storage_option_dto_test.dart b/mobile/openapi/test/system_config_template_storage_option_dto_test.dart new file mode 100644 index 0000000000000..c0918606e11d3 --- /dev/null +++ b/mobile/openapi/test/system_config_template_storage_option_dto_test.dart @@ -0,0 +1,70 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigTemplateStorageOptionDto +void main() { + // final instance = SystemConfigTemplateStorageOptionDto(); + + group('test SystemConfigTemplateStorageOptionDto', () { + // Available day format options for storage template + // List dayOptions (default value: const []) + test('to test the property `dayOptions`', () async { + // TODO + }); + + // Available hour format options for storage template + // List hourOptions (default value: const []) + test('to test the property `hourOptions`', () async { + // TODO + }); + + // Available minute format options for storage template + // List minuteOptions (default value: const []) + test('to test the property `minuteOptions`', () async { + // TODO + }); + + // Available month format options for storage template + // List monthOptions (default value: const []) + test('to test the property `monthOptions`', () async { + // TODO + }); + + // Available preset template options + // List presetOptions (default value: const []) + test('to test the property `presetOptions`', () async { + // TODO + }); + + // Available second format options for storage template + // List secondOptions (default value: const []) + test('to test the property `secondOptions`', () async { + // TODO + }); + + // Available week format options for storage template + // List weekOptions (default value: const []) + test('to test the property `weekOptions`', () async { + // TODO + }); + + // Available year format options for storage template + // List yearOptions (default value: const []) + test('to test the property `yearOptions`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_templates_dto_test.dart b/mobile/openapi/test/system_config_templates_dto_test.dart new file mode 100644 index 0000000000000..9efdb914bd6d8 --- /dev/null +++ b/mobile/openapi/test/system_config_templates_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigTemplatesDto +void main() { + // final instance = SystemConfigTemplatesDto(); + + group('test SystemConfigTemplatesDto', () { + // SystemConfigTemplateEmailsDto email + test('to test the property `email`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_theme_dto_test.dart b/mobile/openapi/test/system_config_theme_dto_test.dart new file mode 100644 index 0000000000000..18fad76ccdd23 --- /dev/null +++ b/mobile/openapi/test/system_config_theme_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigThemeDto +void main() { + // final instance = SystemConfigThemeDto(); + + group('test SystemConfigThemeDto', () { + // Custom CSS for theming + // String customCss + test('to test the property `customCss`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_trash_dto_test.dart b/mobile/openapi/test/system_config_trash_dto_test.dart new file mode 100644 index 0000000000000..de2ecc5bbb46f --- /dev/null +++ b/mobile/openapi/test/system_config_trash_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigTrashDto +void main() { + // final instance = SystemConfigTrashDto(); + + group('test SystemConfigTrashDto', () { + // Days + // int days + test('to test the property `days`', () async { + // TODO + }); + + // Enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_config_user_dto_test.dart b/mobile/openapi/test/system_config_user_dto_test.dart new file mode 100644 index 0000000000000..fcbc8b649e55a --- /dev/null +++ b/mobile/openapi/test/system_config_user_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for SystemConfigUserDto +void main() { + // final instance = SystemConfigUserDto(); + + group('test SystemConfigUserDto', () { + // Delete delay + // int deleteDelay + test('to test the property `deleteDelay`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/system_metadata_api_test.dart b/mobile/openapi/test/system_metadata_api_test.dart new file mode 100644 index 0000000000000..ad17103ed1812 --- /dev/null +++ b/mobile/openapi/test/system_metadata_api_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for SystemMetadataApi +void main() { + // final instance = SystemMetadataApi(); + + group('tests for SystemMetadataApi', () { + // Retrieve admin onboarding + // + // Retrieve the current admin onboarding status. + // + //Future getAdminOnboarding() async + test('test getAdminOnboarding', () async { + // TODO + }); + + // Retrieve reverse geocoding state + // + // Retrieve the current state of the reverse geocoding import. + // + //Future getReverseGeocodingState() async + test('test getReverseGeocodingState', () async { + // TODO + }); + + // Retrieve version check state + // + // Retrieve the current state of the version check process. + // + //Future getVersionCheckState() async + test('test getVersionCheckState', () async { + // TODO + }); + + // Update admin onboarding + // + // Update the admin onboarding status. + // + //Future updateAdminOnboarding(AdminOnboardingUpdateDto adminOnboardingUpdateDto) async + test('test updateAdminOnboarding', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/tag_bulk_assets_dto_test.dart b/mobile/openapi/test/tag_bulk_assets_dto_test.dart new file mode 100644 index 0000000000000..6d1b00828dd22 --- /dev/null +++ b/mobile/openapi/test/tag_bulk_assets_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagBulkAssetsDto +void main() { + // final instance = TagBulkAssetsDto(); + + group('test TagBulkAssetsDto', () { + // Asset IDs + // List assetIds (default value: const []) + test('to test the property `assetIds`', () async { + // TODO + }); + + // Tag IDs + // List tagIds (default value: const []) + test('to test the property `tagIds`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/tag_bulk_assets_response_dto_test.dart b/mobile/openapi/test/tag_bulk_assets_response_dto_test.dart new file mode 100644 index 0000000000000..c5416a7a9a47c --- /dev/null +++ b/mobile/openapi/test/tag_bulk_assets_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagBulkAssetsResponseDto +void main() { + // final instance = TagBulkAssetsResponseDto(); + + group('test TagBulkAssetsResponseDto', () { + // Number of assets tagged + // int count + test('to test the property `count`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/tag_create_dto_test.dart b/mobile/openapi/test/tag_create_dto_test.dart new file mode 100644 index 0000000000000..cd1efa280cb75 --- /dev/null +++ b/mobile/openapi/test/tag_create_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagCreateDto +void main() { + // final instance = TagCreateDto(); + + group('test TagCreateDto', () { + // Tag color (hex) + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + // Tag name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Parent tag ID + // Optional parentId + test('to test the property `parentId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/tag_response_dto_test.dart b/mobile/openapi/test/tag_response_dto_test.dart new file mode 100644 index 0000000000000..fd88b8c57e681 --- /dev/null +++ b/mobile/openapi/test/tag_response_dto_test.dart @@ -0,0 +1,64 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagResponseDto +void main() { + // final instance = TagResponseDto(); + + group('test TagResponseDto', () { + // Tag color (hex) + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Tag ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Tag name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Parent tag ID + // Optional parentId + test('to test the property `parentId`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + // Tag value (full path) + // String value + test('to test the property `value`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/tag_update_dto_test.dart b/mobile/openapi/test/tag_update_dto_test.dart new file mode 100644 index 0000000000000..f65125e652c6b --- /dev/null +++ b/mobile/openapi/test/tag_update_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagUpdateDto +void main() { + // final instance = TagUpdateDto(); + + group('test TagUpdateDto', () { + // Tag color (hex) + // Optional color + test('to test the property `color`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/tag_upsert_dto_test.dart b/mobile/openapi/test/tag_upsert_dto_test.dart new file mode 100644 index 0000000000000..7e8ab1677e8ca --- /dev/null +++ b/mobile/openapi/test/tag_upsert_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagUpsertDto +void main() { + // final instance = TagUpsertDto(); + + group('test TagUpsertDto', () { + // Tag names to upsert + // List tags (default value: const []) + test('to test the property `tags`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/tags_api_test.dart b/mobile/openapi/test/tags_api_test.dart new file mode 100644 index 0000000000000..80496566995ee --- /dev/null +++ b/mobile/openapi/test/tags_api_test.dart @@ -0,0 +1,102 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for TagsApi +void main() { + // final instance = TagsApi(); + + group('tests for TagsApi', () { + // Tag assets + // + // Add multiple tags to multiple assets in a single request. + // + //Future bulkTagAssets(TagBulkAssetsDto tagBulkAssetsDto) async + test('test bulkTagAssets', () async { + // TODO + }); + + // Create a tag + // + // Create a new tag by providing a name and optional color. + // + //Future createTag(TagCreateDto tagCreateDto) async + test('test createTag', () async { + // TODO + }); + + // Delete a tag + // + // Delete a specific tag by its ID. + // + //Future deleteTag(String id) async + test('test deleteTag', () async { + // TODO + }); + + // Retrieve tags + // + // Retrieve a list of all tags. + // + //Future> getAllTags() async + test('test getAllTags', () async { + // TODO + }); + + // Retrieve a tag + // + // Retrieve a specific tag by its ID. + // + //Future getTagById(String id) async + test('test getTagById', () async { + // TODO + }); + + // Tag assets + // + // Add a tag to all the specified assets. + // + //Future> tagAssets(String id, BulkIdsDto bulkIdsDto) async + test('test tagAssets', () async { + // TODO + }); + + // Untag assets + // + // Remove a tag from all the specified assets. + // + //Future> untagAssets(String id, BulkIdsDto bulkIdsDto) async + test('test untagAssets', () async { + // TODO + }); + + // Update a tag + // + // Update an existing tag identified by its ID. + // + //Future updateTag(String id, TagUpdateDto tagUpdateDto) async + test('test updateTag', () async { + // TODO + }); + + // Upsert tags + // + // Create or update multiple tags in a single request. + // + //Future> upsertTags(TagUpsertDto tagUpsertDto) async + test('test upsertTags', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/tags_response_test.dart b/mobile/openapi/test/tags_response_test.dart new file mode 100644 index 0000000000000..d5c618c3373cc --- /dev/null +++ b/mobile/openapi/test/tags_response_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagsResponse +void main() { + // final instance = TagsResponse(); + + group('test TagsResponse', () { + // Whether tags are enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Whether tags appear in web sidebar + // bool sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/tags_update_test.dart b/mobile/openapi/test/tags_update_test.dart new file mode 100644 index 0000000000000..14ddb054e05ea --- /dev/null +++ b/mobile/openapi/test/tags_update_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TagsUpdate +void main() { + // final instance = TagsUpdate(); + + group('test TagsUpdate', () { + // Whether tags are enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Whether tags appear in web sidebar + // Optional sidebarWeb + test('to test the property `sidebarWeb`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/task_status_test.dart b/mobile/openapi/test/task_status_test.dart new file mode 100644 index 0000000000000..9c86befd4b461 --- /dev/null +++ b/mobile/openapi/test/task_status_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TaskStatus +void main() { + + group('test TaskStatus', () { + + }); + +} diff --git a/mobile/openapi/test/task_type_test.dart b/mobile/openapi/test/task_type_test.dart new file mode 100644 index 0000000000000..fedc6831c56c5 --- /dev/null +++ b/mobile/openapi/test/task_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TaskType +void main() { + + group('test TaskType', () { + + }); + +} diff --git a/mobile/openapi/test/telemetry_level_test.dart b/mobile/openapi/test/telemetry_level_test.dart new file mode 100644 index 0000000000000..0f4408c2a878c --- /dev/null +++ b/mobile/openapi/test/telemetry_level_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TelemetryLevel +void main() { + + group('test TelemetryLevel', () { + + }); + +} diff --git a/mobile/openapi/test/template_dto_test.dart b/mobile/openapi/test/template_dto_test.dart new file mode 100644 index 0000000000000..4621ca852b502 --- /dev/null +++ b/mobile/openapi/test/template_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TemplateDto +void main() { + // final instance = TemplateDto(); + + group('test TemplateDto', () { + // Template name + // String template + test('to test the property `template`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/template_response_dto_test.dart b/mobile/openapi/test/template_response_dto_test.dart new file mode 100644 index 0000000000000..c09cee1a1f5f5 --- /dev/null +++ b/mobile/openapi/test/template_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TemplateResponseDto +void main() { + // final instance = TemplateResponseDto(); + + group('test TemplateResponseDto', () { + // Template HTML content + // String html + test('to test the property `html`', () async { + // TODO + }); + + // Template name + // String name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/test_email_response_dto_test.dart b/mobile/openapi/test/test_email_response_dto_test.dart new file mode 100644 index 0000000000000..ee76daac61a45 --- /dev/null +++ b/mobile/openapi/test/test_email_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TestEmailResponseDto +void main() { + // final instance = TestEmailResponseDto(); + + group('test TestEmailResponseDto', () { + // Email message ID + // String messageId + test('to test the property `messageId`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/time_bucket_asset_response_dto_test.dart b/mobile/openapi/test/time_bucket_asset_response_dto_test.dart new file mode 100644 index 0000000000000..19449a8c0af85 --- /dev/null +++ b/mobile/openapi/test/time_bucket_asset_response_dto_test.dart @@ -0,0 +1,136 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TimeBucketAssetResponseDto +void main() { + // final instance = TimeBucketAssetResponseDto(); + + group('test TimeBucketAssetResponseDto', () { + // Array of city names extracted from EXIF GPS data + // Optional?> city (default value: const []) + test('to test the property `city`', () async { + // TODO + }); + + // Array of country names extracted from EXIF GPS data + // Optional?> country (default value: const []) + test('to test the property `country`', () async { + // TODO + }); + + // Array of UTC timestamps when each asset was originally uploaded to Immich + // List createdAt (default value: const []) + test('to test the property `createdAt`', () async { + // TODO + }); + + // Array of video/gif durations in milliseconds (null for static images) + // List duration (default value: const []) + test('to test the property `duration`', () async { + // TODO + }); + + // Array of file creation timestamps in UTC + // List fileCreatedAt (default value: const []) + test('to test the property `fileCreatedAt`', () async { + // TODO + }); + + // Array of asset IDs in the time bucket + // List id (default value: const []) + test('to test the property `id`', () async { + // TODO + }); + + // Array indicating whether each asset is favorited + // List isFavorite (default value: const []) + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Array indicating whether each asset is an image (false for videos) + // List isImage (default value: const []) + test('to test the property `isImage`', () async { + // TODO + }); + + // Array indicating whether each asset is in the trash + // List isTrashed (default value: const []) + test('to test the property `isTrashed`', () async { + // TODO + }); + + // Array of latitude coordinates extracted from EXIF GPS data + // Optional?> latitude (default value: const []) + test('to test the property `latitude`', () async { + // TODO + }); + + // Array of live photo video asset IDs (null for non-live photos) + // List livePhotoVideoId (default value: const []) + test('to test the property `livePhotoVideoId`', () async { + // TODO + }); + + // Array of UTC offset hours at the time each photo was taken. Positive values are east of UTC, negative values are west of UTC. Values may be fractional (e.g., 5.5 for +05:30, -9.75 for -09:45). Applying this offset to 'fileCreatedAt' will give you the time the photo was taken from the photographer's perspective. + // List localOffsetHours (default value: const []) + test('to test the property `localOffsetHours`', () async { + // TODO + }); + + // Array of longitude coordinates extracted from EXIF GPS data + // Optional?> longitude (default value: const []) + test('to test the property `longitude`', () async { + // TODO + }); + + // Array of owner IDs for each asset + // List ownerId (default value: const []) + test('to test the property `ownerId`', () async { + // TODO + }); + + // Array of projection types for 360° content (e.g., \"EQUIRECTANGULAR\", \"CUBEFACE\", \"CYLINDRICAL\") + // List projectionType (default value: const []) + test('to test the property `projectionType`', () async { + // TODO + }); + + // Array of aspect ratios (width/height) for each asset + // List ratio (default value: const []) + test('to test the property `ratio`', () async { + // TODO + }); + + // Array of stack information as [stackId, assetCount] tuples (null for non-stacked assets) + // Optional?>?> stack (default value: const []) + test('to test the property `stack`', () async { + // TODO + }); + + // Array of BlurHash strings for generating asset previews (base64 encoded) + // List thumbhash (default value: const []) + test('to test the property `thumbhash`', () async { + // TODO + }); + + // Array of visibility statuses for each asset (e.g., ARCHIVE, TIMELINE, HIDDEN, LOCKED) + // List visibility (default value: const []) + test('to test the property `visibility`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/time_buckets_response_dto_test.dart b/mobile/openapi/test/time_buckets_response_dto_test.dart new file mode 100644 index 0000000000000..0633fc11c0027 --- /dev/null +++ b/mobile/openapi/test/time_buckets_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TimeBucketsResponseDto +void main() { + // final instance = TimeBucketsResponseDto(); + + group('test TimeBucketsResponseDto', () { + // Number of assets in this time bucket + // int count + test('to test the property `count`', () async { + // TODO + }); + + // Time bucket identifier in YYYY-MM-DD format representing the start of the time period + // String timeBucket + test('to test the property `timeBucket`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/timeline_api_test.dart b/mobile/openapi/test/timeline_api_test.dart new file mode 100644 index 0000000000000..85ac6d950547e --- /dev/null +++ b/mobile/openapi/test/timeline_api_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for TimelineApi +void main() { + // final instance = TimelineApi(); + + group('tests for TimelineApi', () { + // Get time bucket + // + // Retrieve a string of all asset ids in a given time bucket. + // + //Future getTimeBucket(String timeBucket, { String albumId, String bbox, bool isFavorite, bool isTrashed, String key, AssetOrder order, AssetOrderBy orderBy, String personId, String slug, String tagId, String userId, AssetVisibility visibility, bool withCoordinates, bool withPartners, bool withStacked }) async + test('test getTimeBucket', () async { + // TODO + }); + + // Get time buckets + // + // Retrieve a list of all minimal time buckets. + // + //Future> getTimeBuckets({ String albumId, String bbox, bool isFavorite, bool isTrashed, String key, AssetOrder order, AssetOrderBy orderBy, String personId, String slug, String tagId, String userId, AssetVisibility visibility, bool withCoordinates, bool withPartners, bool withStacked }) async + test('test getTimeBuckets', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/tone_mapping_test.dart b/mobile/openapi/test/tone_mapping_test.dart new file mode 100644 index 0000000000000..9aca354366d0b --- /dev/null +++ b/mobile/openapi/test/tone_mapping_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ToneMapping +void main() { + + group('test ToneMapping', () { + + }); + +} diff --git a/mobile/openapi/test/transcode_hw_accel_test.dart b/mobile/openapi/test/transcode_hw_accel_test.dart new file mode 100644 index 0000000000000..f6f8d9f7b5434 --- /dev/null +++ b/mobile/openapi/test/transcode_hw_accel_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TranscodeHWAccel +void main() { + + group('test TranscodeHWAccel', () { + + }); + +} diff --git a/mobile/openapi/test/transcode_policy_test.dart b/mobile/openapi/test/transcode_policy_test.dart new file mode 100644 index 0000000000000..2f46df1c3f1c9 --- /dev/null +++ b/mobile/openapi/test/transcode_policy_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TranscodePolicy +void main() { + + group('test TranscodePolicy', () { + + }); + +} diff --git a/mobile/openapi/test/trash_api_test.dart b/mobile/openapi/test/trash_api_test.dart new file mode 100644 index 0000000000000..c70baab707acd --- /dev/null +++ b/mobile/openapi/test/trash_api_test.dart @@ -0,0 +1,48 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for TrashApi +void main() { + // final instance = TrashApi(); + + group('tests for TrashApi', () { + // Empty trash + // + // Permanently delete all items in the trash. + // + //Future emptyTrash() async + test('test emptyTrash', () async { + // TODO + }); + + // Restore assets + // + // Restore specific assets from the trash. + // + //Future restoreAssets(BulkIdsDto bulkIdsDto) async + test('test restoreAssets', () async { + // TODO + }); + + // Restore trash + // + // Restore all items in the trash. + // + //Future restoreTrash() async + test('test restoreTrash', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/trash_response_dto_test.dart b/mobile/openapi/test/trash_response_dto_test.dart new file mode 100644 index 0000000000000..3eecb7dd962ae --- /dev/null +++ b/mobile/openapi/test/trash_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for TrashResponseDto +void main() { + // final instance = TrashResponseDto(); + + group('test TrashResponseDto', () { + // Number of items in trash + // int count + test('to test the property `count`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/update_album_dto_test.dart b/mobile/openapi/test/update_album_dto_test.dart new file mode 100644 index 0000000000000..749b25702558d --- /dev/null +++ b/mobile/openapi/test/update_album_dto_test.dart @@ -0,0 +1,51 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UpdateAlbumDto +void main() { + // final instance = UpdateAlbumDto(); + + group('test UpdateAlbumDto', () { + // Album name + // Optional albumName + test('to test the property `albumName`', () async { + // TODO + }); + + // Album thumbnail asset ID + // Optional albumThumbnailAssetId + test('to test the property `albumThumbnailAssetId`', () async { + // TODO + }); + + // Album description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Enable activity feed + // Optional isActivityEnabled + test('to test the property `isActivityEnabled`', () async { + // TODO + }); + + // Optional order + test('to test the property `order`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/update_album_user_dto_test.dart b/mobile/openapi/test/update_album_user_dto_test.dart new file mode 100644 index 0000000000000..15c5756b22620 --- /dev/null +++ b/mobile/openapi/test/update_album_user_dto_test.dart @@ -0,0 +1,27 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UpdateAlbumUserDto +void main() { + // final instance = UpdateAlbumUserDto(); + + group('test UpdateAlbumUserDto', () { + // AlbumUserRole role + test('to test the property `role`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/update_asset_dto_test.dart b/mobile/openapi/test/update_asset_dto_test.dart new file mode 100644 index 0000000000000..4880714c2ccea --- /dev/null +++ b/mobile/openapi/test/update_asset_dto_test.dart @@ -0,0 +1,69 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UpdateAssetDto +void main() { + // final instance = UpdateAssetDto(); + + group('test UpdateAssetDto', () { + // Original date and time + // Optional dateTimeOriginal + test('to test the property `dateTimeOriginal`', () async { + // TODO + }); + + // Asset description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Mark as favorite + // Optional isFavorite + test('to test the property `isFavorite`', () async { + // TODO + }); + + // Latitude coordinate + // Optional latitude + test('to test the property `latitude`', () async { + // TODO + }); + + // Live photo video ID + // Optional livePhotoVideoId + test('to test the property `livePhotoVideoId`', () async { + // TODO + }); + + // Longitude coordinate + // Optional longitude + test('to test the property `longitude`', () async { + // TODO + }); + + // Rating in range [1-5] (starred), -1 (rejected), or null (unrated) + // Optional rating + test('to test the property `rating`', () async { + // TODO + }); + + // Optional visibility + test('to test the property `visibility`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/update_library_dto_test.dart b/mobile/openapi/test/update_library_dto_test.dart new file mode 100644 index 0000000000000..0f8cb8bd70219 --- /dev/null +++ b/mobile/openapi/test/update_library_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UpdateLibraryDto +void main() { + // final instance = UpdateLibraryDto(); + + group('test UpdateLibraryDto', () { + // Exclusion patterns (max 128) + // Optional?> exclusionPatterns (default value: const []) + test('to test the property `exclusionPatterns`', () async { + // TODO + }); + + // Import paths (max 128) + // Optional?> importPaths (default value: const []) + test('to test the property `importPaths`', () async { + // TODO + }); + + // Library name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/usage_by_user_dto_test.dart b/mobile/openapi/test/usage_by_user_dto_test.dart new file mode 100644 index 0000000000000..18030e1104d49 --- /dev/null +++ b/mobile/openapi/test/usage_by_user_dto_test.dart @@ -0,0 +1,70 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UsageByUserDto +void main() { + // final instance = UsageByUserDto(); + + group('test UsageByUserDto', () { + // Number of photos + // int photos + test('to test the property `photos`', () async { + // TODO + }); + + // User quota size in bytes (null if unlimited) + // int quotaSizeInBytes + test('to test the property `quotaSizeInBytes`', () async { + // TODO + }); + + // Total storage usage in bytes + // int usage + test('to test the property `usage`', () async { + // TODO + }); + + // Storage usage for photos in bytes + // int usagePhotos + test('to test the property `usagePhotos`', () async { + // TODO + }); + + // Storage usage for videos in bytes + // int usageVideos + test('to test the property `usageVideos`', () async { + // TODO + }); + + // User ID + // String userId + test('to test the property `userId`', () async { + // TODO + }); + + // User name + // String userName + test('to test the property `userName`', () async { + // TODO + }); + + // Number of videos + // int videos + test('to test the property `videos`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_admin_create_dto_test.dart b/mobile/openapi/test/user_admin_create_dto_test.dart new file mode 100644 index 0000000000000..4721fec4a6694 --- /dev/null +++ b/mobile/openapi/test/user_admin_create_dto_test.dart @@ -0,0 +1,81 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserAdminCreateDto +void main() { + // final instance = UserAdminCreateDto(); + + group('test UserAdminCreateDto', () { + // Optional avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // Grant admin privileges + // Optional isAdmin + test('to test the property `isAdmin`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Send notification email + // Optional notify + test('to test the property `notify`', () async { + // TODO + }); + + // User password + // String password + test('to test the property `password`', () async { + // TODO + }); + + // PIN code + // Optional pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + // Storage quota in bytes + // Optional quotaSizeInBytes + test('to test the property `quotaSizeInBytes`', () async { + // TODO + }); + + // Require password change on next login + // Optional shouldChangePassword + test('to test the property `shouldChangePassword`', () async { + // TODO + }); + + // Storage label + // Optional storageLabel + test('to test the property `storageLabel`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_admin_delete_dto_test.dart b/mobile/openapi/test/user_admin_delete_dto_test.dart new file mode 100644 index 0000000000000..4242d6175dacf --- /dev/null +++ b/mobile/openapi/test/user_admin_delete_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserAdminDeleteDto +void main() { + // final instance = UserAdminDeleteDto(); + + group('test UserAdminDeleteDto', () { + // Force delete even if user has assets + // Optional force + test('to test the property `force`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_admin_response_dto_test.dart b/mobile/openapi/test/user_admin_response_dto_test.dart new file mode 100644 index 0000000000000..dbfb4b725789b --- /dev/null +++ b/mobile/openapi/test/user_admin_response_dto_test.dart @@ -0,0 +1,121 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserAdminResponseDto +void main() { + // final instance = UserAdminResponseDto(); + + group('test UserAdminResponseDto', () { + // UserAvatarColor avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // Creation date + // DateTime createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Deletion date + // DateTime deletedAt + test('to test the property `deletedAt`', () async { + // TODO + }); + + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // User ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Is admin user + // bool isAdmin + test('to test the property `isAdmin`', () async { + // TODO + }); + + // UserLicense license + test('to test the property `license`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // OAuth ID + // String oauthId + test('to test the property `oauthId`', () async { + // TODO + }); + + // Profile change date + // DateTime profileChangedAt + test('to test the property `profileChangedAt`', () async { + // TODO + }); + + // Profile image path + // String profileImagePath + test('to test the property `profileImagePath`', () async { + // TODO + }); + + // Storage quota in bytes + // int quotaSizeInBytes + test('to test the property `quotaSizeInBytes`', () async { + // TODO + }); + + // Storage usage in bytes + // int quotaUsageInBytes + test('to test the property `quotaUsageInBytes`', () async { + // TODO + }); + + // Require password change on next login + // bool shouldChangePassword + test('to test the property `shouldChangePassword`', () async { + // TODO + }); + + // UserStatus status + test('to test the property `status`', () async { + // TODO + }); + + // Storage label + // String storageLabel + test('to test the property `storageLabel`', () async { + // TODO + }); + + // Last update date + // DateTime updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_admin_update_dto_test.dart b/mobile/openapi/test/user_admin_update_dto_test.dart new file mode 100644 index 0000000000000..84ad0a99f7967 --- /dev/null +++ b/mobile/openapi/test/user_admin_update_dto_test.dart @@ -0,0 +1,75 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserAdminUpdateDto +void main() { + // final instance = UserAdminUpdateDto(); + + group('test UserAdminUpdateDto', () { + // Optional avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // User email + // Optional email + test('to test the property `email`', () async { + // TODO + }); + + // Grant admin privileges + // Optional isAdmin + test('to test the property `isAdmin`', () async { + // TODO + }); + + // User name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // User password + // Optional password + test('to test the property `password`', () async { + // TODO + }); + + // PIN code + // Optional pinCode + test('to test the property `pinCode`', () async { + // TODO + }); + + // Storage quota in bytes + // Optional quotaSizeInBytes + test('to test the property `quotaSizeInBytes`', () async { + // TODO + }); + + // Require password change on next login + // Optional shouldChangePassword + test('to test the property `shouldChangePassword`', () async { + // TODO + }); + + // Storage label + // Optional storageLabel + test('to test the property `storageLabel`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_avatar_color_test.dart b/mobile/openapi/test/user_avatar_color_test.dart new file mode 100644 index 0000000000000..740af29be611c --- /dev/null +++ b/mobile/openapi/test/user_avatar_color_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserAvatarColor +void main() { + + group('test UserAvatarColor', () { + + }); + +} diff --git a/mobile/openapi/test/user_license_test.dart b/mobile/openapi/test/user_license_test.dart new file mode 100644 index 0000000000000..36bfce72fe374 --- /dev/null +++ b/mobile/openapi/test/user_license_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserLicense +void main() { + // final instance = UserLicense(); + + group('test UserLicense', () { + // Activation date + // DateTime activatedAt + test('to test the property `activatedAt`', () async { + // TODO + }); + + // Activation key + // String activationKey + test('to test the property `activationKey`', () async { + // TODO + }); + + // License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/) + // String licenseKey + test('to test the property `licenseKey`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_metadata_key_test.dart b/mobile/openapi/test/user_metadata_key_test.dart new file mode 100644 index 0000000000000..f6e54e76a727f --- /dev/null +++ b/mobile/openapi/test/user_metadata_key_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserMetadataKey +void main() { + + group('test UserMetadataKey', () { + + }); + +} diff --git a/mobile/openapi/test/user_preferences_response_dto_test.dart b/mobile/openapi/test/user_preferences_response_dto_test.dart new file mode 100644 index 0000000000000..914cb1180ed8f --- /dev/null +++ b/mobile/openapi/test/user_preferences_response_dto_test.dart @@ -0,0 +1,82 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserPreferencesResponseDto +void main() { + // final instance = UserPreferencesResponseDto(); + + group('test UserPreferencesResponseDto', () { + // AlbumsResponse albums + test('to test the property `albums`', () async { + // TODO + }); + + // CastResponse cast + test('to test the property `cast`', () async { + // TODO + }); + + // DownloadResponse download + test('to test the property `download`', () async { + // TODO + }); + + // EmailNotificationsResponse emailNotifications + test('to test the property `emailNotifications`', () async { + // TODO + }); + + // FoldersResponse folders + test('to test the property `folders`', () async { + // TODO + }); + + // MemoriesResponse memories + test('to test the property `memories`', () async { + // TODO + }); + + // PeopleResponse people + test('to test the property `people`', () async { + // TODO + }); + + // PurchaseResponse purchase + test('to test the property `purchase`', () async { + // TODO + }); + + // RatingsResponse ratings + test('to test the property `ratings`', () async { + // TODO + }); + + // RecentlyAddedResponse recentlyAdded + test('to test the property `recentlyAdded`', () async { + // TODO + }); + + // SharedLinksResponse sharedLinks + test('to test the property `sharedLinks`', () async { + // TODO + }); + + // TagsResponse tags + test('to test the property `tags`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_preferences_update_dto_test.dart b/mobile/openapi/test/user_preferences_update_dto_test.dart new file mode 100644 index 0000000000000..4512a701e7425 --- /dev/null +++ b/mobile/openapi/test/user_preferences_update_dto_test.dart @@ -0,0 +1,87 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserPreferencesUpdateDto +void main() { + // final instance = UserPreferencesUpdateDto(); + + group('test UserPreferencesUpdateDto', () { + // Optional albums + test('to test the property `albums`', () async { + // TODO + }); + + // Optional avatar + test('to test the property `avatar`', () async { + // TODO + }); + + // Optional cast + test('to test the property `cast`', () async { + // TODO + }); + + // Optional download + test('to test the property `download`', () async { + // TODO + }); + + // Optional emailNotifications + test('to test the property `emailNotifications`', () async { + // TODO + }); + + // Optional folders + test('to test the property `folders`', () async { + // TODO + }); + + // Optional memories + test('to test the property `memories`', () async { + // TODO + }); + + // Optional people + test('to test the property `people`', () async { + // TODO + }); + + // Optional purchase + test('to test the property `purchase`', () async { + // TODO + }); + + // Optional ratings + test('to test the property `ratings`', () async { + // TODO + }); + + // Optional recentlyAdded + test('to test the property `recentlyAdded`', () async { + // TODO + }); + + // Optional sharedLinks + test('to test the property `sharedLinks`', () async { + // TODO + }); + + // Optional tags + test('to test the property `tags`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_response_dto_test.dart b/mobile/openapi/test/user_response_dto_test.dart new file mode 100644 index 0000000000000..7d630097fe013 --- /dev/null +++ b/mobile/openapi/test/user_response_dto_test.dart @@ -0,0 +1,57 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserResponseDto +void main() { + // final instance = UserResponseDto(); + + group('test UserResponseDto', () { + // UserAvatarColor avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // User email + // String email + test('to test the property `email`', () async { + // TODO + }); + + // User ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // User name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Profile change date + // DateTime profileChangedAt + test('to test the property `profileChangedAt`', () async { + // TODO + }); + + // Profile image path + // String profileImagePath + test('to test the property `profileImagePath`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/user_status_test.dart b/mobile/openapi/test/user_status_test.dart new file mode 100644 index 0000000000000..db28381a7bda8 --- /dev/null +++ b/mobile/openapi/test/user_status_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserStatus +void main() { + + group('test UserStatus', () { + + }); + +} diff --git a/mobile/openapi/test/user_update_me_dto_test.dart b/mobile/openapi/test/user_update_me_dto_test.dart new file mode 100644 index 0000000000000..2a9f45568d56f --- /dev/null +++ b/mobile/openapi/test/user_update_me_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for UserUpdateMeDto +void main() { + // final instance = UserUpdateMeDto(); + + group('test UserUpdateMeDto', () { + // Optional avatarColor + test('to test the property `avatarColor`', () async { + // TODO + }); + + // User email + // Optional email + test('to test the property `email`', () async { + // TODO + }); + + // User name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // User password (deprecated, use change password endpoint) + // Optional password + test('to test the property `password`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/users_admin_api_test.dart b/mobile/openapi/test/users_admin_api_test.dart new file mode 100644 index 0000000000000..fb2313e6cc6b1 --- /dev/null +++ b/mobile/openapi/test/users_admin_api_test.dart @@ -0,0 +1,120 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for UsersAdminApi +void main() { + // final instance = UsersAdminApi(); + + group('tests for UsersAdminApi', () { + // Create a user + // + // Create a new user. + // + //Future createUserAdmin(UserAdminCreateDto userAdminCreateDto) async + test('test createUserAdmin', () async { + // TODO + }); + + // Delete a user + // + // Delete a user. + // + //Future deleteUserAdmin(String id, UserAdminDeleteDto userAdminDeleteDto) async + test('test deleteUserAdmin', () async { + // TODO + }); + + // Retrieve a user + // + // Retrieve a specific user by their ID. + // + //Future getUserAdmin(String id) async + test('test getUserAdmin', () async { + // TODO + }); + + // Retrieve calendar heatmap activity + // + // Retrieve activity counts for a specified period, in a calendar heatmap format. + // + //Future getUserCalendarHeatmapAdmin(String id, { DateTime from, DateTime to, CalendarHeatmapType type }) async + test('test getUserCalendarHeatmapAdmin', () async { + // TODO + }); + + // Retrieve user preferences + // + // Retrieve the preferences of a specific user. + // + //Future getUserPreferencesAdmin(String id) async + test('test getUserPreferencesAdmin', () async { + // TODO + }); + + // Retrieve user sessions + // + // Retrieve all sessions for a specific user. + // + //Future> getUserSessionsAdmin(String id) async + test('test getUserSessionsAdmin', () async { + // TODO + }); + + // Retrieve user statistics + // + // Retrieve asset statistics for a specific user. + // + //Future getUserStatisticsAdmin(String id, { bool isFavorite, bool isTrashed, AssetVisibility visibility }) async + test('test getUserStatisticsAdmin', () async { + // TODO + }); + + // Restore a deleted user + // + // Restore a previously deleted user. + // + //Future restoreUserAdmin(String id) async + test('test restoreUserAdmin', () async { + // TODO + }); + + // Search users + // + // Search for users. + // + //Future> searchUsersAdmin({ String id, bool withDeleted }) async + test('test searchUsersAdmin', () async { + // TODO + }); + + // Update a user + // + // Update an existing user. + // + //Future updateUserAdmin(String id, UserAdminUpdateDto userAdminUpdateDto) async + test('test updateUserAdmin', () async { + // TODO + }); + + // Update user preferences + // + // Update the preferences of a specific user. + // + //Future updateUserPreferencesAdmin(String id, UserPreferencesUpdateDto userPreferencesUpdateDto) async + test('test updateUserPreferencesAdmin', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/users_api_test.dart b/mobile/openapi/test/users_api_test.dart new file mode 100644 index 0000000000000..4d92f0a6a4f8b --- /dev/null +++ b/mobile/openapi/test/users_api_test.dart @@ -0,0 +1,165 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for UsersApi +void main() { + // final instance = UsersApi(); + + group('tests for UsersApi', () { + // Create user profile image + // + // Upload and set a new profile image for the current user. + // + //Future createProfileImage(MultipartFile file) async + test('test createProfileImage', () async { + // TODO + }); + + // Delete user profile image + // + // Delete the profile image of the current user. + // + //Future deleteProfileImage() async + test('test deleteProfileImage', () async { + // TODO + }); + + // Delete user product key + // + // Delete the registered product key for the current user. + // + //Future deleteUserLicense() async + test('test deleteUserLicense', () async { + // TODO + }); + + // Delete user onboarding + // + // Delete the onboarding status of the current user. + // + //Future deleteUserOnboarding() async + test('test deleteUserOnboarding', () async { + // TODO + }); + + // Retrieve calendar heatmap activity + // + // Retrieve activity counts for a specified period, in a calendar heatmap format. + // + //Future getMyCalendarHeatmap({ DateTime from, DateTime to, CalendarHeatmapType type }) async + test('test getMyCalendarHeatmap', () async { + // TODO + }); + + // Get my preferences + // + // Retrieve the preferences for the current user. + // + //Future getMyPreferences() async + test('test getMyPreferences', () async { + // TODO + }); + + // Get current user + // + // Retrieve information about the user making the API request. + // + //Future getMyUser() async + test('test getMyUser', () async { + // TODO + }); + + // Retrieve user profile image + // + // Retrieve the profile image file for a user. + // + //Future getProfileImage(String id) async + test('test getProfileImage', () async { + // TODO + }); + + // Retrieve a user + // + // Retrieve a specific user by their ID. + // + //Future getUser(String id) async + test('test getUser', () async { + // TODO + }); + + // Retrieve user product key + // + // Retrieve information about whether the current user has a registered product key. + // + //Future getUserLicense() async + test('test getUserLicense', () async { + // TODO + }); + + // Retrieve user onboarding + // + // Retrieve the onboarding status of the current user. + // + //Future getUserOnboarding() async + test('test getUserOnboarding', () async { + // TODO + }); + + // Get all users + // + // Retrieve a list of all users on the server. + // + //Future> searchUsers() async + test('test searchUsers', () async { + // TODO + }); + + // Set user product key + // + // Register a product key for the current user. + // + //Future setUserLicense(LicenseKeyDto licenseKeyDto) async + test('test setUserLicense', () async { + // TODO + }); + + // Update user onboarding + // + // Update the onboarding status of the current user. + // + //Future setUserOnboarding(OnboardingDto onboardingDto) async + test('test setUserOnboarding', () async { + // TODO + }); + + // Update my preferences + // + // Update the preferences of the current user. + // + //Future updateMyPreferences(UserPreferencesUpdateDto userPreferencesUpdateDto) async + test('test updateMyPreferences', () async { + // TODO + }); + + // Update current user + // + // Update the current user making the API request. + // + //Future updateMyUser(UserUpdateMeDto userUpdateMeDto) async + test('test updateMyUser', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/validate_access_token_response_dto_test.dart b/mobile/openapi/test/validate_access_token_response_dto_test.dart new file mode 100644 index 0000000000000..b50e4d569c5dc --- /dev/null +++ b/mobile/openapi/test/validate_access_token_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ValidateAccessTokenResponseDto +void main() { + // final instance = ValidateAccessTokenResponseDto(); + + group('test ValidateAccessTokenResponseDto', () { + // Authentication status + // bool authStatus + test('to test the property `authStatus`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/validate_library_dto_test.dart b/mobile/openapi/test/validate_library_dto_test.dart new file mode 100644 index 0000000000000..1e29c414b5839 --- /dev/null +++ b/mobile/openapi/test/validate_library_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ValidateLibraryDto +void main() { + // final instance = ValidateLibraryDto(); + + group('test ValidateLibraryDto', () { + // Exclusion patterns (max 128) + // Optional?> exclusionPatterns (default value: const []) + test('to test the property `exclusionPatterns`', () async { + // TODO + }); + + // Import paths to validate (max 128) + // Optional?> importPaths (default value: const []) + test('to test the property `importPaths`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/validate_library_import_path_response_dto_test.dart b/mobile/openapi/test/validate_library_import_path_response_dto_test.dart new file mode 100644 index 0000000000000..57e57cb2dc6ae --- /dev/null +++ b/mobile/openapi/test/validate_library_import_path_response_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ValidateLibraryImportPathResponseDto +void main() { + // final instance = ValidateLibraryImportPathResponseDto(); + + group('test ValidateLibraryImportPathResponseDto', () { + // Import path + // String importPath + test('to test the property `importPath`', () async { + // TODO + }); + + // Is valid + // bool isValid + test('to test the property `isValid`', () async { + // TODO + }); + + // Validation message + // Optional message + test('to test the property `message`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/validate_library_response_dto_test.dart b/mobile/openapi/test/validate_library_response_dto_test.dart new file mode 100644 index 0000000000000..b645519916736 --- /dev/null +++ b/mobile/openapi/test/validate_library_response_dto_test.dart @@ -0,0 +1,28 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for ValidateLibraryResponseDto +void main() { + // final instance = ValidateLibraryResponseDto(); + + group('test ValidateLibraryResponseDto', () { + // Validation results for import paths + // Optional?> importPaths (default value: const []) + test('to test the property `importPaths`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/version_check_state_response_dto_test.dart b/mobile/openapi/test/version_check_state_response_dto_test.dart new file mode 100644 index 0000000000000..3020b07963f03 --- /dev/null +++ b/mobile/openapi/test/version_check_state_response_dto_test.dart @@ -0,0 +1,34 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for VersionCheckStateResponseDto +void main() { + // final instance = VersionCheckStateResponseDto(); + + group('test VersionCheckStateResponseDto', () { + // Last check timestamp + // String checkedAt + test('to test the property `checkedAt`', () async { + // TODO + }); + + // Release version + // String releaseVersion + test('to test the property `releaseVersion`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/video_codec_test.dart b/mobile/openapi/test/video_codec_test.dart new file mode 100644 index 0000000000000..ed5e26c1f41e9 --- /dev/null +++ b/mobile/openapi/test/video_codec_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for VideoCodec +void main() { + + group('test VideoCodec', () { + + }); + +} diff --git a/mobile/openapi/test/video_container_test.dart b/mobile/openapi/test/video_container_test.dart new file mode 100644 index 0000000000000..010ea11327a69 --- /dev/null +++ b/mobile/openapi/test/video_container_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for VideoContainer +void main() { + + group('test VideoContainer', () { + + }); + +} diff --git a/mobile/openapi/test/views_api_test.dart b/mobile/openapi/test/views_api_test.dart new file mode 100644 index 0000000000000..1ba04cf4adf43 --- /dev/null +++ b/mobile/openapi/test/views_api_test.dart @@ -0,0 +1,39 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for ViewsApi +void main() { + // final instance = ViewsApi(); + + group('tests for ViewsApi', () { + // Retrieve assets by original path + // + // Retrieve assets that are children of a specific folder. + // + //Future> getAssetsByOriginalPath(String path) async + test('test getAssetsByOriginalPath', () async { + // TODO + }); + + // Retrieve unique paths + // + // Retrieve a list of unique folder paths from asset original paths. + // + //Future> getUniqueOriginalPaths() async + test('test getUniqueOriginalPaths', () async { + // TODO + }); + + }); +} diff --git a/mobile/openapi/test/workflow_create_dto_test.dart b/mobile/openapi/test/workflow_create_dto_test.dart new file mode 100644 index 0000000000000..efaded65952bb --- /dev/null +++ b/mobile/openapi/test/workflow_create_dto_test.dart @@ -0,0 +1,50 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowCreateDto +void main() { + // final instance = WorkflowCreateDto(); + + group('test WorkflowCreateDto', () { + // Workflow description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Workflow enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Workflow name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // Optional?> steps (default value: const []) + test('to test the property `steps`', () async { + // TODO + }); + + // WorkflowTrigger trigger + test('to test the property `trigger`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/workflow_response_dto_test.dart b/mobile/openapi/test/workflow_response_dto_test.dart new file mode 100644 index 0000000000000..5ba366dafe83c --- /dev/null +++ b/mobile/openapi/test/workflow_response_dto_test.dart @@ -0,0 +1,69 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowResponseDto +void main() { + // final instance = WorkflowResponseDto(); + + group('test WorkflowResponseDto', () { + // Creation date + // String createdAt + test('to test the property `createdAt`', () async { + // TODO + }); + + // Workflow description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Workflow enabled + // bool enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Workflow ID + // String id + test('to test the property `id`', () async { + // TODO + }); + + // Workflow name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Workflow steps + // List steps (default value: const []) + test('to test the property `steps`', () async { + // TODO + }); + + // WorkflowTrigger trigger + test('to test the property `trigger`', () async { + // TODO + }); + + // Update date + // String updatedAt + test('to test the property `updatedAt`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/workflow_share_response_dto_test.dart b/mobile/openapi/test/workflow_share_response_dto_test.dart new file mode 100644 index 0000000000000..c441f72fa338d --- /dev/null +++ b/mobile/openapi/test/workflow_share_response_dto_test.dart @@ -0,0 +1,45 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowShareResponseDto +void main() { + // final instance = WorkflowShareResponseDto(); + + group('test WorkflowShareResponseDto', () { + // Workflow description + // String description + test('to test the property `description`', () async { + // TODO + }); + + // Workflow name + // String name + test('to test the property `name`', () async { + // TODO + }); + + // Workflow steps + // List steps (default value: const []) + test('to test the property `steps`', () async { + // TODO + }); + + // WorkflowTrigger trigger + test('to test the property `trigger`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/workflow_share_step_dto_test.dart b/mobile/openapi/test/workflow_share_step_dto_test.dart new file mode 100644 index 0000000000000..885266e415012 --- /dev/null +++ b/mobile/openapi/test/workflow_share_step_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowShareStepDto +void main() { + // final instance = WorkflowShareStepDto(); + + group('test WorkflowShareStepDto', () { + // Step configuration + // Map config (default value: const {}) + test('to test the property `config`', () async { + // TODO + }); + + // Step is enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Step plugin method + // String method + test('to test the property `method`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/workflow_step_dto_test.dart b/mobile/openapi/test/workflow_step_dto_test.dart new file mode 100644 index 0000000000000..dcd9524b145cb --- /dev/null +++ b/mobile/openapi/test/workflow_step_dto_test.dart @@ -0,0 +1,40 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowStepDto +void main() { + // final instance = WorkflowStepDto(); + + group('test WorkflowStepDto', () { + // Step configuration + // Map config (default value: const {}) + test('to test the property `config`', () async { + // TODO + }); + + // Step is enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Step plugin method + // String method + test('to test the property `method`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/workflow_trigger_response_dto_test.dart b/mobile/openapi/test/workflow_trigger_response_dto_test.dart new file mode 100644 index 0000000000000..8dc04a78840a0 --- /dev/null +++ b/mobile/openapi/test/workflow_trigger_response_dto_test.dart @@ -0,0 +1,33 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowTriggerResponseDto +void main() { + // final instance = WorkflowTriggerResponseDto(); + + group('test WorkflowTriggerResponseDto', () { + // WorkflowTrigger trigger + test('to test the property `trigger`', () async { + // TODO + }); + + // Workflow types + // List types (default value: const []) + test('to test the property `types`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/workflow_trigger_test.dart b/mobile/openapi/test/workflow_trigger_test.dart new file mode 100644 index 0000000000000..ecac76bef9c43 --- /dev/null +++ b/mobile/openapi/test/workflow_trigger_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowTrigger +void main() { + + group('test WorkflowTrigger', () { + + }); + +} diff --git a/mobile/openapi/test/workflow_type_test.dart b/mobile/openapi/test/workflow_type_test.dart new file mode 100644 index 0000000000000..c93fb88f4d20b --- /dev/null +++ b/mobile/openapi/test/workflow_type_test.dart @@ -0,0 +1,21 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowType +void main() { + + group('test WorkflowType', () { + + }); + +} diff --git a/mobile/openapi/test/workflow_update_dto_test.dart b/mobile/openapi/test/workflow_update_dto_test.dart new file mode 100644 index 0000000000000..2d50792bacc23 --- /dev/null +++ b/mobile/openapi/test/workflow_update_dto_test.dart @@ -0,0 +1,50 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + +// tests for WorkflowUpdateDto +void main() { + // final instance = WorkflowUpdateDto(); + + group('test WorkflowUpdateDto', () { + // Workflow description + // Optional description + test('to test the property `description`', () async { + // TODO + }); + + // Workflow enabled + // Optional enabled + test('to test the property `enabled`', () async { + // TODO + }); + + // Workflow name + // Optional name + test('to test the property `name`', () async { + // TODO + }); + + // Optional?> steps (default value: const []) + test('to test the property `steps`', () async { + // TODO + }); + + // Optional trigger + test('to test the property `trigger`', () async { + // TODO + }); + + + }); + +} diff --git a/mobile/openapi/test/workflows_api_test.dart b/mobile/openapi/test/workflows_api_test.dart new file mode 100644 index 0000000000000..93dc36d6a4c09 --- /dev/null +++ b/mobile/openapi/test/workflows_api_test.dart @@ -0,0 +1,84 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +import 'package:openapi/api.dart'; +import 'package:test/test.dart'; + + +/// tests for WorkflowsApi +void main() { + // final instance = WorkflowsApi(); + + group('tests for WorkflowsApi', () { + // Create a workflow + // + // Create a new workflow, the workflow can also be created with empty filters and actions. + // + //Future createWorkflow(WorkflowCreateDto workflowCreateDto) async + test('test createWorkflow', () async { + // TODO + }); + + // Delete a workflow + // + // Delete a workflow by its ID. + // + //Future deleteWorkflow(String id) async + test('test deleteWorkflow', () async { + // TODO + }); + + // Retrieve a workflow + // + // Retrieve information about a specific workflow by its ID. + // + //Future getWorkflow(String id) async + test('test getWorkflow', () async { + // TODO + }); + + // Retrieve a workflow + // + // Retrieve a workflow details without ids, default values, etc. + // + //Future getWorkflowForShare(String id) async + test('test getWorkflowForShare', () async { + // TODO + }); + + // List all workflow triggers + // + // Retrieve a list of all available workflow triggers. + // + //Future> getWorkflowTriggers() async + test('test getWorkflowTriggers', () async { + // TODO + }); + + // List all workflows + // + // Retrieve a list of workflows available to the authenticated user. + // + //Future> searchWorkflows({ String description, bool enabled, String id, String name, WorkflowTrigger trigger }) async + test('test searchWorkflows', () async { + // TODO + }); + + // Update a workflow + // + // Update the information of a specific workflow by its ID. This endpoint can be used to update the workflow name, description, trigger type, filters and actions order, etc. + // + //Future updateWorkflow(String id, WorkflowUpdateDto workflowUpdateDto) async + test('test updateWorkflow', () async { + // TODO + }); + + }); +} diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json index bc3bf82094a27..969149764f25e 100644 --- a/open-api/immich-openapi-specs.json +++ b/open-api/immich-openapi-specs.json @@ -16237,236 +16237,1720 @@ ], "x-immich-permission": "workflow.read" } - } - }, - "info": { - "title": "Immich", - "description": "Immich API", - "version": "3.1.0", - "contact": {} - }, - "tags": [ - { - "name": "Activities", - "description": "An activity is a like or a comment made by a user on an asset or album." - }, - { - "name": "Albums", - "description": "An album is a collection of assets that can be shared with other users or via shared links." }, - { - "name": "API keys", - "description": "An api key can be used to programmatically access the Immich API." + "/yucca/auth/oidc/device": { + "get": { + "operationId": "oidcDeviceFlow", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeviceFlowResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Auth" + ] + } }, - { - "name": "Assets", - "description": "An asset is an image or video that has been uploaded to Immich." + "/yucca/backend": { + "get": { + "operationId": "getBackends", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BackendsResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Backend" + ] + } }, - { - "name": "Authentication", - "description": "Endpoints related to user authentication, including OAuth." + "/yucca/backend/local": { + "post": { + "operationId": "createLocalBackend", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateLocalBackendRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BackendResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Backend" + ] + } }, - { - "name": "Authentication (admin)", - "description": "Administrative endpoints related to authentication." + "/yucca/debug/reset": { + "post": { + "operationId": "resetOrchestrator", + "parameters": [], + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Development" + ] + } }, - { - "name": "Database Backups (admin)", - "description": "Manage backups of the Immich database." + "/yucca/fs": { + "get": { + "operationId": "getFileListing", + "parameters": [ + { + "name": "path", + "required": false, + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilesystemListingResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Filesystem" + ] + } }, - { - "name": "Deprecated", - "description": "Deprecated endpoints that are planned for removal in the next major release." + "/yucca/integrations": { + "get": { + "operationId": "getIntegrations", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IntegrationsResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Integrations" + ] + } }, - { - "name": "Download", - "description": "Endpoints for downloading assets or collections of assets." + "/yucca/integrations/immich": { + "post": { + "operationId": "configureImmichIntegration", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConfigureImmichIntegrationRequestDto" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Integrations" + ] + } }, - { - "name": "Duplicates", - "description": "Endpoints for managing and identifying duplicate assets." + "/yucca/integrations/immich/rollback": { + "post": { + "operationId": "startImmichRollback", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImmichRollbackRequestDto" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Integrations" + ] + } }, - { - "name": "Faces", - "description": "A face is a detected human face within an asset, which can be associated with a person. Faces are normally detected via machine learning, but can also be created manually." + "/yucca/logs/{id}": { + "get": { + "operationId": "getRun", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RunResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "RunHistory" + ] + } }, - { - "name": "Integrity (admin)", - "description": "Endpoints for viewing and managing integrity reports." + "/yucca/logs/{id}/stream": { + "get": { + "operationId": "logStreamSse", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "RunHistory" + ] + } }, - { - "name": "Jobs", - "description": "Queues and background jobs are used for processing tasks asynchronously. Queues can be paused and resumed as needed." + "/yucca/onboarding": { + "get": { + "operationId": "onboardingStatus", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OnboardingStatusResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Onboarding" + ] + } }, - { - "name": "Libraries", - "description": "An external library is made up of input file paths or expressions that are scanned for asset files. Discovered files are automatically imported. Assets much be unique within a library, but can be duplicated across libraries. Each user has a default upload library, and can have one or more external libraries." - }, - { - "name": "Maintenance (admin)", - "description": "Maintenance mode allows you to put Immich in a read-only state to perform various operations." - }, - { - "name": "Map", - "description": "Map endpoints include supplemental functionality related to geolocation, such as reverse geocoding and retrieving map markers for assets with geolocation data." - }, - { - "name": "Memories", - "description": "A memory is a specialized collection of assets with dedicated viewing implementations in the web and mobile clients. A memory includes fields related to visibility and are automatically generated per user via a background job." - }, - { - "name": "Notifications", - "description": "A notification is a specialized message sent to users to inform them of important events. Currently, these notifications are only shown in the Immich web application." - }, - { - "name": "Notifications (admin)", - "description": "Notification administrative endpoints." - }, - { - "name": "Partners", - "description": "A partner is a link with another user that allows sharing of assets between two users." - }, - { - "name": "People", - "description": "A person is a collection of faces, which can be favorited and named. A person can also be merged into another person. People are automatically created via the face recognition job." - }, - { - "name": "Plugins", - "description": "A plugin is an installed module that makes filters and actions available for the workflow feature." - }, - { - "name": "Queues", - "description": "Queues and background jobs are used for processing tasks asynchronously. Queues can be paused and resumed as needed." - }, - { - "name": "Search", - "description": "Endpoints related to searching assets via text, smart search, optical character recognition (OCR), and other filters like person, album, and other metadata. Search endpoints usually support pagination and sorting." - }, - { - "name": "Server", - "description": "Information about the current server deployment, including version and build information, available features, supported media types, and more." - }, - { - "name": "Sessions", - "description": "A session represents an authenticated login session for a user. Sessions also appear in the web application as \"Authorized devices\"." - }, - { - "name": "Shared links", - "description": "A shared link is a public url that provides access to a specific album, asset, or collection of assets. A shared link can be protected with a password, include a specific slug, allow or disallow downloads, and optionally include an expiration date." - }, - { - "name": "Stacks", - "description": "A stack is a group of related assets. One asset is the \"primary\" asset, and the rest are \"child\" assets. On the main timeline, stack parents are included by default, while child assets are hidden." - }, - { - "name": "Sync", - "description": "A collection of endpoints for the new mobile synchronization implementation." - }, - { - "name": "System config", - "description": "Endpoints to view, modify, and validate the system configuration settings." - }, - { - "name": "System metadata", - "description": "Endpoints to view, modify, and validate the system metadata, which includes information about things like admin onboarding status." - }, - { - "name": "Tags", - "description": "A tag is a user-defined label that can be applied to assets for organizational purposes. Tags can also be hierarchical, allowing for parent-child relationships between tags." - }, - { - "name": "Timeline", - "description": "Specialized endpoints related to the timeline implementation used in the web application. External applications or tools should not use or rely on these endpoints, as they are subject to change without notice." - }, - { - "name": "Trash", - "description": "Endpoints for managing the trash can, which includes assets that have been discarded. Items in the trash are automatically deleted after a configured amount of time." + "/yucca/onboarding/recovery-key": { + "get": { + "operationId": "currentRecoveryKey", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrentRecoveryKeyResponse" + } + } + }, + "description": "" + } + }, + "tags": [ + "Onboarding" + ] + }, + "post": { + "operationId": "confirmRecoveryKey", + "parameters": [], + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Onboarding" + ] + }, + "put": { + "operationId": "importRecoveryKey", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportRecoveryKeyRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "Onboarding" + ] + } }, - { - "name": "Users (admin)", - "description": "Administrative endpoints for managing users, including creating, updating, deleting, and restoring users. Also includes endpoints for resetting passwords and PIN codes." + "/yucca/onboarding/report-error": { + "post": { + "operationId": "reportError", + "parameters": [], + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Onboarding" + ] + } }, - { - "name": "Users", - "description": "Endpoints for viewing and updating the current users, including product key information, profile picture data, onboarding progress, and more." + "/yucca/onboarding/skip": { + "post": { + "operationId": "skipOnboardingExtraConfig", + "parameters": [], + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Onboarding" + ] + } }, - { - "name": "Views", - "description": "Endpoints for specialized views, such as the folder view." + "/yucca/onboarding/telemetry": { + "post": { + "operationId": "enableTelemetry", + "parameters": [], + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "Onboarding" + ] + } }, - { - "name": "Workflows", - "description": "A workflow is a set of actions that run whenever a triggering event occurs. Workflows also can include filters to further limit execution." - } - ], - "servers": [ - { - "url": "/api" - } - ], - "components": { - "securitySchemes": { - "bearer": { - "scheme": "Bearer", - "bearerFormat": "JWT", - "type": "http", - "in": "header" - }, - "cookie": { - "type": "apiKey", - "in": "cookie", - "name": "immich_access_token" + "/yucca/repository": { + "get": { + "operationId": "getRepositories", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryListResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] }, - "api_key": { - "type": "apiKey", - "in": "header", - "name": "x-api-key" + "post": { + "operationId": "createRepository", + "parameters": [ + { + "name": "backend", + "required": false, + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryCreateRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryCreateResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] } }, - "schemas": { - "ActivityCreateDto": { - "description": "Activity create", + "/yucca/repository/inspect": { + "get": { + "operationId": "inspectRepositories", + "parameters": [ + { + "name": "backend", + "required": false, + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryInspectResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}": { + "delete": { + "operationId": "deleteRepository", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "Repository" + ] + }, + "patch": { + "operationId": "updateRepository", + "parameters": [ + { + "name": "backend", + "required": false, + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryUpdateRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryUpdateResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + }, + "post": { + "operationId": "createBackup", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/backend": { + "put": { + "operationId": "reconfigureRepositoryPrimaryBackend", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryPrimaryBackendReconfigureRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryCreateResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/import": { + "get": { + "operationId": "checkImportRepository", + "parameters": [ + { + "name": "backend", + "required": true, + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryCheckImportResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + }, + "post": { + "operationId": "importRepository", + "parameters": [ + { + "name": "backend", + "required": true, + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositoryCreateResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/runs": { + "get": { + "operationId": "getRunHistory", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RunHistoryResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/snapshots": { + "get": { + "operationId": "getSnapshots", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListSnapshotsResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/snapshots/prune": { + "post": { + "operationId": "pruneRepository", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/snapshots/{snapshot}": { + "delete": { + "operationId": "forgetSnapshot", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "snapshot", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListSnapshotsResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + }, + "post": { + "operationId": "restoreSnapshot", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "snapshot", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositorySnapshotRestoreRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/snapshots/{snapshot}/listing": { + "get": { + "operationId": "getSnapshotListing", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "path", + "required": false, + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "snapshot", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FilesystemListingResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/repository/{id}/snapshots/{snapshot}/restore-from-point": { + "post": { + "operationId": "restoreFromPoint", + "parameters": [ + { + "name": "backend", + "required": true, + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "snapshot", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RepositorySnapshotRestoreFromPointRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Repository" + ] + } + }, + "/yucca/schedule": { + "get": { + "operationId": "getSchedules", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduleListResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Schedule" + ] + }, + "post": { + "operationId": "createSchedule", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduleCreateRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduleCreateResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Schedule" + ] + } + }, + "/yucca/schedule/{id}": { + "delete": { + "operationId": "removeSchedule", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "tags": [ + "Schedule" + ] + }, + "patch": { + "operationId": "updateSchedule", + "parameters": [ + { + "name": "id", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduleUpdateRequestDto" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduleUpdateResponseDto" + } + } + }, + "description": "" + } + }, + "tags": [ + "Schedule" + ] + } + }, + "/yucca/tasks": { + "get": { + "operationId": "getRunningTasks", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RunningTaskListResponse" + } + } + }, + "description": "" + } + }, + "tags": [ + "RunningTasks" + ] + } + }, + "/yucca/tasks/{parentId}/cancel": { + "post": { + "operationId": "cancelTask", + "parameters": [ + { + "name": "parentId", + "required": true, + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "" + } + }, + "tags": [ + "RunningTasks" + ] + } + } + }, + "info": { + "title": "Immich", + "description": "Immich API", + "version": "3.1.0", + "contact": {} + }, + "tags": [ + { + "name": "Activities", + "description": "An activity is a like or a comment made by a user on an asset or album." + }, + { + "name": "Albums", + "description": "An album is a collection of assets that can be shared with other users or via shared links." + }, + { + "name": "API keys", + "description": "An api key can be used to programmatically access the Immich API." + }, + { + "name": "Assets", + "description": "An asset is an image or video that has been uploaded to Immich." + }, + { + "name": "Authentication", + "description": "Endpoints related to user authentication, including OAuth." + }, + { + "name": "Authentication (admin)", + "description": "Administrative endpoints related to authentication." + }, + { + "name": "Database Backups (admin)", + "description": "Manage backups of the Immich database." + }, + { + "name": "Deprecated", + "description": "Deprecated endpoints that are planned for removal in the next major release." + }, + { + "name": "Download", + "description": "Endpoints for downloading assets or collections of assets." + }, + { + "name": "Duplicates", + "description": "Endpoints for managing and identifying duplicate assets." + }, + { + "name": "Faces", + "description": "A face is a detected human face within an asset, which can be associated with a person. Faces are normally detected via machine learning, but can also be created manually." + }, + { + "name": "Integrity (admin)", + "description": "Endpoints for viewing and managing integrity reports." + }, + { + "name": "Jobs", + "description": "Queues and background jobs are used for processing tasks asynchronously. Queues can be paused and resumed as needed." + }, + { + "name": "Libraries", + "description": "An external library is made up of input file paths or expressions that are scanned for asset files. Discovered files are automatically imported. Assets much be unique within a library, but can be duplicated across libraries. Each user has a default upload library, and can have one or more external libraries." + }, + { + "name": "Maintenance (admin)", + "description": "Maintenance mode allows you to put Immich in a read-only state to perform various operations." + }, + { + "name": "Map", + "description": "Map endpoints include supplemental functionality related to geolocation, such as reverse geocoding and retrieving map markers for assets with geolocation data." + }, + { + "name": "Memories", + "description": "A memory is a specialized collection of assets with dedicated viewing implementations in the web and mobile clients. A memory includes fields related to visibility and are automatically generated per user via a background job." + }, + { + "name": "Notifications", + "description": "A notification is a specialized message sent to users to inform them of important events. Currently, these notifications are only shown in the Immich web application." + }, + { + "name": "Notifications (admin)", + "description": "Notification administrative endpoints." + }, + { + "name": "Partners", + "description": "A partner is a link with another user that allows sharing of assets between two users." + }, + { + "name": "People", + "description": "A person is a collection of faces, which can be favorited and named. A person can also be merged into another person. People are automatically created via the face recognition job." + }, + { + "name": "Plugins", + "description": "A plugin is an installed module that makes filters and actions available for the workflow feature." + }, + { + "name": "Queues", + "description": "Queues and background jobs are used for processing tasks asynchronously. Queues can be paused and resumed as needed." + }, + { + "name": "Search", + "description": "Endpoints related to searching assets via text, smart search, optical character recognition (OCR), and other filters like person, album, and other metadata. Search endpoints usually support pagination and sorting." + }, + { + "name": "Server", + "description": "Information about the current server deployment, including version and build information, available features, supported media types, and more." + }, + { + "name": "Sessions", + "description": "A session represents an authenticated login session for a user. Sessions also appear in the web application as \"Authorized devices\"." + }, + { + "name": "Shared links", + "description": "A shared link is a public url that provides access to a specific album, asset, or collection of assets. A shared link can be protected with a password, include a specific slug, allow or disallow downloads, and optionally include an expiration date." + }, + { + "name": "Stacks", + "description": "A stack is a group of related assets. One asset is the \"primary\" asset, and the rest are \"child\" assets. On the main timeline, stack parents are included by default, while child assets are hidden." + }, + { + "name": "Sync", + "description": "A collection of endpoints for the new mobile synchronization implementation." + }, + { + "name": "System config", + "description": "Endpoints to view, modify, and validate the system configuration settings." + }, + { + "name": "System metadata", + "description": "Endpoints to view, modify, and validate the system metadata, which includes information about things like admin onboarding status." + }, + { + "name": "Tags", + "description": "A tag is a user-defined label that can be applied to assets for organizational purposes. Tags can also be hierarchical, allowing for parent-child relationships between tags." + }, + { + "name": "Timeline", + "description": "Specialized endpoints related to the timeline implementation used in the web application. External applications or tools should not use or rely on these endpoints, as they are subject to change without notice." + }, + { + "name": "Trash", + "description": "Endpoints for managing the trash can, which includes assets that have been discarded. Items in the trash are automatically deleted after a configured amount of time." + }, + { + "name": "Users (admin)", + "description": "Administrative endpoints for managing users, including creating, updating, deleting, and restoring users. Also includes endpoints for resetting passwords and PIN codes." + }, + { + "name": "Users", + "description": "Endpoints for viewing and updating the current users, including product key information, profile picture data, onboarding progress, and more." + }, + { + "name": "Views", + "description": "Endpoints for specialized views, such as the folder view." + }, + { + "name": "Workflows", + "description": "A workflow is a set of actions that run whenever a triggering event occurs. Workflows also can include filters to further limit execution." + } + ], + "servers": [ + { + "url": "/api" + } + ], + "components": { + "securitySchemes": { + "bearer": { + "scheme": "Bearer", + "bearerFormat": "JWT", + "type": "http", + "in": "header" + }, + "cookie": { + "type": "apiKey", + "in": "cookie", + "name": "immich_access_token" + }, + "api_key": { + "type": "apiKey", + "in": "header", + "name": "x-api-key" + } + }, + "schemas": { + "ActiveScheduleItemDto": { + "properties": { + "repositoryId": { + "type": "string" + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/TaskStatus" + } + ] + } + }, + "required": [ + "repositoryId", + "status" + ], + "type": "object" + }, + "ActivityCreateDto": { + "description": "Activity create", + "properties": { + "albumId": { + "description": "Album ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "assetId": { + "description": "Asset ID (if activity is for an asset)", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "comment": { + "description": "Comment text (required if type is comment)", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ReactionType" + } + }, + "required": [ + "albumId", + "type" + ], + "type": "object" + }, + "ActivityResponseDto": { + "properties": { + "assetId": { + "description": "Asset ID (if activity is for an asset)", + "format": "uuid", + "nullable": true, + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "comment": { + "description": "Comment text (for comment activities)", + "nullable": true, + "type": "string" + }, + "createdAt": { + "description": "Creation date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "id": { + "description": "Activity ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/ReactionType" + }, + "user": { + "$ref": "#/components/schemas/UserResponseDto" + } + }, + "required": [ + "assetId", + "createdAt", + "id", + "type", + "user" + ], + "type": "object" + }, + "ActivityStatisticsResponseDto": { + "properties": { + "comments": { + "description": "Number of comments", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + }, + "likes": { + "description": "Number of likes", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "comments", + "likes" + ], + "type": "object" + }, + "AddUsersDto": { + "properties": { + "albumUsers": { + "description": "Album users to add", + "items": { + "$ref": "#/components/schemas/AlbumUserAddDto" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "albumUsers" + ], + "type": "object" + }, + "AdminOnboardingUpdateDto": { + "properties": { + "isOnboarded": { + "description": "Is admin onboarded", + "type": "boolean" + } + }, + "required": [ + "isOnboarded" + ], + "type": "object" + }, + "AlbumResponseDto": { + "properties": { + "albumName": { + "description": "Album name", + "type": "string" + }, + "albumThumbnailAssetId": { + "description": "Thumbnail asset ID", + "format": "uuid", + "nullable": true, + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "albumUsers": { + "description": "First entry is always the album owner. Second entry is the auth user, if it differs from the owner. The rest are ordered alphabetically.", + "items": { + "$ref": "#/components/schemas/AlbumUserResponseDto" + }, + "minItems": 1, + "type": "array" + }, + "assetCount": { + "description": "Number of assets", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + }, + "contributorCounts": { + "items": { + "$ref": "#/components/schemas/ContributorCountResponseDto" + }, + "type": "array" + }, + "createdAt": { + "description": "Creation date", + "format": "date-time", + "type": "string" + }, + "description": { + "description": "Album description", + "type": "string", + "x-immich-history": [ + { + "version": "v1", + "state": "Added" + }, + { + "version": "v3", + "state": "Updated", + "description": "An empty string is returned instead of null for backwards compatibility; null will be returned in v4." + } + ] + }, + "endDate": { + "description": "End date (latest asset)", + "format": "date-time", + "type": "string" + }, + "hasSharedLink": { + "description": "Has shared link", + "type": "boolean" + }, + "id": { + "description": "Album ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "isActivityEnabled": { + "description": "Activity feed enabled", + "type": "boolean" + }, + "lastModifiedAssetTimestamp": { + "description": "Last modified asset timestamp", + "format": "date-time", + "type": "string" + }, + "order": { + "$ref": "#/components/schemas/AssetOrder" + }, + "shared": { + "description": "Is shared album", + "type": "boolean" + }, + "startDate": { + "description": "Start date (earliest asset)", + "format": "date-time", + "type": "string" + }, + "updatedAt": { + "description": "Last update date", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "albumName", + "albumThumbnailAssetId", + "albumUsers", + "assetCount", + "createdAt", + "description", + "hasSharedLink", + "id", + "isActivityEnabled", + "shared", + "updatedAt" + ], + "type": "object" + }, + "AlbumStatisticsResponseDto": { + "properties": { + "notShared": { + "description": "Number of non-shared albums", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + }, + "owned": { + "description": "Number of owned albums", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + }, + "shared": { + "description": "Number of shared albums", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "notShared", + "owned", + "shared" + ], + "type": "object" + }, + "AlbumUserAddDto": { + "properties": { + "role": { + "$ref": "#/components/schemas/AlbumUserRole", + "default": "editor", + "description": "Album user role" + }, + "userId": { + "description": "User ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + } + }, + "required": [ + "userId" + ], + "type": "object" + }, + "AlbumUserCreateDto": { + "properties": { + "role": { + "$ref": "#/components/schemas/AlbumUserRole" + }, + "userId": { + "description": "User ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + } + }, + "required": [ + "role", + "userId" + ], + "type": "object" + }, + "AlbumUserResponseDto": { + "properties": { + "role": { + "$ref": "#/components/schemas/AlbumUserRole" + }, + "user": { + "$ref": "#/components/schemas/UserResponseDto" + } + }, + "required": [ + "role", + "user" + ], + "type": "object" + }, + "AlbumUserRole": { + "description": "Album user role", + "enum": [ + "editor", + "owner", + "viewer" + ], + "type": "string" + }, + "AlbumsAddAssetsDto": { "properties": { - "albumId": { - "description": "Album ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "albumIds": { + "description": "Album IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" }, - "assetId": { - "description": "Asset ID (if activity is for an asset)", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "assetIds": { + "description": "Asset IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "albumIds", + "assetIds" + ], + "type": "object" + }, + "AlbumsAddAssetsResponseDto": { + "properties": { + "error": { + "$ref": "#/components/schemas/BulkIdErrorReason" }, - "comment": { - "description": "Comment text (required if type is comment)", + "success": { + "description": "Operation success", + "type": "boolean" + } + }, + "required": [ + "success" + ], + "type": "object" + }, + "AlbumsResponse": { + "properties": { + "defaultAssetOrder": { + "$ref": "#/components/schemas/AssetOrder" + } + }, + "required": [ + "defaultAssetOrder" + ], + "type": "object" + }, + "AlbumsUpdate": { + "description": "Album preferences", + "properties": { + "defaultAssetOrder": { + "$ref": "#/components/schemas/AssetOrder" + } + }, + "type": "object" + }, + "ApiKeyCreateDto": { + "properties": { + "name": { + "description": "API key name", "type": "string" }, - "type": { - "$ref": "#/components/schemas/ReactionType" + "permissions": { + "description": "List of permissions", + "items": { + "$ref": "#/components/schemas/Permission" + }, + "minItems": 1, + "type": "array" } }, "required": [ - "albumId", - "type" + "permissions" ], "type": "object" }, - "ActivityResponseDto": { + "ApiKeyCreateResponseDto": { "properties": { - "assetId": { - "description": "Asset ID (if activity is for an asset)", - "format": "uuid", - "nullable": true, - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "apiKey": { + "$ref": "#/components/schemas/ApiKeyResponseDto" }, - "comment": { - "description": "Comment text (for comment activities)", - "nullable": true, + "secret": { + "description": "API key secret (only shown once)", "type": "string" - }, + } + }, + "required": [ + "apiKey", + "secret" + ], + "type": "object" + }, + "ApiKeyResponseDto": { + "properties": { "createdAt": { "description": "Creation date", "example": "2024-01-01T00:00:00.000Z", @@ -16475,765 +17959,781 @@ "type": "string" }, "id": { - "description": "Activity ID", + "description": "API key ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "type": { - "$ref": "#/components/schemas/ReactionType" + "name": { + "description": "API key name", + "type": "string" }, - "user": { - "$ref": "#/components/schemas/UserResponseDto" + "permissions": { + "description": "List of permissions", + "items": { + "$ref": "#/components/schemas/Permission" + }, + "type": "array" + }, + "updatedAt": { + "description": "Last update date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" } }, "required": [ - "assetId", "createdAt", "id", - "type", - "user" + "name", + "permissions", + "updatedAt" ], "type": "object" }, - "ActivityStatisticsResponseDto": { + "ApiKeyUpdateDto": { "properties": { - "comments": { - "description": "Number of comments", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "name": { + "description": "API key name", + "type": "string" }, - "likes": { - "description": "Number of likes", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "comments", - "likes" - ], - "type": "object" - }, - "AddUsersDto": { - "properties": { - "albumUsers": { - "description": "Album users to add", + "permissions": { + "description": "List of permissions", "items": { - "$ref": "#/components/schemas/AlbumUserAddDto" + "$ref": "#/components/schemas/Permission" }, "minItems": 1, "type": "array" } }, - "required": [ - "albumUsers" - ], "type": "object" }, - "AdminOnboardingUpdateDto": { + "AssetBulkDeleteDto": { "properties": { - "isOnboarded": { - "description": "Is admin onboarded", + "force": { + "description": "Force delete even if in use", "type": "boolean" + }, + "ids": { + "description": "IDs to process", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" } }, "required": [ - "isOnboarded" + "ids" ], "type": "object" }, - "AlbumResponseDto": { + "AssetBulkUpdateDto": { "properties": { - "albumName": { - "description": "Album name", + "dateTimeOriginal": { + "description": "Original date and time", "type": "string" }, - "albumThumbnailAssetId": { - "description": "Thumbnail asset ID", - "format": "uuid", + "dateTimeRelative": { + "description": "Relative time offset in minutes", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "description": { + "description": "Asset description", + "type": "string" + }, + "duplicateId": { + "description": "Duplicate ID", "nullable": true, - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "albumUsers": { - "description": "First entry is always the album owner. Second entry is the auth user, if it differs from the owner. The rest are ordered alphabetically.", + "ids": { + "description": "Asset IDs to update", "items": { - "$ref": "#/components/schemas/AlbumUserResponseDto" + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" }, - "minItems": 1, "type": "array" }, - "assetCount": { - "description": "Number of assets", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "isFavorite": { + "description": "Mark as favorite", + "type": "boolean" }, - "contributorCounts": { - "items": { - "$ref": "#/components/schemas/ContributorCountResponseDto" - }, - "type": "array" + "latitude": { + "description": "Latitude coordinate", + "maximum": 90, + "minimum": -90, + "type": "number" }, - "createdAt": { - "description": "Creation date", - "format": "date-time", - "type": "string" + "longitude": { + "description": "Longitude coordinate", + "maximum": 180, + "minimum": -180, + "type": "number" }, - "description": { - "description": "Album description", - "type": "string", + "rating": { + "description": "Rating in range [1-5] (starred), -1 (rejected), or null (unrated)", + "maximum": 5, + "minimum": -1, + "nullable": true, + "type": "integer", "x-immich-history": [ { "version": "v1", "state": "Added" }, + { + "version": "v2", + "state": "Stable" + }, { "version": "v3", "state": "Updated", - "description": "An empty string is returned instead of null for backwards compatibility; null will be returned in v4." + "description": "Using 0 as a rating is no longer valid." } - ] - }, - "endDate": { - "description": "End date (latest asset)", - "format": "date-time", - "type": "string" - }, - "hasSharedLink": { - "description": "Has shared link", - "type": "boolean" - }, - "id": { - "description": "Album ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "isActivityEnabled": { - "description": "Activity feed enabled", - "type": "boolean" - }, - "lastModifiedAssetTimestamp": { - "description": "Last modified asset timestamp", - "format": "date-time", - "type": "string" - }, - "order": { - "$ref": "#/components/schemas/AssetOrder" - }, - "shared": { - "description": "Is shared album", - "type": "boolean" + ], + "x-immich-state": "Stable" }, - "startDate": { - "description": "Start date (earliest asset)", - "format": "date-time", + "timeZone": { + "description": "Time zone (IANA timezone)", "type": "string" }, - "updatedAt": { - "description": "Last update date", - "format": "date-time", - "type": "string" + "visibility": { + "$ref": "#/components/schemas/AssetVisibility" } }, "required": [ - "albumName", - "albumThumbnailAssetId", - "albumUsers", - "assetCount", - "createdAt", - "description", - "hasSharedLink", - "id", - "isActivityEnabled", - "shared", - "updatedAt" + "ids" ], "type": "object" }, - "AlbumStatisticsResponseDto": { + "AssetBulkUploadCheckDto": { "properties": { - "notShared": { - "description": "Number of non-shared albums", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "owned": { - "description": "Number of owned albums", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "shared": { - "description": "Number of shared albums", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "assets": { + "description": "Assets to check", + "items": { + "$ref": "#/components/schemas/AssetBulkUploadCheckItem" + }, + "type": "array" } }, "required": [ - "notShared", - "owned", - "shared" + "assets" ], "type": "object" }, - "AlbumUserAddDto": { + "AssetBulkUploadCheckItem": { "properties": { - "role": { - "$ref": "#/components/schemas/AlbumUserRole", - "default": "editor", - "description": "Album user role" + "checksum": { + "description": "Base64 or hex encoded SHA1 hash", + "type": "string" }, - "userId": { - "description": "User ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "id": { + "description": "Client-side identifier echoed in the response to match results to inputs (e.g. filename)", "type": "string" } }, "required": [ - "userId" + "checksum", + "id" ], "type": "object" }, - "AlbumUserCreateDto": { + "AssetBulkUploadCheckResponseDto": { "properties": { - "role": { - "$ref": "#/components/schemas/AlbumUserRole" - }, - "userId": { - "description": "User ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "results": { + "description": "Upload check results", + "items": { + "$ref": "#/components/schemas/AssetBulkUploadCheckResult" + }, + "type": "array" } }, "required": [ - "role", - "userId" + "results" ], "type": "object" }, - "AlbumUserResponseDto": { + "AssetBulkUploadCheckResult": { "properties": { - "role": { - "$ref": "#/components/schemas/AlbumUserRole" + "action": { + "$ref": "#/components/schemas/AssetUploadAction" }, - "user": { - "$ref": "#/components/schemas/UserResponseDto" + "assetId": { + "description": "Existing asset ID if duplicate", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "id": { + "description": "Client-side identifier echoed from the request to match results to inputs", + "type": "string" + }, + "isTrashed": { + "description": "Whether existing asset is trashed", + "type": "boolean" + }, + "reason": { + "$ref": "#/components/schemas/AssetRejectReason" } }, "required": [ - "role", - "user" + "action", + "id" ], "type": "object" }, - "AlbumUserRole": { - "description": "Album user role", - "enum": [ - "editor", - "owner", - "viewer" - ], - "type": "string" - }, - "AlbumsAddAssetsDto": { + "AssetCopyDto": { "properties": { - "albumIds": { - "description": "Album IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" + "albums": { + "default": true, + "description": "Copy album associations", + "type": "boolean" }, - "assetIds": { - "description": "Asset IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" + "favorite": { + "default": true, + "description": "Copy favorite status", + "type": "boolean" + }, + "sharedLinks": { + "default": true, + "description": "Copy shared links", + "type": "boolean" + }, + "sidecar": { + "default": true, + "description": "Copy sidecar file", + "type": "boolean" + }, + "sourceId": { + "description": "Source asset ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "stack": { + "default": true, + "description": "Copy stack association", + "type": "boolean" + }, + "targetId": { + "description": "Target asset ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" } }, "required": [ - "albumIds", - "assetIds" + "sourceId", + "targetId" ], "type": "object" }, - "AlbumsAddAssetsResponseDto": { + "AssetEditAction": { + "description": "Type of edit action to perform", + "enum": [ + "crop", + "rotate", + "mirror" + ], + "type": "string" + }, + "AssetEditActionItemDto": { "properties": { - "error": { - "$ref": "#/components/schemas/BulkIdErrorReason" + "action": { + "$ref": "#/components/schemas/AssetEditAction" }, - "success": { - "description": "Operation success", - "type": "boolean" + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/CropParameters" + }, + { + "$ref": "#/components/schemas/RotateParameters" + }, + { + "$ref": "#/components/schemas/MirrorParameters" + } + ], + "description": "List of edit actions to apply (crop, rotate, or mirror)" } }, "required": [ - "success" + "action", + "parameters" ], "type": "object" }, - "AlbumsResponse": { + "AssetEditActionItemResponseDto": { "properties": { - "defaultAssetOrder": { - "$ref": "#/components/schemas/AssetOrder" + "action": { + "$ref": "#/components/schemas/AssetEditAction" + }, + "id": { + "description": "Asset edit ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "parameters": { + "anyOf": [ + { + "$ref": "#/components/schemas/CropParameters" + }, + { + "$ref": "#/components/schemas/RotateParameters" + }, + { + "$ref": "#/components/schemas/MirrorParameters" + } + ], + "description": "List of edit actions to apply (crop, rotate, or mirror)" } }, "required": [ - "defaultAssetOrder" + "action", + "id", + "parameters" ], "type": "object" }, - "AlbumsUpdate": { - "description": "Album preferences", - "properties": { - "defaultAssetOrder": { - "$ref": "#/components/schemas/AssetOrder" - } - }, - "type": "object" - }, - "ApiKeyCreateDto": { + "AssetEditsCreateDto": { "properties": { - "name": { - "description": "API key name", - "type": "string" - }, - "permissions": { - "description": "List of permissions", + "edits": { + "description": "List of edit actions to apply (crop, rotate, or mirror)", "items": { - "$ref": "#/components/schemas/Permission" + "$ref": "#/components/schemas/AssetEditActionItemDto" }, "minItems": 1, "type": "array" } }, "required": [ - "permissions" + "edits" ], "type": "object" }, - "ApiKeyCreateResponseDto": { + "AssetEditsResponseDto": { "properties": { - "apiKey": { - "$ref": "#/components/schemas/ApiKeyResponseDto" - }, - "secret": { - "description": "API key secret (only shown once)", + "assetId": { + "description": "Asset ID these edits belong to", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" + }, + "edits": { + "description": "List of edit actions applied to the asset", + "items": { + "$ref": "#/components/schemas/AssetEditActionItemResponseDto" + }, + "type": "array" } }, "required": [ - "apiKey", - "secret" + "assetId", + "edits" ], "type": "object" }, - "ApiKeyResponseDto": { + "AssetFaceCreateDto": { "properties": { - "createdAt": { - "description": "Creation date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "assetId": { + "description": "Asset ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "id": { - "description": "API key ID", + "height": { + "description": "Face bounding box height", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "imageHeight": { + "description": "Image height in pixels", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "imageWidth": { + "description": "Image width in pixels", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "personId": { + "description": "Person ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "name": { - "description": "API key name", - "type": "string" + "width": { + "description": "Face bounding box width", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "permissions": { - "description": "List of permissions", - "items": { - "$ref": "#/components/schemas/Permission" - }, - "type": "array" + "x": { + "description": "Face bounding box X coordinate", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "updatedAt": { - "description": "Last update date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" + "y": { + "description": "Face bounding box Y coordinate", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" } }, "required": [ - "createdAt", - "id", - "name", - "permissions", - "updatedAt" + "assetId", + "height", + "imageHeight", + "imageWidth", + "personId", + "width", + "x", + "y" ], "type": "object" }, - "ApiKeyUpdateDto": { - "properties": { - "name": { - "description": "API key name", - "type": "string" - }, - "permissions": { - "description": "List of permissions", - "items": { - "$ref": "#/components/schemas/Permission" - }, - "minItems": 1, - "type": "array" - } - }, - "type": "object" - }, - "AssetBulkDeleteDto": { + "AssetFaceDeleteDto": { "properties": { "force": { - "description": "Force delete even if in use", + "description": "Force delete even if person has other faces", "type": "boolean" - }, - "ids": { - "description": "IDs to process", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" } }, "required": [ - "ids" + "force" ], "type": "object" }, - "AssetBulkUpdateDto": { + "AssetFaceResponseDto": { + "description": "Asset face with person", "properties": { - "dateTimeOriginal": { - "description": "Original date and time", - "type": "string" - }, - "dateTimeRelative": { - "description": "Relative time offset in minutes", + "boundingBoxX1": { + "description": "Bounding box X1 coordinate", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, - "description": { - "description": "Asset description", - "type": "string" + "boundingBoxX2": { + "description": "Bounding box X2 coordinate", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "duplicateId": { - "description": "Duplicate ID", - "nullable": true, - "type": "string" + "boundingBoxY1": { + "description": "Bounding box Y1 coordinate", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "ids": { - "description": "Asset IDs to update", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" + "boundingBoxY2": { + "description": "Bounding box Y2 coordinate", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "isFavorite": { - "description": "Mark as favorite", - "type": "boolean" + "id": { + "description": "Face ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" }, - "latitude": { - "description": "Latitude coordinate", - "maximum": 90, - "minimum": -90, - "type": "number" + "imageHeight": { + "description": "Image height in pixels", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" }, - "longitude": { - "description": "Longitude coordinate", - "maximum": 180, - "minimum": -180, - "type": "number" + "imageWidth": { + "description": "Image width in pixels", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" }, - "rating": { - "description": "Rating in range [1-5] (starred), -1 (rejected), or null (unrated)", - "maximum": 5, - "minimum": -1, - "nullable": true, - "type": "integer", - "x-immich-history": [ - { - "version": "v1", - "state": "Added" - }, - { - "version": "v2", - "state": "Stable" - }, + "person": { + "allOf": [ { - "version": "v3", - "state": "Updated", - "description": "Using 0 as a rating is no longer valid." + "$ref": "#/components/schemas/PersonResponseDto" } ], - "x-immich-state": "Stable" - }, - "timeZone": { - "description": "Time zone (IANA timezone)", - "type": "string" + "nullable": true }, - "visibility": { - "$ref": "#/components/schemas/AssetVisibility" + "sourceType": { + "$ref": "#/components/schemas/SourceType" } }, "required": [ - "ids" + "boundingBoxX1", + "boundingBoxX2", + "boundingBoxY1", + "boundingBoxY2", + "id", + "imageHeight", + "imageWidth", + "person" ], "type": "object" }, - "AssetBulkUploadCheckDto": { + "AssetFaceUpdateDto": { "properties": { - "assets": { - "description": "Assets to check", + "data": { + "description": "Face update items", "items": { - "$ref": "#/components/schemas/AssetBulkUploadCheckItem" + "$ref": "#/components/schemas/AssetFaceUpdateItem" }, "type": "array" } }, "required": [ - "assets" + "data" ], "type": "object" }, - "AssetBulkUploadCheckItem": { + "AssetFaceUpdateItem": { "properties": { - "checksum": { - "description": "Base64 or hex encoded SHA1 hash", + "assetId": { + "description": "Asset ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "id": { - "description": "Client-side identifier echoed in the response to match results to inputs (e.g. filename)", + "personId": { + "description": "Person ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" } }, "required": [ - "checksum", - "id" + "assetId", + "personId" ], "type": "object" }, - "AssetBulkUploadCheckResponseDto": { + "AssetIdErrorReason": { + "description": "Error reason if failed", + "enum": [ + "duplicate", + "no_permission", + "not_found" + ], + "type": "string" + }, + "AssetIdsDto": { "properties": { - "results": { - "description": "Upload check results", + "assetIds": { + "description": "Asset IDs", "items": { - "$ref": "#/components/schemas/AssetBulkUploadCheckResult" + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" }, "type": "array" } }, "required": [ - "results" + "assetIds" ], "type": "object" }, - "AssetBulkUploadCheckResult": { + "AssetIdsResponseDto": { "properties": { - "action": { - "$ref": "#/components/schemas/AssetUploadAction" - }, "assetId": { - "description": "Existing asset ID if duplicate", + "description": "Asset ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "id": { - "description": "Client-side identifier echoed from the request to match results to inputs", - "type": "string" + "error": { + "$ref": "#/components/schemas/AssetIdErrorReason" }, - "isTrashed": { - "description": "Whether existing asset is trashed", + "success": { + "description": "Whether operation succeeded", "type": "boolean" + } + }, + "required": [ + "assetId", + "success" + ], + "type": "object" + }, + "AssetJobName": { + "description": "Job name", + "enum": [ + "refresh-faces", + "refresh-metadata", + "regenerate-thumbnail", + "transcode-video" + ], + "type": "string" + }, + "AssetJobsDto": { + "properties": { + "assetIds": { + "description": "Asset IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" }, - "reason": { - "$ref": "#/components/schemas/AssetRejectReason" + "name": { + "$ref": "#/components/schemas/AssetJobName" } }, "required": [ - "action", - "id" + "assetIds", + "name" ], "type": "object" }, - "AssetCopyDto": { + "AssetMediaCreateDto": { "properties": { - "albums": { - "default": true, - "description": "Copy album associations", - "type": "boolean" + "assetData": { + "description": "Asset file data", + "format": "binary", + "type": "string" }, - "favorite": { - "default": true, - "description": "Copy favorite status", - "type": "boolean" + "duration": { + "description": "Duration in milliseconds (for videos)", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" }, - "sharedLinks": { - "default": true, - "description": "Copy shared links", - "type": "boolean" + "fileCreatedAt": { + "description": "File creation date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" }, - "sidecar": { - "default": true, - "description": "Copy sidecar file", - "type": "boolean" + "fileModifiedAt": { + "description": "File modification date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" }, - "sourceId": { - "description": "Source asset ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "filename": { + "description": "Filename", "type": "string" }, - "stack": { - "default": true, - "description": "Copy stack association", + "isFavorite": { + "description": "Mark as favorite", "type": "boolean" }, - "targetId": { - "description": "Target asset ID", + "livePhotoVideoId": { + "description": "Live photo video ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" - } - }, - "required": [ - "sourceId", - "targetId" - ], - "type": "object" - }, - "AssetEditAction": { - "description": "Type of edit action to perform", - "enum": [ - "crop", - "rotate", - "mirror" - ], - "type": "string" - }, - "AssetEditActionItemDto": { - "properties": { - "action": { - "$ref": "#/components/schemas/AssetEditAction" }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/CropParameters" - }, - { - "$ref": "#/components/schemas/RotateParameters" - }, - { - "$ref": "#/components/schemas/MirrorParameters" - } - ], - "description": "List of edit actions to apply (crop, rotate, or mirror)" + "metadata": { + "description": "Asset metadata items", + "items": { + "$ref": "#/components/schemas/AssetMetadataUpsertItemDto" + }, + "type": "array" + }, + "sidecarData": { + "description": "Sidecar file data", + "format": "binary", + "type": "string" + }, + "visibility": { + "$ref": "#/components/schemas/AssetVisibility" } }, "required": [ - "action", - "parameters" + "assetData", + "fileCreatedAt", + "fileModifiedAt" ], "type": "object" }, - "AssetEditActionItemResponseDto": { + "AssetMediaResponseDto": { "properties": { - "action": { - "$ref": "#/components/schemas/AssetEditAction" - }, "id": { - "description": "Asset edit ID", + "description": "Asset media ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "parameters": { - "anyOf": [ - { - "$ref": "#/components/schemas/CropParameters" - }, - { - "$ref": "#/components/schemas/RotateParameters" - }, - { - "$ref": "#/components/schemas/MirrorParameters" - } - ], - "description": "List of edit actions to apply (crop, rotate, or mirror)" + "status": { + "$ref": "#/components/schemas/AssetMediaStatus" } }, "required": [ - "action", "id", - "parameters" + "status" ], "type": "object" }, - "AssetEditsCreateDto": { + "AssetMediaSize": { + "description": "Asset media size", + "enum": [ + "original", + "fullsize", + "preview", + "thumbnail" + ], + "type": "string" + }, + "AssetMediaStatus": { + "description": "Upload status", + "enum": [ + "created", + "duplicate" + ], + "type": "string" + }, + "AssetMetadataBulkDeleteDto": { "properties": { - "edits": { - "description": "List of edit actions to apply (crop, rotate, or mirror)", + "items": { + "description": "Metadata items to delete", "items": { - "$ref": "#/components/schemas/AssetEditActionItemDto" + "$ref": "#/components/schemas/AssetMetadataBulkDeleteItemDto" }, - "minItems": 1, "type": "array" } }, "required": [ - "edits" + "items" ], "type": "object" }, - "AssetEditsResponseDto": { + "AssetMetadataBulkDeleteItemDto": { "properties": { "assetId": { - "description": "Asset ID these edits belong to", + "description": "Asset ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "edits": { - "description": "List of edit actions applied to the asset", - "items": { - "$ref": "#/components/schemas/AssetEditActionItemResponseDto" - }, - "type": "array" + "key": { + "description": "Metadata key", + "type": "string" } }, "required": [ "assetId", - "edits" + "key" ], "type": "object" }, - "AssetFaceCreateDto": { + "AssetMetadataBulkResponseDto": { "properties": { "assetId": { "description": "Asset ID", @@ -17241,722 +18741,957 @@ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "height": { - "description": "Face bounding box height", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "imageHeight": { - "description": "Image height in pixels", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "imageWidth": { - "description": "Image width in pixels", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "personId": { - "description": "Person ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "key": { + "description": "Metadata key", "type": "string" }, - "width": { - "description": "Face bounding box width", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "x": { - "description": "Face bounding box X coordinate", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "updatedAt": { + "description": "Last update date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" }, - "y": { - "description": "Face bounding box Y coordinate", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "value": { + "additionalProperties": {}, + "description": "Metadata value (object)", + "type": "object" } }, "required": [ "assetId", - "height", - "imageHeight", - "imageWidth", - "personId", - "width", - "x", - "y" + "key", + "updatedAt", + "value" ], "type": "object" }, - "AssetFaceDeleteDto": { + "AssetMetadataBulkUpsertDto": { "properties": { - "force": { - "description": "Force delete even if person has other faces", - "type": "boolean" + "items": { + "description": "Metadata items to upsert", + "items": { + "$ref": "#/components/schemas/AssetMetadataBulkUpsertItemDto" + }, + "type": "array" } }, "required": [ - "force" + "items" ], "type": "object" }, - "AssetFaceResponseDto": { - "description": "Asset face with person", + "AssetMetadataBulkUpsertItemDto": { "properties": { - "boundingBoxX1": { - "description": "Bounding box X1 coordinate", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "boundingBoxX2": { - "description": "Bounding box X2 coordinate", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "boundingBoxY1": { - "description": "Bounding box Y1 coordinate", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "boundingBoxY2": { - "description": "Bounding box Y2 coordinate", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "id": { - "description": "Face ID", + "assetId": { + "description": "Asset ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "imageHeight": { - "description": "Image height in pixels", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "key": { + "description": "Metadata key", + "type": "string" }, - "imageWidth": { - "description": "Image width in pixels", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "value": { + "additionalProperties": {}, + "description": "Metadata value (object)", + "type": "object" + } + }, + "required": [ + "assetId", + "key", + "value" + ], + "type": "object" + }, + "AssetMetadataResponseDto": { + "properties": { + "key": { + "description": "Metadata key", + "type": "string" }, - "person": { - "allOf": [ - { - "$ref": "#/components/schemas/PersonResponseDto" - } - ], - "nullable": true + "updatedAt": { + "description": "Last update date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" }, - "sourceType": { - "$ref": "#/components/schemas/SourceType" + "value": { + "additionalProperties": {}, + "description": "Metadata value (object)", + "type": "object" } }, "required": [ - "boundingBoxX1", - "boundingBoxX2", - "boundingBoxY1", - "boundingBoxY2", - "id", - "imageHeight", - "imageWidth", - "person" + "key", + "updatedAt", + "value" ], "type": "object" }, - "AssetFaceUpdateDto": { + "AssetMetadataUpsertDto": { "properties": { - "data": { - "description": "Face update items", + "items": { + "description": "Metadata items to upsert", "items": { - "$ref": "#/components/schemas/AssetFaceUpdateItem" + "$ref": "#/components/schemas/AssetMetadataUpsertItemDto" }, "type": "array" } }, "required": [ - "data" + "items" + ], + "type": "object" + }, + "AssetMetadataUpsertItemDto": { + "properties": { + "key": { + "description": "Metadata key", + "type": "string" + }, + "value": { + "additionalProperties": {}, + "description": "Metadata value (object)", + "type": "object" + } + }, + "required": [ + "key", + "value" ], "type": "object" }, - "AssetFaceUpdateItem": { + "AssetOcrResponseDto": { "properties": { "assetId": { - "description": "Asset ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "personId": { - "description": "Person ID", + "boxScore": { + "description": "Confidence score for text detection box", + "format": "double", + "type": "number" + }, + "id": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" + }, + "text": { + "description": "Recognized text", + "type": "string" + }, + "textScore": { + "description": "Confidence score for text recognition", + "format": "double", + "type": "number" + }, + "x1": { + "description": "Normalized x coordinate of box corner 1 (0-1)", + "format": "double", + "type": "number" + }, + "x2": { + "description": "Normalized x coordinate of box corner 2 (0-1)", + "format": "double", + "type": "number" + }, + "x3": { + "description": "Normalized x coordinate of box corner 3 (0-1)", + "format": "double", + "type": "number" + }, + "x4": { + "description": "Normalized x coordinate of box corner 4 (0-1)", + "format": "double", + "type": "number" + }, + "y1": { + "description": "Normalized y coordinate of box corner 1 (0-1)", + "format": "double", + "type": "number" + }, + "y2": { + "description": "Normalized y coordinate of box corner 2 (0-1)", + "format": "double", + "type": "number" + }, + "y3": { + "description": "Normalized y coordinate of box corner 3 (0-1)", + "format": "double", + "type": "number" + }, + "y4": { + "description": "Normalized y coordinate of box corner 4 (0-1)", + "format": "double", + "type": "number" } }, "required": [ "assetId", - "personId" + "boxScore", + "id", + "text", + "textScore", + "x1", + "x2", + "x3", + "x4", + "y1", + "y2", + "y3", + "y4" ], "type": "object" }, - "AssetIdErrorReason": { - "description": "Error reason if failed", + "AssetOrder": { + "description": "Asset sort order", "enum": [ - "duplicate", - "no_permission", - "not_found" + "asc", + "desc" ], "type": "string" }, - "AssetIdsDto": { - "properties": { - "assetIds": { - "description": "Asset IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "assetIds" + "AssetOrderBy": { + "description": "Asset sorting property", + "enum": [ + "takenAt", + "createdAt" ], - "type": "object" + "type": "string" }, - "AssetIdsResponseDto": { + "AssetRejectReason": { + "description": "Rejection reason if rejected", + "enum": [ + "duplicate", + "unsupported-format" + ], + "type": "string" + }, + "AssetResponseDto": { "properties": { - "assetId": { - "description": "Asset ID", + "checksum": { + "description": "Base64 encoded SHA1 hash", + "type": "string" + }, + "createdAt": { + "description": "The UTC timestamp when the asset was originally uploaded to Immich.", + "format": "date-time", + "type": "string" + }, + "duplicateId": { + "description": "Duplicate group ID", "format": "uuid", + "nullable": true, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "error": { - "$ref": "#/components/schemas/AssetIdErrorReason" + "duration": { + "description": "Video/gif duration in milliseconds (null for static images)", + "maximum": 2147483647, + "minimum": 0, + "nullable": true, + "type": "integer" }, - "success": { - "description": "Whether operation succeeded", + "exifInfo": { + "$ref": "#/components/schemas/ExifResponseDto" + }, + "fileCreatedAt": { + "description": "The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken.", + "format": "date-time", + "type": "string" + }, + "fileModifiedAt": { + "description": "The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken.", + "format": "date-time", + "type": "string" + }, + "hasMetadata": { + "description": "Whether asset has metadata", "type": "boolean" - } - }, - "required": [ - "assetId", - "success" - ], - "type": "object" - }, - "AssetJobName": { - "description": "Job name", - "enum": [ - "refresh-faces", - "refresh-metadata", - "regenerate-thumbnail", - "transcode-video" - ], - "type": "string" - }, - "AssetJobsDto": { - "properties": { - "assetIds": { - "description": "Asset IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" }, - "name": { - "$ref": "#/components/schemas/AssetJobName" - } - }, - "required": [ - "assetIds", - "name" - ], - "type": "object" - }, - "AssetMediaCreateDto": { - "properties": { - "assetData": { - "description": "Asset file data", - "format": "binary", + "height": { + "description": "Asset height", + "maximum": 9007199254740991, + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "id": { + "description": "Asset ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "duration": { - "description": "Duration in milliseconds (for videos)", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "isArchived": { + "description": "Is archived", + "type": "boolean" + }, + "isEdited": { + "description": "Is edited", + "type": "boolean", + "x-immich-history": [ + { + "version": "v2.5.0", + "state": "Added" + }, + { + "version": "v2.5.0", + "state": "Beta" + } + ], + "x-immich-state": "Beta" + }, + "isFavorite": { + "description": "Is favorite", + "type": "boolean" + }, + "isOffline": { + "description": "Is offline", + "type": "boolean" + }, + "isTrashed": { + "description": "Is trashed", + "type": "boolean" + }, + "libraryId": { + "description": "Library ID", + "format": "uuid", + "nullable": true, + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string", + "x-immich-history": [ + { + "version": "v1", + "state": "Added" + }, + { + "version": "v1", + "state": "Deprecated" + } + ], + "x-immich-state": "Deprecated" + }, + "livePhotoVideoId": { + "description": "Live photo video ID", + "nullable": true, + "type": "string" }, - "fileCreatedAt": { - "description": "File creation date", - "example": "2024-01-01T00:00:00.000Z", + "localDateTime": { + "description": "The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by \"local\" days and months.", "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "fileModifiedAt": { - "description": "File modification date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "originalFileName": { + "description": "Original file name", "type": "string" }, - "filename": { - "description": "Filename", + "originalMimeType": { + "description": "Original MIME type", "type": "string" }, - "isFavorite": { - "description": "Mark as favorite", - "type": "boolean" + "originalPath": { + "description": "Original file path", + "type": "string" }, - "livePhotoVideoId": { - "description": "Live photo video ID", + "owner": { + "$ref": "#/components/schemas/UserResponseDto" + }, + "ownerId": { + "description": "Owner user ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "metadata": { - "description": "Asset metadata items", + "people": { "items": { - "$ref": "#/components/schemas/AssetMetadataUpsertItemDto" + "$ref": "#/components/schemas/PersonResponseDto" }, "type": "array" }, - "sidecarData": { - "description": "Sidecar file data", - "format": "binary", + "resized": { + "description": "Is resized", + "type": "boolean", + "x-immich-history": [ + { + "version": "v1", + "state": "Added" + }, + { + "version": "v1.113.0", + "state": "Deprecated" + } + ], + "x-immich-state": "Deprecated" + }, + "stack": { + "allOf": [ + { + "$ref": "#/components/schemas/AssetStackResponseDto" + } + ], + "nullable": true + }, + "tags": { + "items": { + "$ref": "#/components/schemas/TagResponseDto" + }, + "type": "array" + }, + "thumbhash": { + "description": "Thumbhash for thumbnail generation (base64) also used as the c query param for thumbnail cache busting.", + "nullable": true, + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/AssetTypeEnum" + }, + "updatedAt": { + "description": "The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified.", + "format": "date-time", "type": "string" }, "visibility": { "$ref": "#/components/schemas/AssetVisibility" + }, + "width": { + "description": "Asset width", + "maximum": 9007199254740991, + "minimum": 0, + "nullable": true, + "type": "integer" } }, "required": [ - "assetData", + "checksum", + "createdAt", + "duration", "fileCreatedAt", - "fileModifiedAt" + "fileModifiedAt", + "hasMetadata", + "height", + "id", + "isArchived", + "isEdited", + "isFavorite", + "isOffline", + "isTrashed", + "localDateTime", + "originalFileName", + "originalPath", + "ownerId", + "thumbhash", + "type", + "updatedAt", + "visibility", + "width" ], "type": "object" }, - "AssetMediaResponseDto": { + "AssetStackResponseDto": { "properties": { + "assetCount": { + "description": "Number of assets in stack", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + }, "id": { - "description": "Asset media ID", + "description": "Stack ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "status": { - "$ref": "#/components/schemas/AssetMediaStatus" + "primaryAssetId": { + "description": "Primary asset ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" } }, "required": [ + "assetCount", "id", - "status" + "primaryAssetId" ], "type": "object" }, - "AssetMediaSize": { - "description": "Asset media size", + "AssetStatsResponseDto": { + "properties": { + "images": { + "description": "Number of images", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "total": { + "description": "Total number of assets", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "videos": { + "description": "Number of videos", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + } + }, + "required": [ + "images", + "total", + "videos" + ], + "type": "object" + }, + "AssetTypeEnum": { + "description": "Asset type", "enum": [ - "original", - "fullsize", - "preview", - "thumbnail" + "IMAGE", + "VIDEO", + "AUDIO", + "OTHER" ], "type": "string" }, - "AssetMediaStatus": { - "description": "Upload status", + "AssetUploadAction": { + "description": "Upload action", "enum": [ - "created", - "duplicate" + "accept", + "reject" ], "type": "string" }, - "AssetMetadataBulkDeleteDto": { - "properties": { - "items": { - "description": "Metadata items to delete", - "items": { - "$ref": "#/components/schemas/AssetMetadataBulkDeleteItemDto" - }, - "type": "array" - } - }, - "required": [ - "items" + "AssetVisibility": { + "description": "Asset visibility", + "enum": [ + "archive", + "timeline", + "hidden", + "locked" ], - "type": "object" + "type": "string" }, - "AssetMetadataBulkDeleteItemDto": { + "AudioCodec": { + "description": "Target audio codec", + "enum": [ + "mp3", + "aac", + "opus", + "pcm_s16le" + ], + "type": "string" + }, + "AuthStatusResponseDto": { "properties": { - "assetId": { - "description": "Asset ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "expiresAt": { + "description": "Session expiration date", "type": "string" }, - "key": { - "description": "Metadata key", + "isElevated": { + "description": "Is elevated session", + "type": "boolean" + }, + "password": { + "description": "Has password set", + "type": "boolean" + }, + "pinCode": { + "description": "Has PIN code set", + "type": "boolean" + }, + "pinExpiresAt": { + "description": "PIN expiration date", "type": "string" } }, "required": [ - "assetId", - "key" + "isElevated", + "password", + "pinCode" ], "type": "object" }, - "AssetMetadataBulkResponseDto": { + "AvatarUpdate": { + "properties": { + "color": { + "$ref": "#/components/schemas/UserAvatarColor" + } + }, + "type": "object" + }, + "BackendDto": { "properties": { - "assetId": { - "description": "Asset ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "description": { "type": "string" }, - "key": { - "description": "Metadata key", + "error": { "type": "string" }, - "updatedAt": { - "description": "Last update date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "id": { "type": "string" }, - "value": { - "additionalProperties": {}, - "description": "Metadata value (object)", - "type": "object" + "isOnline": { + "type": "boolean" + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/BackendType" + } + ] } }, "required": [ - "assetId", - "key", - "updatedAt", - "value" + "description", + "id", + "isOnline", + "type" ], "type": "object" }, - "AssetMetadataBulkUpsertDto": { + "BackendResponseDto": { "properties": { - "items": { - "description": "Metadata items to upsert", - "items": { - "$ref": "#/components/schemas/AssetMetadataBulkUpsertItemDto" - }, - "type": "array" + "backend": { + "$ref": "#/components/schemas/BackendDto" } }, "required": [ - "items" + "backend" ], "type": "object" }, - "AssetMetadataBulkUpsertItemDto": { + "BackendType": { + "enum": [ + "yucca", + "local", + "s3" + ], + "type": "string" + }, + "BackendsResponseDto": { "properties": { - "assetId": { - "description": "Asset ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "key": { - "description": "Metadata key", - "type": "string" - }, - "value": { - "additionalProperties": {}, - "description": "Metadata value (object)", - "type": "object" + "backends": { + "items": { + "$ref": "#/components/schemas/BackendDto" + }, + "type": "array" } }, "required": [ - "assetId", - "key", - "value" + "backends" ], "type": "object" }, - "AssetMetadataResponseDto": { + "BootstrapStatus": { + "enum": [ + "not-ready", + "ready", + "error" + ], + "type": "string" + }, + "BulkIdErrorReason": { + "description": "Error reason", + "enum": [ + "duplicate", + "no_permission", + "not_found", + "unknown", + "validation" + ], + "type": "string" + }, + "BulkIdResponseDto": { "properties": { - "key": { - "description": "Metadata key", + "error": { + "$ref": "#/components/schemas/BulkIdErrorReason" + }, + "errorMessage": { "type": "string" }, - "updatedAt": { - "description": "Last update date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "id": { + "description": "ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "value": { - "additionalProperties": {}, - "description": "Metadata value (object)", - "type": "object" + "success": { + "description": "Whether operation succeeded", + "type": "boolean" } }, "required": [ - "key", - "updatedAt", - "value" + "id", + "success" ], "type": "object" }, - "AssetMetadataUpsertDto": { + "BulkIdsDto": { "properties": { - "items": { - "description": "Metadata items to upsert", + "ids": { + "description": "IDs to process", "items": { - "$ref": "#/components/schemas/AssetMetadataUpsertItemDto" + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" }, "type": "array" } }, "required": [ - "items" + "ids" ], "type": "object" }, - "AssetMetadataUpsertItemDto": { + "CLIPConfig": { "properties": { - "key": { - "description": "Metadata key", - "type": "string" + "enabled": { + "description": "Whether the task is enabled", + "type": "boolean" }, - "value": { - "additionalProperties": {}, - "description": "Metadata value (object)", - "type": "object" + "modelName": { + "description": "Name of the model to use", + "type": "string" } }, "required": [ - "key", - "value" + "enabled", + "modelName" ], "type": "object" }, - "AssetOcrResponseDto": { + "CQMode": { + "description": "CQ mode", + "enum": [ + "auto", + "cqp", + "icq" + ], + "type": "string" + }, + "CalendarHeatmapResponseDto": { "properties": { - "assetId": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "from": { + "description": "Start date in UTC", + "example": "2024-01-01", "type": "string" }, - "boxScore": { - "description": "Confidence score for text detection box", - "format": "double", - "type": "number" - }, - "id": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "series": { + "items": { + "properties": { + "count": { + "description": "Activity count", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + }, + "date": { + "description": "Date in UTC", + "example": "2024-01-01", + "type": "string" + } + }, + "required": [ + "date", + "count" + ], + "type": "object" + }, + "type": "array" }, - "text": { - "description": "Recognized text", + "to": { + "description": "End date in UTC", + "example": "2024-12-31", "type": "string" }, - "textScore": { - "description": "Confidence score for text recognition", - "format": "double", - "type": "number" - }, - "x1": { - "description": "Normalized x coordinate of box corner 1 (0-1)", - "format": "double", - "type": "number" - }, - "x2": { - "description": "Normalized x coordinate of box corner 2 (0-1)", - "format": "double", - "type": "number" - }, - "x3": { - "description": "Normalized x coordinate of box corner 3 (0-1)", - "format": "double", - "type": "number" - }, - "x4": { - "description": "Normalized x coordinate of box corner 4 (0-1)", - "format": "double", - "type": "number" - }, - "y1": { - "description": "Normalized y coordinate of box corner 1 (0-1)", - "format": "double", - "type": "number" - }, - "y2": { - "description": "Normalized y coordinate of box corner 2 (0-1)", - "format": "double", - "type": "number" - }, - "y3": { - "description": "Normalized y coordinate of box corner 3 (0-1)", - "format": "double", - "type": "number" - }, - "y4": { - "description": "Normalized y coordinate of box corner 4 (0-1)", - "format": "double", - "type": "number" + "totalCount": { + "description": "Total activity count over the period", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" } }, "required": [ - "assetId", - "boxScore", - "id", - "text", - "textScore", - "x1", - "x2", - "x3", - "x4", - "y1", - "y2", - "y3", - "y4" + "from", + "series", + "to", + "totalCount" ], "type": "object" }, - "AssetOrder": { - "description": "Asset sort order", + "CalendarHeatmapType": { + "description": "Type of calendar heatmap", "enum": [ - "asc", - "desc" + "Upload", + "Taken" ], "type": "string" }, - "AssetOrderBy": { - "description": "Asset sorting property", - "enum": [ - "takenAt", - "createdAt" + "CastResponse": { + "properties": { + "gCastEnabled": { + "description": "Whether Google Cast is enabled", + "type": "boolean" + } + }, + "required": [ + "gCastEnabled" ], - "type": "string" + "type": "object" }, - "AssetRejectReason": { - "description": "Rejection reason if rejected", - "enum": [ - "duplicate", - "unsupported-format" - ], - "type": "string" + "CastUpdate": { + "properties": { + "gCastEnabled": { + "description": "Whether Google Cast is enabled", + "type": "boolean" + } + }, + "type": "object" }, - "AssetResponseDto": { + "ChangePasswordDto": { "properties": { - "checksum": { - "description": "Base64 encoded SHA1 hash", - "type": "string" + "invalidateSessions": { + "default": false, + "description": "Invalidate all other sessions", + "type": "boolean" }, - "createdAt": { - "description": "The UTC timestamp when the asset was originally uploaded to Immich.", - "format": "date-time", + "newPassword": { + "description": "New password (min 8 characters)", + "example": "password", + "minLength": 8, "type": "string" }, - "duplicateId": { - "description": "Duplicate group ID", - "format": "uuid", - "nullable": true, - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "password": { + "description": "Current password", + "example": "password", "type": "string" + } + }, + "required": [ + "newPassword", + "password" + ], + "type": "object" + }, + "Colorspace": { + "description": "Colorspace", + "enum": [ + "srgb", + "p3" + ], + "type": "string" + }, + "ConfigureImmichIntegrationRequestDto": { + "properties": { + "backupConfiguration": { + "type": "boolean" }, - "duration": { - "description": "Video/gif duration in milliseconds (null for static images)", - "maximum": 2147483647, - "minimum": 0, - "nullable": true, - "type": "integer" + "cron": { + "type": "string" }, - "exifInfo": { - "$ref": "#/components/schemas/ExifResponseDto" + "dataFolders": { + "items": { + "type": "string" + }, + "type": "array" }, - "fileCreatedAt": { - "description": "The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken.", - "format": "date-time", - "type": "string" + "libraries": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all" + ] + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] }, - "fileModifiedAt": { - "description": "The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken.", - "format": "date-time", + "name": { "type": "string" }, - "hasMetadata": { - "description": "Whether asset has metadata", + "paused": { "type": "boolean" }, - "height": { - "description": "Asset height", + "retentionPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/RetentionPolicyDto" + } + ], + "nullable": true, + "type": "object" + }, + "worm": { + "type": "boolean" + } + }, + "required": [ + "backupConfiguration", + "cron", + "dataFolders", + "libraries", + "name", + "worm" + ], + "type": "object" + }, + "ContributorCountResponseDto": { + "properties": { + "assetCount": { + "description": "Number of assets contributed", "maximum": 9007199254740991, "minimum": 0, - "nullable": true, "type": "integer" }, - "id": { - "description": "Asset ID", + "userId": { + "description": "User ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" + } + }, + "required": [ + "assetCount", + "userId" + ], + "type": "object" + }, + "CreateAlbumDto": { + "properties": { + "albumName": { + "description": "Album name", + "type": "string" }, - "isArchived": { - "description": "Is archived", - "type": "boolean" - }, - "isEdited": { - "description": "Is edited", - "type": "boolean", - "x-immich-history": [ - { - "version": "v2.5.0", - "state": "Added" - }, - { - "version": "v2.5.0", - "state": "Beta" - } - ], - "x-immich-state": "Beta" - }, - "isFavorite": { - "description": "Is favorite", - "type": "boolean" - }, - "isOffline": { - "description": "Is offline", - "type": "boolean" + "albumUsers": { + "description": "Album users", + "items": { + "$ref": "#/components/schemas/AlbumUserCreateDto" + }, + "type": "array" }, - "isTrashed": { - "description": "Is trashed", - "type": "boolean" + "assetIds": { + "description": "Initial asset IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" }, - "libraryId": { - "description": "Library ID", - "format": "uuid", + "description": { + "description": "Album description", "nullable": true, - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string", "x-immich-history": [ { @@ -17964,300 +19699,472 @@ "state": "Added" }, { - "version": "v1", - "state": "Deprecated" + "version": "v3", + "state": "Updated", + "description": "Sending an empty string is deprecated; send null instead. Empty strings will no longer be coerced to null in v4." } - ], - "x-immich-state": "Deprecated" + ] + } + }, + "required": [ + "albumName" + ], + "type": "object" + }, + "CreateLibraryDto": { + "properties": { + "exclusionPatterns": { + "description": "Exclusion patterns (max 128)", + "items": { + "type": "string" + }, + "maxItems": 128, + "type": "array" }, - "livePhotoVideoId": { - "description": "Live photo video ID", - "nullable": true, + "importPaths": { + "description": "Import paths (max 128)", + "items": { + "type": "string" + }, + "maxItems": 128, + "type": "array" + }, + "name": { + "description": "Library name", + "minLength": 1, + "type": "string" + }, + "ownerId": { + "description": "Owner user ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + } + }, + "required": [ + "ownerId" + ], + "type": "object" + }, + "CreateLocalBackendRequestDto": { + "properties": { + "path": { "type": "string" - }, - "localDateTime": { - "description": "The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by \"local\" days and months.", + } + }, + "required": [ + "path" + ], + "type": "object" + }, + "CreateProfileImageDto": { + "properties": { + "file": { + "description": "Profile image file", + "format": "binary", + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + }, + "CreateProfileImageResponseDto": { + "properties": { + "profileChangedAt": { + "description": "Profile image change date", + "example": "2024-01-01T00:00:00.000Z", "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "originalFileName": { - "description": "Original file name", + "profileImagePath": { + "description": "Profile image file path", "type": "string" }, - "originalMimeType": { - "description": "Original MIME type", + "userId": { + "description": "User ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" + } + }, + "required": [ + "profileChangedAt", + "profileImagePath", + "userId" + ], + "type": "object" + }, + "CropParameters": { + "properties": { + "height": { + "description": "Height of the crop", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" }, - "originalPath": { - "description": "Original file path", - "type": "string" + "width": { + "description": "Width of the crop", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" }, - "owner": { - "$ref": "#/components/schemas/UserResponseDto" + "x": { + "description": "Top-Left X coordinate of crop", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" }, - "ownerId": { - "description": "Owner user ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "y": { + "description": "Top-Left Y coordinate of crop", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" + } + }, + "required": [ + "height", + "width", + "x", + "y" + ], + "type": "object" + }, + "CurrentRecoveryKeyResponse": { + "properties": { + "recoveryKey": { + "type": "string" + } + }, + "required": [ + "recoveryKey" + ], + "type": "object" + }, + "DatabaseBackupConfig": { + "properties": { + "cronExpression": { + "description": "Cron expression", "type": "string" }, - "people": { + "enabled": { + "description": "Enabled", + "type": "boolean" + }, + "keepLastAmount": { + "description": "Keep last amount", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" + } + }, + "required": [ + "cronExpression", + "enabled", + "keepLastAmount" + ], + "type": "object" + }, + "DatabaseBackupDeleteDto": { + "properties": { + "backups": { + "description": "Backup filenames to delete", "items": { - "$ref": "#/components/schemas/PersonResponseDto" + "type": "string" }, "type": "array" + } + }, + "required": [ + "backups" + ], + "type": "object" + }, + "DatabaseBackupDto": { + "properties": { + "filename": { + "description": "Backup filename", + "type": "string" }, - "resized": { - "description": "Is resized", - "type": "boolean", - "x-immich-history": [ - { - "version": "v1", - "state": "Added" - }, - { - "version": "v1.113.0", - "state": "Deprecated" - } - ], - "x-immich-state": "Deprecated" - }, - "stack": { - "allOf": [ - { - "$ref": "#/components/schemas/AssetStackResponseDto" - } - ], - "nullable": true + "filesize": { + "description": "Backup file size", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "tags": { + "timezone": { + "description": "Backup timezone", + "type": "string" + } + }, + "required": [ + "filename", + "filesize", + "timezone" + ], + "type": "object" + }, + "DatabaseBackupListResponseDto": { + "properties": { + "backups": { + "description": "List of backups", "items": { - "$ref": "#/components/schemas/TagResponseDto" + "$ref": "#/components/schemas/DatabaseBackupDto" }, "type": "array" - }, - "thumbhash": { - "description": "Thumbhash for thumbnail generation (base64) also used as the c query param for thumbnail cache busting.", - "nullable": true, + } + }, + "required": [ + "backups" + ], + "type": "object" + }, + "DatabaseBackupUploadDto": { + "properties": { + "file": { + "description": "Database backup file", + "format": "binary", + "type": "string" + } + }, + "type": "object" + }, + "DeviceFlowResponseDto": { + "properties": { + "userCode": { "type": "string" }, - "type": { - "$ref": "#/components/schemas/AssetTypeEnum" - }, - "updatedAt": { - "description": "The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified.", - "format": "date-time", + "verificationUri": { "type": "string" + } + }, + "required": [ + "userCode", + "verificationUri" + ], + "type": "object" + }, + "DownloadArchiveDto": { + "properties": { + "assetIds": { + "description": "Asset IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" }, - "visibility": { - "$ref": "#/components/schemas/AssetVisibility" + "edited": { + "description": "Download edited asset if available", + "type": "boolean" + } + }, + "required": [ + "assetIds" + ], + "type": "object" + }, + "DownloadArchiveInfo": { + "properties": { + "assetIds": { + "description": "Asset IDs in this archive", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" }, - "width": { - "description": "Asset width", + "size": { + "description": "Archive size in bytes", "maximum": 9007199254740991, - "minimum": 0, - "nullable": true, + "minimum": -9007199254740991, "type": "integer" } }, "required": [ - "checksum", - "createdAt", - "duration", - "fileCreatedAt", - "fileModifiedAt", - "hasMetadata", - "height", - "id", - "isArchived", - "isEdited", - "isFavorite", - "isOffline", - "isTrashed", - "localDateTime", - "originalFileName", - "originalPath", - "ownerId", - "thumbhash", - "type", - "updatedAt", - "visibility", - "width" + "assetIds", + "size" ], "type": "object" }, - "AssetStackResponseDto": { + "DownloadInfoDto": { "properties": { - "assetCount": { - "description": "Number of assets in stack", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "id": { - "description": "Stack ID", + "albumId": { + "description": "Album ID to download", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "primaryAssetId": { - "description": "Primary asset ID", + "archiveSize": { + "description": "Archive size limit in bytes", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" + }, + "assetIds": { + "description": "Asset IDs to download", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" + }, + "userId": { + "description": "User ID to download assets from", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" } }, - "required": [ - "assetCount", - "id", - "primaryAssetId" - ], "type": "object" }, - "AssetStatsResponseDto": { + "DownloadResponse": { "properties": { - "images": { - "description": "Number of images", + "archiveSize": { + "description": "Maximum archive size in bytes", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, - "total": { - "description": "Total number of assets", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "includeEmbeddedVideos": { + "description": "Whether to include embedded videos in downloads", + "type": "boolean" + } + }, + "required": [ + "archiveSize", + "includeEmbeddedVideos" + ], + "type": "object" + }, + "DownloadResponseDto": { + "properties": { + "archives": { + "description": "Archive information", + "items": { + "$ref": "#/components/schemas/DownloadArchiveInfo" + }, + "type": "array" }, - "videos": { - "description": "Number of videos", + "totalSize": { + "description": "Total size in bytes", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ - "images", - "total", - "videos" + "archives", + "totalSize" ], "type": "object" }, - "AssetTypeEnum": { - "description": "Asset type", - "enum": [ - "IMAGE", - "VIDEO", - "AUDIO", - "OTHER" - ], - "type": "string" - }, - "AssetUploadAction": { - "description": "Upload action", - "enum": [ - "accept", - "reject" - ], - "type": "string" - }, - "AssetVisibility": { - "description": "Asset visibility", - "enum": [ - "archive", - "timeline", - "hidden", - "locked" - ], - "type": "string" - }, - "AudioCodec": { - "description": "Target audio codec", - "enum": [ - "mp3", - "aac", - "opus", - "pcm_s16le" - ], - "type": "string" - }, - "AuthStatusResponseDto": { + "DownloadUpdate": { "properties": { - "expiresAt": { - "description": "Session expiration date", - "type": "string" - }, - "isElevated": { - "description": "Is elevated session", - "type": "boolean" + "archiveSize": { + "description": "Maximum archive size in bytes", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" }, - "password": { - "description": "Has password set", + "includeEmbeddedVideos": { + "description": "Whether to include embedded videos in downloads", "type": "boolean" - }, - "pinCode": { - "description": "Has PIN code set", + } + }, + "type": "object" + }, + "DuplicateDetectionConfig": { + "properties": { + "enabled": { + "description": "Whether the task is enabled", "type": "boolean" }, - "pinExpiresAt": { - "description": "PIN expiration date", - "type": "string" + "maxDistance": { + "description": "Maximum distance threshold for duplicate detection", + "format": "double", + "maximum": 0.1, + "minimum": 0.001, + "type": "number" } }, "required": [ - "isElevated", - "password", - "pinCode" + "enabled", + "maxDistance" ], "type": "object" }, - "AvatarUpdate": { + "DuplicateResolveDto": { "properties": { - "color": { - "$ref": "#/components/schemas/UserAvatarColor" + "groups": { + "description": "List of duplicate groups to resolve", + "items": { + "$ref": "#/components/schemas/DuplicateResolveGroupDto" + }, + "minItems": 1, + "type": "array" } }, - "type": "object" - }, - "BulkIdErrorReason": { - "description": "Error reason", - "enum": [ - "duplicate", - "no_permission", - "not_found", - "unknown", - "validation" + "required": [ + "groups" ], - "type": "string" + "type": "object" }, - "BulkIdResponseDto": { + "DuplicateResolveGroupDto": { "properties": { - "error": { - "$ref": "#/components/schemas/BulkIdErrorReason" - }, - "errorMessage": { - "type": "string" - }, - "id": { - "description": "ID", + "duplicateId": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "success": { - "description": "Whether operation succeeded", - "type": "boolean" + "keepAssetIds": { + "description": "Asset IDs to keep", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" + }, + "trashAssetIds": { + "description": "Asset IDs to trash or delete", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" } }, "required": [ - "id", - "success" + "duplicateId", + "keepAssetIds", + "trashAssetIds" ], "type": "object" }, - "BulkIdsDto": { + "DuplicateResponseDto": { "properties": { - "ids": { - "description": "IDs to process", + "assets": { + "description": "Duplicate assets", + "items": { + "$ref": "#/components/schemas/AssetResponseDto" + }, + "type": "array" + }, + "duplicateId": { + "description": "Duplicate group ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "suggestedKeepAssetIds": { + "description": "Suggested asset IDs to keep based on file size and EXIF data", "items": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", @@ -18267,1587 +20174,1618 @@ } }, "required": [ - "ids" + "assets", + "duplicateId", + "suggestedKeepAssetIds" ], "type": "object" }, - "CLIPConfig": { + "EmailNotificationsResponse": { "properties": { - "enabled": { - "description": "Whether the task is enabled", + "albumInvite": { + "description": "Whether to receive email notifications for album invites", "type": "boolean" }, - "modelName": { - "description": "Name of the model to use", - "type": "string" + "albumUpdate": { + "description": "Whether to receive email notifications for album updates", + "type": "boolean" + }, + "enabled": { + "description": "Whether email notifications are enabled", + "type": "boolean" } }, "required": [ - "enabled", - "modelName" + "albumInvite", + "albumUpdate", + "enabled" ], "type": "object" }, - "CQMode": { - "description": "CQ mode", - "enum": [ - "auto", - "cqp", - "icq" - ], - "type": "string" + "EmailNotificationsUpdate": { + "properties": { + "albumInvite": { + "description": "Whether to receive email notifications for album invites", + "type": "boolean" + }, + "albumUpdate": { + "description": "Whether to receive email notifications for album updates", + "type": "boolean" + }, + "enabled": { + "description": "Whether email notifications are enabled", + "type": "boolean" + } + }, + "type": "object" }, - "CalendarHeatmapResponseDto": { + "ExifResponseDto": { + "description": "EXIF response", "properties": { - "from": { - "description": "Start date in UTC", - "example": "2024-01-01", + "city": { + "default": null, + "description": "City name", + "nullable": true, "type": "string" }, - "series": { - "items": { - "properties": { - "count": { - "description": "Activity count", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - }, - "date": { - "description": "Date in UTC", - "example": "2024-01-01", - "type": "string" - } - }, - "required": [ - "date", - "count" - ], - "type": "object" - }, - "type": "array" + "country": { + "default": null, + "description": "Country name", + "nullable": true, + "type": "string" }, - "to": { - "description": "End date in UTC", - "example": "2024-12-31", + "dateTimeOriginal": { + "default": null, + "description": "Original date/time", + "format": "date-time", + "nullable": true, "type": "string" }, - "totalCount": { - "description": "Total activity count over the period", + "description": { + "default": null, + "description": "Image description", + "nullable": true, + "type": "string" + }, + "exifImageHeight": { + "default": null, + "description": "Image height in pixels", "maximum": 9007199254740991, "minimum": 0, + "nullable": true, "type": "integer" - } - }, - "required": [ - "from", - "series", - "to", - "totalCount" - ], - "type": "object" - }, - "CalendarHeatmapType": { - "description": "Type of calendar heatmap", - "enum": [ - "Upload", - "Taken" - ], - "type": "string" - }, - "CastResponse": { - "properties": { - "gCastEnabled": { - "description": "Whether Google Cast is enabled", - "type": "boolean" - } - }, - "required": [ - "gCastEnabled" - ], - "type": "object" - }, - "CastUpdate": { - "properties": { - "gCastEnabled": { - "description": "Whether Google Cast is enabled", - "type": "boolean" + }, + "exifImageWidth": { + "default": null, + "description": "Image width in pixels", + "maximum": 9007199254740991, + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "exposureTime": { + "default": null, + "description": "Exposure time", + "nullable": true, + "type": "string" + }, + "fNumber": { + "default": null, + "description": "F-number (aperture)", + "nullable": true, + "type": "number" + }, + "fileSizeInByte": { + "default": null, + "description": "File size in bytes", + "maximum": 9007199254740991, + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "focalLength": { + "default": null, + "description": "Focal length in mm", + "nullable": true, + "type": "number" + }, + "iso": { + "default": null, + "description": "ISO sensitivity", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "nullable": true, + "type": "integer" + }, + "latitude": { + "default": null, + "description": "GPS latitude", + "nullable": true, + "type": "number" + }, + "lensModel": { + "default": null, + "description": "Lens model", + "nullable": true, + "type": "string" + }, + "longitude": { + "default": null, + "description": "GPS longitude", + "nullable": true, + "type": "number" + }, + "make": { + "default": null, + "description": "Camera make", + "nullable": true, + "type": "string" + }, + "model": { + "default": null, + "description": "Camera model", + "nullable": true, + "type": "string" + }, + "modifyDate": { + "default": null, + "description": "Modification date/time", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "orientation": { + "default": null, + "description": "Image orientation", + "nullable": true, + "type": "string" + }, + "projectionType": { + "default": null, + "description": "Projection type", + "nullable": true, + "type": "string" + }, + "rating": { + "default": null, + "description": "Rating", + "maximum": 5, + "minimum": 1, + "nullable": true, + "type": "integer" + }, + "state": { + "default": null, + "description": "State/province name", + "nullable": true, + "type": "string" + }, + "timeZone": { + "default": null, + "description": "Time zone", + "nullable": true, + "type": "string" } }, "type": "object" }, - "ChangePasswordDto": { + "FaceDto": { "properties": { - "invalidateSessions": { - "default": false, - "description": "Invalidate all other sessions", - "type": "boolean" - }, - "newPassword": { - "description": "New password (min 8 characters)", - "example": "password", - "minLength": 8, - "type": "string" - }, - "password": { - "description": "Current password", - "example": "password", + "id": { + "description": "Face ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" } }, "required": [ - "newPassword", - "password" + "id" ], "type": "object" }, - "Colorspace": { - "description": "Colorspace", - "enum": [ - "srgb", - "p3" - ], - "type": "string" - }, - "ContributorCountResponseDto": { + "FacialRecognitionConfig": { "properties": { - "assetCount": { - "description": "Number of assets contributed", + "enabled": { + "description": "Whether the task is enabled", + "type": "boolean" + }, + "maxDistance": { + "description": "Maximum distance threshold for face recognition", + "format": "double", + "maximum": 2, + "minimum": 0.1, + "type": "number" + }, + "minFaces": { + "description": "Minimum number of faces required for recognition", "maximum": 9007199254740991, - "minimum": 0, + "minimum": 1, "type": "integer" }, - "userId": { - "description": "User ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "minScore": { + "description": "Minimum confidence score for face detection", + "format": "double", + "maximum": 1, + "minimum": 0.1, + "type": "number" + }, + "modelName": { + "description": "Name of the model to use", "type": "string" } }, "required": [ - "assetCount", - "userId" + "enabled", + "maxDistance", + "minFaces", + "minScore", + "modelName" ], "type": "object" }, - "CreateAlbumDto": { + "FilesystemListingItemDto": { "properties": { - "albumName": { - "description": "Album name", - "type": "string" - }, - "albumUsers": { - "description": "Album users", - "items": { - "$ref": "#/components/schemas/AlbumUserCreateDto" - }, - "type": "array" - }, - "assetIds": { - "description": "Initial asset IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" + "isDirectory": { + "type": "boolean" }, - "description": { - "description": "Album description", - "nullable": true, - "type": "string", - "x-immich-history": [ - { - "version": "v1", - "state": "Added" - }, - { - "version": "v3", - "state": "Updated", - "description": "Sending an empty string is deprecated; send null instead. Empty strings will no longer be coerced to null in v4." - } - ] + "path": { + "type": "string" } }, "required": [ - "albumName" + "isDirectory", + "path" ], "type": "object" }, - "CreateLibraryDto": { + "FilesystemListingResponseDto": { "properties": { - "exclusionPatterns": { - "description": "Exclusion patterns (max 128)", - "items": { - "type": "string" - }, - "maxItems": 128, - "type": "array" - }, - "importPaths": { - "description": "Import paths (max 128)", + "items": { "items": { - "type": "string" + "$ref": "#/components/schemas/FilesystemListingItemDto" }, - "maxItems": 128, "type": "array" }, - "name": { - "description": "Library name", - "minLength": 1, + "parent": { "type": "string" }, - "ownerId": { - "description": "Owner user ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "path": { "type": "string" } }, "required": [ - "ownerId" + "items", + "parent", + "path" ], "type": "object" }, - "CreateProfileImageDto": { + "FoldersResponse": { "properties": { - "file": { - "description": "Profile image file", - "format": "binary", - "type": "string" + "enabled": { + "description": "Whether folders are enabled", + "type": "boolean" + }, + "sidebarWeb": { + "description": "Whether folders appear in web sidebar", + "type": "boolean" } }, "required": [ - "file" + "enabled", + "sidebarWeb" ], "type": "object" }, - "CreateProfileImageResponseDto": { + "FoldersUpdate": { "properties": { - "profileChangedAt": { - "description": "Profile image change date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" - }, - "profileImagePath": { - "description": "Profile image file path", - "type": "string" + "enabled": { + "description": "Whether folders are enabled", + "type": "boolean" }, - "userId": { - "description": "User ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "sidebarWeb": { + "description": "Whether folders appear in web sidebar", + "type": "boolean" } }, - "required": [ - "profileChangedAt", - "profileImagePath", - "userId" - ], "type": "object" }, - "CropParameters": { + "HlsVideoResolution": { + "description": "HLS video resolution", + "enum": [ + 480, + 720, + 1080, + 1440, + 2160 + ], + "type": "integer" + }, + "ImageFormat": { + "description": "Image format", + "enum": [ + "jpeg", + "webp" + ], + "type": "string" + }, + "ImmichIntegrationConfigurationDto": { "properties": { - "height": { - "description": "Height of the crop", - "maximum": 9007199254740991, - "minimum": 1, - "type": "integer" - }, - "width": { - "description": "Width of the crop", - "maximum": 9007199254740991, - "minimum": 1, - "type": "integer" + "backupConfiguration": { + "type": "boolean" }, - "x": { - "description": "Top-Left X coordinate of crop", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "dataFolders": { + "items": { + "type": "string" + }, + "type": "array" }, - "y": { - "description": "Top-Left Y coordinate of crop", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "libraries": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all" + ] + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] } }, "required": [ - "height", - "width", - "x", - "y" + "backupConfiguration", + "dataFolders", + "libraries" ], "type": "object" }, - "DatabaseBackupConfig": { + "ImmichIntegrationDto": { "properties": { - "cronExpression": { - "description": "Cron expression", - "type": "string" + "configuration": { + "$ref": "#/components/schemas/ImmichIntegrationConfigurationDto" }, - "enabled": { - "description": "Enabled", - "type": "boolean" + "id": { + "type": "string" }, - "keepLastAmount": { - "description": "Keep last amount", - "maximum": 9007199254740991, - "minimum": 1, - "type": "integer" + "scheduleId": { + "type": "string" } }, "required": [ - "cronExpression", - "enabled", - "keepLastAmount" + "configuration", + "id", + "scheduleId" ], "type": "object" }, - "DatabaseBackupDeleteDto": { + "ImmichLibraryDto": { "properties": { - "backups": { - "description": "Backup filenames to delete", + "exclusionPatterns": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "importPaths": { "items": { "type": "string" }, "type": "array" + }, + "name": { + "type": "string" } }, "required": [ - "backups" + "exclusionPatterns", + "id", + "importPaths", + "name" ], "type": "object" }, - "DatabaseBackupDto": { + "ImmichRollbackRequestDto": { "properties": { - "filename": { - "description": "Backup filename", + "backupFileName": { "type": "string" }, - "filesize": { - "description": "Backup file size", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "repositoryId": { + "type": "string" }, - "timezone": { - "description": "Backup timezone", + "snapshotId": { "type": "string" } }, "required": [ - "filename", - "filesize", - "timezone" + "repositoryId", + "snapshotId" ], "type": "object" }, - "DatabaseBackupListResponseDto": { + "ImmichStateDto": { "properties": { - "backups": { - "description": "List of backups", + "dataFolders": { "items": { - "$ref": "#/components/schemas/DatabaseBackupDto" + "type": "string" + }, + "type": "array" + }, + "dataPath": { + "type": "string" + }, + "libraries": { + "items": { + "$ref": "#/components/schemas/ImmichLibraryDto" }, "type": "array" } }, "required": [ - "backups" + "dataFolders", + "dataPath", + "libraries" ], "type": "object" }, - "DatabaseBackupUploadDto": { + "ImportRecoveryKeyRequest": { "properties": { - "file": { - "description": "Database backup file", - "format": "binary", + "recoveryKey": { "type": "string" } }, + "required": [ + "recoveryKey" + ], "type": "object" }, - "DownloadArchiveDto": { + "InspectedLocalRepositoryDto": { "properties": { - "assetIds": { - "description": "Asset IDs", + "backends": { + "$ref": "#/components/schemas/RepositoryBackendsDto" + }, + "configuration": { + "$ref": "#/components/schemas/RepositoryConfigurationDto" + }, + "id": { + "type": "string" + }, + "meter": { + "$ref": "#/components/schemas/RepositoryMeterDto" + }, + "metrics": { + "$ref": "#/components/schemas/RepositoryMetricsDto" + }, + "name": { + "type": "string" + }, + "siteCode": { + "nullable": true, + "type": "string" + }, + "snapshots": { "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "$ref": "#/components/schemas/SnapshotDto" }, "type": "array" }, - "edited": { - "description": "Download edited asset if available", + "storageClusterCode": { + "nullable": true, + "type": "string" + }, + "worm": { "type": "boolean" } }, "required": [ - "assetIds" + "id", + "metrics", + "name", + "siteCode", + "snapshots", + "storageClusterCode", + "worm" ], "type": "object" }, - "DownloadArchiveInfo": { + "IntegrationsResponseDto": { "properties": { - "assetIds": { - "description": "Asset IDs in this archive", + "immichIntegration": { + "$ref": "#/components/schemas/ImmichIntegrationDto" + }, + "immichState": { + "$ref": "#/components/schemas/ImmichStateDto" + } + }, + "type": "object" + }, + "IntegrityReport": { + "description": "Integrity report type", + "enum": [ + "untracked_file", + "missing_file", + "checksum_mismatch" + ], + "type": "string" + }, + "IntegrityReportResponseDto": { + "properties": { + "items": { "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "properties": { + "id": { + "description": "Integrity report item id", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "path": { + "description": "Integrity report item path", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/IntegrityReport" + } + }, + "required": [ + "id", + "type", + "path" + ], + "type": "object" }, "type": "array" }, - "size": { - "description": "Archive size in bytes", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "nextCursor": { + "type": "string" } }, "required": [ - "assetIds", - "size" + "items" ], "type": "object" }, - "DownloadInfoDto": { + "IntegrityReportSummaryResponseDto": { "properties": { - "albumId": { - "description": "Album ID to download", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "archiveSize": { - "description": "Archive size limit in bytes", + "checksum_mismatch": { "maximum": 9007199254740991, - "minimum": 1, + "minimum": 0, "type": "integer" }, - "assetIds": { - "description": "Asset IDs to download", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" + "missing_file": { + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" }, - "userId": { - "description": "User ID to download assets from", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "untracked_file": { + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" } }, + "required": [ + "checksum_mismatch", + "missing_file", + "untracked_file" + ], "type": "object" }, - "DownloadResponse": { + "JobCreateDto": { "properties": { - "archiveSize": { - "description": "Maximum archive size in bytes", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "includeEmbeddedVideos": { - "description": "Whether to include embedded videos in downloads", - "type": "boolean" + "name": { + "$ref": "#/components/schemas/ManualJobName" } }, "required": [ - "archiveSize", - "includeEmbeddedVideos" + "name" + ], + "type": "object" + }, + "JobName": { + "description": "Job name", + "enum": [ + "AssetDelete", + "AssetDeleteCheck", + "AssetDetectFacesQueueAll", + "AssetDetectFaces", + "AssetDetectDuplicatesQueueAll", + "AssetDetectDuplicates", + "AssetEditThumbnailGeneration", + "AssetEncodeVideoQueueAll", + "AssetEncodeVideo", + "AssetEmptyTrash", + "AssetExtractMetadataQueueAll", + "AssetExtractMetadata", + "AssetFileMigration", + "AssetGenerateThumbnailsQueueAll", + "AssetGenerateThumbnails", + "AuditTableCleanup", + "DatabaseBackup", + "FacialRecognitionQueueAll", + "FacialRecognition", + "FileDelete", + "FileMigrationQueueAll", + "LibraryDeleteCheck", + "LibraryDelete", + "LibraryRemoveAsset", + "LibraryScanAssetsQueueAll", + "LibrarySyncAssets", + "LibrarySyncFilesQueueAll", + "LibrarySyncFiles", + "LibraryScanQueueAll", + "HlsSessionCleanup", + "MemoryCleanup", + "MemoryGenerate", + "NotificationsCleanup", + "NotifyUserSignup", + "NotifyAlbumInvite", + "NotifyAlbumUpdate", + "UserDelete", + "UserDeleteCheck", + "UserSyncUsage", + "PersonCleanup", + "PersonFileMigration", + "PersonGenerateThumbnail", + "SessionCleanup", + "SendMail", + "SidecarQueueAll", + "SidecarCheck", + "SidecarWrite", + "SmartSearchQueueAll", + "SmartSearch", + "StorageTemplateMigration", + "StorageTemplateMigrationSingle", + "TagCleanup", + "VersionCheck", + "OcrQueueAll", + "Ocr", + "WorkflowAssetTrigger", + "IntegrityUntrackedFilesQueueAll", + "IntegrityUntrackedFiles", + "IntegrityUntrackedRefresh", + "IntegrityMissingFilesQueueAll", + "IntegrityMissingFiles", + "IntegrityMissingFilesRefresh", + "IntegrityChecksumFiles", + "IntegrityChecksumFilesRefresh", + "IntegrityDeleteReportType", + "IntegrityDeleteReports" ], - "type": "object" + "type": "string" }, - "DownloadResponseDto": { + "JobSettingsDto": { "properties": { - "archives": { - "description": "Archive information", - "items": { - "$ref": "#/components/schemas/DownloadArchiveInfo" - }, - "type": "array" - }, - "totalSize": { - "description": "Total size in bytes", + "concurrency": { + "description": "Concurrency", "maximum": 9007199254740991, - "minimum": -9007199254740991, + "minimum": 1, "type": "integer" } }, "required": [ - "archives", - "totalSize" + "concurrency" ], "type": "object" }, - "DownloadUpdate": { + "LibraryResponseDto": { "properties": { - "archiveSize": { - "description": "Maximum archive size in bytes", + "assetCount": { + "description": "Number of assets", "maximum": 9007199254740991, - "minimum": 1, + "minimum": -9007199254740991, "type": "integer" }, - "includeEmbeddedVideos": { - "description": "Whether to include embedded videos in downloads", - "type": "boolean" - } - }, - "type": "object" - }, - "DuplicateDetectionConfig": { - "properties": { - "enabled": { - "description": "Whether the task is enabled", - "type": "boolean" + "createdAt": { + "description": "Creation date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" }, - "maxDistance": { - "description": "Maximum distance threshold for duplicate detection", - "format": "double", - "maximum": 0.1, - "minimum": 0.001, - "type": "number" - } - }, - "required": [ - "enabled", - "maxDistance" - ], - "type": "object" - }, - "DuplicateResolveDto": { - "properties": { - "groups": { - "description": "List of duplicate groups to resolve", + "exclusionPatterns": { + "description": "Exclusion patterns", "items": { - "$ref": "#/components/schemas/DuplicateResolveGroupDto" + "type": "string" }, - "minItems": 1, "type": "array" - } - }, - "required": [ - "groups" - ], - "type": "object" - }, - "DuplicateResolveGroupDto": { - "properties": { - "duplicateId": { + }, + "id": { + "description": "Library ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "keepAssetIds": { - "description": "Asset IDs to keep", + "importPaths": { + "description": "Import paths", "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, "type": "array" }, - "trashAssetIds": { - "description": "Asset IDs to trash or delete", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "duplicateId", - "keepAssetIds", - "trashAssetIds" - ], - "type": "object" - }, - "DuplicateResponseDto": { - "properties": { - "assets": { - "description": "Duplicate assets", - "items": { - "$ref": "#/components/schemas/AssetResponseDto" - }, - "type": "array" + "name": { + "description": "Library name", + "type": "string" }, - "duplicateId": { - "description": "Duplicate group ID", + "ownerId": { + "description": "Owner user ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "suggestedKeepAssetIds": { - "description": "Suggested asset IDs to keep based on file size and EXIF data", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "assets", - "duplicateId", - "suggestedKeepAssetIds" - ], - "type": "object" - }, - "EmailNotificationsResponse": { - "properties": { - "albumInvite": { - "description": "Whether to receive email notifications for album invites", - "type": "boolean" - }, - "albumUpdate": { - "description": "Whether to receive email notifications for album updates", - "type": "boolean" + "refreshedAt": { + "description": "Last refresh date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "nullable": true, + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" }, - "enabled": { - "description": "Whether email notifications are enabled", - "type": "boolean" + "updatedAt": { + "description": "Last update date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" } }, "required": [ - "albumInvite", - "albumUpdate", - "enabled" + "assetCount", + "createdAt", + "exclusionPatterns", + "id", + "importPaths", + "name", + "ownerId", + "refreshedAt", + "updatedAt" ], "type": "object" }, - "EmailNotificationsUpdate": { - "properties": { - "albumInvite": { - "description": "Whether to receive email notifications for album invites", - "type": "boolean" - }, - "albumUpdate": { - "description": "Whether to receive email notifications for album updates", - "type": "boolean" - }, - "enabled": { - "description": "Whether email notifications are enabled", - "type": "boolean" - } - }, - "type": "object" - }, - "ExifResponseDto": { - "description": "EXIF response", + "LibraryStatsResponseDto": { "properties": { - "city": { - "default": null, - "description": "City name", - "nullable": true, - "type": "string" - }, - "country": { - "default": null, - "description": "Country name", - "nullable": true, - "type": "string" - }, - "dateTimeOriginal": { - "default": null, - "description": "Original date/time", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "description": { - "default": null, - "description": "Image description", - "nullable": true, - "type": "string" - }, - "exifImageHeight": { - "default": null, - "description": "Image height in pixels", - "maximum": 9007199254740991, - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "exifImageWidth": { - "default": null, - "description": "Image width in pixels", - "maximum": 9007199254740991, - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "exposureTime": { - "default": null, - "description": "Exposure time", - "nullable": true, - "type": "string" - }, - "fNumber": { - "default": null, - "description": "F-number (aperture)", - "nullable": true, - "type": "number" - }, - "fileSizeInByte": { - "default": null, - "description": "File size in bytes", + "photos": { + "description": "Number of photos", "maximum": 9007199254740991, - "minimum": 0, - "nullable": true, + "minimum": -9007199254740991, "type": "integer" }, - "focalLength": { - "default": null, - "description": "Focal length in mm", - "nullable": true, - "type": "number" + "total": { + "description": "Total number of assets", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "iso": { - "default": null, - "description": "ISO sensitivity", + "usage": { + "description": "Storage usage in bytes", "maximum": 9007199254740991, "minimum": -9007199254740991, - "nullable": true, "type": "integer" }, - "latitude": { - "default": null, - "description": "GPS latitude", - "nullable": true, - "type": "number" + "videos": { + "description": "Number of videos", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + } + }, + "required": [ + "photos", + "total", + "usage", + "videos" + ], + "type": "object" + }, + "LicenseKeyDto": { + "properties": { + "activationKey": { + "description": "Activation key", + "type": "string" }, - "lensModel": { - "default": null, - "description": "Lens model", - "nullable": true, + "licenseKey": { + "description": "License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/)", + "pattern": "^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$", "type": "string" + } + }, + "required": [ + "activationKey", + "licenseKey" + ], + "type": "object" + }, + "LicenseResponseDto": { + "$ref": "#/components/schemas/UserLicense" + }, + "ListSnapshotsResponseDto": { + "properties": { + "snapshots": { + "items": { + "$ref": "#/components/schemas/SnapshotDto" + }, + "type": "array" + } + }, + "required": [ + "snapshots" + ], + "type": "object" + }, + "LocalRepositoryDto": { + "properties": { + "backends": { + "$ref": "#/components/schemas/RepositoryBackendsDto" }, - "longitude": { - "default": null, - "description": "GPS longitude", - "nullable": true, - "type": "number" + "configuration": { + "$ref": "#/components/schemas/RepositoryConfigurationDto" }, - "make": { - "default": null, - "description": "Camera make", - "nullable": true, + "id": { "type": "string" }, - "model": { - "default": null, - "description": "Camera model", - "nullable": true, - "type": "string" + "meter": { + "$ref": "#/components/schemas/RepositoryMeterDto" }, - "modifyDate": { - "default": null, - "description": "Modification date/time", - "format": "date-time", - "nullable": true, - "type": "string" + "metrics": { + "$ref": "#/components/schemas/RepositoryMetricsDto" }, - "orientation": { - "default": null, - "description": "Image orientation", - "nullable": true, + "name": { "type": "string" }, - "projectionType": { - "default": null, - "description": "Projection type", + "siteCode": { "nullable": true, "type": "string" }, - "rating": { - "default": null, - "description": "Rating", - "maximum": 5, - "minimum": 1, - "nullable": true, - "type": "integer" - }, - "state": { - "default": null, - "description": "State/province name", + "storageClusterCode": { "nullable": true, "type": "string" }, - "timeZone": { - "default": null, - "description": "Time zone", - "nullable": true, + "worm": { + "type": "boolean" + } + }, + "required": [ + "id", + "metrics", + "name", + "siteCode", + "storageClusterCode", + "worm" + ], + "type": "object" + }, + "LogLevel": { + "description": "Log level", + "enum": [ + "verbose", + "debug", + "log", + "warn", + "error", + "fatal" + ], + "type": "string" + }, + "LogResponseDto": { + "properties": { + "logId": { "type": "string" } }, + "required": [ + "logId" + ], "type": "object" }, - "FaceDto": { + "LoginCredentialDto": { "properties": { - "id": { - "description": "Face ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "email": { + "description": "User email", + "example": "testuser@email.com", + "format": "email", + "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", + "type": "string" + }, + "password": { + "description": "User password", + "example": "password", "type": "string" } }, "required": [ - "id" + "email", + "password" ], "type": "object" }, - "FacialRecognitionConfig": { + "LoginResponseDto": { "properties": { - "enabled": { - "description": "Whether the task is enabled", + "accessToken": { + "description": "Access token", + "type": "string" + }, + "isAdmin": { + "description": "Is admin user", "type": "boolean" }, - "maxDistance": { - "description": "Maximum distance threshold for face recognition", - "format": "double", - "maximum": 2, - "minimum": 0.1, - "type": "number" + "isOnboarded": { + "description": "Is onboarded", + "type": "boolean" }, - "minFaces": { - "description": "Minimum number of faces required for recognition", - "maximum": 9007199254740991, - "minimum": 1, - "type": "integer" + "name": { + "description": "User name", + "type": "string" }, - "minScore": { - "description": "Minimum confidence score for face detection", - "format": "double", - "maximum": 1, - "minimum": 0.1, - "type": "number" + "profileImagePath": { + "description": "Profile image path", + "type": "string" }, - "modelName": { - "description": "Name of the model to use", + "shouldChangePassword": { + "description": "Should change password", + "type": "boolean" + }, + "userEmail": { + "description": "User email", + "format": "email", + "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", + "type": "string" + }, + "userId": { + "description": "User ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" } }, "required": [ - "enabled", - "maxDistance", - "minFaces", - "minScore", - "modelName" + "accessToken", + "isAdmin", + "isOnboarded", + "name", + "profileImagePath", + "shouldChangePassword", + "userEmail", + "userId" ], "type": "object" }, - "FoldersResponse": { + "LogoutResponseDto": { + "properties": { + "redirectUri": { + "description": "Redirect URI", + "type": "string" + }, + "successful": { + "description": "Logout successful", + "type": "boolean" + } + }, + "required": [ + "redirectUri", + "successful" + ], + "type": "object" + }, + "MachineLearningAvailabilityChecksDto": { "properties": { "enabled": { - "description": "Whether folders are enabled", + "description": "Enabled", "type": "boolean" }, - "sidebarWeb": { - "description": "Whether folders appear in web sidebar", - "type": "boolean" + "interval": { + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "timeout": { + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" } }, "required": [ "enabled", - "sidebarWeb" + "interval", + "timeout" ], "type": "object" }, - "FoldersUpdate": { - "properties": { - "enabled": { - "description": "Whether folders are enabled", - "type": "boolean" - }, - "sidebarWeb": { - "description": "Whether folders appear in web sidebar", - "type": "boolean" - } - }, - "type": "object" - }, - "HlsVideoResolution": { - "description": "HLS video resolution", - "enum": [ - 480, - 720, - 1080, - 1440, - 2160 - ], - "type": "integer" - }, - "ImageFormat": { - "description": "Image format", + "MaintenanceAction": { + "description": "Maintenance action", "enum": [ - "jpeg", - "webp" + "start", + "end", + "select_database_restore", + "restore_database", + "rollback" ], "type": "string" }, - "IntegrityReport": { - "description": "Integrity report type", - "enum": [ - "untracked_file", - "missing_file", - "checksum_mismatch" + "MaintenanceAuthDto": { + "properties": { + "username": { + "description": "Maintenance username", + "type": "string" + } + }, + "required": [ + "username" ], - "type": "string" + "type": "object" }, - "IntegrityReportResponseDto": { + "MaintenanceDetectInstallResponseDto": { "properties": { - "items": { + "storage": { "items": { - "properties": { - "id": { - "description": "Integrity report item id", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "path": { - "description": "Integrity report item path", - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/IntegrityReport" - } - }, - "required": [ - "id", - "type", - "path" - ], - "type": "object" + "$ref": "#/components/schemas/MaintenanceDetectInstallStorageFolderDto" }, "type": "array" - }, - "nextCursor": { - "type": "string" } }, "required": [ - "items" + "storage" ], "type": "object" }, - "IntegrityReportSummaryResponseDto": { + "MaintenanceDetectInstallStorageFolderDto": { "properties": { - "checksum_mismatch": { + "files": { + "description": "Number of files in the folder", "maximum": 9007199254740991, - "minimum": 0, + "minimum": -9007199254740991, "type": "integer" }, - "missing_file": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "folder": { + "$ref": "#/components/schemas/StorageFolder" }, - "untracked_file": { - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "readable": { + "description": "Whether the folder is readable", + "type": "boolean" + }, + "writable": { + "description": "Whether the folder is writable", + "type": "boolean" } }, "required": [ - "checksum_mismatch", - "missing_file", - "untracked_file" + "files", + "folder", + "readable", + "writable" ], "type": "object" }, - "JobCreateDto": { + "MaintenanceLoginDto": { "properties": { - "name": { - "$ref": "#/components/schemas/ManualJobName" + "token": { + "description": "Maintenance token", + "type": "string" } }, - "required": [ - "name" - ], "type": "object" }, - "JobName": { - "description": "Job name", - "enum": [ - "AssetDelete", - "AssetDeleteCheck", - "AssetDetectFacesQueueAll", - "AssetDetectFaces", - "AssetDetectDuplicatesQueueAll", - "AssetDetectDuplicates", - "AssetEditThumbnailGeneration", - "AssetEncodeVideoQueueAll", - "AssetEncodeVideo", - "AssetEmptyTrash", - "AssetExtractMetadataQueueAll", - "AssetExtractMetadata", - "AssetFileMigration", - "AssetGenerateThumbnailsQueueAll", - "AssetGenerateThumbnails", - "AuditTableCleanup", - "DatabaseBackup", - "FacialRecognitionQueueAll", - "FacialRecognition", - "FileDelete", - "FileMigrationQueueAll", - "LibraryDeleteCheck", - "LibraryDelete", - "LibraryRemoveAsset", - "LibraryScanAssetsQueueAll", - "LibrarySyncAssets", - "LibrarySyncFilesQueueAll", - "LibrarySyncFiles", - "LibraryScanQueueAll", - "HlsSessionCleanup", - "MemoryCleanup", - "MemoryGenerate", - "NotificationsCleanup", - "NotifyUserSignup", - "NotifyAlbumInvite", - "NotifyAlbumUpdate", - "UserDelete", - "UserDeleteCheck", - "UserSyncUsage", - "PersonCleanup", - "PersonFileMigration", - "PersonGenerateThumbnail", - "SessionCleanup", - "SendMail", - "SidecarQueueAll", - "SidecarCheck", - "SidecarWrite", - "SmartSearchQueueAll", - "SmartSearch", - "StorageTemplateMigration", - "StorageTemplateMigrationSingle", - "TagCleanup", - "VersionCheck", - "OcrQueueAll", - "Ocr", - "WorkflowAssetTrigger", - "IntegrityUntrackedFilesQueueAll", - "IntegrityUntrackedFiles", - "IntegrityUntrackedRefresh", - "IntegrityMissingFilesQueueAll", - "IntegrityMissingFiles", - "IntegrityMissingFilesRefresh", - "IntegrityChecksumFiles", - "IntegrityChecksumFilesRefresh", - "IntegrityDeleteReportType", - "IntegrityDeleteReports" - ], - "type": "string" - }, - "JobSettingsDto": { + "MaintenanceStatusResponseDto": { "properties": { - "concurrency": { - "description": "Concurrency", + "action": { + "$ref": "#/components/schemas/MaintenanceAction" + }, + "active": { + "type": "boolean" + }, + "error": { + "type": "string" + }, + "progress": { "maximum": 9007199254740991, - "minimum": 1, + "minimum": -9007199254740991, "type": "integer" + }, + "task": { + "type": "string" + }, + "yuccaLogId": { + "description": "Yucca log ID", + "type": "string" } }, "required": [ - "concurrency" + "action", + "active" ], "type": "object" }, - "LibraryResponseDto": { + "ManualJobName": { + "description": "Manual job name", + "enum": [ + "person-cleanup", + "tag-cleanup", + "user-cleanup", + "memory-cleanup", + "memory-create", + "backup-database", + "integrity-missing-files", + "integrity-untracked-files", + "integrity-checksum-mismatch", + "integrity-missing-files-refresh", + "integrity-untracked-files-refresh", + "integrity-checksum-mismatch-refresh", + "integrity-missing-files-delete-all", + "integrity-untracked-files-delete-all", + "integrity-checksum-mismatch-delete-all" + ], + "type": "string" + }, + "MapMarkerResponseDto": { "properties": { - "assetCount": { - "description": "Number of assets", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "createdAt": { - "description": "Creation date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "city": { + "description": "City name", + "nullable": true, "type": "string" }, - "exclusionPatterns": { - "description": "Exclusion patterns", - "items": { - "type": "string" - }, - "type": "array" + "country": { + "description": "Country name", + "nullable": true, + "type": "string" }, "id": { - "description": "Library ID", + "description": "Asset ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "importPaths": { - "description": "Import paths", - "items": { - "type": "string" - }, - "type": "array" + "lat": { + "description": "Latitude", + "format": "double", + "type": "number" }, - "name": { - "description": "Library name", - "type": "string" + "lon": { + "description": "Longitude", + "format": "double", + "type": "number" }, - "ownerId": { - "description": "Owner user ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "state": { + "description": "State/Province name", + "nullable": true, + "type": "string" + } + }, + "required": [ + "city", + "country", + "id", + "lat", + "lon", + "state" + ], + "type": "object" + }, + "MapReverseGeocodeResponseDto": { + "properties": { + "city": { + "description": "City name", + "nullable": true, "type": "string" }, - "refreshedAt": { - "description": "Last refresh date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", + "country": { + "description": "Country name", "nullable": true, - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "updatedAt": { - "description": "Last update date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "state": { + "description": "State/Province name", + "nullable": true, "type": "string" } }, "required": [ - "assetCount", - "createdAt", - "exclusionPatterns", - "id", - "importPaths", - "name", - "ownerId", - "refreshedAt", - "updatedAt" + "city", + "country", + "state" ], "type": "object" }, - "LibraryStatsResponseDto": { + "MemoriesResponse": { "properties": { - "photos": { - "description": "Number of photos", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "total": { - "description": "Total number of assets", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "usage": { - "description": "Storage usage in bytes", + "duration": { + "description": "Memory duration in seconds", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, - "videos": { - "description": "Number of videos", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "enabled": { + "description": "Whether memories are enabled", + "type": "boolean" } }, "required": [ - "photos", - "total", - "usage", - "videos" + "duration", + "enabled" ], "type": "object" }, - "LicenseKeyDto": { + "MemoriesUpdate": { "properties": { - "activationKey": { - "description": "Activation key", - "type": "string" + "duration": { + "description": "Memory duration in seconds", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" }, - "licenseKey": { - "description": "License key (format: /^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$/)", - "pattern": "^IM(SV|CL)(-[\\dA-Za-z]{4}){8}$", - "type": "string" + "enabled": { + "description": "Whether memories are enabled", + "type": "boolean" } }, - "required": [ - "activationKey", - "licenseKey" - ], "type": "object" }, - "LicenseResponseDto": { - "$ref": "#/components/schemas/UserLicense" - }, - "LogLevel": { - "description": "Log level", - "enum": [ - "verbose", - "debug", - "log", - "warn", - "error", - "fatal" - ], - "type": "string" - }, - "LoginCredentialDto": { + "MemoryCreateDto": { "properties": { - "email": { - "description": "User email", - "example": "testuser@email.com", - "format": "email", - "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", + "assetIds": { + "description": "Asset IDs to associate with memory", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" + }, + "data": { + "$ref": "#/components/schemas/OnThisDayDto" + }, + "hideAt": { + "description": "Date when memory should be hidden", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string", + "x-immich-history": [ + { + "version": "v2.6.0", + "state": "Added" + }, + { + "version": "v2.6.0", + "state": "Stable" + } + ], + "x-immich-state": "Stable" + }, + "isSaved": { + "description": "Is memory saved", + "type": "boolean" + }, + "memoryAt": { + "description": "Memory date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "password": { - "description": "User password", - "example": "password", + "seenAt": { + "description": "Date when memory was seen", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" + }, + "showAt": { + "description": "Date when memory should be shown", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string", + "x-immich-history": [ + { + "version": "v2.6.0", + "state": "Added" + }, + { + "version": "v2.6.0", + "state": "Stable" + } + ], + "x-immich-state": "Stable" + }, + "type": { + "$ref": "#/components/schemas/MemoryType" } }, "required": [ - "email", - "password" + "data", + "memoryAt", + "type" ], "type": "object" }, - "LoginResponseDto": { + "MemoryResponseDto": { "properties": { - "accessToken": { - "description": "Access token", + "assets": { + "items": { + "$ref": "#/components/schemas/AssetResponseDto" + }, + "type": "array" + }, + "createdAt": { + "description": "Creation date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "data": { + "$ref": "#/components/schemas/OnThisDayDto" + }, + "deletedAt": { + "description": "Deletion date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "isAdmin": { - "description": "Is admin user", - "type": "boolean" - }, - "isOnboarded": { - "description": "Is onboarded", - "type": "boolean" - }, - "name": { - "description": "User name", + "hideAt": { + "description": "Date when memory should be hidden", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "profileImagePath": { - "description": "Profile image path", + "id": { + "description": "Memory ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "shouldChangePassword": { - "description": "Should change password", + "isSaved": { + "description": "Is memory saved", "type": "boolean" }, - "userEmail": { - "description": "User email", - "format": "email", - "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", + "memoryAt": { + "description": "Memory date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "userId": { - "description": "User ID", + "ownerId": { + "description": "Owner user ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" - } - }, - "required": [ - "accessToken", - "isAdmin", - "isOnboarded", - "name", - "profileImagePath", - "shouldChangePassword", - "userEmail", - "userId" - ], - "type": "object" - }, - "LogoutResponseDto": { - "properties": { - "redirectUri": { - "description": "Redirect URI", + }, + "seenAt": { + "description": "Date when memory was seen", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "successful": { - "description": "Logout successful", - "type": "boolean" + "showAt": { + "description": "Date when memory should be shown", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/MemoryType" + }, + "updatedAt": { + "description": "Last update date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" } }, "required": [ - "redirectUri", - "successful" + "assets", + "createdAt", + "data", + "id", + "isSaved", + "memoryAt", + "ownerId", + "type", + "updatedAt" ], "type": "object" }, - "MachineLearningAvailabilityChecksDto": { + "MemorySearchOrder": { + "description": "Sort order", + "enum": [ + "asc", + "desc", + "random" + ], + "type": "string" + }, + "MemoryStatisticsResponseDto": { "properties": { - "enabled": { - "description": "Enabled", - "type": "boolean" - }, - "interval": { - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "timeout": { + "total": { + "description": "Total number of memories", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ - "enabled", - "interval", - "timeout" + "total" ], "type": "object" }, - "MaintenanceAction": { - "description": "Maintenance action", + "MemoryType": { + "description": "Memory type", "enum": [ - "start", - "end", - "select_database_restore", - "restore_database" + "on_this_day" ], "type": "string" }, - "MaintenanceAuthDto": { + "MemoryUpdateDto": { "properties": { - "username": { - "description": "Maintenance username", + "isSaved": { + "description": "Is memory saved", + "type": "boolean" + }, + "memoryAt": { + "description": "Memory date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "seenAt": { + "description": "Date when memory was seen", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" } }, - "required": [ - "username" - ], "type": "object" }, - "MaintenanceDetectInstallResponseDto": { + "MergePersonDto": { "properties": { - "storage": { + "ids": { + "description": "Person IDs to merge", "items": { - "$ref": "#/components/schemas/MaintenanceDetectInstallStorageFolderDto" + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" }, "type": "array" } }, "required": [ - "storage" - ], - "type": "object" - }, - "MaintenanceDetectInstallStorageFolderDto": { - "properties": { - "files": { - "description": "Number of files in the folder", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "folder": { - "$ref": "#/components/schemas/StorageFolder" - }, - "readable": { - "description": "Whether the folder is readable", - "type": "boolean" - }, - "writable": { - "description": "Whether the folder is writable", - "type": "boolean" - } - }, - "required": [ - "files", - "folder", - "readable", - "writable" + "ids" ], "type": "object" }, - "MaintenanceLoginDto": { - "properties": { - "token": { - "description": "Maintenance token", - "type": "string" - } - }, - "type": "object" - }, - "MaintenanceStatusResponseDto": { + "MetadataSearchDto": { "properties": { - "action": { - "$ref": "#/components/schemas/MaintenanceAction" - }, - "active": { - "type": "boolean" + "albumIds": { + "description": "Filter by album IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" }, - "error": { + "checksum": { + "description": "Filter by file checksum", "type": "string" }, - "progress": { - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "task": { - "type": "string" - } - }, - "required": [ - "action", - "active" - ], - "type": "object" - }, - "ManualJobName": { - "description": "Manual job name", - "enum": [ - "person-cleanup", - "tag-cleanup", - "user-cleanup", - "memory-cleanup", - "memory-create", - "backup-database", - "integrity-missing-files", - "integrity-untracked-files", - "integrity-checksum-mismatch", - "integrity-missing-files-refresh", - "integrity-untracked-files-refresh", - "integrity-checksum-mismatch-refresh", - "integrity-missing-files-delete-all", - "integrity-untracked-files-delete-all", - "integrity-checksum-mismatch-delete-all" - ], - "type": "string" - }, - "MapMarkerResponseDto": { - "properties": { "city": { - "description": "City name", + "description": "Filter by city name", "nullable": true, "type": "string" }, "country": { - "description": "Country name", + "description": "Filter by country name", "nullable": true, "type": "string" }, + "createdAfter": { + "description": "Filter by creation date (after)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "createdBefore": { + "description": "Filter by creation date (before)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "description": { + "description": "Filter by description text", + "type": "string" + }, + "encodedVideoPath": { + "description": "Filter by encoded video file path", + "type": "string" + }, "id": { - "description": "Asset ID", + "description": "Filter by asset ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "lat": { - "description": "Latitude", - "format": "double", - "type": "number" + "isEncoded": { + "description": "Filter by encoded status", + "type": "boolean" }, - "lon": { - "description": "Longitude", - "format": "double", - "type": "number" + "isFavorite": { + "description": "Filter by favorite status", + "type": "boolean" }, - "state": { - "description": "State/Province name", + "isMotion": { + "description": "Filter by motion photo status", + "type": "boolean" + }, + "isNotInAlbum": { + "description": "Filter assets not in any album", + "type": "boolean" + }, + "isOffline": { + "description": "Filter by offline status", + "type": "boolean" + }, + "lensModel": { + "description": "Filter by lens model", "nullable": true, "type": "string" - } - }, - "required": [ - "city", - "country", - "id", - "lat", - "lon", - "state" - ], - "type": "object" - }, - "MapReverseGeocodeResponseDto": { - "properties": { - "city": { - "description": "City name", + }, + "libraryId": { + "description": "Library ID to filter by", + "format": "uuid", "nullable": true, + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "country": { - "description": "Country name", + "make": { + "description": "Filter by camera make", "nullable": true, "type": "string" }, - "state": { - "description": "State/Province name", + "model": { + "description": "Filter by camera model", "nullable": true, "type": "string" - } - }, - "required": [ - "city", - "country", - "state" - ], - "type": "object" - }, - "MemoriesResponse": { - "properties": { - "duration": { - "description": "Memory duration in seconds", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" }, - "enabled": { - "description": "Whether memories are enabled", - "type": "boolean" - } - }, - "required": [ - "duration", - "enabled" - ], - "type": "object" - }, - "MemoriesUpdate": { - "properties": { - "duration": { - "description": "Memory duration in seconds", + "ocr": { + "description": "Filter by OCR text content", + "type": "string" + }, + "order": { + "$ref": "#/components/schemas/AssetOrder", + "default": "desc", + "description": "Sort order" + }, + "originalFileName": { + "description": "Filter by original file name", + "type": "string" + }, + "originalPath": { + "description": "Filter by original file path", + "type": "string" + }, + "page": { + "description": "Page number", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, - "enabled": { - "description": "Whether memories are enabled", - "type": "boolean" - } - }, - "type": "object" - }, - "MemoryCreateDto": { - "properties": { - "assetIds": { - "description": "Asset IDs to associate with memory", + "personIds": { + "description": "Filter by person IDs", "items": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", @@ -19855,229 +21793,202 @@ }, "type": "array" }, - "data": { - "$ref": "#/components/schemas/OnThisDayDto" + "previewPath": { + "description": "Filter by preview file path", + "type": "string" }, - "hideAt": { - "description": "Date when memory should be hidden", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string", + "rating": { + "description": "Filter by rating [1-5], or null for unrated", + "maximum": 5, + "minimum": 1, + "nullable": true, + "type": "integer", "x-immich-history": [ { - "version": "v2.6.0", + "version": "v1", "state": "Added" }, { - "version": "v2.6.0", + "version": "v2", "state": "Stable" - } - ], - "x-immich-state": "Stable" - }, - "isSaved": { - "description": "Is memory saved", - "type": "boolean" - }, - "memoryAt": { - "description": "Memory date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" - }, - "seenAt": { - "description": "Date when memory was seen", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" - }, - "showAt": { - "description": "Date when memory should be shown", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string", - "x-immich-history": [ + }, { "version": "v2.6.0", - "state": "Added" + "state": "Updated", + "description": "Using -1 as a rating is deprecated and will be removed in the next major version." }, { - "version": "v2.6.0", - "state": "Stable" + "version": "v3", + "state": "Updated", + "description": "Using -1 as a rating is no longer valid." } ], "x-immich-state": "Stable" }, - "type": { - "$ref": "#/components/schemas/MemoryType" - } - }, - "required": [ - "data", - "memoryAt", - "type" - ], - "type": "object" - }, - "MemoryResponseDto": { - "properties": { - "assets": { - "items": { - "$ref": "#/components/schemas/AssetResponseDto" - }, - "type": "array" + "size": { + "description": "Number of results to return", + "maximum": 1000, + "minimum": 1, + "type": "integer" }, - "createdAt": { - "description": "Creation date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "state": { + "description": "Filter by state/province name", + "nullable": true, "type": "string" }, - "data": { - "$ref": "#/components/schemas/OnThisDayDto" + "tagIds": { + "description": "Filter by tag IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "nullable": true, + "type": "array" }, - "deletedAt": { - "description": "Deletion date", + "takenAfter": { + "description": "Filter by taken date (after)", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "hideAt": { - "description": "Date when memory should be hidden", + "takenBefore": { + "description": "Filter by taken date (before)", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "id": { - "description": "Memory ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "thumbnailPath": { + "description": "Filter by thumbnail file path", "type": "string" }, - "isSaved": { - "description": "Is memory saved", - "type": "boolean" - }, - "memoryAt": { - "description": "Memory date", + "trashedAfter": { + "description": "Filter by trash date (after)", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "ownerId": { - "description": "Owner user ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "seenAt": { - "description": "Date when memory was seen", + "trashedBefore": { + "description": "Filter by trash date (before)", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "showAt": { - "description": "Date when memory should be shown", + "type": { + "$ref": "#/components/schemas/AssetTypeEnum" + }, + "updatedAfter": { + "description": "Filter by update date (after)", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "type": { - "$ref": "#/components/schemas/MemoryType" - }, - "updatedAt": { - "description": "Last update date", + "updatedBefore": { + "description": "Filter by update date (before)", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" + }, + "visibility": { + "$ref": "#/components/schemas/AssetVisibility" + }, + "withDeleted": { + "description": "Include deleted assets", + "type": "boolean" + }, + "withExif": { + "description": "Include EXIF data in response", + "type": "boolean" + }, + "withPeople": { + "description": "Include people data in response", + "type": "boolean" + }, + "withStacked": { + "description": "Include stacked assets", + "type": "boolean" } }, - "required": [ - "assets", - "createdAt", - "data", - "id", - "isSaved", - "memoryAt", - "ownerId", - "type", - "updatedAt" - ], "type": "object" }, - "MemorySearchOrder": { - "description": "Sort order", + "MirrorAxis": { + "description": "Axis to mirror along", "enum": [ - "asc", - "desc", - "random" + "horizontal", + "vertical" ], "type": "string" }, - "MemoryStatisticsResponseDto": { + "MirrorParameters": { "properties": { - "total": { - "description": "Total number of memories", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "axis": { + "$ref": "#/components/schemas/MirrorAxis" } }, "required": [ - "total" + "axis" ], "type": "object" }, - "MemoryType": { - "description": "Memory type", - "enum": [ - "on_this_day" - ], - "type": "string" - }, - "MemoryUpdateDto": { + "NotificationCreateDto": { "properties": { - "isSaved": { - "description": "Is memory saved", - "type": "boolean" + "data": { + "additionalProperties": {}, + "description": "Additional notification data", + "type": "object" }, - "memoryAt": { - "description": "Memory date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "description": { + "description": "Notification description", + "nullable": true, "type": "string" }, - "seenAt": { - "description": "Date when memory was seen", + "level": { + "$ref": "#/components/schemas/NotificationLevel" + }, + "readAt": { + "description": "Date when notification was read", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", + "nullable": true, "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" + }, + "title": { + "description": "Notification title", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/NotificationType" + }, + "userId": { + "description": "User ID to send notification to", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" } }, + "required": [ + "title", + "userId" + ], "type": "object" }, - "MergePersonDto": { + "NotificationDeleteAllDto": { "properties": { "ids": { - "description": "Person IDs to merge", + "description": "Notification IDs to delete", "items": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, + "minItems": 1, "type": "array" } }, @@ -20086,2081 +21997,2316 @@ ], "type": "object" }, - "MetadataSearchDto": { + "NotificationDto": { "properties": { - "albumIds": { - "description": "Filter by album IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" - }, - "checksum": { - "description": "Filter by file checksum", + "createdAt": { + "description": "Creation date", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "city": { - "description": "Filter by city name", - "nullable": true, + "data": { + "additionalProperties": {}, + "description": "Additional notification data", + "type": "object" + }, + "description": { + "description": "Notification description", "type": "string" }, - "country": { - "description": "Filter by country name", - "nullable": true, + "id": { + "description": "Notification ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "createdAfter": { - "description": "Filter by creation date (after)", + "level": { + "$ref": "#/components/schemas/NotificationLevel" + }, + "readAt": { + "description": "Date when notification was read", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "createdBefore": { - "description": "Filter by creation date (before)", + "title": { + "description": "Notification title", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/NotificationType" + } + }, + "required": [ + "createdAt", + "id", + "level", + "title", + "type" + ], + "type": "object" + }, + "NotificationLevel": { + "description": "Notification level", + "enum": [ + "success", + "error", + "warning", + "info" + ], + "type": "string" + }, + "NotificationType": { + "description": "Notification type", + "enum": [ + "JobFailed", + "BackupFailed", + "SystemMessage", + "AlbumInvite", + "AlbumUpdate", + "Custom" + ], + "type": "string" + }, + "NotificationUpdateAllDto": { + "properties": { + "ids": { + "description": "Notification IDs to update", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "readAt": { + "description": "Date when notifications were read", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "nullable": true, + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + } + }, + "required": [ + "ids" + ], + "type": "object" + }, + "NotificationUpdateDto": { + "properties": { + "readAt": { + "description": "Date when notification was read", "example": "2024-01-01T00:00:00.000Z", "format": "date-time", + "nullable": true, "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" - }, - "description": { - "description": "Filter by description text", - "type": "string" - }, - "encodedVideoPath": { - "description": "Filter by encoded video file path", - "type": "string" - }, - "id": { - "description": "Filter by asset ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + } + }, + "type": "object" + }, + "OAuthAuthorizeResponseDto": { + "properties": { + "url": { + "description": "OAuth authorization URL", "type": "string" - }, - "isEncoded": { - "description": "Filter by encoded status", - "type": "boolean" - }, - "isFavorite": { - "description": "Filter by favorite status", - "type": "boolean" - }, - "isMotion": { - "description": "Filter by motion photo status", - "type": "boolean" - }, - "isNotInAlbum": { - "description": "Filter assets not in any album", - "type": "boolean" - }, - "isOffline": { - "description": "Filter by offline status", - "type": "boolean" - }, - "lensModel": { - "description": "Filter by lens model", - "nullable": true, + } + }, + "required": [ + "url" + ], + "type": "object" + }, + "OAuthBackchannelLogoutDto": { + "properties": { + "logout_token": { + "description": "OAuth logout token", "type": "string" - }, - "libraryId": { - "description": "Library ID to filter by", - "format": "uuid", - "nullable": true, - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + } + }, + "required": [ + "logout_token" + ], + "type": "object" + }, + "OAuthCallbackDto": { + "properties": { + "codeVerifier": { + "description": "OAuth code verifier (PKCE)", "type": "string" }, - "make": { - "description": "Filter by camera make", - "nullable": true, + "state": { + "description": "OAuth state parameter", "type": "string" }, - "model": { - "description": "Filter by camera model", - "nullable": true, + "url": { + "description": "OAuth callback URL", + "minLength": 1, "type": "string" - }, - "ocr": { - "description": "Filter by OCR text content", + } + }, + "required": [ + "url" + ], + "type": "object" + }, + "OAuthConfigDto": { + "properties": { + "codeChallenge": { + "description": "OAuth code challenge (PKCE)", "type": "string" }, - "order": { - "$ref": "#/components/schemas/AssetOrder", - "default": "desc", - "description": "Sort order" - }, - "originalFileName": { - "description": "Filter by original file name", + "redirectUri": { + "description": "OAuth redirect URI", "type": "string" }, - "originalPath": { - "description": "Filter by original file path", + "state": { + "description": "OAuth state parameter", "type": "string" + } + }, + "required": [ + "redirectUri" + ], + "type": "object" + }, + "OAuthTokenEndpointAuthMethod": { + "description": "OAuth token endpoint auth method", + "enum": [ + "client_secret_post", + "client_secret_basic" + ], + "type": "string" + }, + "OcrConfig": { + "properties": { + "enabled": { + "description": "Whether the task is enabled", + "type": "boolean" }, - "page": { - "description": "Page number", + "maxResolution": { + "description": "Maximum resolution for OCR processing", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, - "personIds": { - "description": "Filter by person IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "type": "array" - }, - "previewPath": { - "description": "Filter by preview file path", - "type": "string" - }, - "rating": { - "description": "Filter by rating [1-5], or null for unrated", - "maximum": 5, - "minimum": 1, - "nullable": true, - "type": "integer", - "x-immich-history": [ - { - "version": "v1", - "state": "Added" - }, - { - "version": "v2", - "state": "Stable" - }, - { - "version": "v2.6.0", - "state": "Updated", - "description": "Using -1 as a rating is deprecated and will be removed in the next major version." - }, - { - "version": "v3", - "state": "Updated", - "description": "Using -1 as a rating is no longer valid." - } - ], - "x-immich-state": "Stable" + "minDetectionScore": { + "description": "Minimum confidence score for text detection", + "format": "double", + "maximum": 1, + "minimum": 0.1, + "type": "number" }, - "size": { - "description": "Number of results to return", - "maximum": 1000, - "minimum": 1, - "type": "integer" + "minRecognitionScore": { + "description": "Minimum confidence score for text recognition", + "format": "double", + "maximum": 1, + "minimum": 0.1, + "type": "number" }, - "state": { - "description": "Filter by state/province name", - "nullable": true, + "modelName": { + "description": "Name of the model to use", "type": "string" - }, - "tagIds": { - "description": "Filter by tag IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "takenAfter": { - "description": "Filter by taken date (after)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + } + }, + "required": [ + "enabled", + "maxResolution", + "minDetectionScore", + "minRecognitionScore", + "modelName" + ], + "type": "object" + }, + "OnThisDayDto": { + "properties": { + "year": { + "description": "Year for on this day memory", + "maximum": 9999, + "minimum": 1000, + "type": "integer" + } + }, + "required": [ + "year" + ], + "type": "object" + }, + "OnboardingDto": { + "properties": { + "isOnboarded": { + "description": "Is user onboarded", + "type": "boolean" + } + }, + "required": [ + "isOnboarded" + ], + "type": "object" + }, + "OnboardingResponseDto": { + "properties": { + "isOnboarded": { + "description": "Is user onboarded", + "type": "boolean" + } + }, + "required": [ + "isOnboarded" + ], + "type": "object" + }, + "OnboardingStatusResponseDto": { + "properties": { + "error": { "type": "string" }, - "takenBefore": { - "description": "Filter by taken date (before)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" + "hasBackend": { + "type": "boolean" }, - "thumbnailPath": { - "description": "Filter by thumbnail file path", - "type": "string" + "hasBackup": { + "type": "boolean" }, - "trashedAfter": { - "description": "Filter by trash date (after)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" + "hasOnboardedKey": { + "type": "boolean" }, - "trashedBefore": { - "description": "Filter by trash date (before)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" + "hasSchedule": { + "type": "boolean" }, - "type": { - "$ref": "#/components/schemas/AssetTypeEnum" + "hasSkippedExtraConfig": { + "type": "boolean" }, - "updatedAfter": { - "description": "Filter by update date (after)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "hasTelemetry": { + "allOf": [ + { + "$ref": "#/components/schemas/TelemetryLevel" + } + ] + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/BootstrapStatus" + } + ] + } + }, + "required": [ + "hasBackend", + "hasBackup", + "hasOnboardedKey", + "hasSchedule", + "hasSkippedExtraConfig", + "hasTelemetry", + "status" + ], + "type": "object" + }, + "PartnerCreateDto": { + "properties": { + "sharedWithId": { + "description": "User ID to share with", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" + } + }, + "required": [ + "sharedWithId" + ], + "type": "object" + }, + "PartnerDirection": { + "description": "Partner direction", + "enum": [ + "shared-by", + "shared-with" + ], + "type": "string" + }, + "PartnerResponseDto": { + "description": "Partner response", + "properties": { + "avatarColor": { + "$ref": "#/components/schemas/UserAvatarColor" }, - "updatedBefore": { - "description": "Filter by update date (before)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "email": { + "description": "User email", + "format": "email", + "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "type": "string" }, - "visibility": { - "$ref": "#/components/schemas/AssetVisibility" + "id": { + "description": "User ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" }, - "withDeleted": { - "description": "Include deleted assets", + "inTimeline": { + "description": "Show in timeline", "type": "boolean" }, - "withExif": { - "description": "Include EXIF data in response", - "type": "boolean" + "name": { + "description": "User name", + "type": "string" }, - "withPeople": { - "description": "Include people data in response", - "type": "boolean" + "profileChangedAt": { + "description": "Profile change date", + "format": "date-time", + "type": "string" }, - "withStacked": { - "description": "Include stacked assets", - "type": "boolean" + "profileImagePath": { + "description": "Profile image path", + "type": "string" } }, - "type": "object" - }, - "MirrorAxis": { - "description": "Axis to mirror along", - "enum": [ - "horizontal", - "vertical" + "required": [ + "avatarColor", + "email", + "id", + "name", + "profileChangedAt", + "profileImagePath" ], - "type": "string" + "type": "object" }, - "MirrorParameters": { + "PartnerUpdateDto": { "properties": { - "axis": { - "$ref": "#/components/schemas/MirrorAxis" + "inTimeline": { + "description": "Show partner assets in timeline", + "type": "boolean" } }, "required": [ - "axis" + "inTimeline" ], "type": "object" }, - "NotificationCreateDto": { + "PeopleResponse": { "properties": { - "data": { - "additionalProperties": {}, - "description": "Additional notification data", - "type": "object" - }, - "description": { - "description": "Notification description", - "nullable": true, - "type": "string" + "enabled": { + "description": "Whether people are enabled", + "type": "boolean" }, - "level": { - "$ref": "#/components/schemas/NotificationLevel" + "minimumFaces": { + "description": "People face threshold", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" }, - "readAt": { - "description": "Date when notification was read", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "nullable": true, - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" + "sidebarWeb": { + "description": "Whether people appear in web sidebar", + "type": "boolean" + } + }, + "required": [ + "enabled", + "sidebarWeb" + ], + "type": "object" + }, + "PeopleResponseDto": { + "description": "People response", + "properties": { + "hasNextPage": { + "description": "Whether there are more pages", + "type": "boolean", + "x-immich-history": [ + { + "version": "v1.110.0", + "state": "Added" + }, + { + "version": "v2", + "state": "Stable" + } + ], + "x-immich-state": "Stable" }, - "title": { - "description": "Notification title", - "type": "string" + "hidden": { + "description": "Number of hidden people", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" }, - "type": { - "$ref": "#/components/schemas/NotificationType" + "people": { + "items": { + "$ref": "#/components/schemas/PersonResponseDto" + }, + "type": "array" }, - "userId": { - "description": "User ID to send notification to", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "total": { + "description": "Total number of people", + "maximum": 9007199254740991, + "minimum": 0, + "type": "integer" } }, "required": [ - "title", - "userId" + "hidden", + "people", + "total" ], "type": "object" }, - "NotificationDeleteAllDto": { + "PeopleUpdate": { + "properties": { + "enabled": { + "description": "Whether people are enabled", + "type": "boolean" + }, + "minimumFaces": { + "description": "People face threshold", + "maximum": 9007199254740991, + "minimum": 1, + "type": "integer" + }, + "sidebarWeb": { + "description": "Whether people appear in web sidebar", + "type": "boolean" + } + }, + "type": "object" + }, + "PeopleUpdateDto": { "properties": { - "ids": { - "description": "Notification IDs to delete", + "people": { + "description": "People to update", "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "$ref": "#/components/schemas/PeopleUpdateItem" }, - "minItems": 1, "type": "array" } }, "required": [ - "ids" + "people" ], "type": "object" }, - "NotificationDto": { + "PeopleUpdateItem": { "properties": { - "createdAt": { - "description": "Creation date", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "birthDate": { + "description": "Person date of birth", + "format": "date", + "nullable": true, "type": "string" }, - "data": { - "additionalProperties": {}, - "description": "Additional notification data", - "type": "object" + "color": { + "description": "Person color (hex)", + "nullable": true, + "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", + "type": "string" }, - "description": { - "description": "Notification description", + "featureFaceAssetId": { + "description": "Asset ID used for feature face thumbnail", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, "id": { - "description": "Notification ID", + "description": "Person ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "level": { - "$ref": "#/components/schemas/NotificationLevel" + "isFavorite": { + "description": "Mark as favorite", + "type": "boolean" }, - "readAt": { - "description": "Date when notification was read", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" + "isHidden": { + "description": "Person visibility (hidden)", + "type": "boolean" }, - "title": { - "description": "Notification title", + "name": { + "description": "Person name", "type": "string" - }, - "type": { - "$ref": "#/components/schemas/NotificationType" } }, "required": [ - "createdAt", - "id", - "level", - "title", - "type" + "id" ], "type": "object" }, - "NotificationLevel": { - "description": "Notification level", - "enum": [ - "success", - "error", - "warning", - "info" - ], - "type": "string" - }, - "NotificationType": { - "description": "Notification type", + "Permission": { + "description": "List of permissions", "enum": [ - "JobFailed", - "BackupFailed", - "SystemMessage", - "AlbumInvite", - "AlbumUpdate", - "Custom" - ], - "type": "string" - }, - "NotificationUpdateAllDto": { - "properties": { - "ids": { - "description": "Notification IDs to update", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "readAt": { - "description": "Date when notifications were read", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "nullable": true, - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" - } - }, - "required": [ - "ids" + "all", + "activity.create", + "activity.read", + "activity.update", + "activity.delete", + "activity.statistics", + "apiKey.create", + "apiKey.read", + "apiKey.update", + "apiKey.delete", + "asset.read", + "asset.update", + "asset.delete", + "asset.statistics", + "asset.share", + "asset.view", + "asset.download", + "asset.upload", + "asset.copy", + "asset.derive", + "asset.edit.get", + "asset.edit.create", + "asset.edit.delete", + "album.create", + "album.read", + "album.update", + "album.delete", + "album.statistics", + "album.share", + "album.download", + "albumAsset.create", + "albumAsset.delete", + "albumUser.create", + "albumUser.update", + "albumUser.delete", + "auth.changePassword", + "authDevice.delete", + "archive.read", + "backup.list", + "backup.download", + "backup.upload", + "backup.delete", + "duplicate.read", + "duplicate.delete", + "face.create", + "face.read", + "face.update", + "face.delete", + "folder.read", + "job.create", + "job.read", + "library.create", + "library.read", + "library.update", + "library.delete", + "library.statistics", + "timeline.read", + "timeline.download", + "maintenance", + "map.read", + "map.search", + "memory.create", + "memory.read", + "memory.update", + "memory.delete", + "memory.statistics", + "memoryAsset.create", + "memoryAsset.delete", + "notification.create", + "notification.read", + "notification.update", + "notification.delete", + "partner.create", + "partner.read", + "partner.update", + "partner.delete", + "person.create", + "person.read", + "person.update", + "person.delete", + "person.statistics", + "person.merge", + "person.reassign", + "pinCode.create", + "pinCode.update", + "pinCode.delete", + "plugin.create", + "plugin.read", + "plugin.update", + "plugin.delete", + "server.about", + "server.apkLinks", + "server.storage", + "server.statistics", + "server.versionCheck", + "serverLicense.read", + "serverLicense.update", + "serverLicense.delete", + "session.create", + "session.read", + "session.update", + "session.delete", + "session.lock", + "sharedLink.create", + "sharedLink.read", + "sharedLink.update", + "sharedLink.delete", + "stack.create", + "stack.read", + "stack.update", + "stack.delete", + "sync.stream", + "syncCheckpoint.read", + "syncCheckpoint.update", + "syncCheckpoint.delete", + "systemConfig.read", + "systemConfig.update", + "systemMetadata.read", + "systemMetadata.update", + "tag.create", + "tag.read", + "tag.update", + "tag.delete", + "tag.asset", + "user.read", + "user.update", + "userLicense.create", + "userLicense.read", + "userLicense.update", + "userLicense.delete", + "userOnboarding.read", + "userOnboarding.update", + "userOnboarding.delete", + "userPreference.read", + "userPreference.update", + "userProfileImage.create", + "userProfileImage.read", + "userProfileImage.update", + "userProfileImage.delete", + "queue.read", + "queue.update", + "queueJob.create", + "queueJob.read", + "queueJob.update", + "queueJob.delete", + "workflow.create", + "workflow.read", + "workflow.update", + "workflow.delete", + "adminUser.create", + "adminUser.read", + "adminUser.update", + "adminUser.delete", + "adminSession.read", + "adminAuth.unlinkAll" ], - "type": "object" + "type": "string" }, - "NotificationUpdateDto": { + "PersonCreateDto": { "properties": { - "readAt": { - "description": "Date when notification was read", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", + "birthDate": { + "description": "Person date of birth", + "format": "date", "nullable": true, - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "color": { + "description": "Person color (hex)", + "nullable": true, + "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", + "type": "string" + }, + "isFavorite": { + "description": "Mark as favorite", + "type": "boolean" + }, + "isHidden": { + "description": "Person visibility (hidden)", + "type": "boolean" + }, + "name": { + "description": "Person name", "type": "string" } }, "type": "object" }, - "OAuthAuthorizeResponseDto": { + "PersonResponseDto": { "properties": { - "url": { - "description": "OAuth authorization URL", + "birthDate": { + "description": "Person date of birth", + "format": "date", + "nullable": true, + "type": "string" + }, + "color": { + "description": "Person color (hex)", + "type": "string", + "x-immich-history": [ + { + "version": "v1.126.0", + "state": "Added" + }, + { + "version": "v2", + "state": "Stable" + } + ], + "x-immich-state": "Stable" + }, + "id": { + "description": "Person ID", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "isFavorite": { + "description": "Is favorite", + "type": "boolean", + "x-immich-history": [ + { + "version": "v1.126.0", + "state": "Added" + }, + { + "version": "v2", + "state": "Stable" + } + ], + "x-immich-state": "Stable" + }, + "isHidden": { + "description": "Is hidden", + "type": "boolean" + }, + "name": { + "description": "Person name", + "type": "string" + }, + "thumbnailPath": { + "description": "Thumbnail path", "type": "string" + }, + "updatedAt": { + "description": "Last update date", + "format": "date-time", + "type": "string", + "x-immich-history": [ + { + "version": "v1.107.0", + "state": "Added" + }, + { + "version": "v2", + "state": "Stable" + } + ], + "x-immich-state": "Stable" } }, "required": [ - "url" + "birthDate", + "id", + "isHidden", + "name", + "thumbnailPath" ], "type": "object" }, - "OAuthBackchannelLogoutDto": { + "PersonStatisticsResponseDto": { "properties": { - "logout_token": { - "description": "OAuth logout token", - "type": "string" + "assets": { + "description": "Number of assets", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" } }, "required": [ - "logout_token" + "assets" ], "type": "object" }, - "OAuthCallbackDto": { + "PersonUpdateDto": { "properties": { - "codeVerifier": { - "description": "OAuth code verifier (PKCE)", + "birthDate": { + "description": "Person date of birth", + "format": "date", + "nullable": true, "type": "string" }, - "state": { - "description": "OAuth state parameter", + "color": { + "description": "Person color (hex)", + "nullable": true, + "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, - "url": { - "description": "OAuth callback URL", - "minLength": 1, + "featureFaceAssetId": { + "description": "Asset ID used for feature face thumbnail", + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "isFavorite": { + "description": "Mark as favorite", + "type": "boolean" + }, + "isHidden": { + "description": "Person visibility (hidden)", + "type": "boolean" + }, + "name": { + "description": "Person name", "type": "string" } }, - "required": [ - "url" - ], "type": "object" }, - "OAuthConfigDto": { + "PinCodeChangeDto": { "properties": { - "codeChallenge": { - "description": "OAuth code challenge (PKCE)", + "newPinCode": { + "description": "New PIN code (4-6 digits)", + "pattern": "^\\d{6}$", "type": "string" }, - "redirectUri": { - "description": "OAuth redirect URI", + "password": { + "description": "User password (required if PIN code is not provided)", + "example": "password", "type": "string" }, - "state": { - "description": "OAuth state parameter", + "pinCode": { + "description": "New PIN code (4-6 digits)", + "example": "123456", + "pattern": "^\\d{6}$", "type": "string" } }, "required": [ - "redirectUri" + "newPinCode" ], "type": "object" }, - "OAuthTokenEndpointAuthMethod": { - "description": "OAuth token endpoint auth method", - "enum": [ - "client_secret_post", - "client_secret_basic" - ], - "type": "string" - }, - "OcrConfig": { + "PinCodeResetDto": { "properties": { - "enabled": { - "description": "Whether the task is enabled", - "type": "boolean" - }, - "maxResolution": { - "description": "Maximum resolution for OCR processing", - "maximum": 9007199254740991, - "minimum": 1, - "type": "integer" - }, - "minDetectionScore": { - "description": "Minimum confidence score for text detection", - "format": "double", - "maximum": 1, - "minimum": 0.1, - "type": "number" - }, - "minRecognitionScore": { - "description": "Minimum confidence score for text recognition", - "format": "double", - "maximum": 1, - "minimum": 0.1, - "type": "number" + "password": { + "description": "User password (required if PIN code is not provided)", + "example": "password", + "type": "string" }, - "modelName": { - "description": "Name of the model to use", + "pinCode": { + "description": "New PIN code (4-6 digits)", + "example": "123456", + "pattern": "^\\d{6}$", "type": "string" } }, - "required": [ - "enabled", - "maxResolution", - "minDetectionScore", - "minRecognitionScore", - "modelName" - ], - "type": "object" - }, - "OnThisDayDto": { - "properties": { - "year": { - "description": "Year for on this day memory", - "maximum": 9999, - "minimum": 1000, - "type": "integer" - } - }, - "required": [ - "year" - ], "type": "object" }, - "OnboardingDto": { + "PinCodeSetupDto": { "properties": { - "isOnboarded": { - "description": "Is user onboarded", - "type": "boolean" + "pinCode": { + "description": "PIN code (4-6 digits)", + "example": "123456", + "pattern": "^\\d{6}$", + "type": "string" } }, "required": [ - "isOnboarded" + "pinCode" ], "type": "object" }, - "OnboardingResponseDto": { + "PlacesResponseDto": { "properties": { - "isOnboarded": { - "description": "Is user onboarded", - "type": "boolean" + "admin1name": { + "description": "Administrative level 1 name (state/province)", + "type": "string" + }, + "admin2name": { + "description": "Administrative level 2 name (county/district)", + "type": "string" + }, + "latitude": { + "description": "Latitude coordinate", + "type": "number" + }, + "longitude": { + "description": "Longitude coordinate", + "type": "number" + }, + "name": { + "description": "Place name", + "type": "string" } }, "required": [ - "isOnboarded" + "latitude", + "longitude", + "name" ], "type": "object" }, - "PartnerCreateDto": { + "PluginMethodResponseDto": { "properties": { - "sharedWithId": { - "description": "User ID to share with", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "description": { + "description": "Description", + "type": "string" + }, + "hostFunctions": { + "type": "boolean" + }, + "key": { + "description": "Key", + "type": "string" + }, + "name": { + "description": "Name", + "type": "string" + }, + "schema": { + "properties": {}, + "type": "object" + }, + "title": { + "description": "Title", "type": "string" + }, + "types": { + "description": "Workflow types", + "items": { + "$ref": "#/components/schemas/WorkflowType" + }, + "type": "array" + }, + "uiHints": { + "description": "Ui hints", + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ - "sharedWithId" + "description", + "hostFunctions", + "key", + "name", + "title", + "types", + "uiHints" ], "type": "object" }, - "PartnerDirection": { - "description": "Partner direction", - "enum": [ - "shared-by", - "shared-with" - ], - "type": "string" - }, - "PartnerResponseDto": { - "description": "Partner response", + "PluginResponseDto": { "properties": { - "avatarColor": { - "$ref": "#/components/schemas/UserAvatarColor" + "author": { + "description": "Plugin author", + "type": "string" }, - "email": { - "description": "User email", - "format": "email", - "pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", + "createdAt": { + "description": "Creation date", + "type": "string" + }, + "description": { + "description": "Plugin description", "type": "string" }, "id": { - "description": "User ID", + "description": "Plugin ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "inTimeline": { - "description": "Show in timeline", - "type": "boolean" + "methods": { + "description": "Plugin methods", + "items": { + "$ref": "#/components/schemas/PluginMethodResponseDto" + }, + "type": "array" }, "name": { - "description": "User name", + "description": "Plugin name", "type": "string" }, - "profileChangedAt": { - "description": "Profile change date", - "format": "date-time", + "title": { + "description": "Plugin title", "type": "string" }, - "profileImagePath": { - "description": "Profile image path", + "updatedAt": { + "description": "Last update date", + "type": "string" + }, + "version": { + "description": "Plugin version", "type": "string" } }, "required": [ - "avatarColor", - "email", + "author", + "createdAt", + "description", "id", + "methods", "name", - "profileChangedAt", - "profileImagePath" - ], - "type": "object" - }, - "PartnerUpdateDto": { - "properties": { - "inTimeline": { - "description": "Show partner assets in timeline", - "type": "boolean" - } - }, - "required": [ - "inTimeline" - ], - "type": "object" - }, - "PeopleResponse": { - "properties": { - "enabled": { - "description": "Whether people are enabled", - "type": "boolean" - }, - "minimumFaces": { - "description": "People face threshold", - "maximum": 9007199254740991, - "minimum": 1, - "type": "integer" - }, - "sidebarWeb": { - "description": "Whether people appear in web sidebar", - "type": "boolean" - } - }, - "required": [ - "enabled", - "sidebarWeb" + "title", + "updatedAt", + "version" ], "type": "object" }, - "PeopleResponseDto": { - "description": "People response", + "PluginTemplateResponseDto": { "properties": { - "hasNextPage": { - "description": "Whether there are more pages", - "type": "boolean", - "x-immich-history": [ - { - "version": "v1.110.0", - "state": "Added" - }, - { - "version": "v2", - "state": "Stable" - } - ], - "x-immich-state": "Stable" + "description": { + "description": "Template description", + "type": "string" }, - "hidden": { - "description": "Number of hidden people", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" + "key": { + "description": "Template key (unique across all templates)", + "type": "string" }, - "people": { + "steps": { + "description": "Workflow steps", "items": { - "$ref": "#/components/schemas/PersonResponseDto" + "$ref": "#/components/schemas/PluginTemplateStepResponseDto" }, "type": "array" }, - "total": { - "description": "Total number of people", - "maximum": 9007199254740991, - "minimum": 0, - "type": "integer" - } - }, - "required": [ - "hidden", - "people", - "total" - ], - "type": "object" - }, - "PeopleUpdate": { - "properties": { - "enabled": { - "description": "Whether people are enabled", - "type": "boolean" - }, - "minimumFaces": { - "description": "People face threshold", - "maximum": 9007199254740991, - "minimum": 1, - "type": "integer" + "title": { + "description": "Template title", + "type": "string" }, - "sidebarWeb": { - "description": "Whether people appear in web sidebar", - "type": "boolean" - } - }, - "type": "object" - }, - "PeopleUpdateDto": { - "properties": { - "people": { - "description": "People to update", + "trigger": { + "$ref": "#/components/schemas/WorkflowTrigger", + "description": "Workflow trigger" + }, + "uiHints": { + "description": "Ui hints, for example \"smart-album\"", "items": { - "$ref": "#/components/schemas/PeopleUpdateItem" + "type": "string" }, "type": "array" } }, "required": [ - "people" + "description", + "key", + "steps", + "title", + "trigger", + "uiHints" ], "type": "object" }, - "PeopleUpdateItem": { + "PluginTemplateStepResponseDto": { "properties": { - "birthDate": { - "description": "Person date of birth", - "format": "date", - "nullable": true, - "type": "string" - }, - "color": { - "description": "Person color (hex)", + "config": { + "additionalProperties": {}, + "description": "Step configuration", "nullable": true, - "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", - "type": "string" - }, - "featureFaceAssetId": { - "description": "Asset ID used for feature face thumbnail", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "id": { - "description": "Person ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "isFavorite": { - "description": "Mark as favorite", - "type": "boolean" + "type": "object" }, - "isHidden": { - "description": "Person visibility (hidden)", + "enabled": { + "description": "Whether the step is enabled", "type": "boolean" }, - "name": { - "description": "Person name", + "method": { + "description": "Step plugin method", "type": "string" } }, "required": [ - "id" + "config", + "method" ], "type": "object" }, - "Permission": { - "description": "List of permissions", - "enum": [ - "all", - "activity.create", - "activity.read", - "activity.update", - "activity.delete", - "activity.statistics", - "apiKey.create", - "apiKey.read", - "apiKey.update", - "apiKey.delete", - "asset.read", - "asset.update", - "asset.delete", - "asset.statistics", - "asset.share", - "asset.view", - "asset.download", - "asset.upload", - "asset.copy", - "asset.derive", - "asset.edit.get", - "asset.edit.create", - "asset.edit.delete", - "album.create", - "album.read", - "album.update", - "album.delete", - "album.statistics", - "album.share", - "album.download", - "albumAsset.create", - "albumAsset.delete", - "albumUser.create", - "albumUser.update", - "albumUser.delete", - "auth.changePassword", - "authDevice.delete", - "archive.read", - "backup.list", - "backup.download", - "backup.upload", - "backup.delete", - "duplicate.read", - "duplicate.delete", - "face.create", - "face.read", - "face.update", - "face.delete", - "folder.read", - "job.create", - "job.read", - "library.create", - "library.read", - "library.update", - "library.delete", - "library.statistics", - "timeline.read", - "timeline.download", - "maintenance", - "map.read", - "map.search", - "memory.create", - "memory.read", - "memory.update", - "memory.delete", - "memory.statistics", - "memoryAsset.create", - "memoryAsset.delete", - "notification.create", - "notification.read", - "notification.update", - "notification.delete", - "partner.create", - "partner.read", - "partner.update", - "partner.delete", - "person.create", - "person.read", - "person.update", - "person.delete", - "person.statistics", - "person.merge", - "person.reassign", - "pinCode.create", - "pinCode.update", - "pinCode.delete", - "plugin.create", - "plugin.read", - "plugin.update", - "plugin.delete", - "server.about", - "server.apkLinks", - "server.storage", - "server.statistics", - "server.versionCheck", - "serverLicense.read", - "serverLicense.update", - "serverLicense.delete", - "session.create", - "session.read", - "session.update", - "session.delete", - "session.lock", - "sharedLink.create", - "sharedLink.read", - "sharedLink.update", - "sharedLink.delete", - "stack.create", - "stack.read", - "stack.update", - "stack.delete", - "sync.stream", - "syncCheckpoint.read", - "syncCheckpoint.update", - "syncCheckpoint.delete", - "systemConfig.read", - "systemConfig.update", - "systemMetadata.read", - "systemMetadata.update", - "tag.create", - "tag.read", - "tag.update", - "tag.delete", - "tag.asset", - "user.read", - "user.update", - "userLicense.create", - "userLicense.read", - "userLicense.update", - "userLicense.delete", - "userOnboarding.read", - "userOnboarding.update", - "userOnboarding.delete", - "userPreference.read", - "userPreference.update", - "userProfileImage.create", - "userProfileImage.read", - "userProfileImage.update", - "userProfileImage.delete", - "queue.read", - "queue.update", - "queueJob.create", - "queueJob.read", - "queueJob.update", - "queueJob.delete", - "workflow.create", - "workflow.read", - "workflow.update", - "workflow.delete", - "adminUser.create", - "adminUser.read", - "adminUser.update", - "adminUser.delete", - "adminSession.read", - "adminAuth.unlinkAll" - ], - "type": "string" - }, - "PersonCreateDto": { + "PurchaseResponse": { "properties": { - "birthDate": { - "description": "Person date of birth", - "format": "date", - "nullable": true, + "hideBuyButtonUntil": { + "description": "Date until which to hide buy button", "type": "string" }, - "color": { - "description": "Person color (hex)", - "nullable": true, - "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", + "showSupportBadge": { + "description": "Whether to show support badge", + "type": "boolean" + } + }, + "required": [ + "hideBuyButtonUntil", + "showSupportBadge" + ], + "type": "object" + }, + "PurchaseUpdate": { + "properties": { + "hideBuyButtonUntil": { + "description": "Date until which to hide buy button", "type": "string" }, - "isFavorite": { - "description": "Mark as favorite", + "showSupportBadge": { + "description": "Whether to show support badge", "type": "boolean" + } + }, + "type": "object" + }, + "QueueCommand": { + "description": "Queue command to execute", + "enum": [ + "start", + "pause", + "resume", + "empty", + "clear-failed" + ], + "type": "string" + }, + "QueueCommandDto": { + "properties": { + "command": { + "$ref": "#/components/schemas/QueueCommand" }, - "isHidden": { - "description": "Person visibility (hidden)", + "force": { + "description": "Force the command execution (if applicable)", "type": "boolean" - }, - "name": { - "description": "Person name", - "type": "string" } }, + "required": [ + "command" + ], "type": "object" }, - "PersonResponseDto": { + "QueueDeleteDto": { "properties": { - "birthDate": { - "description": "Person date of birth", - "format": "date", - "nullable": true, - "type": "string" - }, - "color": { - "description": "Person color (hex)", - "type": "string", + "failed": { + "description": "If true, will also remove failed jobs from the queue.", + "type": "boolean", "x-immich-history": [ { - "version": "v1.126.0", + "version": "v2.4.0", "state": "Added" }, { - "version": "v2", - "state": "Stable" + "version": "v2.4.0", + "state": "Alpha" } ], - "x-immich-state": "Stable" + "x-immich-state": "Alpha" + } + }, + "type": "object" + }, + "QueueJobResponseDto": { + "properties": { + "data": { + "additionalProperties": {}, + "description": "Job data payload", + "type": "object" }, "id": { - "description": "Person ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "description": "Job ID", "type": "string" }, - "isFavorite": { - "description": "Is favorite", - "type": "boolean", - "x-immich-history": [ - { - "version": "v1.126.0", - "state": "Added" - }, - { - "version": "v2", - "state": "Stable" - } - ], - "x-immich-state": "Stable" - }, - "isHidden": { - "description": "Is hidden", - "type": "boolean" - }, "name": { - "description": "Person name", - "type": "string" - }, - "thumbnailPath": { - "description": "Thumbnail path", - "type": "string" + "$ref": "#/components/schemas/JobName" }, - "updatedAt": { - "description": "Last update date", - "format": "date-time", - "type": "string", - "x-immich-history": [ - { - "version": "v1.107.0", - "state": "Added" - }, - { - "version": "v2", - "state": "Stable" - } - ], - "x-immich-state": "Stable" + "timestamp": { + "description": "Job creation timestamp", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" } }, "required": [ - "birthDate", - "id", - "isHidden", + "data", "name", - "thumbnailPath" + "timestamp" ], "type": "object" }, - "PersonStatisticsResponseDto": { + "QueueJobStatus": { + "description": "Queue job status", + "enum": [ + "active", + "failed", + "completed", + "delayed", + "waiting", + "paused" + ], + "type": "string" + }, + "QueueName": { + "description": "Queue name", + "enum": [ + "thumbnailGeneration", + "metadataExtraction", + "videoConversion", + "faceDetection", + "facialRecognition", + "smartSearch", + "duplicateDetection", + "backgroundTask", + "storageTemplateMigration", + "migration", + "search", + "sidecar", + "library", + "notifications", + "backupDatabase", + "ocr", + "workflow", + "integrityCheck", + "editor" + ], + "type": "string" + }, + "QueueResponseDto": { "properties": { - "assets": { - "description": "Number of assets", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "isPaused": { + "description": "Whether the queue is paused", + "type": "boolean" + }, + "name": { + "$ref": "#/components/schemas/QueueName" + }, + "statistics": { + "$ref": "#/components/schemas/QueueStatisticsDto" } }, "required": [ - "assets" + "isPaused", + "name", + "statistics" ], "type": "object" }, - "PersonUpdateDto": { + "QueueResponseLegacyDto": { "properties": { - "birthDate": { - "description": "Person date of birth", - "format": "date", - "nullable": true, - "type": "string" - }, - "color": { - "description": "Person color (hex)", - "nullable": true, - "pattern": "^#?([0-9A-Fa-f]{3}|[0-9A-Fa-f]{4}|[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", - "type": "string" - }, - "featureFaceAssetId": { - "description": "Asset ID used for feature face thumbnail", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "isFavorite": { - "description": "Mark as favorite", - "type": "boolean" - }, - "isHidden": { - "description": "Person visibility (hidden)", - "type": "boolean" + "jobCounts": { + "$ref": "#/components/schemas/QueueStatisticsDto" }, - "name": { - "description": "Person name", - "type": "string" + "queueStatus": { + "$ref": "#/components/schemas/QueueStatusLegacyDto" } }, + "required": [ + "jobCounts", + "queueStatus" + ], "type": "object" }, - "PinCodeChangeDto": { + "QueueStatisticsDto": { "properties": { - "newPinCode": { - "description": "New PIN code (4-6 digits)", - "pattern": "^\\d{6}$", - "type": "string" + "active": { + "description": "Number of active jobs", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "password": { - "description": "User password (required if PIN code is not provided)", - "example": "password", - "type": "string" + "completed": { + "description": "Number of completed jobs", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" }, - "pinCode": { - "description": "New PIN code (4-6 digits)", - "example": "123456", - "pattern": "^\\d{6}$", - "type": "string" + "delayed": { + "description": "Number of delayed jobs", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "failed": { + "description": "Number of failed jobs", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "paused": { + "description": "Number of paused jobs", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" + }, + "waiting": { + "description": "Number of waiting jobs", + "maximum": 9007199254740991, + "minimum": -9007199254740991, + "type": "integer" } }, "required": [ - "newPinCode" + "active", + "completed", + "delayed", + "failed", + "paused", + "waiting" ], "type": "object" }, - "PinCodeResetDto": { + "QueueStatusLegacyDto": { "properties": { - "password": { - "description": "User password (required if PIN code is not provided)", - "example": "password", - "type": "string" + "isActive": { + "description": "Whether the queue is currently active (has running jobs)", + "type": "boolean" }, - "pinCode": { - "description": "New PIN code (4-6 digits)", - "example": "123456", - "pattern": "^\\d{6}$", - "type": "string" + "isPaused": { + "description": "Whether the queue is paused", + "type": "boolean" } }, + "required": [ + "isActive", + "isPaused" + ], "type": "object" }, - "PinCodeSetupDto": { + "QueueUpdateDto": { "properties": { - "pinCode": { - "description": "PIN code (4-6 digits)", - "example": "123456", - "pattern": "^\\d{6}$", - "type": "string" + "isPaused": { + "description": "Whether to pause the queue", + "type": "boolean" } }, - "required": [ - "pinCode" - ], "type": "object" }, - "PlacesResponseDto": { + "QueuesResponseLegacyDto": { "properties": { - "admin1name": { - "description": "Administrative level 1 name (state/province)", - "type": "string" + "backgroundTask": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" }, - "admin2name": { - "description": "Administrative level 2 name (county/district)", - "type": "string" + "backupDatabase": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" }, - "latitude": { - "description": "Latitude coordinate", - "type": "number" + "duplicateDetection": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" }, - "longitude": { - "description": "Longitude coordinate", - "type": "number" + "editor": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" }, - "name": { - "description": "Place name", - "type": "string" + "faceDetection": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "facialRecognition": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "integrityCheck": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "library": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "metadataExtraction": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "migration": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "notifications": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "ocr": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "search": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "sidecar": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "smartSearch": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "storageTemplateMigration": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "thumbnailGeneration": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "videoConversion": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" + }, + "workflow": { + "$ref": "#/components/schemas/QueueResponseLegacyDto" } }, "required": [ - "latitude", - "longitude", - "name" + "backgroundTask", + "backupDatabase", + "duplicateDetection", + "editor", + "faceDetection", + "facialRecognition", + "integrityCheck", + "library", + "metadataExtraction", + "migration", + "notifications", + "ocr", + "search", + "sidecar", + "smartSearch", + "storageTemplateMigration", + "thumbnailGeneration", + "videoConversion", + "workflow" ], "type": "object" }, - "PluginMethodResponseDto": { + "RandomSearchDto": { "properties": { - "description": { - "description": "Description", + "albumIds": { + "description": "Filter by album IDs", + "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" + }, + "type": "array" + }, + "city": { + "description": "Filter by city name", + "nullable": true, "type": "string" }, - "hostFunctions": { + "country": { + "description": "Filter by country name", + "nullable": true, + "type": "string" + }, + "createdAfter": { + "description": "Filter by creation date (after)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "createdBefore": { + "description": "Filter by creation date (before)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" + }, + "isEncoded": { + "description": "Filter by encoded status", "type": "boolean" }, - "key": { - "description": "Key", + "isFavorite": { + "description": "Filter by favorite status", + "type": "boolean" + }, + "isMotion": { + "description": "Filter by motion photo status", + "type": "boolean" + }, + "isNotInAlbum": { + "description": "Filter assets not in any album", + "type": "boolean" + }, + "isOffline": { + "description": "Filter by offline status", + "type": "boolean" + }, + "lensModel": { + "description": "Filter by lens model", + "nullable": true, "type": "string" }, - "name": { - "description": "Name", + "libraryId": { + "description": "Library ID to filter by", + "format": "uuid", + "nullable": true, + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, - "schema": { - "properties": {}, - "type": "object" + "make": { + "description": "Filter by camera make", + "nullable": true, + "type": "string" }, - "title": { - "description": "Title", + "model": { + "description": "Filter by camera model", + "nullable": true, "type": "string" }, - "types": { - "description": "Workflow types", - "items": { - "$ref": "#/components/schemas/WorkflowType" - }, - "type": "array" + "ocr": { + "description": "Filter by OCR text content", + "type": "string" }, - "uiHints": { - "description": "Ui hints", + "personIds": { + "description": "Filter by person IDs", "items": { + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, "type": "array" - } - }, - "required": [ - "description", - "hostFunctions", - "key", - "name", - "title", - "types", - "uiHints" - ], - "type": "object" - }, - "PluginResponseDto": { - "properties": { - "author": { - "description": "Plugin author", - "type": "string" }, - "createdAt": { - "description": "Creation date", - "type": "string" + "rating": { + "description": "Filter by rating [1-5], or null for unrated", + "maximum": 5, + "minimum": 1, + "nullable": true, + "type": "integer", + "x-immich-history": [ + { + "version": "v1", + "state": "Added" + }, + { + "version": "v2", + "state": "Stable" + }, + { + "version": "v2.6.0", + "state": "Updated", + "description": "Using -1 as a rating is deprecated and will be removed in the next major version." + }, + { + "version": "v3", + "state": "Updated", + "description": "Using -1 as a rating is no longer valid." + } + ], + "x-immich-state": "Stable" }, - "description": { - "description": "Plugin description", - "type": "string" + "size": { + "description": "Number of results to return", + "maximum": 1000, + "minimum": 1, + "type": "integer" }, - "id": { - "description": "Plugin ID", - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "state": { + "description": "Filter by state/province name", + "nullable": true, "type": "string" }, - "methods": { - "description": "Plugin methods", + "tagIds": { + "description": "Filter by tag IDs", "items": { - "$ref": "#/components/schemas/PluginMethodResponseDto" + "format": "uuid", + "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "type": "string" }, + "nullable": true, "type": "array" }, - "name": { - "description": "Plugin name", + "takenAfter": { + "description": "Filter by taken date (after)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "title": { - "description": "Plugin title", + "takenBefore": { + "description": "Filter by taken date (before)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "updatedAt": { - "description": "Last update date", + "trashedAfter": { + "description": "Filter by trash date (after)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "version": { - "description": "Plugin version", - "type": "string" - } - }, - "required": [ - "author", - "createdAt", - "description", - "id", - "methods", - "name", - "title", - "updatedAt", - "version" - ], - "type": "object" - }, - "PluginTemplateResponseDto": { - "properties": { - "description": { - "description": "Template description", + "trashedBefore": { + "description": "Filter by trash date (before)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "key": { - "description": "Template key (unique across all templates)", - "type": "string" + "type": { + "$ref": "#/components/schemas/AssetTypeEnum" }, - "steps": { - "description": "Workflow steps", - "items": { - "$ref": "#/components/schemas/PluginTemplateStepResponseDto" - }, - "type": "array" + "updatedAfter": { + "description": "Filter by update date (after)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "type": "string" }, - "title": { - "description": "Template title", + "updatedBefore": { + "description": "Filter by update date (before)", + "example": "2024-01-01T00:00:00.000Z", + "format": "date-time", + "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "type": "string" }, - "trigger": { - "$ref": "#/components/schemas/WorkflowTrigger", - "description": "Workflow trigger" + "visibility": { + "$ref": "#/components/schemas/AssetVisibility" }, - "uiHints": { - "description": "Ui hints, for example \"smart-album\"", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "description", - "key", - "steps", - "title", - "trigger", - "uiHints" - ], - "type": "object" - }, - "PluginTemplateStepResponseDto": { - "properties": { - "config": { - "additionalProperties": {}, - "description": "Step configuration", - "nullable": true, - "type": "object" + "withDeleted": { + "description": "Include deleted assets", + "type": "boolean" }, - "enabled": { - "description": "Whether the step is enabled", + "withExif": { + "description": "Include EXIF data in response", "type": "boolean" }, - "method": { - "description": "Step plugin method", - "type": "string" + "withPeople": { + "description": "Include people data in response", + "type": "boolean" + }, + "withStacked": { + "description": "Include stacked assets", + "type": "boolean" } }, - "required": [ - "config", - "method" - ], "type": "object" }, - "PurchaseResponse": { + "RatingsResponse": { "properties": { - "hideBuyButtonUntil": { - "description": "Date until which to hide buy button", - "type": "string" - }, - "showSupportBadge": { - "description": "Whether to show support badge", + "enabled": { + "description": "Whether ratings are enabled", "type": "boolean" } }, "required": [ - "hideBuyButtonUntil", - "showSupportBadge" + "enabled" ], "type": "object" }, - "PurchaseUpdate": { + "RatingsUpdate": { "properties": { - "hideBuyButtonUntil": { - "description": "Date until which to hide buy button", - "type": "string" - }, - "showSupportBadge": { - "description": "Whether to show support badge", + "enabled": { + "description": "Whether ratings are enabled", "type": "boolean" } }, "type": "object" }, - "QueueCommand": { - "description": "Queue command to execute", + "ReactionLevel": { + "description": "Reaction level", "enum": [ - "start", - "pause", - "resume", - "empty", - "clear-failed" + "album", + "asset" ], "type": "string" }, - "QueueCommandDto": { + "ReactionType": { + "description": "Reaction type", + "enum": [ + "comment", + "like" + ], + "type": "string" + }, + "RecentlyAddedResponse": { "properties": { - "command": { - "$ref": "#/components/schemas/QueueCommand" - }, - "force": { - "description": "Force the command execution (if applicable)", + "sidebarWeb": { + "description": "Whether the recently added page appears in the web sidebar", "type": "boolean" } }, "required": [ - "command" + "sidebarWeb" ], "type": "object" }, - "QueueDeleteDto": { + "RecentlyAddedUpdate": { "properties": { - "failed": { - "description": "If true, will also remove failed jobs from the queue.", - "type": "boolean", - "x-immich-history": [ - { - "version": "v2.4.0", - "state": "Added" - }, - { - "version": "v2.4.0", - "state": "Alpha" - } - ], - "x-immich-state": "Alpha" + "sidebarWeb": { + "description": "Whether the recently added page appears in the web sidebar", + "type": "boolean" } }, "type": "object" }, - "QueueJobResponseDto": { + "ReleaseChannel": { + "description": "Release channel", + "enum": [ + "stable", + "releaseCandidate" + ], + "type": "string" + }, + "ReleaseEventV1": { "properties": { - "data": { - "additionalProperties": {}, - "description": "Job data payload", - "type": "object" - }, - "id": { - "description": "Job ID", + "checkedAt": { + "description": "When the server last checked for a latest version. As an ISO timestamp", "type": "string" }, - "name": { - "$ref": "#/components/schemas/JobName" + "isAvailable": { + "description": "Whether a new version is available", + "type": "boolean" + }, + "releaseVersion": { + "$ref": "#/components/schemas/ServerVersionResponseDto" }, - "timestamp": { - "description": "Job creation timestamp", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "serverVersion": { + "$ref": "#/components/schemas/ServerVersionResponseDto" + }, + "type": { + "$ref": "#/components/schemas/ReleaseType", + "description": "Release type", + "nullable": true } }, "required": [ - "data", - "name", - "timestamp" + "checkedAt", + "isAvailable", + "releaseVersion", + "serverVersion", + "type" ], "type": "object" }, - "QueueJobStatus": { - "description": "Queue job status", - "enum": [ - "active", - "failed", - "completed", - "delayed", - "waiting", - "paused" - ], - "type": "string" - }, - "QueueName": { - "description": "Queue name", + "ReleaseType": { "enum": [ - "thumbnailGeneration", - "metadataExtraction", - "videoConversion", - "faceDetection", - "facialRecognition", - "smartSearch", - "duplicateDetection", - "backgroundTask", - "storageTemplateMigration", - "migration", - "search", - "sidecar", - "library", - "notifications", - "backupDatabase", - "ocr", - "workflow", - "integrityCheck", - "editor" + "major", + "premajor", + "minor", + "preminor", + "patch", + "prepatch", + "prerelease" ], "type": "string" }, - "QueueResponseDto": { + "RepositoryBackendDto": { "properties": { - "isPaused": { - "description": "Whether the queue is paused", - "type": "boolean" + "id": { + "type": "string" }, - "name": { - "$ref": "#/components/schemas/QueueName" + "online": { + "type": "boolean" }, - "statistics": { - "$ref": "#/components/schemas/QueueStatisticsDto" + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/BackendType" + } + ] } }, "required": [ - "isPaused", - "name", - "statistics" + "id", + "online", + "type" ], "type": "object" }, - "QueueResponseLegacyDto": { + "RepositoryBackendsDto": { "properties": { - "jobCounts": { - "$ref": "#/components/schemas/QueueStatisticsDto" + "primary": { + "$ref": "#/components/schemas/RepositoryBackendDto" }, - "queueStatus": { - "$ref": "#/components/schemas/QueueStatusLegacyDto" + "secondary": { + "items": { + "$ref": "#/components/schemas/RepositoryBackendDto" + }, + "type": "array" } }, "required": [ - "jobCounts", - "queueStatus" + "primary", + "secondary" ], "type": "object" }, - "QueueStatisticsDto": { + "RepositoryCheckImportResponseDto": { "properties": { - "active": { - "description": "Number of active jobs", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "completed": { - "description": "Number of completed jobs", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "delayed": { - "description": "Number of delayed jobs", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "failed": { - "description": "Number of failed jobs", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "paused": { - "description": "Number of paused jobs", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" - }, - "waiting": { - "description": "Number of waiting jobs", - "maximum": 9007199254740991, - "minimum": -9007199254740991, - "type": "integer" + "readable": { + "type": "boolean" } }, "required": [ - "active", - "completed", - "delayed", - "failed", - "paused", - "waiting" + "readable" ], "type": "object" }, - "QueueStatusLegacyDto": { + "RepositoryConfigurationDto": { "properties": { - "isActive": { - "description": "Whether the queue is currently active (has running jobs)", - "type": "boolean" + "paths": { + "items": { + "type": "string" + }, + "type": "array" }, - "isPaused": { - "description": "Whether the queue is paused", - "type": "boolean" + "retentionPolicy": { + "allOf": [ + { + "$ref": "#/components/schemas/RetentionPolicyDto" + } + ], + "nullable": true, + "type": "object" } }, "required": [ - "isActive", - "isPaused" + "paths" ], "type": "object" }, - "QueueUpdateDto": { + "RepositoryCreateRequestDto": { "properties": { - "isPaused": { - "description": "Whether to pause the queue", + "name": { + "type": "string" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array" + }, + "site": { + "description": "Internal site code from environment metadata", + "type": "string" + }, + "worm": { "type": "boolean" } }, + "required": [ + "name", + "worm" + ], "type": "object" }, - "QueuesResponseLegacyDto": { + "RepositoryCreateResponseDto": { "properties": { - "backgroundTask": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "backupDatabase": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "duplicateDetection": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "editor": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "faceDetection": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "facialRecognition": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "integrityCheck": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "library": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "metadataExtraction": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "migration": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "notifications": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "ocr": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "search": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "sidecar": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "smartSearch": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "storageTemplateMigration": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "thumbnailGeneration": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "videoConversion": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" - }, - "workflow": { - "$ref": "#/components/schemas/QueueResponseLegacyDto" + "repository": { + "$ref": "#/components/schemas/LocalRepositoryDto" } }, "required": [ - "backgroundTask", - "backupDatabase", - "duplicateDetection", - "editor", - "faceDetection", - "facialRecognition", - "integrityCheck", - "library", - "metadataExtraction", - "migration", - "notifications", - "ocr", - "search", - "sidecar", - "smartSearch", - "storageTemplateMigration", - "thumbnailGeneration", - "videoConversion", - "workflow" + "repository" + ], + "type": "object" + }, + "RepositoryInspectResponseDto": { + "properties": { + "repositories": { + "items": { + "$ref": "#/components/schemas/InspectedLocalRepositoryDto" + }, + "type": "array" + } + }, + "required": [ + "repositories" ], "type": "object" }, - "RandomSearchDto": { + "RepositoryListResponseDto": { "properties": { - "albumIds": { - "description": "Filter by album IDs", + "repositories": { "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" + "$ref": "#/components/schemas/LocalRepositoryDto" }, "type": "array" - }, - "city": { - "description": "Filter by city name", - "nullable": true, - "type": "string" - }, - "country": { - "description": "Filter by country name", - "nullable": true, + } + }, + "required": [ + "repositories" + ], + "type": "object" + }, + "RepositoryMeterDto": { + "properties": { + "lastUpdated": { "type": "string" }, - "createdAfter": { - "description": "Filter by creation date (after)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", - "type": "string" + "objectCount": { + "type": "number" }, - "createdBefore": { - "description": "Filter by creation date (before)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "sizeBytes": { + "type": "number" + } + }, + "required": [ + "objectCount", + "sizeBytes" + ], + "type": "object" + }, + "RepositoryMetricsDto": { + "properties": { + "lastBackup": { "type": "string" }, - "isEncoded": { - "description": "Filter by encoded status", - "type": "boolean" - }, - "isFavorite": { - "description": "Filter by favorite status", - "type": "boolean" - }, - "isMotion": { - "description": "Filter by motion photo status", - "type": "boolean" - }, - "isNotInAlbum": { - "description": "Filter assets not in any album", - "type": "boolean" - }, - "isOffline": { - "description": "Filter by offline status", - "type": "boolean" + "lastBackupDuration": { + "type": "number" }, - "lensModel": { - "description": "Filter by lens model", - "nullable": true, + "lastSuccessfulBackup": { "type": "string" }, - "libraryId": { - "description": "Library ID to filter by", - "format": "uuid", - "nullable": true, - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", + "sizeBytes": { + "type": "number" + } + }, + "required": [ + "sizeBytes" + ], + "type": "object" + }, + "RepositoryPrimaryBackendReconfigureRequestDto": { + "properties": { + "backendId": { "type": "string" + } + }, + "required": [ + "backendId" + ], + "type": "object" + }, + "RepositorySnapshotRestoreFromPointRequestDto": { + "properties": { + "include": { + "items": { + "type": "string" + }, + "type": "array" }, - "make": { - "description": "Filter by camera make", - "nullable": true, + "yuccaConfig": { "type": "string" + } + }, + "type": "object" + }, + "RepositorySnapshotRestoreRequestDto": { + "properties": { + "include": { + "items": { + "type": "string" + }, + "type": "array" }, - "model": { - "description": "Filter by camera model", - "nullable": true, + "target": { "type": "string" - }, - "ocr": { - "description": "Filter by OCR text content", + } + }, + "type": "object" + }, + "RepositoryUpdateRequestDto": { + "properties": { + "name": { "type": "string" }, - "personIds": { - "description": "Filter by person IDs", + "paths": { "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", "type": "string" }, "type": "array" }, - "rating": { - "description": "Filter by rating [1-5], or null for unrated", - "maximum": 5, - "minimum": 1, - "nullable": true, - "type": "integer", - "x-immich-history": [ - { - "version": "v1", - "state": "Added" - }, - { - "version": "v2", - "state": "Stable" - }, - { - "version": "v2.6.0", - "state": "Updated", - "description": "Using -1 as a rating is deprecated and will be removed in the next major version." - }, + "retentionPolicy": { + "allOf": [ { - "version": "v3", - "state": "Updated", - "description": "Using -1 as a rating is no longer valid." + "$ref": "#/components/schemas/RetentionPolicyDto" } ], - "x-immich-state": "Stable" - }, - "size": { - "description": "Number of results to return", - "maximum": 1000, - "minimum": 1, - "type": "integer" - }, - "state": { - "description": "Filter by state/province name", "nullable": true, - "type": "string" + "type": "object" }, - "tagIds": { - "description": "Filter by tag IDs", - "items": { - "format": "uuid", - "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$", - "type": "string" - }, - "nullable": true, - "type": "array" + "worm": { + "type": "boolean" + } + }, + "type": "object" + }, + "RepositoryUpdateResponseDto": { + "properties": { + "repository": { + "$ref": "#/components/schemas/LocalRepositoryDto" + } + }, + "required": [ + "repository" + ], + "type": "object" + }, + "RetentionPolicyDto": { + "properties": { + "keepLast": { + "type": "number" }, - "takenAfter": { - "description": "Filter by taken date (after)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "keepWithin": { "type": "string" }, - "takenBefore": { - "description": "Filter by taken date (before)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "keepWithinDaily": { "type": "string" }, - "trashedAfter": { - "description": "Filter by trash date (after)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "keepWithinHourly": { "type": "string" }, - "trashedBefore": { - "description": "Filter by trash date (before)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "keepWithinMonthly": { "type": "string" }, - "type": { - "$ref": "#/components/schemas/AssetTypeEnum" + "keepWithinWeekly": { + "type": "string" }, - "updatedAfter": { - "description": "Filter by update date (after)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "keepWithinYearly": { + "type": "string" + } + }, + "type": "object" + }, + "ReverseGeocodingStateResponseDto": { + "properties": { + "lastImportFileName": { + "description": "Last import file name", + "nullable": true, "type": "string" }, - "updatedBefore": { - "description": "Filter by update date (before)", - "example": "2024-01-01T00:00:00.000Z", - "format": "date-time", - "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", + "lastUpdate": { + "description": "Last update timestamp", + "nullable": true, + "type": "string" + } + }, + "required": [ + "lastImportFileName", + "lastUpdate" + ], + "type": "object" + }, + "RotateParameters": { + "properties": { + "angle": { + "description": "Rotation angle in degrees", + "type": "number" + } + }, + "required": [ + "angle" + ], + "type": "object" + }, + "RunDto": { + "properties": { + "end": { "type": "string" }, - "visibility": { - "$ref": "#/components/schemas/AssetVisibility" + "id": { + "type": "string" }, - "withDeleted": { - "description": "Include deleted assets", - "type": "boolean" + "logFilePath": { + "type": "string" }, - "withExif": { - "description": "Include EXIF data in response", - "type": "boolean" + "repositoryId": { + "type": "string" }, - "withPeople": { - "description": "Include people data in response", - "type": "boolean" + "start": { + "type": "string" }, - "withStacked": { - "description": "Include stacked assets", - "type": "boolean" + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/RunStatus" + } + ] + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/RunType" + } + ] } }, + "required": [ + "end", + "id", + "logFilePath", + "repositoryId", + "start", + "status", + "type" + ], "type": "object" }, - "RatingsResponse": { + "RunHistoryResponseDto": { "properties": { - "enabled": { - "description": "Whether ratings are enabled", - "type": "boolean" + "runs": { + "items": { + "$ref": "#/components/schemas/RunDto" + }, + "type": "array" } }, "required": [ - "enabled" + "runs" ], "type": "object" }, - "RatingsUpdate": { + "RunResponseDto": { "properties": { - "enabled": { - "description": "Whether ratings are enabled", - "type": "boolean" + "run": { + "$ref": "#/components/schemas/RunDto" } }, + "required": [ + "run" + ], "type": "object" }, - "ReactionLevel": { - "description": "Reaction level", + "RunStatus": { "enum": [ - "album", - "asset" + "incomplete", + "complete", + "failed" ], "type": "string" }, - "ReactionType": { - "description": "Reaction type", + "RunType": { "enum": [ - "comment", - "like" + "schedule", + "restore", + "backup", + "forget" ], "type": "string" }, - "RecentlyAddedResponse": { + "RunningTaskDto": { "properties": { - "sidebarWeb": { - "description": "Whether the recently added page appears in the web sidebar", - "type": "boolean" + "logId": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "scheduleStatus": { + "items": { + "$ref": "#/components/schemas/ActiveScheduleItemDto" + }, + "type": "array" + }, + "type": { + "allOf": [ + { + "$ref": "#/components/schemas/TaskType" + } + ] } }, "required": [ - "sidebarWeb" + "parentId", + "type" ], "type": "object" }, - "RecentlyAddedUpdate": { + "RunningTaskListResponse": { "properties": { - "sidebarWeb": { - "description": "Whether the recently added page appears in the web sidebar", - "type": "boolean" + "tasks": { + "items": { + "$ref": "#/components/schemas/RunningTaskDto" + }, + "type": "array" } }, + "required": [ + "tasks" + ], "type": "object" }, - "ReleaseChannel": { - "description": "Release channel", - "enum": [ - "stable", - "releaseCandidate" + "ScheduleCreateRequestDto": { + "properties": { + "cron": { + "type": "string" + }, + "name": { + "type": "string" + }, + "repositories": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "cron", + "name", + "repositories" ], - "type": "string" + "type": "object" }, - "ReleaseEventV1": { + "ScheduleCreateResponseDto": { "properties": { - "checkedAt": { - "description": "When the server last checked for a latest version. As an ISO timestamp", + "schedule": { + "$ref": "#/components/schemas/ScheduleDto" + } + }, + "required": [ + "schedule" + ], + "type": "object" + }, + "ScheduleDto": { + "properties": { + "cron": { "type": "string" }, - "isAvailable": { - "description": "Whether a new version is available", - "type": "boolean" + "id": { + "type": "string" }, - "releaseVersion": { - "$ref": "#/components/schemas/ServerVersionResponseDto" + "lastFinished": { + "type": "string" }, - "serverVersion": { - "$ref": "#/components/schemas/ServerVersionResponseDto" + "lastRun": { + "type": "string" }, - "type": { - "$ref": "#/components/schemas/ReleaseType", - "description": "Release type", - "nullable": true + "name": { + "type": "string" + }, + "paused": { + "type": "boolean" + }, + "repositories": { + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ - "checkedAt", - "isAvailable", - "releaseVersion", - "serverVersion", - "type" + "cron", + "id", + "name", + "paused", + "repositories" ], "type": "object" }, - "ReleaseType": { - "enum": [ - "major", - "premajor", - "minor", - "preminor", - "patch", - "prepatch", - "prerelease" + "ScheduleListResponseDto": { + "properties": { + "schedules": { + "items": { + "$ref": "#/components/schemas/ScheduleDto" + }, + "type": "array" + } + }, + "required": [ + "schedules" ], - "type": "string" + "type": "object" }, - "ReverseGeocodingStateResponseDto": { + "ScheduleUpdateRequestDto": { "properties": { - "lastImportFileName": { - "description": "Last import file name", - "nullable": true, + "cron": { "type": "string" }, - "lastUpdate": { - "description": "Last update timestamp", - "nullable": true, + "name": { "type": "string" + }, + "paused": { + "type": "boolean" + }, + "repositories": { + "items": { + "type": "string" + }, + "type": "array" } }, - "required": [ - "lastImportFileName", - "lastUpdate" - ], "type": "object" }, - "RotateParameters": { + "ScheduleUpdateResponseDto": { "properties": { - "angle": { - "description": "Rotation angle in degrees", - "type": "number" + "schedule": { + "$ref": "#/components/schemas/ScheduleDto" } }, "required": [ - "angle" + "schedule" ], "type": "object" }, @@ -22557,6 +24703,10 @@ }, "ServerFeaturesDto": { "properties": { + "backups": { + "description": "Whether the backups feature is enabled", + "type": "boolean" + }, "configFile": { "description": "Whether config file is available", "type": "boolean" @@ -22623,6 +24773,7 @@ } }, "required": [ + "backups", "configFile", "duplicateDetection", "email", @@ -23018,6 +25169,14 @@ "restoreBackupFilename": { "description": "Restore backup filename", "type": "string" + }, + "rollbackRepositoryId": { + "description": "Rollback repository ID", + "type": "string" + }, + "rollbackSnapshotId": { + "description": "Rollback snapshot ID", + "type": "string" } }, "required": [ @@ -23516,6 +25675,68 @@ }, "type": "object" }, + "SnapshotDto": { + "properties": { + "id": { + "type": "string" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array" + }, + "summary": { + "$ref": "#/components/schemas/SnapshotSummaryDto" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "time": { + "type": "string" + } + }, + "required": [ + "id", + "paths", + "time" + ], + "type": "object" + }, + "SnapshotSummaryDto": { + "properties": { + "dataAdded": { + "type": "number" + }, + "filesChanged": { + "type": "number" + }, + "filesNew": { + "type": "number" + }, + "filesUnmodified": { + "type": "number" + }, + "totalBytes": { + "type": "number" + }, + "totalFiles": { + "type": "number" + } + }, + "required": [ + "dataAdded", + "filesChanged", + "filesNew", + "filesUnmodified", + "totalBytes", + "totalFiles" + ], + "type": "object" + }, "SourceType": { "description": "Face detection source type", "enum": [ @@ -25585,11 +27806,16 @@ }, "SystemConfigBackupsDto": { "properties": { + "beta": { + "description": "Whether the backups feature is enabled", + "type": "boolean" + }, "database": { "$ref": "#/components/schemas/DatabaseBackupConfig" } }, "required": [ + "beta", "database" ], "type": "object" @@ -26846,6 +29072,30 @@ }, "type": "object" }, + "TaskStatus": { + "enum": [ + "incomplete", + "complete", + "failed" + ], + "type": "string" + }, + "TaskType": { + "enum": [ + "schedule", + "restore", + "backup", + "forget" + ], + "type": "string" + }, + "TelemetryLevel": { + "enum": [ + "full", + "none" + ], + "type": "string" + }, "TemplateDto": { "properties": { "template": { diff --git a/packages/sdk/src/fetch-client.ts b/packages/sdk/src/fetch-client.ts index 3ac958ce2d962..a4de2d646c046 100644 --- a/packages/sdk/src/fetch-client.ts +++ b/packages/sdk/src/fetch-client.ts @@ -93,6 +93,10 @@ export type SetMaintenanceModeDto = { action: MaintenanceAction; /** Restore backup filename */ restoreBackupFilename?: string; + /** Rollback repository ID */ + rollbackRepositoryId?: string; + /** Rollback snapshot ID */ + rollbackSnapshotId?: string; }; export type MaintenanceDetectInstallStorageFolderDto = { /** Number of files in the folder */ @@ -120,6 +124,8 @@ export type MaintenanceStatusResponseDto = { error?: string; progress?: number; task?: string; + /** Yucca log ID */ + yuccaLogId?: string; }; export type NotificationCreateDto = { /** Additional notification data */ @@ -2019,6 +2025,8 @@ export type ServerConfigDto = { userDeleteDelay: number; }; export type ServerFeaturesDto = { + /** Whether the backups feature is enabled */ + backups: boolean; /** Whether config file is available */ configFile: boolean; /** Whether duplicate detection is enabled */ @@ -2297,6 +2305,8 @@ export type DatabaseBackupConfig = { keepLastAmount: number; }; export type SystemConfigBackupsDto = { + /** Whether the backups feature is enabled */ + beta: boolean; database: DatabaseBackupConfig; }; export type SystemConfigFFmpegRealtimeDto = { @@ -2848,6 +2858,255 @@ export type WorkflowShareResponseDto = { /** Workflow trigger type */ trigger: WorkflowTrigger; }; +export type DeviceFlowResponseDto = { + userCode: string; + verificationUri: string; +}; +export type BackendDto = { + description: string; + error?: string; + id: string; + isOnline: boolean; + "type": BackendType; +}; +export type BackendsResponseDto = { + backends: BackendDto[]; +}; +export type CreateLocalBackendRequestDto = { + path: string; +}; +export type BackendResponseDto = { + backend: BackendDto; +}; +export type FilesystemListingItemDto = { + isDirectory: boolean; + path: string; +}; +export type FilesystemListingResponseDto = { + items: FilesystemListingItemDto[]; + parent: string; + path: string; +}; +export type ImmichIntegrationConfigurationDto = { + backupConfiguration: boolean; + dataFolders: string[]; + libraries: "all" | string[]; +}; +export type ImmichIntegrationDto = { + configuration: ImmichIntegrationConfigurationDto; + id: string; + scheduleId: string; +}; +export type ImmichLibraryDto = { + exclusionPatterns: string[]; + id: string; + importPaths: string[]; + name: string; +}; +export type ImmichStateDto = { + dataFolders: string[]; + dataPath: string; + libraries: ImmichLibraryDto[]; +}; +export type IntegrationsResponseDto = { + immichIntegration?: ImmichIntegrationDto; + immichState?: ImmichStateDto; +}; +export type RetentionPolicyDto = { + keepLast?: number; + keepWithin?: string; + keepWithinDaily?: string; + keepWithinHourly?: string; + keepWithinMonthly?: string; + keepWithinWeekly?: string; + keepWithinYearly?: string; +}; +export type ConfigureImmichIntegrationRequestDto = { + backupConfiguration: boolean; + cron: string; + dataFolders: string[]; + libraries: "all" | string[]; + name: string; + retentionPolicy?: (RetentionPolicyDto) | null; + worm: boolean; +}; +export type ImmichRollbackRequestDto = { + backupFileName?: string; + repositoryId: string; + snapshotId: string; +}; +export type RunDto = { + end: string; + id: string; + logFilePath: string; + repositoryId: string; + start: string; + status: RunStatus; + "type": RunType; +}; +export type RunResponseDto = { + run: RunDto; +}; +export type OnboardingStatusResponseDto = { + error?: string; + hasBackend: boolean; + hasBackup: boolean; + hasOnboardedKey: boolean; + hasSchedule: boolean; + hasSkippedExtraConfig: boolean; + hasTelemetry: TelemetryLevel; + status: BootstrapStatus; +}; +export type CurrentRecoveryKeyResponse = { + recoveryKey: string; +}; +export type ImportRecoveryKeyRequest = { + recoveryKey: string; +}; +export type RepositoryBackendDto = { + id: string; + online: boolean; + "type": BackendType; +}; +export type RepositoryBackendsDto = { + primary: RepositoryBackendDto; + secondary: RepositoryBackendDto[]; +}; +export type RepositoryConfigurationDto = { + paths: string[]; + retentionPolicy?: (RetentionPolicyDto) | null; +}; +export type RepositoryMeterDto = { + lastUpdated?: string; + objectCount: number; + sizeBytes: number; +}; +export type RepositoryMetricsDto = { + lastBackup?: string; + lastBackupDuration?: number; + lastSuccessfulBackup?: string; + sizeBytes: number; +}; +export type LocalRepositoryDto = { + backends?: RepositoryBackendsDto; + configuration?: RepositoryConfigurationDto; + id: string; + meter?: RepositoryMeterDto; + metrics: RepositoryMetricsDto; + name: string; + worm: boolean; +}; +export type RepositoryListResponseDto = { + repositories: LocalRepositoryDto[]; +}; +export type RepositoryCreateRequestDto = { + name: string; + paths?: string[]; + worm: boolean; +}; +export type RepositoryCreateResponseDto = { + repository: LocalRepositoryDto; +}; +export type SnapshotSummaryDto = { + dataAdded: number; + filesChanged: number; + filesNew: number; + filesUnmodified: number; + totalBytes: number; + totalFiles: number; +}; +export type SnapshotDto = { + id: string; + paths: string[]; + summary?: SnapshotSummaryDto; + time: string; +}; +export type InspectedLocalRepositoryDto = { + backends?: RepositoryBackendsDto; + configuration?: RepositoryConfigurationDto; + id: string; + meter?: RepositoryMeterDto; + metrics: RepositoryMetricsDto; + name: string; + snapshots: SnapshotDto[]; + worm: boolean; +}; +export type RepositoryInspectResponseDto = { + repositories: InspectedLocalRepositoryDto[]; +}; +export type RepositoryUpdateRequestDto = { + name?: string; + paths?: string[]; + retentionPolicy?: (RetentionPolicyDto) | null; +}; +export type RepositoryUpdateResponseDto = { + repository: LocalRepositoryDto; +}; +export type LogResponseDto = { + logId: string; +}; +export type RepositoryPrimaryBackendReconfigureRequestDto = { + backendId: string; +}; +export type RepositoryCheckImportResponseDto = { + readable: boolean; +}; +export type RunHistoryResponseDto = { + runs: RunDto[]; +}; +export type ListSnapshotsResponseDto = { + snapshots: SnapshotDto[]; +}; +export type RepositorySnapshotRestoreRequestDto = { + include?: string[]; + target?: string; +}; +export type RepositorySnapshotRestoreFromPointRequestDto = { + include?: string[]; + yuccaConfig?: string; +}; +export type ScheduleDto = { + cron: string; + id: string; + lastFinished?: string; + lastRun?: string; + name: string; + paused: boolean; + repositories: string[]; +}; +export type ScheduleListResponseDto = { + schedules: ScheduleDto[]; +}; +export type ScheduleCreateRequestDto = { + cron: string; + name: string; + repositories: string[]; +}; +export type ScheduleCreateResponseDto = { + schedule: ScheduleDto; +}; +export type ScheduleUpdateRequestDto = { + cron?: string; + name?: string; + paused?: boolean; + repositories?: string[]; +}; +export type ScheduleUpdateResponseDto = { + schedule: ScheduleDto; +}; +export type ActiveScheduleItemDto = { + repositoryId: string; + status: TaskStatus; +}; +export type RunningTaskDto = { + logId?: string; + parentId: string; + scheduleStatus?: ActiveScheduleItemDto[]; + "type": TaskType; +}; +export type RunningTaskListResponse = { + tasks: RunningTaskDto[]; +}; export type LicenseResponseDto = UserLicense; export type ReleaseEventV1 = { /** When the server last checked for a latest version. As an ISO timestamp */ @@ -7076,6 +7335,399 @@ export function getWorkflowForShare({ id }: { ...opts })); } +export function oidcDeviceFlow(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: DeviceFlowResponseDto; + }>("/yucca/auth/oidc/device", { + ...opts + })); +} +export function getBackends(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: BackendsResponseDto; + }>("/yucca/backend", { + ...opts + })); +} +export function createLocalBackend({ createLocalBackendRequestDto }: { + createLocalBackendRequestDto: CreateLocalBackendRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: BackendResponseDto; + }>("/yucca/backend/local", oazapfts.json({ + ...opts, + method: "POST", + body: createLocalBackendRequestDto + }))); +} +export function resetOrchestrator(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/debug/reset", { + ...opts, + method: "POST" + })); +} +export function getFileListing({ path }: { + path?: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: FilesystemListingResponseDto; + }>(`/yucca/fs${QS.query(QS.explode({ + path + }))}`, { + ...opts + })); +} +export function getIntegrations(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: IntegrationsResponseDto; + }>("/yucca/integrations", { + ...opts + })); +} +export function configureImmichIntegration({ configureImmichIntegrationRequestDto }: { + configureImmichIntegrationRequestDto: ConfigureImmichIntegrationRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/integrations/immich", oazapfts.json({ + ...opts, + method: "POST", + body: configureImmichIntegrationRequestDto + }))); +} +export function startImmichRollback({ immichRollbackRequestDto }: { + immichRollbackRequestDto: ImmichRollbackRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/integrations/immich/rollback", oazapfts.json({ + ...opts, + method: "POST", + body: immichRollbackRequestDto + }))); +} +export function getRun({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RunResponseDto; + }>(`/yucca/logs/${encodeURIComponent(id)}`, { + ...opts + })); +} +export function logStreamSse({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText(`/yucca/logs/${encodeURIComponent(id)}/stream`, { + ...opts + })); +} +export function onboardingStatus(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: OnboardingStatusResponseDto; + }>("/yucca/onboarding", { + ...opts + })); +} +export function currentRecoveryKey(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: CurrentRecoveryKeyResponse; + }>("/yucca/onboarding/recovery-key", { + ...opts + })); +} +export function confirmRecoveryKey(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/onboarding/recovery-key", { + ...opts, + method: "POST" + })); +} +export function importRecoveryKey({ importRecoveryKeyRequest }: { + importRecoveryKeyRequest: ImportRecoveryKeyRequest; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/onboarding/recovery-key", oazapfts.json({ + ...opts, + method: "PUT", + body: importRecoveryKeyRequest + }))); +} +export function reportError(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/onboarding/report-error", { + ...opts, + method: "POST" + })); +} +export function skipOnboardingExtraConfig(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/onboarding/skip", { + ...opts, + method: "POST" + })); +} +export function enableTelemetry(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText("/yucca/onboarding/telemetry", { + ...opts, + method: "POST" + })); +} +export function getRepositories(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RepositoryListResponseDto; + }>("/yucca/repository", { + ...opts + })); +} +export function createRepository({ backend, repositoryCreateRequestDto }: { + backend?: string; + repositoryCreateRequestDto: RepositoryCreateRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RepositoryCreateResponseDto; + }>(`/yucca/repository${QS.query(QS.explode({ + backend + }))}`, oazapfts.json({ + ...opts, + method: "POST", + body: repositoryCreateRequestDto + }))); +} +export function inspectRepositories({ backend }: { + backend?: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RepositoryInspectResponseDto; + }>(`/yucca/repository/inspect${QS.query(QS.explode({ + backend + }))}`, { + ...opts + })); +} +export function deleteRepository({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText(`/yucca/repository/${encodeURIComponent(id)}`, { + ...opts, + method: "DELETE" + })); +} +export function updateRepository({ backend, id, repositoryUpdateRequestDto }: { + backend?: string; + id: string; + repositoryUpdateRequestDto: RepositoryUpdateRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RepositoryUpdateResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}${QS.query(QS.explode({ + backend + }))}`, oazapfts.json({ + ...opts, + method: "PATCH", + body: repositoryUpdateRequestDto + }))); +} +export function createBackup({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: LogResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}`, { + ...opts, + method: "POST" + })); +} +export function reconfigureRepositoryPrimaryBackend({ id, repositoryPrimaryBackendReconfigureRequestDto }: { + id: string; + repositoryPrimaryBackendReconfigureRequestDto: RepositoryPrimaryBackendReconfigureRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RepositoryCreateResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/backend`, oazapfts.json({ + ...opts, + method: "PUT", + body: repositoryPrimaryBackendReconfigureRequestDto + }))); +} +export function checkImportRepository({ backend, id }: { + backend: string; + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RepositoryCheckImportResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/import${QS.query(QS.explode({ + backend + }))}`, { + ...opts + })); +} +export function importRepository({ backend, id }: { + backend: string; + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RepositoryCreateResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/import${QS.query(QS.explode({ + backend + }))}`, { + ...opts, + method: "POST" + })); +} +export function getRunHistory({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RunHistoryResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/runs`, { + ...opts + })); +} +export function getSnapshots({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: ListSnapshotsResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/snapshots`, { + ...opts + })); +} +export function pruneRepository({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: LogResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/snapshots/prune`, { + ...opts, + method: "POST" + })); +} +export function forgetSnapshot({ id, snapshot }: { + id: string; + snapshot: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: ListSnapshotsResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}`, { + ...opts, + method: "DELETE" + })); +} +export function restoreSnapshot({ id, snapshot, repositorySnapshotRestoreRequestDto }: { + id: string; + snapshot: string; + repositorySnapshotRestoreRequestDto: RepositorySnapshotRestoreRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: LogResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}`, oazapfts.json({ + ...opts, + method: "POST", + body: repositorySnapshotRestoreRequestDto + }))); +} +export function getSnapshotListing({ id, path, snapshot }: { + id: string; + path?: string; + snapshot: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: FilesystemListingResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}/listing${QS.query(QS.explode({ + path + }))}`, { + ...opts + })); +} +export function restoreFromPoint({ backend, id, snapshot, repositorySnapshotRestoreFromPointRequestDto }: { + backend: string; + id: string; + snapshot: string; + repositorySnapshotRestoreFromPointRequestDto: RepositorySnapshotRestoreFromPointRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: LogResponseDto; + }>(`/yucca/repository/${encodeURIComponent(id)}/snapshots/${encodeURIComponent(snapshot)}/restore-from-point${QS.query(QS.explode({ + backend + }))}`, oazapfts.json({ + ...opts, + method: "POST", + body: repositorySnapshotRestoreFromPointRequestDto + }))); +} +export function getSchedules(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: ScheduleListResponseDto; + }>("/yucca/schedule", { + ...opts + })); +} +export function createSchedule({ scheduleCreateRequestDto }: { + scheduleCreateRequestDto: ScheduleCreateRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: ScheduleCreateResponseDto; + }>("/yucca/schedule", oazapfts.json({ + ...opts, + method: "POST", + body: scheduleCreateRequestDto + }))); +} +export function removeSchedule({ id }: { + id: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText(`/yucca/schedule/${encodeURIComponent(id)}`, { + ...opts, + method: "DELETE" + })); +} +export function updateSchedule({ id, scheduleUpdateRequestDto }: { + id: string; + scheduleUpdateRequestDto: ScheduleUpdateRequestDto; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: ScheduleUpdateResponseDto; + }>(`/yucca/schedule/${encodeURIComponent(id)}`, oazapfts.json({ + ...opts, + method: "PATCH", + body: scheduleUpdateRequestDto + }))); +} +export function getRunningTasks(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: RunningTaskListResponse; + }>("/yucca/tasks", { + ...opts + })); +} +export function cancelTask({ parentId }: { + parentId: string; +}, opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchText(`/yucca/tasks/${encodeURIComponent(parentId)}/cancel`, { + ...opts, + method: "POST" + })); +} export enum ReactionLevel { Album = "album", Asset = "asset" @@ -7105,7 +7757,8 @@ export enum MaintenanceAction { Start = "start", End = "end", SelectDatabaseRestore = "select_database_restore", - RestoreDatabase = "restore_database" + RestoreDatabase = "restore_database", + Rollback = "rollback" } export enum StorageFolder { EncodedVideo = "encoded-video", @@ -7686,6 +8339,42 @@ export enum AssetOrderBy { TakenAt = "takenAt", CreatedAt = "createdAt" } +export enum BackendType { + Yucca = "yucca", + Local = "local", + S3 = "s3" +} +export enum RunStatus { + Incomplete = "incomplete", + Complete = "complete", + Failed = "failed" +} +export enum RunType { + Schedule = "schedule", + Restore = "restore", + Backup = "backup", + Forget = "forget" +} +export enum TelemetryLevel { + Full = "full", + None = "none" +} +export enum BootstrapStatus { + NotReady = "not-ready", + Ready = "ready", + Error = "error" +} +export enum TaskStatus { + Incomplete = "incomplete", + Complete = "complete", + Failed = "failed" +} +export enum TaskType { + Schedule = "schedule", + Restore = "restore", + Backup = "backup", + Forget = "forget" +} export enum ReleaseType { Major = "major", Premajor = "premajor", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 1e147c2502b8e..630a95b283576 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -111,6 +111,9 @@ importers: '@faker-js/faker': specifier: ^10.1.0 version: 10.5.0 + '@futo-org/backups-orchestrator-ui': + specifier: 0.30.0 + version: 0.30.0(@sveltejs/kit@2.70.2(@opentelemetry/api@1.9.1)(@sveltejs/vite-plugin-svelte@7.2.0(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(@typescript/typescript6@6.0.2)(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(supports-color@8.1.1)(svelte@5.56.8(@typescript-eslint/types@8.66.0)) '@immich/cli': specifier: workspace:* version: link:../packages/cli @@ -400,6 +403,9 @@ importers: '@extism/extism': specifier: 2.0.0-rc13 version: 2.0.0-rc13 + '@futo-org/backups-orchestrator-api': + specifier: 0.30.0 + version: 0.30.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(@nestjs/schedule@6.1.3(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28))(@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2))(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(supports-color@8.1.1) '@immich/plugin-sdk': specifier: workspace:* version: link:../packages/plugin-sdk @@ -408,28 +414,28 @@ importers: version: 0.5.2 '@nestjs/bullmq': specifier: ^11.0.1 - version: 11.0.4(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(bullmq@5.81.3(supports-color@8.1.1)) + version: 11.0.4(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(bullmq@5.81.3(supports-color@8.1.1)) '@nestjs/common': specifier: ^11.0.4 - version: 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + version: 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) '@nestjs/core': specifier: ^11.0.4 - version: 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + version: 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) '@nestjs/platform-express': specifier: ^11.0.4 - version: 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1) + version: 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1) '@nestjs/platform-socket.io': specifier: ^11.0.4 - version: 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/websockets@11.1.28)(rxjs@7.8.2)(supports-color@8.1.1) + version: 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/websockets@11.1.28)(rxjs@7.8.2)(supports-color@8.1.1) '@nestjs/schedule': specifier: ^6.0.0 - version: 6.1.3(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) + version: 6.1.3(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) '@nestjs/swagger': specifier: ^11.4.2 - version: 11.4.6(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(reflect-metadata@0.2.2) + version: 11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2) '@nestjs/websockets': specifier: ^11.0.4 - version: 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + version: 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) '@opentelemetry/api': specifier: ^1.9.0 version: 1.9.1 @@ -561,19 +567,19 @@ importers: version: 2.2.0 nest-commander: specifier: ^3.16.0 - version: 3.20.1(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@types/inquirer@8.2.13)(@types/node@24.13.3)(@typescript/typescript6@6.0.2) + version: 3.20.1(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@types/inquirer@8.2.13)(@types/node@24.13.3)(@typescript/typescript6@6.0.2) nestjs-cls: specifier: ^6.0.0 - version: 6.2.1(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + version: 6.2.1(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) nestjs-kysely: specifier: 3.1.2 - version: 3.1.2(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(kysely@0.28.17)(reflect-metadata@0.2.2) + version: 3.1.2(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(kysely@0.28.17)(reflect-metadata@0.2.2) nestjs-otel: specifier: ^8.0.0 - version: 8.1.0(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(rxjs@7.8.2) + version: 8.1.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(rxjs@7.8.2) nestjs-zod: specifier: ^5.3.0 - version: 5.5.0(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(reflect-metadata@0.2.2))(rxjs@7.8.2)(zod@4.3.6) + version: 5.5.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2))(rxjs@7.8.2)(zod@4.3.6) nodemailer: specifier: ^9.0.0 version: 9.0.4 @@ -643,7 +649,7 @@ importers: devDependencies: '@eslint/js': specifier: ^10.0.0 - version: 10.0.1(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)) + version: 10.0.1(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)) '@nestjs/cli': specifier: ^11.0.2 version: 11.0.24(@swc/core@1.15.47(@swc/helpers@0.5.23))(@types/node@24.13.3)(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.26))(csso@5.0.5)(esbuild@0.28.2)(html-minifier-terser@7.2.0)(lightningcss@1.33.0)(postcss@8.5.26)(prettier@3.9.6)(uglify-js@3.19.3) @@ -652,7 +658,7 @@ importers: version: 11.1.0(@typescript/typescript6@6.0.2)(chokidar@4.0.3)(prettier@3.9.6) '@nestjs/testing': specifier: ^11.0.4 - version: 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-express@11.1.28) + version: 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-express@11.1.28) '@swc/core': specifier: ^1.4.14 version: 1.15.47(@swc/helpers@0.5.23) @@ -730,19 +736,19 @@ importers: version: typescript@7.0.2 '@vitest/coverage-v8': specifier: ^4.0.0 - version: 4.1.10(vitest@3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@2.7.0)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)) + version: 4.1.10(vitest@3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@1.21.7)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)) eslint: specifier: ^10.0.0 - version: 10.8.0(jiti@2.7.0)(supports-color@8.1.1) + version: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) eslint-config-prettier: specifier: ^10.1.8 - version: 10.1.8(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)) + version: 10.1.8(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)) eslint-plugin-prettier: specifier: ^5.1.3 - version: 5.5.6(@types/eslint@9.6.1)(eslint-config-prettier@10.1.8(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)))(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(prettier@3.9.6) + version: 5.5.6(@types/eslint@9.6.1)(eslint-config-prettier@10.1.8(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)))(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(prettier@3.9.6) eslint-plugin-unicorn: specifier: ^72.0.0 - version: 72.0.0(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)) + version: 72.0.0(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)) globals: specifier: ^17.0.0 version: 17.9.0 @@ -775,7 +781,7 @@ importers: version: '@typescript/typescript6@6.0.2' typescript-eslint: specifier: ^8.28.0 - version: 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1) + version: 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) unplugin-swc: specifier: ^1.4.5 version: 1.5.10(@swc/core@1.15.47(@swc/helpers@0.5.23))(rollup@4.62.0) @@ -784,13 +790,16 @@ importers: version: 6.1.1(@typescript/typescript6@6.0.2)(supports-color@8.1.1)(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)) vitest: specifier: ^3.0.0 - version: 3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@2.7.0)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) + version: 3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@1.21.7)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) web: dependencies: '@formatjs/icu-messageformat-parser': specifier: ^3.0.0 version: 3.5.16 + '@futo-org/backups-orchestrator-ui': + specifier: 0.30.0 + version: 0.30.0(@sveltejs/kit@2.70.2(@opentelemetry/api@1.9.1)(@sveltejs/vite-plugin-svelte@7.2.0(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(@typescript/typescript6@6.0.2)(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(supports-color@8.1.1)(svelte@5.56.8(@typescript-eslint/types@8.66.0)) '@immich/justified-layout-wasm': specifier: ^0.4.3 version: 0.4.3 @@ -2892,6 +2901,28 @@ packages: resolution: {integrity: sha512-v0BLa0eqg7ubvVWeNSHVBs8fWH/GJicERZoJaxJ3FE/lj67VSqzoMg9pzfZVOfLMX10y0pGwQAuxoRVVH2patg==} engines: {node: '>=6'} + '@futo-org/backups-api-client@0.30.0': + resolution: {integrity: sha512-9Mt9dKsaaXFTQ6Xo9FikWl4oVBzC/SH4K3hNiK5eM6+03szyld9plN/XOxwgsgEbcOaAw3mmAjfFmYnvGXf+Ug==} + + '@futo-org/backups-orchestrator-api@0.30.0': + resolution: {integrity: sha512-cC1QnPn1D8+Q+Kq6hQl+9f+Fe3KBQoMCffIyxAK0jDd6X8tYzX9smcXQVBHb9bm3EzWUx9jyA0XozTJlKa9KWg==} + peerDependencies: + '@nestjs/common': ^11.0.0 + '@nestjs/core': ^11.0.0 + '@nestjs/platform-socket.io': ^11.0.0 + '@nestjs/schedule': ^6.0.0 + '@nestjs/swagger': ^11.0.0 + '@nestjs/websockets': ^11.0.0 + + '@futo-org/backups-orchestrator-ui@0.30.0': + resolution: {integrity: sha512-6oevjA0Iei2aOEeHOuymMTi1xd59pgzyc61pW7OVMLb0PIDqWzq03a4ljHzPRrPTmR0o2qOq/E5oSChrthUVdw==} + peerDependencies: + svelte: ^5.0.0 + + '@futo-org/restic-wrapper@1.3.1': + resolution: {integrity: sha512-+KymwHIMb83RBCZLWGbMLrWtY4c0oU5sIbjK3Lg1TswS2ZLYsk1UmycQ+Xco7V4RconLRAymnaHlcXQsjZlMdw==} + engines: {node: '>=20'} + '@golevelup/nestjs-discovery@5.0.0': resolution: {integrity: sha512-NaIWLCLI+XvneUK05LH2idHLmLNITYT88YnpOuUQmllKtiJNIS3woSt7QXrMZ5k3qUWuZpehEVz1JtlX4I1KyA==} peerDependencies: @@ -3631,6 +3662,12 @@ packages: '@nestjs/websockets': optional: true + '@nestjs/event-emitter@3.1.0': + resolution: {integrity: sha512-DOY/4XBGyIjYyOJKkO6jl1kzFE0ZfX0wV+M2HR5NWymPT9Z0zdCEcZGxTXXkoMRwPtglnvCGJALSjOpXPIcM3g==} + peerDependencies: + '@nestjs/common': ^10.0.0 || ^11.0.0 + '@nestjs/core': ^10.0.0 || ^11.0.0 + '@nestjs/mapped-types@2.1.1': resolution: {integrity: sha512-SCCoMEJ6jdeI5h/N+KCVF1+pmg/hmEkNA5nHTS8Gvww7T/LCl4o1gFLinw2iQ60w7slFkszHcGLKGdazVI4F8A==} peerDependencies: @@ -4974,6 +5011,14 @@ packages: peerDependencies: vite: ^5.2.0 || ^6 || ^7 || ^8 + '@tanstack/query-core@5.100.9': + resolution: {integrity: sha512-SJSFw1S8+kQ0+knv/XGfrbocWoAlT7vDKsSImtLx3ZPQmEcR46hkDjLSvynSy25N8Ms4tIEini1FuBd5k7IscQ==} + + '@tanstack/svelte-query@6.1.28': + resolution: {integrity: sha512-B4uh/fvn+t67LyWzY8Sb+yqyxJS2hc27Nwf+bfz7vy+ilzfJIHORoCm9/6Arsg4pdH8DCBMLMWZTvMgvSUd/pg==} + peerDependencies: + svelte: ^5.25.0 + '@testing-library/dom@10.4.1': resolution: {integrity: sha512-o4PXJQidqJl82ckFaXUeoAW+XysPLauYI43Abki5hABd853iMhitooc6znOnczgbTYmEP6U6/y1ZyKAIsvMKGg==} engines: {node: '>=18'} @@ -6177,6 +6222,10 @@ packages: resolution: {integrity: sha512-cU8v/EGSrnH+HnxV2z0J7/blxH8gq7Xh2JFT6Aroax7UohdmiJJlxApMxtKfuI7z68NvvVcmR78k2LbT6efhRg==} engines: {node: '>= 18'} + better-sqlite3@12.9.0: + resolution: {integrity: sha512-wqUv4Gm3toFpHDQmaKD4QhZm3g1DjUBI0yzS4UBl6lElUmXFYdTQmmEDpAFa5o8FiFiymURypEnfVHzILKaxqQ==} + engines: {node: 20.x || 22.x || 23.x || 24.x || 25.x} + big.js@5.2.2: resolution: {integrity: sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==} @@ -6184,6 +6233,9 @@ packages: resolution: {integrity: sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==} engines: {node: '>=8'} + bindings@1.5.0: + resolution: {integrity: sha512-p2q/t/mhvuOj/UeLlV6566GD/guowlr0hHxClI0W9m7MWYkL1F0hLo+0Aexs9HSPCtR1SXQ0TD3MMKrXZajbiQ==} + bits-ui@2.18.1: resolution: {integrity: sha512-KkemzKFH4T3gt3H+P86JcnAWExjByv/6vlwjm/BoCwTPHu03yiCdxbghdJLvFReQTe0acCAiRcKfmixxD6XvlA==} engines: {node: '>=20'} @@ -6460,6 +6512,12 @@ packages: cjs-module-lexer@2.2.0: resolution: {integrity: sha512-4bHTS2YuzUvtoLjdy+98ykbNB5jS0+07EvFNXerqZQJ89F7DI6ET7OQo/HJuW6K0aVsKA9hj9/RVb2kQVOrPDQ==} + class-transformer@0.5.1: + resolution: {integrity: sha512-SQa1Ws6hUbfC98vKGxZH3KFY0Y1lm5Zm0SY8XX9zbK7FJCyVEac3ATW0RIpwzW+oOfmHE5PMPufDG9hCfoEOMw==} + + class-validator@0.14.4: + resolution: {integrity: sha512-AwNusCCam51q703dW82x95tOqQp6oC9HNUl724KxJJOfnKscI8dOloXFgyez7LbTTKWuRBA37FScqVbJEoq8Yw==} + clean-css@5.3.3: resolution: {integrity: sha512-D5J+kHaVb/wKSFcyyV75uCn8fiY4sV38XJoe4CUyGQ+mOU/fMVYUdH1hJC+CJQ5uY3EnW27SbJYS4X8BiLrAFg==} engines: {node: '>= 10.0'} @@ -6789,10 +6847,17 @@ packages: engines: {node: '>=12.0.0'} deprecated: v4 is no longer maintained, upgrade to v5 + cron-validate@1.5.3: + resolution: {integrity: sha512-jcu8g/3wZL8OBr4MkEcbeIdLpM8pp5Y6UoOlRktcJG3WjgpifijR0s26Yac7ywR0gC2ABtevOsz5mlD3l3gzwA==} + cron@4.4.0: resolution: {integrity: sha512-fkdfq+b+AHI4cKdhZlppHveI/mgz2qpiYxcm+t5E5TsxX7QrLS1VE0+7GENEk9z0EeGPcpSciGv6ez24duWhwQ==} engines: {node: '>=18.x'} + cronstrue@3.14.0: + resolution: {integrity: sha512-XnW4vuK/jPJjmTyDWiej1Zq36Od7ITwxaV2O1pzHZuyMVvdy7NAvyvIBzybt+idqSpfqYuoDG7uf/ocGtJVWxA==} + hasBin: true + cross-spawn@7.0.6: resolution: {integrity: sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==} engines: {node: '>= 8'} @@ -7716,10 +7781,16 @@ packages: event-emitter@0.3.5: resolution: {integrity: sha512-D9rRn9y7kLPnJ+hMq7S/nhvoKwwvVJahBi2BPmx3bvbsEdK3W9ii8cBSGjP+72/LnM4n6fo3+dkCX5FeTQruXA==} + event-iterator@2.0.0: + resolution: {integrity: sha512-KGft0ldl31BZVV//jj+IAIGCxkvvUkkON+ScH6zfoX+l+omX6001ggyRSpI0Io2Hlro0ThXotswCtfzS8UkIiQ==} + event-target-shim@5.0.1: resolution: {integrity: sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==} engines: {node: '>=6'} + eventemitter2@6.4.9: + resolution: {integrity: sha512-JEPTiaOt9f04oa6NOkc4aH+nVp5I3wEjpHbIPqfgCdD5v5bUzy7xQqwcVO2aDQgOWhI28da57HksMrzK9HlRxg==} + eventemitter3@4.0.7: resolution: {integrity: sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==} @@ -7730,6 +7801,14 @@ packages: resolution: {integrity: sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==} engines: {node: '>=0.8.x'} + eventsource-client@1.2.0: + resolution: {integrity: sha512-kDI75RSzO3TwyG/K9w1ap8XwqSPcwi6jaMkNulfVeZmSeUM49U8kUzk1s+vKNt0tGrXgK47i+620Yasn1ccFiw==} + engines: {node: '>=18.0.0'} + + eventsource-parser@3.0.6: + resolution: {integrity: sha512-Vo1ab+QXPzZ4tCa8SwIHJFaSzy4R6SHf7BY79rFBDf0idraZWAkYrDjDj8uWaSm3S2TK+hJ7/t1CEmZ7jXw+pg==} + engines: {node: '>=18.0.0'} + execa@5.1.1: resolution: {integrity: sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==} engines: {node: '>=10'} @@ -7856,6 +7935,9 @@ packages: resolution: {integrity: sha512-Ievi/yy8DS3ygGvT47PjSfdFoX+2isQueoYP1cntFW1JLYAuS4GD7NUPGg4zv2iZfV52uDyk5w5Z0TdpRS6Q1g==} engines: {node: '>=20'} + file-uri-to-path@1.0.0: + resolution: {integrity: sha512-0Zt+s3L7Vf1biwWZ29aARiVYLx7iMGnEUl9x33fbB/j3jR81u/O2LbqK+Bm1CDSNDKVtJ/YjwY7TUd5SkeLQLw==} + fill-range@7.1.1: resolution: {integrity: sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==} engines: {node: '>=8'} @@ -8918,6 +9000,10 @@ packages: resolution: {integrity: sha512-nbD8lB9EB3wNdMhOCdx5Li8DxnLbvKByylRLcJ1h+4SkrowVeECAyZlyiKMThF7xFdRz0jSQ2MoJr+wXux2y0Q==} engines: {node: '>=20.0.0'} + kysely@0.28.2: + resolution: {integrity: sha512-4YAVLoF0Sf0UTqlhgQMFU9iQECdah7n+13ANkiuVfRvlK+uI0Etbgd7bVP36dKlG+NXWbhGua8vnGt+sdhvT7A==} + engines: {node: '>=18.0.0'} + latest-version@7.0.0: resolution: {integrity: sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==} engines: {node: '>=14.16'} @@ -8946,6 +9032,9 @@ packages: resolution: {integrity: sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==} engines: {node: '>= 0.8.0'} + libphonenumber-js@1.12.43: + resolution: {integrity: sha512-5n+HnmkNpgZCfaNVxrTGZHr6Lhv3gd0UtbD5lrzun3T2YNyVvCuJz9vkap2E0YWZWU1XF+0XljYAkrAJBbwbrg==} + lightningcss-android-arm64@1.32.0: resolution: {integrity: sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg==} engines: {node: '>= 12.0.0'} @@ -10887,6 +10976,9 @@ packages: resolution: {integrity: sha512-WPn+h9RGEExOKdu4bsF4HksG/uzd3cFq3MFtq8PsFeExPse5Ha/VOjQNyHhjboBFwGXGev6muJYTSPAOkROq2g==} engines: {node: '>=18'} + property-expr@2.0.6: + resolution: {integrity: sha512-SVtmxhRE/CGkn3eZY1T6pC8Nln6Fr/lu1mKSgRud0eC73whjGfoAogbn78LkD8aFL0zz3bAFerKSnOl7NlErBA==} + property-information@5.6.0: resolution: {integrity: sha512-YUHSPk+A30YPv+0Qf8i9Mbfe/C0hdPXk1s1jPVToV8pk8BQtpw10ct89Eo7OWkutrwqvT0eicAxlOg3dOAu8JA==} @@ -11893,6 +11985,10 @@ packages: resolution: {integrity: sha512-yEFYrVhod+hdNyx7g5Bnkkb0G6si8HJurOoOEgC8B/O0uXLHlaey/65KRv6cuWBNhBgHKAROVpc7QyYqE5gFng==} engines: {node: '>=20'} + tail@2.2.6: + resolution: {integrity: sha512-IQ6G4wK/t8VBauYiGPLx+d3fA5XjSVagjWV5SIYzvEvglbQjwEcukeYI68JOPpdydjxhZ9sIgzRlSmwSpphHyw==} + engines: {node: '>= 6.0.0'} + tailwind-csstree@0.3.3: resolution: {integrity: sha512-je9J5UYRsTJqAjYrIBMMlge8T/rreRd44pJxgG5Zx/zeo4kAC/liUKqzztRZrGlYRJLvIf2Cb1DVJMTXSzEShA==} engines: {node: '>=18.18'} @@ -12063,6 +12159,9 @@ packages: resolution: {integrity: sha512-wFH7+SEAcKfJpfLPkrgMPvvwnEtj8W4IurvEyrKsDleXnKLCDw71w8jltvfLa8Rm4qQxxT4jmDBYbJG/z7qoww==} engines: {node: '>=0.12'} + tiny-case@1.0.3: + resolution: {integrity: sha512-Eet/eeMhkO6TX8mnUteS9zgPbUMQa4I6Kkp5ORiBD5476/m+PIRiumP5tmh5ioJpH7k51Kehawy2UDfsnxxY8Q==} + tiny-glob@0.2.9: resolution: {integrity: sha512-g/55ssRPUjShh+xkfx9UPDXqhckHEsHr4Vd9zX55oSdGZc/MD0m3sferOkwWtp98bv+kcVfEHtRJgBVJzelrzg==} @@ -12131,6 +12230,9 @@ packages: resolution: {integrity: sha512-dRXchy+C0IgK8WPC6xvCHFRIWYUbqqdEIKPaKo/AcTUNzwLTK6AH7RjdLWsEZcAN/TBdtfUw3PYEgPr5VPr6ww==} engines: {node: '>=14.16'} + toposort@2.0.2: + resolution: {integrity: sha512-0a5EOkAUp8D4moMi2W8ZF8jcga7BgZd91O/yabJCFY8az+XSzeGyTKs0Aoo897iV1Nj6guFq8orWDS96z91oGg==} + totalist@3.0.1: resolution: {integrity: sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==} engines: {node: '>=6'} @@ -13029,6 +13131,9 @@ packages: resolution: {integrity: sha512-CzhO+pFNo8ajLM2d2IW/R93ipy99LWjtwblvC1RsoSUMZgyLbYFr221TnSNT7GjGdYui6P459mw9JH/g/zW2ug==} engines: {node: '>=18'} + yup@1.7.1: + resolution: {integrity: sha512-GKHFX2nXul2/4Dtfxhozv701jLQHdf6J34YDh2cEkpqoo8le5Mg6/LrdseVLrFarmFygZTlfIhHx/QKfb/QWXw==} + zimmerframe@1.1.4: resolution: {integrity: sha512-B58NGBEoc8Y9MWWCQGl/gq9xBCe4IiKM0a2x7GZdQKOW5Exr8S1W24J6OgM1njK8xCRGvAJIL/MxXHf6SkmQKQ==} @@ -15601,6 +15706,11 @@ snapshots: '@esbuild/win32-x64@0.28.2': optional: true + '@eslint-community/eslint-utils@4.10.1(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))': + dependencies: + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + eslint-visitor-keys: 3.4.3 + '@eslint-community/eslint-utils@4.10.1(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))': dependencies: eslint: 10.8.0(jiti@2.7.0)(supports-color@8.1.1) @@ -15629,6 +15739,10 @@ snapshots: mdn-data: 2.29.0 source-map-js: 1.2.1 + '@eslint/js@10.0.1(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))': + optionalDependencies: + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + '@eslint/js@10.0.1(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))': optionalDependencies: eslint: 10.8.0(jiti@2.7.0)(supports-color@8.1.1) @@ -15708,10 +15822,68 @@ snapshots: dependencies: '@fortawesome/fontawesome-common-types': 7.3.1 - '@golevelup/nestjs-discovery@5.0.0(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)': + '@futo-org/backups-api-client@0.30.0': + dependencies: + '@oazapfts/runtime': 1.2.0 + + '@futo-org/backups-orchestrator-api@0.30.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(@nestjs/schedule@6.1.3(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28))(@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2))(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(supports-color@8.1.1)': + dependencies: + '@futo-org/backups-api-client': 0.30.0 + '@futo-org/restic-wrapper': 1.3.1 + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/event-emitter': 3.1.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) + '@nestjs/platform-socket.io': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/websockets@11.1.28)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/schedule': 6.1.3(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) + '@nestjs/swagger': 11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2) + '@nestjs/websockets': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + better-sqlite3: 12.9.0 + class-validator: 0.14.4 + cookie: 1.1.1 + cron: 4.4.0 + event-iterator: 2.0.0 + eventsource-client: 1.2.0 + express: 5.2.1(supports-color@8.1.1) + kysely: 0.28.2 + nestjs-kysely: 3.1.2(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(kysely@0.28.2)(reflect-metadata@0.2.2) + openid-client: 6.8.4 + rxjs: 7.8.2 + socket.io: 4.8.3(supports-color@8.1.1) + tail: 2.2.6 + zod: 4.3.6 + transitivePeerDependencies: + - bufferutil + - reflect-metadata + - supports-color + - utf-8-validate + + '@futo-org/backups-orchestrator-ui@0.30.0(@sveltejs/kit@2.70.2(@opentelemetry/api@1.9.1)(@sveltejs/vite-plugin-svelte@7.2.0(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(@typescript/typescript6@6.0.2)(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(supports-color@8.1.1)(svelte@5.56.8(@typescript-eslint/types@8.66.0))': + dependencies: + '@futo-org/backups-api-client': 0.30.0 + '@immich/ui': 0.85.0(@sveltejs/kit@2.70.2(@opentelemetry/api@1.9.1)(@sveltejs/vite-plugin-svelte@7.2.0(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(@typescript/typescript6@6.0.2)(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(svelte@5.56.8(@typescript-eslint/types@8.66.0)) + '@mdi/js': 7.4.47 + '@oazapfts/runtime': 1.2.0 + '@tanstack/svelte-query': 6.1.28(svelte@5.56.8(@typescript-eslint/types@8.66.0)) + cron-validate: 1.5.3 + cronstrue: 3.14.0 + lodash.debounce: 4.0.8 + luxon: 3.7.2 + socket.io-client: 4.8.3(supports-color@8.1.1) + svelte: 5.56.8(@typescript-eslint/types@8.66.0) + transitivePeerDependencies: + - '@sveltejs/kit' + - bufferutil + - supports-color + - utf-8-validate + + '@futo-org/restic-wrapper@1.3.1': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + zod: 4.3.6 + + '@golevelup/nestjs-discovery@5.0.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)': + dependencies: + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) lodash: 4.18.1 '@grpc/grpc-js@1.14.4': @@ -16404,17 +16576,17 @@ snapshots: '@namnode/store@0.1.0': {} - '@nestjs/bull-shared@11.0.4(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)': + '@nestjs/bull-shared@11.0.4(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) tslib: 2.8.1 - '@nestjs/bullmq@11.0.4(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(bullmq@5.81.3(supports-color@8.1.1))': + '@nestjs/bullmq@11.0.4(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(bullmq@5.81.3(supports-color@8.1.1))': dependencies: - '@nestjs/bull-shared': 11.0.4(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/bull-shared': 11.0.4(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) bullmq: 5.81.3(supports-color@8.1.1) tslib: 2.8.1 @@ -16456,7 +16628,7 @@ snapshots: - uglify-js - webpack-cli - '@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1)': + '@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1)': dependencies: file-type: 21.3.4(supports-color@8.1.1) iterare: 1.2.1 @@ -16465,12 +16637,15 @@ snapshots: rxjs: 7.8.2 tslib: 2.8.1 uid: 2.0.2 + optionalDependencies: + class-transformer: 0.5.1 + class-validator: 0.14.4 transitivePeerDependencies: - supports-color - '@nestjs/core@11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2)': + '@nestjs/core@11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) fast-safe-stringify: 2.1.1 iterare: 1.2.1 path-to-regexp: 8.4.2 @@ -16479,18 +16654,27 @@ snapshots: tslib: 2.8.1 uid: 2.0.2 optionalDependencies: - '@nestjs/platform-express': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1) - '@nestjs/websockets': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/platform-express': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1) + '@nestjs/websockets': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) - '@nestjs/mapped-types@2.1.1(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(reflect-metadata@0.2.2)': + '@nestjs/event-emitter@3.1.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + eventemitter2: 6.4.9 + + '@nestjs/mapped-types@2.1.1(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)': + dependencies: + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) reflect-metadata: 0.2.2 + optionalDependencies: + class-transformer: 0.5.1 + class-validator: 0.14.4 - '@nestjs/platform-express@11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1)': + '@nestjs/platform-express@11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) cors: 2.8.6 express: 5.2.1(supports-color@8.1.1) multer: 2.2.0 @@ -16499,10 +16683,10 @@ snapshots: transitivePeerDependencies: - supports-color - '@nestjs/platform-socket.io@11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/websockets@11.1.28)(rxjs@7.8.2)(supports-color@8.1.1)': + '@nestjs/platform-socket.io@11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/websockets@11.1.28)(rxjs@7.8.2)(supports-color@8.1.1)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/websockets': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/websockets': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) rxjs: 7.8.2 socket.io: 4.8.3(supports-color@8.1.1) tslib: 2.8.1 @@ -16511,10 +16695,10 @@ snapshots: - supports-color - utf-8-validate - '@nestjs/schedule@6.1.3(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)': + '@nestjs/schedule@6.1.3(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) cron: 4.4.0 '@nestjs/schematics@11.1.0(@typescript/typescript6@6.0.2)(chokidar@4.0.3)(prettier@3.9.6)': @@ -16543,38 +16727,41 @@ snapshots: transitivePeerDependencies: - chokidar - '@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(reflect-metadata@0.2.2)': + '@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)': dependencies: '@microsoft/tsdoc': 0.16.0 - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) - '@nestjs/mapped-types': 2.1.1(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(reflect-metadata@0.2.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/mapped-types': 2.1.1(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2) js-yaml: 5.2.1 lodash: 4.18.1 path-to-regexp: 8.4.2 reflect-metadata: 0.2.2 swagger-ui-dist: 5.32.8 typescript: '@typescript/typescript6@6.0.2' + optionalDependencies: + class-transformer: 0.5.1 + class-validator: 0.14.4 - '@nestjs/testing@11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-express@11.1.28)': + '@nestjs/testing@11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-express@11.1.28)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) tslib: 2.8.1 optionalDependencies: - '@nestjs/platform-express': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1) + '@nestjs/platform-express': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(supports-color@8.1.1) - '@nestjs/websockets@11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2)': + '@nestjs/websockets@11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@nestjs/platform-socket.io@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2)': dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) iterare: 1.2.1 object-hash: 3.0.0 reflect-metadata: 0.2.2 rxjs: 7.8.2 tslib: 2.8.1 optionalDependencies: - '@nestjs/platform-socket.io': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/websockets@11.1.28)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/platform-socket.io': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/websockets@11.1.28)(rxjs@7.8.2)(supports-color@8.1.1) '@noble/hashes@1.4.0': {} @@ -17706,6 +17893,13 @@ snapshots: tailwindcss: 4.3.3 vite: 8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) + '@tanstack/query-core@5.100.9': {} + + '@tanstack/svelte-query@6.1.28(svelte@5.56.8(@typescript-eslint/types@8.66.0))': + dependencies: + '@tanstack/query-core': 5.100.9 + svelte: 5.56.8(@typescript-eslint/types@8.66.0) + '@testing-library/dom@10.4.1': dependencies: '@babel/code-frame': 7.29.7 @@ -18333,6 +18527,22 @@ snapshots: dependencies: '@types/yargs-parser': 21.0.3 + '@typescript-eslint/eslint-plugin@8.66.0(@typescript-eslint/parser@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1))(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1)': + dependencies: + '@eslint-community/regexpp': 4.12.2 + '@typescript-eslint/parser': 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) + '@typescript-eslint/scope-manager': 8.66.0 + '@typescript-eslint/type-utils': 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) + '@typescript-eslint/utils': 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) + '@typescript-eslint/visitor-keys': 8.66.0 + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + ignore: 7.0.6 + natural-compare: 1.4.0 + ts-api-utils: 2.5.0(@typescript/typescript6@6.0.2) + typescript: '@typescript/typescript6@6.0.2' + transitivePeerDependencies: + - supports-color + '@typescript-eslint/eslint-plugin@8.66.0(@typescript-eslint/parser@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1))(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1)': dependencies: '@eslint-community/regexpp': 4.12.2 @@ -18349,6 +18559,18 @@ snapshots: transitivePeerDependencies: - supports-color + '@typescript-eslint/parser@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1)': + dependencies: + '@typescript-eslint/scope-manager': 8.66.0 + '@typescript-eslint/types': 8.66.0 + '@typescript-eslint/typescript-estree': 8.66.0(@typescript/typescript6@6.0.2)(supports-color@8.1.1) + '@typescript-eslint/visitor-keys': 8.66.0 + debug: 4.4.3(supports-color@8.1.1) + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + typescript: '@typescript/typescript6@6.0.2' + transitivePeerDependencies: + - supports-color + '@typescript-eslint/parser@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1)': dependencies: '@typescript-eslint/scope-manager': 8.66.0 @@ -18379,6 +18601,18 @@ snapshots: dependencies: typescript: '@typescript/typescript6@6.0.2' + '@typescript-eslint/type-utils@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1)': + dependencies: + '@typescript-eslint/types': 8.66.0 + '@typescript-eslint/typescript-estree': 8.66.0(@typescript/typescript6@6.0.2)(supports-color@8.1.1) + '@typescript-eslint/utils': 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) + debug: 4.4.3(supports-color@8.1.1) + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + ts-api-utils: 2.5.0(@typescript/typescript6@6.0.2) + typescript: '@typescript/typescript6@6.0.2' + transitivePeerDependencies: + - supports-color + '@typescript-eslint/type-utils@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1)': dependencies: '@typescript-eslint/types': 8.66.0 @@ -18408,6 +18642,17 @@ snapshots: transitivePeerDependencies: - supports-color + '@typescript-eslint/utils@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1)': + dependencies: + '@eslint-community/eslint-utils': 4.10.1(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)) + '@typescript-eslint/scope-manager': 8.66.0 + '@typescript-eslint/types': 8.66.0 + '@typescript-eslint/typescript-estree': 8.66.0(@typescript/typescript6@6.0.2)(supports-color@8.1.1) + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + typescript: '@typescript/typescript6@6.0.2' + transitivePeerDependencies: + - supports-color + '@typescript-eslint/utils@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1)': dependencies: '@eslint-community/eslint-utils': 4.10.1(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)) @@ -18499,7 +18744,7 @@ snapshots: dependencies: valibot: 1.4.2(@typescript/typescript6@6.0.2) - '@vitest/coverage-v8@4.1.10(vitest@3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@2.7.0)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0))': + '@vitest/coverage-v8@4.1.10(vitest@3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@1.21.7)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0))': dependencies: '@bcoe/v8-coverage': 1.0.2 '@vitest/utils': 4.1.10 @@ -18511,7 +18756,7 @@ snapshots: obug: 2.1.3 std-env: 4.2.0 tinyrainbow: 3.1.0 - vitest: 3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@2.7.0)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) + vitest: 3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@1.21.7)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) '@vitest/coverage-v8@4.1.10(vitest@4.1.10)': dependencies: @@ -18544,13 +18789,13 @@ snapshots: chai: 6.2.2 tinyrainbow: 3.1.0 - '@vitest/mocker@3.2.7(vite@7.3.6(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0))': + '@vitest/mocker@3.2.7(vite@7.3.6(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0))': dependencies: '@vitest/spy': 3.2.7 estree-walker: 3.0.3 magic-string: 0.30.21 optionalDependencies: - vite: 7.3.6(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) + vite: 7.3.6(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) '@vitest/mocker@4.1.10(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0))': dependencies: @@ -19059,10 +19304,19 @@ snapshots: node-gyp: 13.0.0 node-gyp-build: 4.8.4 + better-sqlite3@12.9.0: + dependencies: + bindings: 1.5.0 + prebuild-install: 7.1.3 + big.js@5.2.2: {} binary-extensions@2.3.0: {} + bindings@1.5.0: + dependencies: + file-uri-to-path: 1.0.0 + bits-ui@2.18.1(@internationalized/date@3.12.2)(@sveltejs/kit@2.70.2(@opentelemetry/api@1.9.1)(@sveltejs/vite-plugin-svelte@7.2.0(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(@typescript/typescript6@6.0.2)(svelte@5.56.8(@typescript-eslint/types@8.66.0))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)))(svelte@5.56.8(@typescript-eslint/types@8.66.0)): dependencies: '@floating-ui/core': 1.8.0 @@ -19376,6 +19630,15 @@ snapshots: cjs-module-lexer@2.2.0: {} + class-transformer@0.5.1: + optional: true + + class-validator@0.14.4: + dependencies: + '@types/validator': 13.15.10 + libphonenumber-js: 1.12.43 + validator: 13.15.35 + clean-css@5.3.3: dependencies: source-map: 0.6.1 @@ -19683,11 +19946,17 @@ snapshots: dependencies: luxon: 3.7.2 + cron-validate@1.5.3: + dependencies: + yup: 1.7.1 + cron@4.4.0: dependencies: '@types/luxon': 3.7.3 luxon: 3.7.2 + cronstrue@3.14.0: {} + cross-spawn@7.0.6: dependencies: path-key: 3.1.1 @@ -20546,6 +20815,10 @@ snapshots: escape-string-regexp@5.0.0: {} + eslint-config-prettier@10.1.8(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)): + dependencies: + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + eslint-config-prettier@10.1.8(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)): dependencies: eslint: 10.8.0(jiti@2.7.0)(supports-color@8.1.1) @@ -20578,6 +20851,16 @@ snapshots: lodash.memoize: 4.1.2 semver: 7.8.5 + eslint-plugin-prettier@5.5.6(@types/eslint@9.6.1)(eslint-config-prettier@10.1.8(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)))(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(prettier@3.9.6): + dependencies: + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + prettier: 3.9.6 + prettier-linter-helpers: 1.0.1 + synckit: 0.11.13 + optionalDependencies: + '@types/eslint': 9.6.1 + eslint-config-prettier: 10.1.8(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)) + eslint-plugin-prettier@5.5.6(@types/eslint@9.6.1)(eslint-config-prettier@10.1.8(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)))(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(prettier@3.9.6): dependencies: eslint: 10.8.0(jiti@2.7.0)(supports-color@8.1.1) @@ -20606,6 +20889,30 @@ snapshots: transitivePeerDependencies: - ts-node + eslint-plugin-unicorn@72.0.0(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)): + dependencies: + '@eslint-community/eslint-utils': 4.10.1(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)) + '@eslint/css-tree': 4.0.5 + browserslist: 4.28.6 + change-case: 5.4.4 + ci-info: 4.4.0 + core-js-compat: 3.49.0 + detect-indent: 7.0.2 + entities: 4.5.0 + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + find-up-simple: 1.0.1 + globals: 17.9.0 + indent-string: 5.0.0 + is-builtin-module: 5.0.0 + is-identifier: 1.1.0 + pluralize: 8.0.0 + quote-js-string: 0.1.0 + regjsparser: 0.13.2 + reserved-identifiers: 1.2.0 + semver: 7.8.5 + strip-indent: 4.1.1 + yaml: 2.9.0 + eslint-plugin-unicorn@72.0.0(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)): dependencies: '@eslint-community/eslint-utils': 4.10.1(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)) @@ -20653,6 +20960,43 @@ snapshots: eslint-visitor-keys@5.0.1: {} + eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1): + dependencies: + '@eslint-community/eslint-utils': 4.10.1(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1)) + '@eslint-community/regexpp': 4.12.2 + '@eslint/config-array': 0.23.5(supports-color@8.1.1) + '@eslint/config-helpers': 0.7.0 + '@eslint/core': 1.2.1 + '@eslint/plugin-kit': 0.7.2 + '@humanfs/node': 0.16.8 + '@humanwhocodes/module-importer': 1.0.1 + '@humanwhocodes/retry': 0.4.3 + '@types/estree': 1.0.9 + ajv: 6.15.0 + cross-spawn: 7.0.6 + debug: 4.4.3(supports-color@8.1.1) + escape-string-regexp: 4.0.0 + eslint-scope: 9.1.2 + eslint-visitor-keys: 5.0.1 + espree: 11.2.0 + esquery: 1.7.0 + esutils: 2.0.3 + fast-deep-equal: 3.1.3 + file-entry-cache: 8.0.0 + find-up: 5.0.0 + glob-parent: 6.0.2 + ignore: 5.3.2 + imurmurhash: 0.1.4 + is-glob: 4.0.3 + json-stable-stringify-without-jsonify: 1.0.1 + minimatch: 10.2.6 + natural-compare: 1.4.0 + optionator: 0.9.4 + optionalDependencies: + jiti: 1.21.7 + transitivePeerDependencies: + - supports-color + eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1): dependencies: '@eslint-community/eslint-utils': 4.10.1(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1)) @@ -20788,8 +21132,12 @@ snapshots: d: 1.0.2 es5-ext: 0.10.64 + event-iterator@2.0.0: {} + event-target-shim@5.0.1: {} + eventemitter2@6.4.9: {} + eventemitter3@4.0.7: {} events-universal@1.0.1: @@ -20800,6 +21148,12 @@ snapshots: events@3.3.0: {} + eventsource-client@1.2.0: + dependencies: + eventsource-parser: 3.0.6 + + eventsource-parser@3.0.6: {} + execa@5.1.1: dependencies: cross-spawn: 7.0.6 @@ -20828,8 +21182,7 @@ snapshots: optionalDependencies: exiftool-vendored.exe: 13.59.0 - expand-template@2.0.3: - optional: true + expand-template@2.0.3: {} expect-type@1.4.0: {} @@ -20999,6 +21352,8 @@ snapshots: transitivePeerDependencies: - supports-color + file-uri-to-path@1.0.0: {} + fill-range@7.1.1: dependencies: to-regex-range: 5.0.1 @@ -21215,8 +21570,7 @@ snapshots: dependencies: resolve-pkg-maps: 1.0.0 - github-from-package@0.0.0: - optional: true + github-from-package@0.0.0: {} github-slugger@1.5.0: {} @@ -22235,6 +22589,8 @@ snapshots: kysely@0.28.17: {} + kysely@0.28.2: {} + latest-version@7.0.0: dependencies: package-json: 8.1.1 @@ -22261,6 +22617,8 @@ snapshots: prelude-ls: 1.2.1 type-check: 0.4.0 + libphonenumber-js@1.12.43: {} + lightningcss-android-arm64@1.32.0: optional: true @@ -23272,8 +23630,7 @@ snapshots: nanoid@6.0.1: {} - napi-build-utils@2.0.0: - optional: true + napi-build-utils@2.0.0: {} natural-compare-lite@1.4.0: {} @@ -23294,12 +23651,12 @@ snapshots: neo-async@2.6.2: {} - nest-commander@3.20.1(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@types/inquirer@8.2.13)(@types/node@24.13.3)(@typescript/typescript6@6.0.2): + nest-commander@3.20.1(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@types/inquirer@8.2.13)(@types/node@24.13.3)(@typescript/typescript6@6.0.2): dependencies: '@fig/complete-commander': 3.2.0(commander@11.1.0) - '@golevelup/nestjs-discovery': 5.0.0(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@golevelup/nestjs-discovery': 5.0.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) '@types/inquirer': 8.2.13 commander: 11.1.0 cosmiconfig: 8.3.6(@typescript/typescript6@6.0.2) @@ -23308,38 +23665,46 @@ snapshots: - '@types/node' - typescript - nestjs-cls@6.2.1(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2): + nestjs-cls@6.2.1(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2): dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) reflect-metadata: 0.2.2 rxjs: 7.8.2 - nestjs-kysely@3.1.2(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(kysely@0.28.17)(reflect-metadata@0.2.2): + nestjs-kysely@3.1.2(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(kysely@0.28.17)(reflect-metadata@0.2.2): dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) kysely: 0.28.17 reflect-metadata: 0.2.2 tslib: 2.8.1 - nestjs-otel@8.1.0(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(rxjs@7.8.2): + nestjs-kysely@3.1.2(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(kysely@0.28.2)(reflect-metadata@0.2.2): dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) - '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) + kysely: 0.28.2 + reflect-metadata: 0.2.2 + tslib: 2.8.1 + + nestjs-otel@8.1.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(rxjs@7.8.2): + dependencies: + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/core': 11.1.28(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/platform-express@11.1.28)(@nestjs/websockets@11.1.28)(reflect-metadata@0.2.2)(rxjs@7.8.2) '@opentelemetry/api': 1.9.1 '@opentelemetry/host-metrics': 0.38.3(@opentelemetry/api@1.9.1) rxjs: 7.8.2 tslib: 2.8.1 - nestjs-zod@5.5.0(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(reflect-metadata@0.2.2))(rxjs@7.8.2)(zod@4.3.6): + nestjs-zod@5.5.0(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/swagger@11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2))(rxjs@7.8.2)(zod@4.3.6): dependencies: - '@nestjs/common': 11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) + '@nestjs/common': 11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1) deepmerge: 4.3.1 rxjs: 7.8.2 zod: 4.3.6 optionalDependencies: - '@nestjs/swagger': 11.4.6(@nestjs/common@11.1.28(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(reflect-metadata@0.2.2) + '@nestjs/swagger': 11.4.6(@nestjs/common@11.1.28(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2)(rxjs@7.8.2)(supports-color@8.1.1))(@nestjs/core@11.1.28)(@typescript/typescript6@6.0.2)(class-transformer@0.5.1)(class-validator@0.14.4)(reflect-metadata@0.2.2) next-tick@1.1.0: {} @@ -23351,7 +23716,6 @@ snapshots: node-abi@3.92.0: dependencies: semver: 7.8.5 - optional: true node-abort-controller@3.1.1: {} @@ -24366,7 +24730,6 @@ snapshots: simple-get: 4.0.1 tar-fs: 2.1.5 tunnel-agent: 0.6.0 - optional: true prelude-ls@1.2.1: {} @@ -24441,6 +24804,8 @@ snapshots: transitivePeerDependencies: - supports-color + property-expr@2.0.6: {} + property-information@5.6.0: dependencies: xtend: 4.0.2 @@ -25283,15 +25648,13 @@ snapshots: signal-exit@4.1.0: {} - simple-concat@1.0.1: - optional: true + simple-concat@1.0.1: {} simple-get@4.0.1: dependencies: decompress-response: 6.0.0 once: 1.4.0 simple-concat: 1.0.1 - optional: true simple-icons@16.28.0: {} @@ -25775,6 +26138,8 @@ snapshots: tagged-tag@1.0.0: {} + tail@2.2.6: {} + tailwind-csstree@0.3.3: {} tailwind-merge@3.6.0: {} @@ -25995,6 +26360,8 @@ snapshots: es5-ext: 0.10.64 next-tick: 1.1.0 + tiny-case@1.0.3: {} + tiny-glob@0.2.9: dependencies: globalyzer: 0.1.0 @@ -26052,6 +26419,8 @@ snapshots: '@tokenizer/token': 0.3.0 ieee754: 1.2.1 + toposort@2.0.2: {} + totalist@3.0.1: {} tough-cookie@5.1.2: @@ -26136,7 +26505,6 @@ snapshots: tunnel-agent@0.6.0: dependencies: safe-buffer: 5.2.1 - optional: true tweetnacl@0.14.5: {} @@ -26175,6 +26543,17 @@ snapshots: typedarray@0.0.6: {} + typescript-eslint@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1): + dependencies: + '@typescript-eslint/eslint-plugin': 8.66.0(@typescript-eslint/parser@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1))(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) + '@typescript-eslint/parser': 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) + '@typescript-eslint/typescript-estree': 8.66.0(@typescript/typescript6@6.0.2)(supports-color@8.1.1) + '@typescript-eslint/utils': 8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@1.21.7)(supports-color@8.1.1))(supports-color@8.1.1) + eslint: 10.8.0(jiti@1.21.7)(supports-color@8.1.1) + typescript: '@typescript/typescript6@6.0.2' + transitivePeerDependencies: + - supports-color + typescript-eslint@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1): dependencies: '@typescript-eslint/eslint-plugin': 8.66.0(@typescript-eslint/parser@8.66.0(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1))(@typescript/typescript6@6.0.2)(eslint@10.8.0(jiti@2.7.0)(supports-color@8.1.1))(supports-color@8.1.1) @@ -26463,13 +26842,13 @@ snapshots: transitivePeerDependencies: - rollup - vite-node@3.2.4(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0): + vite-node@3.2.4(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0): dependencies: cac: 6.7.14 debug: 4.4.3(supports-color@8.1.1) es-module-lexer: 1.7.0 pathe: 2.0.3 - vite: 7.3.6(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) + vite: 7.3.6(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) transitivePeerDependencies: - '@types/node' - jiti @@ -26494,7 +26873,7 @@ snapshots: - supports-color - typescript - vite@7.3.6(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0): + vite@7.3.6(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0): dependencies: esbuild: 0.28.2 fdir: 6.5.0(picomatch@4.0.5) @@ -26505,7 +26884,7 @@ snapshots: optionalDependencies: '@types/node': 24.13.3 fsevents: 2.3.3 - jiti: 2.7.0 + jiti: 1.21.7 lightningcss: 1.33.0 sass: 1.102.0 terser: 5.49.0 @@ -26537,11 +26916,11 @@ snapshots: dependencies: vitest: 4.1.10(@opentelemetry/api@1.9.1)(@types/node@24.13.3)(@vitest/coverage-v8@4.1.10)(happy-dom@20.11.1)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(vite@8.2.0(@types/node@24.13.3)(esbuild@0.28.2)(jiti@2.7.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)) - vitest@3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@2.7.0)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0): + vitest@3.2.7(@types/debug@4.1.13)(@types/node@24.13.3)(happy-dom@20.11.1)(jiti@1.21.7)(jsdom@26.1.0(canvas@3.2.3)(supports-color@8.1.1))(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0): dependencies: '@types/chai': 5.2.3 '@vitest/expect': 3.2.7 - '@vitest/mocker': 3.2.7(vite@7.3.6(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)) + '@vitest/mocker': 3.2.7(vite@7.3.6(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0)) '@vitest/pretty-format': 3.2.7 '@vitest/runner': 3.2.7 '@vitest/snapshot': 3.2.7 @@ -26559,8 +26938,8 @@ snapshots: tinyglobby: 0.2.17 tinypool: 1.1.1 tinyrainbow: 2.0.0 - vite: 7.3.6(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) - vite-node: 3.2.4(@types/node@24.13.3)(jiti@2.7.0)(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) + vite: 7.3.6(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) + vite-node: 3.2.4(@types/node@24.13.3)(jiti@1.21.7)(lightningcss@1.33.0)(sass@1.102.0)(supports-color@8.1.1)(terser@5.49.0)(tsx@4.23.9)(yaml@2.9.0) why-is-node-running: 2.3.0 optionalDependencies: '@types/debug': 4.1.13 @@ -27040,6 +27419,13 @@ snapshots: yoctocolors@2.1.2: {} + yup@1.7.1: + dependencies: + property-expr: 2.0.6 + tiny-case: 1.0.3 + toposort: 2.0.2 + type-fest: 2.19.0 + zimmerframe@1.1.4: {} zip-stream@6.0.1: diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 884a4b5b7f115..edce160faaec0 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -14,6 +14,7 @@ allowBuilds: '@scarf/scarf': false '@swc/core': false bcrypt: true + better-sqlite3: true canvas: false core-js: false cpu-features: false @@ -27,43 +28,44 @@ allowBuilds: '@tailwindcss/oxide': true core-js-pure: false postman-code-generators: false +dedupePeerDependents: false +injectWorkspacePackages: true overrides: canvas: 3.2.3 sharp: ^0.34.5 packageExtensions: - nestjs-kysely: - dependencies: - tslib: '*' - nestjs-otel: + '@immich/ui': dependencies: - tslib: '*' + tailwindcss: '>=4.1' + '@nestjs/swagger': + peerDependencies: + typescript: '*' '@photo-sphere-viewer/equirectangular-video-adapter': dependencies: three: '*' '@photo-sphere-viewer/video-plugin': dependencies: three: '*' - sharp: + bcrypt: dependencies: node-addon-api: '*' node-gyp: '*' - '@immich/ui': + nestjs-kysely: dependencies: - tailwindcss: '>=4.1' - tailwind-variants: + tslib: '*' + nestjs-otel: dependencies: - tailwindcss: '>=4.1' - bcrypt: + tslib: '*' + sharp: dependencies: node-addon-api: '*' node-gyp: '*' - '@nestjs/swagger': - peerDependencies: - typescript: '*' -dedupePeerDependents: false + tailwind-variants: + dependencies: + tailwindcss: '>=4.1' preferWorkspacePackages: true -injectWorkspacePackages: true shamefullyHoist: false verifyDepsBeforeRun: install minimumReleaseAgeExclude: - '@immich/ui@0.83.0' + - '@futo-org/*' diff --git a/server/Dockerfile b/server/Dockerfile index 9d5eb1cccb17e..078c1e025f789 100644 --- a/server/Dockerfile +++ b/server/Dockerfile @@ -52,7 +52,7 @@ RUN --mount=type=cache,id=pnpm-cli,target=/buildcache/pnpm-store \ pnpm --filter @immich/sdk --filter @immich/cli build && \ pnpm --filter @immich/cli --prod --no-optional deploy /output/cli-pruned -FROM builder AS plugins +FROM builder AS tools ARG TARGETPLATFORM @@ -66,7 +66,10 @@ ENV MISE_TRUSTED_CONFIG_PATHS=/app/mise.toml ENV MISE_DATA_DIR=/buildcache/mise ENV MISE_DISABLE_TOOLS=flutter RUN --mount=type=cache,id=mise-tools-${TARGETPLATFORM},target=/buildcache/mise \ - mise install --locked + mise install --locked && \ + cp "$(mise which restic)" /usr/local/bin/restic + +FROM tools AS plugins COPY ./packages/sdk ./packages/sdk/ COPY ./packages/plugin-core ./packages/plugin-core/ @@ -114,6 +117,8 @@ ENV IMMICH_SOURCE_REF=${BUILD_SOURCE_REF} ENV IMMICH_SOURCE_COMMIT=${BUILD_SOURCE_COMMIT} ENV IMMICH_SOURCE_URL=https://github.com/immich-app/immich/commit/${BUILD_SOURCE_COMMIT} +COPY --from=tools /usr/local/bin/restic /usr/local/bin/restic + VOLUME /data EXPOSE 2283 ENTRYPOINT ["tini", "--", "/bin/bash", "-c"] diff --git a/server/package.json b/server/package.json index 7d5f73cc61d34..e0b6579c2711e 100644 --- a/server/package.json +++ b/server/package.json @@ -37,6 +37,7 @@ }, "dependencies": { "@extism/extism": "2.0.0-rc13", + "@futo-org/backups-orchestrator-api": "0.30.0", "@immich/plugin-sdk": "workspace:*", "@immich/sql-tools": "^0.5.1", "@nestjs/bullmq": "^11.0.1", @@ -147,6 +148,7 @@ "@types/supertest": "^7.0.0", "@types/ua-parser-js": "^0.7.36", "@types/validator": "^13.15.2", + "@typescript/native": "npm:typescript@^7.0.2", "@vitest/coverage-v8": "^4.0.0", "eslint": "^10.0.0", "eslint-config-prettier": "^10.1.8", @@ -161,7 +163,6 @@ "supertest": "^7.1.0", "tailwindcss": "^3.4.0", "testcontainers": "^12.0.0", - "@typescript/native": "npm:typescript@^7.0.2", "typescript": "npm:@typescript/typescript6@^6.0.2", "typescript-eslint": "^8.28.0", "unplugin-swc": "^1.4.5", diff --git a/server/src/app.module.ts b/server/src/app.module.ts index a4e8ac27c628a..49a3de9c25fd0 100644 --- a/server/src/app.module.ts +++ b/server/src/app.module.ts @@ -1,15 +1,18 @@ +import { OrchestrationApiModule } from '@futo-org/backups-orchestrator-api'; import { BullModule } from '@nestjs/bullmq'; -import { Inject, Module, OnModuleDestroy, OnModuleInit } from '@nestjs/common'; +import { forwardRef, Inject, Module, OnModuleDestroy, OnModuleInit } from '@nestjs/common'; import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR, APP_PIPE } from '@nestjs/core'; import { ScheduleModule, SchedulerRegistry } from '@nestjs/schedule'; import { ClsModule } from 'nestjs-cls'; import { KyselyModule } from 'nestjs-kysely'; import { OpenTelemetryModule } from 'nestjs-otel'; import { ZodSerializerInterceptor, ZodValidationPipe } from 'nestjs-zod'; +import { existsSync } from 'node:fs'; +import { join } from 'node:path'; import { commandsAndQuestions } from 'src/commands'; import { IWorker } from 'src/constants'; import { controllers } from 'src/controllers'; -import { ImmichWorker } from 'src/enum'; +import { ImmichEnvironment, ImmichWorker } from 'src/enum'; import { MaintenanceAuthGuard } from 'src/maintenance/maintenance-auth.guard'; import { MaintenanceHealthRepository } from 'src/maintenance/maintenance-health.repository'; import { MaintenanceWebsocketRepository } from 'src/maintenance/maintenance-websocket.repository'; @@ -39,6 +42,7 @@ import { DatabaseBackupService } from 'src/services/database-backup.service'; import { QueueService } from 'src/services/queue.service'; import { getKyselyConfig } from 'src/utils/database'; import { configureUserAgent } from 'src/utils/fetch'; +import { detectMediaLocation } from 'src/utils/storage'; const common = [...repositories, ...services, GlobalExceptionFilter]; @@ -53,7 +57,10 @@ const commonMiddleware = [ const apiMiddleware = [FileUploadInterceptor, ...commonMiddleware, { provide: APP_GUARD, useClass: AuthGuard }]; const configRepository = new ConfigRepository(); -const { bull, cls, database, otel } = configRepository.getEnv(); +const { bull, cls, database, environment, otel, storage } = configRepository.getEnv(); + +const isYuccaDevelopmentMode = environment !== ImmichEnvironment.Production; +const yuccaStatePath = join(detectMediaLocation(storage.mediaLocation, existsSync), 'yucca'); const commonImports = [ ClsModule.forRoot(cls.config), @@ -103,14 +110,61 @@ export class BaseModule implements OnModuleInit, OnModuleDestroy { } @Module({ - imports: [...bullImports, ...commonImports, ScheduleModule.forRoot()], + imports: [ + ...bullImports, + ...commonImports, + ScheduleModule.forRoot(), + OrchestrationApiModule.forRootAsync({ + imports: [forwardRef(() => ApiModule)], + inject: [AuthService, WebsocketRepository], + useFactory: (authService: AuthService, websocketRepository: WebsocketRepository) => ({ + statePath: yuccaStatePath, + requireWsAuth: true, + requireLock: true, + developmentMode: isYuccaDevelopmentMode, + authenticate: (client) => + authService.authenticate({ + headers: client.request.headers, + queryParams: {}, + metadata: { adminRoute: true, sharedLinkRoute: false, uri: '/api/yucca/socket.io' }, + }), + onInternalEvent: (event) => { + websocketRepository.serverSend('YuccaEvent', event); + }, + }), + }), + ], controllers: [...controllers], providers: [...common, ...apiMiddleware, { provide: IWorker, useValue: ImmichWorker.Api }], + exports: [AuthService, WebsocketRepository], }) export class ApiModule extends BaseModule {} @Module({ - imports: [...commonImports], + imports: [ + ...commonImports, + OrchestrationApiModule.forRootAsync({ + imports: [forwardRef(() => MaintenanceModule)], + inject: [MaintenanceWorkerService, MaintenanceWebsocketRepository], + useFactory: ( + maintenanceWorkerService: MaintenanceWorkerService, + websocketRepository: MaintenanceWebsocketRepository, + ) => ({ + statePath: yuccaStatePath, + externalBaseUrl: 'https://my.immich.app', + requireWsAuth: true, + requireLock: true, + developmentMode: isYuccaDevelopmentMode, + authenticate: async (client) => { + await maintenanceWorkerService.authenticate(client.request.headers); + return { user: { isAdmin: true } }; + }, + onInternalEvent: (event) => { + websocketRepository.serverSend('YuccaEvent', event); + }, + }), + }), + ], controllers: [MaintenanceWorkerController], providers: [ ConfigRepository, @@ -129,6 +183,7 @@ export class ApiModule extends BaseModule {} { provide: APP_GUARD, useClass: MaintenanceAuthGuard }, { provide: IWorker, useValue: ImmichWorker.Maintenance }, ], + exports: [MaintenanceWorkerService, MaintenanceWebsocketRepository], }) export class MaintenanceModule { constructor( diff --git a/server/src/config.ts b/server/src/config.ts index 55304080a3dea..c84b103b1d9e5 100644 --- a/server/src/config.ts +++ b/server/src/config.ts @@ -19,6 +19,7 @@ import { ConcurrentQueueName, FullsizeImageOptions, ImageOptions } from 'src/typ export type SystemConfig = { backup: { + beta: boolean; database: { enabled: boolean; cronExpression: string; @@ -220,6 +221,7 @@ export type MachineLearningConfig = SystemConfig['machineLearning']; export const defaults = Object.freeze({ backup: { + beta: false, database: { enabled: true, cronExpression: CronExpression.EVERY_DAY_AT_2AM, diff --git a/server/src/dtos/database-backup.dto.ts b/server/src/dtos/database-backup.dto.ts index bc16f0aebf5c0..ce623b19d2350 100644 --- a/server/src/dtos/database-backup.dto.ts +++ b/server/src/dtos/database-backup.dto.ts @@ -27,6 +27,8 @@ const DatabaseBackupDeleteSchema = z }) .meta({ id: 'DatabaseBackupDeleteDto' }); +export type DatabaseBackupDto = z.infer; + export class DatabaseBackupListResponseDto extends createZodDto(DatabaseBackupListResponseSchema) {} export class DatabaseBackupUploadDto extends createZodDto(DatabaseBackupUploadSchema) {} export class DatabaseBackupDeleteDto extends createZodDto(DatabaseBackupDeleteSchema) {} diff --git a/server/src/dtos/maintenance.dto.ts b/server/src/dtos/maintenance.dto.ts index 96b376c5e6b20..f2446d223a261 100644 --- a/server/src/dtos/maintenance.dto.ts +++ b/server/src/dtos/maintenance.dto.ts @@ -6,6 +6,8 @@ const SetMaintenanceModeSchema = z .object({ action: MaintenanceActionSchema, restoreBackupFilename: z.string().optional().describe('Restore backup filename'), + rollbackRepositoryId: z.string().optional().describe('Rollback repository ID'), + rollbackSnapshotId: z.string().optional().describe('Rollback snapshot ID'), }) .refine( (data) => data.action !== MaintenanceAction.RestoreDatabase || (data.restoreBackupFilename?.length ?? 0) > 0, @@ -32,6 +34,7 @@ const MaintenanceStatusResponseSchema = z progress: z.int().optional(), task: z.string().optional(), error: z.string().optional(), + yuccaLogId: z.string().optional().describe('Yucca log ID'), }) .meta({ id: 'MaintenanceStatusResponseDto' }); diff --git a/server/src/dtos/server.dto.ts b/server/src/dtos/server.dto.ts index 0215558aab7ea..1eeba0daea119 100644 --- a/server/src/dtos/server.dto.ts +++ b/server/src/dtos/server.dto.ts @@ -135,6 +135,7 @@ const ServerFeaturesSchema = z configFile: z.boolean().describe('Whether config file is available'), facialRecognition: z.boolean().describe('Whether facial recognition is enabled'), map: z.boolean().describe('Whether map feature is enabled'), + backups: z.boolean().describe('Whether the backups feature is enabled'), trash: z.boolean().describe('Whether trash feature is enabled'), reverseGeocoding: z.boolean().describe('Whether reverse geocoding is enabled'), importFaces: z.boolean().describe('Whether face import is enabled'), diff --git a/server/src/dtos/system-config.dto.ts b/server/src/dtos/system-config.dto.ts index a50b7abe87b45..42304f4040c4d 100644 --- a/server/src/dtos/system-config.dto.ts +++ b/server/src/dtos/system-config.dto.ts @@ -93,7 +93,9 @@ const SystemConfigIntegrityChecksSchema = z .describe('Integrity checks config') .meta({ id: 'SystemConfigIntegrityChecks' }); -const SystemConfigBackupsSchema = z.object({ database: DatabaseBackupSchema }).meta({ id: 'SystemConfigBackupsDto' }); +const SystemConfigBackupsSchema = z + .object({ beta: configBool.describe('Whether the backups feature is enabled'), database: DatabaseBackupSchema }) + .meta({ id: 'SystemConfigBackupsDto' }); const SystemConfigFFmpegSchema = z .object({ diff --git a/server/src/enum.ts b/server/src/enum.ts index 0d29244e09da8..9be132a377eee 100644 --- a/server/src/enum.ts +++ b/server/src/enum.ts @@ -969,6 +969,7 @@ export enum DatabaseLock { IntegrityCheck = 67, VersionCheck = 800, HlsSessionCleanup = 850, + YuccaModuleConfig = 926, } export enum MaintenanceAction { @@ -976,6 +977,7 @@ export enum MaintenanceAction { End = 'end', SelectDatabaseRestore = 'select_database_restore', RestoreDatabase = 'restore_database', + Rollback = 'rollback', } export const MaintenanceActionSchema = z diff --git a/server/src/maintenance/maintenance-auth.guard.ts b/server/src/maintenance/maintenance-auth.guard.ts index 08aaad516b91a..326f8750cbc7c 100644 --- a/server/src/maintenance/maintenance-auth.guard.ts +++ b/server/src/maintenance/maintenance-auth.guard.ts @@ -41,16 +41,18 @@ export class MaintenanceAuthGuard implements CanActivate { } async canActivate(context: ExecutionContext): Promise { + const request = context.switchToHttp().getRequest(); + const targets = [context.getHandler()]; const options = this.reflector.getAllAndOverride<{ _emptyObject: never } | undefined>( MetadataKey.AuthRoute, targets, ); - if (!options) { + + if (!options && !request.path.startsWith('/api/yucca')) { return true; } - const request = context.switchToHttp().getRequest(); request.auth = await this.service.authenticate(request.headers); return true; diff --git a/server/src/maintenance/maintenance-websocket.repository.ts b/server/src/maintenance/maintenance-websocket.repository.ts index d13ceb083fae9..9f324f2e99e2e 100644 --- a/server/src/maintenance/maintenance-websocket.repository.ts +++ b/server/src/maintenance/maintenance-websocket.repository.ts @@ -15,6 +15,7 @@ import { LoggingRepository } from 'src/repositories/logging.repository'; interface ServerEventMap { AppRestart: [AppRestartEvent]; MaintenanceStatus: [MaintenanceStatusResponseDto]; + YuccaEvent: [unknown]; } interface ClientEventMap { diff --git a/server/src/maintenance/maintenance-worker.service.ts b/server/src/maintenance/maintenance-worker.service.ts index f088637a5758f..6caf4deecd1a0 100644 --- a/server/src/maintenance/maintenance-worker.service.ts +++ b/server/src/maintenance/maintenance-worker.service.ts @@ -1,9 +1,12 @@ +import { YuccaService } from '@futo-org/backups-orchestrator-api'; import { Injectable, UnauthorizedException } from '@nestjs/common'; +import { ModuleRef } from '@nestjs/core'; import { parse } from 'cookie'; import { NextFunction, Request, Response } from 'express'; import { jwtVerify } from 'jose'; import { readFileSync } from 'node:fs'; import { IncomingHttpHeaders } from 'node:http'; +import { basename } from 'node:path'; import { serverVersion } from 'src/constants'; import { StorageCore } from 'src/cores/storage.core'; import { @@ -30,8 +33,10 @@ import { type ServerService as _ServerService } from 'src/services/server.servic import { type VersionService as _VersionService } from 'src/services/version.service'; import { MaintenanceModeState } from 'src/types'; import { getConfig } from 'src/utils/config'; +import { getLatestDatabaseBackup } from 'src/utils/database-backups'; import { createMaintenanceLoginUrl, detectPriorInstall } from 'src/utils/maintenance'; import { getExternalDomain } from 'src/utils/misc'; +import { detectMediaLocation } from 'src/utils/storage'; /** * This service is available inside of maintenance mode to manage maintenance mode @@ -55,6 +60,7 @@ export class MaintenanceWorkerService { private processRepository: ProcessRepository, private databaseRepository: DatabaseRepository, private databaseBackupService: DatabaseBackupService, + private moduleRef: ModuleRef, ) { this.logger.setContext(this.constructor.name); } @@ -158,30 +164,9 @@ export class MaintenanceWorkerService { }; } - /** - * {@link _StorageService.detectMediaLocation} - */ detectMediaLocation(): string { const envData = this.configRepository.getEnv(); - if (envData.storage.mediaLocation) { - return envData.storage.mediaLocation; - } - - const targets: string[] = []; - const candidates = ['/data', '/usr/src/app/upload']; - - for (const candidate of candidates) { - const isExists = this.storageRepository.existsSync(candidate); - if (isExists) { - targets.push(candidate); - } - } - - if (targets.length === 1) { - return targets[0]; - } - - return '/usr/src/app/upload'; + return detectMediaLocation(envData.storage.mediaLocation, (path) => this.storageRepository.existsSync(path)); } private get secret() { @@ -291,6 +276,9 @@ export class MaintenanceWorkerService { case MaintenanceAction.RestoreDatabase: { return this.runRestoreDatabase(action); } + case MaintenanceAction.Rollback: { + return this.runRollback(action); + } } } @@ -349,6 +337,73 @@ export class MaintenanceWorkerService { }); } + private async runRollback(action: SetMaintenanceModeDto) { + const isLock = await this.databaseRepository.tryLock(DatabaseLock.MaintenanceOperation); + if (!isLock) { + return; + } + + this.logger.log(`Running maintenance action ${action.action}`); + + await this.systemMetadataRepository.set(SystemMetadataKey.MaintenanceMode, { + isMaintenanceMode: true, + secret: this.secret, + action: { + action: MaintenanceAction.Start, + }, + }); + + try { + if (!action.rollbackRepositoryId || !action.rollbackSnapshotId) { + throw new Error("Expected rollbackRepositoryId and rollbackSnapshotId but they're missing!"); + } + + await this.rollback(action.rollbackRepositoryId, action.rollbackSnapshotId); + } catch (error) { + this.logger.error(`Encountered error running action: ${error}`); + this.setStatus({ + active: true, + action: action.action, + task: 'error', + error: '' + error, + }); + } + } + + private async rollback(repositoryId: string, snapshotId: string): Promise { + this.setStatus({ + active: true, + action: MaintenanceAction.Rollback, + }); + + // code needs to be pulled back into yucca sdk + + const yucca = this.moduleRef.get(YuccaService, { strict: false }); + const { logId, task, tags } = await yucca.restoreSnapshotInplace(repositoryId, snapshotId); + + this.setStatus({ + active: true, + action: MaintenanceAction.Rollback, + yuccaLogId: logId, + }); + + await task; + + enum ResticTagPrefix { + ImmichBackupFileName = 'yucca.v1.immichBackupFileName', + } + + const backupFileNameTag = tags.find((item) => item.startsWith(`${ResticTagPrefix.ImmichBackupFileName}=`)); + if (!backupFileNameTag) { + return this.setAction({ + action: MaintenanceAction.SelectDatabaseRestore, + }); + } + + const backupFileName = basename(backupFileNameTag.slice(ResticTagPrefix.ImmichBackupFileName.length + 1)); + await this.restoreBackup(backupFileName); + } + private async endMaintenance(): Promise { const state: MaintenanceModeState = { isMaintenanceMode: false as const }; await this.systemMetadataRepository.set(SystemMetadataKey.MaintenanceMode, state); diff --git a/server/src/middleware/auth.guard.ts b/server/src/middleware/auth.guard.ts index 93bcfe26e76b7..929cb9e7c01a2 100644 --- a/server/src/middleware/auth.guard.ts +++ b/server/src/middleware/auth.guard.ts @@ -97,7 +97,12 @@ export class AuthGuard implements CanActivate { } async canActivate(context: ExecutionContext): Promise { - const options = getAuthenticatedOptions(this.reflector, context.getHandler()); + const request = context.switchToHttp().getRequest(); + + const options = request.path.startsWith('/api/yucca') + ? { sharedLink: false, admin: true, public: false, setup: false, permission: undefined } + : getAuthenticatedOptions(this.reflector, context.getHandler()); + if (!options) { throw new Error(`Route ${context.getHandler().name} does not declare @Authenticated()`); } @@ -111,7 +116,6 @@ export class AuthGuard implements CanActivate { } const { admin: adminRoute, sharedLink: sharedLinkRoute, permission } = options; - const request = context.switchToHttp().getRequest(); request.user = await this.authService.authenticate({ headers: request.headers, diff --git a/server/src/repositories/event.repository.ts b/server/src/repositories/event.repository.ts index 416f823952296..e7de302445aff 100644 --- a/server/src/repositories/event.repository.ts +++ b/server/src/repositories/event.repository.ts @@ -1,3 +1,4 @@ +import { GatewayEvent as YuccaGatewayEvent } from '@futo-org/backups-orchestrator-api'; import { Injectable } from '@nestjs/common'; import { ModuleRef, Reflector } from '@nestjs/core'; import _ from 'lodash'; @@ -67,6 +68,10 @@ type EventMap = { /** job finishes with error */ JobError: [JobErrorEvent]; + LibraryCreate: []; + LibraryUpdate: []; + LibraryDelete: []; + // queue events QueueStart: [QueueStartEvent]; @@ -102,6 +107,8 @@ type EventMap = { // websocket events WebsocketConnect: [{ userId: string }]; + + YuccaEvent: [YuccaGatewayEvent]; }; export type AppRestartEvent = { diff --git a/server/src/repositories/websocket.repository.ts b/server/src/repositories/websocket.repository.ts index 3b4328563a8ab..a7cf7e5f6328e 100644 --- a/server/src/repositories/websocket.repository.ts +++ b/server/src/repositories/websocket.repository.ts @@ -19,6 +19,7 @@ import { handlePromiseError } from 'src/utils/misc'; export const serverEvents = [ 'ConfigUpdate', 'AppRestart', + 'YuccaEvent', 'HlsSegmentRequest', 'HlsSegmentResult', 'HlsHeartbeat', diff --git a/server/src/services/index.ts b/server/src/services/index.ts index 766b5979bc707..40112c2d5361d 100644 --- a/server/src/services/index.ts +++ b/server/src/services/index.ts @@ -49,6 +49,7 @@ import { VersionService } from 'src/services/version.service'; import { ViewService } from 'src/services/view.service'; import { WorkflowExecutionService } from 'src/services/workflow-execution.service'; import { WorkflowService } from 'src/services/workflow.service'; +import { YuccaService } from 'src/services/yucca.service'; export const services = [ ApiKeyService, @@ -102,4 +103,5 @@ export const services = [ ViewService, WorkflowExecutionService, WorkflowService, + YuccaService, ]; diff --git a/server/src/services/library.service.ts b/server/src/services/library.service.ts index 9e5e0cf4d100f..b7b21fc3a5da3 100644 --- a/server/src/services/library.service.ts +++ b/server/src/services/library.service.ts @@ -244,6 +244,8 @@ export class LibraryService extends BaseService { '**/.stfolder/**', ], }); + + await this.eventRepository.emit('LibraryCreate'); return mapLibrary(library); } @@ -355,6 +357,7 @@ export class LibraryService extends BaseService { } const library = await this.libraryRepository.update(id, dto); + await this.eventRepository.emit('LibraryUpdate'); return mapLibrary(library); } @@ -367,6 +370,8 @@ export class LibraryService extends BaseService { await this.libraryRepository.softDelete(id); await this.jobRepository.queue({ name: JobName.LibraryDelete, data: { id } }); + + await this.eventRepository.emit('LibraryDelete'); } @OnJob({ name: JobName.LibraryDelete, queue: QueueName.Library }) diff --git a/server/src/services/server.service.spec.ts b/server/src/services/server.service.spec.ts index b4b1af35d6527..f8edbefdf3a7b 100644 --- a/server/src/services/server.service.spec.ts +++ b/server/src/services/server.service.spec.ts @@ -138,6 +138,7 @@ describe(ServerService.name, () => { duplicateDetection: true, facialRecognition: true, importFaces: false, + backups: false, map: true, reverseGeocoding: true, oauth: false, diff --git a/server/src/services/server.service.ts b/server/src/services/server.service.ts index 57342f9509814..3cb46cf178233 100644 --- a/server/src/services/server.service.ts +++ b/server/src/services/server.service.ts @@ -86,8 +86,18 @@ export class ServerService extends BaseService { } async getFeatures(): Promise { - const { reverseGeocoding, metadata, map, machineLearning, trash, oauth, passwordLogin, notifications, ffmpeg } = - await this.getConfig({ withCache: false }); + const { + reverseGeocoding, + metadata, + map, + backup, + machineLearning, + trash, + oauth, + passwordLogin, + notifications, + ffmpeg, + } = await this.getConfig({ withCache: false }); const { configFile } = this.configRepository.getEnv(); return { @@ -95,6 +105,7 @@ export class ServerService extends BaseService { facialRecognition: isFacialRecognitionEnabled(machineLearning), duplicateDetection: isDuplicateDetectionEnabled(machineLearning), map: map.enabled, + backups: backup.beta, reverseGeocoding: reverseGeocoding.enabled, importFaces: metadata.faces.import, sidecar: true, diff --git a/server/src/services/storage.service.ts b/server/src/services/storage.service.ts index 95926d6509eb1..ca1fd02d9ab6b 100644 --- a/server/src/services/storage.service.ts +++ b/server/src/services/storage.service.ts @@ -15,6 +15,7 @@ import { import { BaseService } from 'src/services/base.service'; import { JobOf, SystemFlags } from 'src/types'; import { ImmichStartupError } from 'src/utils/misc'; +import { detectMediaLocation } from 'src/utils/storage'; const docsMessage = `Please see https://docs.immich.app/administration/system-integrity#folder-checks for more information.`; @@ -22,25 +23,7 @@ const docsMessage = `Please see https://docs.immich.app/administration/system-in export class StorageService extends BaseService { private detectMediaLocation(): string { const envData = this.configRepository.getEnv(); - if (envData.storage.mediaLocation) { - return envData.storage.mediaLocation; - } - - const targets: string[] = []; - const candidates = ['/data', '/usr/src/app/upload']; - - for (const candidate of candidates) { - const isExists = this.storageRepository.existsSync(candidate); - if (isExists) { - targets.push(candidate); - } - } - - if (targets.length === 1) { - return targets[0]; - } - - return '/usr/src/app/upload'; + return detectMediaLocation(envData.storage.mediaLocation, (path) => this.storageRepository.existsSync(path)); } @OnEvent({ name: 'AppBootstrap', priority: BootstrapEventPriority.StorageService }) diff --git a/server/src/services/system-config.service.spec.ts b/server/src/services/system-config.service.spec.ts index 08851da96aff9..f3c0b6bc960ce 100644 --- a/server/src/services/system-config.service.spec.ts +++ b/server/src/services/system-config.service.spec.ts @@ -47,6 +47,7 @@ const updatedConfig = Object.freeze({ [QueueName.Editor]: { concurrency: 2 }, }, backup: { + beta: false, database: { enabled: true, cronExpression: '0 02 * * *', diff --git a/server/src/services/yucca.service.ts b/server/src/services/yucca.service.ts new file mode 100644 index 0000000000000..ba6bde01d8710 --- /dev/null +++ b/server/src/services/yucca.service.ts @@ -0,0 +1,96 @@ +import { GatewayEvent, YuccaService as YuccaOrchestratorService } from '@futo-org/backups-orchestrator-api'; +import { Injectable, Optional } from '@nestjs/common'; +import { SystemConfig } from 'src/config'; +import { StorageCore } from 'src/cores/storage.core'; +import { OnEvent } from 'src/decorators'; +import { DatabaseLock, ImmichWorker, MaintenanceAction, StorageFolder } from 'src/enum'; +import { DatabaseRepository } from 'src/repositories/database.repository'; +import { ArgOf } from 'src/repositories/event.repository'; +import { LibraryRepository } from 'src/repositories/library.repository'; +import { DatabaseBackupService } from 'src/services/database-backup.service'; +import { MaintenanceService } from 'src/services/maintenance.service'; +import { getExternalDomain } from 'src/utils/misc'; + +@Injectable() +export class YuccaService { + constructor( + private readonly databaseRepository: DatabaseRepository, + private readonly libraryRepository: LibraryRepository, + private readonly databaseBackupService: DatabaseBackupService, + @Optional() private readonly maintenanceService: MaintenanceService, + @Optional() private readonly yuccaService: YuccaOrchestratorService, + ) { + this.createDatabaseBackup = this.createDatabaseBackup.bind(this); + this.enterMaintenanceRollback = this.enterMaintenanceRollback.bind(this); + } + + private updateSystemConfig({ server }: SystemConfig) { + this.yuccaService.setExternalBaseUrl(getExternalDomain(server)); + } + + private async updateLibraryConfig() { + const libraries = await this.libraryRepository.getAll(); + + this.yuccaService.setImmichIntegration({ + dataPath: StorageCore.getMediaLocation(), + dataFolders: Object.values(StorageFolder), + libraries: libraries + .filter((library) => !library.deletedAt) + .map(({ id, name, importPaths, exclusionPatterns }) => ({ id, name, importPaths, exclusionPatterns })), + hooks: { + createDatabaseBackup: this.createDatabaseBackup, + enterMaintenanceRollback: this.enterMaintenanceRollback, + }, + }); + } + + private createDatabaseBackup() { + return this.databaseBackupService.createDatabaseBackup(); + } + + private enterMaintenanceRollback(repositoryId: string, snapshotId: string) { + return this.maintenanceService.startMaintenance( + { + action: MaintenanceAction.Rollback, + rollbackRepositoryId: repositoryId, + rollbackSnapshotId: snapshotId, + }, + 'yucca-rollback', + ); + } + + @OnEvent({ name: 'ConfigInit', workers: [ImmichWorker.Api] }) + async onConfigInit({ newConfig }: ArgOf<'ConfigInit'>) { + this.updateSystemConfig(newConfig); + void this.updateLibraryConfig(); + + if (await this.databaseRepository.tryLock(DatabaseLock.YuccaModuleConfig)) { + this.yuccaService.acquireLock(); + } + } + + @OnEvent({ name: 'ConfigUpdate', workers: [ImmichWorker.Api], server: true }) + onConfigUpdate({ newConfig }: ArgOf<'ConfigUpdate'>) { + this.updateSystemConfig(newConfig); + } + + @OnEvent({ name: 'LibraryCreate', workers: [ImmichWorker.Api], server: true }) + onLibraryCreate() { + void this.updateLibraryConfig(); + } + + @OnEvent({ name: 'LibraryUpdate', workers: [ImmichWorker.Api], server: true }) + onLibraryUpdate() { + void this.updateLibraryConfig(); + } + + @OnEvent({ name: 'LibraryDelete', workers: [ImmichWorker.Api], server: true }) + onLibraryDelete() { + void this.updateLibraryConfig(); + } + + @OnEvent({ name: 'YuccaEvent', workers: [ImmichWorker.Api], server: true }) + onYuccaEvent(event: GatewayEvent) { + this.yuccaService.emit(event); + } +} diff --git a/server/src/utils/database-backups.ts b/server/src/utils/database-backups.ts index 70bedb32b183e..4bc1f33cfd08d 100644 --- a/server/src/utils/database-backups.ts +++ b/server/src/utils/database-backups.ts @@ -1,3 +1,6 @@ +import { DateTime } from 'luxon'; +import { DatabaseBackupDto } from 'src/dtos/database-backup.dto'; + export function isValidDatabaseBackupName(filename: string) { return filename.match(/^[\d\w-.]+\.sql(?:\.gz)?$/); } @@ -17,6 +20,23 @@ export function findDatabaseBackupVersion(filename: string) { return /-v(.*)-/.exec(filename)?.[1]; } +function getDatabaseBackupTimestamp(backup: DatabaseBackupDto): number { + const dateMatch = backup.filename.match(/\d+T\d+/); + if (!dateMatch) { + return 0; + } + + return DateTime.fromFormat(dateMatch[0], "yyyyMMdd'T'HHmmss", { zone: backup.timezone }).toMillis(); +} + +export function getLatestDatabaseBackup(backups: T[]): T | undefined { + if (backups.length === 0) { + return undefined; + } + + return backups.toSorted((a, b) => getDatabaseBackupTimestamp(b) - getDatabaseBackupTimestamp(a))[0]; +} + export class UnsupportedPostgresError extends Error { constructor(databaseVersion: string) { super(`Unsupported PostgreSQL version: ${databaseVersion}`); diff --git a/server/src/utils/storage.ts b/server/src/utils/storage.ts new file mode 100644 index 0000000000000..427dd7be06fd0 --- /dev/null +++ b/server/src/utils/storage.ts @@ -0,0 +1,20 @@ +export const detectMediaLocation = (mediaLocation: string | undefined, exists: (path: string) => boolean): string => { + if (mediaLocation) { + return mediaLocation; + } + + const targets: string[] = []; + const candidates = ['/data', '/usr/src/app/upload']; + + for (const candidate of candidates) { + if (exists(candidate)) { + targets.push(candidate); + } + } + + if (targets.length === 1) { + return targets[0]; + } + + return '/usr/src/app/upload'; +}; diff --git a/server/src/workers/api.ts b/server/src/workers/api.ts index 99c08c0fa7af6..61348969b21fb 100644 --- a/server/src/workers/api.ts +++ b/server/src/workers/api.ts @@ -11,7 +11,13 @@ async function bootstrap() { configureTelemetry(); - const app = await NestFactory.create(ApiModule, { bufferLogs: true }); + const app = await NestFactory.create(ApiModule, { + bufferLogs: true, + // default module id algorithm can cause + // the ApiModule to be instatiated more than + // once when injected into YuccaModule + moduleIdGeneratorAlgorithm: 'deep-hash', + }); app.get(AppRepository).setCloseFn(() => app.close()); void configureExpress(app, { diff --git a/server/src/workers/maintenance.ts b/server/src/workers/maintenance.ts index 035ec600af054..029676be71baa 100644 --- a/server/src/workers/maintenance.ts +++ b/server/src/workers/maintenance.ts @@ -10,7 +10,11 @@ async function bootstrap() { process.title = 'immich-maintenance'; configureTelemetry(); - const app = await NestFactory.create(MaintenanceModule, { bufferLogs: true }); + const app = await NestFactory.create(MaintenanceModule, { + bufferLogs: true, + // see comment in api.ts + moduleIdGeneratorAlgorithm: 'deep-hash', + }); app.get(AppRepository).setCloseFn(() => app.close()); void configureExpress(app, { diff --git a/web/package.json b/web/package.json index d709ca0de659e..bd6e5c51ce075 100644 --- a/web/package.json +++ b/web/package.json @@ -25,6 +25,7 @@ }, "dependencies": { "@formatjs/icu-messageformat-parser": "^3.0.0", + "@futo-org/backups-orchestrator-ui": "0.30.0", "@immich/justified-layout-wasm": "^0.4.3", "@immich/sdk": "workspace:*", "@immich/ui": "^0.85.0", @@ -90,6 +91,7 @@ "@types/lodash-es": "^4.17.12", "@types/luxon": "^3.4.2", "@types/qrcode": "^1.5.5", + "@typescript/native": "npm:typescript@^7.0.2", "@vitest/coverage-v8": "^4.0.0", "dotenv": "^17.0.0", "eslint": "^10.2.1", @@ -109,7 +111,6 @@ "svelte-check": "^4.4.6", "svelte-eslint-parser": "^1.3.3", "tailwindcss": "^4.2.4", - "@typescript/native": "npm:typescript@^7.0.2", "typescript": "npm:@typescript/typescript6@^6.0.2", "typescript-eslint": "^8.45.0", "vite": "^8.0.0", diff --git a/web/src/lib/components/layouts/AdminPageLayout.svelte b/web/src/lib/components/layouts/AdminPageLayout.svelte index 7d2003f2255b7..5c9785752859c 100644 --- a/web/src/lib/components/layouts/AdminPageLayout.svelte +++ b/web/src/lib/components/layouts/AdminPageLayout.svelte @@ -2,16 +2,25 @@ import BreadcrumbActionPage from '$lib/components/BreadcrumbActionPage.svelte'; import NavigationBar from '$lib/components/shared-components/navigation-bar/NavigationBar.svelte'; import BottomInfo from '$lib/components/shared-components/side-bar/BottomInfo.svelte'; + import { featureFlagsManager } from '$lib/managers/feature-flags-manager.svelte'; import { Route } from '$lib/route'; import { sidebarStore } from '$lib/stores/sidebar.svelte'; import type { HeaderButtonActionItem } from '$lib/types'; import { AppShell, AppShellHeader, AppShellSidebar, MenuItemType, NavbarItem, type BreadcrumbItem } from '@immich/ui'; - import { mdiAccountMultipleOutline, mdiBookshelf, mdiCog, mdiServer, mdiTrayFull, mdiWrench } from '@mdi/js'; + import { + mdiAccountMultipleOutline, + mdiBookshelf, + mdiCloudUploadOutline, + mdiCog, + mdiServer, + mdiTrayFull, + mdiWrench, + } from '@mdi/js'; import type { Snippet } from 'svelte'; import { t } from 'svelte-i18n'; type Props = { - breadcrumbs: BreadcrumbItem[]; + breadcrumbs?: BreadcrumbItem[]; actions?: Array; children?: Snippet; }; @@ -28,6 +37,9 @@ class="flex h-full flex-col justify-between gap-2 border-none shadow-none" >
+ {#if featureFlagsManager.value.backups} + + {/if} @@ -41,7 +53,13 @@
- - {@render children?.()} - + {#if breadcrumbs} + + {@render children?.()} + + {:else} +
+ {@render children?.()} +
+ {/if} diff --git a/web/src/lib/components/maintenance/MaintenanceBackupCard.svelte b/web/src/lib/components/maintenance/MaintenanceBackupCard.svelte new file mode 100644 index 0000000000000..c678c6a32fb7e --- /dev/null +++ b/web/src/lib/components/maintenance/MaintenanceBackupCard.svelte @@ -0,0 +1,119 @@ + + + + + +
+ + {#if status === BackupFileStatus.OK} + + {:else if status === BackupFileStatus.DifferentVersion} + + {:else} + + {/if} + + {#if dateDisplay} + {dateDisplay} + {:else} + {$t('unknown_date')} + {/if} + {#if relativeTime} +
+
+ {relativeTime} +
+ {/if} + + + {#if actions} + + {@render actions()} + + {/if} +
+ + + + {filename} + + + {#if status === BackupFileStatus.UnknownVersion} + + {$t('admin.maintenance_restore_backup_unknown_version')} + + {:else if status === BackupFileStatus.DifferentVersion} + + {$t('admin.maintenance_restore_backup_different_version')} + + {/if} + + +
+ {$t('version')}: + {version ? `v${version}` : $t('unknown')} +
+
+ {$t('size')}: + {filesizeText[0]} {filesizeText[1]} +
+ + + + diff --git a/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelte b/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelte index 219956269d671..1c2fb12a00556 100644 --- a/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelte +++ b/web/src/lib/components/maintenance/MaintenanceBackupEntry.svelte @@ -1,12 +1,8 @@ + + + + + + diff --git a/web/src/routes/admin/backups/+page.ts b/web/src/routes/admin/backups/+page.ts new file mode 100644 index 0000000000000..18e4c39375452 --- /dev/null +++ b/web/src/routes/admin/backups/+page.ts @@ -0,0 +1,12 @@ +import { authenticate } from '$lib/utils/auth'; +import type { PageLoad } from './$types'; + +export const load = (async ({ url }) => { + await authenticate(url, { admin: true }); + + return { + meta: { + title: 'Backups', + }, + }; +}) satisfies PageLoad; diff --git a/web/src/routes/link/+page.ts b/web/src/routes/link/+page.ts index 4c113b2e5cb65..1ba07dc9f26e6 100644 --- a/web/src/routes/link/+page.ts +++ b/web/src/routes/link/+page.ts @@ -1,3 +1,4 @@ +import { getConfig, updateConfig } from '@immich/sdk'; import { redirect } from '@sveltejs/kit'; import { OpenQueryParam } from '$lib/constants'; import { Route } from '$lib/route'; @@ -8,9 +9,10 @@ enum LinkTarget { UNSUBSCRIBE = 'unsubscribe', VIEW_ASSET = 'view_asset', ACTIVATE_LICENSE = 'activate_license', + BACKUPS = 'backups', } -export const load = (({ url }) => { +export const load = (async ({ url }) => { const queryParams = url.searchParams; const target = queryParams.get('target') as LinkTarget; switch (target) { @@ -22,6 +24,17 @@ export const load = (({ url }) => { return redirect(307, Route.userSettings({ isOpen: OpenQueryParam.NOTIFICATIONS })); } + case LinkTarget.BACKUPS: { + const config = await getConfig().catch(() => undefined); + if (config && !config.backup.beta) { + await updateConfig({ + systemConfigDto: { ...config, backup: { ...config.backup, beta: true } }, + }).catch(() => undefined); + } + + return redirect(307, Route.backups()); + } + case LinkTarget.VIEW_ASSET: { const id = queryParams.get('id'); if (id) { diff --git a/web/src/routes/maintenance/+page.svelte b/web/src/routes/maintenance/+page.svelte index 566231692d64e..52a4be17c190a 100644 --- a/web/src/routes/maintenance/+page.svelte +++ b/web/src/routes/maintenance/+page.svelte @@ -7,6 +7,7 @@ import { maintenanceStore } from '$lib/stores/maintenance.store'; import { MaintenanceAction } from '@immich/sdk'; import { Button, Heading, Link, ProgressBar, Scrollable, Text } from '@immich/ui'; + import { YuccaContext, ViewStatusModal } from '@futo-org/backups-orchestrator-ui'; import { t } from 'svelte-i18n'; import type { PageData } from './$types'; @@ -30,6 +31,11 @@ action: MaintenanceAction.End, }); + const startRestore = () => + handleSetMaintenanceMode({ + action: MaintenanceAction.SelectDatabaseRestore, + }); + const error = $derived( $status?.error ?.split('\n') @@ -38,58 +44,65 @@ ); - -
- {#if $status?.action === MaintenanceAction.RestoreDatabase} - {$t('maintenance_action_restore')} - {#if $status.error} - - 
{error}
- - - {:else} - - {#if $status.task === 'backup'} - {$t('maintenance_task_backup')} - {/if} - {#if $status.task === 'restore'} - {$t('maintenance_task_restore')} + + +
+ {#if $status?.action === MaintenanceAction.RestoreDatabase} + {$t('maintenance_action_restore')} + {#if $status.error} + + 
{error}
+ + + {:else} + + {#if $status.task === 'backup'} + {$t('maintenance_task_backup')} + {/if} + {#if $status.task === 'restore'} + {$t('maintenance_task_restore')} + {/if} + {#if $status.task === 'migrations'} + {$t('maintenance_task_migrations')} + {/if} + {#if $status.task === 'rollback'} + {$t('maintenance_task_rollback')} + {/if} {/if} - {#if $status.task === 'migrations'} - {$t('maintenance_task_migrations')} - {/if} - {#if $status.task === 'rollback'} - {$t('maintenance_task_rollback')} - {/if} - {/if} - {:else if $status?.action === MaintenanceAction.SelectDatabaseRestore && $auth} - - {:else} - {$t('maintenance_title')} -

- - {#snippet children({ tag, message })} - {#if tag === 'link'} - - {message} - - {/if} - {/snippet} - -

- {#if $auth} + {:else if $status?.action === MaintenanceAction.Rollback && $status.yuccaLogId} + void 0} /> + {:else if $status?.action === MaintenanceAction.SelectDatabaseRestore && $auth} + + {:else} + {$t('maintenance_title')}

- {$t('maintenance_logged_in_as', { - values: { - user: $auth.username, - }, - })} + + {#snippet children({ tag, message })} + {#if tag === 'link'} + + {message} + + {/if} + {/snippet} +

- + {#if $auth} +

+ {$t('maintenance_logged_in_as', { + values: { + user: $auth.username, + }, + })} +

+
+ + +
+ {/if} {/if} - {/if} -
- +
+ + diff --git a/web/src/routes/maintenance/MaintenanceRestoreFlow.svelte b/web/src/routes/maintenance/MaintenanceRestoreFlow.svelte index 97119ea2f98b4..4eb909571686e 100644 --- a/web/src/routes/maintenance/MaintenanceRestoreFlow.svelte +++ b/web/src/routes/maintenance/MaintenanceRestoreFlow.svelte @@ -1,6 +1,9 @@ -{#if stage === 0} - stage++} {end} /> -{:else} - stage--} {end} {expectedVersion} /> +{#if stage === 'overview'} + (stage = 'yucca')} flowToDatabase={() => (stage = 'detect-install')} {end} /> +{:else if stage === 'yucca'} + (stage = 'overview')} onFinish={() => (stage = 'auto-select-backup')} /> +{:else if stage === 'detect-install'} + (stage = 'select-backup')} previous={() => (stage = 'overview')} /> +{:else if stage === 'select-backup'} + (stage = 'detect-install')} {end} {expectedVersion} /> +{:else if stage === 'auto-select-backup'} + (stage = 'select-backup')} {end} {expectedVersion} /> {/if} diff --git a/web/src/routes/maintenance/RestoreFlowAutoSelectBackup.svelte b/web/src/routes/maintenance/RestoreFlowAutoSelectBackup.svelte new file mode 100644 index 0000000000000..ea5eb31acb7d7 --- /dev/null +++ b/web/src/routes/maintenance/RestoreFlowAutoSelectBackup.svelte @@ -0,0 +1,62 @@ + + +{$t('maintenance_restore_from_backup')} + +{#if backups === undefined} + + + {$t('maintenance_restore_loading_backups')} + +{:else if latest === undefined} + + + + + +{:else} + {$t('maintenance_restore_latest_backup_description')} + + + + + + + +{/if} diff --git a/web/src/routes/maintenance/RestoreFlowDetectInstall.svelte b/web/src/routes/maintenance/RestoreFlowDetectInstall.svelte index c0461394f8cad..08009e6a2689a 100644 --- a/web/src/routes/maintenance/RestoreFlowDetectInstall.svelte +++ b/web/src/routes/maintenance/RestoreFlowDetectInstall.svelte @@ -7,10 +7,10 @@ type Props = { next: () => void; - end: () => void; + previous: () => void; }; - const { next, end }: Props = $props(); + const { next, previous }: Props = $props(); let detectedInstall: MaintenanceDetectInstallResponseDto | undefined = $state(); @@ -92,6 +92,6 @@ {$t('maintenance_restore_library_confirm')} - + diff --git a/web/src/routes/maintenance/RestoreFlowIntro.svelte b/web/src/routes/maintenance/RestoreFlowIntro.svelte new file mode 100644 index 0000000000000..b33f7cf957e55 --- /dev/null +++ b/web/src/routes/maintenance/RestoreFlowIntro.svelte @@ -0,0 +1,20 @@ + + +Where would you like to restore from? + + + + +