@lokalise/projects-engine-contracts 10.2.2 → 11.0.0

package/dist/apiContracts/projectSettingsContracts.d.ts

@@ -1,24 +1,57 @@
-export declare const getProjectSettingsContract: import("@lokalise/api-contracts").GetRouteDefinition<import("zod").ZodObject<{
-    data: import("zod").ZodObject<{
-        timezone: import("zod").ZodString;
+export declare const getProjectSettingsContract: Omit<{
+    readonly visibility: "internal";
+    readonly method: "get";
+    readonly pathResolver: (params: {
+        workspaceId: string;
+        projectId: string;
+    }) => string;
+    readonly summary: "Get project settings";
+    readonly description: "Get project settings - returns the project-level attributes (e.g. the timezone used to compute task due dates)";
+    readonly requestHeaderSchema: import("zod").ZodObject<{
+        authorization: import("zod").ZodString;
+        'content-type': import("zod").ZodOptional<import("zod").ZodString>;
+    }, import("zod/v4/core").$strip>;
+    readonly requestPathParamsSchema: import("zod").ZodObject<{
+        workspaceId: import("zod").ZodGUID;
+        projectId: import("zod").ZodGUID;
+    }, import("zod/v4/core").$strip>;
+    readonly responsesByStatusCode: {
+        200: import("zod").ZodObject<{
+            data: import("zod").ZodObject<{
+                timezone: import("zod").ZodString;
+            }, import("zod/v4/core").$strip>;
+        }, import("zod/v4/core").$strip>;
+    };
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};
+export declare const putProjectSettingsContract: Omit<{
+    readonly visibility: "internal";
+    readonly method: "put";
+    readonly pathResolver: (params: {
+        workspaceId: string;
+        projectId: string;
+    }) => string;
+    readonly summary: "Create or update project settings";
+    readonly description: "Store the project-level settings (e.g. the timezone) for a project. Creates new settings or updates existing ones.";
+    readonly requestHeaderSchema: import("zod").ZodObject<{
+        authorization: import("zod").ZodString;
+        'content-type': import("zod").ZodOptional<import("zod").ZodString>;
+    }, import("zod/v4/core").$strip>;
+    readonly requestPathParamsSchema: import("zod").ZodObject<{
+        workspaceId: import("zod").ZodGUID;
+        projectId: import("zod").ZodGUID;
     }, import("zod/v4/core").$strip>;
-}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
-    workspaceId: import("zod").ZodGUID;
-    projectId: import("zod").ZodGUID;
-}, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
-    authorization: import("zod").ZodString;
-    'content-type': import("zod").ZodOptional<import("zod").ZodString>;
-}, import("zod/v4/core").$strip>, undefined, false, false, undefined>;
-export declare const putProjectSettingsContract: import("@lokalise/api-contracts").PayloadRouteDefinition<import("zod").ZodObject<{
-    timezone: import("zod").ZodString;
-}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
-    data: import("zod").ZodObject<{
+    readonly requestBodySchema: import("zod").ZodObject<{
         timezone: import("zod").ZodString;
     }, import("zod/v4/core").$strip>;
-}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
-    workspaceId: import("zod").ZodGUID;
-    projectId: import("zod").ZodGUID;
-}, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
-    authorization: import("zod").ZodString;
-    'content-type': import("zod").ZodOptional<import("zod").ZodString>;
-}, import("zod/v4/core").$strip>, undefined, false, false, undefined>;
+    readonly responsesByStatusCode: {
+        200: import("zod").ZodObject<{
+            data: import("zod").ZodObject<{
+                timezone: import("zod").ZodString;
+            }, import("zod/v4/core").$strip>;
+        }, import("zod/v4/core").$strip>;
+    };
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};

package/dist/apiContracts/projectSettingsContracts.js

@@ -1,16 +1,19 @@
-import { buildRestContract } from '@lokalise/api-contracts';
+import { defineApiContract } from '@lokalise/api-contracts';
 import { AUTH_HEADERS } from '../schemas/domainSchemas.js';
 import { GET_PROJECT_SETTINGS_PATH_PARAMS_SCHEMA, GET_PROJECT_SETTINGS_SUCCESS_RESPONSE_BODY, PUT_PROJECT_SETTINGS_PATH_PARAMS_SCHEMA, PUT_PROJECT_SETTINGS_REQUEST_BODY_SCHEMA, PUT_PROJECT_SETTINGS_SUCCESS_RESPONSE_BODY, } from '../schemas/projectSettingsSchemas.js';
-export const getProjectSettingsContract = buildRestContract({
+export const getProjectSettingsContract = defineApiContract({
     visibility: 'internal',
     method: 'get',
     pathResolver: (params) => `/v1/workspaces/${params.workspaceId}/projects/${params.projectId}/project-settings`,
+    summary: 'Get project settings',
     description: 'Get project settings - returns the project-level attributes (e.g. the timezone used to compute task due dates)',
     requestHeaderSchema: AUTH_HEADERS,
     requestPathParamsSchema: GET_PROJECT_SETTINGS_PATH_PARAMS_SCHEMA,
-    successResponseBodySchema: GET_PROJECT_SETTINGS_SUCCESS_RESPONSE_BODY,
+    responsesByStatusCode: {
+        200: GET_PROJECT_SETTINGS_SUCCESS_RESPONSE_BODY,
+    },
 });
-export const putProjectSettingsContract = buildRestContract({
+export const putProjectSettingsContract = defineApiContract({
     visibility: 'internal',
     method: 'put',
     pathResolver: (params) => `/v1/workspaces/${params.workspaceId}/projects/${params.projectId}/project-settings`,
@@ -19,6 +22,8 @@ export const putProjectSettingsContract = buildRestContract({
     requestHeaderSchema: AUTH_HEADERS,
     requestPathParamsSchema: PUT_PROJECT_SETTINGS_PATH_PARAMS_SCHEMA,
     requestBodySchema: PUT_PROJECT_SETTINGS_REQUEST_BODY_SCHEMA,
-    successResponseBodySchema: PUT_PROJECT_SETTINGS_SUCCESS_RESPONSE_BODY,
+    responsesByStatusCode: {
+        200: PUT_PROJECT_SETTINGS_SUCCESS_RESPONSE_BODY,
+    },
 });
 //# sourceMappingURL=projectSettingsContracts.js.map

package/dist/apiContracts/projectSettingsContracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"projectSettingsContracts.js","sourceRoot":"","sources":["../../src/apiContracts/projectSettingsContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,uCAAuC,EACvC,0CAA0C,EAC1C,uCAAuC,EACvC,wCAAwC,EACxC,0CAA0C,GAC3C,MAAM,sCAAsC,CAAA;AAE7C,MAAM,CAAC,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IAC1D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CACvB,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,mBAAmB;IACtF,WAAW,EACT,gHAAgH;IAClH,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,uCAAuC;IAChE,yBAAyB,EAAE,0CAA0C;CACtE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IAC1D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CACvB,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,mBAAmB;IACtF,OAAO,EAAE,mCAAmC;IAC5C,WAAW,EACT,oHAAoH;IACtH,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,uCAAuC;IAChE,iBAAiB,EAAE,wCAAwC;IAC3D,yBAAyB,EAAE,0CAA0C;CACtE,CAAC,CAAA"}
+{"version":3,"file":"projectSettingsContracts.js","sourceRoot":"","sources":["../../src/apiContracts/projectSettingsContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,uCAAuC,EACvC,0CAA0C,EAC1C,uCAAuC,EACvC,wCAAwC,EACxC,0CAA0C,GAC3C,MAAM,sCAAsC,CAAA;AAE7C,MAAM,CAAC,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IAC1D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CACvB,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,mBAAmB;IACtF,OAAO,EAAE,sBAAsB;IAC/B,WAAW,EACT,gHAAgH;IAClH,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,uCAAuC;IAChE,qBAAqB,EAAE;QACrB,GAAG,EAAE,0CAA0C;KAChD;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IAC1D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CACvB,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,mBAAmB;IACtF,OAAO,EAAE,mCAAmC;IAC5C,WAAW,EACT,oHAAoH;IACtH,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,uCAAuC;IAChE,iBAAiB,EAAE,wCAAwC;IAC3D,qBAAqB,EAAE;QACrB,GAAG,EAAE,0CAA0C;KAChD;CACF,CAAC,CAAA"}