external_databases library

The v4 external databases family: its endpoints, bound class, path templates and views.

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

Classes

ExternalDatabaseInsertRecord

What createExternalDatabaseInsertRecord answers, under external_database.

ExternalDatabases

The external databases body.

ExternalDatabaseSearch

What createExternalDatabaseSearch answers, under external_database.

ExternalDatabasesResource

The external databases endpoints with client already applied.

ExternalDatabasesUrls

ExternalDatabasesView

What createExternalDatabase answers, under external_database.

ExternalDatabaseTableList

One page of what getExternalDatabaseTable lists, under data.

ExternalDatabaseUpdateRecordsUpdated

What updateExternalDatabaseUpdateRecords answers, under external_database.

Functions

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

POST /api/{api_version}/external_databases

createExternalDatabaseInsertRecord(ExsitedClient client, Object dbName, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ExternalDatabaseInsertRecord>>

POST /api/{api_version}/external_databases/{db_name}/insert_records

createExternalDatabaseSearch(ExsitedClient client, Object dbName, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ExternalDatabaseSearch>>

POST /api/{api_version}/external_databases/{db_name}/search

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

GET /api/{api_version}/external_databases/{db_name}

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

GET /api/{api_version}/external_databases

getExternalDatabaseTable(ExsitedClient client, Object dbName, Object tableName, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ExternalDatabaseTableList>>

GET /api/{api_version}/external_databases/{db_name}/tables/{table_name}

updateExternalDatabaseUpdateRecords(ExsitedClient client, Object dbName, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<ExternalDatabaseUpdateRecordsUpdated>>

PATCH /api/{api_version}/external_databases/{db_name}/update_records