Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 1 addition & 6 deletions .github/workflows/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@

name: OpenAPI Generator

on:
workflow_dispatch:
repository_dispatch:
types: [API-DocumentationV3-Deployment]

jobs:
build:
runs-on: ubuntu-latest
Expand All @@ -22,7 +17,7 @@ jobs:
with:
args: >-
generate
-i https://developers.lilt.com/redocusaurus/plugin-redoc-0.yaml
-i https://github.com/lilt/mintlify-docs/blob/main/api-reference/openapi-bundled.yaml
-g python
-p packageName=lilt
-p projectName=lilt-python
Expand Down
4 changes: 1 addition & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI

on:
repository_dispatch:
types: [API-DocumentationV3-Publish]
on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+*'
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
python-version: ["3.10", "3.11", "3.12", "3.13"]

steps:
- uses: actions/checkout@v4
Expand All @@ -26,6 +26,7 @@ jobs:
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r test-requirements.txt
pip install pytest-cov dotenv tenacity
- name: Test with pytest
run: |
pytest --cov=lilt
7 changes: 4 additions & 3 deletions .github/workflows/pythonapp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ jobs:
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pytest workflow_tests --ddtrace
# Exclude workflow_tests for now
# - name: Test with pytest
# run: |
# pytest workflow_tests --ddtrace
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
__pycache__/
*.py[cod]
*$py.class
uv.lock
.idea
.vscode
.DS_Store

# C extensions
*.so
Expand Down
59 changes: 46 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
# lilt-python
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:
LILT API Support: https://lilt.atlassian.net/servicedesk/customer/portals

The LILT 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
* 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

Requests are authenticated via REST API key, which requires the Business plan.
Requests are authenticated via 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`.
Requests are authenticated using [HTTP Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication). Add your 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.
For development, you may also pass the API key via the `key` query parameter. This is less secure than HTTP Basic Auth, and is not recommended for production use.

## Quotas

Expand All @@ -25,9 +28,9 @@ Our services have a general quota of 4000 requests per minute. Should you hit th

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v3.0.2
- Package version: v3.0.2
- Generator version: 7.13.0
- API version: v3.0.3
- Package version: 3.1.0
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.
Expand All @@ -40,9 +43,9 @@ Python 3.9+
If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/lilt/lilt-python.git
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/lilt/lilt-python.git`)
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
Expand Down Expand Up @@ -166,10 +169,24 @@ Class | Method | HTTP request | Description
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /v2/projects | Create a Project
*ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /v2/projects | Delete a Project
*ProjectsApi* | [**get_projects**](docs/ProjectsApi.md#get_projects) | **GET** /v2/projects | Retrieve a Project
*SegmentsApi* | [**create_segment**](docs/SegmentsApi.md#create_segment) | **POST** /v2/segments | Create a Segment
*SegmentsApi* | [**delete_segment**](docs/SegmentsApi.md#delete_segment) | **DELETE** /v2/segments | Delete a Segment
*SegmentsApi* | [**get_segment**](docs/SegmentsApi.md#get_segment) | **GET** /v2/segments | Retrieve a Segment
*SegmentsApi* | [**tag_segment**](docs/SegmentsApi.md#tag_segment) | **GET** /segments/tag | Tag a Segment
*SegmentsApi* | [**unlock_segments**](docs/SegmentsApi.md#unlock_segments) | **POST** /segments/review/unlock | Unaccept and unlock segments
*SegmentsApi* | [**update_segment**](docs/SegmentsApi.md#update_segment) | **PUT** /v2/segments | Update a Segment
*TranslateApi* | [**batch_translate_file**](docs/TranslateApi.md#batch_translate_file) | **POST** /v2/translate/file | Translate a File
*TranslateApi* | [**download_file**](docs/TranslateApi.md#download_file) | **GET** /v2/translate/files | Download translated file
*TranslateApi* | [**monitor_file_translation**](docs/TranslateApi.md#monitor_file_translation) | **GET** /v2/translate/file | Monitor file translation
*TranslateApi* | [**translate_segment_post**](docs/TranslateApi.md#translate_segment_post) | **POST** /v2/translate | Translate a segment
*UploadsApi* | [**cancel_multipart_upload**](docs/UploadsApi.md#cancel_multipart_upload) | **DELETE** /v2/upload/s3/multipart/{uploadId} | Cancel Multipart Upload
*UploadsApi* | [**complete_multipart_upload**](docs/UploadsApi.md#complete_multipart_upload) | **POST** /v2/upload/s3/multipart/{uploadId}/complete | Complete Multipart Upload
*UploadsApi* | [**get_pending_uploads**](docs/UploadsApi.md#get_pending_uploads) | **GET** /v2/upload | Get All Pending Uploads or specific list of uploads by ids or statuses
*UploadsApi* | [**get_s3_upload_params**](docs/UploadsApi.md#get_s3_upload_params) | **GET** /v2/upload/s3/params | Get S3 Upload Parameters
*UploadsApi* | [**get_upload_by_id**](docs/UploadsApi.md#get_upload_by_id) | **GET** /v2/upload/{uploadId} | Get Upload by ID
*UploadsApi* | [**initiate_multipart_upload**](docs/UploadsApi.md#initiate_multipart_upload) | **POST** /v2/upload/s3/multipart | Initiate Multipart Upload
*UploadsApi* | [**initiate_s3_upload**](docs/UploadsApi.md#initiate_s3_upload) | **POST** /v2/upload/s3/params | Initiate File Upload to Cloud Storage
*UploadsApi* | [**sign_upload_part**](docs/UploadsApi.md#sign_upload_part) | **GET** /v2/upload/s3/multipart/{uploadId}/partNumber | Sign Upload Part
*WebhookConfigurationApi* | [**services_configuration_api_webhooks_delete**](docs/WebhookConfigurationApi.md#services_configuration_api_webhooks_delete) | **DELETE** /v3/connectors/configuration/webhooks/{id} | Delete a specific Webhook Configuration by ID.
*WebhookConfigurationApi* | [**webhooks_create**](docs/WebhookConfigurationApi.md#webhooks_create) | **POST** /v3/connectors/configuration/webhooks | Creates a new Webhook Configuration
*WebhookConfigurationApi* | [**webhooks_get**](docs/WebhookConfigurationApi.md#webhooks_get) | **GET** /v3/connectors/configuration/webhooks/{id} | Retrieve a specific Webhook Configuration by ID.
Expand All @@ -181,6 +198,10 @@ Class | Method | HTTP request | Description
## Documentation For Models

- [AddFileLabelRequest](docs/AddFileLabelRequest.md)
- [CancelMultipartUpload200Response](docs/CancelMultipartUpload200Response.md)
- [CompleteMultipartUpload200Response](docs/CompleteMultipartUpload200Response.md)
- [CompleteMultipartUploadBody](docs/CompleteMultipartUploadBody.md)
- [CompleteMultipartUploadBodyPartsInner](docs/CompleteMultipartUploadBodyPartsInner.md)
- [CreateConverterConfigParameters](docs/CreateConverterConfigParameters.md)
- [CreateWebhookOptions](docs/CreateWebhookOptions.md)
- [DeleteLiltCreateContent200Response](docs/DeleteLiltCreateContent200Response.md)
Expand All @@ -193,9 +214,15 @@ Class | Method | HTTP request | Description
- [DomainMetadata](docs/DomainMetadata.md)
- [DomainReference](docs/DomainReference.md)
- [Error](docs/Error.md)
- [FileDeleteResponse](docs/FileDeleteResponse.md)
- [FilterConfig](docs/FilterConfig.md)
- [GetLiltCreateContentResponse](docs/GetLiltCreateContentResponse.md)
- [GetPendingUploads200ResponseInner](docs/GetPendingUploads200ResponseInner.md)
- [GetS3UploadParams200Response](docs/GetS3UploadParams200Response.md)
- [InitiateMultipartUpload200Response](docs/InitiateMultipartUpload200Response.md)
- [InitiateMultipartUploadBody](docs/InitiateMultipartUploadBody.md)
- [InitiateMultipartUploadBodyMetadata](docs/InitiateMultipartUploadBodyMetadata.md)
- [InitiateUploadBody](docs/InitiateUploadBody.md)
- [InitiateUploadBodyMetadata](docs/InitiateUploadBodyMetadata.md)
- [Job](docs/Job.md)
- [JobCreateParameters](docs/JobCreateParameters.md)
- [JobDeleteResponse](docs/JobDeleteResponse.md)
Expand All @@ -221,8 +248,14 @@ Class | Method | HTTP request | Description
- [ProjectStats](docs/ProjectStats.md)
- [SDLXLIFFFilter](docs/SDLXLIFFFilter.md)
- [Segment](docs/Segment.md)
- [SegmentCreateParameters](docs/SegmentCreateParameters.md)
- [SegmentDeleteResponse](docs/SegmentDeleteResponse.md)
- [SegmentDoneResponse](docs/SegmentDoneResponse.md)
- [SegmentUpdateParameters](docs/SegmentUpdateParameters.md)
- [SignLiltCreateTermsResponse](docs/SignLiltCreateTermsResponse.md)
- [SignUploadPart200Response](docs/SignUploadPart200Response.md)
- [SourceFile](docs/SourceFile.md)
- [TaggedSegment](docs/TaggedSegment.md)
- [TermbaseExportResponse](docs/TermbaseExportResponse.md)
- [TranslateSegmentBody](docs/TranslateSegmentBody.md)
- [Translation](docs/Translation.md)
Expand Down
11 changes: 0 additions & 11 deletions docs/Annotation.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/ApiRoot.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/AssignmentDetails.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/AssignmentError.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/AutoAssignmentParameters.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/AutoAssignmentResponse.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/AutoAssignmentResponseAssignments.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/AutoAssignmentResponseErrors.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/BadRequest.md

This file was deleted.

30 changes: 30 additions & 0 deletions docs/CancelMultipartUpload200Response.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# CancelMultipartUpload200Response


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **bool** | Cancellation status | [optional]
**message** | **str** | Cancellation message | [optional]

## Example

```python
from lilt.models.cancel_multipart_upload200_response import CancelMultipartUpload200Response

# TODO update the JSON string below
json = "{}"
# create an instance of CancelMultipartUpload200Response from a JSON string
cancel_multipart_upload200_response_instance = CancelMultipartUpload200Response.from_json(json)
# print the JSON string representation of the object
print(CancelMultipartUpload200Response.to_json())

# convert the object into a dict
cancel_multipart_upload200_response_dict = cancel_multipart_upload200_response_instance.to_dict()
# create an instance of CancelMultipartUpload200Response from a dict
cancel_multipart_upload200_response_from_dict = CancelMultipartUpload200Response.from_dict(cancel_multipart_upload200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


19 changes: 0 additions & 19 deletions docs/Comment.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/CommentBody.md

This file was deleted.

Loading