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

31 KiB
Raw Permalink Blame History

AdminApi

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

Method HTTP request Description
affiliatesAdminApproveAffiliate POST /v1/admin/affiliates/{id}/approve Approve an affiliate and mint its code
affiliatesAdminListAffiliates GET /v1/admin/affiliates List all affiliates
affiliatesAdminPayoutAffiliate POST /v1/admin/affiliates/{id}/payout Record a payout
affiliatesAdminSuspendAffiliate POST /v1/admin/affiliates/{id}/suspend Suspend an affiliate
affiliatesAdminSweepAffiliates POST /v1/admin/affiliates/sweep Run the accrual sweep
analyticsAdminListUsers GET /v1/analytics/admin/users List all users (admin only)
analyticsAdminListWebsites GET /v1/analytics/admin/websites List all websites for a user (admin only)
authorsAdminApproveAuthor POST /v1/admin/authors/{id}/approve Approve an author
authorsAdminListAuthors GET /v1/admin/authors List all authors
authorsAdminPayoutAuthor POST /v1/admin/authors/{id}/payout Record a payout
authorsAdminSuspendAuthor POST /v1/admin/authors/{id}/suspend Suspend an author
authorsAdminSweepAuthors POST /v1/admin/authors/sweep Run accrual sweep
kmsGetServerConfig GET /v1/kms/admin/config Get server configuration
kmsUpdateServerConfig PATCH /v1/kms/admin/config Update server configuration
referralsAdminListReferrals GET /v1/admin/referrals List every referral with a fleet summary (global-admin)
referralsAdminSweepReferrals POST /v1/admin/referrals/sweep Qualify-check every pending referral (global-admin)
s3AdminInfo GET /v1/s3/admin/info Server information
s3AdminUsage GET /v1/s3/admin/usage Storage usage
s3CreateServiceAccount POST /v1/s3/admin/service-accounts Create a service account
s3ListServiceAccounts GET /v1/s3/admin/service-accounts List service accounts

affiliatesAdminApproveAffiliate

AffiliatesAdminAffiliateEnvelope affiliatesAdminApproveAffiliate(id, affiliatesApproveRequest)

Approve an affiliate and mint its code

Approves the affiliate and mints its code. The body may carry an explicit `code` override; else the requested vanity code; else a derived slug. Global-admin only.

Example

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

val apiInstance = AdminApi()
val id : kotlin.String = id_example // kotlin.String | The affiliate id (e.g. `aff_<hex>`).
val affiliatesApproveRequest : AffiliatesApproveRequest =  // AffiliatesApproveRequest | 
try {
    val result : AffiliatesAdminAffiliateEnvelope = apiInstance.affiliatesAdminApproveAffiliate(id, affiliatesApproveRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#affiliatesAdminApproveAffiliate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#affiliatesAdminApproveAffiliate")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The affiliate id (e.g. `aff_<hex>`). | |

Name Type Description Notes
affiliatesApproveRequest AffiliatesApproveRequest [optional]

Return type

AffiliatesAdminAffiliateEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

affiliatesAdminListAffiliates

AffiliatesAdminListEnvelope affiliatesAdminListAffiliates(limit)

List all affiliates

Returns every affiliate (org exposed) plus a fleet summary. Global-admin only. Wrapped in the admin `{ status, msg, data }` envelope.

Example

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

val apiInstance = AdminApi()
val limit : kotlin.Int = 56 // kotlin.Int | Max rows to return (default 500, max 1000).
try {
    val result : AffiliatesAdminListEnvelope = apiInstance.affiliatesAdminListAffiliates(limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#affiliatesAdminListAffiliates")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#affiliatesAdminListAffiliates")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
limit kotlin.Int Max rows to return (default 500, max 1000). [optional] [default to 500]

Return type

AffiliatesAdminListEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

affiliatesAdminPayoutAffiliate

AffiliatesAdminPayoutEnvelope affiliatesAdminPayoutAffiliate(id, affiliatesPayoutRequest)

Record a payout

Records a payout of accrued commission. A `credits` method issues a commerce grant into the affiliate's wallet; a cash method (wire/paypal/…) is record-only. The amount can never exceed pending (accrued − paid), reserved atomically before any grant. Global-admin only.

Example

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

val apiInstance = AdminApi()
val id : kotlin.String = id_example // kotlin.String | The affiliate id (e.g. `aff_<hex>`).
val affiliatesPayoutRequest : AffiliatesPayoutRequest =  // AffiliatesPayoutRequest | 
try {
    val result : AffiliatesAdminPayoutEnvelope = apiInstance.affiliatesAdminPayoutAffiliate(id, affiliatesPayoutRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#affiliatesAdminPayoutAffiliate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#affiliatesAdminPayoutAffiliate")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| The affiliate id (e.g. `aff_<hex>`). | |

Name Type Description Notes
affiliatesPayoutRequest AffiliatesPayoutRequest

Return type

AffiliatesAdminPayoutEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

affiliatesAdminSuspendAffiliate

AffiliatesAdminAffiliateEnvelope affiliatesAdminSuspendAffiliate(id)

Suspend an affiliate

Suspends the affiliate. Global-admin only.

Example

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

val apiInstance = AdminApi()
val id : kotlin.String = id_example // kotlin.String | The affiliate id (e.g. `aff_<hex>`).
try {
    val result : AffiliatesAdminAffiliateEnvelope = apiInstance.affiliatesAdminSuspendAffiliate(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#affiliatesAdminSuspendAffiliate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#affiliatesAdminSuspendAffiliate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String The affiliate id (e.g. `aff_<hex>`).

Return type

AffiliatesAdminAffiliateEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

affiliatesAdminSweepAffiliates

AffiliatesAdminSweepEnvelope affiliatesAdminSweepAffiliates()

Run the accrual sweep

The periodic accrual path (cron/o11y hits it, or an operator on demand). It folds over every approved affiliate's referred orgs and accrues this period's commission, at-most-once per period. Global-admin only.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

AffiliatesAdminSweepEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsAdminListUsers

kotlin.collections.List<AnalyticsAdminListUsers200ResponseInner> analyticsAdminListUsers(page, pageSize, orderBy, search)

List all users (admin only)

Example

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

val apiInstance = AdminApi()
val page : kotlin.Int = 56 // kotlin.Int | 
val pageSize : kotlin.Int = 56 // kotlin.Int | 
val orderBy : kotlin.String = orderBy_example // kotlin.String | 
val search : kotlin.String = search_example // kotlin.String | 
try {
    val result : kotlin.collections.List<AnalyticsAdminListUsers200ResponseInner> = apiInstance.analyticsAdminListUsers(page, pageSize, orderBy, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#analyticsAdminListUsers")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#analyticsAdminListUsers")
    e.printStackTrace()
}

Parameters

| page | kotlin.Int| | [optional] | | pageSize | kotlin.Int| | [optional] | | orderBy | kotlin.String| | [optional] |

Name Type Description Notes
search kotlin.String [optional]

Return type

kotlin.collections.List<AnalyticsAdminListUsers200ResponseInner>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

analyticsAdminListWebsites

kotlin.collections.List<AnalyticsWebsite> analyticsAdminListWebsites(userId, includeOwnedTeams, includeAllTeams, page, pageSize, orderBy, search)

List all websites for a user (admin only)

Example

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

val apiInstance = AdminApi()
val userId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val includeOwnedTeams : kotlin.String = includeOwnedTeams_example // kotlin.String | 
val includeAllTeams : kotlin.String = includeAllTeams_example // kotlin.String | 
val page : kotlin.Int = 56 // kotlin.Int | 
val pageSize : kotlin.Int = 56 // kotlin.Int | 
val orderBy : kotlin.String = orderBy_example // kotlin.String | 
val search : kotlin.String = search_example // kotlin.String | 
try {
    val result : kotlin.collections.List<AnalyticsWebsite> = apiInstance.analyticsAdminListWebsites(userId, includeOwnedTeams, includeAllTeams, page, pageSize, orderBy, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#analyticsAdminListWebsites")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#analyticsAdminListWebsites")
    e.printStackTrace()
}

Parameters

| userId | java.util.UUID| | | | includeOwnedTeams | kotlin.String| | [optional] | | includeAllTeams | kotlin.String| | [optional] | | page | kotlin.Int| | [optional] | | pageSize | kotlin.Int| | [optional] | | orderBy | kotlin.String| | [optional] |

Name Type Description Notes
search kotlin.String [optional]

Return type

kotlin.collections.List<AnalyticsWebsite>

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

authorsAdminApproveAuthor

AuthorsAdminAuthorEnvelope authorsAdminApproveAuthor(id, authorsApproveRequest)

Approve an author

Admits an author to earning. An optional `{shareBps}` body overrides the royalty share (0–10000 basis points). Global-admin only.

Example

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

val apiInstance = AdminApi()
val id : kotlin.String = id_example // kotlin.String | Author id (e.g. aut_...).
val authorsApproveRequest : AuthorsApproveRequest =  // AuthorsApproveRequest | 
try {
    val result : AuthorsAdminAuthorEnvelope = apiInstance.authorsAdminApproveAuthor(id, authorsApproveRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#authorsAdminApproveAuthor")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#authorsAdminApproveAuthor")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| Author id (e.g. aut_...). | |

Name Type Description Notes
authorsApproveRequest AuthorsApproveRequest [optional]

Return type

AuthorsAdminAuthorEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

authorsAdminListAuthors

AuthorsAdminListEnvelope authorsAdminListAuthors(limit)

List all authors

Every author (org exposed) plus a fleet summary. Global-admin only.

Example

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

val apiInstance = AdminApi()
val limit : kotlin.Int = 56 // kotlin.Int | Max rows (default 500, capped at 1000).
try {
    val result : AuthorsAdminListEnvelope = apiInstance.authorsAdminListAuthors(limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#authorsAdminListAuthors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#authorsAdminListAuthors")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
limit kotlin.Int Max rows (default 500, capped at 1000). [optional] [default to 500]

Return type

AuthorsAdminListEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

authorsAdminPayoutAuthor

AuthorsAdminPayoutEnvelope authorsAdminPayoutAuthor(id, authorsPayoutRequest)

Record a payout

Records a payout of accrued royalty. A `credits` method issues a commerce grant into the author's wallet; a cash method (wire, paypal, check, …) is record-only. The amount can never exceed pending (accrued − paid), reserved atomically before any grant. Global-admin only.

Example

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

val apiInstance = AdminApi()
val id : kotlin.String = id_example // kotlin.String | Author id (e.g. aut_...).
val authorsPayoutRequest : AuthorsPayoutRequest =  // AuthorsPayoutRequest | 
try {
    val result : AuthorsAdminPayoutEnvelope = apiInstance.authorsAdminPayoutAuthor(id, authorsPayoutRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#authorsAdminPayoutAuthor")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#authorsAdminPayoutAuthor")
    e.printStackTrace()
}

Parameters

| id | kotlin.String| Author id (e.g. aut_...). | |

Name Type Description Notes
authorsPayoutRequest AuthorsPayoutRequest

Return type

AuthorsAdminPayoutEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

authorsAdminSuspendAuthor

AuthorsAdminAuthorEnvelope authorsAdminSuspendAuthor(id)

Suspend an author

Suspends an author. Global-admin only.

Example

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

val apiInstance = AdminApi()
val id : kotlin.String = id_example // kotlin.String | Author id (e.g. aut_...).
try {
    val result : AuthorsAdminAuthorEnvelope = apiInstance.authorsAdminSuspendAuthor(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#authorsAdminSuspendAuthor")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#authorsAdminSuspendAuthor")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id kotlin.String Author id (e.g. aut_...).

Return type

AuthorsAdminAuthorEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

authorsAdminSweepAuthors

AuthorsAdminSweepEnvelope authorsAdminSweepAuthors()

Run accrual sweep

The periodic accrual path. Folds over every approved author's distinct deploying orgs and accrues this period's royalty, at-most-once per period. Global-admin only.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

AuthorsAdminSweepEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

kmsGetServerConfig

KmsGetServerConfig200Response kmsGetServerConfig()

Get server configuration

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

KmsGetServerConfig200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

kmsUpdateServerConfig

kotlin.Any kmsUpdateServerConfig(kmsUpdateServerConfigRequest)

Update server configuration

Example

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

val apiInstance = AdminApi()
val kmsUpdateServerConfigRequest : KmsUpdateServerConfigRequest =  // KmsUpdateServerConfigRequest | 
try {
    val result : kotlin.Any = apiInstance.kmsUpdateServerConfig(kmsUpdateServerConfigRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#kmsUpdateServerConfig")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#kmsUpdateServerConfig")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
kmsUpdateServerConfigRequest KmsUpdateServerConfigRequest

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

referralsAdminListReferrals

ReferralsAdminListEnvelope referralsAdminListReferrals(limit)

List every referral with a fleet summary (global-admin)

Returns every referral (both orgs exposed) plus a fleet summary. Global-admin only. Wrapped in the `{ status, msg, data }` admin envelope.

Example

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

val apiInstance = AdminApi()
val limit : kotlin.Int = 56 // kotlin.Int | Max rows to return. Defaults to 500 when absent/invalid/<=0; capped at 1000. 
try {
    val result : ReferralsAdminListEnvelope = apiInstance.referralsAdminListReferrals(limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#referralsAdminListReferrals")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#referralsAdminListReferrals")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
limit kotlin.Int Max rows to return. Defaults to 500 when absent/invalid/<=0; capped at 1000. [optional] [default to 500]

Return type

ReferralsAdminListEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

referralsAdminSweepReferrals

ReferralsAdminSweepEnvelope referralsAdminSweepReferrals()

Qualify-check every pending referral (global-admin)

The periodic qualify path (cron/operator on demand). Qualify-checks every pending referral (bounded to 500 per sweep) and grants the ones that now qualify. Global-admin only. Returns counts in the admin envelope.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

ReferralsAdminSweepEnvelope

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

s3AdminInfo

S3AdminInfo200Response s3AdminInfo()

Server information

Returns server version, storage capacity, and cluster status.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

S3AdminInfo200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

s3AdminUsage

S3UsageInfo s3AdminUsage()

Storage usage

Returns aggregate storage usage across all buckets.

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

S3UsageInfo

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

s3CreateServiceAccount

S3ServiceAccount s3CreateServiceAccount(s3CreateServiceAccountRequest)

Create a service account

Create a service account with specific bucket access policies.

Example

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

val apiInstance = AdminApi()
val s3CreateServiceAccountRequest : S3CreateServiceAccountRequest =  // S3CreateServiceAccountRequest | 
try {
    val result : S3ServiceAccount = apiInstance.s3CreateServiceAccount(s3CreateServiceAccountRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling AdminApi#s3CreateServiceAccount")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling AdminApi#s3CreateServiceAccount")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
s3CreateServiceAccountRequest S3CreateServiceAccountRequest

Return type

S3ServiceAccount

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

s3ListServiceAccounts

S3ListServiceAccounts200Response s3ListServiceAccounts()

List service accounts

Example

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

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

Parameters

This endpoint does not need any parameter.

Return type

S3ListServiceAccounts200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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