knowgo 1.0.3 copy "knowgo: ^1.0.3" to clipboard
knowgo: ^1.0.3 copied to clipboard

KnowGo Platform REST API client

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

Class Method HTTP request Description
EventsApi addEvent POST /events Add a new Event
EventsApi deleteEvent DELETE /events/{eventId} Delete Event by ID
EventsApi getEventById GET /events/{eventId} Find Event by ID
EventsApi updateEventWithForm POST /events/{eventId} Updates an Event with form data
JourneysApi addClassificationToJourney POST /journeys/{journeyId}/classifications/{classificationId} Add a new Journey classification for a specific Journey
JourneysApi addJourney POST /journeys Add a new Journey
JourneysApi createJourneyClassification POST /journeys/classifications Create a Journey classification
JourneysApi deleteJourney DELETE /journeys/{journeyId} Delete Journey by ID
JourneysApi deleteJourneyClassification DELETE /journeys/classifications/{classificationId} Delete specified Journey classification
JourneysApi getJourneyById GET /journeys/{journeyId} Find journey by ID
JourneysApi getJourneyClassificationById GET /journeys/classifications/{classificationId} Get Journey classification by classification id
JourneysApi listJourneyClassifications GET /journeys/classifications Return a list of Journey classifications available for a specific user
JourneysApi listJourneyClassificationsByJourneyId GET /journeys/{journeyId}/classifications Return a list of Journey classifications for a specific Journey
JourneysApi listJourneys GET /journeys Return a list of journeys available for a specific user
JourneysApi listJourneysByUserId GET /users/{userId}/journeys Return a list of journeys available for a specific user
JourneysApi removeClassificationFromJourney DELETE /journeys/{journeyId}/classifications/{classificationId} Remove a specific classification from a Journey
JourneysApi updateJourneyClassificationById PUT /journeys/classifications/{classificationId} Update a specified Journey classification
JourneysApi updateJourneyWithForm POST /journeys/{journeyId} Updates a Journey with form data
ServerApi currentConfig GET /config Obtain configuration information about the current KnowGo instance
ServicesApi addService POST /services Register a new KnowGo platform service
ServicesApi deleteServiceEndpoint DELETE /services/{serviceName}/{endpoint} DELETE pass-through for service-specific endpoint
ServicesApi disableServiceByUserId DELETE /users/{userId}/services/{serviceName} Disable a service for a specific user
ServicesApi enableServiceByUserId POST /users/{userId}/services/{serviceName} Enable a service for a specific user
ServicesApi getServiceDefinition GET /services/{serviceName} Lookup the service definition for a specific service
ServicesApi getServiceEndpoint GET /services/{serviceName}/{endpoint} GET pass-through for service-specific endpoint
ServicesApi listServices GET /services Return a list of available KnowGo platform services
ServicesApi listServicesByUserId GET /users/{userId}/services Return a list of services for a specific user
ServicesApi postServiceEndpoint POST /services/{serviceName}/{endpoint} POST pass-through for service-specific endpoint
ServicesApi removeServiceDefinition DELETE /services/{serviceName} Deregister a KnowGo platform service
ServicesApi updateServiceDefinition PUT /services/{serviceName} Update the service definition for a specific service
ServicesApi updateServiceEndpoint PUT /services/{serviceName}/{endpoint} PUT pass-through for service-specific endpoint
UsersApi confirmUserPasswordChangeByRecovery POST /users/password/confirm Confirm the change in user password via the recovery mechanism
UsersApi createUser POST /users Create user
UsersApi deleteUser DELETE /users/{userId} Delete user
UsersApi disableServiceByUserId DELETE /users/{userId}/services/{serviceName} Disable a service for a specific user
UsersApi enableServiceByUserId POST /users/{userId}/services/{serviceName} Enable a service for a specific user
UsersApi exportUser GET /users/{userId}/export Exports all data about current user in CSV format
UsersApi getUserById GET /users/{userId} Get user by user id
UsersApi listJourneysByUserId GET /users/{userId}/journeys Return a list of journeys available for a specific user
UsersApi listServicesByUserId GET /users/{userId}/services Return a list of services for a specific user
UsersApi listVehiclesByUserId GET /users/{userId}/vehicles Return a list of vehicles available for a specific user
UsersApi loginUser POST /users/login Logs user into the system and returns an authentication token.
UsersApi logoutUser GET /users/logout Logs out current logged in user session
UsersApi recoverUserPassword POST /users/password/recover Initiaties a password recovery operation for the designated user.
UsersApi refreshToken GET /users/refresh Refreshes the session token for a logged-in user
UsersApi updateUser PUT /users/{userId} Updated user
VehiclesApi addAuto POST /autos Add a new auto
VehiclesApi deleteAuto DELETE /autos/{autoId} Deletes an Auto
VehiclesApi getAutoById GET /autos/{autoId} Find auto by ID
VehiclesApi listVehicles GET /vehicles Return a list of vehicles available for a specific user
VehiclesApi listVehiclesByUserId GET /users/{userId}/vehicles Return a list of vehicles available for a specific user
VehiclesApi updateAuto PUT /autos Update an existing auto
VehiclesApi updateAutoWithForm POST /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

0
likes
20
pub points
0%
popularity

Publisher

verified publisheradaptant.io

KnowGo Platform REST API client

Repository (GitHub)
View/report issues

License

Apache-2.0 (license)

Dependencies

http

More

Packages that depend on knowgo