Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and Android. Generated with openapi-generator kotlin (library=jvm-okhttp4, useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai. Co-authored-by: Hanzo Dev <[email protected]>
8.0 KiB
DocTypesApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| frameworkCreateDocType | POST /v1/framework/doctypes | Define a DocType |
| frameworkDeleteDocType | DELETE /v1/framework/doctypes/{name} | Delete a DocType (and its documents) |
| frameworkFrameworkSummary | GET /v1/framework/summary | Org summary (doctype + document counts) |
| frameworkGetDocType | GET /v1/framework/doctypes/{name} | Get a DocType definition |
| frameworkListDocTypes | GET /v1/framework/doctypes | List DocType definitions |
| frameworkReplaceDocType | PUT /v1/framework/doctypes/{name} | Replace a DocType definition |
frameworkCreateDocType
FrameworkDocType frameworkCreateDocType(frameworkDocType)
Define a DocType
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DocTypesApi()
val frameworkDocType : FrameworkDocType = // FrameworkDocType |
try {
val result : FrameworkDocType = apiInstance.frameworkCreateDocType(frameworkDocType)
println(result)
} catch (e: ClientException) {
println("4xx response calling DocTypesApi#frameworkCreateDocType")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DocTypesApi#frameworkCreateDocType")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| frameworkDocType | FrameworkDocType |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
frameworkDeleteDocType
frameworkDeleteDocType(name)
Delete a DocType (and its documents)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DocTypesApi()
val name : kotlin.String = name_example // kotlin.String |
try {
apiInstance.frameworkDeleteDocType(name)
} catch (e: ClientException) {
println("4xx response calling DocTypesApi#frameworkDeleteDocType")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DocTypesApi#frameworkDeleteDocType")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | kotlin.String |
Return type
null (empty response body)
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
frameworkFrameworkSummary
FrameworkFrameworkSummary200Response frameworkFrameworkSummary()
Org summary (doctype + document counts)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DocTypesApi()
try {
val result : FrameworkFrameworkSummary200Response = apiInstance.frameworkFrameworkSummary()
println(result)
} catch (e: ClientException) {
println("4xx response calling DocTypesApi#frameworkFrameworkSummary")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DocTypesApi#frameworkFrameworkSummary")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
FrameworkFrameworkSummary200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
frameworkGetDocType
FrameworkDocType frameworkGetDocType(name)
Get a DocType definition
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DocTypesApi()
val name : kotlin.String = name_example // kotlin.String |
try {
val result : FrameworkDocType = apiInstance.frameworkGetDocType(name)
println(result)
} catch (e: ClientException) {
println("4xx response calling DocTypesApi#frameworkGetDocType")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DocTypesApi#frameworkGetDocType")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
frameworkListDocTypes
FrameworkListDocTypes200Response frameworkListDocTypes()
List DocType definitions
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DocTypesApi()
try {
val result : FrameworkListDocTypes200Response = apiInstance.frameworkListDocTypes()
println(result)
} catch (e: ClientException) {
println("4xx response calling DocTypesApi#frameworkListDocTypes")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DocTypesApi#frameworkListDocTypes")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
FrameworkListDocTypes200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
frameworkReplaceDocType
FrameworkDocType frameworkReplaceDocType(name, frameworkDocType)
Replace a DocType definition
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = DocTypesApi()
val name : kotlin.String = name_example // kotlin.String |
val frameworkDocType : FrameworkDocType = // FrameworkDocType |
try {
val result : FrameworkDocType = apiInstance.frameworkReplaceDocType(name, frameworkDocType)
println(result)
} catch (e: ClientException) {
println("4xx response calling DocTypesApi#frameworkReplaceDocType")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling DocTypesApi#frameworkReplaceDocType")
e.printStackTrace()
}
Parameters
| name | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| frameworkDocType | FrameworkDocType |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json