Package ai.shipeasy.admin.api
Class ConfigsApi
java.lang.Object
ai.shipeasy.admin.api.ConfigsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateConfig(CreateConfigRequest createConfigRequest, String xProjectId) Create a dynamic config Creates a new config with the given `schema`.okhttp3.CallcreateConfigAsync(CreateConfigRequest createConfigRequest, String xProjectId, ApiCallback<CreateConfigResponse> _callback) Create a dynamic config (asynchronously) Creates a new config with the given `schema`.okhttp3.CallcreateConfigCall(CreateConfigRequest createConfigRequest, String xProjectId, ApiCallback _callback) Build call for createConfigcreateConfigWithHttpInfo(CreateConfigRequest createConfigRequest, String xProjectId) Create a dynamic config Creates a new config with the given `schema`.deleteConfig(String id, String xProjectId) Delete a dynamic config Soft-deletes the config and rebuilds the project's flags KV blob.okhttp3.CalldeleteConfigAsync(String id, String xProjectId, ApiCallback<DeleteConfigResponse> _callback) Delete a dynamic config (asynchronously) Soft-deletes the config and rebuilds the project's flags KV blob.okhttp3.CalldeleteConfigCall(String id, String xProjectId, ApiCallback _callback) Build call for deleteConfigdeleteConfigWithHttpInfo(String id, String xProjectId) Delete a dynamic config Soft-deletes the config and rebuilds the project's flags KV blob.discardConfigDraft(String id, DiscardConfigDraftRequest discardConfigDraftRequest, String xProjectId) Discard a draft Drops the in-flight draft on one env.okhttp3.CalldiscardConfigDraftAsync(String id, DiscardConfigDraftRequest discardConfigDraftRequest, String xProjectId, ApiCallback<DiscardConfigDraftResponse> _callback) Discard a draft (asynchronously) Drops the in-flight draft on one env.okhttp3.CalldiscardConfigDraftCall(String id, DiscardConfigDraftRequest discardConfigDraftRequest, String xProjectId, ApiCallback _callback) Build call for discardConfigDraftdiscardConfigDraftWithHttpInfo(String id, DiscardConfigDraftRequest discardConfigDraftRequest, String xProjectId) Discard a draft Drops the in-flight draft on one env.Get one config Returns config metadata plus the latest published values per env and any active draft values.okhttp3.CallgetConfigAsync(String id, String xProjectId, ApiCallback<GetConfigResponse> _callback) Get one config (asynchronously) Returns config metadata plus the latest published values per env and any active draft values.okhttp3.CallgetConfigCall(String id, String xProjectId, ApiCallback _callback) Build call for getConfiggetConfigWithHttpInfo(String id, String xProjectId) Get one config Returns config metadata plus the latest published values per env and any active draft values.intlistConfigActivity(String id, String xProjectId, Integer limit) List config activity Returns recent audit rows for one config (create, update, draft.save, publish, delete) ordered newest first.okhttp3.CalllistConfigActivityAsync(String id, String xProjectId, Integer limit, ApiCallback<List<ListConfigActivityResponseInner>> _callback) List config activity (asynchronously) Returns recent audit rows for one config (create, update, draft.save, publish, delete) ordered newest first.okhttp3.CalllistConfigActivityCall(String id, String xProjectId, Integer limit, ApiCallback _callback) Build call for listConfigActivitylistConfigActivityWithHttpInfo(String id, String xProjectId, Integer limit) List config activity Returns recent audit rows for one config (create, update, draft.save, publish, delete) ordered newest first.listConfigs(String xProjectId, Integer limit, String cursor, String q) List dynamic configs Returns a single page of configs ordered by `updated_at desc, id desc`.okhttp3.CalllistConfigsAsync(String xProjectId, Integer limit, String cursor, String q, ApiCallback<ListConfigsResponse> _callback) List dynamic configs (asynchronously) Returns a single page of configs ordered by `updated_at desc, id desc`.okhttp3.CalllistConfigsCall(String xProjectId, Integer limit, String cursor, String q, ApiCallback _callback) Build call for listConfigslistConfigsWithHttpInfo(String xProjectId, Integer limit, String cursor, String q) List dynamic configs Returns a single page of configs ordered by `updated_at desc, id desc`.publishConfigDraft(String id, PublishConfigDraftRequest publishConfigDraftRequest, String xProjectId) Publish a draft Promotes the staged draft on one env to a new published version.okhttp3.CallpublishConfigDraftAsync(String id, PublishConfigDraftRequest publishConfigDraftRequest, String xProjectId, ApiCallback<PublishConfigDraftResponse> _callback) Publish a draft (asynchronously) Promotes the staged draft on one env to a new published version.okhttp3.CallpublishConfigDraftCall(String id, PublishConfigDraftRequest publishConfigDraftRequest, String xProjectId, ApiCallback _callback) Build call for publishConfigDraftpublishConfigDraftWithHttpInfo(String id, PublishConfigDraftRequest publishConfigDraftRequest, String xProjectId) Publish a draft Promotes the staged draft on one env to a new published version.saveConfigDraft(String id, SaveConfigDraftRequest saveConfigDraftRequest, String xProjectId) Save a draft value Stages a value for one env without publishing.okhttp3.CallsaveConfigDraftAsync(String id, SaveConfigDraftRequest saveConfigDraftRequest, String xProjectId, ApiCallback<SaveConfigDraftResponse> _callback) Save a draft value (asynchronously) Stages a value for one env without publishing.okhttp3.CallsaveConfigDraftCall(String id, SaveConfigDraftRequest saveConfigDraftRequest, String xProjectId, ApiCallback _callback) Build call for saveConfigDraftsaveConfigDraftWithHttpInfo(String id, SaveConfigDraftRequest saveConfigDraftRequest, String xProjectId) Save a draft value Stages a value for one env without publishing.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex) updateConfig(String id, UpdateConfigRequest updateConfigRequest, String xProjectId) Update a dynamic config Partial update.okhttp3.CallupdateConfigAsync(String id, UpdateConfigRequest updateConfigRequest, String xProjectId, ApiCallback<UpdateConfigResponse> _callback) Update a dynamic config (asynchronously) Partial update.okhttp3.CallupdateConfigCall(String id, UpdateConfigRequest updateConfigRequest, String xProjectId, ApiCallback _callback) Build call for updateConfigupdateConfigSchema(String id, UpdateConfigSchemaRequest updateConfigSchemaRequest, String xProjectId) Update a config schema Replaces a config's JSON Schema in place.okhttp3.CallupdateConfigSchemaAsync(String id, UpdateConfigSchemaRequest updateConfigSchemaRequest, String xProjectId, ApiCallback<UpdateConfigSchemaResponse> _callback) Update a config schema (asynchronously) Replaces a config's JSON Schema in place.okhttp3.CallupdateConfigSchemaCall(String id, UpdateConfigSchemaRequest updateConfigSchemaRequest, String xProjectId, ApiCallback _callback) Build call for updateConfigSchemaupdateConfigSchemaWithHttpInfo(String id, UpdateConfigSchemaRequest updateConfigSchemaRequest, String xProjectId) Update a config schema Replaces a config's JSON Schema in place.updateConfigWithHttpInfo(String id, UpdateConfigRequest updateConfigRequest, String xProjectId) Update a dynamic config Partial update.
-
Constructor Details
-
ConfigsApi
public ConfigsApi() -
ConfigsApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
createConfigCall
public okhttp3.Call createConfigCall(@Nonnull CreateConfigRequest createConfigRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for createConfig- Parameters:
createConfigRequest- (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
-
createConfig
public CreateConfigResponse createConfig(@Nonnull CreateConfigRequest createConfigRequest, @Nullable String xProjectId) throws ApiException Create a dynamic config Creates a new config with the given `schema`. The initial `value` (or an empty object) is published as version 1 on **every** env. Returns `409` if `name` already exists in the project, `400` if `value` doesn't validate against `schema`. **Use cases** - **Minimal create** — `name` + `schema`. Initial value defaults to `{}`. - **Seeded create** — supply a flat `value` to publish the same object on every env. - **Per-env seed** — supply a `{ env: value }` map for different per-env starting values.- Parameters:
createConfigRequest- (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:
- CreateConfigResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createConfigWithHttpInfo
public ApiResponse<CreateConfigResponse> createConfigWithHttpInfo(@Nonnull CreateConfigRequest createConfigRequest, @Nullable String xProjectId) throws ApiException Create a dynamic config Creates a new config with the given `schema`. The initial `value` (or an empty object) is published as version 1 on **every** env. Returns `409` if `name` already exists in the project, `400` if `value` doesn't validate against `schema`. **Use cases** - **Minimal create** — `name` + `schema`. Initial value defaults to `{}`. - **Seeded create** — supply a flat `value` to publish the same object on every env. - **Per-env seed** — supply a `{ env: value }` map for different per-env starting values.- Parameters:
createConfigRequest- (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<CreateConfigResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createConfigAsync
public okhttp3.Call createConfigAsync(@Nonnull CreateConfigRequest createConfigRequest, @Nullable String xProjectId, ApiCallback<CreateConfigResponse> _callback) throws ApiException Create a dynamic config (asynchronously) Creates a new config with the given `schema`. The initial `value` (or an empty object) is published as version 1 on **every** env. Returns `409` if `name` already exists in the project, `400` if `value` doesn't validate against `schema`. **Use cases** - **Minimal create** — `name` + `schema`. Initial value defaults to `{}`. - **Seeded create** — supply a flat `value` to publish the same object on every env. - **Per-env seed** — supply a `{ env: value }` map for different per-env starting values.- Parameters:
createConfigRequest- (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
-
deleteConfigCall
public okhttp3.Call deleteConfigCall(@Nonnull String id, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for deleteConfig- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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
-
deleteConfig
public DeleteConfigResponse deleteConfig(@Nonnull String id, @Nullable String xProjectId) throws ApiException Delete a dynamic config Soft-deletes the config and rebuilds the project's flags KV blob. **Use case:** Tear down a config after its consumers have stopped reading it.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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:
- DeleteConfigResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteConfigWithHttpInfo
public ApiResponse<DeleteConfigResponse> deleteConfigWithHttpInfo(@Nonnull String id, @Nullable String xProjectId) throws ApiException Delete a dynamic config Soft-deletes the config and rebuilds the project's flags KV blob. **Use case:** Tear down a config after its consumers have stopped reading it.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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<DeleteConfigResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteConfigAsync
public okhttp3.Call deleteConfigAsync(@Nonnull String id, @Nullable String xProjectId, ApiCallback<DeleteConfigResponse> _callback) throws ApiException Delete a dynamic config (asynchronously) Soft-deletes the config and rebuilds the project's flags KV blob. **Use case:** Tear down a config after its consumers have stopped reading it.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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
-
discardConfigDraftCall
public okhttp3.Call discardConfigDraftCall(@Nonnull String id, @Nonnull DiscardConfigDraftRequest discardConfigDraftRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for discardConfigDraft- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)discardConfigDraftRequest- (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
-
discardConfigDraft
public DiscardConfigDraftResponse discardConfigDraft(@Nonnull String id, @Nonnull DiscardConfigDraftRequest discardConfigDraftRequest, @Nullable String xProjectId) throws ApiException Discard a draft Drops the in-flight draft on one env. Published values are unaffected. **Use case:** Abandon an in-progress draft after deciding not to ship it.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)discardConfigDraftRequest- (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:
- DiscardConfigDraftResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
discardConfigDraftWithHttpInfo
public ApiResponse<DiscardConfigDraftResponse> discardConfigDraftWithHttpInfo(@Nonnull String id, @Nonnull DiscardConfigDraftRequest discardConfigDraftRequest, @Nullable String xProjectId) throws ApiException Discard a draft Drops the in-flight draft on one env. Published values are unaffected. **Use case:** Abandon an in-progress draft after deciding not to ship it.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)discardConfigDraftRequest- (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<DiscardConfigDraftResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
discardConfigDraftAsync
public okhttp3.Call discardConfigDraftAsync(@Nonnull String id, @Nonnull DiscardConfigDraftRequest discardConfigDraftRequest, @Nullable String xProjectId, ApiCallback<DiscardConfigDraftResponse> _callback) throws ApiException Discard a draft (asynchronously) Drops the in-flight draft on one env. Published values are unaffected. **Use case:** Abandon an in-progress draft after deciding not to ship it.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)discardConfigDraftRequest- (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
-
getConfigCall
public okhttp3.Call getConfigCall(@Nonnull String id, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for getConfig- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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
-
getConfig
public GetConfigResponse getConfig(@Nonnull String id, @Nullable String xProjectId) throws ApiException Get one config Returns config metadata plus the latest published values per env and any active draft values. Use this to fetch the JSON the editor renders. **Use case:** Fetch one config's current published values and any in-flight drafts.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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:
- GetConfigResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getConfigWithHttpInfo
public ApiResponse<GetConfigResponse> getConfigWithHttpInfo(@Nonnull String id, @Nullable String xProjectId) throws ApiException Get one config Returns config metadata plus the latest published values per env and any active draft values. Use this to fetch the JSON the editor renders. **Use case:** Fetch one config's current published values and any in-flight drafts.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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<GetConfigResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getConfigAsync
public okhttp3.Call getConfigAsync(@Nonnull String id, @Nullable String xProjectId, ApiCallback<GetConfigResponse> _callback) throws ApiException Get one config (asynchronously) Returns config metadata plus the latest published values per env and any active draft values. Use this to fetch the JSON the editor renders. **Use case:** Fetch one config's current published values and any in-flight drafts.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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
-
listConfigActivityCall
public okhttp3.Call listConfigActivityCall(@Nonnull String id, @Nullable String xProjectId, @Nullable Integer limit, ApiCallback _callback) throws ApiException Build call for listConfigActivity- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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)limit- Max rows to return (1–100). Defaults to 20. (optional, default to 20)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
listConfigActivity
public List<ListConfigActivityResponseInner> listConfigActivity(@Nonnull String id, @Nullable String xProjectId, @Nullable Integer limit) throws ApiException List config activity Returns recent audit rows for one config (create, update, draft.save, publish, delete) ordered newest first. Use the `limit` query parameter to cap the result (1–100, default 20). **Use case:** Render the activity panel in the config editor or drive a slack notification on publish events.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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)limit- Max rows to return (1–100). Defaults to 20. (optional, default to 20)- Returns:
- List<ListConfigActivityResponseInner>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listConfigActivityWithHttpInfo
public ApiResponse<List<ListConfigActivityResponseInner>> listConfigActivityWithHttpInfo(@Nonnull String id, @Nullable String xProjectId, @Nullable Integer limit) throws ApiException List config activity Returns recent audit rows for one config (create, update, draft.save, publish, delete) ordered newest first. Use the `limit` query parameter to cap the result (1–100, default 20). **Use case:** Render the activity panel in the config editor or drive a slack notification on publish events.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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)limit- Max rows to return (1–100). Defaults to 20. (optional, default to 20)- Returns:
- ApiResponse<List<ListConfigActivityResponseInner>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listConfigActivityAsync
public okhttp3.Call listConfigActivityAsync(@Nonnull String id, @Nullable String xProjectId, @Nullable Integer limit, ApiCallback<List<ListConfigActivityResponseInner>> _callback) throws ApiException List config activity (asynchronously) Returns recent audit rows for one config (create, update, draft.save, publish, delete) ordered newest first. Use the `limit` query parameter to cap the result (1–100, default 20). **Use case:** Render the activity panel in the config editor or drive a slack notification on publish events.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (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)limit- Max rows to return (1–100). Defaults to 20. (optional, default to 20)_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
-
listConfigsCall
public okhttp3.Call listConfigsCall(@Nullable String xProjectId, @Nullable Integer limit, @Nullable String cursor, @Nullable String q, ApiCallback _callback) throws ApiException Build call for listConfigs- 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)limit- Page size (1–500). Defaults to 100. (optional, default to 100)cursor- Opaque cursor returned in the previous page's `next_cursor`. Omit for the first page. (optional)q- Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
listConfigs
public ListConfigsResponse listConfigs(@Nullable String xProjectId, @Nullable Integer limit, @Nullable String cursor, @Nullable String q) throws ApiException List dynamic configs Returns a single page of configs ordered by `updated_at desc, id desc`. Each row includes the latest published `version` per env and any active drafts. **Use case:** Snapshot every config in the project — e.g. CI check that asserts no env is stuck on a stale default or that every config has a published value on prod.- 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)limit- Page size (1–500). Defaults to 100. (optional, default to 100)cursor- Opaque cursor returned in the previous page's `next_cursor`. Omit for the first page. (optional)q- Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (optional)- Returns:
- ListConfigsResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listConfigsWithHttpInfo
public ApiResponse<ListConfigsResponse> listConfigsWithHttpInfo(@Nullable String xProjectId, @Nullable Integer limit, @Nullable String cursor, @Nullable String q) throws ApiException List dynamic configs Returns a single page of configs ordered by `updated_at desc, id desc`. Each row includes the latest published `version` per env and any active drafts. **Use case:** Snapshot every config in the project — e.g. CI check that asserts no env is stuck on a stale default or that every config has a published value on prod.- 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)limit- Page size (1–500). Defaults to 100. (optional, default to 100)cursor- Opaque cursor returned in the previous page's `next_cursor`. Omit for the first page. (optional)q- Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (optional)- Returns:
- ApiResponse<ListConfigsResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
listConfigsAsync
public okhttp3.Call listConfigsAsync(@Nullable String xProjectId, @Nullable Integer limit, @Nullable String cursor, @Nullable String q, ApiCallback<ListConfigsResponse> _callback) throws ApiException List dynamic configs (asynchronously) Returns a single page of configs ordered by `updated_at desc, id desc`. Each row includes the latest published `version` per env and any active drafts. **Use case:** Snapshot every config in the project — e.g. CI check that asserts no env is stuck on a stale default or that every config has a published value on prod.- 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)limit- Page size (1–500). Defaults to 100. (optional, default to 100)cursor- Opaque cursor returned in the previous page's `next_cursor`. Omit for the first page. (optional)q- Case-insensitive substring filter across the resource's human-readable text columns (e.g. `name`, `title`, `description`). OR-matched across those columns; omit to return everything. (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
-
publishConfigDraftCall
public okhttp3.Call publishConfigDraftCall(@Nonnull String id, @Nonnull PublishConfigDraftRequest publishConfigDraftRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for publishConfigDraft- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)publishConfigDraftRequest- (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
-
publishConfigDraft
public PublishConfigDraftResponse publishConfigDraft(@Nonnull String id, @Nonnull PublishConfigDraftRequest publishConfigDraftRequest, @Nullable String xProjectId) throws ApiException Publish a draft Promotes the staged draft on one env to a new published version. The draft must still validate against the current schema. Returns `404` if there is no draft for the given env. **Use case:** Ship a staged change once you've validated it on a lower env.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)publishConfigDraftRequest- (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:
- PublishConfigDraftResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
publishConfigDraftWithHttpInfo
public ApiResponse<PublishConfigDraftResponse> publishConfigDraftWithHttpInfo(@Nonnull String id, @Nonnull PublishConfigDraftRequest publishConfigDraftRequest, @Nullable String xProjectId) throws ApiException Publish a draft Promotes the staged draft on one env to a new published version. The draft must still validate against the current schema. Returns `404` if there is no draft for the given env. **Use case:** Ship a staged change once you've validated it on a lower env.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)publishConfigDraftRequest- (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<PublishConfigDraftResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
publishConfigDraftAsync
public okhttp3.Call publishConfigDraftAsync(@Nonnull String id, @Nonnull PublishConfigDraftRequest publishConfigDraftRequest, @Nullable String xProjectId, ApiCallback<PublishConfigDraftResponse> _callback) throws ApiException Publish a draft (asynchronously) Promotes the staged draft on one env to a new published version. The draft must still validate against the current schema. Returns `404` if there is no draft for the given env. **Use case:** Ship a staged change once you've validated it on a lower env.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)publishConfigDraftRequest- (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
-
saveConfigDraftCall
public okhttp3.Call saveConfigDraftCall(@Nonnull String id, @Nonnull SaveConfigDraftRequest saveConfigDraftRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for saveConfigDraft- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)saveConfigDraftRequest- (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
-
saveConfigDraft
public SaveConfigDraftResponse saveConfigDraft(@Nonnull String id, @Nonnull SaveConfigDraftRequest saveConfigDraftRequest, @Nullable String xProjectId) throws ApiException Save a draft value Stages a value for one env without publishing. The draft is validated against the config's current schema and stored alongside the `baseVersion` it was forked from. Saving over an existing draft overwrites it. Use `POST /{id}/publish` to promote it to a new published version. **Use case:** Iterate on a config value on dev without affecting prod — preview in staging, then publish.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)saveConfigDraftRequest- (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:
- SaveConfigDraftResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
saveConfigDraftWithHttpInfo
public ApiResponse<SaveConfigDraftResponse> saveConfigDraftWithHttpInfo(@Nonnull String id, @Nonnull SaveConfigDraftRequest saveConfigDraftRequest, @Nullable String xProjectId) throws ApiException Save a draft value Stages a value for one env without publishing. The draft is validated against the config's current schema and stored alongside the `baseVersion` it was forked from. Saving over an existing draft overwrites it. Use `POST /{id}/publish` to promote it to a new published version. **Use case:** Iterate on a config value on dev without affecting prod — preview in staging, then publish.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)saveConfigDraftRequest- (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<SaveConfigDraftResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
saveConfigDraftAsync
public okhttp3.Call saveConfigDraftAsync(@Nonnull String id, @Nonnull SaveConfigDraftRequest saveConfigDraftRequest, @Nullable String xProjectId, ApiCallback<SaveConfigDraftResponse> _callback) throws ApiException Save a draft value (asynchronously) Stages a value for one env without publishing. The draft is validated against the config's current schema and stored alongside the `baseVersion` it was forked from. Saving over an existing draft overwrites it. Use `POST /{id}/publish` to promote it to a new published version. **Use case:** Iterate on a config value on dev without affecting prod — preview in staging, then publish.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)saveConfigDraftRequest- (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
-
updateConfigCall
public okhttp3.Call updateConfigCall(@Nonnull String id, @Nonnull UpdateConfigRequest updateConfigRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for updateConfig- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigRequest- (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
-
updateConfig
public UpdateConfigResponse updateConfig(@Nonnull String id, @Nonnull UpdateConfigRequest updateConfigRequest, @Nullable String xProjectId) throws ApiException Update a dynamic config Partial update. When `value` is supplied it is **republished on every env** (new version per env). When `schema` is supplied it replaces the current schema; every existing value is re-validated. For env-scoped edits, use the draft/publish flow (`PUT /{id}/drafts` then `POST /{id}/publish`) instead. **Use cases** - **Republish flat value** — `{ \"value\": {…} }` sets the same value on every env. - **Schema migration** — `{ \"schema\": {…} }` replaces the schema; existing values are re-validated. - **Env-scoped edits** — use `PUT /{id}/drafts` + `POST /{id}/publish` instead of PATCH.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigRequest- (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:
- UpdateConfigResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateConfigWithHttpInfo
public ApiResponse<UpdateConfigResponse> updateConfigWithHttpInfo(@Nonnull String id, @Nonnull UpdateConfigRequest updateConfigRequest, @Nullable String xProjectId) throws ApiException Update a dynamic config Partial update. When `value` is supplied it is **republished on every env** (new version per env). When `schema` is supplied it replaces the current schema; every existing value is re-validated. For env-scoped edits, use the draft/publish flow (`PUT /{id}/drafts` then `POST /{id}/publish`) instead. **Use cases** - **Republish flat value** — `{ \"value\": {…} }` sets the same value on every env. - **Schema migration** — `{ \"schema\": {…} }` replaces the schema; existing values are re-validated. - **Env-scoped edits** — use `PUT /{id}/drafts` + `POST /{id}/publish` instead of PATCH.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigRequest- (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<UpdateConfigResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateConfigAsync
public okhttp3.Call updateConfigAsync(@Nonnull String id, @Nonnull UpdateConfigRequest updateConfigRequest, @Nullable String xProjectId, ApiCallback<UpdateConfigResponse> _callback) throws ApiException Update a dynamic config (asynchronously) Partial update. When `value` is supplied it is **republished on every env** (new version per env). When `schema` is supplied it replaces the current schema; every existing value is re-validated. For env-scoped edits, use the draft/publish flow (`PUT /{id}/drafts` then `POST /{id}/publish`) instead. **Use cases** - **Republish flat value** — `{ \"value\": {…} }` sets the same value on every env. - **Schema migration** — `{ \"schema\": {…} }` replaces the schema; existing values are re-validated. - **Env-scoped edits** — use `PUT /{id}/drafts` + `POST /{id}/publish` instead of PATCH.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigRequest- (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
-
updateConfigSchemaCall
public okhttp3.Call updateConfigSchemaCall(@Nonnull String id, @Nonnull UpdateConfigSchemaRequest updateConfigSchemaRequest, @Nullable String xProjectId, ApiCallback _callback) throws ApiException Build call for updateConfigSchema- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigSchemaRequest- (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
-
updateConfigSchema
public UpdateConfigSchemaResponse updateConfigSchema(@Nonnull String id, @Nonnull UpdateConfigSchemaRequest updateConfigSchemaRequest, @Nullable String xProjectId) throws ApiException Update a config schema Replaces a config's JSON Schema in place. Every existing published value is re-validated against the new schema before it lands; the update fails if any value no longer validates. **Use case:** Evolve a config's shape (add/remove a field) without republishing values.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigSchemaRequest- (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:
- UpdateConfigSchemaResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateConfigSchemaWithHttpInfo
public ApiResponse<UpdateConfigSchemaResponse> updateConfigSchemaWithHttpInfo(@Nonnull String id, @Nonnull UpdateConfigSchemaRequest updateConfigSchemaRequest, @Nullable String xProjectId) throws ApiException Update a config schema Replaces a config's JSON Schema in place. Every existing published value is re-validated against the new schema before it lands; the update fails if any value no longer validates. **Use case:** Evolve a config's shape (add/remove a field) without republishing values.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigSchemaRequest- (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<UpdateConfigSchemaResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateConfigSchemaAsync
public okhttp3.Call updateConfigSchemaAsync(@Nonnull String id, @Nonnull UpdateConfigSchemaRequest updateConfigSchemaRequest, @Nullable String xProjectId, ApiCallback<UpdateConfigSchemaResponse> _callback) throws ApiException Update a config schema (asynchronously) Replaces a config's JSON Schema in place. Every existing published value is re-validated against the new schema before it lands; the update fails if any value no longer validates. **Use case:** Evolve a config's shape (add/remove a field) without republishing values.- Parameters:
id- Stable opaque config id (`cfg_…`) or the config's `name`. (required)updateConfigSchemaRequest- (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
-