immich/mobile/openapi/doc/IntegrationsApi.md

openapi.api.IntegrationsApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
configureImmichIntegration	POST /yucca/integrations/immich
getIntegrations	GET /yucca/integrations
startImmichRollback	POST /yucca/integrations/immich/rollback

configureImmichIntegration

configureImmichIntegration(configureImmichIntegrationRequestDto)

Example

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

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]

getIntegrations

IntegrationsResponseDto getIntegrations()

Example

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

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]

startImmichRollback

startImmichRollback(immichRollbackRequestDto)

Example

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

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]