@generaltranslation/api 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/dist/index.cjs +136 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +225 -1
- package/dist/index.d.mts +225 -1
- package/dist/index.mjs +136 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/spec/openapi.json +360 -48
package/dist/index.d.cts
CHANGED
|
@@ -310,7 +310,7 @@ type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boole
|
|
|
310
310
|
//#endregion
|
|
311
311
|
//#region src/generated/types.gen.d.ts
|
|
312
312
|
type ClientOptions = {
|
|
313
|
-
baseUrl:
|
|
313
|
+
baseUrl: 'https://api.gtx.dev' | (string & {});
|
|
314
314
|
};
|
|
315
315
|
type ErrorResponse = {
|
|
316
316
|
error: string;
|
|
@@ -468,6 +468,10 @@ type UploadSourceFilesData = {
|
|
|
468
468
|
* API contract version. Defaults to the oldest supported version.
|
|
469
469
|
*/
|
|
470
470
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
471
|
+
/**
|
|
472
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
473
|
+
*/
|
|
474
|
+
'gt-project-id'?: string;
|
|
471
475
|
};
|
|
472
476
|
path?: never;
|
|
473
477
|
query?: never;
|
|
@@ -561,6 +565,10 @@ type UploadTranslationsData = {
|
|
|
561
565
|
* API contract version. Defaults to the oldest supported version.
|
|
562
566
|
*/
|
|
563
567
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
568
|
+
/**
|
|
569
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
570
|
+
*/
|
|
571
|
+
'gt-project-id'?: string;
|
|
564
572
|
};
|
|
565
573
|
path?: never;
|
|
566
574
|
query?: never;
|
|
@@ -635,6 +643,10 @@ type UploadAssetsData = {
|
|
|
635
643
|
* API contract version. Defaults to the oldest supported version.
|
|
636
644
|
*/
|
|
637
645
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
646
|
+
/**
|
|
647
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
648
|
+
*/
|
|
649
|
+
'gt-project-id'?: string;
|
|
638
650
|
};
|
|
639
651
|
path?: never;
|
|
640
652
|
query?: never;
|
|
@@ -702,6 +714,10 @@ type SubmitUserEditDiffsData = {
|
|
|
702
714
|
* API contract version. Defaults to the oldest supported version.
|
|
703
715
|
*/
|
|
704
716
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
717
|
+
/**
|
|
718
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
719
|
+
*/
|
|
720
|
+
'gt-project-id'?: string;
|
|
705
721
|
};
|
|
706
722
|
path?: never;
|
|
707
723
|
query?: never;
|
|
@@ -752,6 +768,10 @@ type ShouldGenerateProjectContextData = {
|
|
|
752
768
|
* API contract version. Defaults to the oldest supported version.
|
|
753
769
|
*/
|
|
754
770
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
771
|
+
/**
|
|
772
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
773
|
+
*/
|
|
774
|
+
'gt-project-id'?: string;
|
|
755
775
|
};
|
|
756
776
|
path?: never;
|
|
757
777
|
query?: never;
|
|
@@ -808,6 +828,10 @@ type GenerateProjectContextData = {
|
|
|
808
828
|
* API contract version. Defaults to the oldest supported version.
|
|
809
829
|
*/
|
|
810
830
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
831
|
+
/**
|
|
832
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
833
|
+
*/
|
|
834
|
+
'gt-project-id'?: string;
|
|
811
835
|
};
|
|
812
836
|
path?: never;
|
|
813
837
|
query?: never;
|
|
@@ -863,6 +887,10 @@ type GetProjectContextGenerationStatusData = {
|
|
|
863
887
|
* API contract version. Defaults to the oldest supported version.
|
|
864
888
|
*/
|
|
865
889
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
890
|
+
/**
|
|
891
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
892
|
+
*/
|
|
893
|
+
'gt-project-id'?: string;
|
|
866
894
|
};
|
|
867
895
|
path: {
|
|
868
896
|
jobId: string;
|
|
@@ -929,6 +957,10 @@ type EnqueueFileTranslationsData = {
|
|
|
929
957
|
* API contract version. Defaults to the oldest supported version.
|
|
930
958
|
*/
|
|
931
959
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
960
|
+
/**
|
|
961
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
962
|
+
*/
|
|
963
|
+
'gt-project-id'?: string;
|
|
932
964
|
};
|
|
933
965
|
path?: never;
|
|
934
966
|
query?: never;
|
|
@@ -1040,6 +1072,10 @@ type PublishFilesData = {
|
|
|
1040
1072
|
* API contract version. Defaults to the oldest supported version.
|
|
1041
1073
|
*/
|
|
1042
1074
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1075
|
+
/**
|
|
1076
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1077
|
+
*/
|
|
1078
|
+
'gt-project-id'?: string;
|
|
1043
1079
|
};
|
|
1044
1080
|
path?: never;
|
|
1045
1081
|
query?: never;
|
|
@@ -1099,6 +1135,10 @@ type DownloadFileData = {
|
|
|
1099
1135
|
* API contract version. Defaults to the oldest supported version.
|
|
1100
1136
|
*/
|
|
1101
1137
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1138
|
+
/**
|
|
1139
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1140
|
+
*/
|
|
1141
|
+
'gt-project-id'?: string;
|
|
1102
1142
|
};
|
|
1103
1143
|
path: {
|
|
1104
1144
|
fileId: string;
|
|
@@ -1166,6 +1206,10 @@ type DownloadFilesData = {
|
|
|
1166
1206
|
* API contract version. Defaults to the oldest supported version.
|
|
1167
1207
|
*/
|
|
1168
1208
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1209
|
+
/**
|
|
1210
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1211
|
+
*/
|
|
1212
|
+
'gt-project-id'?: string;
|
|
1169
1213
|
};
|
|
1170
1214
|
path?: never;
|
|
1171
1215
|
query?: never;
|
|
@@ -1235,6 +1279,10 @@ type GetBranchInfoData = {
|
|
|
1235
1279
|
* API contract version. Defaults to the oldest supported version.
|
|
1236
1280
|
*/
|
|
1237
1281
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1282
|
+
/**
|
|
1283
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1284
|
+
*/
|
|
1285
|
+
'gt-project-id'?: string;
|
|
1238
1286
|
};
|
|
1239
1287
|
path?: never;
|
|
1240
1288
|
query?: never;
|
|
@@ -1289,6 +1337,10 @@ type CreateBranchData = {
|
|
|
1289
1337
|
* API contract version. Defaults to the oldest supported version.
|
|
1290
1338
|
*/
|
|
1291
1339
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1340
|
+
/**
|
|
1341
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1342
|
+
*/
|
|
1343
|
+
'gt-project-id'?: string;
|
|
1292
1344
|
};
|
|
1293
1345
|
path?: never;
|
|
1294
1346
|
query?: never;
|
|
@@ -1349,6 +1401,10 @@ type CreateTagData = {
|
|
|
1349
1401
|
* API contract version. Defaults to the oldest supported version.
|
|
1350
1402
|
*/
|
|
1351
1403
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1404
|
+
/**
|
|
1405
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1406
|
+
*/
|
|
1407
|
+
'gt-project-id'?: string;
|
|
1352
1408
|
};
|
|
1353
1409
|
path?: never;
|
|
1354
1410
|
query?: never;
|
|
@@ -1403,6 +1459,10 @@ type GetProjectInfoData = {
|
|
|
1403
1459
|
* API contract version. Defaults to the oldest supported version.
|
|
1404
1460
|
*/
|
|
1405
1461
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1462
|
+
/**
|
|
1463
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1464
|
+
*/
|
|
1465
|
+
'gt-project-id'?: string;
|
|
1406
1466
|
};
|
|
1407
1467
|
path: {
|
|
1408
1468
|
projectId: string;
|
|
@@ -1461,6 +1521,10 @@ type UpdateProjectInfoData = {
|
|
|
1461
1521
|
* API contract version. Defaults to the oldest supported version.
|
|
1462
1522
|
*/
|
|
1463
1523
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1524
|
+
/**
|
|
1525
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1526
|
+
*/
|
|
1527
|
+
'gt-project-id'?: string;
|
|
1464
1528
|
};
|
|
1465
1529
|
path: {
|
|
1466
1530
|
projectId: string;
|
|
@@ -1517,6 +1581,10 @@ type GetTranslationJobInfoData = {
|
|
|
1517
1581
|
* API contract version. Defaults to the oldest supported version.
|
|
1518
1582
|
*/
|
|
1519
1583
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1584
|
+
/**
|
|
1585
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1586
|
+
*/
|
|
1587
|
+
'gt-project-id'?: string;
|
|
1520
1588
|
};
|
|
1521
1589
|
path?: never;
|
|
1522
1590
|
query?: never;
|
|
@@ -1585,6 +1653,10 @@ type TranslateData = {
|
|
|
1585
1653
|
* API contract version. Defaults to the oldest supported version.
|
|
1586
1654
|
*/
|
|
1587
1655
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1656
|
+
/**
|
|
1657
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1658
|
+
*/
|
|
1659
|
+
'gt-project-id'?: string;
|
|
1588
1660
|
};
|
|
1589
1661
|
path?: never;
|
|
1590
1662
|
query?: never;
|
|
@@ -1655,6 +1727,10 @@ type GetFileInfoData = {
|
|
|
1655
1727
|
* API contract version. Defaults to the oldest supported version.
|
|
1656
1728
|
*/
|
|
1657
1729
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1730
|
+
/**
|
|
1731
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1732
|
+
*/
|
|
1733
|
+
'gt-project-id'?: string;
|
|
1658
1734
|
};
|
|
1659
1735
|
path?: never;
|
|
1660
1736
|
query?: never;
|
|
@@ -1728,6 +1804,10 @@ type GetTranslationStatusData = {
|
|
|
1728
1804
|
* API contract version. Defaults to the oldest supported version.
|
|
1729
1805
|
*/
|
|
1730
1806
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1807
|
+
/**
|
|
1808
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1809
|
+
*/
|
|
1810
|
+
'gt-project-id'?: string;
|
|
1731
1811
|
};
|
|
1732
1812
|
path: {
|
|
1733
1813
|
fileId: string;
|
|
@@ -1808,6 +1888,10 @@ type ProcessFileMovesData = {
|
|
|
1808
1888
|
* API contract version. Defaults to the oldest supported version.
|
|
1809
1889
|
*/
|
|
1810
1890
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1891
|
+
/**
|
|
1892
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1893
|
+
*/
|
|
1894
|
+
'gt-project-id'?: string;
|
|
1811
1895
|
};
|
|
1812
1896
|
path?: never;
|
|
1813
1897
|
query?: never;
|
|
@@ -1875,6 +1959,10 @@ type GetOrphanedFilesData = {
|
|
|
1875
1959
|
* API contract version. Defaults to the oldest supported version.
|
|
1876
1960
|
*/
|
|
1877
1961
|
'gt-api-version'?: '2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1';
|
|
1962
|
+
/**
|
|
1963
|
+
* Target project ID. Required when authenticating with an organization API key; ignored with project-scoped API keys (the project is resolved from the key).
|
|
1964
|
+
*/
|
|
1965
|
+
'gt-project-id'?: string;
|
|
1878
1966
|
};
|
|
1879
1967
|
path?: never;
|
|
1880
1968
|
query?: never;
|
|
@@ -2115,31 +2203,167 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
|
|
|
2115
2203
|
*/
|
|
2116
2204
|
meta?: Record<string, unknown>;
|
|
2117
2205
|
};
|
|
2206
|
+
/**
|
|
2207
|
+
* Create a Project
|
|
2208
|
+
*
|
|
2209
|
+
* 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`.
|
|
2210
|
+
*/
|
|
2118
2211
|
declare const createProject: <ThrowOnError extends boolean = false>(options: Options<CreateProjectData, ThrowOnError>) => RequestResult<CreateProjectResponses, CreateProjectErrors, ThrowOnError, "fields">;
|
|
2212
|
+
/**
|
|
2213
|
+
* Upload source files
|
|
2214
|
+
*
|
|
2215
|
+
* Upload one or more source files to the project. Max 100 files per request.
|
|
2216
|
+
*/
|
|
2119
2217
|
declare const uploadSourceFiles: <ThrowOnError extends boolean = false>(options: Options<UploadSourceFilesData, ThrowOnError>) => RequestResult<UploadSourceFilesResponses, UploadSourceFilesErrors, ThrowOnError, "fields">;
|
|
2218
|
+
/**
|
|
2219
|
+
* Upload translated files
|
|
2220
|
+
*
|
|
2221
|
+
* Upload translated files linked to their source files. Max 100 files per request.
|
|
2222
|
+
*/
|
|
2120
2223
|
declare const uploadTranslations: <ThrowOnError extends boolean = false>(options: Options<UploadTranslationsData, ThrowOnError>) => RequestResult<UploadTranslationsResponses, UploadTranslationsErrors, ThrowOnError, "fields">;
|
|
2224
|
+
/**
|
|
2225
|
+
* Upload Project assets
|
|
2226
|
+
*
|
|
2227
|
+
* 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.
|
|
2228
|
+
*/
|
|
2121
2229
|
declare const uploadAssets: <ThrowOnError extends boolean = false>(options: Options<UploadAssetsData, ThrowOnError>) => RequestResult<UploadAssetsResponses, UploadAssetsErrors, ThrowOnError, "fields">;
|
|
2230
|
+
/**
|
|
2231
|
+
* Submit translation diffs
|
|
2232
|
+
*
|
|
2233
|
+
* Overwrite translations with user-provided localized content.
|
|
2234
|
+
*/
|
|
2122
2235
|
declare const submitUserEditDiffs: <ThrowOnError extends boolean = false>(options: Options<SubmitUserEditDiffsData, ThrowOnError>) => RequestResult<SubmitUserEditDiffsResponses, SubmitUserEditDiffsErrors, ThrowOnError, "fields">;
|
|
2236
|
+
/**
|
|
2237
|
+
* Check if context generation is needed
|
|
2238
|
+
*
|
|
2239
|
+
* Check whether the Project needs translation context generated. This deprecated endpoint is retained for backward compatibility and is no longer called by current clients.
|
|
2240
|
+
*
|
|
2241
|
+
* @deprecated
|
|
2242
|
+
*/
|
|
2123
2243
|
declare const shouldGenerateProjectContext: <ThrowOnError extends boolean = false>(options: Options<ShouldGenerateProjectContextData, ThrowOnError>) => RequestResult<ShouldGenerateProjectContextResponses, ShouldGenerateProjectContextErrors, ThrowOnError, "fields">;
|
|
2244
|
+
/**
|
|
2245
|
+
* Generate translation context
|
|
2246
|
+
*
|
|
2247
|
+
* Generate glossaries and translation instructions for the project.
|
|
2248
|
+
*/
|
|
2124
2249
|
declare const generateProjectContext: <ThrowOnError extends boolean = false>(options: Options<GenerateProjectContextData, ThrowOnError>) => RequestResult<GenerateProjectContextResponses, GenerateProjectContextErrors, ThrowOnError, "fields">;
|
|
2250
|
+
/**
|
|
2251
|
+
* Get context generation job status
|
|
2252
|
+
*
|
|
2253
|
+
* Track a context generation job. This deprecated endpoint is retained for backward compatibility; new integrations should use `POST /v2/project/jobs/info`.
|
|
2254
|
+
*
|
|
2255
|
+
* @deprecated
|
|
2256
|
+
*/
|
|
2125
2257
|
declare const getProjectContextGenerationStatus: <ThrowOnError extends boolean = false>(options: Options<GetProjectContextGenerationStatusData, ThrowOnError>) => RequestResult<GetProjectContextGenerationStatusResponses, GetProjectContextGenerationStatusErrors, ThrowOnError, "fields">;
|
|
2258
|
+
/**
|
|
2259
|
+
* Queue files for translation
|
|
2260
|
+
*
|
|
2261
|
+
* Enqueue uploaded source files for background translation. Max 100 files per request. The response shape depends on the requested `gt-api-version`.
|
|
2262
|
+
*/
|
|
2126
2263
|
declare const enqueueFileTranslations: <ThrowOnError extends boolean = false>(options: Options<EnqueueFileTranslationsData, ThrowOnError>) => RequestResult<EnqueueFileTranslationsResponses, EnqueueFileTranslationsErrors, ThrowOnError, "fields">;
|
|
2264
|
+
/**
|
|
2265
|
+
* Publish or unpublish files
|
|
2266
|
+
*
|
|
2267
|
+
* Publish or unpublish translated files to the CDN. Requires CDN to be enabled.
|
|
2268
|
+
*/
|
|
2127
2269
|
declare const publishFiles: <ThrowOnError extends boolean = false>(options: Options<PublishFilesData, ThrowOnError>) => RequestResult<PublishFilesResponses, PublishFilesErrors, ThrowOnError, "fields">;
|
|
2270
|
+
/**
|
|
2271
|
+
* Download a single file
|
|
2272
|
+
*
|
|
2273
|
+
* Download a single source or translated file. This deprecated endpoint is retained for backward compatibility; new integrations should use `POST /v2/project/files/download`.
|
|
2274
|
+
*
|
|
2275
|
+
* @deprecated
|
|
2276
|
+
*/
|
|
2128
2277
|
declare const downloadFile: <ThrowOnError extends boolean = false>(options: Options<DownloadFileData, ThrowOnError>) => RequestResult<DownloadFileResponses, DownloadFileErrors, ThrowOnError, "fields">;
|
|
2278
|
+
/**
|
|
2279
|
+
* Download multiple files
|
|
2280
|
+
*
|
|
2281
|
+
* Download up to 100 source or translated files in one request.
|
|
2282
|
+
*/
|
|
2129
2283
|
declare const downloadFiles: <ThrowOnError extends boolean = false>(options: Options<DownloadFilesData, ThrowOnError>) => RequestResult<DownloadFilesResponses, DownloadFilesErrors, ThrowOnError, "fields">;
|
|
2284
|
+
/**
|
|
2285
|
+
* Get branch information
|
|
2286
|
+
*
|
|
2287
|
+
* Return the Project's default branch and any branches requested by name.
|
|
2288
|
+
*/
|
|
2130
2289
|
declare const getBranchInfo: <ThrowOnError extends boolean = false>(options: Options<GetBranchInfoData, ThrowOnError>) => RequestResult<GetBranchInfoResponses, GetBranchInfoErrors, ThrowOnError, "fields">;
|
|
2290
|
+
/**
|
|
2291
|
+
* Create a branch
|
|
2292
|
+
*
|
|
2293
|
+
* Create a new branch, or rename and confirm the default branch.
|
|
2294
|
+
*/
|
|
2131
2295
|
declare const createBranch: <ThrowOnError extends boolean = false>(options: Options<CreateBranchData, ThrowOnError>) => RequestResult<CreateBranchResponses, CreateBranchErrors, ThrowOnError, "fields">;
|
|
2296
|
+
/**
|
|
2297
|
+
* Create or update a tag
|
|
2298
|
+
*
|
|
2299
|
+
* Create or upsert a tag that points at a set of file versions.
|
|
2300
|
+
*/
|
|
2132
2301
|
declare const createTag: <ThrowOnError extends boolean = false>(options: Options<CreateTagData, ThrowOnError>) => RequestResult<CreateTagResponses, CreateTagErrors, ThrowOnError, "fields">;
|
|
2302
|
+
/**
|
|
2303
|
+
* Get Project information
|
|
2304
|
+
*
|
|
2305
|
+
* Read the authenticated Project's name, Organization ID, locale settings, and auto-approval setting.
|
|
2306
|
+
*/
|
|
2133
2307
|
declare const getProjectInfo: <ThrowOnError extends boolean = false>(options: Options<GetProjectInfoData, ThrowOnError>) => RequestResult<GetProjectInfoResponses, GetProjectInfoErrors, ThrowOnError, "fields">;
|
|
2308
|
+
/**
|
|
2309
|
+
* Update Project information
|
|
2310
|
+
*
|
|
2311
|
+
* Update the Project's default locale or CDN delivery setting.
|
|
2312
|
+
*/
|
|
2134
2313
|
declare const updateProjectInfo: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectInfoData, ThrowOnError>) => RequestResult<UpdateProjectInfoResponses, UpdateProjectInfoErrors, ThrowOnError, "fields">;
|
|
2314
|
+
/**
|
|
2315
|
+
* Get translation job status
|
|
2316
|
+
*
|
|
2317
|
+
* Return normalized status information for one or more queued translation or context generation jobs.
|
|
2318
|
+
*/
|
|
2135
2319
|
declare const getTranslationJobInfo: <ThrowOnError extends boolean = false>(options: Options<GetTranslationJobInfoData, ThrowOnError>) => RequestResult<GetTranslationJobInfoResponses, GetTranslationJobInfoErrors, ThrowOnError, "fields">;
|
|
2320
|
+
/**
|
|
2321
|
+
* Translate content at runtime
|
|
2322
|
+
*
|
|
2323
|
+
* Translate one or more strings or structured content entries with caching and memoization. Development API keys are accepted for this endpoint.
|
|
2324
|
+
*/
|
|
2136
2325
|
declare const translate: <ThrowOnError extends boolean = false>(options: Options<TranslateData, ThrowOnError>) => RequestResult<TranslateResponses, TranslateErrors, ThrowOnError, "fields">;
|
|
2326
|
+
/**
|
|
2327
|
+
* Get file metadata
|
|
2328
|
+
*
|
|
2329
|
+
* Get detailed metadata for specific source and translated files.
|
|
2330
|
+
*/
|
|
2137
2331
|
declare const getFileInfo: <ThrowOnError extends boolean = false>(options: Options<GetFileInfoData, ThrowOnError>) => RequestResult<GetFileInfoResponses, GetFileInfoErrors, ThrowOnError, "fields">;
|
|
2332
|
+
/**
|
|
2333
|
+
* Get translation status for a file
|
|
2334
|
+
*
|
|
2335
|
+
* Return translation progress and availability by locale for one source file, along with its source metadata.
|
|
2336
|
+
*/
|
|
2138
2337
|
declare const getTranslationStatus: <ThrowOnError extends boolean = false>(options: Options<GetTranslationStatusData, ThrowOnError>) => RequestResult<GetTranslationStatusResponses, GetTranslationStatusErrors, ThrowOnError, "fields">;
|
|
2338
|
+
/**
|
|
2339
|
+
* Move or rename files
|
|
2340
|
+
*
|
|
2341
|
+
* Clone source files and their translations under new file IDs.
|
|
2342
|
+
*/
|
|
2139
2343
|
declare const processFileMoves: <ThrowOnError extends boolean = false>(options: Options<ProcessFileMovesData, ThrowOnError>) => RequestResult<ProcessFileMovesResponses, ProcessFileMovesErrors, ThrowOnError, "fields">;
|
|
2344
|
+
/**
|
|
2345
|
+
* Find orphaned files
|
|
2346
|
+
*
|
|
2347
|
+
* Return files on a branch that are not present in the provided file ID list.
|
|
2348
|
+
*/
|
|
2140
2349
|
declare const getOrphanedFiles: <ThrowOnError extends boolean = false>(options: Options<GetOrphanedFilesData, ThrowOnError>) => RequestResult<GetOrphanedFilesResponses, GetOrphanedFilesErrors, ThrowOnError, "fields">;
|
|
2350
|
+
/**
|
|
2351
|
+
* Create a CLI wizard session
|
|
2352
|
+
*
|
|
2353
|
+
* Create a temporary session for CLI browser authentication.
|
|
2354
|
+
*/
|
|
2141
2355
|
declare const createCliWizardSession: <ThrowOnError extends boolean = false>(options: Options<CreateCliWizardSessionData, ThrowOnError>) => RequestResult<CreateCliWizardSessionResponses, CreateCliWizardSessionErrors, ThrowOnError, "fields">;
|
|
2356
|
+
/**
|
|
2357
|
+
* Delete a CLI wizard session
|
|
2358
|
+
*
|
|
2359
|
+
* Delete a completed or abandoned CLI wizard session.
|
|
2360
|
+
*/
|
|
2142
2361
|
declare const deleteCliWizardSession: <ThrowOnError extends boolean = false>(options: Options<DeleteCliWizardSessionData, ThrowOnError>) => RequestResult<DeleteCliWizardSessionResponses, DeleteCliWizardSessionErrors, ThrowOnError, "fields">;
|
|
2362
|
+
/**
|
|
2363
|
+
* Get a CLI wizard session
|
|
2364
|
+
*
|
|
2365
|
+
* Get credentials for a completed CLI wizard session or its current waiting status.
|
|
2366
|
+
*/
|
|
2143
2367
|
declare const getCliWizardSession: <ThrowOnError extends boolean = false>(options: Options<GetCliWizardSessionData, ThrowOnError>) => RequestResult<GetCliWizardSessionResponses, GetCliWizardSessionErrors, ThrowOnError, "fields">;
|
|
2144
2368
|
//#endregion
|
|
2145
2369
|
export { API_VERSION, type ApiClientConfig, type ApiVersion, type AwaitJobsOptions, type AwaitJobsResult, type BatchOptions, Branch, CliWizardSessionReadyResponse, CliWizardSessionWaitingResponse, type Client, ClientOptions, CreateBranchData, CreateBranchError, CreateBranchErrors, CreateBranchResponse, CreateBranchResponses, CreateCliWizardSessionData, CreateCliWizardSessionError, CreateCliWizardSessionErrors, CreateCliWizardSessionRequest, CreateCliWizardSessionResponse, CreateCliWizardSessionResponse2, CreateCliWizardSessionResponses, CreateProjectData, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, DEFAULT_BATCH_SIZE, DeleteCliWizardSessionData, DeleteCliWizardSessionError, DeleteCliWizardSessionErrors, DeleteCliWizardSessionResponse, DeleteCliWizardSessionResponse2, DeleteCliWizardSessionResponses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, DownloadFilesData, DownloadFilesError, DownloadFilesErrors, DownloadFilesResponse, DownloadFilesResponses, EnqueueFileTranslationsData, EnqueueFileTranslationsError, EnqueueFileTranslationsErrors, EnqueueFileTranslationsResponse, EnqueueFileTranslationsResponses, ErrorResponse, FileFormat, GenerateProjectContextData, GenerateProjectContextError, GenerateProjectContextErrors, GenerateProjectContextResponse, GenerateProjectContextResponses, GetBranchInfoData, GetBranchInfoError, GetBranchInfoErrors, GetBranchInfoResponse, GetBranchInfoResponses, GetCliWizardSessionData, GetCliWizardSessionError, GetCliWizardSessionErrors, GetCliWizardSessionResponse, GetCliWizardSessionResponses, GetFileInfoData, GetFileInfoError, GetFileInfoErrors, GetFileInfoResponse, GetFileInfoResponses, GetOrphanedFilesData, GetOrphanedFilesError, GetOrphanedFilesErrors, GetOrphanedFilesResponse, GetOrphanedFilesResponses, GetProjectContextGenerationStatusData, GetProjectContextGenerationStatusError, GetProjectContextGenerationStatusErrors, GetProjectContextGenerationStatusResponse, GetProjectContextGenerationStatusResponses, GetProjectInfoData, GetProjectInfoError, GetProjectInfoErrors, GetProjectInfoResponse, GetProjectInfoResponses, GetTranslationJobInfoData, GetTranslationJobInfoError, GetTranslationJobInfoErrors, GetTranslationJobInfoResponse, GetTranslationJobInfoResponses, GetTranslationStatusData, GetTranslationStatusError, GetTranslationStatusErrors, GetTranslationStatusResponse, GetTranslationStatusResponses, type JobResult, Options, ProcessFileMovesData, ProcessFileMovesError, ProcessFileMovesErrors, ProcessFileMovesResponse, ProcessFileMovesResponses, PublishFilesData, PublishFilesError, PublishFilesErrors, PublishFilesResponse, PublishFilesResponses, type RetryPolicy, RuntimeTranslationRequest, RuntimeTranslationResponse, ShouldGenerateProjectContextData, ShouldGenerateProjectContextError, ShouldGenerateProjectContextErrors, ShouldGenerateProjectContextResponse, ShouldGenerateProjectContextResponses, SubmitUserEditDiffsData, SubmitUserEditDiffsError, SubmitUserEditDiffsErrors, SubmitUserEditDiffsResponse, SubmitUserEditDiffsResponses, TranslateData, TranslateError, TranslateErrors, TranslateResponse, TranslateResponses, UpdateProjectInfoData, UpdateProjectInfoError, UpdateProjectInfoErrors, UpdateProjectInfoResponse, UpdateProjectInfoResponses, UploadAssetsData, UploadAssetsError, UploadAssetsErrors, UploadAssetsResponse, UploadAssetsResponses, UploadSourceFilesData, UploadSourceFilesError, UploadSourceFilesErrors, UploadSourceFilesResponse, UploadSourceFilesResponses, UploadTranslationsData, UploadTranslationsError, UploadTranslationsErrors, UploadTranslationsResponse, UploadTranslationsResponses, awaitJobs, createApiClient, createBranch, createCliWizardSession, createProject, createTag, decodeBase64, decodeFileContent, deleteCliWizardSession, downloadFile, downloadFiles, encodeBase64, encodeFileContent, enqueueFileTranslations, generateProjectContext, getBranchInfo, getCliWizardSession, getFileInfo, getOrphanedFiles, getProjectContextGenerationStatus, getProjectInfo, getTranslationJobInfo, getTranslationStatus, processBatches, processFileMoves, publishFiles, shouldGenerateProjectContext, submitUserEditDiffs, translate, updateProjectInfo, uploadAssets, uploadSourceFiles, uploadTranslations };
|