public class AdvisorsApi extends CrowdinApi
clientConfig, graphqlUrl, httpClient, url| Constructor and Description |
|---|
AdvisorsApi(Credentials credentials) |
AdvisorsApi(Credentials credentials,
ClientConfig clientConfig) |
| Modifier and Type | Method and Description |
|---|---|
ResponseObject<AdvisorInsight> |
editAdvisorInsight(java.lang.Long projectId,
java.lang.Long insightId,
java.util.List<PatchRequest> request) |
ResponseObject<AdvisorCheck> |
getAdvisorCheck(java.lang.Long projectId,
java.lang.String checkId) |
ResponseList<AdvisorInsight> |
listAdvisorInsights(java.lang.Long projectId,
ListAdvisorInsightsParams params) |
ResponseObject<AdvisorCheck> |
runAdvisorCheck(java.lang.Long projectId,
RunAdvisorCheckRequest request) |
void |
upsertApplicationAdvisorInsight(java.lang.Long projectId,
java.lang.String applicationIdentifier,
java.lang.String moduleKey,
UpsertAdvisorInsightRequest request)
Publishes the result of an application's
advisor-inspector module check. |
graphql, graphqlpublic AdvisorsApi(Credentials credentials)
public AdvisorsApi(Credentials credentials, ClientConfig clientConfig)
public ResponseObject<AdvisorCheck> runAdvisorCheck(java.lang.Long projectId, RunAdvisorCheckRequest request) throws HttpException, HttpBadRequestException
projectId - project identifierrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<AdvisorCheck> getAdvisorCheck(java.lang.Long projectId, java.lang.String checkId) throws HttpException, HttpBadRequestException
projectId - project identifiercheckId - advisor check identifierHttpExceptionHttpBadRequestExceptionpublic ResponseList<AdvisorInsight> listAdvisorInsights(java.lang.Long projectId, ListAdvisorInsightsParams params) throws HttpException, HttpBadRequestException
projectId - project identifierparams - query paramsAdvisorInsightPagination which also carries the total countHttpExceptionHttpBadRequestExceptionpublic ResponseObject<AdvisorInsight> editAdvisorInsight(java.lang.Long projectId, java.lang.Long insightId, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
projectId - project identifierinsightId - insight identifierrequest - request object (only the /isDismissed path is supported)HttpExceptionHttpBadRequestExceptionpublic void upsertApplicationAdvisorInsight(java.lang.Long projectId,
java.lang.String applicationIdentifier,
java.lang.String moduleKey,
UpsertAdvisorInsightRequest request)
throws HttpException,
HttpBadRequestException
advisor-inspector module check.
Subsequent calls for the same module overwrite the previous insight.projectId - project identifierapplicationIdentifier - application identifiermoduleKey - application module keyrequest - request objectHttpExceptionHttpBadRequestException