Package com.launchdarkly.api.api
Class ApprovalsBetaApi
- java.lang.Object
-
- com.launchdarkly.api.api.ApprovalsBetaApi
-
public class ApprovalsBetaApi extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description ApprovalsBetaApi()ApprovalsBetaApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiClientgetApiClient()java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>getApprovalRequestSettings(java.lang.String ldAPIVersion, java.lang.String projectKey, java.lang.String environmentKey, java.lang.String resourceKind, java.lang.String expand)Get approval request settings Get the approval request settings for the given project, optionally filtered by environment and resource kind.okhttp3.CallgetApprovalRequestSettingsAsync(java.lang.String ldAPIVersion, java.lang.String projectKey, java.lang.String environmentKey, java.lang.String resourceKind, java.lang.String expand, ApiCallback<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>> _callback)Get approval request settings (asynchronously) Get the approval request settings for the given project, optionally filtered by environment and resource kind.okhttp3.CallgetApprovalRequestSettingsCall(java.lang.String ldAPIVersion, java.lang.String projectKey, java.lang.String environmentKey, java.lang.String resourceKind, java.lang.String expand, ApiCallback _callback)Build call for getApprovalRequestSettingsApiResponse<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>>getApprovalRequestSettingsWithHttpInfo(java.lang.String ldAPIVersion, java.lang.String projectKey, java.lang.String environmentKey, java.lang.String resourceKind, java.lang.String expand)Get approval request settings Get the approval request settings for the given project, optionally filtered by environment and resource kind.java.lang.StringgetCustomBaseUrl()intgetHostIndex()FlagConfigApprovalRequestResponsepatchApprovalRequest(java.lang.String id, ApprovalRequestPatchInput approvalRequestPatchInput)Update approval request Perform a partial update to an approval request.okhttp3.CallpatchApprovalRequestAsync(java.lang.String id, ApprovalRequestPatchInput approvalRequestPatchInput, ApiCallback<FlagConfigApprovalRequestResponse> _callback)Update approval request (asynchronously) Perform a partial update to an approval request.okhttp3.CallpatchApprovalRequestCall(java.lang.String id, ApprovalRequestPatchInput approvalRequestPatchInput, ApiCallback _callback)Build call for patchApprovalRequestjava.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>patchApprovalRequestSettings(java.lang.String ldAPIVersion, java.lang.String projectKey, ApprovalRequestSettingsPatch approvalRequestSettingsPatch)Update approval request settings Perform a partial update to approval request settingsokhttp3.CallpatchApprovalRequestSettingsAsync(java.lang.String ldAPIVersion, java.lang.String projectKey, ApprovalRequestSettingsPatch approvalRequestSettingsPatch, ApiCallback<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>> _callback)Update approval request settings (asynchronously) Perform a partial update to approval request settingsokhttp3.CallpatchApprovalRequestSettingsCall(java.lang.String ldAPIVersion, java.lang.String projectKey, ApprovalRequestSettingsPatch approvalRequestSettingsPatch, ApiCallback _callback)Build call for patchApprovalRequestSettingsApiResponse<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>>patchApprovalRequestSettingsWithHttpInfo(java.lang.String ldAPIVersion, java.lang.String projectKey, ApprovalRequestSettingsPatch approvalRequestSettingsPatch)Update approval request settings Perform a partial update to approval request settingsApiResponse<FlagConfigApprovalRequestResponse>patchApprovalRequestWithHttpInfo(java.lang.String id, ApprovalRequestPatchInput approvalRequestPatchInput)Update approval request Perform a partial update to an approval request.FlagConfigApprovalRequestResponsepatchFlagConfigApprovalRequest(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String id)Update flag approval request Perform a partial update to an approval request.okhttp3.CallpatchFlagConfigApprovalRequestAsync(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String id, ApiCallback<FlagConfigApprovalRequestResponse> _callback)Update flag approval request (asynchronously) Perform a partial update to an approval request.okhttp3.CallpatchFlagConfigApprovalRequestCall(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String id, ApiCallback _callback)Build call for patchFlagConfigApprovalRequestApiResponse<FlagConfigApprovalRequestResponse>patchFlagConfigApprovalRequestWithHttpInfo(java.lang.String projectKey, java.lang.String featureFlagKey, java.lang.String environmentKey, java.lang.String id)Update flag approval request Perform a partial update to an approval request.voidsetApiClient(ApiClient apiClient)voidsetCustomBaseUrl(java.lang.String customBaseUrl)voidsetHostIndex(int hostIndex)
-
-
-
Constructor Detail
-
ApprovalsBetaApi
public ApprovalsBetaApi()
-
ApprovalsBetaApi
public ApprovalsBetaApi(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)
-
getApprovalRequestSettingsCall
public okhttp3.Call getApprovalRequestSettingsCall(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable java.lang.String environmentKey, @Nullable java.lang.String resourceKind, @Nullable java.lang.String expand, ApiCallback _callback) throws ApiExceptionBuild call for getApprovalRequestSettings- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)environmentKey- An environment key filter to apply to the approval request settings. (optional)resourceKind- A resource kind filter to apply to the approval request settings. (optional)expand- A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getApprovalRequestSettings
public java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs> getApprovalRequestSettings(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable java.lang.String environmentKey, @Nullable java.lang.String resourceKind, @Nullable java.lang.String expand) throws ApiException
Get approval request settings Get the approval request settings for the given project, optionally filtered by environment and resource kind.- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)environmentKey- An environment key filter to apply to the approval request settings. (optional)resourceKind- A resource kind filter to apply to the approval request settings. (optional)expand- A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'. (optional)- Returns:
- Map<String, ApprovalRequestSettingWithEnvs>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getApprovalRequestSettingsWithHttpInfo
public ApiResponse<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>> getApprovalRequestSettingsWithHttpInfo(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable java.lang.String environmentKey, @Nullable java.lang.String resourceKind, @Nullable java.lang.String expand) throws ApiException
Get approval request settings Get the approval request settings for the given project, optionally filtered by environment and resource kind.- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)environmentKey- An environment key filter to apply to the approval request settings. (optional)resourceKind- A resource kind filter to apply to the approval request settings. (optional)expand- A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'. (optional)- Returns:
- ApiResponse<Map<String, ApprovalRequestSettingWithEnvs>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getApprovalRequestSettingsAsync
public okhttp3.Call getApprovalRequestSettingsAsync(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable java.lang.String environmentKey, @Nullable java.lang.String resourceKind, @Nullable java.lang.String expand, ApiCallback<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>> _callback) throws ApiExceptionGet approval request settings (asynchronously) Get the approval request settings for the given project, optionally filtered by environment and resource kind.- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)environmentKey- An environment key filter to apply to the approval request settings. (optional)resourceKind- A resource kind filter to apply to the approval request settings. (optional)expand- A comma-separated list of fields to expand in the response. Options include 'default' and 'strict'. (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
-
patchApprovalRequestCall
public okhttp3.Call patchApprovalRequestCall(@Nonnull java.lang.String id, @Nonnull ApprovalRequestPatchInput approvalRequestPatchInput, ApiCallback _callback) throws ApiExceptionBuild call for patchApprovalRequest- Parameters:
id- The approval ID (required)approvalRequestPatchInput- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
patchApprovalRequest
public FlagConfigApprovalRequestResponse patchApprovalRequest(@Nonnull java.lang.String id, @Nonnull ApprovalRequestPatchInput approvalRequestPatchInput) throws ApiException
Update approval request Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with any approval requests. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. Here's an example: ```json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } ``` #### updateDescription Updates the description (title) of the approval request. ##### Parameters - `value`: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated approval request title\" }] } ```- Parameters:
id- The approval ID (required)approvalRequestPatchInput- (required)- Returns:
- FlagConfigApprovalRequestResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
patchApprovalRequestWithHttpInfo
public ApiResponse<FlagConfigApprovalRequestResponse> patchApprovalRequestWithHttpInfo(@Nonnull java.lang.String id, @Nonnull ApprovalRequestPatchInput approvalRequestPatchInput) throws ApiException
Update approval request Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with any approval requests. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. Here's an example: ```json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } ``` #### updateDescription Updates the description (title) of the approval request. ##### Parameters - `value`: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated approval request title\" }] } ```- Parameters:
id- The approval ID (required)approvalRequestPatchInput- (required)- Returns:
- ApiResponse<FlagConfigApprovalRequestResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
patchApprovalRequestAsync
public okhttp3.Call patchApprovalRequestAsync(@Nonnull java.lang.String id, @Nonnull ApprovalRequestPatchInput approvalRequestPatchInput, ApiCallback<FlagConfigApprovalRequestResponse> _callback) throws ApiExceptionUpdate approval request (asynchronously) Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint works with any approval requests. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. Here's an example: ```json { \"instructions\": [{ \"kind\": \"addReviewers\", \"notifyMemberIds\": [ \"user-key-123abc\", \"user-key-456def\" ], \"notifyTeamKeys\": [ \"team-key-789abc\"] }] } ``` #### updateDescription Updates the description (title) of the approval request. ##### Parameters - `value`: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters. Here's an example: ```json { \"instructions\": [{ \"kind\": \"updateDescription\", \"value\": \"Updated approval request title\" }] } ```- Parameters:
id- The approval ID (required)approvalRequestPatchInput- (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
-
patchApprovalRequestSettingsCall
public okhttp3.Call patchApprovalRequestSettingsCall(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable ApprovalRequestSettingsPatch approvalRequestSettingsPatch, ApiCallback _callback) throws ApiExceptionBuild call for patchApprovalRequestSettings- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)approvalRequestSettingsPatch- Approval request settings to update (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
patchApprovalRequestSettings
public java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs> patchApprovalRequestSettings(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable ApprovalRequestSettingsPatch approvalRequestSettingsPatch) throws ApiException
Update approval request settings Perform a partial update to approval request settings- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)approvalRequestSettingsPatch- Approval request settings to update (optional)- Returns:
- Map<String, ApprovalRequestSettingWithEnvs>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
patchApprovalRequestSettingsWithHttpInfo
public ApiResponse<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>> patchApprovalRequestSettingsWithHttpInfo(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable ApprovalRequestSettingsPatch approvalRequestSettingsPatch) throws ApiException
Update approval request settings Perform a partial update to approval request settings- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)approvalRequestSettingsPatch- Approval request settings to update (optional)- Returns:
- ApiResponse<Map<String, ApprovalRequestSettingWithEnvs>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
patchApprovalRequestSettingsAsync
public okhttp3.Call patchApprovalRequestSettingsAsync(@Nonnull java.lang.String ldAPIVersion, @Nonnull java.lang.String projectKey, @Nullable ApprovalRequestSettingsPatch approvalRequestSettingsPatch, ApiCallback<java.util.Map<java.lang.String,ApprovalRequestSettingWithEnvs>> _callback) throws ApiExceptionUpdate approval request settings (asynchronously) Perform a partial update to approval request settings- Parameters:
ldAPIVersion- Version of the endpoint. (required)projectKey- (required)approvalRequestSettingsPatch- Approval request settings to update (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
-
patchFlagConfigApprovalRequestCall
public okhttp3.Call patchFlagConfigApprovalRequestCall(@Nonnull java.lang.String projectKey, @Nonnull java.lang.String featureFlagKey, @Nonnull java.lang.String environmentKey, @Nonnull java.lang.String id, ApiCallback _callback) throws ApiExceptionBuild call for patchFlagConfigApprovalRequest- Parameters:
projectKey- The project key (required)featureFlagKey- The feature flag key (required)environmentKey- The environment key (required)id- The approval ID (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
patchFlagConfigApprovalRequest
public FlagConfigApprovalRequestResponse patchFlagConfigApprovalRequest(@Nonnull java.lang.String projectKey, @Nonnull java.lang.String featureFlagKey, @Nonnull java.lang.String environmentKey, @Nonnull java.lang.String id) throws ApiException
Update flag approval request Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. #### updateDescription Updates the description (title) of the approval request. ##### Parameters - `value`: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters.- Parameters:
projectKey- The project key (required)featureFlagKey- The feature flag key (required)environmentKey- The environment key (required)id- The approval ID (required)- Returns:
- FlagConfigApprovalRequestResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
patchFlagConfigApprovalRequestWithHttpInfo
public ApiResponse<FlagConfigApprovalRequestResponse> patchFlagConfigApprovalRequestWithHttpInfo(@Nonnull java.lang.String projectKey, @Nonnull java.lang.String featureFlagKey, @Nonnull java.lang.String environmentKey, @Nonnull java.lang.String id) throws ApiException
Update flag approval request Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. #### updateDescription Updates the description (title) of the approval request. ##### Parameters - `value`: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters.- Parameters:
projectKey- The project key (required)featureFlagKey- The feature flag key (required)environmentKey- The environment key (required)id- The approval ID (required)- Returns:
- ApiResponse<FlagConfigApprovalRequestResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
patchFlagConfigApprovalRequestAsync
public okhttp3.Call patchFlagConfigApprovalRequestAsync(@Nonnull java.lang.String projectKey, @Nonnull java.lang.String featureFlagKey, @Nonnull java.lang.String environmentKey, @Nonnull java.lang.String id, ApiCallback<FlagConfigApprovalRequestResponse> _callback) throws ApiExceptionUpdate flag approval request (asynchronously) Perform a partial update to an approval request. Updating an approval request uses the semantic patch format. This endpoint requires a feature flag key, and can only be used for updating approval requests for flags. To make a semantic patch request, you must append `domain-model=launchdarkly.semanticpatch` to your `Content-Type` header. To learn more, read [Updates using semantic patch](https://launchdarkly.com/docs/api#updates-using-semantic-patch). ### Instructions Semantic patch requests support the following `kind` instructions for updating an approval request. #### addReviewers Adds the specified members and teams to the existing list of reviewers. You must include at least one of `notifyMemberIds` and `notifyTeamKeys`. ##### Parameters - `notifyMemberIds`: (Optional) List of member IDs. - `notifyTeamKeys`: (Optional) List of team keys. #### updateDescription Updates the description (title) of the approval request. ##### Parameters - `value`: (Required) The new description for the approval request. Must be non-empty and no more than 5000 characters.- Parameters:
projectKey- The project key (required)featureFlagKey- The feature flag key (required)environmentKey- The environment key (required)id- The approval ID (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
-
-