io.swagger.client.api

Class UsersApi

java.lang.Object

io.swagger.client.api.UsersApi

public class UsersApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteUser(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey) Delete a user by ID
com.squareup.okhttp.Call	deleteUserAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<java.lang.Void> callback) Delete a user by ID (asynchronously)
com.squareup.okhttp.Call	deleteUserCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteUser
ApiResponse<java.lang.Void>	deleteUserWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey) Delete a user by ID
ApiClient	getApiClient()
Users	getSearchUsers(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.math.BigDecimal limit, java.math.BigDecimal offset, java.math.BigDecimal after) Search users in LaunchDarkly based on their last active date, or a search query.
com.squareup.okhttp.Call	getSearchUsersAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.math.BigDecimal limit, java.math.BigDecimal offset, java.math.BigDecimal after, ApiCallback<Users> callback) Search users in LaunchDarkly based on their last active date, or a search query.
com.squareup.okhttp.Call	getSearchUsersCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.math.BigDecimal limit, java.math.BigDecimal offset, java.math.BigDecimal after, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSearchUsers
ApiResponse<Users>	getSearchUsersWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.math.BigDecimal limit, java.math.BigDecimal offset, java.math.BigDecimal after) Search users in LaunchDarkly based on their last active date, or a search query.
User	getUser(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey) Get a user by key.
com.squareup.okhttp.Call	getUserAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<User> callback) Get a user by key.
com.squareup.okhttp.Call	getUserCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getUser
Users	getUsers(java.lang.String projectKey, java.lang.String environmentKey, java.math.BigDecimal limit) List all users in the environment.
com.squareup.okhttp.Call	getUsersAsync(java.lang.String projectKey, java.lang.String environmentKey, java.math.BigDecimal limit, ApiCallback<Users> callback) List all users in the environment.
com.squareup.okhttp.Call	getUsersCall(java.lang.String projectKey, java.lang.String environmentKey, java.math.BigDecimal limit, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getUsers
ApiResponse<Users>	getUsersWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.math.BigDecimal limit) List all users in the environment.
ApiResponse<User>	getUserWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey) Get a user by 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

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteUserCall

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

Build call for deleteUser

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

deleteUser

public void deleteUser(java.lang.String projectKey,
                       java.lang.String environmentKey,
                       java.lang.String userKey)
                throws ApiException

Delete a user by ID

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 (required)

userKey - The user's key (required)

Throws:

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

deleteUserWithHttpInfo

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

Delete a user by ID

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 (required)

userKey - The user's key (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteUserAsync

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

Delete a user by ID (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 (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

getSearchUsersCall

public com.squareup.okhttp.Call getSearchUsersCall(java.lang.String projectKey,
                                                   java.lang.String environmentKey,
                                                   java.lang.String q,
                                                   java.math.BigDecimal limit,
                                                   java.math.BigDecimal offset,
                                                   java.math.BigDecimal after,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getSearchUsers

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 (required)

q - Search query (optional)

limit - Pagination limit (optional)

offset - Specifies the first item to return in the collection (optional)

after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSearchUsers

public Users getSearchUsers(java.lang.String projectKey,
                            java.lang.String environmentKey,
                            java.lang.String q,
                            java.math.BigDecimal limit,
                            java.math.BigDecimal offset,
                            java.math.BigDecimal after)
                     throws ApiException

Search users in LaunchDarkly based on their last active date, or a search query.

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 (required)

q - Search query (optional)

limit - Pagination limit (optional)

offset - Specifies the first item to return in the collection (optional)

after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag (optional)

Returns:

Users

Throws:

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

getSearchUsersWithHttpInfo

public ApiResponse<Users> getSearchUsersWithHttpInfo(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     java.lang.String q,
                                                     java.math.BigDecimal limit,
                                                     java.math.BigDecimal offset,
                                                     java.math.BigDecimal after)
                                              throws ApiException

Search users in LaunchDarkly based on their last active date, or a search query.

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 (required)

q - Search query (optional)

limit - Pagination limit (optional)

offset - Specifies the first item to return in the collection (optional)

after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag (optional)

Returns:

ApiResponse<Users>

Throws:

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

getSearchUsersAsync

public com.squareup.okhttp.Call getSearchUsersAsync(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String q,
                                                    java.math.BigDecimal limit,
                                                    java.math.BigDecimal offset,
                                                    java.math.BigDecimal after,
                                                    ApiCallback<Users> callback)
                                             throws ApiException

Search users in LaunchDarkly based on their last active date, or a search query. (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 (required)

q - Search query (optional)

limit - Pagination limit (optional)

offset - Specifies the first item to return in the collection (optional)

after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag (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

getUserCall

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

Build call for getUser

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

getUser

public User getUser(java.lang.String projectKey,
                    java.lang.String environmentKey,
                    java.lang.String userKey)
             throws ApiException

Get 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 (required)

userKey - The user's key (required)

Returns:

User

Throws:

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

getUserWithHttpInfo

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

Get 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 (required)

userKey - The user's key (required)

Returns:

ApiResponse<User>

Throws:

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

getUserAsync

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

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

getUsersCall

public com.squareup.okhttp.Call getUsersCall(java.lang.String projectKey,
                                             java.lang.String environmentKey,
                                             java.math.BigDecimal limit,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for getUsers

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 (required)

limit - Pagination limit (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUsers

public Users getUsers(java.lang.String projectKey,
                      java.lang.String environmentKey,
                      java.math.BigDecimal limit)
               throws ApiException

List all users in the environment.

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 (required)

limit - Pagination limit (optional)

Returns:

Users

Throws:

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

getUsersWithHttpInfo

public ApiResponse<Users> getUsersWithHttpInfo(java.lang.String projectKey,
                                               java.lang.String environmentKey,
                                               java.math.BigDecimal limit)
                                        throws ApiException

List all users in the environment.

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 (required)

limit - Pagination limit (optional)

Returns:

ApiResponse<Users>

Throws:

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

getUsersAsync

public com.squareup.okhttp.Call getUsersAsync(java.lang.String projectKey,
                                              java.lang.String environmentKey,
                                              java.math.BigDecimal limit,
                                              ApiCallback<Users> callback)
                                       throws ApiException

List all users in the environment. (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 (required)

limit - Pagination limit (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