immich/mobile/openapi/doc/OnboardingApi.md

openapi.api.OnboardingApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
confirmRecoveryKey	POST /yucca/onboarding/recovery-key
currentRecoveryKey	GET /yucca/onboarding/recovery-key
enableTelemetry	POST /yucca/onboarding/telemetry
importRecoveryKey	PUT /yucca/onboarding/recovery-key
onboardingStatus	GET /yucca/onboarding
reportError	POST /yucca/onboarding/report-error
skipOnboardingExtraConfig	POST /yucca/onboarding/skip

confirmRecoveryKey

confirmRecoveryKey()

Example

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] [Back to Model list] [Back to README]

currentRecoveryKey

CurrentRecoveryKeyResponse currentRecoveryKey()

Example

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

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enableTelemetry

enableTelemetry()

Example

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] [Back to Model list] [Back to README]

importRecoveryKey

importRecoveryKey(importRecoveryKeyRequest)

Example

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

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] [Back to Model list] [Back to README]

onboardingStatus

OnboardingStatusResponseDto onboardingStatus()

Example

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

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reportError

reportError()

Example

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] [Back to Model list] [Back to README]

skipOnboardingExtraConfig

skipOnboardingExtraConfig()

Example

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] [Back to Model list] [Back to README]