custom_components library

The v4 custom components family: its endpoints, bound class, path templates and views.

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

Classes

Component: The component body.
ComponentByUuid: The component by uuid body.
ComponentByUuidActivityLog: One entry of a ComponentByUuid's activity_logs.
ComponentByUuidAttribute: One entry of a ComponentByUuid's attributes.
ComponentByUuidCustomForm: A ComponentByUuid's custom_form.
ComponentByUuidParent: One entry of a ComponentByUuid's parents.
ComponentCustomForm: One entry of a Component's custom_forms.
ComponentCustomFormData: A ComponentCustomForm's data.
ComponentCustomFormDataFirstColumnAttribute: One entry of a ComponentCustomFormData's firstColumnAttribute.
ComponentCustomFormDataFirstColumnAttributeOption: One entry of a ComponentCustomFormDataFirstColumnAttribute's options.
ComponentCustomFormDataSecondColumnAttribute: One entry of a ComponentCustomFormData's secondColumnAttribute.
ComponentCustomFormDataSecondColumnAttributeTypeActual: A ComponentCustomFormDataSecondColumnAttribute's typeActual.
ComponentList: A page of Component records.
ComponentObject: The component object body.
ComponentObjectActivity: The component object activity body.
ComponentObjectActivityEntry: One component object activity, under custom_component_object_activity.
ComponentObjectComponent: A ComponentObject's component.
ComponentObjectCustomComponentObjectCustomForm: A ComponentObjectCustomComponentObject's custom_form.
ComponentObjectCustomComponentObjectDetail: A ComponentObjectCustomComponentObject's component.
ComponentObjectCustomComponentObjectParent: One entry of a ComponentObjectCustomComponentObject's parents.
ComponentObjectCustomForm: A ComponentObject's custom_form.
ComponentObjectCustomObjects: The component object custom objects body.
ComponentObjectNote: A component object's note, under note.
ComponentObjectNoteAttachment: One entry of a ComponentObjectNote's attachments; uuid is the file id.
ComponentObjectNoteCreatedBy: A ComponentObjectNote's created_by.
ComponentObjectNoteCustomComponentObject: A ComponentObjectNote's custom_component_object, the note's owner.
ComponentObjectNoteFile: One file of a note, under file.
ComponentObjectNoteFiles: A note's files, under data; its pagination carries has_more alone.
ComponentObjectNoteLastUpdatedBy: A ComponentObjectNote's last_updated_by, set once the note has been updated.
ComponentObjectNotes: One page of ComponentObjectNote records, under data.
ComponentObjectParent: One entry of a ComponentObject's parents.
ComponentObjectRecord: The component object body a v4 write answers, under custom_component_object: the fields a read nests there, with activity_logs beside them.
ComponentObjectRecordActivityLog: One entry of a ComponentObjectRecord's activity_logs.
ComponentObjects: The component objects body.
ComponentObjectsData: One entry of a ComponentObjects's data.
ComponentObjectsDataComponent: A ComponentObjectsData's component.
ComponentObjectsDataCustomForm: A ComponentObjectsData's custom_form.
ComponentObjectsDataDetail: A ComponentObjectsData's component.
ComponentObjectsDataParent: One entry of a ComponentObjectsData's parents.
CustomComponentsResource: The custom components endpoints with client already applied.
CustomComponentsUrls

Functions

changeComponentObjectStatus(ExsitedClient client, Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectRecord>>: POST /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/change_status
createComponent(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Component>>: POST /api/{api_version}/component
createComponentByUuid(ExsitedClient client, Object componentUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentByUuid>>: POST /api/{api_version}/component/{component_uuid}
createComponentObject(ExsitedClient client, Object componentUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectRecord>>: POST /api/{api_version}/components/{component_uuid}/objects
createComponentObjectActivity(ExsitedClient client, Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectActivityEntry>>: POST /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/activity
createComponentObjectCustomObjectInstance(ExsitedClient client, Object componentUuid, Object componentObjectId, Object customObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: POST /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}
createComponentObjectNote(ExsitedClient client, Object componentUuid, Object componentObjectId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectNote>>: POST /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes
deleteComponent(ExsitedClient client, Object componentUuid, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/component/{component_uuid}
deleteComponentById(ExsitedClient client, Object componentUuid, Object componentObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/component/{component_uuid}/{component_object_id}
deleteComponentObject(ExsitedClient client, Object componentUuid, Object componentObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/components/{component_uuid}/objects/{component_object_id}
deleteComponentObjectCustomObjectInstance(ExsitedClient client, Object componentUuid, Object componentObjectId, Object customObjectId, Object instanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}/instances/{instance_id}
deleteComponentObjectNote(ExsitedClient client, Object componentUuid, Object componentObjectId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes/{note_id}
deleteComponentObjectNoteFile(ExsitedClient client, Object componentUuid, Object componentObjectId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes/{note_id}/files/{file_id}
getComponent(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentList>>: GET /api/{api_version}/component
getComponentByUuid(ExsitedClient client, Object componentUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Component>>: GET /api/{api_version}/component/{component_uuid}
getComponentObject(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObject>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}
getComponentObjectActivity(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectActivity>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/activity
getComponentObjectActivityById(ExsitedClient client, Object componentUuid, Object componentObjectId, Object activityId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectActivityEntry>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/activity/{activity_id}
getComponentObjectCustomObject(ExsitedClient client, Object componentUuid, Object componentObjectId, Object customObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}
getComponentObjectCustomObjectInstance(ExsitedClient client, Object componentUuid, Object componentObjectId, Object customObjectId, Object instanceId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}/instances/{instance_id}
getComponentObjectCustomObjects(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectCustomObjects>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/custom_objects
getComponentObjectHistory(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/history
getComponentObjectHistoryById(ExsitedClient client, Object componentUuid, Object componentObjectId, Object historyId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/history/{history_id}
getComponentObjectMilestone(ExsitedClient client, Object componentUuid, Object componentObjectId, Object milestoneId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/milestones/{milestone_id}
getComponentObjectMilestones(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/milestones
getComponentObjectNote(ExsitedClient client, Object componentUuid, Object componentObjectId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectNote>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes/{note_id}
getComponentObjectNoteFile(ExsitedClient client, Object componentUuid, Object componentObjectId, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectNoteFile>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes/{note_id}/files/{file_id}
getComponentObjectNoteFiles(ExsitedClient client, Object componentUuid, Object componentObjectId, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectNoteFiles>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes/{note_id}/files
getComponentObjectNotes(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectNotes>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes
getComponentObjectPdf(ExsitedClient client, Object componentUuid, Object componentObjectId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: GET /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/pdf
getComponentObjects(ExsitedClient client, Object componentUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjects>>: GET /api/{api_version}/components/{component_uuid}/objects
linkComponentObjectDomains(ExsitedClient client, Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectRecord>>: POST /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/link_domains
unlinkComponentObjectDomains(ExsitedClient client, Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectRecord>>: POST /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/unlink_domains
updateComponent(ExsitedClient client, Object componentUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Component>>: PATCH /api/{api_version}/component/{component_uuid}
updateComponentById(ExsitedClient client, Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentByUuid>>: PATCH /api/{api_version}/component/{component_uuid}/{component_object_id}
updateComponentObject(ExsitedClient client, Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectRecord>>: PATCH /api/{api_version}/components/{component_uuid}/objects/{component_object_id}
updateComponentObjectCustomObjectInstance(ExsitedClient client, Object componentUuid, Object componentObjectId, Object customObjectId, Object instanceId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: PATCH /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/custom_objects/{custom_object_id}/instances/{instance_id}
updateComponentObjectDomains(ExsitedClient client, Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectRecord>>: PATCH /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/link_domains
updateComponentObjectNote(ExsitedClient client, Object componentUuid, Object componentObjectId, Object noteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectNote>>: PATCH /api/{api_version}/components/{component_uuid}/objects/{component_object_id}/notes/{note_id}

custom_components library

Classes

Functions

exsited package

custom_components library