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.5 KiB

FormsApi

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

Method HTTP request Description
commerceCreateForm POST /v1/commerce/form Create form
commerceGetForm GET /v1/commerce/form/{formid} Get form
commerceListForms GET /v1/commerce/form List forms
commerceSubmitForm POST /v1/commerce/form/{formid}/submit Submit form
commerceSubscribeForm POST /v1/commerce/form/{formid}/subscribe Subscribe via form

commerceCreateForm

CommerceForm commerceCreateForm(commerceForm)

Create form

Example

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

val apiInstance = FormsApi()
val commerceForm : CommerceForm =  // CommerceForm | 
try {
    val result : CommerceForm = apiInstance.commerceCreateForm(commerceForm)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormsApi#commerceCreateForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormsApi#commerceCreateForm")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
commerceForm CommerceForm

Return type

CommerceForm

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

commerceGetForm

CommerceForm commerceGetForm(formid)

Get form

Example

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

val apiInstance = FormsApi()
val formid : kotlin.String = formid_example // kotlin.String | 
try {
    val result : CommerceForm = apiInstance.commerceGetForm(formid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormsApi#commerceGetForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormsApi#commerceGetForm")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
formid kotlin.String

Return type

CommerceForm

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

commerceListForms

CommercePaginatedForms commerceListForms()

List forms

Example

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

val apiInstance = FormsApi()
try {
    val result : CommercePaginatedForms = apiInstance.commerceListForms()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormsApi#commerceListForms")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormsApi#commerceListForms")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

CommercePaginatedForms

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

commerceSubmitForm

kotlin.Any commerceSubmitForm(formid, requestBody)

Submit form

Example

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

val apiInstance = FormsApi()
val formid : kotlin.String = formid_example // kotlin.String | 
val requestBody : kotlin.collections.Map<kotlin.String, kotlin.Any> = Object // kotlin.collections.Map<kotlin.String, kotlin.Any> | 
try {
    val result : kotlin.Any = apiInstance.commerceSubmitForm(formid, requestBody)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormsApi#commerceSubmitForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormsApi#commerceSubmitForm")
    e.printStackTrace()
}

Parameters

| formid | kotlin.String| | |

Name Type Description Notes
requestBody kotlin.collections.Map<kotlin.String, kotlin.Any>

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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

commerceSubscribeForm

kotlin.Any commerceSubscribeForm(formid, commerceSubscribeFormRequest)

Subscribe via form

Example

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

val apiInstance = FormsApi()
val formid : kotlin.String = formid_example // kotlin.String | 
val commerceSubscribeFormRequest : CommerceSubscribeFormRequest =  // CommerceSubscribeFormRequest | 
try {
    val result : kotlin.Any = apiInstance.commerceSubscribeForm(formid, commerceSubscribeFormRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling FormsApi#commerceSubscribeForm")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling FormsApi#commerceSubscribeForm")
    e.printStackTrace()
}

Parameters

| formid | kotlin.String| | |

Name Type Description Notes
commerceSubscribeFormRequest CommerceSubscribeFormRequest

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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