Files
sdk/docs/CompaniesApi.md
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

CompaniesApi

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

Method HTTP request Description
crmCreateCompany POST /v1/crm/companies Create a company
crmDeleteCompany DELETE /v1/crm/companies/{id} Delete a company (clears dangling contact/opportunity refs)
crmGetCompany GET /v1/crm/companies/{id} Company detail
crmListCompanies GET /v1/crm/companies List companies
crmUpdateCompany PUT /v1/crm/companies/{id} Update a company

crmCreateCompany

CrmCompany crmCreateCompany(crmCompanyInput)

Create a company

Example

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

val apiInstance = CompaniesApi()
val crmCompanyInput : CrmCompanyInput =  // CrmCompanyInput | 
try {
    val result : CrmCompany = apiInstance.crmCreateCompany(crmCompanyInput)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CompaniesApi#crmCreateCompany")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CompaniesApi#crmCreateCompany")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
crmCompanyInput CrmCompanyInput

Return type

CrmCompany

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

crmDeleteCompany

crmDeleteCompany(id)

Delete a company (clears dangling contact/opportunity refs)

Example

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

val apiInstance = CompaniesApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    apiInstance.crmDeleteCompany(id)
} catch (e: ClientException) {
    println("4xx response calling CompaniesApi#crmDeleteCompany")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CompaniesApi#crmDeleteCompany")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id 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

crmGetCompany

CrmCompany crmGetCompany(id)

Company detail

Example

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

val apiInstance = CompaniesApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    val result : CrmCompany = apiInstance.crmGetCompany(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CompaniesApi#crmGetCompany")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CompaniesApi#crmGetCompany")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String

Return type

CrmCompany

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

crmListCompanies

CrmListCompanies200Response crmListCompanies(limit)

List companies

Example

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

val apiInstance = CompaniesApi()
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : CrmListCompanies200Response = apiInstance.crmListCompanies(limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CompaniesApi#crmListCompanies")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CompaniesApi#crmListCompanies")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
limit kotlin.Int [optional] [default to 200]

Return type

CrmListCompanies200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

crmUpdateCompany

CrmCompany crmUpdateCompany(id, crmCompanyInput)

Update a company

Example

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

val apiInstance = CompaniesApi()
val id : kotlin.String = id_example // kotlin.String | 
val crmCompanyInput : CrmCompanyInput =  // CrmCompanyInput | 
try {
    val result : CrmCompany = apiInstance.crmUpdateCompany(id, crmCompanyInput)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CompaniesApi#crmUpdateCompany")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CompaniesApi#crmUpdateCompany")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
crmCompanyInput CrmCompanyInput

Return type

CrmCompany

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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