@lokalise/content-type-app-engine-contracts 6.11.0 → 7.0.0
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/README.md +19 -0
- package/dist/index.d.ts +0 -2
- package/dist/index.js +0 -2
- package/dist/index.js.map +1 -1
- package/dist/schemas/auth/authApiSchemas.d.ts +174 -133
- package/dist/schemas/auth/authApiSchemas.js +21 -24
- package/dist/schemas/auth/authApiSchemas.js.map +1 -1
- package/dist/schemas/auth/integrationAuthApiSchemas.d.ts +189 -170
- package/dist/schemas/auth/integrationAuthApiSchemas.js +17 -31
- package/dist/schemas/auth/integrationAuthApiSchemas.js.map +1 -1
- package/dist/schemas/cache/cacheApiSchemas.d.ts +59 -80
- package/dist/schemas/cache/cacheApiSchemas.js +4 -4
- package/dist/schemas/cache/cacheApiSchemas.js.map +1 -1
- package/dist/schemas/commonRequestSchemas.d.ts +1 -1
- package/dist/schemas/commonRequestSchemas.js +3 -1
- package/dist/schemas/commonRequestSchemas.js.map +1 -1
- package/dist/schemas/config/integrationConfigApiSchemas.d.ts +80 -70
- package/dist/schemas/config/integrationConfigApiSchemas.js +8 -14
- package/dist/schemas/config/integrationConfigApiSchemas.js.map +1 -1
- package/dist/schemas/connector/connectorApiSchemas.d.ts +703 -1348
- package/dist/schemas/connector/connectorApiSchemas.js +12 -14
- package/dist/schemas/connector/connectorApiSchemas.js.map +1 -1
- package/dist/schemas/connector/connectorSchemas.d.ts +0 -3
- package/dist/schemas/content/contentApiSchemas.d.ts +704 -709
- package/dist/schemas/content/contentApiSchemas.js +51 -84
- package/dist/schemas/content/contentApiSchemas.js.map +1 -1
- package/dist/schemas/content/contentExportApiSchemas.d.ts +44 -51
- package/dist/schemas/content/contentExportApiSchemas.js +3 -4
- package/dist/schemas/content/contentExportApiSchemas.js.map +1 -1
- package/dist/schemas/env/envApiSchemas.d.ts +95 -124
- package/dist/schemas/env/envApiSchemas.js +17 -14
- package/dist/schemas/env/envApiSchemas.js.map +1 -1
- package/dist/schemas/filter/filterApiSchemas.d.ts +314 -232
- package/dist/schemas/filter/filterApiSchemas.js +20 -20
- package/dist/schemas/filter/filterApiSchemas.js.map +1 -1
- package/dist/schemas/integration/integrationApiSchemas.d.ts +702 -1349
- package/dist/schemas/integration/integrationApiSchemas.js +12 -18
- package/dist/schemas/integration/integrationApiSchemas.js.map +1 -1
- package/dist/schemas/integration/integrationSchemas.d.ts +0 -3
- package/dist/schemas/integrationProject/integrationProjectApiSchemas.d.ts +144 -117
- package/dist/schemas/integrationProject/integrationProjectApiSchemas.js +10 -10
- package/dist/schemas/integrationProject/integrationProjectApiSchemas.js.map +1 -1
- package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.d.ts +45 -40
- package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js +5 -4
- package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js.map +1 -1
- package/dist/schemas/itemGroup/linkItemGroupApiSchemas.d.ts +45 -43
- package/dist/schemas/itemGroup/linkItemGroupApiSchemas.js +5 -4
- package/dist/schemas/itemGroup/linkItemGroupApiSchemas.js.map +1 -1
- package/dist/schemas/itemList/integrationItemListApiSchemas.d.ts +51 -53
- package/dist/schemas/itemList/integrationItemListApiSchemas.js +5 -4
- package/dist/schemas/itemList/integrationItemListApiSchemas.js.map +1 -1
- package/dist/schemas/itemList/itemListContracts.d.ts +40 -45
- package/dist/schemas/itemList/itemListContracts.js +5 -4
- package/dist/schemas/itemList/itemListContracts.js.map +1 -1
- package/dist/schemas/language/languageApiSchemas.d.ts +29 -26
- package/dist/schemas/language/languageApiSchemas.js +4 -5
- package/dist/schemas/language/languageApiSchemas.js.map +1 -1
- package/dist/schemas/link/linkApiSchemas.d.ts +616 -1272
- package/dist/schemas/link/linkApiSchemas.js +5 -4
- package/dist/schemas/link/linkApiSchemas.js.map +1 -1
- package/dist/schemas/link/linkSchemas.d.ts +0 -3
- package/dist/schemas/processResult/integrationProcessResultsApiSchemas.d.ts +143 -167
- package/dist/schemas/processResult/integrationProcessResultsApiSchemas.js +9 -7
- package/dist/schemas/processResult/integrationProcessResultsApiSchemas.js.map +1 -1
- package/dist/schemas/project/projectApiSchemas.d.ts +90 -90
- package/dist/schemas/project/projectApiSchemas.js +8 -15
- package/dist/schemas/project/projectApiSchemas.js.map +1 -1
- package/dist/schemas/schedule/scheduleApiSchemas.d.ts +2620 -2487
- package/dist/schemas/schedule/scheduleApiSchemas.js +34 -29
- package/dist/schemas/schedule/scheduleApiSchemas.js.map +1 -1
- package/dist/schemas/settings/settingsApiSchemas.d.ts +136 -189
- package/dist/schemas/settings/settingsApiSchemas.js +8 -9
- package/dist/schemas/settings/settingsApiSchemas.js.map +1 -1
- package/dist/schemas/status/statusApiSchemas.d.ts +53 -64
- package/dist/schemas/status/statusApiSchemas.js +5 -9
- package/dist/schemas/status/statusApiSchemas.js.map +1 -1
- package/package.json +3 -3
- package/dist/schemas/preview/integrationPreviewApiSchemas.d.ts +0 -145
- package/dist/schemas/preview/integrationPreviewApiSchemas.js +0 -53
- package/dist/schemas/preview/integrationPreviewApiSchemas.js.map +0 -1
- package/dist/schemas/preview/integrationPreviewSchemas.d.ts +0 -13
- package/dist/schemas/preview/integrationPreviewSchemas.js +0 -8
- package/dist/schemas/preview/integrationPreviewSchemas.js.map +0 -1
|
@@ -1,89 +1,68 @@
|
|
|
1
|
-
export declare const getCacheItemLanguageStatusesContract:
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
export: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
20
|
-
processId: import("zod").ZodString;
|
|
21
|
-
status: import("zod").ZodEnum<{
|
|
22
|
-
completed: "completed";
|
|
23
|
-
failed: "failed";
|
|
24
|
-
in_progress: "in_progress";
|
|
25
|
-
}>;
|
|
26
|
-
}, import("zod/v4/core").$strip>>;
|
|
27
|
-
import: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
28
|
-
processId: import("zod").ZodString;
|
|
1
|
+
export declare const getCacheItemLanguageStatusesContract: Omit<{
|
|
2
|
+
readonly visibility: "internal";
|
|
3
|
+
readonly method: "post";
|
|
4
|
+
readonly summary: "Get cache item language statuses";
|
|
5
|
+
readonly description: "Get CacheItemLanguage statuses for multiple items";
|
|
6
|
+
readonly pathResolver: () => string;
|
|
7
|
+
readonly requestBodySchema: import("zod").ZodObject<{
|
|
8
|
+
cacheItemIds: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber>>;
|
|
9
|
+
uniqueIds: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
10
|
+
includeProcessStatus: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodBoolean>>;
|
|
11
|
+
projectId: import("zod").ZodOptional<import("zod").ZodString>;
|
|
12
|
+
}, import("zod/v4/core").$strip>;
|
|
13
|
+
readonly responsesByStatusCode: {
|
|
14
|
+
200: import("zod").ZodObject<{
|
|
15
|
+
data: import("zod").ZodArray<import("zod").ZodObject<{
|
|
16
|
+
id: import("zod").ZodNumber;
|
|
17
|
+
cacheItemId: import("zod").ZodNumber;
|
|
18
|
+
langIsoCode: import("zod").ZodString;
|
|
29
19
|
status: import("zod").ZodEnum<{
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
20
|
+
Completed: "Completed";
|
|
21
|
+
InProgress: "InProgress";
|
|
22
|
+
Published: "Published";
|
|
23
|
+
Untranslated: "Untranslated";
|
|
33
24
|
}>;
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
lokaliseProjectLanguageId: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
53
|
-
processStatus: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
54
|
-
export: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
55
|
-
processId: import("zod").ZodString;
|
|
56
|
-
status: import("zod").ZodEnum<{
|
|
57
|
-
completed: "completed";
|
|
58
|
-
failed: "failed";
|
|
59
|
-
in_progress: "in_progress";
|
|
60
|
-
}>;
|
|
61
|
-
}, import("zod/v4/core").$strip>>;
|
|
62
|
-
import: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
63
|
-
processId: import("zod").ZodString;
|
|
64
|
-
status: import("zod").ZodEnum<{
|
|
65
|
-
completed: "completed";
|
|
66
|
-
failed: "failed";
|
|
67
|
-
in_progress: "in_progress";
|
|
68
|
-
}>;
|
|
25
|
+
lokaliseProjectLanguageId: import("zod").ZodNullable<import("zod").ZodNumber>;
|
|
26
|
+
processStatus: import("zod").ZodOptional<import("zod").ZodObject<{
|
|
27
|
+
export: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
28
|
+
processId: import("zod").ZodString;
|
|
29
|
+
status: import("zod").ZodEnum<{
|
|
30
|
+
completed: "completed";
|
|
31
|
+
failed: "failed";
|
|
32
|
+
in_progress: "in_progress";
|
|
33
|
+
}>;
|
|
34
|
+
}, import("zod/v4/core").$strip>>;
|
|
35
|
+
import: import("zod").ZodNullable<import("zod").ZodObject<{
|
|
36
|
+
processId: import("zod").ZodString;
|
|
37
|
+
status: import("zod").ZodEnum<{
|
|
38
|
+
completed: "completed";
|
|
39
|
+
failed: "failed";
|
|
40
|
+
in_progress: "in_progress";
|
|
41
|
+
}>;
|
|
42
|
+
}, import("zod/v4/core").$strip>>;
|
|
69
43
|
}, import("zod/v4/core").$strip>>;
|
|
70
44
|
}, import("zod/v4/core").$strip>>;
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
400: import("zod").ZodObject<{
|
|
75
|
-
message: import("zod").ZodString;
|
|
76
|
-
code: import("zod").ZodString;
|
|
77
|
-
errorCode: import("zod").ZodString;
|
|
78
|
-
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
79
|
-
}, import("zod/v4/core").$strip>;
|
|
80
|
-
401: import("zod").ZodObject<{
|
|
81
|
-
statusCode: import("zod").ZodNumber;
|
|
82
|
-
payload: import("zod").ZodObject<{
|
|
45
|
+
totalCount: import("zod").ZodNumber;
|
|
46
|
+
}, import("zod/v4/core").$strip>;
|
|
47
|
+
400: import("zod").ZodObject<{
|
|
83
48
|
message: import("zod").ZodString;
|
|
84
49
|
code: import("zod").ZodString;
|
|
85
50
|
errorCode: import("zod").ZodString;
|
|
86
51
|
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
87
52
|
}, import("zod/v4/core").$strip>;
|
|
88
|
-
|
|
89
|
-
|
|
53
|
+
401: import("zod").ZodObject<{
|
|
54
|
+
statusCode: import("zod").ZodNumber;
|
|
55
|
+
payload: import("zod").ZodObject<{
|
|
56
|
+
message: import("zod").ZodString;
|
|
57
|
+
code: import("zod").ZodString;
|
|
58
|
+
errorCode: import("zod").ZodString;
|
|
59
|
+
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
60
|
+
}, import("zod/v4/core").$strip>;
|
|
61
|
+
}, import("zod/v4/core").$strip>;
|
|
62
|
+
};
|
|
63
|
+
readonly requestHeaderSchema: import("zod").ZodObject<{
|
|
64
|
+
authorization: import("zod").ZodOptional<import("zod").ZodString>;
|
|
65
|
+
}, import("zod/v4/core").$loose>;
|
|
66
|
+
}, "visibility"> & {
|
|
67
|
+
visibility: import("@lokalise/api-contracts").RouteVisibility;
|
|
68
|
+
};
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { defineApiContract } from '@lokalise/api-contracts';
|
|
2
2
|
import { AUTHORIZATION_HEADER_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA_V2, } from '../commonRequestSchemas.js';
|
|
3
3
|
import { GET_CACHE_ITEM_LANGUAGE_STATUSES_BODY_SCHEMA, GET_CACHE_ITEM_LANGUAGE_STATUSES_RESPONSE_SCHEMA, } from './cacheSchemas.js';
|
|
4
|
-
export const getCacheItemLanguageStatusesContract =
|
|
4
|
+
export const getCacheItemLanguageStatusesContract = defineApiContract({
|
|
5
5
|
visibility: 'internal',
|
|
6
6
|
method: 'post',
|
|
7
|
+
summary: 'Get cache item language statuses',
|
|
7
8
|
description: 'Get CacheItemLanguage statuses for multiple items',
|
|
8
9
|
pathResolver: () => '/v1/cache-item-languages/statuses',
|
|
9
10
|
requestBodySchema: GET_CACHE_ITEM_LANGUAGE_STATUSES_BODY_SCHEMA,
|
|
10
|
-
|
|
11
|
-
responseSchemasByStatusCode: {
|
|
11
|
+
responsesByStatusCode: {
|
|
12
12
|
200: GET_CACHE_ITEM_LANGUAGE_STATUSES_RESPONSE_SCHEMA,
|
|
13
13
|
400: COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
14
14
|
401: COMMON_ERROR_RESPONSE_SCHEMA,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cacheApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/cache/cacheApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,4CAA4C,EAC5C,gDAAgD,GACjD,MAAM,mBAAmB,CAAA;AAE1B,MAAM,CAAC,MAAM,oCAAoC,GAAG,iBAAiB,CAAC;IACpE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,MAAM;IACd,WAAW,EAAE,mDAAmD;IAChE,YAAY,EAAE,GAAG,EAAE,CAAC,mCAAmC;IACvD,iBAAiB,EAAE,4CAA4C;IAC/D,
|
|
1
|
+
{"version":3,"file":"cacheApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/cache/cacheApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,4CAA4C,EAC5C,gDAAgD,GACjD,MAAM,mBAAmB,CAAA;AAE1B,MAAM,CAAC,MAAM,oCAAoC,GAAG,iBAAiB,CAAC;IACpE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,MAAM;IACd,OAAO,EAAE,kCAAkC;IAC3C,WAAW,EAAE,mDAAmD;IAChE,YAAY,EAAE,GAAG,EAAE,CAAC,mCAAmC;IACvD,iBAAiB,EAAE,4CAA4C;IAC/D,qBAAqB,EAAE;QACrB,GAAG,EAAE,gDAAgD;QACrD,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod/v4';
|
|
2
2
|
export declare const AUTHORIZATION_HEADER_SCHEMA: z.ZodObject<{
|
|
3
3
|
authorization: z.ZodOptional<z.ZodString>;
|
|
4
|
-
}, z.core.$
|
|
4
|
+
}, z.core.$loose>;
|
|
5
5
|
/**
|
|
6
6
|
* @deprecated Schema for error responses used in older Lokalise APIs.
|
|
7
7
|
* This format is maintained for backward compatibility.
|
|
@@ -2,7 +2,9 @@ import { z } from 'zod/v4';
|
|
|
2
2
|
// z.compile() swaps in an ahead-of-time compiled parser without changing the schema's type,
|
|
3
3
|
// inference or JSON Schema output. Worth it here: these three schemas are referenced by nearly
|
|
4
4
|
// every contract in the package, so they are parsed on almost every request and error response.
|
|
5
|
-
export const AUTHORIZATION_HEADER_SCHEMA = z.compile(
|
|
5
|
+
export const AUTHORIZATION_HEADER_SCHEMA = z.compile(
|
|
6
|
+
// Loose so the other request headers (content-type, user-agent, ...) survive validation.
|
|
7
|
+
z.looseObject({
|
|
6
8
|
/** Optional for backwards compatibility purposes, as previously there was no auth headers schema validation */
|
|
7
9
|
authorization: z.string().optional(),
|
|
8
10
|
}));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"commonRequestSchemas.js","sourceRoot":"","sources":["../../src/schemas/commonRequestSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,4FAA4F;AAC5F,+FAA+F;AAC/F,gGAAgG;AAChG,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"commonRequestSchemas.js","sourceRoot":"","sources":["../../src/schemas/commonRequestSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,4FAA4F;AAC5F,+FAA+F;AAC/F,gGAAgG;AAChG,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,OAAO;AAClD,yFAAyF;AACzF,CAAC,CAAC,WAAW,CAAC;IACZ,+GAA+G;IAC/G,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CACH,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,OAAO,CACnD,CAAC,CAAC,MAAM,CAAC;IACP,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,sEAAsE;QACtE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;QACrB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;KAClD,CAAC;CACH,CAAC,CACH,CAAA;AASD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,OAAO,CACtD,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,sEAAsE;IACtE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CAClD,CAAC,CACH,CAAA"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { z } from 'zod/v4';
|
|
2
1
|
/**
|
|
3
2
|
* Contract for getting integration configuration
|
|
4
3
|
* GET /v1/integrations/{integrationId}/config
|
|
@@ -11,36 +10,41 @@ import { z } from 'zod/v4';
|
|
|
11
10
|
* - Display current scope/configuration in the Platform UI
|
|
12
11
|
* - Retrieve settings before performing import/sync operations
|
|
13
12
|
*/
|
|
14
|
-
export declare const getIntegrationConfigContract:
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
},
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
}
|
|
43
|
-
|
|
13
|
+
export declare const getIntegrationConfigContract: Omit<{
|
|
14
|
+
readonly visibility: "internal";
|
|
15
|
+
readonly method: "get";
|
|
16
|
+
readonly pathResolver: (params: {
|
|
17
|
+
integrationId: string;
|
|
18
|
+
}) => string;
|
|
19
|
+
readonly summary: "Get integration configuration";
|
|
20
|
+
readonly description: "Get the current configuration for an integration";
|
|
21
|
+
readonly requestPathParamsSchema: import("zod").ZodObject<{
|
|
22
|
+
integrationId: import("zod").ZodGUID;
|
|
23
|
+
}, import("zod/v4/core").$strip>;
|
|
24
|
+
readonly responsesByStatusCode: {
|
|
25
|
+
200: import("zod").ZodObject<{
|
|
26
|
+
itemGroupIds: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
27
|
+
metadata: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
28
|
+
}, import("zod/v4/core").$strip>;
|
|
29
|
+
401: import("zod").ZodObject<{
|
|
30
|
+
message: import("zod").ZodString;
|
|
31
|
+
code: import("zod").ZodString;
|
|
32
|
+
errorCode: import("zod").ZodString;
|
|
33
|
+
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
34
|
+
}, import("zod/v4/core").$strip>;
|
|
35
|
+
404: import("zod").ZodObject<{
|
|
36
|
+
message: import("zod").ZodString;
|
|
37
|
+
code: import("zod").ZodString;
|
|
38
|
+
errorCode: import("zod").ZodString;
|
|
39
|
+
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
40
|
+
}, import("zod/v4/core").$strip>;
|
|
41
|
+
};
|
|
42
|
+
readonly requestHeaderSchema: import("zod").ZodObject<{
|
|
43
|
+
authorization: import("zod").ZodOptional<import("zod").ZodString>;
|
|
44
|
+
}, import("zod/v4/core").$loose>;
|
|
45
|
+
}, "visibility"> & {
|
|
46
|
+
visibility: import("@lokalise/api-contracts").RouteVisibility;
|
|
47
|
+
};
|
|
44
48
|
/**
|
|
45
49
|
* Contract for updating integration configuration
|
|
46
50
|
* PUT /v1/integrations/{integrationId}/config
|
|
@@ -55,42 +59,48 @@ export declare const getIntegrationConfigContract: import("@lokalise/api-contrac
|
|
|
55
59
|
*
|
|
56
60
|
* The entire config object is replaced (not merged) on each PUT.
|
|
57
61
|
*/
|
|
58
|
-
export declare const putIntegrationConfigContract:
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
}
|
|
62
|
+
export declare const putIntegrationConfigContract: Omit<{
|
|
63
|
+
readonly visibility: "internal";
|
|
64
|
+
readonly method: "put";
|
|
65
|
+
readonly pathResolver: (params: {
|
|
66
|
+
integrationId: string;
|
|
67
|
+
}) => string;
|
|
68
|
+
readonly summary: "Update integration configuration";
|
|
69
|
+
readonly description: "Update the configuration for an integration";
|
|
70
|
+
readonly requestPathParamsSchema: import("zod").ZodObject<{
|
|
71
|
+
integrationId: import("zod").ZodGUID;
|
|
72
|
+
}, import("zod/v4/core").$strip>;
|
|
73
|
+
readonly requestBodySchema: import("zod").ZodObject<{
|
|
74
|
+
itemGroupIds: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
75
|
+
metadata: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
76
|
+
}, import("zod/v4/core").$strip>;
|
|
77
|
+
readonly responsesByStatusCode: {
|
|
78
|
+
200: import("zod").ZodObject<{
|
|
79
|
+
itemGroupIds: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
|
|
80
|
+
metadata: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
81
|
+
}, import("zod/v4/core").$strip>;
|
|
82
|
+
400: import("zod").ZodObject<{
|
|
83
|
+
message: import("zod").ZodString;
|
|
84
|
+
code: import("zod").ZodString;
|
|
85
|
+
errorCode: import("zod").ZodString;
|
|
86
|
+
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
87
|
+
}, import("zod/v4/core").$strip>;
|
|
88
|
+
401: import("zod").ZodObject<{
|
|
89
|
+
message: import("zod").ZodString;
|
|
90
|
+
code: import("zod").ZodString;
|
|
91
|
+
errorCode: import("zod").ZodString;
|
|
92
|
+
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
93
|
+
}, import("zod/v4/core").$strip>;
|
|
94
|
+
404: import("zod").ZodObject<{
|
|
95
|
+
message: import("zod").ZodString;
|
|
96
|
+
code: import("zod").ZodString;
|
|
97
|
+
errorCode: import("zod").ZodString;
|
|
98
|
+
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
99
|
+
}, import("zod/v4/core").$strip>;
|
|
100
|
+
};
|
|
101
|
+
readonly requestHeaderSchema: import("zod").ZodObject<{
|
|
102
|
+
authorization: import("zod").ZodOptional<import("zod").ZodString>;
|
|
103
|
+
}, import("zod/v4/core").$loose>;
|
|
104
|
+
}, "visibility"> & {
|
|
105
|
+
visibility: import("@lokalise/api-contracts").RouteVisibility;
|
|
106
|
+
};
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { z } from 'zod/v4';
|
|
1
|
+
import { defineApiContract } from '@lokalise/api-contracts';
|
|
3
2
|
import { AUTHORIZATION_HEADER_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA_V2, } from '../commonRequestSchemas.js';
|
|
4
3
|
import { GET_INTEGRATION_CONFIG_RESPONSE_SCHEMA, INTEGRATION_CONFIG_PATH_PARAMS_SCHEMA, PUT_INTEGRATION_CONFIG_BODY_SCHEMA, PUT_INTEGRATION_CONFIG_RESPONSE_SCHEMA, } from './integrationConfigSchemas.js';
|
|
5
4
|
/**
|
|
@@ -14,16 +13,14 @@ import { GET_INTEGRATION_CONFIG_RESPONSE_SCHEMA, INTEGRATION_CONFIG_PATH_PARAMS_
|
|
|
14
13
|
* - Display current scope/configuration in the Platform UI
|
|
15
14
|
* - Retrieve settings before performing import/sync operations
|
|
16
15
|
*/
|
|
17
|
-
export const getIntegrationConfigContract =
|
|
16
|
+
export const getIntegrationConfigContract = defineApiContract({
|
|
18
17
|
visibility: 'internal',
|
|
18
|
+
method: 'get',
|
|
19
19
|
pathResolver: (params) => `/v1/integrations/${params.integrationId}/config`,
|
|
20
|
+
summary: 'Get integration configuration',
|
|
20
21
|
description: 'Get the current configuration for an integration',
|
|
21
22
|
requestPathParamsSchema: INTEGRATION_CONFIG_PATH_PARAMS_SCHEMA,
|
|
22
|
-
|
|
23
|
-
GET_INTEGRATION_CONFIG_RESPONSE_SCHEMA,
|
|
24
|
-
COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
25
|
-
]),
|
|
26
|
-
responseSchemasByStatusCode: {
|
|
23
|
+
responsesByStatusCode: {
|
|
27
24
|
200: GET_INTEGRATION_CONFIG_RESPONSE_SCHEMA,
|
|
28
25
|
401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
29
26
|
404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
@@ -44,18 +41,15 @@ export const getIntegrationConfigContract = buildGetRoute({
|
|
|
44
41
|
*
|
|
45
42
|
* The entire config object is replaced (not merged) on each PUT.
|
|
46
43
|
*/
|
|
47
|
-
export const putIntegrationConfigContract =
|
|
44
|
+
export const putIntegrationConfigContract = defineApiContract({
|
|
48
45
|
visibility: 'internal',
|
|
49
46
|
method: 'put',
|
|
50
47
|
pathResolver: (params) => `/v1/integrations/${params.integrationId}/config`,
|
|
48
|
+
summary: 'Update integration configuration',
|
|
51
49
|
description: 'Update the configuration for an integration',
|
|
52
50
|
requestPathParamsSchema: INTEGRATION_CONFIG_PATH_PARAMS_SCHEMA,
|
|
53
51
|
requestBodySchema: PUT_INTEGRATION_CONFIG_BODY_SCHEMA,
|
|
54
|
-
|
|
55
|
-
PUT_INTEGRATION_CONFIG_RESPONSE_SCHEMA,
|
|
56
|
-
COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
57
|
-
]),
|
|
58
|
-
responseSchemasByStatusCode: {
|
|
52
|
+
responsesByStatusCode: {
|
|
59
53
|
200: PUT_INTEGRATION_CONFIG_RESPONSE_SCHEMA,
|
|
60
54
|
400: COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
61
55
|
401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"integrationConfigApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/config/integrationConfigApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"integrationConfigApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/config/integrationConfigApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,sCAAsC,EACtC,qCAAqC,EACrC,kCAAkC,EAClC,sCAAsC,GACvC,MAAM,+BAA+B,CAAA;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;IAC5D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,SAAS;IAC3E,OAAO,EAAE,+BAA+B;IACxC,WAAW,EAAE,kDAAkD;IAC/D,uBAAuB,EAAE,qCAAqC;IAC9D,qBAAqB,EAAE;QACrB,GAAG,EAAE,sCAAsC;QAC3C,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,iBAAiB,CAAC;IAC5D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,SAAS;IAC3E,OAAO,EAAE,kCAAkC;IAC3C,WAAW,EAAE,6CAA6C;IAC1D,uBAAuB,EAAE,qCAAqC;IAC9D,iBAAiB,EAAE,kCAAkC;IACrD,qBAAqB,EAAE;QACrB,GAAG,EAAE,sCAAsC;QAC3C,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
|