com.configcat.publicapi.java.client.api

Class FeatureFlagsSettingsApi

java.lang.Object

com.configcat.publicapi.java.client.api.FeatureFlagsSettingsApi

public class FeatureFlagsSettingsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FeatureFlagsSettingsApi()
FeatureFlagsSettingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
SettingModel	createSetting(java.util.UUID configId, CreateSettingInitialValues createSettingInitialValues) Create Flag This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter.
okhttp3.Call	createSettingAsync(java.util.UUID configId, CreateSettingInitialValues createSettingInitialValues, ApiCallback<SettingModel> _callback) Create Flag (asynchronously) This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter.
okhttp3.Call	createSettingCall(java.util.UUID configId, CreateSettingInitialValues createSettingInitialValues, ApiCallback _callback) Build call for createSetting
ApiResponse<SettingModel>	createSettingWithHttpInfo(java.util.UUID configId, CreateSettingInitialValues createSettingInitialValues) Create Flag This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter.
void	deleteSetting(java.lang.Integer settingId) Delete Flag This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.
okhttp3.Call	deleteSettingAsync(java.lang.Integer settingId, ApiCallback<java.lang.Void> _callback) Delete Flag (asynchronously) This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.
okhttp3.Call	deleteSettingCall(java.lang.Integer settingId, ApiCallback _callback) Build call for deleteSetting
ApiResponse<java.lang.Void>	deleteSettingWithHttpInfo(java.lang.Integer settingId) Delete Flag This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
SettingModel	getSetting(java.lang.Integer settingId) Get Flag This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.
okhttp3.Call	getSettingAsync(java.lang.Integer settingId, ApiCallback<SettingModel> _callback) Get Flag (asynchronously) This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.
okhttp3.Call	getSettingCall(java.lang.Integer settingId, ApiCallback _callback) Build call for getSetting
java.util.List<SettingModel>	getSettings(java.util.UUID configId) List Flags This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.
okhttp3.Call	getSettingsAsync(java.util.UUID configId, ApiCallback<java.util.List<SettingModel>> _callback) List Flags (asynchronously) This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.
okhttp3.Call	getSettingsCall(java.util.UUID configId, ApiCallback _callback) Build call for getSettings
ApiResponse<java.util.List<SettingModel>>	getSettingsWithHttpInfo(java.util.UUID configId) List Flags This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.
ApiResponse<SettingModel>	getSettingWithHttpInfo(java.lang.Integer settingId) Get Flag This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.
SettingModel	replaceSetting(java.lang.Integer settingId, ReplaceSettingModel replaceSettingModel) Replace Flag This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter.
okhttp3.Call	replaceSettingAsync(java.lang.Integer settingId, ReplaceSettingModel replaceSettingModel, ApiCallback<SettingModel> _callback) Replace Flag (asynchronously) This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter.
okhttp3.Call	replaceSettingCall(java.lang.Integer settingId, ReplaceSettingModel replaceSettingModel, ApiCallback _callback) Build call for replaceSetting
ApiResponse<SettingModel>	replaceSettingWithHttpInfo(java.lang.Integer settingId, ReplaceSettingModel replaceSettingModel) Replace Flag This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
SettingModel	updateSetting(java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation) Update Flag This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config.
okhttp3.Call	updateSettingAsync(java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, ApiCallback<SettingModel> _callback) Update Flag (asynchronously) This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config.
okhttp3.Call	updateSettingCall(java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation, ApiCallback _callback) Build call for updateSetting
ApiResponse<SettingModel>	updateSettingWithHttpInfo(java.lang.Integer settingId, java.util.List<JsonPatchOperation> jsonPatchOperation) Update Flag This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeatureFlagsSettingsApi

public FeatureFlagsSettingsApi()

FeatureFlagsSettingsApi

public FeatureFlagsSettingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

createSettingCall

public okhttp3.Call createSettingCall(java.util.UUID configId,
                                      CreateSettingInitialValues createSettingInitialValues,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createSetting

Parameters:

configId - The identifier of the Config. (required)

createSettingInitialValues - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createSetting

public SettingModel createSetting(java.util.UUID configId,
                                  CreateSettingInitialValues createSettingInitialValues)
                           throws ApiException

Create Flag This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter. **Important:** The `key` attribute must be unique within the given Config.

Parameters:

configId - The identifier of the Config. (required)

createSettingInitialValues - (required)

Returns:

SettingModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createSettingWithHttpInfo

public ApiResponse<SettingModel> createSettingWithHttpInfo(java.util.UUID configId,
                                                           CreateSettingInitialValues createSettingInitialValues)
                                                    throws ApiException

Create Flag This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter. **Important:** The `key` attribute must be unique within the given Config.

Parameters:

configId - The identifier of the Config. (required)

createSettingInitialValues - (required)

Returns:

ApiResponse<SettingModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createSettingAsync

public okhttp3.Call createSettingAsync(java.util.UUID configId,
                                       CreateSettingInitialValues createSettingInitialValues,
                                       ApiCallback<SettingModel> _callback)
                                throws ApiException

Create Flag (asynchronously) This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter. **Important:** The `key` attribute must be unique within the given Config.

Parameters:

configId - The identifier of the Config. (required)

createSettingInitialValues - (required)

_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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSettingCall

public okhttp3.Call deleteSettingCall(java.lang.Integer settingId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteSetting

Parameters:

settingId - The identifier of the Setting. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSetting

public void deleteSetting(java.lang.Integer settingId)
                   throws ApiException

Delete Flag This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.

Parameters:

settingId - The identifier of the Setting. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSettingWithHttpInfo

public ApiResponse<java.lang.Void> deleteSettingWithHttpInfo(java.lang.Integer settingId)
                                                      throws ApiException

Delete Flag This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.

Parameters:

settingId - The identifier of the Setting. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteSettingAsync

public okhttp3.Call deleteSettingAsync(java.lang.Integer settingId,
                                       ApiCallback<java.lang.Void> _callback)
                                throws ApiException

Delete Flag (asynchronously) This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.

Parameters:

settingId - The identifier of the Setting. (required)

_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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingCall

public okhttp3.Call getSettingCall(java.lang.Integer settingId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getSetting

Parameters:

settingId - The identifier of the Setting. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the setting data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSetting

public SettingModel getSetting(java.lang.Integer settingId)
                        throws ApiException

Get Flag This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.

Parameters:

settingId - The identifier of the Setting. (required)

Returns:

SettingModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the setting data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingWithHttpInfo

public ApiResponse<SettingModel> getSettingWithHttpInfo(java.lang.Integer settingId)
                                                 throws ApiException

Get Flag This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.

Parameters:

settingId - The identifier of the Setting. (required)

Returns:

ApiResponse<SettingModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the setting data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingAsync

public okhttp3.Call getSettingAsync(java.lang.Integer settingId,
                                    ApiCallback<SettingModel> _callback)
                             throws ApiException

Get Flag (asynchronously) This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.

Parameters:

settingId - The identifier of the Setting. (required)

_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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the setting data returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingsCall

public okhttp3.Call getSettingsCall(java.util.UUID configId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getSettings

Parameters:

configId - The identifier of the Config. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettings

public java.util.List<SettingModel> getSettings(java.util.UUID configId)
                                         throws ApiException

List Flags This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.

Parameters:

configId - The identifier of the Config. (required)

Returns:

List<SettingModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingsWithHttpInfo

public ApiResponse<java.util.List<SettingModel>> getSettingsWithHttpInfo(java.util.UUID configId)
                                                                  throws ApiException

List Flags This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.

Parameters:

configId - The identifier of the Config. (required)

Returns:

ApiResponse<List<SettingModel>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingsAsync

public okhttp3.Call getSettingsAsync(java.util.UUID configId,
                                     ApiCallback<java.util.List<SettingModel>> _callback)
                              throws ApiException

List Flags (asynchronously) This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.

Parameters:

configId - The identifier of the Config. (required)

_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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSettingCall

public okhttp3.Call replaceSettingCall(java.lang.Integer settingId,
                                       ReplaceSettingModel replaceSettingModel,
                                       ApiCallback _callback)
                                throws ApiException

Build call for replaceSetting

Parameters:

settingId - The identifier of the Setting. (required)

replaceSettingModel - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When the replace was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSetting

public SettingModel replaceSetting(java.lang.Integer settingId,
                                   ReplaceSettingModel replaceSettingModel)
                            throws ApiException

Replace Flag This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.

Parameters:

settingId - The identifier of the Setting. (required)

replaceSettingModel - (required)

Returns:

SettingModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the replace was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSettingWithHttpInfo

public ApiResponse<SettingModel> replaceSettingWithHttpInfo(java.lang.Integer settingId,
                                                            ReplaceSettingModel replaceSettingModel)
                                                     throws ApiException

Replace Flag This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.

Parameters:

settingId - The identifier of the Setting. (required)

replaceSettingModel - (required)

Returns:

ApiResponse<SettingModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the replace was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSettingAsync

public okhttp3.Call replaceSettingAsync(java.lang.Integer settingId,
                                        ReplaceSettingModel replaceSettingModel,
                                        ApiCallback<SettingModel> _callback)
                                 throws ApiException

Replace Flag (asynchronously) This endpoint replaces the whole value of a Feature Flag or Setting identified by the `settingId` parameter. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.

Parameters:

settingId - The identifier of the Setting. (required)

replaceSettingModel - (required)

_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

Http Response Details

Status Code	Description	Response Headers
200	When the replace was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSettingCall

public okhttp3.Call updateSettingCall(java.lang.Integer settingId,
                                      java.util.List<JsonPatchOperation> jsonPatchOperation,
                                      ApiCallback _callback)
                               throws ApiException

Build call for updateSetting

Parameters:

settingId - The identifier of the Setting. (required)

jsonPatchOperation - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSetting

public SettingModel updateSetting(java.lang.Integer settingId,
                                  java.util.List<JsonPatchOperation> jsonPatchOperation)
                           throws ApiException

Update Flag This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the `name` and adds the already existing tag with the id `2`): ```json [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ```

Parameters:

settingId - The identifier of the Setting. (required)

jsonPatchOperation - (required)

Returns:

SettingModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSettingWithHttpInfo

public ApiResponse<SettingModel> updateSettingWithHttpInfo(java.lang.Integer settingId,
                                                           java.util.List<JsonPatchOperation> jsonPatchOperation)
                                                    throws ApiException

Update Flag This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the `name` and adds the already existing tag with the id `2`): ```json [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ```

Parameters:

settingId - The identifier of the Setting. (required)

jsonPatchOperation - (required)

Returns:

ApiResponse<SettingModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSettingAsync

public okhttp3.Call updateSettingAsync(java.lang.Integer settingId,
                                       java.util.List<JsonPatchOperation> jsonPatchOperation,
                                       ApiCallback<SettingModel> _callback)
                                throws ApiException

Update Flag (asynchronously) This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"Tihs is a naem with soem typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" } ] } ``` If we send an update request body as below (it changes the `name` and adds the already existing tag with the id `2`): ```json [ { \"op\": \"replace\", \"path\": \"/name\", \"value\": \"This is the name without typos.\" }, { \"op\": \"add\", \"path\": \"/tags/-\", \"value\": 2 } ] ``` Only the `name` and `tags` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"settingId\": 5345, \"key\": \"myGrandFeature\", \"name\": \"This is the name without typos.\", \"hint\": \"This flag controls my grandioso feature.\", \"settingType\": \"boolean\", \"tags\": [ { \"tagId\": 0, \"name\": \"sample tag\", \"color\": \"whale\" }, { \"tagId\": 2, \"name\": \"another tag\", \"color\": \"koala\" } ] } ```

Parameters:

settingId - The identifier of the Setting. (required)

jsonPatchOperation - (required)

_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

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-