Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.09 KB

README.md

File metadata and controls

61 lines (40 loc) · 2.09 KB

fr.cashbee.ocarina.client - Kotlin client library for Ocarina API

Requires

  • Kotlin 1.3.31
  • Gradle 4.9

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

  • Supports JSON inputs/outputs, File inputs, and Form inputs.
  • Supports collection formats for query parameters: csv, tsv, ssv, pipes.
  • Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
  • Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.

Documentation for API Endpoints

All URIs are relative to https://api-hyrule.cashbee.io

Class Method HTTP request Description
DocumentsApi documentIdentification POST /documents
DocumentsApi documentIdentificationInfo GET /documents/{uuid}
DocumentsApi documentsDirectUpload POST /documents/direct_upload

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: HTTP basic authentication