1
0
mirror of https://github.com/immich-app/immich.git synced 2024-12-27 10:58:13 +02:00
immich/mobile/openapi/doc/DeviceInfoApi.md

3.2 KiB

openapi.api.DeviceInfoApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method HTTP request Description
createDeviceInfo POST /device-info
updateDeviceInfo PATCH /device-info

createDeviceInfo

DeviceInfoResponseDto createDeviceInfo(createDeviceInfoDto)

Example

import 'package:openapi/api.dart';
// 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 = DeviceInfoApi();
final createDeviceInfoDto = CreateDeviceInfoDto(); // CreateDeviceInfoDto | 

try {
    final result = api_instance.createDeviceInfo(createDeviceInfoDto);
    print(result);
} catch (e) {
    print('Exception when calling DeviceInfoApi->createDeviceInfo: $e\n');
}

Parameters

Name Type Description Notes
createDeviceInfoDto CreateDeviceInfoDto

Return type

DeviceInfoResponseDto

Authorization

bearer

HTTP request headers

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

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

updateDeviceInfo

DeviceInfoResponseDto updateDeviceInfo(updateDeviceInfoDto)

Example

import 'package:openapi/api.dart';
// 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 = DeviceInfoApi();
final updateDeviceInfoDto = UpdateDeviceInfoDto(); // UpdateDeviceInfoDto | 

try {
    final result = api_instance.updateDeviceInfo(updateDeviceInfoDto);
    print(result);
} catch (e) {
    print('Exception when calling DeviceInfoApi->updateDeviceInfo: $e\n');
}

Parameters

Name Type Description Notes
updateDeviceInfoDto UpdateDeviceInfoDto

Return type

DeviceInfoResponseDto

Authorization

bearer

HTTP request headers

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

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