immich/mobile/openapi/doc/SystemMetadataApi.md

openapi.api.SystemMetadataApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
getAdminOnboarding	GET /system-metadata/admin-onboarding
getReverseGeocodingState	GET /system-metadata/reverse-geocoding-state
updateAdminOnboarding	POST /system-metadata/admin-onboarding

getAdminOnboarding

AdminOnboardingUpdateDto getAdminOnboarding()

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('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

Authorization

cookie, api_key, bearer

HTTP request headers

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

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

getReverseGeocodingState

ReverseGeocodingStateResponseDto getReverseGeocodingState()

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('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

Authorization

cookie, api_key, bearer

HTTP request headers

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

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

updateAdminOnboarding

updateAdminOnboarding(adminOnboardingUpdateDto)

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP Bearer authorization: bearer
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('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

Return type

void (empty response body)

Authorization

cookie, api_key, bearer

HTTP request headers

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

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