No description
| .openapi-generator | ||
| doc | ||
| lib | ||
| test | ||
| .gitignore | ||
| .openapi-generator-ignore | ||
| analysis_options.yaml | ||
| pubspec.yaml | ||
| README.md | ||
tuuli_api (EXPERIMENTAL)
Tuuli API for Tuuli frontend
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
Requirements
- Dart 2.15.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
Installation & Usage
pub.dev
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
tuuli_api: 1.0.0
Github
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
tuuli_api:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
Local development
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
tuuli_api:
path: /path/to/tuuli_api
Getting Started
Please follow the installation procedure and then run the following:
import 'package:tuuli_api/tuuli_api.dart';
final api = TuuliApi().getDefaultApi();
final String tableName = tableName_example; // String |
final JsonObject body = Object; // JsonObject |
final String accessToken = accessToken_example; // String |
try {
final response = await api.createItemItemsTableNamePost(tableName, body, accessToken);
print(response);
} catch on DioError (e) {
print("Exception when calling DefaultApi->createItemItemsTableNamePost: $e\n");
}
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | createItemItemsTableNamePost | POST /items/{tableName}/+ | Create Item |
| DefaultApi | createTableApiCreateTableTableNamePost | POST /api/createTable/{tableName} | Create Table |
| DefaultApi | createUserApiUsersPost | POST /api/users/+ | Create User |
| DefaultApi | deleteItemFromTableItemsTableNamePost | POST /items/{tableName}/- | Delete Item From Table |
| DefaultApi | dropTableApiDropTableTableNamePost | POST /api/dropTable/{tableName} | Drop Table |
| DefaultApi | getAccessTokenApiGetAccessTokenPost | POST /api/getAccessToken | Get Access Token |
| DefaultApi | getAssetAssetsFidGet | GET /assets/{fid} | Get Asset |
| DefaultApi | getItemsFromTableItemsTableNamePost | POST /items/{tableName} | Get Items From Table |
| DefaultApi | listTablesApiListTablesGet | GET /api/listTables | List Tables |
| DefaultApi | putAssetAssetsPost | POST /assets/+ | Put Asset |
| DefaultApi | removeAssetAssetsAssetIdPost | POST /assets/{asset_id}/- | Remove Asset |
| DefaultApi | removeUserApiUsersPost | POST /api/users/- | Remove User |
| DefaultApi | updateAssetDescriptionAssetsAssetIdPost | POST /assets/{asset_id}/* | Update Asset Description |
| DefaultApi | updateItemInTableItemsTableNamePost | POST /items/{tableName}/* | Update Item In Table |
| DefaultApi | updateUserApiUsersPost | POST /api/users/* | Update User |
Documentation For Models
- AccessTokenResponse
- AuthModel
- BodyUpdateItemInTableItemsTableNamePost
- ColumnConditionCompat
- CreateAssetResponse
- CreateUserDefinition
- ErrorResponse
- HTTPValidationError
- ItemsFieldSelectorList
- LocationInner
- OkResponse
- TableDefinition
- TableItemsResponse
- UserUpdateDefinition
- ValidationError
Documentation For Authorization
All endpoints do not require authorization.