lb_core 1.2.1

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

ClassMethodHTTP requestDescription
InfoApigetInfoGET /infoInfo about service
IotsApiaddIotPOST /iots/{token}Registers a new IoT
IotsApigetIotGET /iots/{token}Returns the active configuration of an IoT
IotsApilistIoTsGET /iotsList all IoTs of an OEM
IotsApitransferHttpConfigPOST /iots/{token}/transferHttpConfigTransfers HTTP configuration
IotsApitransferModbustcpConfigPOST /iots/{token}/transferModbustcpConfigTransfers Modbus TCP configuration
IotsApitransferOpcuaConfigPOST /iots/{token}/transferOpcuaConfigTransfers Opcua configuration
IotsApitransferS7ConfigPOST /iots/{token}/transferS7ConfigTransfers S7 configuration
IotsApiupdateIotPATCH /iots/{token}
OrganizationApigetOrganizationGET /orgOrganization info
OrganizationApiupdateOrganizationPUT /orgUpdates organization info
RelationshipsApiassociateDevicesToUserPOST /relationships/user/{userId}/iotsAssociates one or more devices to the given user
RelationshipsApiassociateUsersToDevicePOST /relationships/iot/{token}/usersAssociates one or more devices to the given user
RelationshipsApidissociateDevicesFromUserDELETE /relationships/user/{userId}/iotsRemoves one or more devices from the given user
RelationshipsApidissociateUsersFromDeviceDELETE /relationships/iot/{token}/usersRemoves one or more devices from the given user
RelationshipsApilistDeviceAssociatedUsersGET /relationships/iot/{token}/usersGet the users associated with the given device
RelationshipsApilistUserAssociatedDevicesGET /relationships/user/{userId}/iotsGet the devices associated with the given user
SecurityApigetUserLogsGET /security/logs/{username}User activity logs
ServicesApilistIotServicesGET /services/iots/{token}Returns the services for an IoT
ServicesApiupdateIotServicesPATCH /services/iots/{token}Updates services
UsersApicreateUserPOST /users/{username}Creates a new user
UsersApideleteUserDELETE /users/{username}Deletes user
UsersApilistUsersGET /usersReturns the list of all users registered for that OEM
UsersApiregisterEditorPUT /registereditorRegisters the editor
UsersApiupdateUserPUT /users/{username}Updates user

Documentation For Models

Author

Logbot SRL info@logbot.cloud