@generaltranslation/api 0.2.0 → 0.2.1

package/dist/index.mjs

@@ -2,14 +2,17 @@
 /**
 * 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`.
+* Create a Project in the Organization selected by the orgId path parameter. Requires org:projects:create. Enabling CDN delivery also requires project:write.
 */
 const createProject = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/projects",
+	url: "/v2/orgs/{orgId}/projects",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -17,16 +20,19 @@ const createProject = (options) => options.client.post({
 	}
 });
 /**
-* Upload source files
+* Create a Project API Key
 *
-* Upload one or more source files to the project. Max 100 files per request.
+* Create an API key for the selected Project. Requires project:api_keys:write and delegates only Project permissions held by the request identity.
 */
-const uploadSourceFiles = (options) => options.client.post({
+const createProjectApiKey = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/files/upload-files",
+	url: "/v2/projects/{projectId}/api-keys",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -42,6 +48,9 @@ const uploadTranslations = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
 	url: "/v2/project/files/upload-translations",
 	...options,
@@ -51,33 +60,35 @@ const uploadTranslations = (options) => options.client.post({
 	}
 });
 /**
-* Upload Project assets
+* Get Project information
 *
-* 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.
+* Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting.
 */
-const uploadAssets = (options) => options.client.post({
+const getProjectInfo = (options) => options.client.get({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/assets",
-	...options,
-	headers: {
-		"Content-Type": "application/json",
-		...options.headers
-	}
+	url: "/v2/project/info/{projectId}",
+	...options
 });
 /**
-* Submit translation diffs
+* Update Project information
 *
-* Overwrite translations with user-provided localized content.
+* Update the Project's default locale or CDN delivery setting.
 */
-const submitUserEditDiffs = (options) => options.client.post({
+const updateProjectInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/files/diffs",
+	url: "/v2/project/info/{projectId}",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -85,31 +96,19 @@ const submitUserEditDiffs = (options) => options.client.post({
 	}
 });
 /**
-* 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.
+* Translate content at runtime
 *
-* @deprecated
+* Translate one or more strings or structured content entries with caching and memoization. Development API keys are accepted for this endpoint.
 */
-const shouldGenerateProjectContext = (options) => options.client.get({
+const translate = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
-	}],
-	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",
 		type: "http"
 	}],
-	url: "/v2/project/setup/generate",
+	url: "/v2/translate",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -117,31 +116,35 @@ const generateProjectContext = (options) => options.client.post({
 	}
 });
 /**
-* 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`.
+* Get translation status for a file
 *
-* @deprecated
+* Return translation progress and availability by locale for one source file, along with its source metadata.
 */
-const getProjectContextGenerationStatus = (options) => options.client.get({
+const getTranslationStatus = (options) => options.client.get({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/setup/status/{jobId}",
+	url: "/v2/project/translations/files/status/{fileId}",
 	...options
 });
 /**
-* Queue files for translation
+* Get branch information
 *
-* Enqueue uploaded source files for background translation. Max 100 files per request. The response shape depends on the requested `gt-api-version`.
+* Return the Project's default branch and any branches requested by name.
 */
-const enqueueFileTranslations = (options) => options.client.post({
+const getBranchInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/translations/enqueue",
+	url: "/v2/project/branches/info",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -149,16 +152,19 @@ const enqueueFileTranslations = (options) => options.client.post({
 	}
 });
 /**
-* Publish or unpublish files
+* Create a branch
 *
-* Publish or unpublish translated files to the CDN. Requires CDN to be enabled.
+* Create a new branch, or rename and confirm the default branch.
 */
-const publishFiles = (options) => options.client.post({
+const createBranch = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/files/publish",
+	url: "/v2/project/branches/create",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -166,31 +172,39 @@ const publishFiles = (options) => options.client.post({
 	}
 });
 /**
-* 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`.
+* Create or update a tag
 *
-* @deprecated
+* Create or upsert a tag that points at a set of file versions.
 */
-const downloadFile = (options) => options.client.get({
+const createTag = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/files/download/{fileId}",
-	...options
+	url: "/v2/project/tags/create",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
 });
 /**
-* Download multiple files
+* Upload Project assets
 *
-* Download up to 100 source or translated files in one request.
+* 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 downloadFiles = (options) => options.client.post({
+const uploadAssets = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/files/download",
+	url: "/v2/project/assets",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -198,16 +212,19 @@ const downloadFiles = (options) => options.client.post({
 	}
 });
 /**
-* Get branch information
+* Submit translation diffs
 *
-* Return the Project's default branch and any branches requested by name.
+* Overwrite translations with user-provided localized content.
 */
-const getBranchInfo = (options) => options.client.post({
+const submitUserEditDiffs = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/branches/info",
+	url: "/v2/project/files/diffs",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -215,16 +232,19 @@ const getBranchInfo = (options) => options.client.post({
 	}
 });
 /**
-* Create a branch
+* Move or rename files
 *
-* Create a new branch, or rename and confirm the default branch.
+* Clone source files and their translations under new file IDs.
 */
-const createBranch = (options) => options.client.post({
+const processFileMoves = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/branches/create",
+	url: "/v2/project/files/moves",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -232,16 +252,19 @@ const createBranch = (options) => options.client.post({
 	}
 });
 /**
-* Create or update a tag
+* Find orphaned files
 *
-* Create or upsert a tag that points at a set of file versions.
+* Return files on a branch that are not present in the provided file ID list.
 */
-const createTag = (options) => options.client.post({
+const getOrphanedFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/tags/create",
+	url: "/v2/project/files/orphaned",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -249,29 +272,39 @@ const createTag = (options) => options.client.post({
 	}
 });
 /**
-* Get Project information
+* Get file metadata
 *
-* Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting.
+* Get detailed metadata for specific source and translated files.
 */
-const getProjectInfo = (options) => options.client.get({
+const getFileInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/info/{projectId}",
-	...options
+	url: "/v2/project/files/info",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
 });
 /**
-* Update Project information
+* Download multiple files
 *
-* Update the Project's default locale or CDN delivery setting.
+* Download up to 100 source or translated files in one request.
 */
-const updateProjectInfo = (options) => options.client.post({
+const downloadFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/info/{projectId}",
+	url: "/v2/project/files/download",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -279,6 +312,24 @@ const updateProjectInfo = (options) => options.client.post({
 	}
 });
 /**
+* 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",
+		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
+	}],
+	url: "/v2/project/files/download/{fileId}",
+	...options
+});
+/**
 * Get translation job status
 *
 * Return normalized status information for one or more queued translation or context generation jobs.
@@ -287,6 +338,9 @@ const getTranslationJobInfo = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
 	url: "/v2/project/jobs/info",
 	...options,
@@ -296,16 +350,19 @@ const getTranslationJobInfo = (options) => options.client.post({
 	}
 });
 /**
-* Translate content at runtime
+* Generate translation context
 *
-* Translate one or more strings or structured content entries with caching and memoization. Development API keys are accepted for this endpoint.
+* Generate glossaries and translation instructions for the project.
 */
-const translate = (options) => options.client.post({
+const generateProjectContext = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/translate",
+	url: "/v2/project/setup/generate",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -313,16 +370,19 @@ const translate = (options) => options.client.post({
 	}
 });
 /**
-* Get file metadata
+* Publish or unpublish files
 *
-* Get detailed metadata for specific source and translated files.
+* Publish or unpublish translated files to the CDN. Requires CDN to be enabled.
 */
-const getFileInfo = (options) => options.client.post({
+const publishFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/files/info",
+	url: "/v2/project/files/publish",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -330,29 +390,19 @@ const getFileInfo = (options) => options.client.post({
 	}
 });
 /**
-* Get translation status for a file
+* Upload source files
 *
-* Return translation progress and availability by locale for one source file, along with its source metadata.
+* Upload one or more source files to the project. Max 100 files per request.
 */
-const getTranslationStatus = (options) => options.client.get({
+const uploadSourceFiles = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
-	}],
-	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",
 		type: "http"
 	}],
-	url: "/v2/project/files/moves",
+	url: "/v2/project/files/upload-files",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -360,16 +410,19 @@ const processFileMoves = (options) => options.client.post({
 	}
 });
 /**
-* Find orphaned files
+* Queue files for translation
 *
-* Return files on a branch that are not present in the provided file ID list.
+* Enqueue uploaded source files for background translation. Max 100 files per request. The response shape depends on the requested `gt-api-version`.
 */
-const getOrphanedFiles = (options) => options.client.post({
+const enqueueFileTranslations = (options) => options.client.post({
 	security: [{
 		scheme: "bearer",
 		type: "http"
+	}, {
+		scheme: "bearer",
+		type: "http"
 	}],
-	url: "/v2/project/files/orphaned",
+	url: "/v2/project/translations/enqueue",
 	...options,
 	headers: {
 		"Content-Type": "application/json",
@@ -1188,6 +1241,6 @@ function createApiClient(config) {
 	});
 }
 //#endregion
-export { API_VERSION, DEFAULT_BATCH_SIZE, awaitJobs, createApiClient, createBranch, createCliWizardSession, createProject, createTag, decodeBase64, decodeFileContent, deleteCliWizardSession, downloadFile, downloadFiles, encodeBase64, encodeFileContent, enqueueFileTranslations, generateProjectContext, getBranchInfo, getCliWizardSession, getFileInfo, getOrphanedFiles, getProjectContextGenerationStatus, getProjectInfo, getTranslationJobInfo, getTranslationStatus, pollJobs, processBatches, processFileMoves, publishFiles, shouldGenerateProjectContext, submitUserEditDiffs, translate, updateProjectInfo, uploadAssets, uploadSourceFiles, uploadTranslations };
+export { API_VERSION, DEFAULT_BATCH_SIZE, awaitJobs, createApiClient, createBranch, createCliWizardSession, createProject, createProjectApiKey, createTag, decodeBase64, decodeFileContent, deleteCliWizardSession, downloadFile, downloadFiles, encodeBase64, encodeFileContent, enqueueFileTranslations, generateProjectContext, getBranchInfo, getCliWizardSession, getFileInfo, getOrphanedFiles, getProjectInfo, getTranslationJobInfo, getTranslationStatus, pollJobs, processBatches, processFileMoves, publishFiles, submitUserEditDiffs, translate, updateProjectInfo, uploadAssets, uploadSourceFiles, uploadTranslations };
 
 //# sourceMappingURL=index.mjs.map