lilt-node v0.6.3

lilt-node

LiltNode - JavaScript client for lilt-node 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. 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.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v2.0
• Package version: 0.5.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://lilt.com/docs/api

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install lilt-node --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your lilt-node from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/lilt/lilt-node then install it via:

    npm install lilt/lilt-node --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var LiltNode = require('lilt-node');

var defaultClient = LiltNode.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['key'] = "Token"
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new LiltNode.CommentsApi()
var documentId = 56; // {Number} A unique document identifier.
var segmentId = 56; // {Number} A unique segment identifier.
var body = new LiltNode.CommentBody(); // {CommentBody} The comment being created
api.createComment(documentId, segmentId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://lilt.com/2

Documentation for Models

• LiltNode.AddFileLabelRequest
• LiltNode.Annotation
• LiltNode.ApiRoot
• LiltNode.AssignmentDetails
• LiltNode.AssignmentError
• LiltNode.AutoAssignmentParameters
• LiltNode.AutoAssignmentResponse
• LiltNode.BadRequest
• LiltNode.Comment
• LiltNode.CommentBody
• LiltNode.CommentDeleteResponse
• LiltNode.Connector
• LiltNode.ConnectorArguments
• LiltNode.ConnectorDeleteResponse
• LiltNode.ConnectorJob
• LiltNode.ConverterConfigUpdateResponse
• LiltNode.CreateConverterConfigParameters
• LiltNode.DocumentAssignmentParameters
• LiltNode.DocumentAssignmentResponse
• LiltNode.DocumentComments
• LiltNode.DocumentDeleteResponse
• LiltNode.DocumentDoneUpdateParameters
• LiltNode.DocumentDoneUpdateParameters1
• LiltNode.DocumentDoneUpdateParameters2
• LiltNode.DocumentParameters
• LiltNode.DocumentPretranslateParameters
• LiltNode.DocumentPretranslateResponse
• LiltNode.DocumentPretranslating
• LiltNode.DocumentPretranslatingStatus
• LiltNode.DocumentQuote
• LiltNode.DocumentWithSegments
• LiltNode.DocumentWithoutSegments
• LiltNode.DocumentWithoutSegmentsStatus
• LiltNode.DocumentWorkflow
• LiltNode.EditFilterMappingParameters
• LiltNode.Error
• LiltNode.FileDeleteResponse
• LiltNode.Job
• LiltNode.JobCreateParameters
• LiltNode.JobDeleteResponse
• LiltNode.JobLeverageStats
• LiltNode.JobProject
• LiltNode.JobStats
• LiltNode.JobUpdateParameters
• LiltNode.LanguagePair
• LiltNode.LanguagesResponse
• LiltNode.LexiconEntry
• LiltNode.LexiconEntryExamples
• LiltNode.LexiconEntrySourceSpan
• LiltNode.LexiconEntryTargetSpan
• LiltNode.LexiconEntryTranslations
• LiltNode.LexiconUpdateParameters
• LiltNode.LexiconUpdateResponse
• LiltNode.MatchBand
• LiltNode.Memory
• LiltNode.MemoryCreateParameters
• LiltNode.MemoryDeleteResponse
• LiltNode.MemoryImportResponse
• LiltNode.MemoryInsertResponse
• LiltNode.MemoryUpdateParameters
• LiltNode.MemoryUpdateResponse
• LiltNode.NextWorkflowTask
• LiltNode.Project
• LiltNode.ProjectCreateParameters
• LiltNode.ProjectDeleteResponse
• LiltNode.ProjectQuote
• LiltNode.ProjectStats
• LiltNode.ProjectStatus
• LiltNode.ProjectUpdateResponse
• LiltNode.ProjectsToDeliver
• LiltNode.ProjectsToUpdate
• LiltNode.QARuleMatches
• LiltNode.QARuleMatchesContext
• LiltNode.QARuleMatchesCustomRules
• LiltNode.QARuleMatchesMatches
• LiltNode.QARuleMatchesReplacements
• LiltNode.QARuleMatchesRule
• LiltNode.QARuleMatchesRuleCategory
• LiltNode.QARuleMatchesRuleUrls
• LiltNode.ResourceStatus
• LiltNode.ReviewCompletionTypeError
• LiltNode.Segment
• LiltNode.SegmentCreateParameters
• LiltNode.SegmentDeleteResponse
• LiltNode.SegmentDoneResponse
• LiltNode.SegmentUpdateParameters
• LiltNode.SegmentWithComments
• LiltNode.SetDocumentStageRequest
• LiltNode.Setting
• LiltNode.SettingUpsertBody
• LiltNode.SettingUpsertResponse
• LiltNode.SourceFile
• LiltNode.TaggedSegment
• LiltNode.TranslateCompletionTypeError
• LiltNode.TranslateRegisterResponse
• LiltNode.TranslateSegmentBody
• LiltNode.TranslateSegmentBody1
• LiltNode.Translation
• LiltNode.TranslationInfo
• LiltNode.TranslationList
• LiltNode.TranslationMemoryEntry
• LiltNode.WorkflowStage
• LiltNode.WorkflowStageAssignment
• LiltNode.WorkflowStageTemplate
• LiltNode.WorkflowTask
• LiltNode.WorkflowTemplate

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: key
• Location: URL query string

BasicAuth

• Type: HTTP basic authentication