Skip to content

Commit

Permalink
Regenerates API Bindings
Browse files Browse the repository at this point in the history
  • Loading branch information
tgallant authored Aug 19, 2023
1 parent e725e59 commit cdb85e4
Show file tree
Hide file tree
Showing 134 changed files with 442 additions and 132 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Our services have a general quota of 4000 requests per minute. Should you hit th
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v2.0
- Package version: 0.5.0
- Package version: 0.6.3
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For more information, please visit [https://lilt.com/docs/api](https://lilt.com/docs/api)

Expand Down Expand Up @@ -326,6 +326,7 @@ Class | Method | HTTP request | Description
- [LiltNode.QARuleMatchesRuleUrls](docs/QARuleMatchesRuleUrls.md)
- [LiltNode.ResourceStatus](docs/ResourceStatus.md)
- [LiltNode.ReviewCompletionTypeError](docs/ReviewCompletionTypeError.md)
- [LiltNode.SDLXLIFFFilter](docs/SDLXLIFFFilter.md)
- [LiltNode.Segment](docs/Segment.md)
- [LiltNode.SegmentCreateParameters](docs/SegmentCreateParameters.md)
- [LiltNode.SegmentDeleteResponse](docs/SegmentDeleteResponse.md)
Expand Down
1 change: 1 addition & 0 deletions docs/DocumentWithSegments.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Name | Type | Description | Notes
**reviewerEmail** | **String** | The email of the assigned reviewer. | [optional]
**createdAt** | **Number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional]
**updatedAt** | **Number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional]
**isReviewComplete** | **Boolean** | Document review status. | [optional]
**segments** | [**[Segment]**](Segment.md) | A list of Segments. | [optional]


1 change: 1 addition & 0 deletions docs/DocumentWithoutSegments.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,6 @@ Name | Type | Description | Notes
**reviewerEmail** | **String** | The email of the assigned reviewer. | [optional]
**createdAt** | **Number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional]
**updatedAt** | **Number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional]
**isReviewComplete** | **Boolean** | Document review status. | [optional]


2 changes: 2 additions & 0 deletions docs/JobCreateParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Name | Type | Description | Notes
**languagePairs** | [**[LanguagePair]**](LanguagePair.md) | Language pairs is a set of one or more pairs that includes source language, source locale(optional), target language, target locale(optional), and memoryId. |
**fileIds** | **[Number]** | A list of file ids to upload to job creation. |
**due** | **String** | An ISO string date representing job due date. | [optional]
**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** | **Number** | Identifier of the workflow template to be used when creating a job. If not passed the organization default will be used. | [optional]

Expand Down
4 changes: 3 additions & 1 deletion docs/MemoriesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,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` 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://lilt.com/2/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 ```
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://lilt.com/2/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://lilt.com/2/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

Expand All @@ -209,6 +209,7 @@ let memoryId = 56; // Number | A unique Memory identifier.
let name = "name_example"; // String | Name of the TM or termbase file.
let body = "/path/to/file"; // File | The file contents to be uploaded. The entire POST body will be treated as the file.
let opts = {
'sdlxliffFilters': [new LiltNode.SDLXLIFFFilter()], // [SDLXLIFFFilter] | Contains Filter information Unique to SDLXLIFF
'hasHeaderRow': true, // Boolean | A flag indicating whether an imported Termbase CSV has a header row or not (the default value is `false`).
'skipDuplicates': true // Boolean | A flag indicating whether or not to skip the import of segments which already exist in the memory. (the default value is `false`).
};
Expand All @@ -228,6 +229,7 @@ Name | Type | Description | Notes
**memoryId** | **Number**| A unique Memory identifier. |
**name** | **String**| Name of the TM or termbase file. |
**body** | **File**| The file contents to be uploaded. The entire POST body will be treated as the file. |
**sdlxliffFilters** | [**[SDLXLIFFFilter]**](SDLXLIFFFilter.md)| Contains Filter information Unique to SDLXLIFF | [optional]
**hasHeaderRow** | **Boolean**| A flag indicating whether an imported Termbase CSV has a header row or not (the default value is `false`). | [optional]
**skipDuplicates** | **Boolean**| A flag indicating whether or not to skip the import of segments which already exist in the memory. (the default value is `false`). | [optional]

Expand Down
28 changes: 28 additions & 0 deletions docs/SDLXLIFFFilter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# LiltNode.SDLXLIFFFilter

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**confName** | **String** | the current state of the SDLXLIFF Trans Unit. |
**allowablePercentage** | **Number** | This represents for the current conf_name what percentage the filter applies to. If you pass -1 it will take any value for this field and won't ignore blank values. If you pass 50, Lilt will only import Segments that have a 50 percent match or better. | [optional]
**allowUnlockedSegments** | **Boolean** | Boolean that tells Lilt whether we should allow unlocked Segments for this conf_name. | [optional]



## Enum: ConfNameEnum


* `Translated` (value: `"Translated"`)

* `Draft` (value: `"Draft"`)

* `ApprovedTranslation` (value: `"ApprovedTranslation"`)

* `Locked` (value: `"Locked"`)

* `SignedOff` (value: `"SignedOff"`)




2 changes: 2 additions & 0 deletions docs/TranslateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,7 @@ let opts = {
'rich': false, // Boolean | Returns rich translation information (e.g., with word alignments).
'tmMatches': true, // Boolean | Include translation memory fuzzy matches.
'projectTags': false, // Boolean | Project tags. Projects tags in source to target if set to true.
'containsIcuData': false, // Boolean | Contains ICU data. If true then tags in the source following the ICU standard will be parsed and retained.
'body': new LiltNode.TranslateSegmentBody() // TranslateSegmentBody |
};
apiInstance.translateSegment(memoryId, opts).then((data) => {
Expand All @@ -305,6 +306,7 @@ Name | Type | Description | Notes
**rich** | **Boolean**| Returns rich translation information (e.g., with word alignments). | [optional] [default to false]
**tmMatches** | **Boolean**| Include translation memory fuzzy matches. | [optional] [default to true]
**projectTags** | **Boolean**| Project tags. Projects tags in source to target if set to true. | [optional] [default to false]
**containsIcuData** | **Boolean**| Contains ICU data. If true then tags in the source following the ICU standard will be parsed and retained. | [optional] [default to false]
**body** | [**TranslateSegmentBody**](TranslateSegmentBody.md)| | [optional]

### Return type
Expand Down
1 change: 1 addition & 0 deletions docs/TranslateSegmentBody1.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ Name | Type | Description | Notes
**rich** | **Boolean** | Returns rich translation information (e.g., with word alignments). | [optional] [default to false]
**tmMatches** | **Boolean** | Include translation memory fuzzy matches. | [optional] [default to true]
**projectTags** | **Boolean** | Project tags. Projects tags in source to target if set to true. | [optional] [default to false]
**containsICUData** | **Boolean** | Contains ICU data. If true then tags in the source following the ICU standard will be parsed and retained. | [optional] [default to false]


2 changes: 1 addition & 1 deletion src/ApiClient.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import querystring from "querystring";

/**
* @module ApiClient
* @version 0.5.0
* @version 0.6.3
*/

/**
Expand Down
2 changes: 1 addition & 1 deletion src/api/CommentsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import Error from '../model/Error';
/**
* Comments service.
* @module api/CommentsApi
* @version 0.5.0
* @version 0.6.3
*/
export default class CommentsApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/ConnectorsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import Error from '../model/Error';
/**
* Connectors service.
* @module api/ConnectorsApi
* @version 0.5.0
* @version 0.6.3
*/
export default class ConnectorsApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/ConverterConfigApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import Error from '../model/Error';
/**
* ConverterConfig service.
* @module api/ConverterConfigApi
* @version 0.5.0
* @version 0.6.3
*/
export default class ConverterConfigApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/DocumentsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import TranslateCompletionTypeError from '../model/TranslateCompletionTypeError'
/**
* Documents service.
* @module api/DocumentsApi
* @version 0.5.0
* @version 0.6.3
*/
export default class DocumentsApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/FilesApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import SourceFile from '../model/SourceFile';
/**
* Files service.
* @module api/FilesApi
* @version 0.5.0
* @version 0.6.3
*/
export default class FilesApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/JobsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import JobUpdateParameters from '../model/JobUpdateParameters';
/**
* Jobs service.
* @module api/JobsApi
* @version 0.5.0
* @version 0.6.3
*/
export default class JobsApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/LanguagesApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import LanguagesResponse from '../model/LanguagesResponse';
/**
* Languages service.
* @module api/LanguagesApi
* @version 0.5.0
* @version 0.6.3
*/
export default class LanguagesApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/LexiconApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import LexiconUpdateResponse from '../model/LexiconUpdateResponse';
/**
* Lexicon service.
* @module api/LexiconApi
* @version 0.5.0
* @version 0.6.3
*/
export default class LexiconApi {

Expand Down
10 changes: 7 additions & 3 deletions src/api/MemoriesApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ import MemoryImportResponse from '../model/MemoryImportResponse';
import MemoryInsertResponse from '../model/MemoryInsertResponse';
import MemoryUpdateParameters from '../model/MemoryUpdateParameters';
import MemoryUpdateResponse from '../model/MemoryUpdateResponse';
import SDLXLIFFFilter from '../model/SDLXLIFFFilter';
import TranslationMemoryEntry from '../model/TranslationMemoryEntry';

/**
* Memories service.
* @module api/MemoriesApi
* @version 0.5.0
* @version 0.6.3
*/
export default class MemoriesApi {

Expand Down Expand Up @@ -187,11 +188,12 @@ export default class MemoriesApi {

/**
* 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` 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://lilt.com/2/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 ```
* 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://lilt.com/2/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://lilt.com/2/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 {Number} memoryId A unique Memory identifier.
* @param {String} name Name of the TM or termbase file.
* @param {File} body The file contents to be uploaded. The entire POST body will be treated as the file.
* @param {Object} opts Optional parameters
* @param {Array.<module:model/SDLXLIFFFilter>} opts.sdlxliffFilters Contains Filter information Unique to SDLXLIFF
* @param {Boolean} opts.hasHeaderRow A flag indicating whether an imported Termbase CSV has a header row or not (the default value is `false`).
* @param {Boolean} opts.skipDuplicates A flag indicating whether or not to skip the import of segments which already exist in the memory. (the default value is `false`).
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MemoryImportResponse} and HTTP response
Expand Down Expand Up @@ -219,6 +221,7 @@ export default class MemoriesApi {
let headerParams = {
'memory_id': memoryId,
'name': name,
'sdlxliff_filters': opts['sdlxliffFilters'],
'has_header_row': opts['hasHeaderRow'],
'skip_duplicates': opts['skipDuplicates']
};
Expand All @@ -238,11 +241,12 @@ export default class MemoriesApi {

/**
* 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` 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://lilt.com/2/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 ```
* 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://lilt.com/2/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://lilt.com/2/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 {Number} memoryId A unique Memory identifier.
* @param {String} name Name of the TM or termbase file.
* @param {File} body The file contents to be uploaded. The entire POST body will be treated as the file.
* @param {Object} opts Optional parameters
* @param {Array.<module:model/SDLXLIFFFilter>} opts.sdlxliffFilters Contains Filter information Unique to SDLXLIFF
* @param {Boolean} opts.hasHeaderRow A flag indicating whether an imported Termbase CSV has a header row or not (the default value is `false`).
* @param {Boolean} opts.skipDuplicates A flag indicating whether or not to skip the import of segments which already exist in the memory. (the default value is `false`).
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MemoryImportResponse}
Expand Down
2 changes: 1 addition & 1 deletion src/api/ProjectsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import ProjectsToUpdate from '../model/ProjectsToUpdate';
/**
* Projects service.
* @module api/ProjectsApi
* @version 0.5.0
* @version 0.6.3
*/
export default class ProjectsApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/QAApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import QARuleMatches from '../model/QARuleMatches';
/**
* QA service.
* @module api/QAApi
* @version 0.5.0
* @version 0.6.3
*/
export default class QAApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/RootApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import Error from '../model/Error';
/**
* Root service.
* @module api/RootApi
* @version 0.5.0
* @version 0.6.3
*/
export default class RootApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/SegmentsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import TaggedSegment from '../model/TaggedSegment';
/**
* Segments service.
* @module api/SegmentsApi
* @version 0.5.0
* @version 0.6.3
*/
export default class SegmentsApi {

Expand Down
2 changes: 1 addition & 1 deletion src/api/SettingsApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import SettingUpsertResponse from '../model/SettingUpsertResponse';
/**
* Settings service.
* @module api/SettingsApi
* @version 0.5.0
* @version 0.6.3
*/
export default class SettingsApi {

Expand Down
Loading

0 comments on commit cdb85e4

Please sign in to comment.