self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-21 01:39:59 +02:00
Code Issues Releases Activity
9edbff0ec0
immich/mobile/openapi/doc/DeviceInfoApi.md
Jason Rasmussen cefdd86b7f
refactor(server): device info service (#1071) 
* refactor(server): device info service

* use upsertDeviceInfo in mobile app

* fix: return types and dedupe code

Co-authored-by: Fynn Petersen-Frey <zoodyy@users.noreply.github.com>
2022-12-08 09:57:07 -06:00

4.7 KiB
Generated
Raw Blame History

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
upsertDeviceInfo PUT /device-info

createDeviceInfo

DeviceInfoResponseDto createDeviceInfo(upsertDeviceInfoDto)

@deprecated

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 upsertDeviceInfoDto = UpsertDeviceInfoDto(); // UpsertDeviceInfoDto | 

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

Parameters

Name Type Description Notes
upsertDeviceInfoDto UpsertDeviceInfoDto

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(upsertDeviceInfoDto)

@deprecated

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 upsertDeviceInfoDto = UpsertDeviceInfoDto(); // UpsertDeviceInfoDto | 

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

Parameters

Name Type Description Notes
upsertDeviceInfoDto UpsertDeviceInfoDto

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]

upsertDeviceInfo

DeviceInfoResponseDto upsertDeviceInfo(upsertDeviceInfoDto)

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 upsertDeviceInfoDto = UpsertDeviceInfoDto(); // UpsertDeviceInfoDto | 

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

Parameters

Name Type Description Notes
upsertDeviceInfoDto UpsertDeviceInfoDto

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]