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]>
18 KiB
ArticleAPIApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| cloudApiControllerAddArticle | POST /v1/cloud/add-article | Api Controller Add Article |
| cloudApiControllerDeleteArticle | POST /v1/cloud/delete-article | Api Controller Delete Article |
| cloudApiControllerGetArticle | GET /v1/cloud/get-article | Api Controller Get Article |
| cloudApiControllerGetArticles | GET /v1/cloud/get-articles | Api Controller Get Articles |
| cloudApiControllerGetGlobalArticles | GET /v1/cloud/get-global-articles | Api Controller Get Global Articles |
| cloudApiControllerUpdateArticle | POST /v1/cloud/update-article | Api Controller Update Article |
| nexusAddArticle | POST /v1/nexus/add-article | add Article |
| nexusDeleteArticle | POST /v1/nexus/delete-article | delete Article |
| nexusGetArticle | GET /v1/nexus/get-article | get Article |
| nexusGetArticles | GET /v1/nexus/get-articles | get Articles |
| nexusGetGlobalArticles | GET /v1/nexus/get-global-articles | get Global Articles |
| nexusUpdateArticle | POST /v1/nexus/update-article | update Article |
cloudApiControllerAddArticle
CloudControllersResponse cloudApiControllerAddArticle(cloudObjectArticle)
Api Controller Add Article
add article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val cloudObjectArticle : CloudObjectArticle = // CloudObjectArticle | The details of the article
try {
val result : CloudControllersResponse = apiInstance.cloudApiControllerAddArticle(cloudObjectArticle)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#cloudApiControllerAddArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#cloudApiControllerAddArticle")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectArticle | CloudObjectArticle | The details of the article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cloudApiControllerDeleteArticle
CloudControllersResponse cloudApiControllerDeleteArticle(cloudObjectArticle)
Api Controller Delete Article
delete article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val cloudObjectArticle : CloudObjectArticle = // CloudObjectArticle | The details of the article
try {
val result : CloudControllersResponse = apiInstance.cloudApiControllerDeleteArticle(cloudObjectArticle)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#cloudApiControllerDeleteArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#cloudApiControllerDeleteArticle")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectArticle | CloudObjectArticle | The details of the article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
cloudApiControllerGetArticle
CloudObjectArticle cloudApiControllerGetArticle(id)
Api Controller Get Article
get article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of article
try {
val result : CloudObjectArticle = apiInstance.cloudApiControllerGetArticle(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#cloudApiControllerGetArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#cloudApiControllerGetArticle")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id (owner/name) of article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
cloudApiControllerGetArticles
kotlin.collections.List<CloudObjectArticle> cloudApiControllerGetArticles(owner)
Api Controller Get Articles
get articles
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of article
try {
val result : kotlin.collections.List<CloudObjectArticle> = apiInstance.cloudApiControllerGetArticles(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#cloudApiControllerGetArticles")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#cloudApiControllerGetArticles")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of article |
Return type
kotlin.collections.List<CloudObjectArticle>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
cloudApiControllerGetGlobalArticles
kotlin.collections.List<CloudObjectArticle> cloudApiControllerGetGlobalArticles()
Api Controller Get Global Articles
get global articles
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
try {
val result : kotlin.collections.List<CloudObjectArticle> = apiInstance.cloudApiControllerGetGlobalArticles()
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#cloudApiControllerGetGlobalArticles")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#cloudApiControllerGetGlobalArticles")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.List<CloudObjectArticle>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
cloudApiControllerUpdateArticle
CloudControllersResponse cloudApiControllerUpdateArticle(id, cloudObjectArticle)
Api Controller Update Article
update article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the article
val cloudObjectArticle : CloudObjectArticle = // CloudObjectArticle | The details of the article
try {
val result : CloudControllersResponse = apiInstance.cloudApiControllerUpdateArticle(id, cloudObjectArticle)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#cloudApiControllerUpdateArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#cloudApiControllerUpdateArticle")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id (owner/name) of the article | |
| Name | Type | Description | Notes |
|---|---|---|---|
| cloudObjectArticle | CloudObjectArticle | The details of the article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
nexusAddArticle
NexusResponse nexusAddArticle(nexusArticle)
add Article
Add an article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val nexusArticle : NexusArticle = // NexusArticle | The details of the article
try {
val result : NexusResponse = apiInstance.nexusAddArticle(nexusArticle)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#nexusAddArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#nexusAddArticle")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| nexusArticle | NexusArticle | The details of the article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
nexusDeleteArticle
NexusResponse nexusDeleteArticle(nexusArticle)
delete Article
Delete an article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val nexusArticle : NexusArticle = // NexusArticle | The details of the article
try {
val result : NexusResponse = apiInstance.nexusDeleteArticle(nexusArticle)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#nexusDeleteArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#nexusDeleteArticle")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| nexusArticle | NexusArticle | The details of the article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
nexusGetArticle
NexusArticle nexusGetArticle(id)
get Article
Get an article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the article
try {
val result : NexusArticle = apiInstance.nexusGetArticle(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#nexusGetArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#nexusGetArticle")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id (owner/name) of the article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
nexusGetArticles
kotlin.collections.List<NexusArticle> nexusGetArticles(owner)
get Articles
Get articles
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of the articles
try {
val result : kotlin.collections.List<NexusArticle> = apiInstance.nexusGetArticles(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#nexusGetArticles")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#nexusGetArticles")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of the articles |
Return type
kotlin.collections.List<NexusArticle>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
nexusGetGlobalArticles
kotlin.collections.List<NexusArticle> nexusGetGlobalArticles()
get Global Articles
Get global articles
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
try {
val result : kotlin.collections.List<NexusArticle> = apiInstance.nexusGetGlobalArticles()
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#nexusGetGlobalArticles")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#nexusGetGlobalArticles")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.List<NexusArticle>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
nexusUpdateArticle
NexusResponse nexusUpdateArticle(id, nexusArticle)
update Article
Update an article
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = ArticleAPIApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the article
val nexusArticle : NexusArticle = // NexusArticle | The details of the article
try {
val result : NexusResponse = apiInstance.nexusUpdateArticle(id, nexusArticle)
println(result)
} catch (e: ClientException) {
println("4xx response calling ArticleAPIApi#nexusUpdateArticle")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ArticleAPIApi#nexusUpdateArticle")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id (owner/name) of the article | |
| Name | Type | Description | Notes |
|---|---|---|---|
| nexusArticle | NexusArticle | The details of the article |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json