time_periods library

The v4 time periods family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/time_periods.dart' as time_periods;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

SettingsTimePeriod

The settings time period body, under time_period.

SettingsTimePeriodList

One page of SettingsTimePeriod records, under data.

TimePeriodsResource

The time periods endpoints with client already applied.

TimePeriodsUrls

Functions

createSettingsTimePeriod(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimePeriod>>

POST /api/{api_version}/settings/time_periods

deleteSettingsTimePeriod(ExsitedClient client, Object timePeriodId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/settings/time_periods/{time_period_id}

getSettingsTimePeriod(ExsitedClient client, Object timePeriodId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimePeriod>>

GET /api/{api_version}/settings/time_periods/{time_period_id}

getSettingsTimePeriods(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimePeriodList>>

GET /api/{api_version}/settings/time_periods

updateSettingsTimePeriod(ExsitedClient client, Object timePeriodId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsTimePeriod>>

PATCH /api/{api_version}/settings/time_periods/{time_period_id}