Skip to content

Latest commit

 

History

History
163 lines (131 loc) · 7.04 KB

README.md

File metadata and controls

163 lines (131 loc) · 7.04 KB
Raw

kabalist_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: 0.1.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  kabalist_client:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  kabalist_client:
    path: /path/to/kabalist_client

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:kabalist_client/api.dart';

// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = AccountApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Account ID

try {
    final result = api_instance.getAccountName(id);
    print(result);
} catch (e) {
    print('Exception when calling AccountApi->getAccountName: $e\n');
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccountApi getAccountName GET /api/account/{id}/name
AccountApi login POST /api/account/login Generate a JWT in order to use the other routes
AccountApi recoverPassword POST /api/account/recover/{id}
AccountApi recoveryInfo GET /api/account/recover/{id}
AccountApi register POST /api/account/register/{id}
CrateApi historySearch GET /api/history/{list}
CrateApi searchAccount GET /api/search/account/{name}
CrateApi searchList GET /api/search/list/{name}
ListApi addList POST /api/list/{id}
ListApi createList POST /api/list
ListApi deleteItem DELETE /api/list/{id}/{item}
ListApi deleteList DELETE /api/list/{id}
ListApi getPublicList GET /api/list/{id}/public
ListApi listLists GET /api/list
ListApi readList GET /api/list/{id}
ListApi removePublic DELETE /api/list/{id}/public
ListApi setPublic PUT /api/list/{id}/public
ListApi updateItem PATCH /api/list/{id}/{item}
PantryApi addToPantry POST /api/pantry/{id}
PantryApi deletePantryItem DELETE /api/pantry/{id}/{item}
PantryApi getPantry GET /api/pantry/{id}
PantryApi refillPantry POST /api/pantry/{id}/refill
PantryApi setPantryItem PATCH /api/pantry/{id}/{item}
ShareApi deleteShares DELETE /api/share/{id}
ShareApi getShares GET /api/share/{id}
ShareApi shareList PUT /api/share/{id}
ShareApi unshare DELETE /api/share/{id}/{account}

Documentation For Models

Documentation For Authorization

token

  • Type: HTTP Bearer authentication

Author