@lokalise/content-type-app-engine-contracts 1.0.2

package/dist/schemas/content/contentApiSchemas.d.ts

@@ -0,0 +1,729 @@
+import { z } from 'zod';
+export declare const postGetContentContract: import("@lokalise/api-contracts").PayloadRouteDefinition<never, z.ZodObject<{
+    page: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    searchQuery: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodArray<z.ZodNativeEnum<{
+        Untranslated: string;
+        InProgress: string;
+        Completed: string;
+        Published: string;
+    }>, "many">>;
+    filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        relation: z.ZodNativeEnum<{
+            AND: string;
+            OR: string;
+        }>;
+        object: z.ZodString;
+        option: z.ZodNativeEnum<{
+            equals: string;
+            notEquals: string;
+            contains: string;
+            containsAll: string;
+            notContainsAll: string;
+            startsWith: string;
+            endsWith: string;
+        }>;
+        values: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "atleastone">;
+    }, "strip", z.ZodTypeAny, {
+        object: string;
+        values: [string | number, ...(string | number)[]];
+        relation: string;
+        option: string;
+    }, {
+        object: string;
+        values: [string | number, ...(string | number)[]];
+        relation: string;
+        option: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    page: number;
+    limit: number;
+    status?: string[] | undefined;
+    searchQuery?: string | undefined;
+    filters?: {
+        object: string;
+        values: [string | number, ...(string | number)[]];
+        relation: string;
+        option: string;
+    }[] | undefined;
+}, {
+    status?: string[] | undefined;
+    page?: number | undefined;
+    limit?: number | undefined;
+    searchQuery?: string | undefined;
+    filters?: {
+        object: string;
+        values: [string | number, ...(string | number)[]];
+        relation: string;
+        option: string;
+    }[] | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    total: z.ZodNumber;
+    items: z.ZodArray<z.ZodObject<{
+        groupId: z.ZodString;
+        items: z.ZodArray<z.ZodObject<{
+            groupId: z.ZodString;
+            uniqueId: z.ZodString;
+            fields: z.ZodRecord<z.ZodString, z.ZodString>;
+            groupTitle: z.ZodOptional<z.ZodString>;
+            title: z.ZodOptional<z.ZodString>;
+            cacheItemLanguages: z.ZodArray<z.ZodObject<{
+                status: z.ZodNativeEnum<{
+                    Untranslated: string;
+                    InProgress: string;
+                    Completed: string;
+                    Published: string;
+                }>;
+                langIsoCode: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                status: string;
+                langIsoCode: string;
+            }, {
+                status: string;
+                langIsoCode: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            groupId: string;
+            uniqueId: string;
+            fields: Record<string, string>;
+            cacheItemLanguages: {
+                status: string;
+                langIsoCode: string;
+            }[];
+            groupTitle?: string | undefined;
+            title?: string | undefined;
+        }, {
+            groupId: string;
+            uniqueId: string;
+            fields: Record<string, string>;
+            cacheItemLanguages: {
+                status: string;
+                langIsoCode: string;
+            }[];
+            groupTitle?: string | undefined;
+            title?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        groupId: string;
+        items: {
+            groupId: string;
+            uniqueId: string;
+            fields: Record<string, string>;
+            cacheItemLanguages: {
+                status: string;
+                langIsoCode: string;
+            }[];
+            groupTitle?: string | undefined;
+            title?: string | undefined;
+        }[];
+    }, {
+        groupId: string;
+        items: {
+            groupId: string;
+            uniqueId: string;
+            fields: Record<string, string>;
+            cacheItemLanguages: {
+                status: string;
+                langIsoCode: string;
+            }[];
+            groupTitle?: string | undefined;
+            title?: string | undefined;
+        }[];
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        groupId: string;
+        items: {
+            groupId: string;
+            uniqueId: string;
+            fields: Record<string, string>;
+            cacheItemLanguages: {
+                status: string;
+                langIsoCode: string;
+            }[];
+            groupTitle?: string | undefined;
+            title?: string | undefined;
+        }[];
+    }[];
+    total: number;
+}, {
+    items: {
+        groupId: string;
+        items: {
+            groupId: string;
+            uniqueId: string;
+            fields: Record<string, string>;
+            cacheItemLanguages: {
+                status: string;
+                langIsoCode: string;
+            }[];
+            groupTitle?: string | undefined;
+            title?: string | undefined;
+        }[];
+    }[];
+    total: number;
+}>, z.ZodObject<{
+    statusCode: z.ZodNumber;
+    payload: z.ZodObject<{
+        message: z.ZodString;
+        errorCode: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}>]>, undefined, undefined, z.ZodObject<{
+    authorization: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    authorization?: string | undefined;
+}, {
+    authorization?: string | undefined;
+}>, false, false>;
+export declare const postRefreshContentContract: import("@lokalise/api-contracts").PayloadRouteDefinition<never, z.ZodNull, z.ZodUnion<[z.ZodObject<{
+    statusCode: z.ZodNumber;
+    message: z.ZodString;
+    jobId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}>, z.ZodObject<{
+    statusCode: z.ZodNumber;
+    payload: z.ZodObject<{
+        message: z.ZodString;
+        errorCode: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}>]>, undefined, undefined, z.ZodObject<{
+    authorization: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    authorization?: string | undefined;
+}, {
+    authorization?: string | undefined;
+}>, false, false>;
+export declare const partialRefreshContentContract: import("@lokalise/api-contracts").PayloadRouteDefinition<never, z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        updatedAtTimestamp: z.ZodOptional<z.ZodNumber>;
+        fields: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+        groupId: z.ZodString;
+        groupTitle: z.ZodString;
+        metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString, "many">]>>;
+        title: z.ZodString;
+        uniqueId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        fields: Record<string, string | number>;
+        groupTitle: string;
+        title: string;
+        updatedAtTimestamp?: number | undefined;
+    }, {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        fields: Record<string, string | number>;
+        groupTitle: string;
+        title: string;
+        updatedAtTimestamp?: number | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        fields: Record<string, string | number>;
+        groupTitle: string;
+        title: string;
+        updatedAtTimestamp?: number | undefined;
+    }[];
+}, {
+    items: {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        fields: Record<string, string | number>;
+        groupTitle: string;
+        title: string;
+        updatedAtTimestamp?: number | undefined;
+    }[];
+}>, z.ZodUnion<[z.ZodNull, z.ZodObject<{
+    statusCode: z.ZodNumber;
+    payload: z.ZodObject<{
+        message: z.ZodString;
+        errorCode: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}>]>, undefined, undefined, z.ZodObject<{
+    authorization: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    authorization?: string | undefined;
+}, {
+    authorization?: string | undefined;
+}>, false, false>;
+export declare const postTranslateContentContract: import("@lokalise/api-contracts").PayloadRouteDefinition<never, z.ZodObject<{
+    languages: z.ZodArray<z.ZodString, "many">;
+    groupIds: z.ZodArray<z.ZodString, "many">;
+    options: z.ZodOptional<z.ZodObject<{
+        convertPlaceholders: z.ZodOptional<z.ZodBoolean>;
+        overrideUpdatedTranslations: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    }, {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    languages: string[];
+    groupIds: string[];
+    options?: {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    } | undefined;
+}, {
+    languages: string[];
+    groupIds: string[];
+    options?: {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    statusCode: z.ZodNumber;
+    message: z.ZodString;
+    jobId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}>, z.ZodObject<{
+    statusCode: z.ZodNumber;
+    payload: z.ZodObject<{
+        message: z.ZodString;
+        errorCode: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}>]>, undefined, undefined, z.ZodObject<{
+    authorization: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    authorization?: string | undefined;
+}, {
+    authorization?: string | undefined;
+}>, false, false>;
+export declare const postTranslateSingleContentContract: import("@lokalise/api-contracts").PayloadRouteDefinition<never, z.ZodObject<{
+    languages: z.ZodArray<z.ZodString, "many">;
+    groupIds: z.ZodArray<z.ZodString, "many">;
+    options: z.ZodOptional<z.ZodObject<{
+        convertPlaceholders: z.ZodOptional<z.ZodBoolean>;
+        overrideUpdatedTranslations: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    }, {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    }>>;
+    items: z.ZodArray<z.ZodObject<{
+        groupId: z.ZodString;
+        uniqueId: z.ZodString;
+        metadata: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString, "many">]>>;
+        translations: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        translations: Record<string, string>;
+    }, {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        translations: Record<string, string>;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        translations: Record<string, string>;
+    }[];
+    languages: string[];
+    groupIds: string[];
+    options?: {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    } | undefined;
+}, {
+    items: {
+        metadata: Record<string, string | number | string[]>;
+        groupId: string;
+        uniqueId: string;
+        translations: Record<string, string>;
+    }[];
+    languages: string[];
+    groupIds: string[];
+    options?: {
+        convertPlaceholders?: boolean | undefined;
+        overrideUpdatedTranslations?: boolean | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    statusCode: z.ZodNumber;
+    message: z.ZodString;
+    jobId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}>, z.ZodObject<{
+    statusCode: z.ZodNumber;
+    payload: z.ZodObject<{
+        message: z.ZodString;
+        errorCode: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}>]>, undefined, undefined, z.ZodObject<{
+    authorization: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    authorization?: string | undefined;
+}, {
+    authorization?: string | undefined;
+}>, false, false>;
+export declare const postPublishContentContract: import("@lokalise/api-contracts").PayloadRouteDefinition<never, z.ZodObject<{
+    languages: z.ZodArray<z.ZodString, "many">;
+    groupIds: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    languages: string[];
+    groupIds: string[];
+}, {
+    languages: string[];
+    groupIds: string[];
+}>, z.ZodUnion<[z.ZodObject<{
+    statusCode: z.ZodNumber;
+    message: z.ZodString;
+    jobId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}, {
+    message: string;
+    statusCode: number;
+    jobId: string;
+}>, z.ZodObject<{
+    statusCode: z.ZodNumber;
+    payload: z.ZodObject<{
+        message: z.ZodString;
+        errorCode: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }, {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}, {
+    statusCode: number;
+    payload: {
+        message: string;
+        errorCode: string;
+        details?: Record<string, any> | undefined;
+    };
+}>]>, undefined, undefined, z.ZodObject<{
+    authorization: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    authorization?: string | undefined;
+}, {
+    authorization?: string | undefined;
+}>, false, false>;
+export declare const completeImportUploadContract: import("@lokalise/api-contracts").PayloadRouteDefinition<{
+    integrationId: string;
+    importId: string;
+}, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>, z.ZodUnion<[z.ZodObject<{
+    receivedCount: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    receivedCount: number;
+}, {
+    receivedCount: number;
+}>, z.ZodObject<{
+    message: z.ZodString;
+    errorCode: z.ZodString;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    errorCode: string;
+    details?: Record<string, any> | undefined;
+}, {
+    message: string;
+    errorCode: string;
+    details?: Record<string, any> | undefined;
+}>]>, z.ZodObject<{
+    integrationId: z.ZodString;
+    importId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    integrationId: string;
+    importId: string;
+}, {
+    integrationId: string;
+    importId: string;
+}>, undefined, undefined, false, false>;
+export declare const initializeContentImportContract: import("@lokalise/api-contracts").PayloadRouteDefinition<{
+    integrationId: string;
+}, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>, z.ZodUnion<[z.ZodObject<{
+    importId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    importId: string;
+}, {
+    importId: string;
+}>, z.ZodObject<{
+    message: z.ZodString;
+    errorCode: z.ZodString;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    errorCode: string;
+    details?: Record<string, any> | undefined;
+}, {
+    message: string;
+    errorCode: string;
+    details?: Record<string, any> | undefined;
+}>]>, z.ZodObject<{
+    integrationId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    integrationId: string;
+}, {
+    integrationId: string;
+}>, undefined, undefined, false, false>;
+export declare const uploadContentItemsChunkContract: import("@lokalise/api-contracts").PayloadRouteDefinition<{
+    integrationId: string;
+    importId: string;
+}, z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        contentUnits: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            type: z.ZodString;
+            source: z.ZodString;
+            context: z.ZodOptional<z.ZodString>;
+            characterLimit: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+            id: string;
+            source: string;
+            context?: string | undefined;
+            characterLimit?: string | undefined;
+        }, {
+            type: string;
+            id: string;
+            source: string;
+            context?: string | undefined;
+            characterLimit?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        contentUnits: {
+            type: string;
+            id: string;
+            source: string;
+            context?: string | undefined;
+            characterLimit?: string | undefined;
+        }[];
+    }, {
+        id: string;
+        name: string;
+        contentUnits: {
+            type: string;
+            id: string;
+            source: string;
+            context?: string | undefined;
+            characterLimit?: string | undefined;
+        }[];
+    }>, "many">;
+    chunkId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        id: string;
+        name: string;
+        contentUnits: {
+            type: string;
+            id: string;
+            source: string;
+            context?: string | undefined;
+            characterLimit?: string | undefined;
+        }[];
+    }[];
+    chunkId: string;
+}, {
+    items: {
+        id: string;
+        name: string;
+        contentUnits: {
+            type: string;
+            id: string;
+            source: string;
+            context?: string | undefined;
+            characterLimit?: string | undefined;
+        }[];
+    }[];
+    chunkId: string;
+}>, z.ZodUnion<[z.ZodObject<{
+    receivedCount: z.ZodNumber;
+    chunkId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    receivedCount: number;
+    chunkId: string;
+}, {
+    receivedCount: number;
+    chunkId: string;
+}>, z.ZodObject<{
+    message: z.ZodString;
+    errorCode: z.ZodString;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    errorCode: string;
+    details?: Record<string, any> | undefined;
+}, {
+    message: string;
+    errorCode: string;
+    details?: Record<string, any> | undefined;
+}>]>, z.ZodObject<{
+    integrationId: z.ZodString;
+    importId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    integrationId: string;
+    importId: string;
+}, {
+    integrationId: string;
+    importId: string;
+}>, undefined, undefined, false, false>;