Package ai.shipeasy.admin.api

Class KeysApi

java.lang.Object
ai.shipeasy.admin.api.KeysApi
public class KeysApi extends Object

  • Constructor Details

    • KeysApi

      public KeysApi()

    • KeysApi

      public KeysApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • listI18nKeysCall

      public okhttp3.Call listI18nKeysCall(@Nullable String xProjectId, @Nullable String profileId, @Nullable String prefix, @Nullable String q, @Nullable Integer limit, @Nullable Integer offset, ApiCallback _callback) throws ApiException
      Build call for listI18nKeys
      Parameters:
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      profileId - Profile id to list keys for. (optional)
      prefix - Only keys whose name starts with this. (optional)
      q - Free-text search — matches keys whose name, value, OR description contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy. (optional)
      limit - Max keys to return (1–500). (optional)
      offset - Number of keys to skip before returning `limit` rows (offset pagination). (optional, default to 0)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listI18nKeys

      public ListI18nKeysResponse listI18nKeys(@Nullable String xProjectId, @Nullable String profileId, @Nullable String prefix, @Nullable String q, @Nullable Integer limit, @Nullable Integer offset) throws ApiException
      List i18n keys List keys for a profile, optionally filtered to a name `prefix`. **Use case:** Read the current keys (and values) for a profile — e.g. to diff before a push.
      Parameters:
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      profileId - Profile id to list keys for. (optional)
      prefix - Only keys whose name starts with this. (optional)
      q - Free-text search — matches keys whose name, value, OR description contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy. (optional)
      limit - Max keys to return (1–500). (optional)
      offset - Number of keys to skip before returning `limit` rows (offset pagination). (optional, default to 0)
      Returns:
      ListI18nKeysResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listI18nKeysWithHttpInfo

      public ApiResponse<ListI18nKeysResponse> listI18nKeysWithHttpInfo(@Nullable String xProjectId, @Nullable String profileId, @Nullable String prefix, @Nullable String q, @Nullable Integer limit, @Nullable Integer offset) throws ApiException
      List i18n keys List keys for a profile, optionally filtered to a name `prefix`. **Use case:** Read the current keys (and values) for a profile — e.g. to diff before a push.
      Parameters:
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      profileId - Profile id to list keys for. (optional)
      prefix - Only keys whose name starts with this. (optional)
      q - Free-text search — matches keys whose name, value, OR description contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy. (optional)
      limit - Max keys to return (1–500). (optional)
      offset - Number of keys to skip before returning `limit` rows (offset pagination). (optional, default to 0)
      Returns:
      ApiResponse<ListI18nKeysResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listI18nKeysAsync

      public okhttp3.Call listI18nKeysAsync(@Nullable String xProjectId, @Nullable String profileId, @Nullable String prefix, @Nullable String q, @Nullable Integer limit, @Nullable Integer offset, ApiCallback<ListI18nKeysResponse> _callback) throws ApiException
      List i18n keys (asynchronously) List keys for a profile, optionally filtered to a name `prefix`. **Use case:** Read the current keys (and values) for a profile — e.g. to diff before a push.
      Parameters:
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      profileId - Profile id to list keys for. (optional)
      prefix - Only keys whose name starts with this. (optional)
      q - Free-text search — matches keys whose name, value, OR description contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy. (optional)
      limit - Max keys to return (1–500). (optional)
      offset - Number of keys to skip before returning `limit` rows (offset pagination). (optional, default to 0)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • pushI18nKeysCall

      public okhttp3.Call pushI18nKeysCall(@Nonnull PushI18nKeysRequest pushI18nKeysRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for pushI18nKeys
      Parameters:
      pushI18nKeysRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • pushI18nKeys

      public PushI18nKeysResponse pushI18nKeys(@Nonnull PushI18nKeysRequest pushI18nKeysRequest, @Nullable String xProjectId) throws ApiException
      Push new i18n keys (insert-only) Add NEW keys to a profile. Insert-only — existing keys are left untouched (overwrite one with `updateI18nKey`). **Use case:** Seed newly-extracted keys without clobbering translations already in the profile.
      Parameters:
      pushI18nKeysRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      PushI18nKeysResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • pushI18nKeysWithHttpInfo

      public ApiResponse<PushI18nKeysResponse> pushI18nKeysWithHttpInfo(@Nonnull PushI18nKeysRequest pushI18nKeysRequest, @Nullable String xProjectId) throws ApiException
      Push new i18n keys (insert-only) Add NEW keys to a profile. Insert-only — existing keys are left untouched (overwrite one with `updateI18nKey`). **Use case:** Seed newly-extracted keys without clobbering translations already in the profile.
      Parameters:
      pushI18nKeysRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      ApiResponse<PushI18nKeysResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • pushI18nKeysAsync

      public okhttp3.Call pushI18nKeysAsync(@Nonnull PushI18nKeysRequest pushI18nKeysRequest, @Nullable String xProjectId, ApiCallback<PushI18nKeysResponse> _callback) throws ApiException
      Push new i18n keys (insert-only) (asynchronously) Add NEW keys to a profile. Insert-only — existing keys are left untouched (overwrite one with `updateI18nKey`). **Use case:** Seed newly-extracted keys without clobbering translations already in the profile.
      Parameters:
      pushI18nKeysRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • setI18nLabelCall

      public okhttp3.Call setI18nLabelCall(@Nonnull SetI18nLabelRequest setI18nLabelRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for setI18nLabel
      Parameters:
      setI18nLabelRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • setI18nLabel

      public SetI18nLabelResponse setI18nLabel(@Nonnull SetI18nLabelRequest setI18nLabelRequest, @Nullable String xProjectId) throws ApiException
      Set a key's value and publish it live Upsert a single key's value into a profile and immediately publish the whole profile (KV rebuild + CDN purge) so the new value is live in one call. The key is inserted when new and overwritten when it already exists. `profile` is a profile name — omit it to target the project's default-marked profile, or pass a name to target another locale. **Use case:** Correct or replace one live string and ship it without a separate `push` + `publish`.
      Parameters:
      setI18nLabelRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      SetI18nLabelResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • setI18nLabelWithHttpInfo

      public ApiResponse<SetI18nLabelResponse> setI18nLabelWithHttpInfo(@Nonnull SetI18nLabelRequest setI18nLabelRequest, @Nullable String xProjectId) throws ApiException
      Set a key's value and publish it live Upsert a single key's value into a profile and immediately publish the whole profile (KV rebuild + CDN purge) so the new value is live in one call. The key is inserted when new and overwritten when it already exists. `profile` is a profile name — omit it to target the project's default-marked profile, or pass a name to target another locale. **Use case:** Correct or replace one live string and ship it without a separate `push` + `publish`.
      Parameters:
      setI18nLabelRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      ApiResponse<SetI18nLabelResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • setI18nLabelAsync

      public okhttp3.Call setI18nLabelAsync(@Nonnull SetI18nLabelRequest setI18nLabelRequest, @Nullable String xProjectId, ApiCallback<SetI18nLabelResponse> _callback) throws ApiException
      Set a key's value and publish it live (asynchronously) Upsert a single key's value into a profile and immediately publish the whole profile (KV rebuild + CDN purge) so the new value is live in one call. The key is inserted when new and overwritten when it already exists. `profile` is a profile name — omit it to target the project's default-marked profile, or pass a name to target another locale. **Use case:** Correct or replace one live string and ship it without a separate `push` + `publish`.
      Parameters:
      setI18nLabelRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object

    • updateI18nKeyCall

      public okhttp3.Call updateI18nKeyCall(@Nonnull String id, @Nonnull UpdateI18nKeyRequest updateI18nKeyRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for updateI18nKey
      Parameters:
      id - The key's id. (required)
      updateI18nKeyRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateI18nKey

      public UpdateI18nKeyResponse updateI18nKey(@Nonnull String id, @Nonnull UpdateI18nKeyRequest updateI18nKeyRequest, @Nullable String xProjectId) throws ApiException
      Update one i18n key Overwrite a single existing key's value — the only overwrite path. The change goes live on its own: the profile's KV snapshot is rebuilt and the CDN purged as part of this call, so no separate profile publish is needed. **Use case:** Correct or re-translate a single string in place.
      Parameters:
      id - The key's id. (required)
      updateI18nKeyRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      UpdateI18nKeyResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateI18nKeyWithHttpInfo

      public ApiResponse<UpdateI18nKeyResponse> updateI18nKeyWithHttpInfo(@Nonnull String id, @Nonnull UpdateI18nKeyRequest updateI18nKeyRequest, @Nullable String xProjectId) throws ApiException
      Update one i18n key Overwrite a single existing key's value — the only overwrite path. The change goes live on its own: the profile's KV snapshot is rebuilt and the CDN purged as part of this call, so no separate profile publish is needed. **Use case:** Correct or re-translate a single string in place.
      Parameters:
      id - The key's id. (required)
      updateI18nKeyRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      Returns:
      ApiResponse<UpdateI18nKeyResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateI18nKeyAsync

      public okhttp3.Call updateI18nKeyAsync(@Nonnull String id, @Nonnull UpdateI18nKeyRequest updateI18nKeyRequest, @Nullable String xProjectId, ApiCallback<UpdateI18nKeyResponse> _callback) throws ApiException
      Update one i18n key (asynchronously) Overwrite a single existing key's value — the only overwrite path. The change goes live on its own: the profile's KV snapshot is rebuilt and the CDN purged as part of this call, so no separate profile publish is needed. **Use case:** Correct or re-translate a single string in place.
      Parameters:
      id - The key's id. (required)
      updateI18nKeyRequest - (required)
      xProjectId - Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it). (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object