KnowGo API Client for Dart

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.3
  • Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://www.adaptant.io

Requirements

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

name: knowgo
version: 1.0.0
description: KnowGo API client
dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      version: 'any'

Local

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  knowgo:
    path: /path/to/knowgo-client-dart

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:knowgo/api.dart';

// TODO Configure API key authorization: app_id
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('app_id').apiKeyPrefix = 'Bearer';
// TODO Configure HTTP basic authorization: bearerAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearerAuth').password = 'YOUR_PASSWORD';
// TODO Configure API key authorization: cookieAuth
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookieAuth').apiKeyPrefix = 'Bearer';

var api_instance = EventsApi();
var event = Event(); // Event | Event object to operate on

try {
    var result = api_instance.addEvent(event);
    print(result);
} catch (e) {
    print("Exception when calling EventsApi->addEvent: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.adaptant.io/v1

ClassMethodHTTP requestDescription
EventsApiaddEventPOST /eventsAdd a new Event
EventsApideleteEventDELETE /events/{eventId}Delete Event by ID
EventsApigetEventByIdGET /events/{eventId}Find Event by ID
EventsApiupdateEventWithFormPOST /events/{eventId}Updates an Event with form data
JourneysApiaddClassificationToJourneyPOST /journeys/{journeyId}/classifications/{classificationId}Add a new Journey classification for a specific Journey
JourneysApiaddJourneyPOST /journeysAdd a new Journey
JourneysApicreateJourneyClassificationPOST /journeys/classificationsCreate a Journey classification
JourneysApideleteJourneyDELETE /journeys/{journeyId}Delete Journey by ID
JourneysApideleteJourneyClassificationDELETE /journeys/classifications/{classificationId}Delete specified Journey classification
JourneysApigetJourneyByIdGET /journeys/{journeyId}Find journey by ID
JourneysApigetJourneyClassificationByIdGET /journeys/classifications/{classificationId}Get Journey classification by classification id
JourneysApilistJourneyClassificationsGET /journeys/classificationsReturn a list of Journey classifications available for a specific user
JourneysApilistJourneyClassificationsByJourneyIdGET /journeys/{journeyId}/classificationsReturn a list of Journey classifications for a specific Journey
JourneysApilistJourneysGET /journeysReturn a list of journeys available for a specific user
JourneysApilistJourneysByUserIdGET /users/{userId}/journeysReturn a list of journeys available for a specific user
JourneysApiremoveClassificationFromJourneyDELETE /journeys/{journeyId}/classifications/{classificationId}Remove a specific classification from a Journey
JourneysApiupdateJourneyClassificationByIdPUT /journeys/classifications/{classificationId}Update a specified Journey classification
JourneysApiupdateJourneyWithFormPOST /journeys/{journeyId}Updates a Journey with form data
ServerApicurrentConfigGET /configObtain configuration information about the current KnowGo instance
ServicesApiaddServicePOST /servicesRegister a new KnowGo platform service
ServicesApideleteServiceEndpointDELETE /services/{serviceName}/{endpoint}DELETE pass-through for service-specific endpoint
ServicesApidisableServiceByUserIdDELETE /users/{userId}/services/{serviceName}Disable a service for a specific user
ServicesApienableServiceByUserIdPOST /users/{userId}/services/{serviceName}Enable a service for a specific user
ServicesApigetServiceDefinitionGET /services/{serviceName}Lookup the service definition for a specific service
ServicesApigetServiceEndpointGET /services/{serviceName}/{endpoint}GET pass-through for service-specific endpoint
ServicesApilistServicesGET /servicesReturn a list of available KnowGo platform services
ServicesApilistServicesByUserIdGET /users/{userId}/servicesReturn a list of services for a specific user
ServicesApipostServiceEndpointPOST /services/{serviceName}/{endpoint}POST pass-through for service-specific endpoint
ServicesApiremoveServiceDefinitionDELETE /services/{serviceName}Deregister a KnowGo platform service
ServicesApiupdateServiceDefinitionPUT /services/{serviceName}Update the service definition for a specific service
ServicesApiupdateServiceEndpointPUT /services/{serviceName}/{endpoint}PUT pass-through for service-specific endpoint
UsersApiconfirmUserPasswordChangeByRecoveryPOST /users/password/confirmConfirm the change in user password via the recovery mechanism
UsersApicreateUserPOST /usersCreate user
UsersApideleteUserDELETE /users/{userId}Delete user
UsersApidisableServiceByUserIdDELETE /users/{userId}/services/{serviceName}Disable a service for a specific user
UsersApienableServiceByUserIdPOST /users/{userId}/services/{serviceName}Enable a service for a specific user
UsersApiexportUserGET /users/{userId}/exportExports all data about current user in CSV format
UsersApigetUserByIdGET /users/{userId}Get user by user id
UsersApilistJourneysByUserIdGET /users/{userId}/journeysReturn a list of journeys available for a specific user
UsersApilistServicesByUserIdGET /users/{userId}/servicesReturn a list of services for a specific user
UsersApilistVehiclesByUserIdGET /users/{userId}/vehiclesReturn a list of vehicles available for a specific user
UsersApiloginUserPOST /users/loginLogs user into the system and returns an authentication token.
UsersApilogoutUserGET /users/logoutLogs out current logged in user session
UsersApirecoverUserPasswordPOST /users/password/recoverInitiaties a password recovery operation for the designated user.
UsersApirefreshTokenGET /users/refreshRefreshes the session token for a logged-in user
UsersApiupdateUserPUT /users/{userId}Updated user
VehiclesApiaddAutoPOST /autosAdd a new auto
VehiclesApideleteAutoDELETE /autos/{autoId}Deletes an Auto
VehiclesApigetAutoByIdGET /autos/{autoId}Find auto by ID
VehiclesApilistVehiclesGET /vehiclesReturn a list of vehicles available for a specific user
VehiclesApilistVehiclesByUserIdGET /users/{userId}/vehiclesReturn a list of vehicles available for a specific user
VehiclesApiupdateAutoPUT /autosUpdate an existing auto
VehiclesApiupdateAutoWithFormPOST /autos/{autoId}Updates an auto with form data

Documentation For Models

Documentation For Authorization

app_id

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

bearerAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: token
  • Location:

Author

labs@adaptant.io

Libraries

knowgo.api