Package com.launchdarkly.api.api

Class AnnouncementsApi

java.lang.Object

com.launchdarkly.api.api.AnnouncementsApi

public class AnnouncementsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AnnouncementsApi()
AnnouncementsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AnnouncementResponse	createAnnouncementPublic(CreateAnnouncementBody createAnnouncementBody)	Create an announcement Create an announcement
okhttp3.Call	createAnnouncementPublicAsync(CreateAnnouncementBody createAnnouncementBody, ApiCallback<AnnouncementResponse> _callback)	Create an announcement (asynchronously) Create an announcement
okhttp3.Call	createAnnouncementPublicCall(CreateAnnouncementBody createAnnouncementBody, ApiCallback _callback)	Build call for createAnnouncementPublic
ApiResponse<AnnouncementResponse>	createAnnouncementPublicWithHttpInfo(CreateAnnouncementBody createAnnouncementBody)	Create an announcement Create an announcement
void	deleteAnnouncementPublic(java.lang.String announcementId)	Delete an announcement Delete an announcement
okhttp3.Call	deleteAnnouncementPublicAsync(java.lang.String announcementId, ApiCallback<java.lang.Void> _callback)	Delete an announcement (asynchronously) Delete an announcement
okhttp3.Call	deleteAnnouncementPublicCall(java.lang.String announcementId, ApiCallback _callback)	Build call for deleteAnnouncementPublic
ApiResponse<java.lang.Void>	deleteAnnouncementPublicWithHttpInfo(java.lang.String announcementId)	Delete an announcement Delete an announcement
GetAnnouncementsPublic200Response	getAnnouncementsPublic(java.lang.String status, java.lang.Integer limit, java.lang.Integer offset)	Get announcements Get announcements
okhttp3.Call	getAnnouncementsPublicAsync(java.lang.String status, java.lang.Integer limit, java.lang.Integer offset, ApiCallback<GetAnnouncementsPublic200Response> _callback)	Get announcements (asynchronously) Get announcements
okhttp3.Call	getAnnouncementsPublicCall(java.lang.String status, java.lang.Integer limit, java.lang.Integer offset, ApiCallback _callback)	Build call for getAnnouncementsPublic
ApiResponse<GetAnnouncementsPublic200Response>	getAnnouncementsPublicWithHttpInfo(java.lang.String status, java.lang.Integer limit, java.lang.Integer offset)	Get announcements Get announcements
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
AnnouncementResponse	updateAnnouncementPublic(java.lang.String announcementId, java.util.List<AnnouncementPatchOperation> announcementPatchOperation)	Update an announcement Update an announcement
okhttp3.Call	updateAnnouncementPublicAsync(java.lang.String announcementId, java.util.List<AnnouncementPatchOperation> announcementPatchOperation, ApiCallback<AnnouncementResponse> _callback)	Update an announcement (asynchronously) Update an announcement
okhttp3.Call	updateAnnouncementPublicCall(java.lang.String announcementId, java.util.List<AnnouncementPatchOperation> announcementPatchOperation, ApiCallback _callback)	Build call for updateAnnouncementPublic
ApiResponse<AnnouncementResponse>	updateAnnouncementPublicWithHttpInfo(java.lang.String announcementId, java.util.List<AnnouncementPatchOperation> announcementPatchOperation)	Update an announcement Update an announcement

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnouncementsApi

public AnnouncementsApi()

AnnouncementsApi

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

createAnnouncementPublicCall

public okhttp3.Call createAnnouncementPublicCall(@Nonnull
                                                 CreateAnnouncementBody createAnnouncementBody,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for createAnnouncementPublic

Parameters:

createAnnouncementBody - Announcement request body (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createAnnouncementPublic

public AnnouncementResponse createAnnouncementPublic(@Nonnull
                                                     CreateAnnouncementBody createAnnouncementBody)
                                              throws ApiException

Create an announcement Create an announcement

Parameters:

createAnnouncementBody - Announcement request body (required)

Returns:

AnnouncementResponse

Throws:

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

createAnnouncementPublicWithHttpInfo

public ApiResponse<AnnouncementResponse> createAnnouncementPublicWithHttpInfo(@Nonnull
                                                                              CreateAnnouncementBody createAnnouncementBody)
                                                                       throws ApiException

Create an announcement Create an announcement

Parameters:

createAnnouncementBody - Announcement request body (required)

Returns:

ApiResponse<AnnouncementResponse>

Throws:

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

createAnnouncementPublicAsync

public okhttp3.Call createAnnouncementPublicAsync(@Nonnull
                                                  CreateAnnouncementBody createAnnouncementBody,
                                                  ApiCallback<AnnouncementResponse> _callback)
                                           throws ApiException

Create an announcement (asynchronously) Create an announcement

Parameters:

createAnnouncementBody - Announcement request body (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

deleteAnnouncementPublicCall

public okhttp3.Call deleteAnnouncementPublicCall(@Nonnull
                                                 java.lang.String announcementId,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for deleteAnnouncementPublic

Parameters:

announcementId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAnnouncementPublic

public void deleteAnnouncementPublic(@Nonnull
                                     java.lang.String announcementId)
                              throws ApiException

Delete an announcement Delete an announcement

Parameters:

announcementId - (required)

Throws:

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

deleteAnnouncementPublicWithHttpInfo

public ApiResponse<java.lang.Void> deleteAnnouncementPublicWithHttpInfo(@Nonnull
                                                                        java.lang.String announcementId)
                                                                 throws ApiException

Delete an announcement Delete an announcement

Parameters:

announcementId - (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteAnnouncementPublicAsync

public okhttp3.Call deleteAnnouncementPublicAsync(@Nonnull
                                                  java.lang.String announcementId,
                                                  ApiCallback<java.lang.Void> _callback)
                                           throws ApiException

Delete an announcement (asynchronously) Delete an announcement

Parameters:

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

getAnnouncementsPublicCall

public okhttp3.Call getAnnouncementsPublicCall(@Nullable
                                               java.lang.String status,
                                               @Nullable
                                               java.lang.Integer limit,
                                               @Nullable
                                               java.lang.Integer offset,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for getAnnouncementsPublic

Parameters:

status - Filter announcements by status. (optional)

limit - The number of announcements to return. (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAnnouncementsPublic

public GetAnnouncementsPublic200Response getAnnouncementsPublic(@Nullable
                                                                java.lang.String status,
                                                                @Nullable
                                                                java.lang.Integer limit,
                                                                @Nullable
                                                                java.lang.Integer offset)
                                                         throws ApiException

Get announcements Get announcements

Parameters:

status - Filter announcements by status. (optional)

limit - The number of announcements to return. (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

Returns:

GetAnnouncementsPublic200Response

Throws:

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

getAnnouncementsPublicWithHttpInfo

public ApiResponse<GetAnnouncementsPublic200Response> getAnnouncementsPublicWithHttpInfo(@Nullable
                                                                                         java.lang.String status,
                                                                                         @Nullable
                                                                                         java.lang.Integer limit,
                                                                                         @Nullable
                                                                                         java.lang.Integer offset)
                                                                                  throws ApiException

Get announcements Get announcements

Parameters:

status - Filter announcements by status. (optional)

limit - The number of announcements to return. (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)

Returns:

ApiResponse<GetAnnouncementsPublic200Response>

Throws:

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

getAnnouncementsPublicAsync

public okhttp3.Call getAnnouncementsPublicAsync(@Nullable
                                                java.lang.String status,
                                                @Nullable
                                                java.lang.Integer limit,
                                                @Nullable
                                                java.lang.Integer offset,
                                                ApiCallback<GetAnnouncementsPublic200Response> _callback)
                                         throws ApiException

Get announcements (asynchronously) Get announcements

Parameters:

status - Filter announcements by status. (optional)

limit - The number of announcements to return. (optional)

offset - Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `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

updateAnnouncementPublicCall

public okhttp3.Call updateAnnouncementPublicCall(@Nonnull
                                                 java.lang.String announcementId,
                                                 @Nonnull
                                                 java.util.List<AnnouncementPatchOperation> announcementPatchOperation,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for updateAnnouncementPublic

Parameters:

announcementId - (required)

announcementPatchOperation - Update announcement request body (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateAnnouncementPublic

public AnnouncementResponse updateAnnouncementPublic(@Nonnull
                                                     java.lang.String announcementId,
                                                     @Nonnull
                                                     java.util.List<AnnouncementPatchOperation> announcementPatchOperation)
                                              throws ApiException

Update an announcement Update an announcement

Parameters:

announcementId - (required)

announcementPatchOperation - Update announcement request body (required)

Returns:

AnnouncementResponse

Throws:

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

updateAnnouncementPublicWithHttpInfo

public ApiResponse<AnnouncementResponse> updateAnnouncementPublicWithHttpInfo(@Nonnull
                                                                              java.lang.String announcementId,
                                                                              @Nonnull
                                                                              java.util.List<AnnouncementPatchOperation> announcementPatchOperation)
                                                                       throws ApiException

Update an announcement Update an announcement

Parameters:

announcementId - (required)

announcementPatchOperation - Update announcement request body (required)

Returns:

ApiResponse<AnnouncementResponse>

Throws:

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

updateAnnouncementPublicAsync

public okhttp3.Call updateAnnouncementPublicAsync(@Nonnull
                                                  java.lang.String announcementId,
                                                  @Nonnull
                                                  java.util.List<AnnouncementPatchOperation> announcementPatchOperation,
                                                  ApiCallback<AnnouncementResponse> _callback)
                                           throws ApiException

Update an announcement (asynchronously) Update an announcement

Parameters:

announcementId - (required)

announcementPatchOperation - Update announcement request body (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