mirror of
https://github.com/hanzo-kt/sdk.git
synced 2026-10-30 20:43:57 +00:00
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]>
4.2 KiB
4.2 KiB
ModulesApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| frameworkGetModule | GET /v1/framework/modules/{module} | Inspect a module and its install state in this org |
| frameworkInstallModule | POST /v1/framework/modules/{module}/install | Install a module's DocType fixtures into this org (idempotent) |
| frameworkListModules | GET /v1/framework/modules | List registered app-lane modules |
frameworkGetModule
FrameworkGetModule200Response frameworkGetModule(module)
Inspect a module and its install state in this org
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ModulesApi()
val module : kotlin.String = module_example // kotlin.String |
try {
val result : FrameworkGetModule200Response = apiInstance.frameworkGetModule(module)
println(result)
} catch (e: ClientException) {
println("4xx response calling ModulesApi#frameworkGetModule")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ModulesApi#frameworkGetModule")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| module | 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
frameworkInstallModule
FrameworkInstallModule200Response frameworkInstallModule(module)
Install a module's DocType fixtures into this org (idempotent)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ModulesApi()
val module : kotlin.String = module_example // kotlin.String |
try {
val result : FrameworkInstallModule200Response = apiInstance.frameworkInstallModule(module)
println(result)
} catch (e: ClientException) {
println("4xx response calling ModulesApi#frameworkInstallModule")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ModulesApi#frameworkInstallModule")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| module | kotlin.String |
Return type
FrameworkInstallModule200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
frameworkListModules
FrameworkListModules200Response frameworkListModules()
List registered app-lane modules
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ModulesApi()
try {
val result : FrameworkListModules200Response = apiInstance.frameworkListModules()
println(result)
} catch (e: ClientException) {
println("4xx response calling ModulesApi#frameworkListModules")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ModulesApi#frameworkListModules")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
FrameworkListModules200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json