Package com.launchdarkly.api.api

Class UserSettingsApi

java.lang.Object

com.launchdarkly.api.api.UserSettingsApi

public class UserSettingsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
UserSettingsApi()
UserSettingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
UserTargetingExpirationOnFlagsForUser	getExpiringUserTargetsForUser(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Get expiring dates on flags for user
com.squareup.okhttp.Call	getExpiringUserTargetsForUserAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<UserTargetingExpirationOnFlagsForUser> callback)	Get expiring dates on flags for user (asynchronously)
com.squareup.okhttp.Call	getExpiringUserTargetsForUserCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getExpiringUserTargetsForUser
ApiResponse<UserTargetingExpirationOnFlagsForUser>	getExpiringUserTargetsForUserWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Get expiring dates on flags for user
UserFlagSetting	getUserFlagSetting(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey)	Fetch a single flag setting for a user by key.
com.squareup.okhttp.Call	getUserFlagSettingAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey, ApiCallback<UserFlagSetting> callback)	Fetch a single flag setting for a user by key.
com.squareup.okhttp.Call	getUserFlagSettingCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getUserFlagSetting
UserFlagSettings	getUserFlagSettings(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Fetch a single flag setting for a user by key.
com.squareup.okhttp.Call	getUserFlagSettingsAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<UserFlagSettings> callback)	Fetch a single flag setting for a user by key.
com.squareup.okhttp.Call	getUserFlagSettingsCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getUserFlagSettings
ApiResponse<UserFlagSettings>	getUserFlagSettingsWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Fetch a single flag setting for a user by key.
ApiResponse<UserFlagSetting>	getUserFlagSettingWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey)	Fetch a single flag setting for a user by key.
UserTargetingExpirationOnFlagsForUser	patchExpiringUserTargetsForFlags(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.Object semanticPatchWithComment)	Update, add, or delete expiring user targets for a single user on all flags
com.squareup.okhttp.Call	patchExpiringUserTargetsForFlagsAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.Object semanticPatchWithComment, ApiCallback<UserTargetingExpirationOnFlagsForUser> callback)	Update, add, or delete expiring user targets for a single user on all flags (asynchronously)
com.squareup.okhttp.Call	patchExpiringUserTargetsForFlagsCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.Object semanticPatchWithComment, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for patchExpiringUserTargetsForFlags
ApiResponse<UserTargetingExpirationOnFlagsForUser>	patchExpiringUserTargetsForFlagsWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.Object semanticPatchWithComment)	Update, add, or delete expiring user targets for a single user on all flags
void	putFlagSetting(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey, UserSettingsBody userSettingsBody)	Specifically enable or disable a feature flag for a user based on their key.
com.squareup.okhttp.Call	putFlagSettingAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey, UserSettingsBody userSettingsBody, ApiCallback<java.lang.Void> callback)	Specifically enable or disable a feature flag for a user based on their key.
com.squareup.okhttp.Call	putFlagSettingCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey, UserSettingsBody userSettingsBody, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for putFlagSetting
ApiResponse<java.lang.Void>	putFlagSettingWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, java.lang.String featureFlagKey, UserSettingsBody userSettingsBody)	Specifically enable or disable a feature flag for a user based on their key.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSettingsApi

public UserSettingsApi()

UserSettingsApi

public UserSettingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getExpiringUserTargetsForUserCall

public com.squareup.okhttp.Call getExpiringUserTargetsForUserCall(java.lang.String projectKey,
                                                                  java.lang.String environmentKey,
                                                                  java.lang.String userKey,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException

Build call for getExpiringUserTargetsForUser

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getExpiringUserTargetsForUser

public UserTargetingExpirationOnFlagsForUser getExpiringUserTargetsForUser(java.lang.String projectKey,
                                                                           java.lang.String environmentKey,
                                                                           java.lang.String userKey)
                                                                    throws ApiException

Get expiring dates on flags for user

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Returns:

UserTargetingExpirationOnFlagsForUser

Throws:

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

getExpiringUserTargetsForUserWithHttpInfo

public ApiResponse<UserTargetingExpirationOnFlagsForUser> getExpiringUserTargetsForUserWithHttpInfo(java.lang.String projectKey,
                                                                                                    java.lang.String environmentKey,
                                                                                                    java.lang.String userKey)
                                                                                             throws ApiException

Get expiring dates on flags for user

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Returns:

ApiResponse<UserTargetingExpirationOnFlagsForUser>

Throws:

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

getExpiringUserTargetsForUserAsync

public com.squareup.okhttp.Call getExpiringUserTargetsForUserAsync(java.lang.String projectKey,
                                                                   java.lang.String environmentKey,
                                                                   java.lang.String userKey,
                                                                   ApiCallback<UserTargetingExpirationOnFlagsForUser> callback)
                                                            throws ApiException

Get expiring dates on flags for user (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (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

getUserFlagSettingCall

public com.squareup.okhttp.Call getUserFlagSettingCall(java.lang.String projectKey,
                                                       java.lang.String environmentKey,
                                                       java.lang.String userKey,
                                                       java.lang.String featureFlagKey,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for getUserFlagSetting

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUserFlagSetting

public UserFlagSetting getUserFlagSetting(java.lang.String projectKey,
                                          java.lang.String environmentKey,
                                          java.lang.String userKey,
                                          java.lang.String featureFlagKey)
                                   throws ApiException

Fetch a single flag setting for a user by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (required)

Returns:

UserFlagSetting

Throws:

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

getUserFlagSettingWithHttpInfo

public ApiResponse<UserFlagSetting> getUserFlagSettingWithHttpInfo(java.lang.String projectKey,
                                                                   java.lang.String environmentKey,
                                                                   java.lang.String userKey,
                                                                   java.lang.String featureFlagKey)
                                                            throws ApiException

Fetch a single flag setting for a user by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (required)

Returns:

ApiResponse<UserFlagSetting>

Throws:

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

getUserFlagSettingAsync

public com.squareup.okhttp.Call getUserFlagSettingAsync(java.lang.String projectKey,
                                                        java.lang.String environmentKey,
                                                        java.lang.String userKey,
                                                        java.lang.String featureFlagKey,
                                                        ApiCallback<UserFlagSetting> callback)
                                                 throws ApiException

Fetch a single flag setting for a user by key. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (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

getUserFlagSettingsCall

public com.squareup.okhttp.Call getUserFlagSettingsCall(java.lang.String projectKey,
                                                        java.lang.String environmentKey,
                                                        java.lang.String userKey,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for getUserFlagSettings

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUserFlagSettings

public UserFlagSettings getUserFlagSettings(java.lang.String projectKey,
                                            java.lang.String environmentKey,
                                            java.lang.String userKey)
                                     throws ApiException

Fetch a single flag setting for a user by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Returns:

UserFlagSettings

Throws:

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

getUserFlagSettingsWithHttpInfo

public ApiResponse<UserFlagSettings> getUserFlagSettingsWithHttpInfo(java.lang.String projectKey,
                                                                     java.lang.String environmentKey,
                                                                     java.lang.String userKey)
                                                              throws ApiException

Fetch a single flag setting for a user by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Returns:

ApiResponse<UserFlagSettings>

Throws:

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

getUserFlagSettingsAsync

public com.squareup.okhttp.Call getUserFlagSettingsAsync(java.lang.String projectKey,
                                                         java.lang.String environmentKey,
                                                         java.lang.String userKey,
                                                         ApiCallback<UserFlagSettings> callback)
                                                  throws ApiException

Fetch a single flag setting for a user by key. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (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

patchExpiringUserTargetsForFlagsCall

public com.squareup.okhttp.Call patchExpiringUserTargetsForFlagsCall(java.lang.String projectKey,
                                                                     java.lang.String environmentKey,
                                                                     java.lang.String userKey,
                                                                     java.lang.Object semanticPatchWithComment,
                                                                     ProgressResponseBody.ProgressListener progressListener,
                                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                              throws ApiException

Build call for patchExpiringUserTargetsForFlags

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

patchExpiringUserTargetsForFlags

public UserTargetingExpirationOnFlagsForUser patchExpiringUserTargetsForFlags(java.lang.String projectKey,
                                                                              java.lang.String environmentKey,
                                                                              java.lang.String userKey,
                                                                              java.lang.Object semanticPatchWithComment)
                                                                       throws ApiException

Update, add, or delete expiring user targets for a single user on all flags

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (required)

Returns:

UserTargetingExpirationOnFlagsForUser

Throws:

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

patchExpiringUserTargetsForFlagsWithHttpInfo

public ApiResponse<UserTargetingExpirationOnFlagsForUser> patchExpiringUserTargetsForFlagsWithHttpInfo(java.lang.String projectKey,
                                                                                                       java.lang.String environmentKey,
                                                                                                       java.lang.String userKey,
                                                                                                       java.lang.Object semanticPatchWithComment)
                                                                                                throws ApiException

Update, add, or delete expiring user targets for a single user on all flags

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (required)

Returns:

ApiResponse<UserTargetingExpirationOnFlagsForUser>

Throws:

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

patchExpiringUserTargetsForFlagsAsync

public com.squareup.okhttp.Call patchExpiringUserTargetsForFlagsAsync(java.lang.String projectKey,
                                                                      java.lang.String environmentKey,
                                                                      java.lang.String userKey,
                                                                      java.lang.Object semanticPatchWithComment,
                                                                      ApiCallback<UserTargetingExpirationOnFlagsForUser> callback)
                                                               throws ApiException

Update, add, or delete expiring user targets for a single user on all flags (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

semanticPatchWithComment - Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. (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

putFlagSettingCall

public com.squareup.okhttp.Call putFlagSettingCall(java.lang.String projectKey,
                                                   java.lang.String environmentKey,
                                                   java.lang.String userKey,
                                                   java.lang.String featureFlagKey,
                                                   UserSettingsBody userSettingsBody,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for putFlagSetting

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (required)

userSettingsBody - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

putFlagSetting

public void putFlagSetting(java.lang.String projectKey,
                           java.lang.String environmentKey,
                           java.lang.String userKey,
                           java.lang.String featureFlagKey,
                           UserSettingsBody userSettingsBody)
                    throws ApiException

Specifically enable or disable a feature flag for a user based on their key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (required)

userSettingsBody - (required)

Throws:

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

putFlagSettingWithHttpInfo

public ApiResponse<java.lang.Void> putFlagSettingWithHttpInfo(java.lang.String projectKey,
                                                              java.lang.String environmentKey,
                                                              java.lang.String userKey,
                                                              java.lang.String featureFlagKey,
                                                              UserSettingsBody userSettingsBody)
                                                       throws ApiException

Specifically enable or disable a feature flag for a user based on their key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (required)

userSettingsBody - (required)

Returns:

ApiResponse<Void>

Throws:

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

putFlagSettingAsync

public com.squareup.okhttp.Call putFlagSettingAsync(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String userKey,
                                                    java.lang.String featureFlagKey,
                                                    UserSettingsBody userSettingsBody,
                                                    ApiCallback<java.lang.Void> callback)
                                             throws ApiException

Specifically enable or disable a feature flag for a user based on their key. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

featureFlagKey - The feature flag's key. The key identifies the flag in your code. (required)

userSettingsBody - (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