@generaltranslation/api 0.0.1 → 0.0.3

package/dist/index.mjs

@@ -1,4 +1,9 @@
 //#region src/generated/sdk.gen.ts
+/**
+* Create a Project
+*
+* Create a Project in the Organization associated with an Organization API key. The key must have the `org:projects:create` permission. Project keys cannot use this endpoint. Enabling CDN delivery also requires `project:write`.
+*/
 const createProject = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -11,6 +16,11 @@ const createProject = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Upload source files
+*
+* Upload one or more source files to the project. Max 100 files per request.
+*/
 const uploadSourceFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -23,6 +33,11 @@ const uploadSourceFiles = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Upload translated files
+*
+* Upload translated files linked to their source files. Max 100 files per request.
+*/
 const uploadTranslations = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -35,6 +50,11 @@ const uploadTranslations = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Upload Project assets
+*
+* Upload OpenType or TrueType fonts through a Project and make them available to Lottie translation workflows across its Organization. Each font is keyed by a normalized identity derived from its family, weight, and italic style (from the supplied `family` and `style`, or from the font metadata and file name). Re-uploading the same identity overwrites the existing asset, so complete retries after a `500` response are safe.
+*/
 const uploadAssets = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -47,6 +67,11 @@ const uploadAssets = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Submit translation diffs
+*
+* Overwrite translations with user-provided localized content.
+*/
 const submitUserEditDiffs = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -59,6 +84,13 @@ const submitUserEditDiffs = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Check if context generation is needed
+*
+* Check whether the Project needs translation context generated. This deprecated endpoint is retained for backward compatibility and is no longer called by current clients.
+*
+* @deprecated
+*/
 const shouldGenerateProjectContext = (options) => options.client.get({
 	security: [{
 		scheme: "bearer",
@@ -67,6 +99,11 @@ const shouldGenerateProjectContext = (options) => options.client.get({
 	url: "/v2/project/setup/should-generate",
 	...options
 });
+/**
+* Generate translation context
+*
+* Generate glossaries and translation instructions for the project.
+*/
 const generateProjectContext = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -79,6 +116,13 @@ const generateProjectContext = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Get context generation job status
+*
+* Track a context generation job. This deprecated endpoint is retained for backward compatibility; new integrations should use `POST /v2/project/jobs/info`.
+*
+* @deprecated
+*/
 const getProjectContextGenerationStatus = (options) => options.client.get({
 	security: [{
 		scheme: "bearer",
@@ -87,6 +131,11 @@ const getProjectContextGenerationStatus = (options) => options.client.get({
 	url: "/v2/project/setup/status/{jobId}",
 	...options
 });
+/**
+* Queue files for translation
+*
+* Enqueue uploaded source files for background translation. Max 100 files per request. The response shape depends on the requested `gt-api-version`.
+*/
 const enqueueFileTranslations = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -99,6 +148,11 @@ const enqueueFileTranslations = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Publish or unpublish files
+*
+* Publish or unpublish translated files to the CDN. Requires CDN to be enabled.
+*/
 const publishFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -111,6 +165,13 @@ const publishFiles = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Download a single file
+*
+* Download a single source or translated file. This deprecated endpoint is retained for backward compatibility; new integrations should use `POST /v2/project/files/download`.
+*
+* @deprecated
+*/
 const downloadFile = (options) => options.client.get({
 	security: [{
 		scheme: "bearer",
@@ -119,6 +180,11 @@ const downloadFile = (options) => options.client.get({
 	url: "/v2/project/files/download/{fileId}",
 	...options
 });
+/**
+* Download multiple files
+*
+* Download up to 100 source or translated files in one request.
+*/
 const downloadFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -131,6 +197,11 @@ const downloadFiles = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Get branch information
+*
+* Return the Project's default branch and any branches requested by name.
+*/
 const getBranchInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -143,6 +214,11 @@ const getBranchInfo = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Create a branch
+*
+* Create a new branch, or rename and confirm the default branch.
+*/
 const createBranch = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -155,6 +231,11 @@ const createBranch = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Create or update a tag
+*
+* Create or upsert a tag that points at a set of file versions.
+*/
 const createTag = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -167,6 +248,11 @@ const createTag = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Get Project information
+*
+* Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting.
+*/
 const getProjectInfo = (options) => options.client.get({
 	security: [{
 		scheme: "bearer",
@@ -175,6 +261,11 @@ const getProjectInfo = (options) => options.client.get({
 	url: "/v2/project/info/{projectId}",
 	...options
 });
+/**
+* Update Project information
+*
+* Update the Project's default locale or CDN delivery setting.
+*/
 const updateProjectInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -187,6 +278,11 @@ const updateProjectInfo = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Get translation job status
+*
+* Return normalized status information for one or more queued translation or context generation jobs.
+*/
 const getTranslationJobInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -199,6 +295,11 @@ const getTranslationJobInfo = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Translate content at runtime
+*
+* Translate one or more strings or structured content entries with caching and memoization. Development API keys are accepted for this endpoint.
+*/
 const translate = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -211,6 +312,11 @@ const translate = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Get file metadata
+*
+* Get detailed metadata for specific source and translated files.
+*/
 const getFileInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -223,6 +329,11 @@ const getFileInfo = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Get translation status for a file
+*
+* Return translation progress and availability by locale for one source file, along with its source metadata.
+*/
 const getTranslationStatus = (options) => options.client.get({
 	security: [{
 		scheme: "bearer",
@@ -231,6 +342,11 @@ const getTranslationStatus = (options) => options.client.get({
 	url: "/v2/project/translations/files/status/{fileId}",
 	...options
 });
+/**
+* Move or rename files
+*
+* Clone source files and their translations under new file IDs.
+*/
 const processFileMoves = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -243,6 +359,11 @@ const processFileMoves = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Find orphaned files
+*
+* Return files on a branch that are not present in the provided file ID list.
+*/
 const getOrphanedFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
@@ -255,6 +376,11 @@ const getOrphanedFiles = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Create a CLI wizard session
+*
+* Create a temporary session for CLI browser authentication.
+*/
 const createCliWizardSession = (options) => options.client.post({
 	url: "/cli/wizard/session",
 	...options,
@@ -263,10 +389,20 @@ const createCliWizardSession = (options) => options.client.post({
 		...options.headers
 	}
 });
+/**
+* Delete a CLI wizard session
+*
+* Delete a completed or abandoned CLI wizard session.
+*/
 const deleteCliWizardSession = (options) => options.client.delete({
 	url: "/cli/wizard/{sessionId}",
 	...options
 });
+/**
+* Get a CLI wizard session
+*
+* Get credentials for a completed CLI wizard session or its current waiting status.
+*/
 const getCliWizardSession = (options) => options.client.get({
 	url: "/cli/wizard/{sessionId}",
 	...options