public class ApplicationsApi extends CrowdinApi
clientConfig, graphqlUrl, httpClient, url| Constructor and Description |
|---|
ApplicationsApi(Credentials credentials) |
ApplicationsApi(Credentials credentials,
ClientConfig clientConfig) |
| Modifier and Type | Method and Description |
|---|---|
ResponseObject<ApplicationConsent> |
addApplicationConsent(AddApplicationConsentRequest request) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
addApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> request) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
addApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> request,
java.util.Map<java.lang.String,java.lang.Object> queryParams) |
ResponseObject<ApplicationKvRecord> |
addApplicationKvRecord(java.lang.String applicationIdentifier,
AddApplicationKvRecordRequest request)
Requires the application's own access token - personal access tokens are not supported.
|
ResponseObject<ApplicationInstallation> |
applyApplicationInstallationUpdate(java.lang.String identifier,
ApplyApplicationInstallationUpdateRequest request)
Apply the latest cached manifest to an installed application
|
void |
cancelIntegrationJob(java.lang.String applicationIdentifier,
java.lang.Long projectId,
java.lang.String jobId) |
void |
deleteApplicationConsent(java.lang.Long consentId) |
void |
deleteApplicationData(java.lang.String applicationIdentifier,
java.lang.String path) |
void |
deleteApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> queryParams) |
void |
deleteApplicationInstallation(java.lang.String identifier) |
void |
deleteApplicationInstallation(java.lang.String identifier,
java.lang.Boolean force) |
void |
deleteApplicationKvRecord(java.lang.String applicationIdentifier,
java.lang.String key)
Requires the application's own access token - personal access tokens are not supported
|
ResponseObject<ApplicationConsent> |
editApplicationConsent(java.lang.Long consentId,
java.util.List<PatchRequest> request) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
editApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> request) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
editApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> request,
java.util.Map<java.lang.String,java.lang.Object> queryParams) |
ResponseObject<ApplicationInstallation> |
editApplicationInstallation(java.lang.String identifier,
java.util.List<PatchRequest> request) |
ResponseObject<ApplicationKvRecord> |
editApplicationKvRecord(java.lang.String applicationIdentifier,
java.lang.String key,
java.util.List<PatchRequest> request)
Requires the application's own access token - personal access tokens are not supported.
|
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
getApplicationData(java.lang.String applicationIdentifier,
java.lang.String path) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
getApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> queryParams) |
ResponseObject<ApplicationInstallation> |
getApplicationInstallation(java.lang.String identifier) |
ResponseObject<ApplicationInstallationUpdate> |
getApplicationInstallationUpdate(java.lang.String identifier)
Returns the diff between the currently installed application and the latest cached manifest
|
ResponseObject<ApplicationKvRecord> |
getApplicationKvRecord(java.lang.String applicationIdentifier,
java.lang.String key)
Requires the application's own access token - personal access tokens are not supported
|
ResponseObject<IntegrationFileProgress> |
getIntegrationFileProgress(java.lang.String applicationIdentifier,
java.lang.Long projectId,
java.lang.Long fileId) |
ResponseList<IntegrationJob> |
getIntegrationJobInfo(java.lang.String applicationIdentifier,
java.lang.Long projectId,
java.lang.String jobId) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
getIntegrationSettings(java.lang.String applicationIdentifier,
java.lang.Long projectId) |
ResponseObject<java.lang.Object> |
getIntegrationSyncSettings(java.lang.String applicationIdentifier,
java.lang.Long projectId,
IntegrationSyncProvider provider) |
ResponseObject<ApplicationInstallation> |
installApplication(InstallApplicationRequest request) |
ResponseList<ApplicationConsent> |
listApplicationConsents(ListApplicationConsentsParams params) |
ResponseList<ApplicationInstallation> |
listApplicationInstallations(java.lang.Integer limit,
java.lang.Integer offset) |
ResponseList<ApplicationInstallation> |
listApplicationInstallations(ListApplicationInstallationsParams params) |
ResponseList<ApplicationKvRecord> |
listApplicationKvRecords(java.lang.String applicationIdentifier,
ListApplicationKvRecordsParams params)
Requires the application's own access token - personal access tokens are not supported
|
ResponseList<IntegrationFile> |
listIntegrationCrowdinFiles(java.lang.String applicationIdentifier,
java.lang.Long projectId) |
ResponseList<IntegrationFile> |
listIntegrationFiles(java.lang.String applicationIdentifier,
java.lang.Long projectId) |
ResponseList<IntegrationJob> |
listIntegrationJobs(java.lang.String applicationIdentifier,
java.lang.Long projectId,
java.lang.Integer limit,
java.lang.Integer offset) |
ResponseList<IntegrationLoginField> |
listIntegrationLoginFields(java.lang.String applicationIdentifier) |
void |
loginToIntegration(java.lang.String applicationIdentifier,
IntegrationLoginRequest request) |
ResponseObject<IntegrationJobId> |
updateIntegrationCrowdinFiles(java.lang.String applicationIdentifier,
UpdateIntegrationCrowdinFilesRequest request) |
ResponseObject<IntegrationJobId> |
updateIntegrationFiles(java.lang.String applicationIdentifier,
UpdateIntegrationFilesRequest request) |
void |
updateIntegrationSettings(java.lang.String applicationIdentifier,
UpdateIntegrationSettingsRequest request) |
void |
updateIntegrationSyncSettings(java.lang.String applicationIdentifier,
UpdateIntegrationSyncSettingsRequest request) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
updateOrRestoreApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> request) |
ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> |
updateOrRestoreApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> request,
java.util.Map<java.lang.String,java.lang.Object> queryParams) |
ResponseObject<ApplicationInstallation> |
uploadApplicationBundle(java.lang.String identifier,
UploadApplicationBundleRequest request)
Upload a bundle archive for a serverless app installed from manifest content
|
graphql, graphqlpublic ApplicationsApi(Credentials credentials)
public ApplicationsApi(Credentials credentials, ClientConfig clientConfig)
public ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> getApplicationData(java.lang.String applicationIdentifier, java.lang.String path) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationHttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> getApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> queryParams) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationqueryParams - application-specific query parameters (entries with null values are skipped, values are sent as is)HttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> updateOrRestoreApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> updateOrRestoreApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request, java.util.Map<java.lang.String,java.lang.Object> queryParams) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationrequest - request objectqueryParams - application-specific query parameters (entries with null values are skipped, values are sent as is)HttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> addApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> addApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request, java.util.Map<java.lang.String,java.lang.Object> queryParams) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationrequest - request objectqueryParams - application-specific query parameters (entries with null values are skipped, values are sent as is)HttpExceptionHttpBadRequestExceptionpublic void deleteApplicationData(java.lang.String applicationIdentifier,
java.lang.String path)
throws HttpException,
HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationHttpExceptionHttpBadRequestExceptionpublic void deleteApplicationData(java.lang.String applicationIdentifier,
java.lang.String path,
java.util.Map<java.lang.String,java.lang.Object> queryParams)
throws HttpException,
HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationqueryParams - application-specific query parameters (entries with null values are skipped, values are sent as is)HttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> editApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> editApplicationData(java.lang.String applicationIdentifier, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> request, java.util.Map<java.lang.String,java.lang.Object> queryParams) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationpath - The path is implemented by the applicationrequest - request objectqueryParams - application-specific query parameters (entries with null values are skipped, values are sent as is)HttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationInstallation> getApplicationInstallation(java.lang.String identifier) throws HttpException, HttpBadRequestException
identifier - identifier of the application installationHttpExceptionHttpBadRequestExceptionpublic ResponseList<ApplicationInstallation> listApplicationInstallations(java.lang.Integer limit, java.lang.Integer offset) throws HttpException, HttpBadRequestException
limit - A maximum number of items to retrieveoffset - A starting offset in the collectionHttpExceptionHttpBadRequestExceptionpublic ResponseList<ApplicationInstallation> listApplicationInstallations(ListApplicationInstallationsParams params) throws HttpException, HttpBadRequestException
params - filter, sorting and pagination paramsHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationInstallation> installApplication(InstallApplicationRequest request) throws HttpException, HttpBadRequestException
request - request objectHttpExceptionHttpBadRequestExceptionpublic void deleteApplicationInstallation(java.lang.String identifier)
throws HttpException,
HttpBadRequestException
identifier - identifier of the application installationHttpExceptionHttpBadRequestExceptionpublic void deleteApplicationInstallation(java.lang.String identifier,
java.lang.Boolean force)
throws HttpException,
HttpBadRequestException
identifier - identifier of the application installationforce - force delete the application installationHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationInstallation> editApplicationInstallation(java.lang.String identifier, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
identifier - identifier of the application installationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationInstallation> uploadApplicationBundle(java.lang.String identifier, UploadApplicationBundleRequest request) throws HttpException, HttpBadRequestException
identifier - identifier of the application installationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationInstallationUpdate> getApplicationInstallationUpdate(java.lang.String identifier) throws HttpException, HttpBadRequestException
identifier - identifier of the application installationHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationInstallation> applyApplicationInstallationUpdate(java.lang.String identifier, ApplyApplicationInstallationUpdateRequest request) throws HttpException, HttpBadRequestException
identifier - identifier of the application installationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseList<ApplicationConsent> listApplicationConsents(ListApplicationConsentsParams params) throws HttpException, HttpBadRequestException
params - filter, sorting and pagination paramsHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationConsent> addApplicationConsent(AddApplicationConsentRequest request) throws HttpException, HttpBadRequestException
request - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationConsent> editApplicationConsent(java.lang.Long consentId, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
consentId - consent decision identifierrequest - request objectHttpExceptionHttpBadRequestExceptionpublic void deleteApplicationConsent(java.lang.Long consentId)
throws HttpException,
HttpBadRequestException
consentId - consent decision identifierHttpExceptionHttpBadRequestExceptionpublic ResponseList<ApplicationKvRecord> listApplicationKvRecords(java.lang.String applicationIdentifier, ListApplicationKvRecordsParams params) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationparams - filter, sorting and pagination paramsHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationKvRecord> addApplicationKvRecord(java.lang.String applicationIdentifier, AddApplicationKvRecordRequest request) throws HttpException, HttpBadRequestException
Note: the client omits null-valued entries inside maps when serializing the request, e.g. {"a": null, "b": 1} is sent as {"b": 1}; null elements inside lists are kept.
applicationIdentifier - identifier of the applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationKvRecord> getApplicationKvRecord(java.lang.String applicationIdentifier, java.lang.String key) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the applicationkey - key of the record (reserved characters are URL-encoded by the client)HttpExceptionHttpBadRequestExceptionpublic ResponseObject<ApplicationKvRecord> editApplicationKvRecord(java.lang.String applicationIdentifier, java.lang.String key, java.util.List<PatchRequest> request) throws HttpException, HttpBadRequestException
/value, /ttl. To remove the TTL send null for /ttl using
ApplicationKvRecordPatchRequest
(a plain PatchRequest omits null values).
Use ApplicationKvRecordPatchRequest for records that may be secret: its toString()
masks every value except the /ttl one, while a plain PatchRequest prints the value as is.
Note: the client omits null-valued entries inside maps when serializing the request, e.g. {"a": null, "b": 1} is sent as {"b": 1}; null elements inside lists are kept.
applicationIdentifier - identifier of the applicationkey - key of the record (reserved characters are URL-encoded by the client)request - request objectHttpExceptionHttpBadRequestExceptionpublic void deleteApplicationKvRecord(java.lang.String applicationIdentifier,
java.lang.String key)
throws HttpException,
HttpBadRequestException
applicationIdentifier - identifier of the applicationkey - key of the record (reserved characters are URL-encoded by the client)HttpExceptionHttpBadRequestExceptionpublic ResponseList<IntegrationFile> listIntegrationCrowdinFiles(java.lang.String applicationIdentifier, java.lang.Long projectId) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierHttpExceptionHttpBadRequestExceptionpublic ResponseList<IntegrationFile> listIntegrationFiles(java.lang.String applicationIdentifier, java.lang.Long projectId) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<IntegrationFileProgress> getIntegrationFileProgress(java.lang.String applicationIdentifier, java.lang.Long projectId, java.lang.Long fileId) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierfileId - Crowdin file identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<IntegrationJobId> updateIntegrationCrowdinFiles(java.lang.String applicationIdentifier, UpdateIntegrationCrowdinFilesRequest request) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<IntegrationJobId> updateIntegrationFiles(java.lang.String applicationIdentifier, UpdateIntegrationFilesRequest request) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseList<IntegrationJob> listIntegrationJobs(java.lang.String applicationIdentifier, java.lang.Long projectId, java.lang.Integer limit, java.lang.Integer offset) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierlimit - number of jobs to returnoffset - number of jobs to skipHttpExceptionHttpBadRequestExceptionpublic ResponseList<IntegrationJob> getIntegrationJobInfo(java.lang.String applicationIdentifier, java.lang.Long projectId, java.lang.String jobId) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierjobId - job identifierHttpExceptionHttpBadRequestExceptionpublic void cancelIntegrationJob(java.lang.String applicationIdentifier,
java.lang.Long projectId,
java.lang.String jobId)
throws HttpException,
HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierjobId - job identifierHttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.util.Map<java.lang.String,java.lang.Object>> getIntegrationSettings(java.lang.String applicationIdentifier, java.lang.Long projectId) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierHttpExceptionHttpBadRequestExceptionpublic void updateIntegrationSettings(java.lang.String applicationIdentifier,
UpdateIntegrationSettingsRequest request)
throws HttpException,
HttpBadRequestException
applicationIdentifier - identifier of the integration applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseObject<java.lang.Object> getIntegrationSyncSettings(java.lang.String applicationIdentifier, java.lang.Long projectId, IntegrationSyncProvider provider) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationprojectId - project identifierprovider - sync settings providerMap of Crowdin file id to a list of language ids, or a List of file nodesHttpExceptionHttpBadRequestExceptionpublic void updateIntegrationSyncSettings(java.lang.String applicationIdentifier,
UpdateIntegrationSyncSettingsRequest request)
throws HttpException,
HttpBadRequestException
applicationIdentifier - identifier of the integration applicationrequest - request objectHttpExceptionHttpBadRequestExceptionpublic ResponseList<IntegrationLoginField> listIntegrationLoginFields(java.lang.String applicationIdentifier) throws HttpException, HttpBadRequestException
applicationIdentifier - identifier of the integration applicationHttpExceptionHttpBadRequestExceptionpublic void loginToIntegration(java.lang.String applicationIdentifier,
IntegrationLoginRequest request)
throws HttpException,
HttpBadRequestException
applicationIdentifier - identifier of the integration applicationrequest - request objectHttpExceptionHttpBadRequestException