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

7.1 KiB

OpportunitiesApi

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

Method HTTP request Description
crmCreateOpportunity POST /v1/crm/opportunities Create an opportunity
crmDeleteOpportunity DELETE /v1/crm/opportunities/{id} Delete an opportunity
crmGetOpportunity GET /v1/crm/opportunities/{id} Opportunity detail
crmListOpportunities GET /v1/crm/opportunities List opportunities
crmUpdateOpportunity PUT /v1/crm/opportunities/{id} Update an opportunity

crmCreateOpportunity

CrmOpportunity crmCreateOpportunity(crmOpportunityInput)

Create an opportunity

Example

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

val apiInstance = OpportunitiesApi()
val crmOpportunityInput : CrmOpportunityInput =  // CrmOpportunityInput | 
try {
    val result : CrmOpportunity = apiInstance.crmCreateOpportunity(crmOpportunityInput)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OpportunitiesApi#crmCreateOpportunity")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OpportunitiesApi#crmCreateOpportunity")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
crmOpportunityInput CrmOpportunityInput

Return type

CrmOpportunity

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

crmDeleteOpportunity

crmDeleteOpportunity(id)

Delete an opportunity

Example

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

val apiInstance = OpportunitiesApi()
val id : kotlin.String = id_example // kotlin.String | 
try {
    apiInstance.crmDeleteOpportunity(id)
} catch (e: ClientException) {
    println("4xx response calling OpportunitiesApi#crmDeleteOpportunity")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OpportunitiesApi#crmDeleteOpportunity")
    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

crmGetOpportunity

CrmOpportunity crmGetOpportunity(id)

Opportunity detail

Example

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

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

Parameters

Name Type Description Notes
id kotlin.String

Return type

CrmOpportunity

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

crmListOpportunities

CrmListOpportunities200Response crmListOpportunities(stage, limit)

List opportunities

Example

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

val apiInstance = OpportunitiesApi()
val stage : CrmStage =  // CrmStage | Filter to one pipeline stage
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : CrmListOpportunities200Response = apiInstance.crmListOpportunities(stage, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OpportunitiesApi#crmListOpportunities")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OpportunitiesApi#crmListOpportunities")
    e.printStackTrace()
}

Parameters

| stage | CrmStage| Filter to one pipeline stage | [optional] [enum: NEW, SCREENING, MEETING, PROPOSAL, CUSTOMER] |

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

Return type

CrmListOpportunities200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

crmUpdateOpportunity

CrmOpportunity crmUpdateOpportunity(id, crmOpportunityInput)

Update an opportunity

Example

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

val apiInstance = OpportunitiesApi()
val id : kotlin.String = id_example // kotlin.String | 
val crmOpportunityInput : CrmOpportunityInput =  // CrmOpportunityInput | 
try {
    val result : CrmOpportunity = apiInstance.crmUpdateOpportunity(id, crmOpportunityInput)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OpportunitiesApi#crmUpdateOpportunity")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OpportunitiesApi#crmUpdateOpportunity")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| | |

Name Type Description Notes
crmOpportunityInput CrmOpportunityInput

Return type

CrmOpportunity

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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