Skip to content

Commit

Permalink
Regenerates API Bindings
Browse files Browse the repository at this point in the history
  • Loading branch information
lilt-infra-service authored and github-actions[bot] committed Nov 11, 2024
1 parent 0542217 commit 0ea482f
Show file tree
Hide file tree
Showing 71 changed files with 642 additions and 212 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,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: v3.0
- Package version: 0.6.3
- Package version: v3.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation
Expand Down Expand Up @@ -135,7 +135,11 @@ BasicAuth.password = 'YOUR PASSWORD'

var api = new LiltNode.CreateApi()
var contentId = 56; // {Number} The content ID.
api.deleteLiltCreateContent(contentId).then(function(data) {
var opts = {
'xIsAutomated': true, // {Boolean} A boolean value that indicates whether the request is automated or not.
'xIsExpectedError': true // {Boolean} A boolean value that indicates whether the request is expected to return an error or not.
};
api.deleteLiltCreateContent(contentId, opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
Expand Down Expand Up @@ -171,7 +175,7 @@ Class | Method | HTTP request | Description
*LiltNode.JobsApi* | [**createJob**](docs/JobsApi.md#createJob) | **POST** /v2/jobs | Create a Job
*LiltNode.JobsApi* | [**deleteJob**](docs/JobsApi.md#deleteJob) | **DELETE** /v2/jobs/{jobId} | Delete a Job
*LiltNode.JobsApi* | [**deliverJob**](docs/JobsApi.md#deliverJob) | **POST** /v2/jobs/{jobId}/deliver | Deliver a Job
*LiltNode.JobsApi* | [**downloadJob**](docs/JobsApi.md#downloadJob) | **GET** /v2/jobs/{jobId}/downlod | Download a Job
*LiltNode.JobsApi* | [**downloadJob**](docs/JobsApi.md#downloadJob) | **GET** /v2/jobs/{jobId}/download | Download a Job
*LiltNode.JobsApi* | [**exportJob**](docs/JobsApi.md#exportJob) | **GET** /v2/jobs/{jobId}/export | Export a Job
*LiltNode.JobsApi* | [**getJob**](docs/JobsApi.md#getJob) | **GET** /v2/jobs/{jobId} | Retrieve a Job
*LiltNode.JobsApi* | [**getJobLeverageStats**](docs/JobsApi.md#getJobLeverageStats) | **POST** /v2/jobs/{jobId}/stats | Retrieve Job Leverage Stats
Expand Down Expand Up @@ -222,6 +226,7 @@ Class | Method | HTTP request | Description
- [LiltNode.LanguagesResponse](docs/LanguagesResponse.md)
- [LiltNode.LiltCreateContent](docs/LiltCreateContent.md)
- [LiltNode.LiltCreateContentPreferences](docs/LiltCreateContentPreferences.md)
- [LiltNode.LiltCreateContentRequest](docs/LiltCreateContentRequest.md)
- [LiltNode.LiltCreateContentTemplateParams](docs/LiltCreateContentTemplateParams.md)
- [LiltNode.Memory](docs/Memory.md)
- [LiltNode.MemoryCreateParameters](docs/MemoryCreateParameters.md)
Expand Down
66 changes: 46 additions & 20 deletions docs/CreateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Method | HTTP request | Description

## deleteLiltCreateContent

> InlineResponse200 deleteLiltCreateContent(contentId)
> InlineResponse200 deleteLiltCreateContent(contentId, opts)
Delete Lilt Create content

Expand All @@ -41,7 +41,11 @@ BasicAuth.password = 'YOUR PASSWORD';

let apiInstance = new LiltNode.CreateApi();
let contentId = 56; // Number | The content ID.
apiInstance.deleteLiltCreateContent(contentId).then((data) => {
let opts = {
'xIsAutomated': true, // Boolean | A boolean value that indicates whether the request is automated or not.
'xIsExpectedError': true // Boolean | A boolean value that indicates whether the request is expected to return an error or not.
};
apiInstance.deleteLiltCreateContent(contentId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -55,6 +59,8 @@ apiInstance.deleteLiltCreateContent(contentId).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contentId** | **Number**| The content ID. |
**xIsAutomated** | **Boolean**| A boolean value that indicates whether the request is automated or not. | [optional]
**xIsExpectedError** | **Boolean**| A boolean value that indicates whether the request is expected to return an error or not. | [optional]

### Return type

Expand All @@ -67,12 +73,12 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain


## generateLiltCreateContent

> generateLiltCreateContent(templateParams)
> generateLiltCreateContent(templateParams, opts)
Generate new Lilt Create content

Expand All @@ -94,8 +100,12 @@ BasicAuth.username = 'YOUR USERNAME';
BasicAuth.password = 'YOUR PASSWORD';

let apiInstance = new LiltNode.CreateApi();
let templateParams = new LiltNode.LiltCreateContent(); // LiltCreateContent | Input parameters that determine what content will be generated.
apiInstance.generateLiltCreateContent(templateParams).then(() => {
let templateParams = new LiltNode.LiltCreateContentRequest(); // LiltCreateContentRequest | Input parameters that determine what content will be generated.
let opts = {
'xIsAutomated': true, // Boolean | A boolean value that indicates whether the request is automated or not.
'xIsExpectedError': true // Boolean | A boolean value that indicates whether the request is expected to return an error or not.
};
apiInstance.generateLiltCreateContent(templateParams, opts).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
Expand All @@ -108,7 +118,9 @@ apiInstance.generateLiltCreateContent(templateParams).then(() => {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**templateParams** | [**LiltCreateContent**](LiltCreateContent.md)| Input parameters that determine what content will be generated. |
**templateParams** | [**LiltCreateContentRequest**](LiltCreateContentRequest.md)| Input parameters that determine what content will be generated. |
**xIsAutomated** | **Boolean**| A boolean value that indicates whether the request is automated or not. | [optional]
**xIsExpectedError** | **Boolean**| A boolean value that indicates whether the request is expected to return an error or not. | [optional]

### Return type

Expand All @@ -121,7 +133,7 @@ null (empty response body)
### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined
- **Accept**: application/octet-stream, text/plain, application/json


## getLiltCreateById
Expand Down Expand Up @@ -175,12 +187,12 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain


## getLiltCreateContent

> GetLiltCreateContentResponse getLiltCreateContent()
> GetLiltCreateContentResponse getLiltCreateContent(opts)
Get Lilt Create content

Expand All @@ -202,7 +214,11 @@ BasicAuth.username = 'YOUR USERNAME';
BasicAuth.password = 'YOUR PASSWORD';

let apiInstance = new LiltNode.CreateApi();
apiInstance.getLiltCreateContent().then((data) => {
let opts = {
'xIsAutomated': true, // Boolean | A boolean value that indicates whether the request is automated or not.
'xIsExpectedError': true // Boolean | A boolean value that indicates whether the request is expected to return an error or not.
};
apiInstance.getLiltCreateContent(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -212,7 +228,11 @@ apiInstance.getLiltCreateContent().then((data) => {

### Parameters

This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xIsAutomated** | **Boolean**| A boolean value that indicates whether the request is automated or not. | [optional]
**xIsExpectedError** | **Boolean**| A boolean value that indicates whether the request is expected to return an error or not. | [optional]

### Return type

Expand All @@ -225,7 +245,7 @@ This endpoint does not need any parameter.
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain


## getLiltCreatePreferences
Expand Down Expand Up @@ -275,7 +295,7 @@ null (empty response body)
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined
- **Accept**: application/octet-stream, text/plain, application/json


## regenerateLiltCreateContent
Expand Down Expand Up @@ -329,12 +349,12 @@ null (empty response body)
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined
- **Accept**: application/octet-stream, text/plain, application/json


## signLiltCreateTerms

> SignLiltCreateTermsResponse signLiltCreateTerms(signedAgreement)
> SignLiltCreateTermsResponse signLiltCreateTerms(signedAgreement, opts)
Sign the Lilt Create terms and conditions

Expand All @@ -357,7 +377,11 @@ BasicAuth.password = 'YOUR PASSWORD';

let apiInstance = new LiltNode.CreateApi();
let signedAgreement = new LiltNode.CreateConverterConfigParameters(); // CreateConverterConfigParameters |
apiInstance.signLiltCreateTerms(signedAgreement).then((data) => {
let opts = {
'xIsAutomated': true, // Boolean | A boolean value that indicates whether the request is automated or not.
'xIsExpectedError': true // Boolean | A boolean value that indicates whether the request is expected to return an error or not.
};
apiInstance.signLiltCreateTerms(signedAgreement, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -371,6 +395,8 @@ apiInstance.signLiltCreateTerms(signedAgreement).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**signedAgreement** | [**CreateConverterConfigParameters**](CreateConverterConfigParameters.md)| |
**xIsAutomated** | **Boolean**| A boolean value that indicates whether the request is automated or not. | [optional]
**xIsExpectedError** | **Boolean**| A boolean value that indicates whether the request is expected to return an error or not. | [optional]

### Return type

Expand All @@ -383,7 +409,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain


## updateLiltCreateContent
Expand Down Expand Up @@ -441,7 +467,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain


## updateLiltCreatePreferences
Expand Down Expand Up @@ -497,5 +523,5 @@ null (empty response body)
### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined
- **Accept**: application/octet-stream, text/plain, application/json

4 changes: 2 additions & 2 deletions docs/DocumentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream
- **Accept**: application/octet-stream, text/plain,


## uploadDocument
Expand Down Expand Up @@ -134,5 +134,5 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: application/octet-stream
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain

2 changes: 1 addition & 1 deletion docs/Error.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | [**Object**](.md) | A human-readable message describing the error. | [optional]
**message** | **String** | A human-readable message describing the error. | [optional]


26 changes: 18 additions & 8 deletions docs/FilesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ null (empty response body)
### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined
- **Accept**: application/octet-stream, text/plain, application/json


## deleteFile

> FileDeleteResponse deleteFile(id)
> FileDeleteResponse deleteFile(id, opts)
Delete a File

Expand All @@ -94,7 +94,11 @@ BasicAuth.password = 'YOUR PASSWORD';

let apiInstance = new LiltNode.FilesApi();
let id = 56; // Number | A unique File identifier.
apiInstance.deleteFile(id).then((data) => {
let opts = {
'xIsAutomated': true, // Boolean | A boolean value that indicates whether the request is automated or not.
'xIsExpectedError': true // Boolean | A boolean value that indicates whether the request is expected to return an error or not.
};
apiInstance.deleteFile(id, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -108,6 +112,8 @@ apiInstance.deleteFile(id).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **Number**| A unique File identifier. |
**xIsAutomated** | **Boolean**| A boolean value that indicates whether the request is automated or not. | [optional]
**xIsExpectedError** | **Boolean**| A boolean value that indicates whether the request is expected to return an error or not. | [optional]

### Return type

Expand All @@ -120,7 +126,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain


## download
Expand Down Expand Up @@ -174,7 +180,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream
- **Accept**: application/octet-stream, text/plain, application/json


## getFiles
Expand Down Expand Up @@ -232,7 +238,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain


## removeLabel
Expand Down Expand Up @@ -288,7 +294,7 @@ null (empty response body)
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined
- **Accept**: application/octet-stream, text/plain, application/json


## uploadFile
Expand Down Expand Up @@ -318,6 +324,8 @@ let apiInstance = new LiltNode.FilesApi();
let name = "name_example"; // String | A file name.
let body = "/path/to/file"; // File | The file contents to be uploaded. The entire POST body will be treated as the file.
let opts = {
'xIsAutomated': true, // Boolean | A boolean value that indicates whether the request is automated or not.
'xIsExpectedError': true, // Boolean | A boolean value that indicates whether the request is expected to return an error or not.
'fileHash': "fileHash_example", // String | 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.
'langId': true, // Boolean | Flag indicating whether to perform language detection on the uploaded file. Default is false.
'projectId': 56, // Number | The project to associate the uploaded file with.
Expand All @@ -339,6 +347,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| A file name. |
**body** | **File**| The file contents to be uploaded. The entire POST body will be treated as the file. |
**xIsAutomated** | **Boolean**| A boolean value that indicates whether the request is automated or not. | [optional]
**xIsExpectedError** | **Boolean**| A boolean value that indicates whether the request is expected to return an error or not. | [optional]
**fileHash** | **String**| 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]
**langId** | **Boolean**| Flag indicating whether to perform language detection on the uploaded file. Default is false. | [optional]
**projectId** | **Number**| The project to associate the uploaded file with. | [optional]
Expand All @@ -356,5 +366,5 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: application/octet-stream
- **Accept**: application/json
- **Accept**: application/json, application/octet-stream, text/plain

Loading

0 comments on commit 0ea482f

Please sign in to comment.