Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
hadomskyi committed Jan 5, 2025
0 parents commit 73b0d9b
Show file tree
Hide file tree
Showing 94 changed files with 17,444 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
#
# This file is auto-generated by OpenAPI Generator (https://openapi-generator.tech)

name: Java CI with Maven

on:
push:
branches: [ main, master ]
pull_request:
branches: [ main, master ]

jobs:
build:
name: Build Lilt Connector Plugin API
runs-on: ubuntu-latest
strategy:
matrix:
java: [ '8' ]
steps:
- uses: actions/checkout@v4
- name: Set up JDK
uses: actions/setup-java@v4
with:
java-version: ${{ matrix.java }}
distribution: 'temurin'
cache: maven
- name: Build with Maven
run: mvn -B package --no-transfer-progress --file pom.xml
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
*.class

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.ear

# exclude jar for gradle wrapper
!gradle/wrapper/*.jar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

# build files
**/target
target
.gradle
build
23 changes: 23 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
92 changes: 92 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
.github/workflows/maven.yml
.gitignore
.openapi-generator-ignore
.travis.yml
README.md
api/openapi.yaml
build.gradle
build.sbt
docs/CreditTransactionsApi.md
docs/ErrorResponse.md
docs/JobResponse.md
docs/JobsApi.md
docs/JobsResponse.md
docs/NewJobOptions.md
docs/NewOrganizationOptions.md
docs/OrganizationApi.md
docs/OrganizationResponse.md
docs/PreviewTranslationResponseInner.md
docs/RegistrationApi.md
docs/ServicesApiCreditTransactionCreateCreditTransactionRequest.md
docs/SettingsApi.md
docs/SettingsResponse.md
docs/TranslationResponse.md
docs/TranslationsApi.md
docs/TranslationsResponse.md
docs/UpdateDeliveryOptions.md
docs/UpdateJobOptions.md
git_push.sh
gradle.properties
gradle/wrapper/gradle-wrapper.jar
gradle/wrapper/gradle-wrapper.properties
gradlew
gradlew.bat
pom.xml
settings.gradle
src/main/AndroidManifest.xml
src/main/java/LiltConnectorSDK/ApiCallback.java
src/main/java/LiltConnectorSDK/ApiClient.java
src/main/java/LiltConnectorSDK/ApiException.java
src/main/java/LiltConnectorSDK/ApiResponse.java
src/main/java/LiltConnectorSDK/Configuration.java
src/main/java/LiltConnectorSDK/GzipRequestInterceptor.java
src/main/java/LiltConnectorSDK/JSON.java
src/main/java/LiltConnectorSDK/Pair.java
src/main/java/LiltConnectorSDK/ProgressRequestBody.java
src/main/java/LiltConnectorSDK/ProgressResponseBody.java
src/main/java/LiltConnectorSDK/ServerConfiguration.java
src/main/java/LiltConnectorSDK/ServerVariable.java
src/main/java/LiltConnectorSDK/StringUtil.java
src/main/java/LiltConnectorSDK/auth/ApiKeyAuth.java
src/main/java/LiltConnectorSDK/auth/Authentication.java
src/main/java/LiltConnectorSDK/auth/HttpBasicAuth.java
src/main/java/LiltConnectorSDK/auth/HttpBearerAuth.java
src/main/java/org/openapitools/client/api/CreditTransactionsApi.java
src/main/java/org/openapitools/client/api/JobsApi.java
src/main/java/org/openapitools/client/api/OrganizationApi.java
src/main/java/org/openapitools/client/api/RegistrationApi.java
src/main/java/org/openapitools/client/api/SettingsApi.java
src/main/java/org/openapitools/client/api/TranslationsApi.java
src/main/java/org/openapitools/client/model/AbstractOpenApiSchema.java
src/main/java/org/openapitools/client/model/ErrorResponse.java
src/main/java/org/openapitools/client/model/JobResponse.java
src/main/java/org/openapitools/client/model/JobsResponse.java
src/main/java/org/openapitools/client/model/NewJobOptions.java
src/main/java/org/openapitools/client/model/NewOrganizationOptions.java
src/main/java/org/openapitools/client/model/OrganizationResponse.java
src/main/java/org/openapitools/client/model/PreviewTranslationResponseInner.java
src/main/java/org/openapitools/client/model/ServicesApiCreditTransactionCreateCreditTransactionRequest.java
src/main/java/org/openapitools/client/model/SettingsResponse.java
src/main/java/org/openapitools/client/model/TranslationResponse.java
src/main/java/org/openapitools/client/model/TranslationsResponse.java
src/main/java/org/openapitools/client/model/UpdateDeliveryOptions.java
src/main/java/org/openapitools/client/model/UpdateJobOptions.java
src/test/java/org/openapitools/client/api/CreditTransactionsApiTest.java
src/test/java/org/openapitools/client/api/JobsApiTest.java
src/test/java/org/openapitools/client/api/OrganizationApiTest.java
src/test/java/org/openapitools/client/api/RegistrationApiTest.java
src/test/java/org/openapitools/client/api/SettingsApiTest.java
src/test/java/org/openapitools/client/api/TranslationsApiTest.java
src/test/java/org/openapitools/client/model/ErrorResponseTest.java
src/test/java/org/openapitools/client/model/JobResponseTest.java
src/test/java/org/openapitools/client/model/JobsResponseTest.java
src/test/java/org/openapitools/client/model/NewJobOptionsTest.java
src/test/java/org/openapitools/client/model/NewOrganizationOptionsTest.java
src/test/java/org/openapitools/client/model/OrganizationResponseTest.java
src/test/java/org/openapitools/client/model/PreviewTranslationResponseInnerTest.java
src/test/java/org/openapitools/client/model/ServicesApiCreditTransactionCreateCreditTransactionRequestTest.java
src/test/java/org/openapitools/client/model/SettingsResponseTest.java
src/test/java/org/openapitools/client/model/TranslationResponseTest.java
src/test/java/org/openapitools/client/model/TranslationsResponseTest.java
src/test/java/org/openapitools/client/model/UpdateDeliveryOptionsTest.java
src/test/java/org/openapitools/client/model/UpdateJobOptionsTest.java
1 change: 1 addition & 0 deletions .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
7.6.0-SNAPSHOT
22 changes: 22 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#
# Generated by OpenAPI Generator: https://openapi-generator.tech
#
# Ref: https://docs.travis-ci.com/user/languages/java/
#
language: java
jdk:
- openjdk12
- openjdk11
- openjdk10
- openjdk9
- openjdk8
before_install:
# ensure gradlew has proper permission
- chmod a+x ./gradlew
script:
# test using maven
#- mvn test
# test using gradle
- gradle test
# test using sbt
# - sbt test
183 changes: 183 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
# openapi-java-client

Lilt Connector Plugin API
- API version: 1.0
- Build date: 2025-01-05T09:10:14.232589379Z[Etc/UTC]
- Generator version: 7.6.0-SNAPSHOT

This document describes the Plugin API for Lilt's Connector platform. The
Plugin API is intented to be used by developers who wish to build
integrations into their desired systems. The purpose of this API is to
enable content transfer and status monitoring for localization projects.

- Read more about the concepts and workflows in the
[user guide](/docs/api/v1.0).
- Test the API interactively via [Swagger UI](/api/v1.0/ui).



*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*


## Requirements

Building the API client library requires:
1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

## Installation

To install the API client library to your local Maven repository, simply execute:

```shell
mvn clean install
```

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

```shell
mvn clean deploy
```

Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.

### Maven users

Add this dependency to your project's POM:

```xml
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-java-client</artifactId>
<version>1.0</version>
<scope>compile</scope>
</dependency>
```

### Gradle users

Add this dependency to your project's build file:

```groovy
repositories {
mavenCentral() // Needed if the 'openapi-java-client' jar has been published to maven central.
mavenLocal() // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
}
dependencies {
implementation "org.openapitools:openapi-java-client:1.0"
}
```

### Others

At first generate the JAR by executing:

```shell
mvn clean package
```

Then manually install the following JARs:

* `target/openapi-java-client-1.0.jar`
* `target/lib/*.jar`

## Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:

```java

// Import classes:
import LiltConnectorSDK.ApiClient;
import LiltConnectorSDK.ApiException;
import LiltConnectorSDK.Configuration;
import LiltConnectorSDK.models.*;
import org.openapitools.client.api.CreditTransactionsApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://connectors-admin.lilt.com/api/v1.0");

CreditTransactionsApi apiInstance = new CreditTransactionsApi(defaultClient);
ServicesApiCreditTransactionCreateCreditTransactionRequest servicesApiCreditTransactionCreateCreditTransactionRequest = new ServicesApiCreditTransactionCreateCreditTransactionRequest(); // ServicesApiCreditTransactionCreateCreditTransactionRequest |
try {
apiInstance.servicesApiCreditTransactionCreateCreditTransaction(servicesApiCreditTransactionCreateCreditTransactionRequest);
} catch (ApiException e) {
System.err.println("Exception when calling CreditTransactionsApi#servicesApiCreditTransactionCreateCreditTransaction");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

```

## Documentation for API Endpoints

All URIs are relative to *https://connectors-admin.lilt.com/api/v1.0*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CreditTransactionsApi* | [**servicesApiCreditTransactionCreateCreditTransaction**](docs/CreditTransactionsApi.md#servicesApiCreditTransactionCreateCreditTransaction) | **POST** /credit-transaction | Create a credit transaction. Request is expected to contain credits information encoded in jwt_token payload. Request encoded should have info for instant_translation_credits_change value, verified_translation_credits_change value, source_metadata which contains any identifying information to attach to the transaction, email for the user starting the transaction, and optionally lilt_token for the connector configuration.
*JobsApi* | [**servicesApiJobsAddFile**](docs/JobsApi.md#servicesApiJobsAddFile) | **POST** /jobs/{id}/files | Add a file to a Job.
*JobsApi* | [**servicesApiJobsCreateJob**](docs/JobsApi.md#servicesApiJobsCreateJob) | **POST** /jobs | Create a Connector Job.
*JobsApi* | [**servicesApiJobsDeleteJobById**](docs/JobsApi.md#servicesApiJobsDeleteJobById) | **DELETE** /jobs/{id} | Delete a Connector Job.
*JobsApi* | [**servicesApiJobsGetJobById**](docs/JobsApi.md#servicesApiJobsGetJobById) | **GET** /jobs/{id} | Retrieve a Connector Job.
*JobsApi* | [**servicesApiJobsGetJobTranslations**](docs/JobsApi.md#servicesApiJobsGetJobTranslations) | **GET** /jobs/translations | Retrieve a list of Translations with their Job information.
*JobsApi* | [**servicesApiJobsGetJobs**](docs/JobsApi.md#servicesApiJobsGetJobs) | **GET** /jobs | Retrieve a list of Connector Jobs.
*JobsApi* | [**servicesApiJobsStartJob**](docs/JobsApi.md#servicesApiJobsStartJob) | **POST** /jobs/{id}/start | Start a Job.
*JobsApi* | [**servicesApiJobsSyncJob**](docs/JobsApi.md#servicesApiJobsSyncJob) | **POST** /jobs/{id}/sync | Start a Sync.
*JobsApi* | [**servicesApiJobsUpdateJob**](docs/JobsApi.md#servicesApiJobsUpdateJob) | **PUT** /jobs/{id} | Update a Connector Job.
*OrganizationApi* | [**servicesApiOrganizationGetOrganizationRecord**](docs/OrganizationApi.md#servicesApiOrganizationGetOrganizationRecord) | **GET** /organization | Get information about the organization based on lilt_token
*RegistrationApi* | [**servicesApiRegistrationRegisterCreditsBasedOrganization**](docs/RegistrationApi.md#servicesApiRegistrationRegisterCreditsBasedOrganization) | **POST** /register | Register a new Connectors Organization
*SettingsApi* | [**servicesApiSettingsGetSettings**](docs/SettingsApi.md#servicesApiSettingsGetSettings) | **GET** /settings | Retrieve the settings.
*SettingsApi* | [**servicesApiSettingsUpdateSettings**](docs/SettingsApi.md#servicesApiSettingsUpdateSettings) | **PUT** /settings | Update the settings.
*TranslationsApi* | [**servicesApiDeliveriesCompleteDelivery**](docs/TranslationsApi.md#servicesApiDeliveriesCompleteDelivery) | **POST** /translations/{id}/complete | Complete a Translation.
*TranslationsApi* | [**servicesApiDeliveriesDownloadDelivery**](docs/TranslationsApi.md#servicesApiDeliveriesDownloadDelivery) | **GET** /translations/{id}/download | Download a Translation.
*TranslationsApi* | [**servicesApiDeliveriesDownloadDeliverySource**](docs/TranslationsApi.md#servicesApiDeliveriesDownloadDeliverySource) | **GET** /translations/{id}/source | Download a Translation Source.
*TranslationsApi* | [**servicesApiDeliveriesGetDeliveriesByJobId**](docs/TranslationsApi.md#servicesApiDeliveriesGetDeliveriesByJobId) | **GET** /translations | Retrieve a list of Translations.
*TranslationsApi* | [**servicesApiDeliveriesGetDeliveryById**](docs/TranslationsApi.md#servicesApiDeliveriesGetDeliveryById) | **GET** /translations/{id} | Retrieve a Translation.
*TranslationsApi* | [**servicesApiDeliveriesPreviewDelivery**](docs/TranslationsApi.md#servicesApiDeliveriesPreviewDelivery) | **GET** /translations/{id}/preview | Get a Translation&#39;s source to target mapping.
*TranslationsApi* | [**servicesApiDeliveriesUpdateDelivery**](docs/TranslationsApi.md#servicesApiDeliveriesUpdateDelivery) | **PUT** /translations/{id} | Update a Translation.


## Documentation for Models

- [ErrorResponse](docs/ErrorResponse.md)
- [JobResponse](docs/JobResponse.md)
- [JobsResponse](docs/JobsResponse.md)
- [NewJobOptions](docs/NewJobOptions.md)
- [NewOrganizationOptions](docs/NewOrganizationOptions.md)
- [OrganizationResponse](docs/OrganizationResponse.md)
- [PreviewTranslationResponseInner](docs/PreviewTranslationResponseInner.md)
- [ServicesApiCreditTransactionCreateCreditTransactionRequest](docs/ServicesApiCreditTransactionCreateCreditTransactionRequest.md)
- [SettingsResponse](docs/SettingsResponse.md)
- [TranslationResponse](docs/TranslationResponse.md)
- [TranslationsResponse](docs/TranslationsResponse.md)
- [UpdateDeliveryOptions](docs/UpdateDeliveryOptions.md)
- [UpdateJobOptions](docs/UpdateJobOptions.md)


<a id="documentation-for-authorization"></a>
## Documentation for Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: HTTP Bearer Token authentication


## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

## Author



Loading

0 comments on commit 73b0d9b

Please sign in to comment.