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]>
15 KiB
TemplateAPIApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| cloudApiControllerAddTemplate | POST /v1/cloud/add-template | Api Controller Add Template |
| cloudApiControllerDeleteTemplate | POST /v1/cloud/delete-template | Api Controller Delete Template |
| cloudApiControllerGetTemplate | GET /v1/cloud/get-template | Api Controller Get Template |
| cloudApiControllerGetTemplates | GET /v1/cloud/get-templates | Api Controller Get Templates |
| cloudApiControllerUpdateTemplate | POST /v1/cloud/update-template | Api Controller Update Template |
| nexusAddTemplate | POST /v1/nexus/add-template | add Template |
| nexusDeleteTemplate | POST /v1/nexus/delete-template | delete Template |
| nexusGetTemplate | GET /v1/nexus/get-template | get Template |
| nexusGetTemplates | GET /v1/nexus/get-templates | get Templates |
| nexusUpdateTemplate | POST /v1/nexus/update-template | update Template |
cloudApiControllerAddTemplate
CloudControllersResponse cloudApiControllerAddTemplate(cloudObjectTemplate)
Api Controller Add Template
add template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val cloudObjectTemplate : CloudObjectTemplate = // CloudObjectTemplate | The details of the template
try {
val result : CloudControllersResponse = apiInstance.cloudApiControllerAddTemplate(cloudObjectTemplate)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#cloudApiControllerAddTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#cloudApiControllerAddTemplate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectTemplate | CloudObjectTemplate | The details of the template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cloudApiControllerDeleteTemplate
CloudControllersResponse cloudApiControllerDeleteTemplate(cloudObjectTemplate)
Api Controller Delete Template
delete template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val cloudObjectTemplate : CloudObjectTemplate = // CloudObjectTemplate | The details of the template
try {
val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteTemplate(cloudObjectTemplate)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#cloudApiControllerDeleteTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#cloudApiControllerDeleteTemplate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectTemplate | CloudObjectTemplate | The details of the template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cloudApiControllerGetTemplate
CloudObjectTemplate cloudApiControllerGetTemplate(id)
Api Controller Get Template
get template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id of template
try {
val result : CloudObjectTemplate = apiInstance.cloudApiControllerGetTemplate(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#cloudApiControllerGetTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#cloudApiControllerGetTemplate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id of template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
cloudApiControllerGetTemplates
kotlin.collections.List<CloudObjectTemplate> cloudApiControllerGetTemplates(owner)
Api Controller Get Templates
get templates
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of templates
try {
val result : kotlin.collections.List<CloudObjectTemplate> = apiInstance.cloudApiControllerGetTemplates(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#cloudApiControllerGetTemplates")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#cloudApiControllerGetTemplates")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of templates |
Return type
kotlin.collections.List<CloudObjectTemplate>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
cloudApiControllerUpdateTemplate
CloudControllersResponse cloudApiControllerUpdateTemplate(id, cloudObjectTemplate)
Api Controller Update Template
update template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the template
val cloudObjectTemplate : CloudObjectTemplate = // CloudObjectTemplate | The details of the template
try {
val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateTemplate(id, cloudObjectTemplate)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#cloudApiControllerUpdateTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#cloudApiControllerUpdateTemplate")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id (owner/name) of the template | |
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectTemplate | CloudObjectTemplate | The details of the template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
nexusAddTemplate
NexusResponse nexusAddTemplate(cloudObjectTemplate)
add Template
Add a template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val cloudObjectTemplate : CloudObjectTemplate = // CloudObjectTemplate | The details of the template
try {
val result : NexusResponse = apiInstance.nexusAddTemplate(cloudObjectTemplate)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#nexusAddTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#nexusAddTemplate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectTemplate | CloudObjectTemplate | The details of the template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
nexusDeleteTemplate
NexusResponse nexusDeleteTemplate(cloudObjectTemplate)
delete Template
Delete a template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val cloudObjectTemplate : CloudObjectTemplate = // CloudObjectTemplate | The details of the template
try {
val result : NexusResponse = apiInstance.nexusDeleteTemplate(cloudObjectTemplate)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#nexusDeleteTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#nexusDeleteTemplate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectTemplate | CloudObjectTemplate | The details of the template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
nexusGetTemplate
CloudObjectTemplate nexusGetTemplate(id)
get Template
Get a template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id of the template
try {
val result : CloudObjectTemplate = apiInstance.nexusGetTemplate(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#nexusGetTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#nexusGetTemplate")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id of the template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
nexusGetTemplates
kotlin.collections.List<CloudObjectTemplate> nexusGetTemplates(owner)
get Templates
Get templates
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of the templates
try {
val result : kotlin.collections.List<CloudObjectTemplate> = apiInstance.nexusGetTemplates(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#nexusGetTemplates")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#nexusGetTemplates")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of the templates |
Return type
kotlin.collections.List<CloudObjectTemplate>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
nexusUpdateTemplate
NexusResponse nexusUpdateTemplate(id, cloudObjectTemplate)
update Template
Update a template
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = TemplateAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the template
val cloudObjectTemplate : CloudObjectTemplate = // CloudObjectTemplate | The details of the template
try {
val result : NexusResponse = apiInstance.nexusUpdateTemplate(id, cloudObjectTemplate)
println(result)
} catch (e: ClientException) {
println("4xx response calling TemplateAPIApi#nexusUpdateTemplate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling TemplateAPIApi#nexusUpdateTemplate")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id (owner/name) of the template | |
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectTemplate | CloudObjectTemplate | The details of the template |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json