immich/mobile/openapi/doc/ScheduleApi.md

openapi.api.ScheduleApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to /api

Method	HTTP request	Description
createSchedule	POST /yucca/schedule
getSchedules	GET /yucca/schedule
removeSchedule	DELETE /yucca/schedule/{id}
updateSchedule	PATCH /yucca/schedule/{id}

createSchedule

ScheduleCreateResponseDto createSchedule(scheduleCreateRequestDto)

Example

import 'package:openapi/api.dart';

final api_instance = ScheduleApi();
final scheduleCreateRequestDto = ScheduleCreateRequestDto(); // ScheduleCreateRequestDto | 

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

Parameters

Name	Type	Description	Notes
scheduleCreateRequestDto	ScheduleCreateRequestDto

Return type

ScheduleCreateResponseDto

Authorization

No authorization required

HTTP request headers

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

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

getSchedules

ScheduleListResponseDto getSchedules()

Example

import 'package:openapi/api.dart';

final api_instance = ScheduleApi();

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

Parameters

This endpoint does not need any parameter.

Return type

ScheduleListResponseDto

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]

removeSchedule

removeSchedule(id)

Example

import 'package:openapi/api.dart';

final api_instance = ScheduleApi();
final id = id_example; // String | 

try {
    api_instance.removeSchedule(id);
} catch (e) {
    print('Exception when calling ScheduleApi->removeSchedule: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String

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]

updateSchedule

ScheduleUpdateResponseDto updateSchedule(id, scheduleUpdateRequestDto)

Example

import 'package:openapi/api.dart';

final api_instance = ScheduleApi();
final id = id_example; // String | 
final scheduleUpdateRequestDto = ScheduleUpdateRequestDto(); // ScheduleUpdateRequestDto | 

try {
    final result = api_instance.updateSchedule(id, scheduleUpdateRequestDto);
    print(result);
} catch (e) {
    print('Exception when calling ScheduleApi->updateSchedule: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String
scheduleUpdateRequestDto	ScheduleUpdateRequestDto

Return type

ScheduleUpdateResponseDto

Authorization

No authorization required

HTTP request headers

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

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