Files
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
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]>
2026-07-25 07:10:32 -07:00

6.1 KiB

DocdbApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
provisioningCreateDocdb POST /v1/docdb Provision a document-database resource (dedicated per-org instance)
provisioningDeleteDocdb DELETE /v1/docdb/{name} Deprovision a document-database instance
provisioningGetDocdb GET /v1/docdb/{name} Get one document-database resource (reconciles live instance status)
provisioningListDocdb GET /v1/docdb List document-database resources for the caller's org

provisioningCreateDocdb

ProvisioningCreateResponse provisioningCreateDocdb(provisioningCreateRequest)

Provision a document-database resource (dedicated per-org instance)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DocdbApi()
val provisioningCreateRequest : ProvisioningCreateRequest =  // ProvisioningCreateRequest | 
try {
    val result : ProvisioningCreateResponse = apiInstance.provisioningCreateDocdb(provisioningCreateRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DocdbApi#provisioningCreateDocdb")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DocdbApi#provisioningCreateDocdb")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
provisioningCreateRequest ProvisioningCreateRequest

Return type

ProvisioningCreateResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

provisioningDeleteDocdb

provisioningDeleteDocdb(name)

Deprovision a document-database instance

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DocdbApi()
val name : kotlin.String = name_example // kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$`. 
try {
    apiInstance.provisioningDeleteDocdb(name)
} catch (e: ClientException) {
    println("4xx response calling DocdbApi#provisioningDeleteDocdb")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DocdbApi#provisioningDeleteDocdb")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
name kotlin.String The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^a-z0-9?$`.

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

provisioningGetDocdb

ProvisioningGetResponse provisioningGetDocdb(name)

Get one document-database resource (reconciles live instance status)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DocdbApi()
val name : kotlin.String = name_example // kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$`. 
try {
    val result : ProvisioningGetResponse = apiInstance.provisioningGetDocdb(name)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DocdbApi#provisioningGetDocdb")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DocdbApi#provisioningGetDocdb")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
name kotlin.String The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^a-z0-9?$`.

Return type

ProvisioningGetResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

provisioningListDocdb

kotlin.collections.List<ProvisioningListItem> provisioningListDocdb()

List document-database resources for the caller's org

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = DocdbApi()
try {
    val result : kotlin.collections.List<ProvisioningListItem> = apiInstance.provisioningListDocdb()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling DocdbApi#provisioningListDocdb")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling DocdbApi#provisioningListDocdb")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<ProvisioningListItem>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json