@lokalise/content-type-app-engine-contracts 5.36.0 → 5.38.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.
@@ -1,13 +1,16 @@
1
1
  import { buildRestContract } from '@lokalise/api-contracts';
2
2
  import { z } from 'zod';
3
3
  import { AUTHORIZATION_HEADER_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA_V2, } from '../commonRequestSchemas.js';
4
- import { BULK_DELETE_SCHEDULES_REQUEST_BODY, EXECUTIONS_RESPONSE, LEGACY_UPDATE_SCHEDULE_REQUEST_BODY, SCHEDULE_CONFIG_RESPONSE, SCHEDULE_LIST_RESPONSE, SCHEDULE_PATH_PARAMS, SCHEDULE_UPDATE_REQUEST_BODY, SCHEDULE_UPDATE_RESPONSE, UPDATE_SCHEDULE_REQUEST_BODY, } from './scheduleSchemas.js';
4
+ import { BULK_DELETE_SCHEDULES_REQUEST_BODY, EXECUTIONS_RESPONSE, LEGACY_SCHEDULE_CONFIG_RESPONSE, LEGACY_UPDATE_SCHEDULE_REQUEST_BODY, SCHEDULE_CONFIG_RESPONSE, SCHEDULE_LIST_RESPONSE, SCHEDULE_PATH_PARAMS, SCHEDULE_UPDATE_REQUEST_BODY, SCHEDULE_UPDATE_RESPONSE, UPDATE_SCHEDULE_REQUEST_BODY, } from './scheduleSchemas.js';
5
+ /**
6
+ * @deprecated Use {@link getScheduleListContract} instead.
7
+ */
5
8
  export const getScheduleConfigContract = buildRestContract({
6
9
  visibility: 'internal',
7
10
  method: 'get',
8
- summary: 'Get schedule configuration',
9
- description: 'Get the auto import/export schedule configuration for the current link',
10
- successResponseBodySchema: SCHEDULE_CONFIG_RESPONSE,
11
+ summary: 'Get schedule configuration (deprecated)',
12
+ description: 'Deprecated: use GET /v1/schedules. Get the auto import/export schedule configuration for the current link.',
13
+ successResponseBodySchema: LEGACY_SCHEDULE_CONFIG_RESPONSE,
11
14
  requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
12
15
  pathResolver: () => '/v1/schedule',
13
16
  });
@@ -20,7 +23,7 @@ export const putScheduleConfigContract = buildRestContract({
20
23
  summary: 'Update schedule configuration (deprecated)',
21
24
  description: 'Deprecated: use PUT /v1/schedules. Create or update the auto import/export schedule for the current link.',
22
25
  requestBodySchema: LEGACY_UPDATE_SCHEDULE_REQUEST_BODY,
23
- successResponseBodySchema: SCHEDULE_CONFIG_RESPONSE,
26
+ successResponseBodySchema: LEGACY_SCHEDULE_CONFIG_RESPONSE,
24
27
  responseSchemasByStatusCode: {
25
28
  400: COMMON_ERROR_RESPONSE_SCHEMA_V2,
26
29
  409: COMMON_ERROR_RESPONSE_SCHEMA_V2,
@@ -76,19 +79,69 @@ export const getScheduleExecutionsContract = buildRestContract({
76
79
  requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
77
80
  pathResolver: () => '/v1/schedules/executions',
78
81
  });
79
- export const bulkDeleteSchedulesContract = buildRestContract({
82
+ const INTEGRATION_SCHEDULE_PATH_PARAMS = z.object({
83
+ integrationId: z.guid(),
84
+ });
85
+ export const putIntegrationSchedulesContract = buildRestContract({
86
+ visibility: 'internal',
87
+ method: 'put',
88
+ summary: 'Update integration schedule configuration',
89
+ description: 'Create or update auto import/export schedules for an integration',
90
+ requestBodySchema: UPDATE_SCHEDULE_REQUEST_BODY,
91
+ successResponseBodySchema: SCHEDULE_CONFIG_RESPONSE,
92
+ responseSchemasByStatusCode: {
93
+ 400: COMMON_ERROR_RESPONSE_SCHEMA_V2,
94
+ 401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
95
+ 404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
96
+ 409: COMMON_ERROR_RESPONSE_SCHEMA_V2,
97
+ },
98
+ requestPathParamsSchema: INTEGRATION_SCHEDULE_PATH_PARAMS,
99
+ requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
100
+ pathResolver: ({ integrationId }) => `/v1/integrations/${integrationId}/schedules`,
101
+ });
102
+ export const getIntegrationScheduleListContract = buildRestContract({
103
+ visibility: 'internal',
104
+ method: 'get',
105
+ summary: 'List integration schedule configurations',
106
+ description: 'List all auto import/export schedules for an integration',
107
+ successResponseBodySchema: SCHEDULE_LIST_RESPONSE,
108
+ responseSchemasByStatusCode: {
109
+ 401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
110
+ 404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
111
+ },
112
+ requestPathParamsSchema: INTEGRATION_SCHEDULE_PATH_PARAMS,
113
+ requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
114
+ pathResolver: ({ integrationId }) => `/v1/integrations/${integrationId}/schedules`,
115
+ });
116
+ export const getIntegrationScheduleExecutionsContract = buildRestContract({
117
+ visibility: 'internal',
118
+ method: 'get',
119
+ summary: 'Get integration schedule executions',
120
+ description: 'Get execution history for integration schedules',
121
+ successResponseBodySchema: EXECUTIONS_RESPONSE,
122
+ responseSchemasByStatusCode: {
123
+ 401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
124
+ 404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
125
+ },
126
+ requestPathParamsSchema: INTEGRATION_SCHEDULE_PATH_PARAMS,
127
+ requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
128
+ pathResolver: ({ integrationId }) => `/v1/integrations/${integrationId}/schedules/executions`,
129
+ });
130
+ export const bulkDeleteIntegrationSchedulesContract = buildRestContract({
80
131
  visibility: 'internal',
81
132
  method: 'post',
82
- summary: 'Delete schedule configurations',
83
- description: 'Atomically delete schedules and their unreferenced filters by schedule IDs',
133
+ summary: 'Delete integration schedule configurations',
134
+ description: 'Atomically delete integration schedules and their unreferenced filters by IDs',
84
135
  requestBodySchema: BULK_DELETE_SCHEDULES_REQUEST_BODY,
85
136
  successResponseBodySchema: z.undefined(),
86
137
  isEmptyResponseExpected: true,
87
138
  responseSchemasByStatusCode: {
88
139
  400: COMMON_ERROR_RESPONSE_SCHEMA_V2,
140
+ 401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
89
141
  404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
90
142
  },
143
+ requestPathParamsSchema: INTEGRATION_SCHEDULE_PATH_PARAMS,
91
144
  requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
92
- pathResolver: () => '/v1/schedules/actions/bulk-delete',
145
+ pathResolver: ({ integrationId }) => `/v1/integrations/${integrationId}/schedules/actions/bulk-delete`,
93
146
  });
94
147
  //# sourceMappingURL=scheduleApiSchemas.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"scheduleApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/schedule/scheduleApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,kCAAkC,EAClC,mBAAmB,EACnB,mCAAmC,EACnC,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,4BAA4B,EAC5B,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,sBAAsB,CAAA;AAE7B,MAAM,CAAC,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACzD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,4BAA4B;IACrC,WAAW,EAAE,wEAAwE;IACrF,yBAAyB,EAAE,wBAAwB;IACnD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,cAAc;CACnC,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACzD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,4CAA4C;IACrD,WAAW,EACT,2GAA2G;IAC7G,iBAAiB,EAAE,mCAAmC;IACtD,yBAAyB,EAAE,wBAAwB;IACnD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,cAAc;CACnC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,+BAA+B;IACxC,WAAW,EAAE,uEAAuE;IACpF,iBAAiB,EAAE,4BAA4B;IAC/C,yBAAyB,EAAE,wBAAwB;IACnD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,eAAe;CACpC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,8BAA8B;IACvC,WAAW,EAAE,mEAAmE;IAChF,yBAAyB,EAAE,sBAAsB;IACjD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,eAAe;CACpC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,iCAAiC;IAC1C,WAAW,EAAE,4CAA4C;IACzD,iBAAiB,EAAE,4BAA4B;IAC/C,yBAAyB,EAAE,wBAAwB;IACnD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,uBAAuB,EAAE,oBAAoB;IAC7C,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,iBAAiB,UAAU,EAAE;CAChE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;IAC7D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,yBAAyB;IAClC,WAAW,EAAE,qDAAqD;IAClE,yBAAyB,EAAE,mBAAmB;IAC9C,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,0BAA0B;CAC/C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;IAC3D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,MAAM;IACd,OAAO,EAAE,gCAAgC;IACzC,WAAW,EAAE,4EAA4E;IACzF,iBAAiB,EAAE,kCAAkC;IACrD,yBAAyB,EAAE,CAAC,CAAC,SAAS,EAAE;IACxC,uBAAuB,EAAE,IAAI;IAC7B,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,mCAAmC;CACxD,CAAC,CAAA"}
1
+ {"version":3,"file":"scheduleApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/schedule/scheduleApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,kCAAkC,EAClC,mBAAmB,EACnB,+BAA+B,EAC/B,mCAAmC,EACnC,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,4BAA4B,EAC5B,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,sBAAsB,CAAA;AAE7B;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACzD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,yCAAyC;IAClD,WAAW,EACT,4GAA4G;IAC9G,yBAAyB,EAAE,+BAA+B;IAC1D,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,cAAc;CACnC,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACzD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,4CAA4C;IACrD,WAAW,EACT,2GAA2G;IAC7G,iBAAiB,EAAE,mCAAmC;IACtD,yBAAyB,EAAE,+BAA+B;IAC1D,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,cAAc;CACnC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,+BAA+B;IACxC,WAAW,EAAE,uEAAuE;IACpF,iBAAiB,EAAE,4BAA4B;IAC/C,yBAAyB,EAAE,wBAAwB;IACnD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,eAAe;CACpC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,8BAA8B;IACvC,WAAW,EAAE,mEAAmE;IAChF,yBAAyB,EAAE,sBAAsB;IACjD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,eAAe;CACpC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,iCAAiC;IAC1C,WAAW,EAAE,4CAA4C;IACzD,iBAAiB,EAAE,4BAA4B;IAC/C,yBAAyB,EAAE,wBAAwB;IACnD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,uBAAuB,EAAE,oBAAoB;IAC7C,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,iBAAiB,UAAU,EAAE;CAChE,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;IAC7D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,yBAAyB;IAClC,WAAW,EAAE,qDAAqD;IAClE,yBAAyB,EAAE,mBAAmB;IAC9C,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,GAAG,EAAE,CAAC,0BAA0B;CAC/C,CAAC,CAAA;AAEF,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,aAAa,EAAE,CAAC,CAAC,IAAI,EAAE;CACxB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;IAC/D,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,2CAA2C;IACpD,WAAW,EAAE,kEAAkE;IAC/E,iBAAiB,EAAE,4BAA4B;IAC/C,yBAAyB,EAAE,wBAAwB;IACnD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,uBAAuB,EAAE,gCAAgC;IACzD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,oBAAoB,aAAa,YAAY;CACnF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;IAClE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,0CAA0C;IACnD,WAAW,EAAE,0DAA0D;IACvE,yBAAyB,EAAE,sBAAsB;IACjD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,uBAAuB,EAAE,gCAAgC;IACzD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,oBAAoB,aAAa,YAAY;CACnF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,wCAAwC,GAAG,iBAAiB,CAAC;IACxE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,qCAAqC;IAC9C,WAAW,EAAE,iDAAiD;IAC9D,yBAAyB,EAAE,mBAAmB;IAC9C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,uBAAuB,EAAE,gCAAgC;IACzD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,oBAAoB,aAAa,uBAAuB;CAC9F,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAAG,iBAAiB,CAAC;IACtE,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,MAAM;IACd,OAAO,EAAE,4CAA4C;IACrD,WAAW,EAAE,+EAA+E;IAC5F,iBAAiB,EAAE,kCAAkC;IACrD,yBAAyB,EAAE,CAAC,CAAC,SAAS,EAAE;IACxC,uBAAuB,EAAE,IAAI;IAC7B,2BAA2B,EAAE;QAC3B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,uBAAuB,EAAE,gCAAgC;IACzD,mBAAmB,EAAE,2BAA2B;IAChD,YAAY,EAAE,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAClC,oBAAoB,aAAa,gCAAgC;CACpE,CAAC,CAAA"}