CustomComponentsResource class

The custom components endpoints with client already applied.

Constructors

CustomComponentsResource(ExsitedClient client): Bind the resource to a client; normally reached via client.customComponents.
const

Properties

client → ExsitedClient: The client every call below is made through.
final
hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

changeComponentObjectStatus(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(Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Component>>: POST /api/{api_version}/component
createComponentByUuid(Object componentUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentByUuid>>: POST /api/{api_version}/component/{component_uuid}
createComponentObject(Object componentUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjectRecord>>: POST /api/{api_version}/components/{component_uuid}/objects
createComponentObjectActivity(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(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(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(Object componentUuid, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/component/{component_uuid}
deleteComponentById(Object componentUuid, Object componentObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/component/{component_uuid}/{component_object_id}
deleteComponentObject(Object componentUuid, Object componentObjectId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>: DELETE /api/{api_version}/components/{component_uuid}/objects/{component_object_id}
deleteComponentObjectCustomObjectInstance(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(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(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({Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentList>>: GET /api/{api_version}/component
getComponentByUuid(Object componentUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Component>>: GET /api/{api_version}/component/{component_uuid}
getComponentObject(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(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(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(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(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(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(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(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(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(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(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(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(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(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(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(Object componentUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentObjects>>: GET /api/{api_version}/components/{component_uuid}/objects
linkComponentObjectDomains(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
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited
unlinkComponentObjectDomains(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(Object componentUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Component>>: PATCH /api/{api_version}/component/{component_uuid}
updateComponentById(Object componentUuid, Object componentObjectId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ComponentByUuid>>: PATCH /api/{api_version}/component/{component_uuid}/{component_object_id}
updateComponentObject(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(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(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(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}

Operators

operator ==(Object other) → bool: The equality operator.
inherited

CustomComponentsResource class

Constructors

Properties

Methods

Operators

custom_components library