operator_groups library

The v4 operator groups family: its endpoints, bound class, path templates and views.

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

Classes

OperatorGroupsResource

The operator groups endpoints with client already applied.

OperatorGroupsUrls

SettingsOperatorGroup

The operator group body, under operator_group. The create answer carries only object, id, name, display_name, description and href.

SettingsOperatorGroupDepartment

One of a SettingsOperatorGroup's departments, a reference; id is null on the departments the instance ships with.

SettingsOperatorGroupList

One page of SettingsOperatorGroup records, under data.

SettingsOperatorGroupRole

A SettingsOperatorGroup's role. A read names it as a role with its rol_ id and href; the update answer names it as a reference with the dashed uuid and no href.

Functions

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

POST /api/{api_version}/settings/operator_groups

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

DELETE /api/{api_version}/settings/operator_groups/{operator_group_id}

getSettingsOperatorGroup(ExsitedClient client, Object operatorGroupId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsOperatorGroup>>

GET /api/{api_version}/settings/operator_groups/{operator_group_id}

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

GET /api/{api_version}/settings/operator_groups

updateSettingsOperatorGroup(ExsitedClient client, Object operatorGroupId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsOperatorGroup>>

PATCH /api/{api_version}/settings/operator_groups/{operator_group_id}