From d73f02865d5461d22794c2d78911766cabbf3cf9 Mon Sep 17 00:00:00 2001 From: lilt-infra-service <69855773+lilt-infra-service@users.noreply.github.com> Date: Mon, 14 Oct 2024 17:01:16 +0000 Subject: [PATCH 1/2] Regenerates API Bindings --- .openapi-generator/FILES | 12 + README.md | 21 +- api/openapi.yaml | 417 +++++++++++------- docs/CreateApi.md | 24 +- docs/DocumentsApi.md | 4 +- docs/FilesApi.md | 12 +- docs/GetLiltCreateContentResponse.md | 12 + docs/JobCreateParameters.md | 3 +- docs/JobsApi.md | 24 +- docs/LanguagePair.md | 2 - docs/LiltCreateContent.md | 10 +- docs/LiltCreateContentPreferences.md | 14 + docs/LiltCreateContentTemplateParams.md | 17 + docs/MemoriesApi.md | 8 +- docs/TranslateApi.md | 22 +- docs/WorkflowStageTemplate.md | 26 ++ docs/WorkflowTemplate.md | 16 + docs/WorkflowsApi.md | 79 ++++ pom.xml | 2 +- .../java/com/lilt/client/ApiCallback.java | 4 +- src/main/java/com/lilt/client/ApiClient.java | 6 +- .../java/com/lilt/client/ApiException.java | 6 +- .../java/com/lilt/client/ApiResponse.java | 4 +- .../java/com/lilt/client/Configuration.java | 6 +- .../lilt/client/GzipRequestInterceptor.java | 4 +- src/main/java/com/lilt/client/JSON.java | 4 +- src/main/java/com/lilt/client/Pair.java | 6 +- .../com/lilt/client/ProgressRequestBody.java | 4 +- .../com/lilt/client/ProgressResponseBody.java | 4 +- src/main/java/com/lilt/client/StringUtil.java | 6 +- .../java/com/lilt/client/api/CreateApi.java | 75 ++-- .../com/lilt/client/api/DocumentsApi.java | 16 +- .../java/com/lilt/client/api/FilesApi.java | 40 +- .../java/com/lilt/client/api/JobsApi.java | 76 ++-- .../com/lilt/client/api/LanguagesApi.java | 4 +- .../java/com/lilt/client/api/MemoriesApi.java | 28 +- .../java/com/lilt/client/api/ProjectsApi.java | 4 +- .../com/lilt/client/api/TranslateApi.java | 70 +-- .../com/lilt/client/api/WorkflowsApi.java | 159 +++++++ .../java/com/lilt/client/auth/ApiKeyAuth.java | 6 +- .../com/lilt/client/auth/Authentication.java | 4 +- .../com/lilt/client/auth/HttpBasicAuth.java | 4 +- .../com/lilt/client/auth/HttpBearerAuth.java | 6 +- .../client/model/AddFileLabelRequest.java | 6 +- .../CreateConverterConfigParameters.java | 6 +- .../DeleteSegmentFromMemoryResponse.java | 6 +- .../client/model/DocumentWithSegments.java | 6 +- .../client/model/DocumentWithoutSegments.java | 6 +- .../model/DocumentWithoutSegmentsStatus.java | 6 +- .../java/com/lilt/client/model/Error.java | 6 +- .../lilt/client/model/FileDeleteResponse.java | 6 +- .../model/GetLiltCreateContentResponse.java | 109 +++++ .../lilt/client/model/InlineResponse200.java | 6 +- src/main/java/com/lilt/client/model/Job.java | 6 +- .../client/model/JobCreateParameters.java | 43 +- .../lilt/client/model/JobDeleteResponse.java | 6 +- .../lilt/client/model/JobLeverageStats.java | 6 +- .../com/lilt/client/model/JobProject.java | 6 +- .../java/com/lilt/client/model/JobStats.java | 6 +- .../client/model/JobUpdateParameters.java | 6 +- .../com/lilt/client/model/LanguagePair.java | 68 +-- .../lilt/client/model/LanguagesResponse.java | 6 +- .../lilt/client/model/LiltCreateContent.java | 185 +++----- .../model/LiltCreateContentPreferences.java | 128 ++++++ .../LiltCreateContentTemplateParams.java | 224 ++++++++++ .../java/com/lilt/client/model/Memory.java | 6 +- .../client/model/MemoryCreateParameters.java | 6 +- .../client/model/MemoryDeleteResponse.java | 6 +- .../client/model/MemoryImportResponse.java | 6 +- .../client/model/MemoryUpdateParameters.java | 6 +- .../java/com/lilt/client/model/Project.java | 6 +- .../client/model/ProjectCreateParameters.java | 6 +- .../client/model/ProjectDeleteResponse.java | 6 +- .../com/lilt/client/model/ProjectStats.java | 6 +- .../com/lilt/client/model/SDLXLIFFFilter.java | 6 +- .../java/com/lilt/client/model/Segment.java | 6 +- .../model/SignLiltCreateTermsResponse.java | 6 +- .../com/lilt/client/model/SourceFile.java | 6 +- .../client/model/TermbaseExportResponse.java | 6 +- .../client/model/TranslateSegmentBody.java | 6 +- .../com/lilt/client/model/Translation.java | 6 +- .../lilt/client/model/TranslationInfo.java | 6 +- .../lilt/client/model/TranslationList.java | 6 +- .../client/model/TranslationMemoryEntry.java | 6 +- .../client/model/WorkflowStageAssignment.java | 6 +- .../client/model/WorkflowStageTemplate.java | 181 ++++++++ .../lilt/client/model/WorkflowTemplate.java | 198 +++++++++ 87 files changed, 1880 insertions(+), 743 deletions(-) create mode 100644 docs/GetLiltCreateContentResponse.md create mode 100644 docs/LiltCreateContentPreferences.md create mode 100644 docs/LiltCreateContentTemplateParams.md create mode 100644 docs/WorkflowStageTemplate.md create mode 100644 docs/WorkflowTemplate.md create mode 100644 docs/WorkflowsApi.md create mode 100644 src/main/java/com/lilt/client/api/WorkflowsApi.java create mode 100644 src/main/java/com/lilt/client/model/GetLiltCreateContentResponse.java create mode 100644 src/main/java/com/lilt/client/model/LiltCreateContentPreferences.java create mode 100644 src/main/java/com/lilt/client/model/LiltCreateContentTemplateParams.java create mode 100644 src/main/java/com/lilt/client/model/WorkflowStageTemplate.java create mode 100644 src/main/java/com/lilt/client/model/WorkflowTemplate.java diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 7f008af63..eb0111800 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -12,6 +12,7 @@ docs/DocumentsApi.md docs/Error.md docs/FileDeleteResponse.md docs/FilesApi.md +docs/GetLiltCreateContentResponse.md docs/InlineResponse200.md docs/Job.md docs/JobCreateParameters.md @@ -25,6 +26,8 @@ docs/LanguagePair.md docs/LanguagesApi.md docs/LanguagesResponse.md docs/LiltCreateContent.md +docs/LiltCreateContentPreferences.md +docs/LiltCreateContentTemplateParams.md docs/MemoriesApi.md docs/Memory.md docs/MemoryCreateParameters.md @@ -48,6 +51,9 @@ docs/TranslationInfo.md docs/TranslationList.md docs/TranslationMemoryEntry.md docs/WorkflowStageAssignment.md +docs/WorkflowStageTemplate.md +docs/WorkflowTemplate.md +docs/WorkflowsApi.md pom.xml src/main/AndroidManifest.xml src/main/java/com/lilt/client/ApiCallback.java @@ -71,6 +77,7 @@ src/main/java/com/lilt/client/api/LanguagesApi.java src/main/java/com/lilt/client/api/MemoriesApi.java src/main/java/com/lilt/client/api/ProjectsApi.java src/main/java/com/lilt/client/api/TranslateApi.java +src/main/java/com/lilt/client/api/WorkflowsApi.java src/main/java/com/lilt/client/auth/ApiKeyAuth.java src/main/java/com/lilt/client/auth/Authentication.java src/main/java/com/lilt/client/auth/HttpBasicAuth.java @@ -83,6 +90,7 @@ src/main/java/com/lilt/client/model/DocumentWithoutSegments.java src/main/java/com/lilt/client/model/DocumentWithoutSegmentsStatus.java src/main/java/com/lilt/client/model/Error.java src/main/java/com/lilt/client/model/FileDeleteResponse.java +src/main/java/com/lilt/client/model/GetLiltCreateContentResponse.java src/main/java/com/lilt/client/model/InlineResponse200.java src/main/java/com/lilt/client/model/Job.java src/main/java/com/lilt/client/model/JobCreateParameters.java @@ -94,6 +102,8 @@ src/main/java/com/lilt/client/model/JobUpdateParameters.java src/main/java/com/lilt/client/model/LanguagePair.java src/main/java/com/lilt/client/model/LanguagesResponse.java src/main/java/com/lilt/client/model/LiltCreateContent.java +src/main/java/com/lilt/client/model/LiltCreateContentPreferences.java +src/main/java/com/lilt/client/model/LiltCreateContentTemplateParams.java src/main/java/com/lilt/client/model/Memory.java src/main/java/com/lilt/client/model/MemoryCreateParameters.java src/main/java/com/lilt/client/model/MemoryDeleteResponse.java @@ -114,3 +124,5 @@ src/main/java/com/lilt/client/model/TranslationInfo.java src/main/java/com/lilt/client/model/TranslationList.java src/main/java/com/lilt/client/model/TranslationMemoryEntry.java src/main/java/com/lilt/client/model/WorkflowStageAssignment.java +src/main/java/com/lilt/client/model/WorkflowStageTemplate.java +src/main/java/com/lilt/client/model/WorkflowTemplate.java diff --git a/README.md b/README.md index 3c3b4d915..4eb75db0d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,9 @@ Lilt REST API - API version: v3.0 - - Build date: 2024-07-22T00:19:36.591Z[GMT] + - Build date: 2024-10-14T17:01:14.551Z[GMT] +Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory @@ -11,7 +12,8 @@ The Lilt REST API enables programmatic access to the full-range of Lilt backend * Programmatic control of the Lilt CAT environment * Translation memory synchronization -Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. +Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. +The base url for this REST API is `https://api.lilt.com/`. ## Authentication @@ -26,7 +28,6 @@ For development, you may also pass the REST API key via the `key` query paramete Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. - For more information, please visit [https://developers.lilt.com/](https://developers.lilt.com/) *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* @@ -61,7 +62,7 @@ Add this dependency to your project's POM: org.openapitools openapi-java-client - 2.2.0 + 3.0.0 compile ``` @@ -71,7 +72,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "org.openapitools:openapi-java-client:2.2.0" +compile "org.openapitools:openapi-java-client:3.0.0" ``` ### Others @@ -84,7 +85,7 @@ mvn clean package Then manually install the following JARs: -* `target/openapi-java-client-2.2.0.jar` +* `target/openapi-java-client-3.0.0.jar` * `target/lib/*.jar` ## Getting Started @@ -186,6 +187,7 @@ Class | Method | HTTP request | Description *TranslateApi* | [**downloadFile**](docs/TranslateApi.md#downloadFile) | **GET** /v2/translate/files | Download translated file *TranslateApi* | [**monitorFileTranslation**](docs/TranslateApi.md#monitorFileTranslation) | **GET** /v2/translate/file | Monitor file translation *TranslateApi* | [**translateSegmentPost**](docs/TranslateApi.md#translateSegmentPost) | **POST** /v2/translate | Translate a segment +*WorkflowsApi* | [**getWorkflowTemplates**](docs/WorkflowsApi.md#getWorkflowTemplates) | **GET** /v2/workflows/templates | Retrieve workflow templates ## Documentation for Models @@ -198,6 +200,7 @@ Class | Method | HTTP request | Description - [DocumentWithoutSegmentsStatus](docs/DocumentWithoutSegmentsStatus.md) - [Error](docs/Error.md) - [FileDeleteResponse](docs/FileDeleteResponse.md) + - [GetLiltCreateContentResponse](docs/GetLiltCreateContentResponse.md) - [InlineResponse200](docs/InlineResponse200.md) - [Job](docs/Job.md) - [JobCreateParameters](docs/JobCreateParameters.md) @@ -209,6 +212,8 @@ Class | Method | HTTP request | Description - [LanguagePair](docs/LanguagePair.md) - [LanguagesResponse](docs/LanguagesResponse.md) - [LiltCreateContent](docs/LiltCreateContent.md) + - [LiltCreateContentPreferences](docs/LiltCreateContentPreferences.md) + - [LiltCreateContentTemplateParams](docs/LiltCreateContentTemplateParams.md) - [Memory](docs/Memory.md) - [MemoryCreateParameters](docs/MemoryCreateParameters.md) - [MemoryDeleteResponse](docs/MemoryDeleteResponse.md) @@ -229,6 +234,8 @@ Class | Method | HTTP request | Description - [TranslationList](docs/TranslationList.md) - [TranslationMemoryEntry](docs/TranslationMemoryEntry.md) - [WorkflowStageAssignment](docs/WorkflowStageAssignment.md) + - [WorkflowStageTemplate](docs/WorkflowStageTemplate.md) + - [WorkflowTemplate](docs/WorkflowTemplate.md) ## Documentation for Authorization @@ -251,5 +258,5 @@ It's recommended to create an instance of `ApiClient` per thread in a multithrea ## Author -support@lilt.com + diff --git a/api/openapi.yaml b/api/openapi.yaml index 7e91f26d3..e783a5baf 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -1,34 +1,25 @@ openapi: 3.0.1 info: - contact: - email: support@lilt.com - name: Lilt REST API Support - url: https://developers.lilt.com/ - description: | - The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: - * Training of and translating with interactive, adaptive machine translation - * Large-scale translation memory - * The Lexicon (a large-scale termbase) - * Programmatic control of the Lilt CAT environment - * Translation memory synchronization - - Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. - - ## Authentication - - Requests are authenticated via REST API key, which requires the Business plan. - - Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. - - For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. - - ## Quotas - - Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + description: "Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals\ + \ \nThe Lilt REST API enables programmatic access to the full-range of Lilt\ + \ backend services including:\n * Training of and translating with interactive,\ + \ adaptive machine translation\n * Large-scale translation memory\n * The Lexicon\ + \ (a large-scale termbase)\n * Programmatic control of the Lilt CAT environment\n\ + \ * Translation memory synchronization\n\nRequests and responses are in JSON\ + \ format. The REST API only responds to HTTPS / SSL requests. \nThe base url for\ + \ this REST API is `https://api.lilt.com/`.\n\n## Authentication\n\nRequests are\ + \ authenticated via REST API key, which requires the Business plan.\n\nRequests\ + \ are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication).\ + \ Add your REST API key as both the `username` and `password`.\n\nFor development,\ + \ you may also pass the REST API key via the `key` query parameter. This is less\ + \ secure than HTTP Basic Auth, and is not recommended for production use.\n\n\ + ## Quotas\n\nOur services have a general quota of 4000 requests per minute. Should\ + \ you hit the maximum requests per minute, you will need to wait 60 seconds before\ + \ you can send another request.\n" title: Lilt REST API version: v3.0 servers: -- url: https://api.lilt.com/ +- url: https://api.lilt.com security: - ApiKeyAuth: [] - BasicAuth: [] @@ -299,7 +290,7 @@ paths: Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: - ``` + ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \ --header "LILT-API: {\"name\": \"my_memory.sdltm\",\"memory_id\": 42}" \ --header "Content-Type: application/octet-stream" \ @@ -307,12 +298,12 @@ paths: ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. - ``` + ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \ --header "LILT-API: {\"name\": \"my_memory.sdlxliff\",\"memory_id\": 12,\"sdlxliff_filters\":[{\"conf_name\": \"Translated\", \"percentage\": 100, \"allow_unlocked\": false}]"}" \ --header "Content-Type: application/octet-stream" \ --data-binary @my_memory.sdlxliff - + ``` operationId: importMemoryFile parameters: @@ -400,7 +391,7 @@ paths: endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. - ``` + ```bash curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` operationId: exportTermbase @@ -438,7 +429,7 @@ paths: Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. - ``` + ```bash curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` operationId: downloadTermbase @@ -475,7 +466,7 @@ paths: description: | Delete a segment from a memory. - ``` + ```bash curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` operationId: deleteSegmentFromMemory @@ -612,8 +603,8 @@ paths: Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: - ``` - curl --X --request GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' + ```bash + curl -X GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` operationId: monitorFileTranslation @@ -658,8 +649,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TranslationInfo' - description: Translation info + description: List of TranslationInfo objects + items: + $ref: '#/components/schemas/TranslationInfo' + title: monitorFileTranslationResponse + type: array + description: Translation Info default: content: application/json: @@ -675,8 +670,8 @@ paths: Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: - ``` - curl --X --request POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' + ```bash + curl -X POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` operationId: batchTranslateFile @@ -720,8 +715,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TranslationInfo' - description: Translation info + description: List of TranslationInfo objects + items: + $ref: '#/components/schemas/TranslationInfo' + title: batchTranslateFileResponse + type: array + description: Translation Info default: content: application/json: @@ -738,8 +737,8 @@ paths: Download a translated File. Example CURL: - ``` - curl --X --request GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' + ```bash + curl -X GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` operationId: downloadFile @@ -773,8 +772,8 @@ paths: endpoint. Example CURL: - ``` - curl --X --request POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \ + ```bash + curl -X POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{"signedAgreement": true}' ``` @@ -818,8 +817,8 @@ paths: Get a list of all content that has been generated by Lilt Create. Example CURL: - ``` - curl --X --request GET 'https://api.lilt.com/v2/create?key=API_KEY' + ```bash + curl -X GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` operationId: getLiltCreateContent @@ -828,9 +827,7 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/LiltCreateContent' - type: array + $ref: '#/components/schemas/getLiltCreateContentResponse' description: An object with a documents next task Workflow metadata. summary: Get Lilt Create content tags: @@ -841,8 +838,8 @@ paths: Generate new Lilt Create content with the given parameters. Example CURL: - ``` - curl --X --request POST 'https://api.lilt.com/v2/create?key=API_KEY' \ + ```bash + curl -X POST 'https://api.lilt.com/v2/create?key=API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{ "language":"en-US", @@ -887,8 +884,8 @@ paths: Get the stored preferences for Lilt Create. Example CURL: - ``` - curl --X --request POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' + ```bash + curl -X POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` operationId: getLiltCreatePreferences @@ -905,8 +902,8 @@ paths: Update the stored preferences for Lilt Create. Example CURL: - ``` - curl --X --request PUT + ```bash + curl -X PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{"tone": "formal", "styleguide": ""}' @@ -936,8 +933,8 @@ paths: Delete a piece of Lilt Create content. Example CURL: - ``` - curl --X --request DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' + ```bash + curl -X DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` operationId: deleteLiltCreateContent @@ -966,8 +963,8 @@ paths: Get Lilt Create content by ID. Example CURL: - ``` - curl --X --request GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' + ```bash + curl -X GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` operationId: getLiltCreateById @@ -996,8 +993,8 @@ paths: Update a piece of Lilt Create content. Example CURL: - ``` - curl --X --request PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \ + ```bash + curl -X PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{"language":"de-DE"}' ``` @@ -1037,8 +1034,8 @@ paths: Regenerate the given piece of content with the current parameters. Example CURL: - ``` - curl --X --request GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' + ```bash + curl -X GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` operationId: regenerateLiltCreateContent @@ -1064,6 +1061,26 @@ paths: tags: - Create x-accepts: application/json + /v2/workflows/templates: + get: + description: | + Get all of the possible Workflow Templates owned by the team. Useful for retrieving the ids corresponding to each workflow tables, and passing them to subsequent requests, for example, creating a new Job with a specific Workflow. + Example CURL: + ```bash curl -X GET 'https://api.lilt.com/v2/workflows/templates?key=API_KEY' ``` + operationId: getWorkflowTemplates + responses: + "200": + content: + application/json: + schema: + items: + $ref: '#/components/schemas/WorkflowTemplate' + type: array + description: An array with a team's available WorkflowTemplates. + summary: Retrieve workflow templates + tags: + - Workflows + x-accepts: application/json /v2/jobs: get: description: |- @@ -1071,7 +1088,7 @@ paths: Example CURL command: - ``` + ```bash curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` operationId: retrieveAllJobs @@ -1142,7 +1159,7 @@ paths: Example CURL command: - ``` + ```bash curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{ @@ -1184,10 +1201,8 @@ paths: workflowTemplateId: 14 autoAccept: true configId: 2332 - srcLocale: US memoryId: 1241 trgLang: de - srcLang: en - workflowStageAssignments: - workflowStageTemplateId: 12345 userId: 123 @@ -1205,11 +1220,9 @@ paths: workflowTemplateId: 14 autoAccept: true configId: 2332 - srcLocale: US memoryId: 1241 trgLang: de - srcLang: en - workflowTemplateId: 123 + workflowTemplateId: 6 fileIds: - 298 - 299 @@ -1217,7 +1230,6 @@ paths: name: My new Job srcLocale: US isPlural: true - workflowTemplateName: 6 srcLang: en properties: name: @@ -1256,15 +1268,9 @@ paths: example: true type: boolean workflowTemplateId: - description: Identifier of the workflow template to be used when - creating a job. If not passed the organization default will be - used. - example: 123 - type: integer - workflowTemplateName: - description: Name of the workflow template to be used, must be passed - with teamId or look up will fail. If workflowTemplateId is passed - it supercedes any other look up. + description: ID of the workflow template to be used. Use the [workflows + templates endpoint](#tag/Workflows/operation/getWorkflowTemplates) + to get the list of available workflows. type: integer required: - fileIds @@ -1302,7 +1308,7 @@ paths: Example CURL command: - ``` + ```bash curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` operationId: deleteJob @@ -1338,7 +1344,7 @@ paths: Example CURL command: - ``` + ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` operationId: getJob @@ -1376,7 +1382,7 @@ paths: Example CURL command: - ``` + ```bash curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{ @@ -1461,7 +1467,7 @@ paths: Example CURL command: - ``` + ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` operationId: getJobLeverageStats @@ -1500,7 +1506,7 @@ paths: Example CURL command: - ``` + ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` operationId: archiveJob @@ -1537,7 +1543,7 @@ paths: Example CURL command: - ``` + ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` operationId: unarchiveJob @@ -1576,7 +1582,7 @@ paths: Example CURL command: - ``` + ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` operationId: deliverJob @@ -1615,7 +1621,7 @@ paths: Example CURL command: - ``` + ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` operationId: reactivateJob @@ -1653,7 +1659,7 @@ paths: Example CURL command: - ``` + ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` @@ -1702,7 +1708,7 @@ paths: Example CURL command: - ``` + ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` operationId: downloadJob @@ -1946,7 +1952,7 @@ paths: Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: - ``` + ```bash curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` @@ -1999,7 +2005,7 @@ paths: File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: - ``` + ```bash curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \ --header "LILT-API: {\"name\": \"introduction.xliff\",\"pretranslate\": \"tm+mt\",\"project_id\": 9}" \ --header "Content-Type: application/octet-stream" \ @@ -2111,13 +2117,8 @@ paths: x-accepts: application/json /v2/files: delete: - description: |+ - Delete a File. - - Example CURL command: - ``` - curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` - + description: "Delete a File.\n\nExample CURL command:\n```bash\n curl -X DELETE\ + \ https://api.lilt.com/v2/files?key=API_KEY&id=123 \n```\n\n" operationId: deleteFile parameters: - description: A unique File identifier. @@ -2152,8 +2153,9 @@ paths: To retrieve a specific file, specify the id request parameter. To retrieve all files, omit the id request parameter. Example CURL command: + ```bash + curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274 ``` - curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274``` operationId: getFiles parameters: - description: A unique File identifier. @@ -2209,7 +2211,7 @@ paths: Request parameters should be passed in as query string parameters. Example CURL command: - ``` + ```bash curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \ --header "Content-Type: application/octet-stream" \ --data-binary @en_US.json @@ -2309,8 +2311,8 @@ paths: Download a File. Example CURL: - ``` - curl --X --request GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' + ```bash + curl -X GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` operationId: download parameters: @@ -2341,8 +2343,8 @@ paths: Remove a label from a File. Example CURL: - ``` - curl --X --request DELETE 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1&name=label_name' + ```bash + curl -X DELETE 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1&name=label_name' ``` operationId: removeLabel parameters: @@ -2375,8 +2377,8 @@ paths: Add a label to a File. Example CURL: - ``` - curl --X --request POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' + ```bash + curl -X POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \ --data-raw '{ "name": "label_name" @@ -2789,34 +2791,85 @@ components: description: | Content Parameters for LiltCreate. example: - summary: summary - tone: tone - terms: terms + template: template + preferences: + styleguide: styleguide + tone: tone + templateParams: + summary: summary + contentLength: 0 + language: language + memoryId: 6 + sections: + - sections + - sections language: language - memoryId: memoryId - sections: - - sections - - sections properties: - tone: - description: The tone of the content. + language: + description: The language of the content. type: string - terms: - description: The terms of the content. + template: + description: The template of the content. type: string - summary: - description: The summary of the content. + templateParams: + $ref: '#/components/schemas/LiltCreateContent_templateParams' + preferences: + $ref: '#/components/schemas/LiltCreateContent_preferences' + required: + - language + - template + - templateParams + type: object + WorkflowStageTemplate: + description: A single stage within a Workflow Template. + example: + name: Translate + assignmentType: TRANSLATE + properties: + name: + description: The human readable name of a Workflow stage. + example: Translate type: string - language: - description: The language of the content. + assignmentType: + description: An enum to represent all possible types of Workflow stage. + enum: + - READY_TO_START + - TRANSLATE + - REVIEW + - SECONDARY_REVIEW + - DONE + example: TRANSLATE type: string - memoryId: - description: The memory ID of the content. + type: object + WorkflowTemplate: + description: A workflow template which defines the workflow's possible steps + (combination of Translation, Review and Customer Review). + example: + name: Translate > Review > Customer Review + stages: + - name: Translate + assignmentType: TRANSLATE + - name: Translate + assignmentType: TRANSLATE + id: 15 + TeamId: 100 + properties: + id: + description: Identifier of a teams Workflow template. Can be used during + Job creation for specifying the workflow used for a job or language pair. + example: 15 + type: number + name: + example: Translate > Review > Customer Review type: string - sections: - description: The sections of the content. + TeamId: + description: The name of a given Workflow template. + example: 100 + type: number + stages: + description: The stages in this workflow template. items: - type: string + $ref: '#/components/schemas/WorkflowStageTemplate' type: array type: object JobProject: @@ -3160,19 +3213,9 @@ components: workflowTemplateId: 14 autoAccept: true configId: 2332 - srcLocale: US memoryId: 1241 trgLang: de - srcLang: en properties: - srcLang: - description: Source language, an ISO 639-1 language identifier. - example: en - type: string - srcLocale: - description: A locale identifier, supported for source language. - example: US - type: string trgLang: description: Target language, an ISO 639-1 language identifier. example: de @@ -4016,6 +4059,43 @@ components: type: boolean title: signLiltCreateTermsResponse type: object + getLiltCreateContentResponse: + example: + contents: + - template: template + preferences: + styleguide: styleguide + tone: tone + templateParams: + summary: summary + contentLength: 0 + language: language + memoryId: 6 + sections: + - sections + - sections + language: language + - template: template + preferences: + styleguide: styleguide + tone: tone + templateParams: + summary: summary + contentLength: 0 + language: language + memoryId: 6 + sections: + - sections + - sections + language: language + properties: + contents: + description: List of LiltCreateContent objects + items: + $ref: '#/components/schemas/LiltCreateContent' + type: array + title: getLiltCreateContentResponse + type: object inline_response_200: example: id: 0 @@ -4044,10 +4124,8 @@ components: workflowTemplateId: 14 autoAccept: true configId: 2332 - srcLocale: US memoryId: 1241 trgLang: de - srcLang: en - workflowStageAssignments: - workflowStageTemplateId: 12345 userId: 123 @@ -4065,11 +4143,9 @@ components: workflowTemplateId: 14 autoAccept: true configId: 2332 - srcLocale: US memoryId: 1241 trgLang: de - srcLang: en - workflowTemplateId: 123 + workflowTemplateId: 6 fileIds: - 298 - 299 @@ -4077,7 +4153,6 @@ components: name: My new Job srcLocale: US isPlural: true - workflowTemplateName: 6 srcLang: en properties: name: @@ -4116,14 +4191,9 @@ components: example: true type: boolean workflowTemplateId: - description: Identifier of the workflow template to be used when creating - a job. If not passed the organization default will be used. - example: 123 - type: integer - workflowTemplateName: - description: Name of the workflow template to be used, must be passed with - teamId or look up will fail. If workflowTemplateId is passed it supercedes - any other look up. + description: ID of the workflow template to be used. Use the [workflows + templates endpoint](#tag/Workflows/operation/getWorkflowTemplates) to + get the list of available workflows. type: integer required: - fileIds @@ -4266,6 +4336,51 @@ components: type: string title: AddFileLabelRequest type: object + LiltCreateContent_templateParams: + description: The template parameters of the content. + example: + summary: summary + contentLength: 0 + language: language + memoryId: 6 + sections: + - sections + - sections + properties: + contentLength: + description: The length of the content. + type: integer + memoryId: + description: The ID referencing a Data Source. + type: integer + language: + description: The language of the content. + type: string + sections: + description: The sections of the content. + items: + description: A section heading of the content. + type: string + type: array + summary: + description: The summary of the content. + type: string + required: + - language + type: object + LiltCreateContent_preferences: + description: The preferences of the content. + example: + styleguide: styleguide + tone: tone + properties: + tone: + description: The tone of the content. + type: string + styleguide: + description: The styleguide of the content. + type: string + type: object DocumentWithoutSegments_status: description: A list of translations for the query term. example: diff --git a/docs/CreateApi.md b/docs/CreateApi.md index 9d87a9d96..c07e7973d 100644 --- a/docs/CreateApi.md +++ b/docs/CreateApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description Delete Lilt Create content -Delete a piece of Lilt Create content. Example CURL: ``` curl --X --request DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` +Delete a piece of Lilt Create content. Example CURL: ```bash curl -X DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` ### Example ```java @@ -95,7 +95,7 @@ Name | Type | Description | Notes Generate new Lilt Create content -Generate new Lilt Create content with the given parameters. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` +Generate new Lilt Create content with the given parameters. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` ### Example ```java @@ -168,7 +168,7 @@ null (empty response body) Get Lilt Create content by ID. -Get Lilt Create content by ID. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` +Get Lilt Create content by ID. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` ### Example ```java @@ -238,11 +238,11 @@ Name | Type | Description | Notes # **getLiltCreateContent** -> List<LiltCreateContent> getLiltCreateContent() +> GetLiltCreateContentResponse getLiltCreateContent() Get Lilt Create content -Get a list of all content that has been generated by Lilt Create. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` +Get a list of all content that has been generated by Lilt Create. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` ### Example ```java @@ -272,7 +272,7 @@ public class Example { CreateApi apiInstance = new CreateApi(defaultClient); try { - List result = apiInstance.getLiltCreateContent(); + GetLiltCreateContentResponse result = apiInstance.getLiltCreateContent(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling CreateApi#getLiltCreateContent"); @@ -290,7 +290,7 @@ This endpoint does not need any parameter. ### Return type -[**List<LiltCreateContent>**](LiltCreateContent.md) +[**GetLiltCreateContentResponse**](GetLiltCreateContentResponse.md) ### Authorization @@ -312,7 +312,7 @@ This endpoint does not need any parameter. Get Lilt Create preferences -Get the stored preferences for Lilt Create. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` +Get the stored preferences for Lilt Create. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` ### Example ```java @@ -381,7 +381,7 @@ null (empty response body) Regenerate Lilt Create content -Regenerate the given piece of content with the current parameters. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` +Regenerate the given piece of content with the current parameters. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` ### Example ```java @@ -454,7 +454,7 @@ null (empty response body) Sign the Lilt Create terms and conditions -Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` +Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` ### Example ```java @@ -528,7 +528,7 @@ Name | Type | Description | Notes Update Lilt Create content -Update a piece of Lilt Create content. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` +Update a piece of Lilt Create content. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` ### Example ```java @@ -604,7 +604,7 @@ Name | Type | Description | Notes Update Lilt Create preferences -Update the stored preferences for Lilt Create. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` +Update the stored preferences for Lilt Create. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` ### Example ```java diff --git a/docs/DocumentsApi.md b/docs/DocumentsApi.md index bb486885a..c52d07f15 100644 --- a/docs/DocumentsApi.md +++ b/docs/DocumentsApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description Download a Document -Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ``` curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` +Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ```bash curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` ### Example ```java @@ -92,7 +92,7 @@ Name | Type | Description | Notes Upload a File -Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` +Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` ### Example ```java diff --git a/docs/FilesApi.md b/docs/FilesApi.md index 9715a7944..e4706cf75 100644 --- a/docs/FilesApi.md +++ b/docs/FilesApi.md @@ -18,7 +18,7 @@ Method | HTTP request | Description Add Label to File -Add a label to a File. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` +Add a label to a File. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` ### Example ```java @@ -93,7 +93,7 @@ null (empty response body) Delete a File -Delete a File. Example CURL command: ``` curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` +Delete a File. Example CURL command: ```bash curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` ### Example ```java @@ -168,7 +168,7 @@ Name | Type | Description | Notes Download file -Download a File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` +Download a File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` ### Example ```java @@ -242,7 +242,7 @@ Name | Type | Description | Notes Retrieve a File -Retrieves one or more files available to your user. Files are not associated with a project or a memory. They are unprocessed and can be used later in the project/document creation workflow step. To retrieve a specific file, specify the <strong>id</strong> request parameter. To retrieve all files, omit the <strong>id</strong> request parameter. Example CURL command: ``` curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274``` +Retrieves one or more files available to your user. Files are not associated with a project or a memory. They are unprocessed and can be used later in the project/document creation workflow step. To retrieve a specific file, specify the <strong>id</strong> request parameter. To retrieve all files, omit the <strong>id</strong> request parameter. Example CURL command: ```bash curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274 ``` ### Example ```java @@ -321,7 +321,7 @@ Name | Type | Description | Notes Remove Label from File -Remove a label from a File. Example CURL: ``` curl --X --request DELETE 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1&name=label_name' ``` +Remove a label from a File. Example CURL: ```bash curl -X DELETE 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1&name=label_name' ``` ### Example ```java @@ -396,7 +396,7 @@ null (empty response body) Upload a File -Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. +Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. ### Example ```java diff --git a/docs/GetLiltCreateContentResponse.md b/docs/GetLiltCreateContentResponse.md new file mode 100644 index 000000000..2e7fb2c1b --- /dev/null +++ b/docs/GetLiltCreateContentResponse.md @@ -0,0 +1,12 @@ + + +# GetLiltCreateContentResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**contents** | [**List<LiltCreateContent>**](LiltCreateContent.md) | List of LiltCreateContent objects | [optional] + + + diff --git a/docs/JobCreateParameters.md b/docs/JobCreateParameters.md index d337d1462..30b870d73 100644 --- a/docs/JobCreateParameters.md +++ b/docs/JobCreateParameters.md @@ -13,8 +13,7 @@ Name | Type | Description | Notes **srcLang** | **String** | 2-letter ISO source language code | **srcLocale** | **String** | 2-letter source language code | **isPlural** | **Boolean** | A boolean value representing if the files have plurals. | [optional] -**workflowTemplateId** | **Integer** | Identifier of the workflow template to be used when creating a job. If not passed the organization default will be used. | [optional] -**workflowTemplateName** | **Integer** | Name of the workflow template to be used, must be passed with teamId or look up will fail. If workflowTemplateId is passed it supercedes any other look up. | [optional] +**workflowTemplateId** | **Integer** | ID of the workflow template to be used. Use the [workflows templates endpoint](#tag/Workflows/operation/getWorkflowTemplates) to get the list of available workflows. | [optional] diff --git a/docs/JobsApi.md b/docs/JobsApi.md index 608599886..3f0b075d7 100644 --- a/docs/JobsApi.md +++ b/docs/JobsApi.md @@ -24,7 +24,7 @@ Method | HTTP request | Description Archive a Job -Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` +Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` ### Example ```java @@ -99,7 +99,7 @@ Name | Type | Description | Notes Create a Job -Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` +Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` ### Example ```java @@ -174,7 +174,7 @@ Name | Type | Description | Notes Delete a Job -Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ``` curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` +Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ```bash curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` ### Example ```java @@ -249,7 +249,7 @@ Name | Type | Description | Notes Deliver a Job -Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` +Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` ### Example ```java @@ -324,7 +324,7 @@ Name | Type | Description | Notes Download a Job -Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` +Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` ### Example ```java @@ -398,7 +398,7 @@ null (empty response body) Export a Job -Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. +Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. ### Example ```java @@ -474,7 +474,7 @@ null (empty response body) Retrieve a Job -Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` +Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` ### Example ```java @@ -549,7 +549,7 @@ Name | Type | Description | Notes Retrieve Job Leverage Stats -Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` +Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` ### Example ```java @@ -624,7 +624,7 @@ Name | Type | Description | Notes Reactivate a Job -Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` +Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` ### Example ```java @@ -699,7 +699,7 @@ Name | Type | Description | Notes Retrieve all Jobs -Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` +Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` ### Example ```java @@ -780,7 +780,7 @@ Name | Type | Description | Notes Unarchive a Job -Set job to unarchived, the job will move to active status. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` +Set job to unarchived, the job will move to active status. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` ### Example ```java @@ -855,7 +855,7 @@ Name | Type | Description | Notes Update a Job -Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ``` curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` +Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ```bash curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` ### Example ```java diff --git a/docs/LanguagePair.md b/docs/LanguagePair.md index d1fd253a7..b1d241c1b 100644 --- a/docs/LanguagePair.md +++ b/docs/LanguagePair.md @@ -7,8 +7,6 @@ A language pair couples the source and target language along with memory and pre Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**srcLang** | **String** | Source language, an ISO 639-1 language identifier. | [optional] -**srcLocale** | **String** | A locale identifier, supported for source language. | [optional] **trgLang** | **String** | Target language, an ISO 639-1 language identifier. | **trgLocale** | **String** | A locale identifier, supported for target language. | [optional] **dueDate** | **String** | An ISO date. | [optional] diff --git a/docs/LiltCreateContent.md b/docs/LiltCreateContent.md index 1616bd396..fb3804ce9 100644 --- a/docs/LiltCreateContent.md +++ b/docs/LiltCreateContent.md @@ -7,12 +7,10 @@ Content Parameters for LiltCreate. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tone** | **String** | The tone of the content. | [optional] -**terms** | **String** | The terms of the content. | [optional] -**summary** | **String** | The summary of the content. | [optional] -**language** | **String** | The language of the content. | [optional] -**memoryId** | **String** | The memory ID of the content. | [optional] -**sections** | **List<String>** | The sections of the content. | [optional] +**language** | **String** | The language of the content. | +**template** | **String** | The template of the content. | +**templateParams** | [**LiltCreateContentTemplateParams**](LiltCreateContentTemplateParams.md) | | +**preferences** | [**LiltCreateContentPreferences**](LiltCreateContentPreferences.md) | | [optional] diff --git a/docs/LiltCreateContentPreferences.md b/docs/LiltCreateContentPreferences.md new file mode 100644 index 000000000..fbe2ea212 --- /dev/null +++ b/docs/LiltCreateContentPreferences.md @@ -0,0 +1,14 @@ + + +# LiltCreateContentPreferences + +The preferences of the content. +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tone** | **String** | The tone of the content. | [optional] +**styleguide** | **String** | The styleguide of the content. | [optional] + + + diff --git a/docs/LiltCreateContentTemplateParams.md b/docs/LiltCreateContentTemplateParams.md new file mode 100644 index 000000000..97f135b9f --- /dev/null +++ b/docs/LiltCreateContentTemplateParams.md @@ -0,0 +1,17 @@ + + +# LiltCreateContentTemplateParams + +The template parameters of the content. +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**contentLength** | **Integer** | The length of the content. | [optional] +**memoryId** | **Integer** | The ID referencing a Data Source. | [optional] +**language** | **String** | The language of the content. | +**sections** | **List<String>** | The sections of the content. | [optional] +**summary** | **String** | The summary of the content. | [optional] + + + diff --git a/docs/MemoriesApi.md b/docs/MemoriesApi.md index 09774ec38..3b9d43313 100644 --- a/docs/MemoriesApi.md +++ b/docs/MemoriesApi.md @@ -171,7 +171,7 @@ Name | Type | Description | Notes Delete a segment from a memory. -Delete a segment from a memory. ``` curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` +Delete a segment from a memory. ```bash curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` ### Example ```java @@ -248,7 +248,7 @@ Name | Type | Description | Notes Termbase download for a Memory -Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ``` curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` +Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ```bash curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` ### Example ```java @@ -323,7 +323,7 @@ Name | Type | Description | Notes Termbase export for a Memory -Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ``` curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` +Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ```bash curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` ### Example ```java @@ -473,7 +473,7 @@ Name | Type | Description | Notes File import for a Memory -Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff +Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff ``` ### Example ```java diff --git a/docs/TranslateApi.md b/docs/TranslateApi.md index 9afcd9fff..8be12f991 100644 --- a/docs/TranslateApi.md +++ b/docs/TranslateApi.md @@ -12,11 +12,11 @@ Method | HTTP request | Description # **batchTranslateFile** -> TranslationInfo batchTranslateFile(fileId, memoryId, configId, withTM) +> List<TranslationInfo> batchTranslateFile(fileId, memoryId, configId, withTM) Translate a File -Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` +Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` ### Example ```java @@ -50,7 +50,7 @@ public class Example { BigDecimal configId = new BigDecimal(78); // BigDecimal | An optional pararameter to specify an import configuration to be applied when extracting translatable content from this file. Boolean withTM = true; // Boolean | An optional boolean parameter to toggle the use of Translation Memory in the translation of the file. try { - TranslationInfo result = apiInstance.batchTranslateFile(fileId, memoryId, configId, withTM); + List result = apiInstance.batchTranslateFile(fileId, memoryId, configId, withTM); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TranslateApi#batchTranslateFile"); @@ -74,7 +74,7 @@ Name | Type | Description | Notes ### Return type -[**TranslationInfo**](TranslationInfo.md) +[**List<TranslationInfo>**](TranslationInfo.md) ### Authorization @@ -88,7 +88,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Translation info | - | +**200** | Translation Info | - | **0** | Unexpected error | - | @@ -97,7 +97,7 @@ Name | Type | Description | Notes Download translated file -Download a translated File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` +Download a translated File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` ### Example ```java @@ -167,11 +167,11 @@ Name | Type | Description | Notes # **monitorFileTranslation** -> TranslationInfo monitorFileTranslation(translationIds, status, fromTime, toTime) +> List<TranslationInfo> monitorFileTranslation(translationIds, status, fromTime, toTime) Monitor file translation -Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` +Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` ### Example ```java @@ -205,7 +205,7 @@ public class Example { BigDecimal fromTime = new BigDecimal(78); // BigDecimal | Results after this time (inclusive) will be returned, specified as seconds since the Unix epoch. BigDecimal toTime = new BigDecimal(78); // BigDecimal | Results before this time (exclusive) will be returned, specified as seconds since the Unix epoch. try { - TranslationInfo result = apiInstance.monitorFileTranslation(translationIds, status, fromTime, toTime); + List result = apiInstance.monitorFileTranslation(translationIds, status, fromTime, toTime); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TranslateApi#monitorFileTranslation"); @@ -229,7 +229,7 @@ Name | Type | Description | Notes ### Return type -[**TranslationInfo**](TranslationInfo.md) +[**List<TranslationInfo>**](TranslationInfo.md) ### Authorization @@ -243,7 +243,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Translation info | - | +**200** | Translation Info | - | **0** | Unexpected error | - | diff --git a/docs/WorkflowStageTemplate.md b/docs/WorkflowStageTemplate.md new file mode 100644 index 000000000..8c6f3d3bc --- /dev/null +++ b/docs/WorkflowStageTemplate.md @@ -0,0 +1,26 @@ + + +# WorkflowStageTemplate + +A single stage within a Workflow Template. +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | The human readable name of a Workflow stage. | [optional] +**assignmentType** | [**AssignmentTypeEnum**](#AssignmentTypeEnum) | An enum to represent all possible types of Workflow stage. | [optional] + + + +## Enum: AssignmentTypeEnum + +Name | Value +---- | ----- +READY_TO_START | "READY_TO_START" +TRANSLATE | "TRANSLATE" +REVIEW | "REVIEW" +SECONDARY_REVIEW | "SECONDARY_REVIEW" +DONE | "DONE" + + + diff --git a/docs/WorkflowTemplate.md b/docs/WorkflowTemplate.md new file mode 100644 index 000000000..4f91d50cd --- /dev/null +++ b/docs/WorkflowTemplate.md @@ -0,0 +1,16 @@ + + +# WorkflowTemplate + +A workflow template which defines the workflow's possible steps (combination of Translation, Review and Customer Review). +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **BigDecimal** | Identifier of a teams Workflow template. Can be used during Job creation for specifying the workflow used for a job or language pair. | [optional] +**name** | **String** | | [optional] +**teamId** | **BigDecimal** | The name of a given Workflow template. | [optional] +**stages** | [**List<WorkflowStageTemplate>**](WorkflowStageTemplate.md) | The stages in this workflow template. | [optional] + + + diff --git a/docs/WorkflowsApi.md b/docs/WorkflowsApi.md new file mode 100644 index 000000000..2da831e86 --- /dev/null +++ b/docs/WorkflowsApi.md @@ -0,0 +1,79 @@ +# WorkflowsApi + +All URIs are relative to *https://api.lilt.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getWorkflowTemplates**](WorkflowsApi.md#getWorkflowTemplates) | **GET** /v2/workflows/templates | Retrieve workflow templates + + + +# **getWorkflowTemplates** +> List<WorkflowTemplate> getWorkflowTemplates() + +Retrieve workflow templates + +Get all of the possible Workflow Templates owned by the team. Useful for retrieving the ids corresponding to each workflow tables, and passing them to subsequent requests, for example, creating a new Job with a specific Workflow. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/workflows/templates?key=API_KEY' ``` + +### Example +```java +// Import classes: +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.Configuration; +import com.lilt.client.auth.*; +import com.lilt.client.models.*; +import com.lilt.client.api.WorkflowsApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.lilt.com"); + + // Configure API key authorization: ApiKeyAuth + ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth"); + ApiKeyAuth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //ApiKeyAuth.setApiKeyPrefix("Token"); + + // Configure HTTP basic authorization: BasicAuth + HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); + BasicAuth.setUsername("YOUR USERNAME"); + BasicAuth.setPassword("YOUR PASSWORD"); + + WorkflowsApi apiInstance = new WorkflowsApi(defaultClient); + try { + List result = apiInstance.getWorkflowTemplates(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling WorkflowsApi#getWorkflowTemplates"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<WorkflowTemplate>**](WorkflowTemplate.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth), [BasicAuth](../README.md#BasicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | An array with a team's available WorkflowTemplates. | - | + diff --git a/pom.xml b/pom.xml index 1f92e2b55..1b536051a 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ openapi-java-client jar openapi-java-client - 2.2.0 + 3.0.0 https://github.com/openapitools/openapi-generator OpenAPI Java diff --git a/src/main/java/com/lilt/client/ApiCallback.java b/src/main/java/com/lilt/client/ApiCallback.java index 7e638f3c1..327ee86ce 100644 --- a/src/main/java/com/lilt/client/ApiCallback.java +++ b/src/main/java/com/lilt/client/ApiCallback.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/ApiClient.java b/src/main/java/com/lilt/client/ApiClient.java index 7a27128f5..7f6e82bc8 100644 --- a/src/main/java/com/lilt/client/ApiClient.java +++ b/src/main/java/com/lilt/client/ApiClient.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -125,7 +125,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/2.2.0/java"); + setUserAgent("OpenAPI-Generator/3.0.0/java"); authentications = new HashMap(); } diff --git a/src/main/java/com/lilt/client/ApiException.java b/src/main/java/com/lilt/client/ApiException.java index 0be2734a9..c38112d53 100644 --- a/src/main/java/com/lilt/client/ApiException.java +++ b/src/main/java/com/lilt/client/ApiException.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -16,7 +16,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class ApiException extends Exception { private int code = 0; private Map> responseHeaders = null; diff --git a/src/main/java/com/lilt/client/ApiResponse.java b/src/main/java/com/lilt/client/ApiResponse.java index 63501644e..297d18c5a 100644 --- a/src/main/java/com/lilt/client/ApiResponse.java +++ b/src/main/java/com/lilt/client/ApiResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/Configuration.java b/src/main/java/com/lilt/client/Configuration.java index cf493b65d..c60c9d408 100644 --- a/src/main/java/com/lilt/client/Configuration.java +++ b/src/main/java/com/lilt/client/Configuration.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -13,7 +13,7 @@ package com.lilt.client; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Configuration { private static ApiClient defaultApiClient = new ApiClient(); diff --git a/src/main/java/com/lilt/client/GzipRequestInterceptor.java b/src/main/java/com/lilt/client/GzipRequestInterceptor.java index 967490dfc..f1f53e540 100644 --- a/src/main/java/com/lilt/client/GzipRequestInterceptor.java +++ b/src/main/java/com/lilt/client/GzipRequestInterceptor.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/JSON.java b/src/main/java/com/lilt/client/JSON.java index d07044411..53249545a 100644 --- a/src/main/java/com/lilt/client/JSON.java +++ b/src/main/java/com/lilt/client/JSON.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/Pair.java b/src/main/java/com/lilt/client/Pair.java index 9875c3b8a..3412280c5 100644 --- a/src/main/java/com/lilt/client/Pair.java +++ b/src/main/java/com/lilt/client/Pair.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -13,7 +13,7 @@ package com.lilt.client; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Pair { private String name = ""; private String value = ""; diff --git a/src/main/java/com/lilt/client/ProgressRequestBody.java b/src/main/java/com/lilt/client/ProgressRequestBody.java index 210b2835d..f4c41ed56 100644 --- a/src/main/java/com/lilt/client/ProgressRequestBody.java +++ b/src/main/java/com/lilt/client/ProgressRequestBody.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/ProgressResponseBody.java b/src/main/java/com/lilt/client/ProgressResponseBody.java index b4d9342ae..23ebe729c 100644 --- a/src/main/java/com/lilt/client/ProgressResponseBody.java +++ b/src/main/java/com/lilt/client/ProgressResponseBody.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/StringUtil.java b/src/main/java/com/lilt/client/StringUtil.java index 572280335..2e9c2174a 100644 --- a/src/main/java/com/lilt/client/StringUtil.java +++ b/src/main/java/com/lilt/client/StringUtil.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -16,7 +16,7 @@ import java.util.Collection; import java.util.Iterator; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class StringUtil { /** * Check if the given array contains the given value (with case-insensitive comparison). diff --git a/src/main/java/com/lilt/client/api/CreateApi.java b/src/main/java/com/lilt/client/api/CreateApi.java index 9d683f04c..b4e16e1bd 100644 --- a/src/main/java/com/lilt/client/api/CreateApi.java +++ b/src/main/java/com/lilt/client/api/CreateApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,6 +28,7 @@ import com.lilt.client.model.CreateConverterConfigParameters; +import com.lilt.client.model.GetLiltCreateContentResponse; import com.lilt.client.model.InlineResponse200; import com.lilt.client.model.LiltCreateContent; import com.lilt.client.model.SignLiltCreateTermsResponse; @@ -116,7 +117,7 @@ private okhttp3.Call deleteLiltCreateContentValidateBeforeCall(Integer contentId /** * Delete Lilt Create content - * Delete a piece of Lilt Create content. Example CURL: ``` curl --X --request DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` + * Delete a piece of Lilt Create content. Example CURL: ```bash curl -X DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` * @param contentId The content ID. (required) * @return InlineResponse200 * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -133,7 +134,7 @@ public InlineResponse200 deleteLiltCreateContent(Integer contentId) throws ApiEx /** * Delete Lilt Create content - * Delete a piece of Lilt Create content. Example CURL: ``` curl --X --request DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` + * Delete a piece of Lilt Create content. Example CURL: ```bash curl -X DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` * @param contentId The content ID. (required) * @return ApiResponse<InlineResponse200> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -151,7 +152,7 @@ public ApiResponse deleteLiltCreateContentWithHttpInfo(Intege /** * Delete Lilt Create content (asynchronously) - * Delete a piece of Lilt Create content. Example CURL: ``` curl --X --request DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` + * Delete a piece of Lilt Create content. Example CURL: ```bash curl -X DELETE 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` * @param contentId The content ID. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -227,7 +228,7 @@ private okhttp3.Call generateLiltCreateContentValidateBeforeCall(LiltCreateConte /** * Generate new Lilt Create content - * Generate new Lilt Create content with the given parameters. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` + * Generate new Lilt Create content with the given parameters. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` * @param templateParams Input parameters that determine what content will be generated. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -242,7 +243,7 @@ public void generateLiltCreateContent(LiltCreateContent templateParams) throws A /** * Generate new Lilt Create content - * Generate new Lilt Create content with the given parameters. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` + * Generate new Lilt Create content with the given parameters. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` * @param templateParams Input parameters that determine what content will be generated. (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -259,7 +260,7 @@ public ApiResponse generateLiltCreateContentWithHttpInfo(LiltCreateContent /** * Generate new Lilt Create content (asynchronously) - * Generate new Lilt Create content with the given parameters. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` + * Generate new Lilt Create content with the given parameters. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"language\":\"en-US\", \"template\":\"blog-post\", \"templateParams\":{ \"contentLength\":\"100\", \"language\":\"en-US\", \"sections\":[], \"summary\":\"a blog post about hiking\" }, \"preferences\":{\"tone\":\"formal\",\"styleguide\":\"\"} }' ``` * @param templateParams Input parameters that determine what content will be generated. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -335,7 +336,7 @@ private okhttp3.Call getLiltCreateByIdValidateBeforeCall(Integer contentId, fina /** * Get Lilt Create content by ID. - * Get Lilt Create content by ID. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` + * Get Lilt Create content by ID. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` * @param contentId The content ID. (required) * @return LiltCreateContent * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -352,7 +353,7 @@ public LiltCreateContent getLiltCreateById(Integer contentId) throws ApiExceptio /** * Get Lilt Create content by ID. - * Get Lilt Create content by ID. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` + * Get Lilt Create content by ID. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` * @param contentId The content ID. (required) * @return ApiResponse<LiltCreateContent> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -370,7 +371,7 @@ public ApiResponse getLiltCreateByIdWithHttpInfo(Integer cont /** * Get Lilt Create content by ID. (asynchronously) - * Get Lilt Create content by ID. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` + * Get Lilt Create content by ID. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234?key=API_KEY' ``` * @param contentId The content ID. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -440,8 +441,8 @@ private okhttp3.Call getLiltCreateContentValidateBeforeCall(final ApiCallback _c /** * Get Lilt Create content - * Get a list of all content that has been generated by Lilt Create. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` - * @return List<LiltCreateContent> + * Get a list of all content that has been generated by Lilt Create. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` + * @return GetLiltCreateContentResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -449,15 +450,15 @@ private okhttp3.Call getLiltCreateContentValidateBeforeCall(final ApiCallback _c
200 An object with a documents next task Workflow metadata. -
*/ - public List getLiltCreateContent() throws ApiException { - ApiResponse> localVarResp = getLiltCreateContentWithHttpInfo(); + public GetLiltCreateContentResponse getLiltCreateContent() throws ApiException { + ApiResponse localVarResp = getLiltCreateContentWithHttpInfo(); return localVarResp.getData(); } /** * Get Lilt Create content - * Get a list of all content that has been generated by Lilt Create. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` - * @return ApiResponse<List<LiltCreateContent>> + * Get a list of all content that has been generated by Lilt Create. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` + * @return ApiResponse<GetLiltCreateContentResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -465,15 +466,15 @@ public List getLiltCreateContent() throws ApiException {
200 An object with a documents next task Workflow metadata. -
*/ - public ApiResponse> getLiltCreateContentWithHttpInfo() throws ApiException { + public ApiResponse getLiltCreateContentWithHttpInfo() throws ApiException { okhttp3.Call localVarCall = getLiltCreateContentValidateBeforeCall(null); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Get Lilt Create content (asynchronously) - * Get a list of all content that has been generated by Lilt Create. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` + * Get a list of all content that has been generated by Lilt Create. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create?key=API_KEY' ``` * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -483,10 +484,10 @@ public ApiResponse> getLiltCreateContentWithHttpInfo() t 200 An object with a documents next task Workflow metadata. - */ - public okhttp3.Call getLiltCreateContentAsync(final ApiCallback> _callback) throws ApiException { + public okhttp3.Call getLiltCreateContentAsync(final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = getLiltCreateContentValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -542,7 +543,7 @@ private okhttp3.Call getLiltCreatePreferencesValidateBeforeCall(final ApiCallbac /** * Get Lilt Create preferences - * Get the stored preferences for Lilt Create. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` + * Get the stored preferences for Lilt Create. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -556,7 +557,7 @@ public void getLiltCreatePreferences() throws ApiException { /** * Get Lilt Create preferences - * Get the stored preferences for Lilt Create. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` + * Get the stored preferences for Lilt Create. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -572,7 +573,7 @@ public ApiResponse getLiltCreatePreferencesWithHttpInfo() throws ApiExcept /** * Get Lilt Create preferences (asynchronously) - * Get the stored preferences for Lilt Create. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` + * Get the stored preferences for Lilt Create. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/preferences?key=API_KEY' ``` * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -647,7 +648,7 @@ private okhttp3.Call regenerateLiltCreateContentValidateBeforeCall(Integer conte /** * Regenerate Lilt Create content - * Regenerate the given piece of content with the current parameters. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` + * Regenerate the given piece of content with the current parameters. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` * @param contentId The content ID. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -662,7 +663,7 @@ public void regenerateLiltCreateContent(Integer contentId) throws ApiException { /** * Regenerate Lilt Create content - * Regenerate the given piece of content with the current parameters. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` + * Regenerate the given piece of content with the current parameters. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` * @param contentId The content ID. (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -679,7 +680,7 @@ public ApiResponse regenerateLiltCreateContentWithHttpInfo(Integer content /** * Regenerate Lilt Create content (asynchronously) - * Regenerate the given piece of content with the current parameters. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` + * Regenerate the given piece of content with the current parameters. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/create/1234/create?key=API_KEY' ``` * @param contentId The content ID. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -754,7 +755,7 @@ private okhttp3.Call signLiltCreateTermsValidateBeforeCall(CreateConverterConfig /** * Sign the Lilt Create terms and conditions - * Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` + * Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` * @param signedAgreement (required) * @return SignLiltCreateTermsResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -771,7 +772,7 @@ public SignLiltCreateTermsResponse signLiltCreateTerms(CreateConverterConfigPara /** * Sign the Lilt Create terms and conditions - * Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` + * Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` * @param signedAgreement (required) * @return ApiResponse<SignLiltCreateTermsResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -789,7 +790,7 @@ public ApiResponse signLiltCreateTermsWithHttpInfo( /** * Sign the Lilt Create terms and conditions (asynchronously) - * Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` + * Lilt Create requires that the terms and conditions are signed first before using it. The terms and conditions can be signed by using this endpoint. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/create/terms-and-conditions?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"signedAgreement\": true}' ``` * @param signedAgreement (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -867,7 +868,7 @@ private okhttp3.Call updateLiltCreateContentValidateBeforeCall(Integer contentId /** * Update Lilt Create content - * Update a piece of Lilt Create content. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` + * Update a piece of Lilt Create content. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` * @param contentId The content ID. (required) * @param body (optional) * @return LiltCreateContent @@ -885,7 +886,7 @@ public LiltCreateContent updateLiltCreateContent(Integer contentId, LiltCreateCo /** * Update Lilt Create content - * Update a piece of Lilt Create content. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` + * Update a piece of Lilt Create content. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` * @param contentId The content ID. (required) * @param body (optional) * @return ApiResponse<LiltCreateContent> @@ -904,7 +905,7 @@ public ApiResponse updateLiltCreateContentWithHttpInfo(Intege /** * Update Lilt Create content (asynchronously) - * Update a piece of Lilt Create content. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` + * Update a piece of Lilt Create content. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/1234?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"language\":\"de-DE\"}' ``` * @param contentId The content ID. (required) * @param body (optional) * @param _callback The callback to be executed when the API call finishes @@ -976,7 +977,7 @@ private okhttp3.Call updateLiltCreatePreferencesValidateBeforeCall(LiltCreateCon /** * Update Lilt Create preferences - * Update the stored preferences for Lilt Create. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` + * Update the stored preferences for Lilt Create. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` * @param styleguide Which styleguide to use. (optional) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -991,7 +992,7 @@ public void updateLiltCreatePreferences(LiltCreateContent styleguide) throws Api /** * Update Lilt Create preferences - * Update the stored preferences for Lilt Create. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` + * Update the stored preferences for Lilt Create. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` * @param styleguide Which styleguide to use. (optional) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1008,7 +1009,7 @@ public ApiResponse updateLiltCreatePreferencesWithHttpInfo(LiltCreateConte /** * Update Lilt Create preferences (asynchronously) - * Update the stored preferences for Lilt Create. Example CURL: ``` curl --X --request PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` + * Update the stored preferences for Lilt Create. Example CURL: ```bash curl -X PUT 'https://api.lilt.com/v2/create/preferences?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{\"tone\": \"formal\", \"styleguide\": \"\"}' ``` * @param styleguide Which styleguide to use. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/com/lilt/client/api/DocumentsApi.java b/src/main/java/com/lilt/client/api/DocumentsApi.java index ee4893425..68f10d162 100644 --- a/src/main/java/com/lilt/client/api/DocumentsApi.java +++ b/src/main/java/com/lilt/client/api/DocumentsApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -125,7 +125,7 @@ private okhttp3.Call downloadDocumentValidateBeforeCall(Integer id, Boolean isXl /** * Download a Document - * Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ``` curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` + * Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ```bash curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` * @param id An unique Document identifier. (required) * @param isXliff Download the document in XLIFF 1.2 format. (optional, default to true) * @return byte[] @@ -145,7 +145,7 @@ public byte[] downloadDocument(Integer id, Boolean isXliff) throws ApiException /** * Download a Document - * Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ``` curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` + * Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ```bash curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` * @param id An unique Document identifier. (required) * @param isXliff Download the document in XLIFF 1.2 format. (optional, default to true) * @return ApiResponse<byte[]> @@ -166,7 +166,7 @@ public ApiResponse downloadDocumentWithHttpInfo(Integer id, Boolean isXl /** * Download a Document (asynchronously) - * Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ``` curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` + * Export a Document that has been translated in the Lilt web application. Any Document can be downloaded in XLIFF 1.2 format, or can be retrieved in its original uploaded format by setting `is_xliff=false`. This endpoint will fail if either (a) export or (b) pre-translation operations are in-progress. The status of those operations can be determined by retrieving the Document resource. Example CURL command: ```bash curl -X GET https://api.lilt.com/v2/documents/files?key=API_KEY&id=274 -o from_lilt.xliff ``` * @param id An unique Document identifier. (required) * @param isXliff Download the document in XLIFF 1.2 format. (optional, default to true) * @param _callback The callback to be executed when the API call finishes @@ -291,7 +291,7 @@ private okhttp3.Call uploadDocumentValidateBeforeCall(String name, Integer proje /** * Upload a File - * Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` + * Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` * @param name A file name. (required) * @param projectId A unique Project identifier. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) @@ -316,7 +316,7 @@ public DocumentWithSegments uploadDocument(String name, Integer projectId, File /** * Upload a File - * Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` + * Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` * @param name A file name. (required) * @param projectId A unique Project identifier. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) @@ -342,7 +342,7 @@ public ApiResponse uploadDocumentWithHttpInfo(String name, /** * Upload a File (asynchronously) - * Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` + * Create a Document from a file in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed as JSON object with the header field `LILT-API`. File names in the header can only contain [US-ASCII characters](https://en.wikipedia.org/wiki/ASCII). File names with characters outside of US-ASCII should be [URI encoded](https://en.wikipedia.org/wiki/Percent-encoding) or transliterated to US-ASCII strings. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/documents/files?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"introduction.xliff\\\",\\\"pretranslate\\\": \\\"tm+mt\\\",\\\"project_id\\\": 9}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @Introduction.xliff ``` * @param name A file name. (required) * @param projectId A unique Project identifier. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) diff --git a/src/main/java/com/lilt/client/api/FilesApi.java b/src/main/java/com/lilt/client/api/FilesApi.java index b01356a70..c4c9961e4 100644 --- a/src/main/java/com/lilt/client/api/FilesApi.java +++ b/src/main/java/com/lilt/client/api/FilesApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -126,7 +126,7 @@ private okhttp3.Call addLabelValidateBeforeCall(String id, AddFileLabelRequest n /** * Add Label to File - * Add a label to a File. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` + * Add a label to a File. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` * @param id A File id. (required) * @param name (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -142,7 +142,7 @@ public void addLabel(String id, AddFileLabelRequest name) throws ApiException { /** * Add Label to File - * Add a label to a File. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` + * Add a label to a File. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` * @param id A File id. (required) * @param name (required) * @return ApiResponse<Void> @@ -160,7 +160,7 @@ public ApiResponse addLabelWithHttpInfo(String id, AddFileLabelRequest nam /** * Add Label to File (asynchronously) - * Add a label to a File. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` + * Add a label to a File. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1' --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"label_name\" }' ``` * @param id A File id. (required) * @param name (required) * @param _callback The callback to be executed when the API call finishes @@ -241,7 +241,7 @@ private okhttp3.Call deleteFileValidateBeforeCall(Integer id, final ApiCallback /** * Delete a File - * Delete a File. Example CURL command: ``` curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` + * Delete a File. Example CURL command: ```bash curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` * @param id A unique File identifier. (required) * @return FileDeleteResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -259,7 +259,7 @@ public FileDeleteResponse deleteFile(Integer id) throws ApiException { /** * Delete a File - * Delete a File. Example CURL command: ``` curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` + * Delete a File. Example CURL command: ```bash curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` * @param id A unique File identifier. (required) * @return ApiResponse<FileDeleteResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -278,7 +278,7 @@ public ApiResponse deleteFileWithHttpInfo(Integer id) throws /** * Delete a File (asynchronously) - * Delete a File. Example CURL command: ``` curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` + * Delete a File. Example CURL command: ```bash curl -X DELETE https://api.lilt.com/v2/files?key=API_KEY&id=123 ``` * @param id A unique File identifier. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -359,7 +359,7 @@ private okhttp3.Call downloadValidateBeforeCall(String id, final ApiCallback _ca /** * Download file - * Download a File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` + * Download a File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` * @param id A File id. (required) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -376,7 +376,7 @@ public byte[] download(String id) throws ApiException { /** * Download file - * Download a File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` + * Download a File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` * @param id A File id. (required) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -394,7 +394,7 @@ public ApiResponse downloadWithHttpInfo(String id) throws ApiException { /** * Download file (asynchronously) - * Download a File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` + * Download a File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/files/download?key=API_KEY&id=1' ``` * @param id A File id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -477,7 +477,7 @@ private okhttp3.Call getFilesValidateBeforeCall(Integer id, List labels, /** * Retrieve a File - * Retrieves one or more files available to your user. Files are not associated with a project or a memory. They are unprocessed and can be used later in the project/document creation workflow step. To retrieve a specific file, specify the <strong>id</strong> request parameter. To retrieve all files, omit the <strong>id</strong> request parameter. Example CURL command: ``` curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274``` + * Retrieves one or more files available to your user. Files are not associated with a project or a memory. They are unprocessed and can be used later in the project/document creation workflow step. To retrieve a specific file, specify the <strong>id</strong> request parameter. To retrieve all files, omit the <strong>id</strong> request parameter. Example CURL command: ```bash curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274 ``` * @param id A unique File identifier. (optional) * @param labels One or more labels. This will return the files which contain all of the given labels. (optional) * @return List<SourceFile> @@ -498,7 +498,7 @@ public List getFiles(Integer id, List labels) throws ApiExce /** * Retrieve a File - * Retrieves one or more files available to your user. Files are not associated with a project or a memory. They are unprocessed and can be used later in the project/document creation workflow step. To retrieve a specific file, specify the <strong>id</strong> request parameter. To retrieve all files, omit the <strong>id</strong> request parameter. Example CURL command: ``` curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274``` + * Retrieves one or more files available to your user. Files are not associated with a project or a memory. They are unprocessed and can be used later in the project/document creation workflow step. To retrieve a specific file, specify the <strong>id</strong> request parameter. To retrieve all files, omit the <strong>id</strong> request parameter. Example CURL command: ```bash curl -X GET https://api.lilt.com/v2/files?key=API_KEY&id=274 ``` * @param id A unique File identifier. (optional) * @param labels One or more labels. This will return the files which contain all of the given labels. (optional) * @return ApiResponse<List<SourceFile>> @@ -520,7 +520,7 @@ public ApiResponse> getFilesWithHttpInfo(Integer id, List removeLabelWithHttpInfo(String id, String name) throws /** * Remove Label from File (asynchronously) - * Remove a label from a File. Example CURL: ``` curl --X --request DELETE 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1&name=label_name' ``` + * Remove a label from a File. Example CURL: ```bash curl -X DELETE 'https://api.lilt.com/v2/files/labels?key=API_KEY&id=1&name=label_name' ``` * @param id A File id. (required) * @param name A label name. (required) * @param _callback The callback to be executed when the API call finishes @@ -760,7 +760,7 @@ private okhttp3.Call uploadFileValidateBeforeCall(String name, File body, String /** * Upload a File - * Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. + * Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. * @param name A file name. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) * @param fileHash A hash value to associate with the file. The MD5 hash of the body contents will be used by default if a value isn't provided. (optional) @@ -784,7 +784,7 @@ public SourceFile uploadFile(String name, File body, String fileHash, Boolean la /** * Upload a File - * Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. + * Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. * @param name A file name. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) * @param fileHash A hash value to associate with the file. The MD5 hash of the body contents will be used by default if a value isn't provided. (optional) @@ -809,7 +809,7 @@ public ApiResponse uploadFileWithHttpInfo(String name, File body, St /** * Upload a File (asynchronously) - * Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ``` curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. + * Upload a File in any of the formats [documented in our knowledge base](https://support.lilt.com/hc/en-us/articles/360020816253-File-Formats). Request parameters should be passed in as query string parameters. Example CURL command: ```bash curl -X POST https://api.lilt.com/v2/files?key=API_KEY&name=en_US.json \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @en_US.json ``` Calls to GET /files are used to monitor the language detection results. The API response will be augmented to include detected language and confidence score. The language detection will complete asynchronously. Prior to completion, the `detected_lang` value will be `zxx`, the reserved ISO 639-2 code for \"No linguistic content/not applicable\". If the language can not be determined, or the detection process fails, the `detected_lang` field will return `und`, the reserved ISO 639-2 code for undetermined language, and the `detected_lang_confidence` score will be `0`. * @param name A file name. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) * @param fileHash A hash value to associate with the file. The MD5 hash of the body contents will be used by default if a value isn't provided. (optional) diff --git a/src/main/java/com/lilt/client/api/JobsApi.java b/src/main/java/com/lilt/client/api/JobsApi.java index 50aaee4e9..bd56ce9a2 100644 --- a/src/main/java/com/lilt/client/api/JobsApi.java +++ b/src/main/java/com/lilt/client/api/JobsApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -119,7 +119,7 @@ private okhttp3.Call archiveJobValidateBeforeCall(Integer jobId, final ApiCallba /** * Archive a Job - * Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` + * Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` * @param jobId A job id. (required) * @return Job * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -137,7 +137,7 @@ public Job archiveJob(Integer jobId) throws ApiException { /** * Archive a Job - * Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` + * Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<Job> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -156,7 +156,7 @@ public ApiResponse archiveJobWithHttpInfo(Integer jobId) throws ApiExceptio /** * Archive a Job (asynchronously) - * Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` + * Set job to archived, unassign all linguists and archive all projects and documents inside the job. It will return the archived job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/archive?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -234,7 +234,7 @@ private okhttp3.Call createJobValidateBeforeCall(JobCreateParameters body, final /** * Create a Job - * Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` + * Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` * @param body (required) * @return Job * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -252,7 +252,7 @@ public Job createJob(JobCreateParameters body) throws ApiException { /** * Create a Job - * Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` + * Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` * @param body (required) * @return ApiResponse<Job> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -271,7 +271,7 @@ public ApiResponse createJobWithHttpInfo(JobCreateParameters body) throws A /** * Create a Job (asynchronously) - * Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` + * Create a Job. A Job is a collection of Projects. A Job will contain multiple projects, based on the language pair. A Project is associated with exactly one Memory. Jobs appear in the Jobs dashboard of the web app. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"fileIds\": [5009, 5010, 5011], \"due\": \"2022-05-05T10:56:44.985Z\", \"srcLang\": \"en\", \"srcLocale\": \"US\", \"languagePairs\": [ { \"memoryId\": 3121, \"trgLang\": \"de\" }, { \"memoryId\": 2508, \"trgLang\": \"fr\" }, { \"memoryId\": 3037, \"trgLang\": \"zh\" } ] }' ``` * @param body (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -350,7 +350,7 @@ private okhttp3.Call deleteJobValidateBeforeCall(Integer jobId, final ApiCallbac /** * Delete a Job - * Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ``` curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` + * Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ```bash curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` * @param jobId A job id. (required) * @return JobDeleteResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -368,7 +368,7 @@ public JobDeleteResponse deleteJob(Integer jobId) throws ApiException { /** * Delete a Job - * Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ``` curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` + * Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ```bash curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<JobDeleteResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -387,7 +387,7 @@ public ApiResponse deleteJobWithHttpInfo(Integer jobId) throw /** * Delete a Job (asynchronously) - * Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ``` curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` + * Delete a job, deletes all projects and documents in the job, deletes all the segments from all the job's translation memories. Example CURL command: ```bash curl -X DELETE 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -466,7 +466,7 @@ private okhttp3.Call deliverJobValidateBeforeCall(Integer jobId, final ApiCallba /** * Deliver a Job - * Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` + * Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` * @param jobId A job id. (required) * @return Job * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -484,7 +484,7 @@ public Job deliverJob(Integer jobId) throws ApiException { /** * Deliver a Job - * Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` + * Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<Job> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -503,7 +503,7 @@ public ApiResponse deliverJobWithHttpInfo(Integer jobId) throws ApiExceptio /** * Deliver a Job (asynchronously) - * Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` + * Set the job state to delivered and set all the projects in the job to done It will return the delivered job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/deliver?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -582,7 +582,7 @@ private okhttp3.Call downloadJobValidateBeforeCall(Integer jobId, final ApiCallb /** * Download a Job - * Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` + * Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` * @param jobId A job id. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -598,7 +598,7 @@ public void downloadJob(Integer jobId) throws ApiException { /** * Download a Job - * Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` + * Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -616,7 +616,7 @@ public ApiResponse downloadJobWithHttpInfo(Integer jobId) throws ApiExcept /** * Download a Job (asynchronously) - * Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` + * Make sure you have exported a job with the same id before using this api. Downloading files requires the exported job `id` in the param. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/download?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -704,7 +704,7 @@ private okhttp3.Call exportJobValidateBeforeCall(Integer jobId, String type, fin /** * Export a Job - * Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. + * Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. * @param jobId A job id. (required) * @param type category for files and memory. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -721,7 +721,7 @@ public void exportJob(Integer jobId, String type) throws ApiException { /** * Export a Job - * Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. + * Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. * @param jobId A job id. (required) * @param type category for files and memory. (required) * @return ApiResponse<Void> @@ -740,7 +740,7 @@ public ApiResponse exportJobWithHttpInfo(Integer jobId, String type) throw /** * Export a Job (asynchronously) - * Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. + * Prepare job files for download. To export translated documents from the job use the query parameter `type=files`: Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}/export?key=API_KEY&type=files' ``` To export job memories use the query parameter `type=memory`. The status of the export can be checked by requesting the job `GET /jobs/:jobId`, `job.isProcessing` will be `1` while in progress, `0` when idle and `-2` when the export failed. * @param jobId A job id. (required) * @param type category for files and memory. (required) * @param _callback The callback to be executed when the API call finishes @@ -819,7 +819,7 @@ private okhttp3.Call getJobValidateBeforeCall(Integer jobId, final ApiCallback _ /** * Retrieve a Job - * Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` + * Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` * @param jobId A job id. (required) * @return Job * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -837,7 +837,7 @@ public Job getJob(Integer jobId) throws ApiException { /** * Retrieve a Job - * Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` + * Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<Job> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -856,7 +856,7 @@ public ApiResponse getJobWithHttpInfo(Integer jobId) throws ApiException { /** * Retrieve a Job (asynchronously) - * Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` + * Retrieves a job data along with stats. To retrieve a specific job, you will need the job `id` in the url path. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -935,7 +935,7 @@ private okhttp3.Call getJobLeverageStatsValidateBeforeCall(Integer jobId, final /** * Retrieve Job Leverage Stats - * Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` + * Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` * @param jobId A job id. (required) * @return JobLeverageStats * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -953,7 +953,7 @@ public JobLeverageStats getJobLeverageStats(Integer jobId) throws ApiException { /** * Retrieve Job Leverage Stats - * Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` + * Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<JobLeverageStats> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -972,7 +972,7 @@ public ApiResponse getJobLeverageStatsWithHttpInfo(Integer job /** * Retrieve Job Leverage Stats (asynchronously) - * Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` + * Get the TM leverage stats for the job (new/exact/fuzzy matches). Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/stats?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1051,7 +1051,7 @@ private okhttp3.Call reactivateJobValidateBeforeCall(Integer jobId, final ApiCal /** * Reactivate a Job - * Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` + * Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` * @param jobId A job id. (required) * @return Job * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1069,7 +1069,7 @@ public Job reactivateJob(Integer jobId) throws ApiException { /** * Reactivate a Job - * Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` + * Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<Job> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1088,7 +1088,7 @@ public ApiResponse reactivateJobWithHttpInfo(Integer jobId) throws ApiExcep /** * Reactivate a Job (asynchronously) - * Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` + * Set the job state to active. Does not change the state of projects associated with the given job. It will return the reactivated job. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/reactivate?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1180,7 +1180,7 @@ private okhttp3.Call retrieveAllJobsValidateBeforeCall(Boolean isArchived, Boole /** * Retrieve all Jobs - * Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` + * Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` * @param isArchived Retrieves all jobs that are archived. (optional) * @param isDelivered Retrieves all jobs that are delivered. (optional) * @param offset Return jobs starting at the offset row. If not given the default offset will be 0. (optional) @@ -1201,7 +1201,7 @@ public List retrieveAllJobs(Boolean isArchived, Boolean isDelivered, Intege /** * Retrieve all Jobs - * Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` + * Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` * @param isArchived Retrieves all jobs that are archived. (optional) * @param isDelivered Retrieves all jobs that are delivered. (optional) * @param offset Return jobs starting at the offset row. If not given the default offset will be 0. (optional) @@ -1223,7 +1223,7 @@ public ApiResponse> retrieveAllJobsWithHttpInfo(Boolean isArchived, Bo /** * Retrieve all Jobs (asynchronously) - * Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ``` curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` + * Get all Jobs within a given offset and limit. You can retrieve jobs from your account using the above API. Example CURL command: ```bash curl -X GET 'https://api.lilt.com/v2/jobs?key=API_KEY&isArchived=false' ``` * @param isArchived Retrieves all jobs that are archived. (optional) * @param isDelivered Retrieves all jobs that are delivered. (optional) * @param offset Return jobs starting at the offset row. If not given the default offset will be 0. (optional) @@ -1305,7 +1305,7 @@ private okhttp3.Call unarchiveJobValidateBeforeCall(Integer jobId, final ApiCall /** * Unarchive a Job - * Set job to unarchived, the job will move to active status. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` + * Set job to unarchived, the job will move to active status. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` * @param jobId A job id. (required) * @return Job * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1323,7 +1323,7 @@ public Job unarchiveJob(Integer jobId) throws ApiException { /** * Unarchive a Job - * Set job to unarchived, the job will move to active status. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` + * Set job to unarchived, the job will move to active status. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` * @param jobId A job id. (required) * @return ApiResponse<Job> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1342,7 +1342,7 @@ public ApiResponse unarchiveJobWithHttpInfo(Integer jobId) throws ApiExcept /** * Unarchive a Job (asynchronously) - * Set job to unarchived, the job will move to active status. Example CURL command: ``` curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` + * Set job to unarchived, the job will move to active status. Example CURL command: ```bash curl -X POST 'https://api.lilt.com/v2/jobs/{id}/unarchive?key=API_KEY' ``` * @param jobId A job id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1422,7 +1422,7 @@ private okhttp3.Call updateJobValidateBeforeCall(Integer jobId, JobUpdateParamet /** * Update a Job - * Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ``` curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` + * Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ```bash curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` * @param jobId A job id. (required) * @param body (optional) * @return Job @@ -1441,7 +1441,7 @@ public Job updateJob(Integer jobId, JobUpdateParameters body) throws ApiExceptio /** * Update a Job - * Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ``` curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` + * Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ```bash curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` * @param jobId A job id. (required) * @param body (optional) * @return ApiResponse<Job> @@ -1461,7 +1461,7 @@ public ApiResponse updateJobWithHttpInfo(Integer jobId, JobUpdateParameters /** * Update a Job (asynchronously) - * Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ``` curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` + * Updates a job with the new job properties. To update a specific job, you will need the job `id` in the url path. You can update job's name and due date by passing the property and new value in the body. Example CURL command: ```bash curl -X PUT 'https://api.lilt.com/v2/jobs/{id}?key=API_KEY' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"name\": \"test job\", \"due\": \"2022-05-05T10:56:44.985Z\" }' ``` * @param jobId A job id. (required) * @param body (optional) * @param _callback The callback to be executed when the API call finishes diff --git a/src/main/java/com/lilt/client/api/LanguagesApi.java b/src/main/java/com/lilt/client/api/LanguagesApi.java index b52e383bb..4e411571e 100644 --- a/src/main/java/com/lilt/client/api/LanguagesApi.java +++ b/src/main/java/com/lilt/client/api/LanguagesApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/api/MemoriesApi.java b/src/main/java/com/lilt/client/api/MemoriesApi.java index 176ed8d3f..abab12a19 100644 --- a/src/main/java/com/lilt/client/api/MemoriesApi.java +++ b/src/main/java/com/lilt/client/api/MemoriesApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -371,7 +371,7 @@ private okhttp3.Call deleteSegmentFromMemoryValidateBeforeCall(Integer id, Integ /** * Delete a segment from a memory. - * Delete a segment from a memory. ``` curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` + * Delete a segment from a memory. ```bash curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` * @param id A unique Memory identifier. (required) * @param segmentId A unique Segment identifier. (required) * @return DeleteSegmentFromMemoryResponse @@ -390,7 +390,7 @@ public DeleteSegmentFromMemoryResponse deleteSegmentFromMemory(Integer id, Integ /** * Delete a segment from a memory. - * Delete a segment from a memory. ``` curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` + * Delete a segment from a memory. ```bash curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` * @param id A unique Memory identifier. (required) * @param segmentId A unique Segment identifier. (required) * @return ApiResponse<DeleteSegmentFromMemoryResponse> @@ -410,7 +410,7 @@ public ApiResponse deleteSegmentFromMemoryWithH /** * Delete a segment from a memory. (asynchronously) - * Delete a segment from a memory. ``` curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` + * Delete a segment from a memory. ```bash curl -X DELETE https://api.lilt.com/v2/memories/segment?key=API_KEY&id=ID&segment_id=$SEGMENT_ID ``` * @param id A unique Memory identifier. (required) * @param segmentId A unique Segment identifier. (required) * @param _callback The callback to be executed when the API call finishes @@ -493,7 +493,7 @@ private okhttp3.Call downloadTermbaseValidateBeforeCall(Integer id, final ApiCal /** * Termbase download for a Memory - * Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ``` curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` + * Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ```bash curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` * @param id A unique Memory identifier. (required) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -511,7 +511,7 @@ public byte[] downloadTermbase(Integer id) throws ApiException { /** * Termbase download for a Memory - * Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ``` curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` + * Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ```bash curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` * @param id A unique Memory identifier. (required) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -530,7 +530,7 @@ public ApiResponse downloadTermbaseWithHttpInfo(Integer id) throws ApiEx /** * Termbase download for a Memory (asynchronously) - * Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ``` curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` + * Downloads the termbase export for the given memory as a CSV file. Ensure you first call the `/2/memories/termbase/export` endpoint to start the export process before you try to download it. ```bash curl -X GET https://api.lilt.com/v2/memories/termbase/download?key=API_KEY&id=ID ``` * @param id A unique Memory identifier. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -612,7 +612,7 @@ private okhttp3.Call exportTermbaseValidateBeforeCall(Integer id, final ApiCallb /** * Termbase export for a Memory - * Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ``` curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` + * Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ```bash curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` * @param id A unique Memory identifier. (required) * @return TermbaseExportResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -630,7 +630,7 @@ public TermbaseExportResponse exportTermbase(Integer id) throws ApiException { /** * Termbase export for a Memory - * Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ``` curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` + * Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ```bash curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` * @param id A unique Memory identifier. (required) * @return ApiResponse<TermbaseExportResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -649,7 +649,7 @@ public ApiResponse exportTermbaseWithHttpInfo(Integer id /** * Termbase export for a Memory (asynchronously) - * Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ``` curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` + * Exports the termbase entries for the given memory into a CSV file. Calling this endpoint will begin the export process in the background. Check that the processing is complete by polling the `GET /2/memories` endpoint. When the `is_processing` value is 0 then call the `POST /2/memories/termbase/download` endpoint. ```bash curl -X POST https://api.lilt.com/v2/memories/termbase/export?key=API_KEY&id=ID ``` * @param id A unique Memory identifier. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -876,7 +876,7 @@ private okhttp3.Call importMemoryFileValidateBeforeCall(Integer memoryId, String /** * File import for a Memory - * Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff + * Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff ``` * @param memoryId A unique Memory identifier. (required) * @param name Name of the TM or termbase file. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) @@ -899,7 +899,7 @@ public MemoryImportResponse importMemoryFile(Integer memoryId, String name, File /** * File import for a Memory - * Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff + * Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff ``` * @param memoryId A unique Memory identifier. (required) * @param name Name of the TM or termbase file. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) @@ -923,7 +923,7 @@ public ApiResponse importMemoryFileWithHttpInfo(Integer me /** * File import for a Memory (asynchronously) - * Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ``` curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff + * Imports common translation memory or termbase file formats to a specific Lilt memory. Currently supported file formats are `*.tmx`, `*.sdltm`, `*.sdlxliff`(With custom Filters), '*.xliff', and `*.tmq` for TM data; `*.csv` and `*.tbx` for termbase data. Request parameters should be passed as JSON object with the header field `LILT-API`. Example CURL command to upload a translation memory file named `my_memory.sdltm` in the current working directory: ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdltm\\\",\\\"memory_id\\\": 42}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdltm ``` Example CURL command to upload a translation memory file named `my_memory.sdlxliff` in the current working directory, with Custom Filters based on SDLXLIFF fields, conf_name which maps to, percentage, and whether we should ignore unlocked segments. ```bash curl -X POST https://api.lilt.com/v2/memories/import?key=API_KEY \\ --header \"LILT-API: {\\\"name\\\": \\\"my_memory.sdlxliff\\\",\\\"memory_id\\\": 12,\\\"sdlxliff_filters\\\":[{\\\"conf_name\\\": \\\"Translated\\\", \\\"percentage\\\": 100, \\\"allow_unlocked\\\": false}]\"}\" \\ --header \"Content-Type: application/octet-stream\" \\ --data-binary @my_memory.sdlxliff ``` * @param memoryId A unique Memory identifier. (required) * @param name Name of the TM or termbase file. (required) * @param body The file contents to be uploaded. The entire POST body will be treated as the file. (required) diff --git a/src/main/java/com/lilt/client/api/ProjectsApi.java b/src/main/java/com/lilt/client/api/ProjectsApi.java index 0a1cd20f4..1292bd6ff 100644 --- a/src/main/java/com/lilt/client/api/ProjectsApi.java +++ b/src/main/java/com/lilt/client/api/ProjectsApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/api/TranslateApi.java b/src/main/java/com/lilt/client/api/TranslateApi.java index a8088eede..5236ddd85 100644 --- a/src/main/java/com/lilt/client/api/TranslateApi.java +++ b/src/main/java/com/lilt/client/api/TranslateApi.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -70,7 +70,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details
- +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ @@ -141,50 +141,50 @@ private okhttp3.Call batchTranslateFileValidateBeforeCall(String fileId, String /** * Translate a File - * Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` + * Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` * @param fileId List of File ids to be translated, comma separated. (required) * @param memoryId Id of Memory to use in translation. (required) * @param configId An optional pararameter to specify an import configuration to be applied when extracting translatable content from this file. (optional) * @param withTM An optional boolean parameter to toggle the use of Translation Memory in the translation of the file. (optional) - * @return TranslationInfo + * @return List<TranslationInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ - public TranslationInfo batchTranslateFile(String fileId, String memoryId, BigDecimal configId, Boolean withTM) throws ApiException { - ApiResponse localVarResp = batchTranslateFileWithHttpInfo(fileId, memoryId, configId, withTM); + public List batchTranslateFile(String fileId, String memoryId, BigDecimal configId, Boolean withTM) throws ApiException { + ApiResponse> localVarResp = batchTranslateFileWithHttpInfo(fileId, memoryId, configId, withTM); return localVarResp.getData(); } /** * Translate a File - * Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` + * Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` * @param fileId List of File ids to be translated, comma separated. (required) * @param memoryId Id of Memory to use in translation. (required) * @param configId An optional pararameter to specify an import configuration to be applied when extracting translatable content from this file. (optional) * @param withTM An optional boolean parameter to toggle the use of Translation Memory in the translation of the file. (optional) - * @return ApiResponse<TranslationInfo> + * @return ApiResponse<List<TranslationInfo>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ - public ApiResponse batchTranslateFileWithHttpInfo(String fileId, String memoryId, BigDecimal configId, Boolean withTM) throws ApiException { + public ApiResponse> batchTranslateFileWithHttpInfo(String fileId, String memoryId, BigDecimal configId, Boolean withTM) throws ApiException { okhttp3.Call localVarCall = batchTranslateFileValidateBeforeCall(fileId, memoryId, configId, withTM, null); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Translate a File (asynchronously) - * Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ``` curl --X --request POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` + * Start machine translation of one or more Files that have previously been uploaded. The response will include an `id` parameter that can be used to monitor and download the translations in subsequent calls. Example CURL: ```bash curl -X POST 'https://api.lilt.com/v2/translate/file?key=API_KEY&fileId=583&memoryId=2495&configId=123&withTM=true' ``` * @param fileId List of File ids to be translated, comma separated. (required) * @param memoryId Id of Memory to use in translation. (required) * @param configId An optional pararameter to specify an import configuration to be applied when extracting translatable content from this file. (optional) @@ -195,14 +195,14 @@ public ApiResponse batchTranslateFileWithHttpInfo(String fileId * @http.response.details - +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ - public okhttp3.Call batchTranslateFileAsync(String fileId, String memoryId, BigDecimal configId, Boolean withTM, final ApiCallback _callback) throws ApiException { + public okhttp3.Call batchTranslateFileAsync(String fileId, String memoryId, BigDecimal configId, Boolean withTM, final ApiCallback> _callback) throws ApiException { okhttp3.Call localVarCall = batchTranslateFileValidateBeforeCall(fileId, memoryId, configId, withTM, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -268,7 +268,7 @@ private okhttp3.Call downloadFileValidateBeforeCall(String id, final ApiCallback /** * Download translated file - * Download a translated File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` + * Download a translated File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` * @param id A translation id. (required) * @return byte[] * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -285,7 +285,7 @@ public byte[] downloadFile(String id) throws ApiException { /** * Download translated file - * Download a translated File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` + * Download a translated File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` * @param id A translation id. (required) * @return ApiResponse<byte[]> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -303,7 +303,7 @@ public ApiResponse downloadFileWithHttpInfo(String id) throws ApiExcepti /** * Download translated file (asynchronously) - * Download a translated File. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` + * Download a translated File. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/files?key=API_KEY&id=1' ``` * @param id A translation id. (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -333,7 +333,7 @@ public okhttp3.Call downloadFileAsync(String id, final ApiCallback _call * @http.response.details - +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ @@ -394,50 +394,50 @@ private okhttp3.Call monitorFileTranslationValidateBeforeCall(String translation /** * Monitor file translation - * Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` + * Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` * @param translationIds List of translation ids, comma separated (optional) * @param status One of the translation statuses - `InProgress`, `Completed`, `Failed`, `ReadyForDownload` (optional) * @param fromTime Results after this time (inclusive) will be returned, specified as seconds since the Unix epoch. (optional) * @param toTime Results before this time (exclusive) will be returned, specified as seconds since the Unix epoch. (optional) - * @return TranslationInfo + * @return List<TranslationInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ - public TranslationInfo monitorFileTranslation(String translationIds, String status, BigDecimal fromTime, BigDecimal toTime) throws ApiException { - ApiResponse localVarResp = monitorFileTranslationWithHttpInfo(translationIds, status, fromTime, toTime); + public List monitorFileTranslation(String translationIds, String status, BigDecimal fromTime, BigDecimal toTime) throws ApiException { + ApiResponse> localVarResp = monitorFileTranslationWithHttpInfo(translationIds, status, fromTime, toTime); return localVarResp.getData(); } /** * Monitor file translation - * Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` + * Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` * @param translationIds List of translation ids, comma separated (optional) * @param status One of the translation statuses - `InProgress`, `Completed`, `Failed`, `ReadyForDownload` (optional) * @param fromTime Results after this time (inclusive) will be returned, specified as seconds since the Unix epoch. (optional) * @param toTime Results before this time (exclusive) will be returned, specified as seconds since the Unix epoch. (optional) - * @return ApiResponse<TranslationInfo> + * @return ApiResponse<List<TranslationInfo>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ - public ApiResponse monitorFileTranslationWithHttpInfo(String translationIds, String status, BigDecimal fromTime, BigDecimal toTime) throws ApiException { + public ApiResponse> monitorFileTranslationWithHttpInfo(String translationIds, String status, BigDecimal fromTime, BigDecimal toTime) throws ApiException { okhttp3.Call localVarCall = monitorFileTranslationValidateBeforeCall(translationIds, status, fromTime, toTime, null); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** * Monitor file translation (asynchronously) - * Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ``` curl --X --request GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` + * Get information about the one or more Files that are being translated with machine translation. Query filters are optional but at least one must be provided. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/translate/file?key=API_KEY&translationIds=1,2&fromTime=1607966744&toTime=1707966744&status=InProgress' ``` * @param translationIds List of translation ids, comma separated (optional) * @param status One of the translation statuses - `InProgress`, `Completed`, `Failed`, `ReadyForDownload` (optional) * @param fromTime Results after this time (inclusive) will be returned, specified as seconds since the Unix epoch. (optional) @@ -448,14 +448,14 @@ public ApiResponse monitorFileTranslationWithHttpInfo(String tr * @http.response.details - +
Status Code Description Response Headers
200 Translation info -
200 Translation Info -
0 Unexpected error -
*/ - public okhttp3.Call monitorFileTranslationAsync(String translationIds, String status, BigDecimal fromTime, BigDecimal toTime, final ApiCallback _callback) throws ApiException { + public okhttp3.Call monitorFileTranslationAsync(String translationIds, String status, BigDecimal fromTime, BigDecimal toTime, final ApiCallback> _callback) throws ApiException { okhttp3.Call localVarCall = monitorFileTranslationValidateBeforeCall(translationIds, status, fromTime, toTime, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } diff --git a/src/main/java/com/lilt/client/api/WorkflowsApi.java b/src/main/java/com/lilt/client/api/WorkflowsApi.java new file mode 100644 index 000000000..4d44c81aa --- /dev/null +++ b/src/main/java/com/lilt/client/api/WorkflowsApi.java @@ -0,0 +1,159 @@ +/* + * Lilt REST API + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * + * The version of the OpenAPI document: v3.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.lilt.client.api; + +import com.lilt.client.ApiCallback; +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.ApiResponse; +import com.lilt.client.Configuration; +import com.lilt.client.Pair; +import com.lilt.client.ProgressRequestBody; +import com.lilt.client.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import com.lilt.client.model.WorkflowTemplate; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class WorkflowsApi { + private ApiClient localVarApiClient; + + public WorkflowsApi() { + this(Configuration.getDefaultApiClient()); + } + + public WorkflowsApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + /** + * Build call for getWorkflowTemplates + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 An array with a team's available WorkflowTemplates. -
+ */ + public okhttp3.Call getWorkflowTemplatesCall(final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/v2/workflows/templates"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "ApiKeyAuth", "BasicAuth" }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getWorkflowTemplatesValidateBeforeCall(final ApiCallback _callback) throws ApiException { + + + okhttp3.Call localVarCall = getWorkflowTemplatesCall(_callback); + return localVarCall; + + } + + /** + * Retrieve workflow templates + * Get all of the possible Workflow Templates owned by the team. Useful for retrieving the ids corresponding to each workflow tables, and passing them to subsequent requests, for example, creating a new Job with a specific Workflow. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/workflows/templates?key=API_KEY' ``` + * @return List<WorkflowTemplate> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 An array with a team's available WorkflowTemplates. -
+ */ + public List getWorkflowTemplates() throws ApiException { + ApiResponse> localVarResp = getWorkflowTemplatesWithHttpInfo(); + return localVarResp.getData(); + } + + /** + * Retrieve workflow templates + * Get all of the possible Workflow Templates owned by the team. Useful for retrieving the ids corresponding to each workflow tables, and passing them to subsequent requests, for example, creating a new Job with a specific Workflow. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/workflows/templates?key=API_KEY' ``` + * @return ApiResponse<List<WorkflowTemplate>> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 An array with a team's available WorkflowTemplates. -
+ */ + public ApiResponse> getWorkflowTemplatesWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = getWorkflowTemplatesValidateBeforeCall(null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Retrieve workflow templates (asynchronously) + * Get all of the possible Workflow Templates owned by the team. Useful for retrieving the ids corresponding to each workflow tables, and passing them to subsequent requests, for example, creating a new Job with a specific Workflow. Example CURL: ```bash curl -X GET 'https://api.lilt.com/v2/workflows/templates?key=API_KEY' ``` + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 An array with a team's available WorkflowTemplates. -
+ */ + public okhttp3.Call getWorkflowTemplatesAsync(final ApiCallback> _callback) throws ApiException { + + okhttp3.Call localVarCall = getWorkflowTemplatesValidateBeforeCall(_callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } +} diff --git a/src/main/java/com/lilt/client/auth/ApiKeyAuth.java b/src/main/java/com/lilt/client/auth/ApiKeyAuth.java index d06741ad4..4e96d388a 100644 --- a/src/main/java/com/lilt/client/auth/ApiKeyAuth.java +++ b/src/main/java/com/lilt/client/auth/ApiKeyAuth.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -18,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class ApiKeyAuth implements Authentication { private final String location; private final String paramName; diff --git a/src/main/java/com/lilt/client/auth/Authentication.java b/src/main/java/com/lilt/client/auth/Authentication.java index 3843a6524..0e0517c43 100644 --- a/src/main/java/com/lilt/client/auth/Authentication.java +++ b/src/main/java/com/lilt/client/auth/Authentication.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/auth/HttpBasicAuth.java b/src/main/java/com/lilt/client/auth/HttpBasicAuth.java index 57126a477..6d63768e3 100644 --- a/src/main/java/com/lilt/client/auth/HttpBasicAuth.java +++ b/src/main/java/com/lilt/client/auth/HttpBasicAuth.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/com/lilt/client/auth/HttpBearerAuth.java b/src/main/java/com/lilt/client/auth/HttpBearerAuth.java index c9a40f388..dcb28dc0a 100644 --- a/src/main/java/com/lilt/client/auth/HttpBearerAuth.java +++ b/src/main/java/com/lilt/client/auth/HttpBearerAuth.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -18,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class HttpBearerAuth implements Authentication { private final String scheme; private String bearerToken; diff --git a/src/main/java/com/lilt/client/model/AddFileLabelRequest.java b/src/main/java/com/lilt/client/model/AddFileLabelRequest.java index f0821da0a..4b1659af2 100644 --- a/src/main/java/com/lilt/client/model/AddFileLabelRequest.java +++ b/src/main/java/com/lilt/client/model/AddFileLabelRequest.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * AddFileLabelRequest */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class AddFileLabelRequest { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/com/lilt/client/model/CreateConverterConfigParameters.java b/src/main/java/com/lilt/client/model/CreateConverterConfigParameters.java index e7c7054fd..dc85c0e78 100644 --- a/src/main/java/com/lilt/client/model/CreateConverterConfigParameters.java +++ b/src/main/java/com/lilt/client/model/CreateConverterConfigParameters.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * CreateConverterConfigParameters */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class CreateConverterConfigParameters { public static final String SERIALIZED_NAME_SIGNED_AGREEMENT = "signedAgreement"; @SerializedName(SERIALIZED_NAME_SIGNED_AGREEMENT) diff --git a/src/main/java/com/lilt/client/model/DeleteSegmentFromMemoryResponse.java b/src/main/java/com/lilt/client/model/DeleteSegmentFromMemoryResponse.java index 56ddd9836..45fd503c7 100644 --- a/src/main/java/com/lilt/client/model/DeleteSegmentFromMemoryResponse.java +++ b/src/main/java/com/lilt/client/model/DeleteSegmentFromMemoryResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * DeleteSegmentFromMemoryResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class DeleteSegmentFromMemoryResponse { public static final String SERIALIZED_NAME_SUCCESS = "success"; @SerializedName(SERIALIZED_NAME_SUCCESS) diff --git a/src/main/java/com/lilt/client/model/DocumentWithSegments.java b/src/main/java/com/lilt/client/model/DocumentWithSegments.java index dd9f93687..157b559c9 100644 --- a/src/main/java/com/lilt/client/model/DocumentWithSegments.java +++ b/src/main/java/com/lilt/client/model/DocumentWithSegments.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -32,7 +32,7 @@ * A Document is a collection of zero or more Segments. */ @ApiModel(description = "A Document is a collection of zero or more Segments. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class DocumentWithSegments { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/DocumentWithoutSegments.java b/src/main/java/com/lilt/client/model/DocumentWithoutSegments.java index 53edb0ea3..5f3985a57 100644 --- a/src/main/java/com/lilt/client/model/DocumentWithoutSegments.java +++ b/src/main/java/com/lilt/client/model/DocumentWithoutSegments.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -29,7 +29,7 @@ * A Document is a collection of zero or more Segments. */ @ApiModel(description = "A Document is a collection of zero or more Segments. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class DocumentWithoutSegments { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/DocumentWithoutSegmentsStatus.java b/src/main/java/com/lilt/client/model/DocumentWithoutSegmentsStatus.java index e0c8d9b7d..00da4dc90 100644 --- a/src/main/java/com/lilt/client/model/DocumentWithoutSegmentsStatus.java +++ b/src/main/java/com/lilt/client/model/DocumentWithoutSegmentsStatus.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ * A list of translations for the query term. */ @ApiModel(description = "A list of translations for the query term.") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class DocumentWithoutSegmentsStatus { /** * Gets or Sets pretranslation diff --git a/src/main/java/com/lilt/client/model/Error.java b/src/main/java/com/lilt/client/model/Error.java index 66445a7d4..f41c75781 100644 --- a/src/main/java/com/lilt/client/model/Error.java +++ b/src/main/java/com/lilt/client/model/Error.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ * Response in the event of an unexpected error. */ @ApiModel(description = "Response in the event of an unexpected error. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Error { public static final String SERIALIZED_NAME_MESSAGE = "message"; @SerializedName(SERIALIZED_NAME_MESSAGE) diff --git a/src/main/java/com/lilt/client/model/FileDeleteResponse.java b/src/main/java/com/lilt/client/model/FileDeleteResponse.java index f51327ee9..7775ffa76 100644 --- a/src/main/java/com/lilt/client/model/FileDeleteResponse.java +++ b/src/main/java/com/lilt/client/model/FileDeleteResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * FileDeleteResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class FileDeleteResponse { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/GetLiltCreateContentResponse.java b/src/main/java/com/lilt/client/model/GetLiltCreateContentResponse.java new file mode 100644 index 000000000..07f683871 --- /dev/null +++ b/src/main/java/com/lilt/client/model/GetLiltCreateContentResponse.java @@ -0,0 +1,109 @@ +/* + * Lilt REST API + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * + * The version of the OpenAPI document: v3.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.lilt.client.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.lilt.client.model.LiltCreateContent; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * GetLiltCreateContentResponse + */ +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") +public class GetLiltCreateContentResponse { + public static final String SERIALIZED_NAME_CONTENTS = "contents"; + @SerializedName(SERIALIZED_NAME_CONTENTS) + private List contents = null; + + + public GetLiltCreateContentResponse contents(List contents) { + + this.contents = contents; + return this; + } + + public GetLiltCreateContentResponse addContentsItem(LiltCreateContent contentsItem) { + if (this.contents == null) { + this.contents = new ArrayList(); + } + this.contents.add(contentsItem); + return this; + } + + /** + * List of LiltCreateContent objects + * @return contents + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "List of LiltCreateContent objects") + + public List getContents() { + return contents; + } + + + public void setContents(List contents) { + this.contents = contents; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + GetLiltCreateContentResponse getLiltCreateContentResponse = (GetLiltCreateContentResponse) o; + return Objects.equals(this.contents, getLiltCreateContentResponse.contents); + } + + @Override + public int hashCode() { + return Objects.hash(contents); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class GetLiltCreateContentResponse {\n"); + sb.append(" contents: ").append(toIndentedString(contents)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/lilt/client/model/InlineResponse200.java b/src/main/java/com/lilt/client/model/InlineResponse200.java index 0e76cde80..af7c55aca 100644 --- a/src/main/java/com/lilt/client/model/InlineResponse200.java +++ b/src/main/java/com/lilt/client/model/InlineResponse200.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * InlineResponse200 */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class InlineResponse200 { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/Job.java b/src/main/java/com/lilt/client/model/Job.java index 0eb9f0353..b25273c61 100644 --- a/src/main/java/com/lilt/client/model/Job.java +++ b/src/main/java/com/lilt/client/model/Job.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -30,7 +30,7 @@ * A Job is a collection of multiple Projects. Each project is specific to a language pair, and is associated with exactly one Memory for that language pair. The Memory association cannot be changed after the Project is created. */ @ApiModel(description = "A Job is a collection of multiple Projects. Each project is specific to a language pair, and is associated with exactly one Memory for that language pair. The Memory association cannot be changed after the Project is created. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Job { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/com/lilt/client/model/JobCreateParameters.java b/src/main/java/com/lilt/client/model/JobCreateParameters.java index d037c3c6d..834421e69 100644 --- a/src/main/java/com/lilt/client/model/JobCreateParameters.java +++ b/src/main/java/com/lilt/client/model/JobCreateParameters.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -30,7 +30,7 @@ /** * JobCreateParameters */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class JobCreateParameters { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) @@ -64,10 +64,6 @@ public class JobCreateParameters { @SerializedName(SERIALIZED_NAME_WORKFLOW_TEMPLATE_ID) private Integer workflowTemplateId; - public static final String SERIALIZED_NAME_WORKFLOW_TEMPLATE_NAME = "workflowTemplateName"; - @SerializedName(SERIALIZED_NAME_WORKFLOW_TEMPLATE_NAME) - private Integer workflowTemplateName; - public JobCreateParameters name(String name) { @@ -242,11 +238,11 @@ public JobCreateParameters workflowTemplateId(Integer workflowTemplateId) { } /** - * Identifier of the workflow template to be used when creating a job. If not passed the organization default will be used. + * ID of the workflow template to be used. Use the [workflows templates endpoint](#tag/Workflows/operation/getWorkflowTemplates) to get the list of available workflows. * @return workflowTemplateId **/ @javax.annotation.Nullable - @ApiModelProperty(example = "123", value = "Identifier of the workflow template to be used when creating a job. If not passed the organization default will be used.") + @ApiModelProperty(value = "ID of the workflow template to be used. Use the [workflows templates endpoint](#tag/Workflows/operation/getWorkflowTemplates) to get the list of available workflows.") public Integer getWorkflowTemplateId() { return workflowTemplateId; @@ -258,29 +254,6 @@ public void setWorkflowTemplateId(Integer workflowTemplateId) { } - public JobCreateParameters workflowTemplateName(Integer workflowTemplateName) { - - this.workflowTemplateName = workflowTemplateName; - return this; - } - - /** - * Name of the workflow template to be used, must be passed with teamId or look up will fail. If workflowTemplateId is passed it supercedes any other look up. - * @return workflowTemplateName - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "Name of the workflow template to be used, must be passed with teamId or look up will fail. If workflowTemplateId is passed it supercedes any other look up.") - - public Integer getWorkflowTemplateName() { - return workflowTemplateName; - } - - - public void setWorkflowTemplateName(Integer workflowTemplateName) { - this.workflowTemplateName = workflowTemplateName; - } - - @Override public boolean equals(Object o) { if (this == o) { @@ -297,13 +270,12 @@ public boolean equals(Object o) { Objects.equals(this.srcLang, jobCreateParameters.srcLang) && Objects.equals(this.srcLocale, jobCreateParameters.srcLocale) && Objects.equals(this.isPlural, jobCreateParameters.isPlural) && - Objects.equals(this.workflowTemplateId, jobCreateParameters.workflowTemplateId) && - Objects.equals(this.workflowTemplateName, jobCreateParameters.workflowTemplateName); + Objects.equals(this.workflowTemplateId, jobCreateParameters.workflowTemplateId); } @Override public int hashCode() { - return Objects.hash(name, languagePairs, fileIds, due, srcLang, srcLocale, isPlural, workflowTemplateId, workflowTemplateName); + return Objects.hash(name, languagePairs, fileIds, due, srcLang, srcLocale, isPlural, workflowTemplateId); } @Override @@ -318,7 +290,6 @@ public String toString() { sb.append(" srcLocale: ").append(toIndentedString(srcLocale)).append("\n"); sb.append(" isPlural: ").append(toIndentedString(isPlural)).append("\n"); sb.append(" workflowTemplateId: ").append(toIndentedString(workflowTemplateId)).append("\n"); - sb.append(" workflowTemplateName: ").append(toIndentedString(workflowTemplateName)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/lilt/client/model/JobDeleteResponse.java b/src/main/java/com/lilt/client/model/JobDeleteResponse.java index 22ef32343..fcd1243ed 100644 --- a/src/main/java/com/lilt/client/model/JobDeleteResponse.java +++ b/src/main/java/com/lilt/client/model/JobDeleteResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * JobDeleteResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class JobDeleteResponse { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/JobLeverageStats.java b/src/main/java/com/lilt/client/model/JobLeverageStats.java index 2f6c6581c..68524788a 100644 --- a/src/main/java/com/lilt/client/model/JobLeverageStats.java +++ b/src/main/java/com/lilt/client/model/JobLeverageStats.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -31,7 +31,7 @@ * A job leverage stats object shows an overview of job's statistical data including total number of exact words, fuzzy words, and exact words for the job in total and for each project. */ @ApiModel(description = "A job leverage stats object shows an overview of job's statistical data including total number of exact words, fuzzy words, and exact words for the job in total and for each project. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class JobLeverageStats { public static final String SERIALIZED_NAME_SOURCE_WORDS = "sourceWords"; @SerializedName(SERIALIZED_NAME_SOURCE_WORDS) diff --git a/src/main/java/com/lilt/client/model/JobProject.java b/src/main/java/com/lilt/client/model/JobProject.java index 56138a1a0..25fc9441c 100644 --- a/src/main/java/com/lilt/client/model/JobProject.java +++ b/src/main/java/com/lilt/client/model/JobProject.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ * A job project contains project statistical data that belongs to a specific job. */ @ApiModel(description = "A job project contains project statistical data that belongs to a specific job. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class JobProject { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/JobStats.java b/src/main/java/com/lilt/client/model/JobStats.java index d7f46c5ff..10edce70b 100644 --- a/src/main/java/com/lilt/client/model/JobStats.java +++ b/src/main/java/com/lilt/client/model/JobStats.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -31,7 +31,7 @@ * A job stats shows an overview of job's statistical data including total number of exact words, fuzzy words, language pairs, projects, etc. */ @ApiModel(description = "A job stats shows an overview of job's statistical data including total number of exact words, fuzzy words, language pairs, projects, etc. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class JobStats { public static final String SERIALIZED_NAME_EXACT_WORDS = "exactWords"; @SerializedName(SERIALIZED_NAME_EXACT_WORDS) diff --git a/src/main/java/com/lilt/client/model/JobUpdateParameters.java b/src/main/java/com/lilt/client/model/JobUpdateParameters.java index 352defd95..ef8d62489 100644 --- a/src/main/java/com/lilt/client/model/JobUpdateParameters.java +++ b/src/main/java/com/lilt/client/model/JobUpdateParameters.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * JobUpdateParameters */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class JobUpdateParameters { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/com/lilt/client/model/LanguagePair.java b/src/main/java/com/lilt/client/model/LanguagePair.java index 1a798e6b1..7ffe12b26 100644 --- a/src/main/java/com/lilt/client/model/LanguagePair.java +++ b/src/main/java/com/lilt/client/model/LanguagePair.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -31,16 +31,8 @@ * A language pair couples the source and target language along with memory and pre-translations settings associated to a project. */ @ApiModel(description = "A language pair couples the source and target language along with memory and pre-translations settings associated to a project. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class LanguagePair { - public static final String SERIALIZED_NAME_SRC_LANG = "srcLang"; - @SerializedName(SERIALIZED_NAME_SRC_LANG) - private String srcLang; - - public static final String SERIALIZED_NAME_SRC_LOCALE = "srcLocale"; - @SerializedName(SERIALIZED_NAME_SRC_LOCALE) - private String srcLocale; - public static final String SERIALIZED_NAME_TRG_LANG = "trgLang"; @SerializedName(SERIALIZED_NAME_TRG_LANG) private String trgLang; @@ -94,52 +86,6 @@ public class LanguagePair { private List workflowStageAssignments = null; - public LanguagePair srcLang(String srcLang) { - - this.srcLang = srcLang; - return this; - } - - /** - * Source language, an ISO 639-1 language identifier. - * @return srcLang - **/ - @javax.annotation.Nullable - @ApiModelProperty(example = "en", value = "Source language, an ISO 639-1 language identifier.") - - public String getSrcLang() { - return srcLang; - } - - - public void setSrcLang(String srcLang) { - this.srcLang = srcLang; - } - - - public LanguagePair srcLocale(String srcLocale) { - - this.srcLocale = srcLocale; - return this; - } - - /** - * A locale identifier, supported for source language. - * @return srcLocale - **/ - @javax.annotation.Nullable - @ApiModelProperty(example = "US", value = "A locale identifier, supported for source language.") - - public String getSrcLocale() { - return srcLocale; - } - - - public void setSrcLocale(String srcLocale) { - this.srcLocale = srcLocale; - } - - public LanguagePair trgLang(String trgLang) { this.trgLang = trgLang; @@ -454,9 +400,7 @@ public boolean equals(Object o) { return false; } LanguagePair languagePair = (LanguagePair) o; - return Objects.equals(this.srcLang, languagePair.srcLang) && - Objects.equals(this.srcLocale, languagePair.srcLocale) && - Objects.equals(this.trgLang, languagePair.trgLang) && + return Objects.equals(this.trgLang, languagePair.trgLang) && Objects.equals(this.trgLocale, languagePair.trgLocale) && Objects.equals(this.dueDate, languagePair.dueDate) && Objects.equals(this.memoryId, languagePair.memoryId) && @@ -473,15 +417,13 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(srcLang, srcLocale, trgLang, trgLocale, dueDate, memoryId, externalModelId, pretranslate, autoAccept, caseSensitive, takeMatchAttribution, configId, workflowTemplateId, workflowTemplateName, workflowStageAssignments); + return Objects.hash(trgLang, trgLocale, dueDate, memoryId, externalModelId, pretranslate, autoAccept, caseSensitive, takeMatchAttribution, configId, workflowTemplateId, workflowTemplateName, workflowStageAssignments); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class LanguagePair {\n"); - sb.append(" srcLang: ").append(toIndentedString(srcLang)).append("\n"); - sb.append(" srcLocale: ").append(toIndentedString(srcLocale)).append("\n"); sb.append(" trgLang: ").append(toIndentedString(trgLang)).append("\n"); sb.append(" trgLocale: ").append(toIndentedString(trgLocale)).append("\n"); sb.append(" dueDate: ").append(toIndentedString(dueDate)).append("\n"); diff --git a/src/main/java/com/lilt/client/model/LanguagesResponse.java b/src/main/java/com/lilt/client/model/LanguagesResponse.java index 6ab7a9c4b..611f613cb 100644 --- a/src/main/java/com/lilt/client/model/LanguagesResponse.java +++ b/src/main/java/com/lilt/client/model/LanguagesResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * LanguagesResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class LanguagesResponse { public static final String SERIALIZED_NAME_SOURCE_TO_TARGET = "source_to_target"; @SerializedName(SERIALIZED_NAME_SOURCE_TO_TARGET) diff --git a/src/main/java/com/lilt/client/model/LiltCreateContent.java b/src/main/java/com/lilt/client/model/LiltCreateContent.java index 2c63a2001..1ca404578 100644 --- a/src/main/java/com/lilt/client/model/LiltCreateContent.java +++ b/src/main/java/com/lilt/client/model/LiltCreateContent.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,186 +20,121 @@ import com.google.gson.annotations.SerializedName; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; +import com.lilt.client.model.LiltCreateContentPreferences; +import com.lilt.client.model.LiltCreateContentTemplateParams; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.util.ArrayList; -import java.util.List; /** * Content Parameters for LiltCreate. */ @ApiModel(description = "Content Parameters for LiltCreate. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class LiltCreateContent { - public static final String SERIALIZED_NAME_TONE = "tone"; - @SerializedName(SERIALIZED_NAME_TONE) - private String tone; - - public static final String SERIALIZED_NAME_TERMS = "terms"; - @SerializedName(SERIALIZED_NAME_TERMS) - private String terms; - - public static final String SERIALIZED_NAME_SUMMARY = "summary"; - @SerializedName(SERIALIZED_NAME_SUMMARY) - private String summary; - public static final String SERIALIZED_NAME_LANGUAGE = "language"; @SerializedName(SERIALIZED_NAME_LANGUAGE) private String language; - public static final String SERIALIZED_NAME_MEMORY_ID = "memoryId"; - @SerializedName(SERIALIZED_NAME_MEMORY_ID) - private String memoryId; - - public static final String SERIALIZED_NAME_SECTIONS = "sections"; - @SerializedName(SERIALIZED_NAME_SECTIONS) - private List sections = null; - - - public LiltCreateContent tone(String tone) { - - this.tone = tone; - return this; - } - - /** - * The tone of the content. - * @return tone - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The tone of the content.") + public static final String SERIALIZED_NAME_TEMPLATE = "template"; + @SerializedName(SERIALIZED_NAME_TEMPLATE) + private String template; - public String getTone() { - return tone; - } + public static final String SERIALIZED_NAME_TEMPLATE_PARAMS = "templateParams"; + @SerializedName(SERIALIZED_NAME_TEMPLATE_PARAMS) + private LiltCreateContentTemplateParams templateParams; - - public void setTone(String tone) { - this.tone = tone; - } - - - public LiltCreateContent terms(String terms) { - - this.terms = terms; - return this; - } - - /** - * The terms of the content. - * @return terms - **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The terms of the content.") - - public String getTerms() { - return terms; - } + public static final String SERIALIZED_NAME_PREFERENCES = "preferences"; + @SerializedName(SERIALIZED_NAME_PREFERENCES) + private LiltCreateContentPreferences preferences; - public void setTerms(String terms) { - this.terms = terms; - } - - - public LiltCreateContent summary(String summary) { + public LiltCreateContent language(String language) { - this.summary = summary; + this.language = language; return this; } /** - * The summary of the content. - * @return summary + * The language of the content. + * @return language **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The summary of the content.") + @ApiModelProperty(required = true, value = "The language of the content.") - public String getSummary() { - return summary; + public String getLanguage() { + return language; } - public void setSummary(String summary) { - this.summary = summary; + public void setLanguage(String language) { + this.language = language; } - public LiltCreateContent language(String language) { + public LiltCreateContent template(String template) { - this.language = language; + this.template = template; return this; } /** - * The language of the content. - * @return language + * The template of the content. + * @return template **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The language of the content.") + @ApiModelProperty(required = true, value = "The template of the content.") - public String getLanguage() { - return language; + public String getTemplate() { + return template; } - public void setLanguage(String language) { - this.language = language; + public void setTemplate(String template) { + this.template = template; } - public LiltCreateContent memoryId(String memoryId) { + public LiltCreateContent templateParams(LiltCreateContentTemplateParams templateParams) { - this.memoryId = memoryId; + this.templateParams = templateParams; return this; } /** - * The memory ID of the content. - * @return memoryId + * Get templateParams + * @return templateParams **/ - @javax.annotation.Nullable - @ApiModelProperty(value = "The memory ID of the content.") + @ApiModelProperty(required = true, value = "") - public String getMemoryId() { - return memoryId; + public LiltCreateContentTemplateParams getTemplateParams() { + return templateParams; } - public void setMemoryId(String memoryId) { - this.memoryId = memoryId; + public void setTemplateParams(LiltCreateContentTemplateParams templateParams) { + this.templateParams = templateParams; } - public LiltCreateContent sections(List sections) { + public LiltCreateContent preferences(LiltCreateContentPreferences preferences) { - this.sections = sections; - return this; - } - - public LiltCreateContent addSectionsItem(String sectionsItem) { - if (this.sections == null) { - this.sections = new ArrayList(); - } - this.sections.add(sectionsItem); + this.preferences = preferences; return this; } /** - * The sections of the content. - * @return sections + * Get preferences + * @return preferences **/ @javax.annotation.Nullable - @ApiModelProperty(value = "The sections of the content.") + @ApiModelProperty(value = "") - public List getSections() { - return sections; + public LiltCreateContentPreferences getPreferences() { + return preferences; } - public void setSections(List sections) { - this.sections = sections; + public void setPreferences(LiltCreateContentPreferences preferences) { + this.preferences = preferences; } @@ -212,29 +147,25 @@ public boolean equals(Object o) { return false; } LiltCreateContent liltCreateContent = (LiltCreateContent) o; - return Objects.equals(this.tone, liltCreateContent.tone) && - Objects.equals(this.terms, liltCreateContent.terms) && - Objects.equals(this.summary, liltCreateContent.summary) && - Objects.equals(this.language, liltCreateContent.language) && - Objects.equals(this.memoryId, liltCreateContent.memoryId) && - Objects.equals(this.sections, liltCreateContent.sections); + return Objects.equals(this.language, liltCreateContent.language) && + Objects.equals(this.template, liltCreateContent.template) && + Objects.equals(this.templateParams, liltCreateContent.templateParams) && + Objects.equals(this.preferences, liltCreateContent.preferences); } @Override public int hashCode() { - return Objects.hash(tone, terms, summary, language, memoryId, sections); + return Objects.hash(language, template, templateParams, preferences); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class LiltCreateContent {\n"); - sb.append(" tone: ").append(toIndentedString(tone)).append("\n"); - sb.append(" terms: ").append(toIndentedString(terms)).append("\n"); - sb.append(" summary: ").append(toIndentedString(summary)).append("\n"); sb.append(" language: ").append(toIndentedString(language)).append("\n"); - sb.append(" memoryId: ").append(toIndentedString(memoryId)).append("\n"); - sb.append(" sections: ").append(toIndentedString(sections)).append("\n"); + sb.append(" template: ").append(toIndentedString(template)).append("\n"); + sb.append(" templateParams: ").append(toIndentedString(templateParams)).append("\n"); + sb.append(" preferences: ").append(toIndentedString(preferences)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/lilt/client/model/LiltCreateContentPreferences.java b/src/main/java/com/lilt/client/model/LiltCreateContentPreferences.java new file mode 100644 index 000000000..6402fa403 --- /dev/null +++ b/src/main/java/com/lilt/client/model/LiltCreateContentPreferences.java @@ -0,0 +1,128 @@ +/* + * Lilt REST API + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * + * The version of the OpenAPI document: v3.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.lilt.client.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * The preferences of the content. + */ +@ApiModel(description = "The preferences of the content.") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") +public class LiltCreateContentPreferences { + public static final String SERIALIZED_NAME_TONE = "tone"; + @SerializedName(SERIALIZED_NAME_TONE) + private String tone; + + public static final String SERIALIZED_NAME_STYLEGUIDE = "styleguide"; + @SerializedName(SERIALIZED_NAME_STYLEGUIDE) + private String styleguide; + + + public LiltCreateContentPreferences tone(String tone) { + + this.tone = tone; + return this; + } + + /** + * The tone of the content. + * @return tone + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The tone of the content.") + + public String getTone() { + return tone; + } + + + public void setTone(String tone) { + this.tone = tone; + } + + + public LiltCreateContentPreferences styleguide(String styleguide) { + + this.styleguide = styleguide; + return this; + } + + /** + * The styleguide of the content. + * @return styleguide + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The styleguide of the content.") + + public String getStyleguide() { + return styleguide; + } + + + public void setStyleguide(String styleguide) { + this.styleguide = styleguide; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LiltCreateContentPreferences liltCreateContentPreferences = (LiltCreateContentPreferences) o; + return Objects.equals(this.tone, liltCreateContentPreferences.tone) && + Objects.equals(this.styleguide, liltCreateContentPreferences.styleguide); + } + + @Override + public int hashCode() { + return Objects.hash(tone, styleguide); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LiltCreateContentPreferences {\n"); + sb.append(" tone: ").append(toIndentedString(tone)).append("\n"); + sb.append(" styleguide: ").append(toIndentedString(styleguide)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/lilt/client/model/LiltCreateContentTemplateParams.java b/src/main/java/com/lilt/client/model/LiltCreateContentTemplateParams.java new file mode 100644 index 000000000..9533cc887 --- /dev/null +++ b/src/main/java/com/lilt/client/model/LiltCreateContentTemplateParams.java @@ -0,0 +1,224 @@ +/* + * Lilt REST API + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * + * The version of the OpenAPI document: v3.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.lilt.client.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * The template parameters of the content. + */ +@ApiModel(description = "The template parameters of the content.") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") +public class LiltCreateContentTemplateParams { + public static final String SERIALIZED_NAME_CONTENT_LENGTH = "contentLength"; + @SerializedName(SERIALIZED_NAME_CONTENT_LENGTH) + private Integer contentLength; + + public static final String SERIALIZED_NAME_MEMORY_ID = "memoryId"; + @SerializedName(SERIALIZED_NAME_MEMORY_ID) + private Integer memoryId; + + public static final String SERIALIZED_NAME_LANGUAGE = "language"; + @SerializedName(SERIALIZED_NAME_LANGUAGE) + private String language; + + public static final String SERIALIZED_NAME_SECTIONS = "sections"; + @SerializedName(SERIALIZED_NAME_SECTIONS) + private List sections = null; + + public static final String SERIALIZED_NAME_SUMMARY = "summary"; + @SerializedName(SERIALIZED_NAME_SUMMARY) + private String summary; + + + public LiltCreateContentTemplateParams contentLength(Integer contentLength) { + + this.contentLength = contentLength; + return this; + } + + /** + * The length of the content. + * @return contentLength + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The length of the content.") + + public Integer getContentLength() { + return contentLength; + } + + + public void setContentLength(Integer contentLength) { + this.contentLength = contentLength; + } + + + public LiltCreateContentTemplateParams memoryId(Integer memoryId) { + + this.memoryId = memoryId; + return this; + } + + /** + * The ID referencing a Data Source. + * @return memoryId + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The ID referencing a Data Source.") + + public Integer getMemoryId() { + return memoryId; + } + + + public void setMemoryId(Integer memoryId) { + this.memoryId = memoryId; + } + + + public LiltCreateContentTemplateParams language(String language) { + + this.language = language; + return this; + } + + /** + * The language of the content. + * @return language + **/ + @ApiModelProperty(required = true, value = "The language of the content.") + + public String getLanguage() { + return language; + } + + + public void setLanguage(String language) { + this.language = language; + } + + + public LiltCreateContentTemplateParams sections(List sections) { + + this.sections = sections; + return this; + } + + public LiltCreateContentTemplateParams addSectionsItem(String sectionsItem) { + if (this.sections == null) { + this.sections = new ArrayList(); + } + this.sections.add(sectionsItem); + return this; + } + + /** + * The sections of the content. + * @return sections + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The sections of the content.") + + public List getSections() { + return sections; + } + + + public void setSections(List sections) { + this.sections = sections; + } + + + public LiltCreateContentTemplateParams summary(String summary) { + + this.summary = summary; + return this; + } + + /** + * The summary of the content. + * @return summary + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The summary of the content.") + + public String getSummary() { + return summary; + } + + + public void setSummary(String summary) { + this.summary = summary; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LiltCreateContentTemplateParams liltCreateContentTemplateParams = (LiltCreateContentTemplateParams) o; + return Objects.equals(this.contentLength, liltCreateContentTemplateParams.contentLength) && + Objects.equals(this.memoryId, liltCreateContentTemplateParams.memoryId) && + Objects.equals(this.language, liltCreateContentTemplateParams.language) && + Objects.equals(this.sections, liltCreateContentTemplateParams.sections) && + Objects.equals(this.summary, liltCreateContentTemplateParams.summary); + } + + @Override + public int hashCode() { + return Objects.hash(contentLength, memoryId, language, sections, summary); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LiltCreateContentTemplateParams {\n"); + sb.append(" contentLength: ").append(toIndentedString(contentLength)).append("\n"); + sb.append(" memoryId: ").append(toIndentedString(memoryId)).append("\n"); + sb.append(" language: ").append(toIndentedString(language)).append("\n"); + sb.append(" sections: ").append(toIndentedString(sections)).append("\n"); + sb.append(" summary: ").append(toIndentedString(summary)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/lilt/client/model/Memory.java b/src/main/java/com/lilt/client/model/Memory.java index 066419b90..7d55e4f22 100644 --- a/src/main/java/com/lilt/client/model/Memory.java +++ b/src/main/java/com/lilt/client/model/Memory.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -30,7 +30,7 @@ * A Memory is a collection of parallel (source/target) segments from which a MT/TM model is trained. When a translator confirms a segment in the Interface, a parallel segment is added to the Memory. Parallel segments from existing translation memories and bitexts can also be added to the Memory via the REST API. */ @ApiModel(description = "A Memory is a collection of parallel (source/target) segments from which a MT/TM model is trained. When a translator confirms a segment in the Interface, a parallel segment is added to the Memory. Parallel segments from existing translation memories and bitexts can also be added to the Memory via the REST API. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Memory { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/MemoryCreateParameters.java b/src/main/java/com/lilt/client/model/MemoryCreateParameters.java index 4d2f34e82..2df0a0172 100644 --- a/src/main/java/com/lilt/client/model/MemoryCreateParameters.java +++ b/src/main/java/com/lilt/client/model/MemoryCreateParameters.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * MemoryCreateParameters */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class MemoryCreateParameters { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/com/lilt/client/model/MemoryDeleteResponse.java b/src/main/java/com/lilt/client/model/MemoryDeleteResponse.java index 3923b04ad..3273c8807 100644 --- a/src/main/java/com/lilt/client/model/MemoryDeleteResponse.java +++ b/src/main/java/com/lilt/client/model/MemoryDeleteResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * MemoryDeleteResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class MemoryDeleteResponse { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/MemoryImportResponse.java b/src/main/java/com/lilt/client/model/MemoryImportResponse.java index d2924aae9..69033552c 100644 --- a/src/main/java/com/lilt/client/model/MemoryImportResponse.java +++ b/src/main/java/com/lilt/client/model/MemoryImportResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * MemoryImportResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class MemoryImportResponse { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/MemoryUpdateParameters.java b/src/main/java/com/lilt/client/model/MemoryUpdateParameters.java index 6cc2df577..3313d84f9 100644 --- a/src/main/java/com/lilt/client/model/MemoryUpdateParameters.java +++ b/src/main/java/com/lilt/client/model/MemoryUpdateParameters.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * MemoryUpdateParameters */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class MemoryUpdateParameters { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/Project.java b/src/main/java/com/lilt/client/model/Project.java index c01b2cfe1..1834c625d 100644 --- a/src/main/java/com/lilt/client/model/Project.java +++ b/src/main/java/com/lilt/client/model/Project.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -31,7 +31,7 @@ * A Project is a collection of zero or more Documents. It is specific to a language pair, and is associated with exactly one Memory for that language pair. The Memory association cannot be changed after the Project is created. */ @ApiModel(description = "A Project is a collection of zero or more Documents. It is specific to a language pair, and is associated with exactly one Memory for that language pair. The Memory association cannot be changed after the Project is created. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Project { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/ProjectCreateParameters.java b/src/main/java/com/lilt/client/model/ProjectCreateParameters.java index 92a1f8745..9f540312f 100644 --- a/src/main/java/com/lilt/client/model/ProjectCreateParameters.java +++ b/src/main/java/com/lilt/client/model/ProjectCreateParameters.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * ProjectCreateParameters */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class ProjectCreateParameters { public static final String SERIALIZED_NAME_NAME = "name"; @SerializedName(SERIALIZED_NAME_NAME) diff --git a/src/main/java/com/lilt/client/model/ProjectDeleteResponse.java b/src/main/java/com/lilt/client/model/ProjectDeleteResponse.java index 396dc2eea..1c50a88a4 100644 --- a/src/main/java/com/lilt/client/model/ProjectDeleteResponse.java +++ b/src/main/java/com/lilt/client/model/ProjectDeleteResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * ProjectDeleteResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class ProjectDeleteResponse { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/ProjectStats.java b/src/main/java/com/lilt/client/model/ProjectStats.java index 25ffa6396..ee7a4a5ca 100644 --- a/src/main/java/com/lilt/client/model/ProjectStats.java +++ b/src/main/java/com/lilt/client/model/ProjectStats.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * ProjectStats */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class ProjectStats { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/SDLXLIFFFilter.java b/src/main/java/com/lilt/client/model/SDLXLIFFFilter.java index 903337a98..ab39a0c27 100644 --- a/src/main/java/com/lilt/client/model/SDLXLIFFFilter.java +++ b/src/main/java/com/lilt/client/model/SDLXLIFFFilter.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * SDLXLIFFFilter */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class SDLXLIFFFilter { /** * the current state of the SDLXLIFF Trans Unit. diff --git a/src/main/java/com/lilt/client/model/Segment.java b/src/main/java/com/lilt/client/model/Segment.java index 226f6b499..c610d3b89 100644 --- a/src/main/java/com/lilt/client/model/Segment.java +++ b/src/main/java/com/lilt/client/model/Segment.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ * A Segment is a source string and, optionally, its translation. A Segment can be associated with both a Memory and a Document. The Segment object contains additional metadata about the source and target strings. */ @ApiModel(description = "A Segment is a source string and, optionally, its translation. A Segment can be associated with both a Memory and a Document. The Segment object contains additional metadata about the source and target strings. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Segment { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/SignLiltCreateTermsResponse.java b/src/main/java/com/lilt/client/model/SignLiltCreateTermsResponse.java index c61178627..54a85ac55 100644 --- a/src/main/java/com/lilt/client/model/SignLiltCreateTermsResponse.java +++ b/src/main/java/com/lilt/client/model/SignLiltCreateTermsResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * SignLiltCreateTermsResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class SignLiltCreateTermsResponse { public static final String SERIALIZED_NAME_SIGNED_AGREEMENT = "signedAgreement"; @SerializedName(SERIALIZED_NAME_SIGNED_AGREEMENT) diff --git a/src/main/java/com/lilt/client/model/SourceFile.java b/src/main/java/com/lilt/client/model/SourceFile.java index 82f05944b..c2ac7924a 100644 --- a/src/main/java/com/lilt/client/model/SourceFile.java +++ b/src/main/java/com/lilt/client/model/SourceFile.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -32,7 +32,7 @@ * A SourceFile is an unprocessed source file that can later be added to a project. */ @ApiModel(description = "A SourceFile is an unprocessed source file that can later be added to a project.") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class SourceFile { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/TermbaseExportResponse.java b/src/main/java/com/lilt/client/model/TermbaseExportResponse.java index 3ef7a602b..5d91426d0 100644 --- a/src/main/java/com/lilt/client/model/TermbaseExportResponse.java +++ b/src/main/java/com/lilt/client/model/TermbaseExportResponse.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * TermbaseExportResponse */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class TermbaseExportResponse { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/TranslateSegmentBody.java b/src/main/java/com/lilt/client/model/TranslateSegmentBody.java index 5e8597ec7..65ce9a283 100644 --- a/src/main/java/com/lilt/client/model/TranslateSegmentBody.java +++ b/src/main/java/com/lilt/client/model/TranslateSegmentBody.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -27,7 +27,7 @@ /** * TranslateSegmentBody */ -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class TranslateSegmentBody { public static final String SERIALIZED_NAME_SOURCE = "source"; @SerializedName(SERIALIZED_NAME_SOURCE) diff --git a/src/main/java/com/lilt/client/model/Translation.java b/src/main/java/com/lilt/client/model/Translation.java index 9268a401b..f9ed177b5 100644 --- a/src/main/java/com/lilt/client/model/Translation.java +++ b/src/main/java/com/lilt/client/model/Translation.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -31,7 +31,7 @@ * A machine translation (MT) or a translation memory (TM) match of a source segment. */ @ApiModel(description = "A machine translation (MT) or a translation memory (TM) match of a source segment.") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class Translation { public static final String SERIALIZED_NAME_TARGET = "target"; @SerializedName(SERIALIZED_NAME_TARGET) diff --git a/src/main/java/com/lilt/client/model/TranslationInfo.java b/src/main/java/com/lilt/client/model/TranslationInfo.java index 47e72fac8..f37d85696 100644 --- a/src/main/java/com/lilt/client/model/TranslationInfo.java +++ b/src/main/java/com/lilt/client/model/TranslationInfo.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ * Information describing a batch translation process. */ @ApiModel(description = "Information describing a batch translation process. ") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class TranslationInfo { public static final String SERIALIZED_NAME_ID = "id"; @SerializedName(SERIALIZED_NAME_ID) diff --git a/src/main/java/com/lilt/client/model/TranslationList.java b/src/main/java/com/lilt/client/model/TranslationList.java index b63e3408e..7637e5589 100644 --- a/src/main/java/com/lilt/client/model/TranslationList.java +++ b/src/main/java/com/lilt/client/model/TranslationList.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -31,7 +31,7 @@ * An ranked list of translations and associated metadata. */ @ApiModel(description = "An ranked list of translations and associated metadata.") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class TranslationList { public static final String SERIALIZED_NAME_UNTOKENIZED_SOURCE = "untokenizedSource"; @SerializedName(SERIALIZED_NAME_UNTOKENIZED_SOURCE) diff --git a/src/main/java/com/lilt/client/model/TranslationMemoryEntry.java b/src/main/java/com/lilt/client/model/TranslationMemoryEntry.java index 7e561ee0c..f4311f47a 100644 --- a/src/main/java/com/lilt/client/model/TranslationMemoryEntry.java +++ b/src/main/java/com/lilt/client/model/TranslationMemoryEntry.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ * A translation memory entry. */ @ApiModel(description = "A translation memory entry.") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class TranslationMemoryEntry { public static final String SERIALIZED_NAME_SOURCE = "source"; @SerializedName(SERIALIZED_NAME_SOURCE) diff --git a/src/main/java/com/lilt/client/model/WorkflowStageAssignment.java b/src/main/java/com/lilt/client/model/WorkflowStageAssignment.java index 0de82bff9..b3f089400 100644 --- a/src/main/java/com/lilt/client/model/WorkflowStageAssignment.java +++ b/src/main/java/com/lilt/client/model/WorkflowStageAssignment.java @@ -1,9 +1,9 @@ /* * Lilt REST API - * The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. * * The version of the OpenAPI document: v3.0 - * Contact: support@lilt.com + * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ * An assignment object that associates a user to a workflow stage template. */ @ApiModel(description = "An assignment object that associates a user to a workflow stage template.") -@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-22T00:19:36.591Z[GMT]") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") public class WorkflowStageAssignment { public static final String SERIALIZED_NAME_WORKFLOW_STAGE_TEMPLATE_ID = "workflowStageTemplateId"; @SerializedName(SERIALIZED_NAME_WORKFLOW_STAGE_TEMPLATE_ID) diff --git a/src/main/java/com/lilt/client/model/WorkflowStageTemplate.java b/src/main/java/com/lilt/client/model/WorkflowStageTemplate.java new file mode 100644 index 000000000..36121052d --- /dev/null +++ b/src/main/java/com/lilt/client/model/WorkflowStageTemplate.java @@ -0,0 +1,181 @@ +/* + * Lilt REST API + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * + * The version of the OpenAPI document: v3.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.lilt.client.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * A single stage within a Workflow Template. + */ +@ApiModel(description = "A single stage within a Workflow Template.") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") +public class WorkflowStageTemplate { + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + /** + * An enum to represent all possible types of Workflow stage. + */ + @JsonAdapter(AssignmentTypeEnum.Adapter.class) + public enum AssignmentTypeEnum { + READY_TO_START("READY_TO_START"), + + TRANSLATE("TRANSLATE"), + + REVIEW("REVIEW"), + + SECONDARY_REVIEW("SECONDARY_REVIEW"), + + DONE("DONE"); + + private String value; + + AssignmentTypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static AssignmentTypeEnum fromValue(String value) { + for (AssignmentTypeEnum b : AssignmentTypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final AssignmentTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public AssignmentTypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return AssignmentTypeEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_ASSIGNMENT_TYPE = "assignmentType"; + @SerializedName(SERIALIZED_NAME_ASSIGNMENT_TYPE) + private AssignmentTypeEnum assignmentType; + + + public WorkflowStageTemplate name(String name) { + + this.name = name; + return this; + } + + /** + * The human readable name of a Workflow stage. + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "Translate", value = "The human readable name of a Workflow stage.") + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public WorkflowStageTemplate assignmentType(AssignmentTypeEnum assignmentType) { + + this.assignmentType = assignmentType; + return this; + } + + /** + * An enum to represent all possible types of Workflow stage. + * @return assignmentType + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "TRANSLATE", value = "An enum to represent all possible types of Workflow stage.") + + public AssignmentTypeEnum getAssignmentType() { + return assignmentType; + } + + + public void setAssignmentType(AssignmentTypeEnum assignmentType) { + this.assignmentType = assignmentType; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + WorkflowStageTemplate workflowStageTemplate = (WorkflowStageTemplate) o; + return Objects.equals(this.name, workflowStageTemplate.name) && + Objects.equals(this.assignmentType, workflowStageTemplate.assignmentType); + } + + @Override + public int hashCode() { + return Objects.hash(name, assignmentType); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class WorkflowStageTemplate {\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" assignmentType: ").append(toIndentedString(assignmentType)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/lilt/client/model/WorkflowTemplate.java b/src/main/java/com/lilt/client/model/WorkflowTemplate.java new file mode 100644 index 000000000..b56c3a314 --- /dev/null +++ b/src/main/java/com/lilt/client/model/WorkflowTemplate.java @@ -0,0 +1,198 @@ +/* + * Lilt REST API + * Lilt REST API Support: https://lilt.atlassian.net/servicedesk/customer/portals The Lilt REST API enables programmatic access to the full-range of Lilt backend services including: * Training of and translating with interactive, adaptive machine translation * Large-scale translation memory * The Lexicon (a large-scale termbase) * Programmatic control of the Lilt CAT environment * Translation memory synchronization Requests and responses are in JSON format. The REST API only responds to HTTPS / SSL requests. The base url for this REST API is `https://api.lilt.com/`. ## Authentication Requests are authenticated via REST API key, which requires the Business plan. Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your REST API key as both the `username` and `password`. For development, you may also pass the REST API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use. ## Quotas Our services have a general quota of 4000 requests per minute. Should you hit the maximum requests per minute, you will need to wait 60 seconds before you can send another request. + * + * The version of the OpenAPI document: v3.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.lilt.client.model; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import com.lilt.client.model.WorkflowStageTemplate; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.List; + +/** + * A workflow template which defines the workflow's possible steps (combination of Translation, Review and Customer Review). + */ +@ApiModel(description = "A workflow template which defines the workflow's possible steps (combination of Translation, Review and Customer Review).") +@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-14T17:01:14.551Z[GMT]") +public class WorkflowTemplate { + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private BigDecimal id; + + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + public static final String SERIALIZED_NAME_TEAM_ID = "TeamId"; + @SerializedName(SERIALIZED_NAME_TEAM_ID) + private BigDecimal teamId; + + public static final String SERIALIZED_NAME_STAGES = "stages"; + @SerializedName(SERIALIZED_NAME_STAGES) + private List stages = null; + + + public WorkflowTemplate id(BigDecimal id) { + + this.id = id; + return this; + } + + /** + * Identifier of a teams Workflow template. Can be used during Job creation for specifying the workflow used for a job or language pair. + * @return id + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "15", value = "Identifier of a teams Workflow template. Can be used during Job creation for specifying the workflow used for a job or language pair.") + + public BigDecimal getId() { + return id; + } + + + public void setId(BigDecimal id) { + this.id = id; + } + + + public WorkflowTemplate name(String name) { + + this.name = name; + return this; + } + + /** + * Get name + * @return name + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "Translate > Review > Customer Review", value = "") + + public String getName() { + return name; + } + + + public void setName(String name) { + this.name = name; + } + + + public WorkflowTemplate teamId(BigDecimal teamId) { + + this.teamId = teamId; + return this; + } + + /** + * The name of a given Workflow template. + * @return teamId + **/ + @javax.annotation.Nullable + @ApiModelProperty(example = "100", value = "The name of a given Workflow template.") + + public BigDecimal getTeamId() { + return teamId; + } + + + public void setTeamId(BigDecimal teamId) { + this.teamId = teamId; + } + + + public WorkflowTemplate stages(List stages) { + + this.stages = stages; + return this; + } + + public WorkflowTemplate addStagesItem(WorkflowStageTemplate stagesItem) { + if (this.stages == null) { + this.stages = new ArrayList(); + } + this.stages.add(stagesItem); + return this; + } + + /** + * The stages in this workflow template. + * @return stages + **/ + @javax.annotation.Nullable + @ApiModelProperty(value = "The stages in this workflow template.") + + public List getStages() { + return stages; + } + + + public void setStages(List stages) { + this.stages = stages; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + WorkflowTemplate workflowTemplate = (WorkflowTemplate) o; + return Objects.equals(this.id, workflowTemplate.id) && + Objects.equals(this.name, workflowTemplate.name) && + Objects.equals(this.teamId, workflowTemplate.teamId) && + Objects.equals(this.stages, workflowTemplate.stages); + } + + @Override + public int hashCode() { + return Objects.hash(id, name, teamId, stages); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class WorkflowTemplate {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" teamId: ").append(toIndentedString(teamId)).append("\n"); + sb.append(" stages: ").append(toIndentedString(stages)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + From c53937e816b631d11c36f9be1fedef4c8b844da8 Mon Sep 17 00:00:00 2001 From: nicholas-chiu Date: Wed, 16 Oct 2024 13:22:02 -0700 Subject: [PATCH 2/2] Adding tests + github action automation (#30) * Adding tests * Adding environment variable access, adding test automation * Updating java version, fixing env var access call * Updating maven version * Downgrading to java 1.9 * Updating java version in github action file * Removing maven enforcer plugin * Updating maven jar plugin * Adding debug flag * Reverting pom.xml * Updating pom with Zack update, downgrading github checkout/setup * Removing updated switch/case syntax, removing debug flag * Fixing switch/case compilation errors * Changing getFirst() to get() call * Removing unused imports * Removing ignore failure flag * Upgrading to java 11, changing distribution to temurin * Fixing java version property * Switching to gcp-runner for staging access * Adding maven cache * Adding maven setup * Adding latest check * Testing createSections assert * Fixing List casting * Fixing assert return * Adding createChars assert --- .github/workflows/javaapp.yml | 34 ++++ .gitignore | 1 + pom.xml | 35 ++-- src/test-resources/get_documents.json | 36 ++++ src/test-resources/test-fr_to_en.tmx | 14 ++ src/test-resources/translate-fr_to_en.txt | 2 + .../testCreateContent/TestCreateChars.java | 105 ++++++++++ .../testCreateContent/TestCreateSections.java | 102 ++++++++++ .../com/lilt/testCreateContent/TestSign.java | 55 ++++++ .../testDataSource/TestCreateDataSource.java | 165 ++++++++++++++++ .../lilt/testDataSource/TestUploadTMX.java | 179 ++++++++++++++++++ .../TestInstantTranslate.java | 151 +++++++++++++++ src/test/java/com/lilt/testRunner.java | 24 +++ 13 files changed, 880 insertions(+), 23 deletions(-) create mode 100644 .github/workflows/javaapp.yml create mode 100644 src/test-resources/get_documents.json create mode 100644 src/test-resources/test-fr_to_en.tmx create mode 100644 src/test-resources/translate-fr_to_en.txt create mode 100644 src/test/java/com/lilt/testCreateContent/TestCreateChars.java create mode 100644 src/test/java/com/lilt/testCreateContent/TestCreateSections.java create mode 100644 src/test/java/com/lilt/testCreateContent/TestSign.java create mode 100644 src/test/java/com/lilt/testDataSource/TestCreateDataSource.java create mode 100644 src/test/java/com/lilt/testDataSource/TestUploadTMX.java create mode 100644 src/test/java/com/lilt/testInstantTranslate/TestInstantTranslate.java create mode 100644 src/test/java/com/lilt/testRunner.java diff --git a/.github/workflows/javaapp.yml b/.github/workflows/javaapp.yml new file mode 100644 index 000000000..0a53d2a53 --- /dev/null +++ b/.github/workflows/javaapp.yml @@ -0,0 +1,34 @@ +name: JUnit Tests + +env: + API_HOST: ${{ vars.API_HOST }} + API_KEY: ${{ secrets.API_KEY }} + +on: + push: + branches: [ master, openapi-bindings ] + pull_request: + branches: [ master, openapi-bindings ] + +jobs: + build: + + runs-on: gcp-runner + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up JDK 1.11 + uses: actions/setup-java@v4 + with: + java-version: '11' + distribution: 'temurin' + + - name: Set up Maven + uses: stCarolas/setup-maven@v5 + with: + maven-version: 3.8.1 + + - name: Build + run: mvn --batch-mode package diff --git a/.gitignore b/.gitignore index 31f5505bc..7796b5410 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ build .classpath .settings +.idea diff --git a/pom.xml b/pom.xml index 1b536051a..0ac47924c 100644 --- a/pom.xml +++ b/pom.xml @@ -1,36 +1,25 @@ 4.0.0 - org.openapitools - openapi-java-client + com.lilt.client + lilt-java-client jar - openapi-java-client + lilt-java-client 3.0.0 https://github.com/openapitools/openapi-generator - OpenAPI Java + LILT Java scm:git:git@github.com:openapitools/openapi-generator.git scm:git:git@github.com:openapitools/openapi-generator.git https://github.com/openapitools/openapi-generator - - - - Unlicense - http://unlicense.org - repo - - - - - - OpenAPI-Generator Contributors - team@openapitools.org - OpenAPITools.org - http://openapitools.org - - - + + + github + Lilt packages on GitHub + https://maven.pkg.github.com/lilt/lilt-java + + @@ -266,7 +255,7 @@ - 1.7 + 11 ${java.version} ${java.version} 1.8.5 diff --git a/src/test-resources/get_documents.json b/src/test-resources/get_documents.json new file mode 100644 index 000000000..e60f2d28e --- /dev/null +++ b/src/test-resources/get_documents.json @@ -0,0 +1,36 @@ +{ + "id": 46530, + "project_id": 287, + "srclang": "en", + "trglang": "de", + "name": "Introduction.xliff", + "import_in_progress": false, + "import_succeeded": false, + "import_error_message": "Could not parse XML.", + "export_in_progress": false, + "export_succeeded": false, + "export_error_message": "Could not parse XML.", + "is_pretranslating": false, + "status": { + "pretranslation": "idle" + }, + "translator_email": "translator@example.com", + "reviewer_email": "reviewer@example.com", + "created_at": 1489147692, + "updated_at": 1489147692, + "segments": [ + { + "id": 84480010, + "created_at": 1489147692, + "updated_at": 1489147692, + "document_id": 1234, + "memory_id": 5678, + "source": "The red bus.", + "srclang": "en", + "target": "Le bus rouge.", + "trglang": "fr", + "is_confirmed": true, + "is_reviewed": true + } + ] + } diff --git a/src/test-resources/test-fr_to_en.tmx b/src/test-resources/test-fr_to_en.tmx new file mode 100644 index 000000000..a44825ded --- /dev/null +++ b/src/test-resources/test-fr_to_en.tmx @@ -0,0 +1,14 @@ + + +
+ + + + chatte + + + cat + + + + diff --git a/src/test-resources/translate-fr_to_en.txt b/src/test-resources/translate-fr_to_en.txt new file mode 100644 index 000000000..bacf71597 --- /dev/null +++ b/src/test-resources/translate-fr_to_en.txt @@ -0,0 +1,2 @@ +chatte +bonjour diff --git a/src/test/java/com/lilt/testCreateContent/TestCreateChars.java b/src/test/java/com/lilt/testCreateContent/TestCreateChars.java new file mode 100644 index 000000000..b6ea070bc --- /dev/null +++ b/src/test/java/com/lilt/testCreateContent/TestCreateChars.java @@ -0,0 +1,105 @@ +package com.lilt.testCreateContent; + +import static org.junit.Assert.*; + +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.Configuration; +import com.lilt.client.auth.*; +import com.lilt.client.model.*; +import com.lilt.client.api.CreateApi; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +@RunWith(Parameterized.class) +public class TestCreateChars { + private final String charCase; + private final ApiClient defaultClient; + + public TestCreateChars(String charCase) { + this.charCase = charCase; + this.defaultClient = Configuration.getDefaultApiClient(); + this.defaultClient.setBasePath(System.getenv("API_HOST")); + ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) this.defaultClient.getAuthentication("ApiKeyAuth"); + ApiKeyAuth.setApiKey(System.getenv("API_KEY")); + } + + @Parameterized.Parameters(name="{0}") + public static Collection charCases() { + return Arrays.asList(new Object[][] { + {"none"}, + {"normal"}, + {"over500"} + }); + } + + public static String getSummary(String charCase) { + String normal_summary = "a blog post about how important bees are to my honey farm"; + switch (charCase) { + case "none": + return ""; + case "normal": + return normal_summary; + case "over500": + return new String(new char[10]).replace("\0", normal_summary); + default: + return""; + } + } + + public static void assertExpected(LiltCreateContent response, String expectedSummary) { + assertEquals(response.getLanguage(), "en-US"); + assertEquals(response.getTemplate(), "blog-post"); + LiltCreateContentTemplateParams responseTemplateParams = response.getTemplateParams(); + assertEquals((int) responseTemplateParams.getContentLength(), 1000); + assertNull(responseTemplateParams.getMemoryId()); + assertEquals(responseTemplateParams.getLanguage(), "en-US"); + List expectedSections = Arrays.asList("Bees and me", "Honey for you", "Conclusion"); + for (int index=0; index createResultContents = createResult.getContents(); + LiltCreateContent latest = createResultContents.get(createResultContents.size() - 1); + System.out.println(latest); + assertExpected(latest, getSummary(this.charCase)); + } catch (ApiException e) { + System.err.println("Exception when calling CreateApi#signLiltCreateTerms"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + fail("should not throw exception"); + } + } +} diff --git a/src/test/java/com/lilt/testCreateContent/TestCreateSections.java b/src/test/java/com/lilt/testCreateContent/TestCreateSections.java new file mode 100644 index 000000000..c81cf2131 --- /dev/null +++ b/src/test/java/com/lilt/testCreateContent/TestCreateSections.java @@ -0,0 +1,102 @@ +package com.lilt.testCreateContent; + +import static org.junit.Assert.*; + +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.Configuration; +import com.lilt.client.auth.*; +import com.lilt.client.model.*; +import com.lilt.client.api.CreateApi; + +import java.util.Arrays; +import java.util.Collection; +import java.util.List; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +@RunWith(Parameterized.class) +public class TestCreateSections { + private final String sectionCase; + private final ApiClient defaultClient; + + public TestCreateSections(String sectionCase) { + this.sectionCase = sectionCase; + this.defaultClient = Configuration.getDefaultApiClient(); + this.defaultClient.setBasePath(System.getenv("API_HOST")); + ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) this.defaultClient.getAuthentication("ApiKeyAuth"); + ApiKeyAuth.setApiKey(System.getenv("API_KEY")); + } + + @Parameterized.Parameters(name="{0}") + public static Collection charCases() { + return Arrays.asList(new Object[][] { + {"none"}, + {"one"}, + {"multiple"} + }); + } + + public static List getSections(String sectionCase) { + switch (sectionCase) { + case "one": + return Arrays.asList("Bees and me"); + case "multiple": + return Arrays.asList("Bees and me", "Honey for you", "Conclusion"); + default: + return Arrays.asList(); + } + } + + public static void assertExpected(LiltCreateContent response, List expectedSections) { + assertEquals(response.getLanguage(), "en-US"); + assertEquals(response.getTemplate(), "blog-post"); + LiltCreateContentTemplateParams responseTemplateParams = response.getTemplateParams(); + assertEquals((int) responseTemplateParams.getContentLength(), 1000); + assertNull(responseTemplateParams.getMemoryId()); + assertEquals(responseTemplateParams.getLanguage(), "en-US"); + for (int index=0; index createResultContents = createResult.getContents(); + LiltCreateContent latest = createResultContents.get(createResultContents.size() - 1); + System.out.println(latest); + assertExpected(latest, getSections(this.sectionCase)); + } catch (ApiException e) { + System.err.println("Exception when calling CreateApi#signLiltCreateTerms"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + fail("should not throw exception"); + } + } +} diff --git a/src/test/java/com/lilt/testCreateContent/TestSign.java b/src/test/java/com/lilt/testCreateContent/TestSign.java new file mode 100644 index 000000000..51d50c018 --- /dev/null +++ b/src/test/java/com/lilt/testCreateContent/TestSign.java @@ -0,0 +1,55 @@ +package com.lilt.testCreateContent; + +import static org.junit.Assert.*; + +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.Configuration; +import com.lilt.client.auth.*; +import com.lilt.client.model.*; +import com.lilt.client.api.CreateApi; +import java.util.Arrays; +import java.util.Collection; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +@RunWith(Parameterized.class) +public class TestSign { + private final boolean sign; + private final ApiClient defaultClient; + + public TestSign(boolean sign) { + this.sign = sign; + this.defaultClient = Configuration.getDefaultApiClient(); + this.defaultClient.setBasePath(System.getenv("API_HOST")); + ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) this.defaultClient.getAuthentication("ApiKeyAuth"); + ApiKeyAuth.setApiKey(System.getenv("API_KEY")); + } + + @Parameterized.Parameters(name="{0}") + public static Collection booleans() { + return Arrays.asList(new Object[][] { + { true }, { false } + }); + } + + @Test + public void sign() { + CreateApi apiInstance = new CreateApi(this.defaultClient); + CreateConverterConfigParameters signedAgreement = new CreateConverterConfigParameters(); + signedAgreement.setSignedAgreement(this.sign); + try { + SignLiltCreateTermsResponse result = apiInstance.signLiltCreateTerms(signedAgreement); + System.out.println(result); + assertEquals(result.getSignedAgreement(), this.sign); + } catch (ApiException e) { + System.err.println("Exception when calling CreateApi#signLiltCreateTerms"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + fail("should not throw exception"); + } + } +} diff --git a/src/test/java/com/lilt/testDataSource/TestCreateDataSource.java b/src/test/java/com/lilt/testDataSource/TestCreateDataSource.java new file mode 100644 index 000000000..a61f4317f --- /dev/null +++ b/src/test/java/com/lilt/testDataSource/TestCreateDataSource.java @@ -0,0 +1,165 @@ +package com.lilt.testDataSource; + +import static org.junit.Assert.*; + +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.Configuration; +import com.lilt.client.auth.*; +import com.lilt.client.model.*; +import com.lilt.client.api.MemoriesApi; + +import java.util.*; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +@RunWith(Parameterized.class) +public class TestCreateDataSource { + private final String dataSourceLanguages; + private final ApiClient defaultClient; + private final List shouldFail = Arrays.asList("none_src", "none_trg", "none_both", "unsupported_languages"); + + public TestCreateDataSource(String dataSourceLanguages) { + this.dataSourceLanguages = dataSourceLanguages; + this.defaultClient = Configuration.getDefaultApiClient(); + this.defaultClient.setBasePath(System.getenv("API_HOST")); + ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) this.defaultClient.getAuthentication("ApiKeyAuth"); + ApiKeyAuth.setApiKey(System.getenv("API_KEY")); + } + + @Parameterized.Parameters(name="{0}") + public static Collection dataSourceLanguages() { + return Arrays.asList(new Object[][] { + { "none_src" }, + { "none_trg" }, + { "none_both" }, + { "english" }, + { "non_english" }, + { "source_is_target" }, + { "unsupported_languages" } + }); + } + + public static Dictionary getDataSourceParameters(String datasSourceCase) { + Dictionary parameterDict = new Hashtable<>(); + switch (datasSourceCase) { + case "none_src": + parameterDict.put("name", "test-non-src"); + parameterDict.put("srclang", ""); + parameterDict.put("trglang", "en"); + parameterDict.put("srclocale", "US"); + parameterDict.put("trglocale", ""); + break; + case "none_trg": + parameterDict.put("name", "test-none-trg"); + parameterDict.put("srclang", "en"); + parameterDict.put("trglang", ""); + parameterDict.put("srclocale", "US"); + parameterDict.put("trglocale", ""); + break; + case "none_both": + parameterDict.put("name", "test-none-both"); + parameterDict.put("srclang", ""); + parameterDict.put("trglang", ""); + parameterDict.put("srclocale", "US"); + parameterDict.put("trglocale", ""); + break; + case "english": + parameterDict.put("name", "test-english"); + parameterDict.put("srclang", "en"); + parameterDict.put("trglang", "es"); + parameterDict.put("srclocale", "US"); + parameterDict.put("trglocale", ""); + break; + case "non_english": + parameterDict.put("name", "test-non-english"); + parameterDict.put("srclang", "de"); + parameterDict.put("trglang", "fr"); + parameterDict.put("srclocale", "DE"); + parameterDict.put("trglocale", "FR"); + break; + case "source_is_target": + parameterDict.put("name", "test-source-is-target"); + parameterDict.put("srclang", "fr"); + parameterDict.put("trglang", "fr"); + parameterDict.put("srclocale", "FR"); + parameterDict.put("trglocale", "FR"); + break; + case "unsupported_languages": + parameterDict.put("name", "test-unsupported-languages"); + parameterDict.put("srclang", "ac"); + parameterDict.put("trglang", "ad"); + parameterDict.put("srclocale", ""); + parameterDict.put("trglocale", ""); + break; + } + return parameterDict; + }; + + public static Memory getExpected(String dataSourceLanguages) { + Memory expected = new Memory(); + switch (dataSourceLanguages) { + case "english": + expected.setSrclang("en"); + expected.setTrglang("es"); + expected.setSrclocale("US"); + expected.setTrglocale(null); + expected.setName("test-english"); + break; + case "non_english": + expected.setSrclang("de"); + expected.setTrglang("fr"); + expected.setSrclocale("DE"); + expected.setTrglocale("FR"); + expected.setName("test-non-english"); + break; + case "source_is_target": + expected.setSrclang("fr"); + expected.setTrglang("fr"); + expected.setSrclocale("FR"); + expected.setTrglocale("FR"); + expected.setName("test-source-is-target"); + break; + default: + break; + } + return expected; + } + + public static void assertResponse(Memory response, Memory expected) { + assertEquals(response.getSrclang(), expected.getSrclang()); + assertEquals(response.getTrglang(), expected.getTrglang()); + assertEquals(response.getSrclocale(), expected.getSrclocale()); + assertEquals(response.getTrglocale(), expected.getTrglocale()); + assertEquals(response.getName(), expected.getName()); + } + + @Test + public void createDataSource() { + MemoriesApi apiInstance = new MemoriesApi(defaultClient); + MemoryCreateParameters body = new MemoryCreateParameters(); + Dictionary bodyParameters = getDataSourceParameters(this.dataSourceLanguages); + body.setName(bodyParameters.get("name")); + body.setSrclang(bodyParameters.get("srclang")); + body.setTrglang(bodyParameters.get("trglang")); + body.setSrclocale(bodyParameters.get("srclocale")); + body.setTrglocale(bodyParameters.get("trglocale")); + try { + Memory result = apiInstance.createMemory(body); + System.out.println(result); + assertResponse(result, getExpected(this.dataSourceLanguages)); + } catch (ApiException e) { + System.err.println("Exception when calling MemoriesApi#createMemory"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + if(!this.shouldFail.contains(this.dataSourceLanguages)) { + fail("should be able to create data source"); + } else { + assertEquals(e.getCode(), 400); + } + } + } +} diff --git a/src/test/java/com/lilt/testDataSource/TestUploadTMX.java b/src/test/java/com/lilt/testDataSource/TestUploadTMX.java new file mode 100644 index 000000000..e86ae8ce9 --- /dev/null +++ b/src/test/java/com/lilt/testDataSource/TestUploadTMX.java @@ -0,0 +1,179 @@ +package com.lilt.testDataSource; + +import static org.junit.Assert.*; + +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.Configuration; +import com.lilt.client.auth.*; +import com.lilt.client.model.*; +import com.lilt.client.api.MemoriesApi; + +import java.io.File; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.concurrent.*; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; + +@RunWith(Parameterized.class) +public class TestUploadTMX { + private final String tmxFileCase; + private final ApiClient defaultClient; + + public TestUploadTMX(String tmxFileCase) { + this.tmxFileCase = tmxFileCase; + this.defaultClient = Configuration.getDefaultApiClient(); + this.defaultClient.setBasePath(System.getenv("API_HOST")); + ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) this.defaultClient.getAuthentication("ApiKeyAuth"); + ApiKeyAuth.setApiKey(System.getenv("API_KEY")); + } + + @Parameterized.Parameters(name="{0}") + public static Collection tmxFileCase() { + return Arrays.asList(new Object[][] { + { "wrong_data" }, + { "normal" } + }); + } + + public static String getTMXName(String tmxFileCase) { + switch (tmxFileCase) { + case "wrong_data": + return "get_documents.json"; + case "normal": + return "fr_to_en.tmx"; + default: + return ""; + } + } + + public static File getTMXFile(String tmxFileCase) { + String filepath = ""; + switch (tmxFileCase) { + case "wrong_data": + filepath = "/src/test-resources/get_documents.json"; + break; + case "normal": + filepath = "/src/test-resources/test-fr_to_en.tmx"; + break; + default: + filepath = ""; + } + try { + return new File(System.getProperty("user.dir") + filepath); + } catch (NullPointerException e) { + System.out.println("Could not find file"); + fail("Should always be able to access test-resources"); + return null; + } + } + + private void printError(ApiException e) { + System.err.println("Exception when calling FilesApi#uploadFile"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + + public class MonitorFileHandler implements Callable { + private MemoriesApi memoriesApiInstance; + private int memoryId; + private Boolean translationStatus; + private int numMonitored; + + public MonitorFileHandler(MemoriesApi memoriesApiInstance, int memoryId, Boolean translationStatus, int numMonitored) { + this.memoriesApiInstance = memoriesApiInstance; + this.memoryId = memoryId; + this.translationStatus = translationStatus; + this.numMonitored = numMonitored; + } + + private Boolean monitorFile() { + try { + List monitorResult = null; + while (this.translationStatus) { + monitorResult = this.memoriesApiInstance.getMemory(this.memoryId); + this.translationStatus = monitorResult.get(0).getIsProcessing(); + Thread.sleep(5000); + System.out.println("Translation status: " + this.translationStatus + " || Request No: " + numMonitored); + numMonitored++; + if (numMonitored > 12) { + break; + } + } + return monitorResult.get(0).getIsProcessing(); + } catch (ApiException e) { + e.printStackTrace(); + fail("Should be able to monitor translation"); + } catch (InterruptedException e) { + e.printStackTrace(); + fail("Should not be interrupted"); + } + return null; + } + + @Override + public String call() throws Exception { + return Boolean.toString(monitorFile()); + } + } + + + @Test + public void createDataSource() { + MemoriesApi apiInstance = new MemoriesApi(defaultClient); + MemoryCreateParameters body = new MemoryCreateParameters(); + body.setName("test-fr_to_en"); + body.setSrclang("fr"); + body.setTrglang("en"); + body.setSrclocale("FR"); + body.setTrglocale("US"); + try { + Memory createMemoryResult = apiInstance.createMemory(body); + int memoryId = createMemoryResult.getId(); + String name = getTMXName(this.tmxFileCase); + File fileContents = getTMXFile(this.tmxFileCase); + List sdlxliffFilters = Arrays.asList(); + Boolean hasHeaderRow = null; + Boolean skipDuplicates = true; + + MemoryImportResponse importMemoryResult = apiInstance.importMemoryFile(memoryId, name, fileContents, sdlxliffFilters, hasHeaderRow, skipDuplicates); + System.out.println(importMemoryResult); + int intIsProcessing = importMemoryResult.getIsProcessing(); + assertEquals(intIsProcessing, 1); + + Boolean isProcessing = intIsProcessing == 1; + MonitorFileHandler handler = new MonitorFileHandler(apiInstance, memoryId, isProcessing, 0); + ExecutorService executor = Executors.newSingleThreadExecutor(); + final Future monitorHandler = executor.submit(handler); + + try { + isProcessing = monitorHandler.get(120, TimeUnit.SECONDS) == "true"; + if (isProcessing) { + System.out.println("Translation exceeding time limit. Switching to finished translation."); + fail("Memory file processing should not timeout"); + } + } catch (TimeoutException | ExecutionException | InterruptedException e) { + monitorHandler.cancel(true); + } + executor.shutdownNow(); + + String query = "chatte"; + List result = apiInstance.queryMemory(memoryId, query, 10); + if (this.tmxFileCase.equals("wrong_data")) { + assert result.isEmpty(); + } else { + assertEquals(result.get(0).getSource(), "chatte"); + assertEquals(result.get(0).getTarget(), "cat"); + } + } catch (ApiException e) { + printError(e); + fail("should not throw exception"); + } + } +} diff --git a/src/test/java/com/lilt/testInstantTranslate/TestInstantTranslate.java b/src/test/java/com/lilt/testInstantTranslate/TestInstantTranslate.java new file mode 100644 index 000000000..a4687c252 --- /dev/null +++ b/src/test/java/com/lilt/testInstantTranslate/TestInstantTranslate.java @@ -0,0 +1,151 @@ +package com.lilt.testInstantTranslate; + +import static org.junit.Assert.*; + +import com.lilt.client.ApiClient; +import com.lilt.client.ApiException; +import com.lilt.client.Configuration; +import com.lilt.client.auth.*; +import com.lilt.client.model.*; +import com.lilt.client.api.FilesApi; +import com.lilt.client.api.TranslateApi; + +import java.io.File; +import java.nio.charset.StandardCharsets; +import java.util.List; +import java.util.concurrent.*; + +import org.junit.Test; + +public class TestInstantTranslate { + private final ApiClient defaultClient; + private final String STAGING_MEMORY_ID = "23583"; + private final String STAGING_TRANSLATION_ID = "17680"; + + + public TestInstantTranslate() { + this.defaultClient = Configuration.getDefaultApiClient(); + this.defaultClient.setBasePath(System.getenv("API_HOST")); + ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) this.defaultClient.getAuthentication("ApiKeyAuth"); + ApiKeyAuth.setApiKey(System.getenv("API_KEY")); + } + + private void printError(ApiException e) { + System.err.println("Exception when calling FilesApi#uploadFile"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + + public class MonitorFileHandler implements Callable{ + private final TranslateApi translateApiInstance; + private final String translationId; + private String translationStatus; + private int numMonitored; + + public MonitorFileHandler(TranslateApi translateApiInstance, String translationId, String translationStatus, int numMonitored) { + this.translateApiInstance = translateApiInstance; + this.translationId = translationId; + this.numMonitored = numMonitored; + this.translationStatus = translationStatus; + } + + private String monitorFile() { + try { + List monitorResult = null; + while (this.translationStatus.equals("InProgress")) { + monitorResult = this.translateApiInstance.monitorFileTranslation(this.translationId, null, null, null); + this.translationStatus = monitorResult.get(0).getStatus(); + Thread.sleep(5000); + System.out.println("Translation status: " + translationStatus + " || Request No: " + numMonitored); + numMonitored++; + if (numMonitored > 12) { + break; + } + } + assert monitorResult != null; + return monitorResult.get(0).getStatus(); + } catch (ApiException e) { + printError(e); + fail("Should be able to monitor translation"); + } catch (InterruptedException | NullPointerException e) { + e.printStackTrace(); + return null; + } + return null; + } + + @Override + public String call() throws Exception { + return monitorFile(); + } + } + + @Test + public void translate() { + //Upload File + FilesApi fileApiInstance = new FilesApi(defaultClient); + String name = "/src/test-resources/translate-fr_to_en.txt"; + File body = new File(System.getProperty("user.dir") + name); + String fileId = null; + try { + SourceFile fileUploadResult = fileApiInstance.uploadFile(name, body, null, null, null, null, null); + System.out.println(fileUploadResult); + fileId = Integer.toString(fileUploadResult.getId()); + } catch (ApiException apiError) { + printError(apiError); + fail("Should be able to upload file"); + } catch (NullPointerException nullError) { + nullError.printStackTrace(); + fail("File Upload returned null ID"); + }; + + //Translate File + TranslateApi translateApiInstance = new TranslateApi(defaultClient); + String memoryId = this.STAGING_MEMORY_ID; + String translationId = null; + String translationStatus = null; + try { + List translateResult = translateApiInstance.batchTranslateFile(fileId, memoryId, null, null); + System.out.println(translateResult); + TranslationInfo translationResponse = translateResult.get(0); + translationId = Integer.toString(translationResponse.getId()); + translationStatus = translationResponse.getStatus(); + } catch (ApiException e) { + printError(e); + fail("Should be able to translate file"); + } catch (NullPointerException e) { + e.printStackTrace(); + fail("File translation returned null ID"); + } + + + //Monitor Translation + MonitorFileHandler handler = new MonitorFileHandler(translateApiInstance, translationId, translationStatus, 0); + ExecutorService executor = Executors.newSingleThreadExecutor(); + final Future monitorHandler = executor.submit(handler); + + try { + translationStatus = monitorHandler.get(120, TimeUnit.SECONDS); + if (translationStatus.equals("InProgress")) { + translationId = this.STAGING_TRANSLATION_ID; + System.out.println("Translation exceeding time limit. Switching to finished translation."); + } + } catch (TimeoutException | InterruptedException | ExecutionException e) { + monitorHandler.cancel(true); + } + executor.shutdownNow(); + + //Download File + try { + byte[] downloadResult = translateApiInstance.downloadFile(translationId); + String downloadString = new String(downloadResult, StandardCharsets.UTF_8); + System.out.println(downloadString); + assertTrue(downloadString.contains("cat")); + assertTrue(downloadString.contains("Hello")); + } catch (ApiException e) { + printError(e); + } + } +} diff --git a/src/test/java/com/lilt/testRunner.java b/src/test/java/com/lilt/testRunner.java new file mode 100644 index 000000000..891d42910 --- /dev/null +++ b/src/test/java/com/lilt/testRunner.java @@ -0,0 +1,24 @@ +package com.lilt; + +import org.junit.runner.RunWith; +import org.junit.runners.Suite; +import com.lilt.testCreateContent.TestSign; +import com.lilt.testCreateContent.TestCreateChars; +import com.lilt.testCreateContent.TestCreateSections; +import com.lilt.testDataSource.TestCreateDataSource; +import com.lilt.testDataSource.TestUploadTMX; +import com.lilt.testInstantTranslate.TestInstantTranslate; + +@RunWith(Suite.class) + +@Suite.SuiteClasses({ + TestSign.class, + TestCreateChars.class, + TestCreateSections.class, + TestCreateDataSource.class, + TestUploadTMX.class, + TestInstantTranslate.class +}) + +public class testRunner { +}