lb_core 1.1.5 lb_core: ^1.1.5 copied to clipboard
Logbot Core client to be used for API requests to Logbot Core APIs for users management
Logbot Core SDK for Flutter #
This is a package that provides user management functionalities
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.1
- Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://logbot.cloud/
Requirements #
Dart 2.17 or later
Installation & Usage #
Add the dependencies from pub.dev:
dependencies:
lb_auth:
lb_core:
lb_auth
is always required to make authorized calls to the APIs.
To use the SDK on you application see the example below:
import 'package:lb_auth/lb_auth.dart';
import 'package:lb_core/lb_core.dart';
class Example {
Future<void> run() async {
/// Initialize Logbot SDK by logging in with Logbot Credentials
await LogbotAuth.init(LogbotCredentials(
username: username,
password: password,
clientId: clientId,
clientSecret: clientSecret,
));
/// Now you can use every API included on the SDK
/// for example:
List<User>? response = await LogbotCore.users.listUsers();
}
}
Tests #
To run all tests:
flutter test
Documentation for API Endpoints #
All URIs are relative to https://platform.logbotiot.cloud/lbcoreapi
Class | Method | HTTP request | Description |
---|---|---|---|
InfoApi | getInfo | GET /info | Info about service |
IotsApi | addIot | POST /iots/{token} | Registers a new IoT |
IotsApi | getIot | GET /iots/{token} | Returns the active configuration of an IoT |
IotsApi | listIoTs | GET /iots | List all IoTs of an OEM |
IotsApi | transferHttpConfig | POST /iots/{token}/transferHttpConfig | Transfers HTTP configuration |
IotsApi | transferModbustcpConfig | POST /iots/{token}/transferModbustcpConfig | Transfers Modbus TCP configuration |
IotsApi | transferOpcuaConfig | POST /iots/{token}/transferOpcuaConfig | Transfers Opcua configuration |
IotsApi | transferS7Config | POST /iots/{token}/transferS7Config | Transfers S7 configuration |
IotsApi | updateIot | PATCH /iots/{token} | |
OrganizationApi | getOrganization | GET /org | Organization info |
OrganizationApi | updateOrganization | PUT /org | Updates organization info |
RelationshipsApi | associateDevicesToUser | POST /relationships/user/{userId}/iots | Associates one or more devices to the given user |
RelationshipsApi | associateUsersToDevice | POST /relationships/iot/{token}/users | Associates one or more devices to the given user |
RelationshipsApi | dissociateDevicesFromUser | DELETE /relationships/user/{userId}/iots | Removes one or more devices from the given user |
RelationshipsApi | dissociateUsersFromDevice | DELETE /relationships/iot/{token}/users | Removes one or more devices from the given user |
RelationshipsApi | listDeviceAssociatedUsers | GET /relationships/iot/{token}/users | Get the users associated with the given device |
RelationshipsApi | listUserAssociatedDevices | GET /relationships/user/{userId}/iots | Get the devices associated with the given user |
SecurityApi | getUserLogs | GET /security/logs/{username} | User activity logs |
ServicesApi | listIotServices | GET /services/iots/{token} | Returns the services for an IoT |
ServicesApi | updateIotServices | PATCH /services/iots/{token} | Updates services |
UsersApi | createUser | POST /users/{username} | Creates a new user |
UsersApi | deleteUser | DELETE /users/{username} | Deletes user |
UsersApi | listUsers | GET /users | Returns the list of all users registered for that OEM |
UsersApi | registerEditor | PUT /registereditor | Registers the editor |
UsersApi | updateUser | PUT /users/{username} | Updates user |
Documentation For Models #
- Address
- DeviceRelationship
- GetInfoResponse
- GetIotResponse
- HttpConfig
- HttpConfigData
- HttpConfigPlc
- IoT
- IotRequestBody
- ListIotServicesResponse
- LogbotError
- Logs
- LogsDetails
- ModbusTcpConfig
- ModbusTcpConfigData
- ModbusTcpConfigPlc
- OpcuaConfig
- OpcuaConfigData
- OpcuaConfigPlc
- Organization
- RegisterEditorRequestBody
- S7Config
- S7ConfigData
- S7ConfigPlc
- Service
- ServiceRequestBody
- ServiceRequestBodyServicelistInner
- UpdateUserResponse
- User
- UserRelationship
- UserRequestBody
Author #
Logbot SRL info@logbot.cloud