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

• fr.cashbee.ocarina.client.models.DirectUploadRequest
• fr.cashbee.ocarina.client.models.DirectUploadResponse
• fr.cashbee.ocarina.client.models.DocumentIdentificationInfo
• fr.cashbee.ocarina.client.models.DocumentIdentificationInfoMetadata
• fr.cashbee.ocarina.client.models.DocumentIdentificationResponse
• fr.cashbee.ocarina.client.models.DocumentsIdentificationRequest

Documentation for Authorization

bearerAuth

• Type: HTTP basic authentication