Package ai.shipeasy.admin.api

Class ProfilesApi

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

  • Constructor Details

    • ProfilesApi

      public ProfilesApi()

    • ProfilesApi

      public ProfilesApi(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)

    • createI18nProfileCall

      public okhttp3.Call createI18nProfileCall(@Nonnull CreateI18nProfileRequest createI18nProfileRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for createI18nProfile
      Parameters:
      createI18nProfileRequest - (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

    • createI18nProfile

      public CreateI18nProfileResponse createI18nProfile(@Nonnull CreateI18nProfileRequest createI18nProfileRequest, @Nullable String xProjectId) throws ApiException
      Create an i18n profile Create a locale profile. `name` is the stable handle (e.g. `fr:prod`). **Use case:** Stand up a new locale before seeding its keys.
      Parameters:
      createI18nProfileRequest - (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:
      CreateI18nProfileResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createI18nProfileWithHttpInfo

      public ApiResponse<CreateI18nProfileResponse> createI18nProfileWithHttpInfo(@Nonnull CreateI18nProfileRequest createI18nProfileRequest, @Nullable String xProjectId) throws ApiException
      Create an i18n profile Create a locale profile. `name` is the stable handle (e.g. `fr:prod`). **Use case:** Stand up a new locale before seeding its keys.
      Parameters:
      createI18nProfileRequest - (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<CreateI18nProfileResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createI18nProfileAsync

      public okhttp3.Call createI18nProfileAsync(@Nonnull CreateI18nProfileRequest createI18nProfileRequest, @Nullable String xProjectId, ApiCallback<CreateI18nProfileResponse> _callback) throws ApiException
      Create an i18n profile (asynchronously) Create a locale profile. `name` is the stable handle (e.g. `fr:prod`). **Use case:** Stand up a new locale before seeding its keys.
      Parameters:
      createI18nProfileRequest - (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

    • listI18nProfilesCall

      public okhttp3.Call listI18nProfilesCall(@Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for listI18nProfiles
      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)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listI18nProfiles

      public List<ListI18nProfilesResponseInner> listI18nProfiles(@Nullable String xProjectId) throws ApiException
      List i18n profiles Returns every locale profile in the project (e.g. `en:prod`, `fr:prod`). **Use case:** Discover which locale profiles exist before pushing keys or publishing a chunk.
      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)
      Returns:
      List<ListI18nProfilesResponseInner>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listI18nProfilesWithHttpInfo

      public ApiResponse<List<ListI18nProfilesResponseInner>> listI18nProfilesWithHttpInfo(@Nullable String xProjectId) throws ApiException
      List i18n profiles Returns every locale profile in the project (e.g. `en:prod`, `fr:prod`). **Use case:** Discover which locale profiles exist before pushing keys or publishing a chunk.
      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)
      Returns:
      ApiResponse<List<ListI18nProfilesResponseInner>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listI18nProfilesAsync

      public okhttp3.Call listI18nProfilesAsync(@Nullable String xProjectId, ApiCallback<List<ListI18nProfilesResponseInner>> _callback) throws ApiException
      List i18n profiles (asynchronously) Returns every locale profile in the project (e.g. `en:prod`, `fr:prod`). **Use case:** Discover which locale profiles exist before pushing keys or publishing a chunk.
      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)
      _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

    • publishI18nProfileCall

      public okhttp3.Call publishI18nProfileCall(@Nonnull String profileId, @Nonnull PublishI18nProfileRequest publishI18nProfileRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException
      Build call for publishI18nProfile
      Parameters:
      profileId - The profile id to publish. (required)
      publishI18nProfileRequest - (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

    • publishI18nProfile

      public PublishI18nProfileResponse publishI18nProfile(@Nonnull String profileId, @Nonnull PublishI18nProfileRequest publishI18nProfileRequest, @Nullable String xProjectId) throws ApiException
      Publish a profile live Publish a profile to the CDN — rebuild its KV snapshot + purge the edge. Publishing is PROFILE-WIDE: the whole profile is snapshotted into one KV blob, so the optional `chunk` in the body is an audit label only (it does not scope what ships). **Use case:** Ship the latest translations live after pushing/updating keys.
      Parameters:
      profileId - The profile id to publish. (required)
      publishI18nProfileRequest - (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:
      PublishI18nProfileResponse
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • publishI18nProfileWithHttpInfo

      public ApiResponse<PublishI18nProfileResponse> publishI18nProfileWithHttpInfo(@Nonnull String profileId, @Nonnull PublishI18nProfileRequest publishI18nProfileRequest, @Nullable String xProjectId) throws ApiException
      Publish a profile live Publish a profile to the CDN — rebuild its KV snapshot + purge the edge. Publishing is PROFILE-WIDE: the whole profile is snapshotted into one KV blob, so the optional `chunk` in the body is an audit label only (it does not scope what ships). **Use case:** Ship the latest translations live after pushing/updating keys.
      Parameters:
      profileId - The profile id to publish. (required)
      publishI18nProfileRequest - (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<PublishI18nProfileResponse>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • publishI18nProfileAsync

      public okhttp3.Call publishI18nProfileAsync(@Nonnull String profileId, @Nonnull PublishI18nProfileRequest publishI18nProfileRequest, @Nullable String xProjectId, ApiCallback<PublishI18nProfileResponse> _callback) throws ApiException
      Publish a profile live (asynchronously) Publish a profile to the CDN — rebuild its KV snapshot + purge the edge. Publishing is PROFILE-WIDE: the whole profile is snapshotted into one KV blob, so the optional `chunk` in the body is an audit label only (it does not scope what ships). **Use case:** Ship the latest translations live after pushing/updating keys.
      Parameters:
      profileId - The profile id to publish. (required)
      publishI18nProfileRequest - (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