Taha Saif
Deploy Ecom Hub API backend (Express + Drizzle + Clerk + R2)
74bfb65
Raw History Blame Contribute Delete
12.6 kB
/**
* Generated by orval 🍺
* Do not edit manually.
* Api
* API specification
* OpenAPI spec version: 0.1.0
*/
import * as zod from 'zod';
/**
* @summary List published articles and overridden sample identifiers
*/
export declare const listArticlesResponseArticlesItemOneTitleMax = 240;
export declare const listArticlesResponseArticlesItemOneSlugMax = 200;
export declare const listArticlesResponseArticlesItemOneSlugRegExp: RegExp;
export declare const listArticlesResponseArticlesItemOneExcerptMax = 2000;
export declare const listArticlesResponseArticlesItemOneContentMax = 200000;
export declare const listArticlesResponseArticlesItemOneAuthorMax = 160;
export declare const listArticlesResponseArticlesItemOneTagsMax = 1000;
export declare const listArticlesResponseArticlesItemOneImageMax = 1000;
export declare const listArticlesResponseArticlesItemOneImageAltMax = 500;
export declare const listArticlesResponseArticlesItemOneVersionMin = 0;
export declare const ListArticlesResponse: zod.ZodObject<{
articles: zod.ZodArray<zod.ZodIntersection<zod.ZodObject<{
title: zod.ZodString;
slug: zod.ZodString;
excerpt: zod.ZodString;
content: zod.ZodString;
category: zod.ZodEnum<["Courier Guides", "Product Hunting", "Dropshipping", "Online Selling", "eCommerce Platforms", "Comparisons"]>;
author: zod.ZodString;
tags: zod.ZodString;
image: zod.ZodString;
imageAlt: zod.ZodString;
status: zod.ZodEnum<["Draft", "Published"]>;
version: zod.ZodNumber;
}, "strip", zod.ZodTypeAny, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}>, zod.ZodObject<{
id: zod.ZodString;
updatedAt: zod.ZodDate;
publishedAt: zod.ZodNullable<zod.ZodDate>;
}, "strip", zod.ZodTypeAny, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}>>, "many">;
overriddenSamples: zod.ZodArray<zod.ZodString, "many">;
}, "strip", zod.ZodTypeAny, {
articles: ({
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
} & {
id: string;
updatedAt: Date;
publishedAt: Date | null;
})[];
overriddenSamples: string[];
}, {
articles: ({
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
} & {
id: string;
updatedAt: Date;
publishedAt: Date | null;
})[];
overriddenSamples: string[];
}>;
/**
* @summary List all articles (admin only)
*/
export declare const listAdminArticlesResponseOneTitleMax = 240;
export declare const listAdminArticlesResponseOneSlugMax = 200;
export declare const listAdminArticlesResponseOneSlugRegExp: RegExp;
export declare const listAdminArticlesResponseOneExcerptMax = 2000;
export declare const listAdminArticlesResponseOneContentMax = 200000;
export declare const listAdminArticlesResponseOneAuthorMax = 160;
export declare const listAdminArticlesResponseOneTagsMax = 1000;
export declare const listAdminArticlesResponseOneImageMax = 1000;
export declare const listAdminArticlesResponseOneImageAltMax = 500;
export declare const listAdminArticlesResponseOneVersionMin = 0;
export declare const ListAdminArticlesResponseItem: zod.ZodIntersection<zod.ZodObject<{
title: zod.ZodString;
slug: zod.ZodString;
excerpt: zod.ZodString;
content: zod.ZodString;
category: zod.ZodEnum<["Courier Guides", "Product Hunting", "Dropshipping", "Online Selling", "eCommerce Platforms", "Comparisons"]>;
author: zod.ZodString;
tags: zod.ZodString;
image: zod.ZodString;
imageAlt: zod.ZodString;
status: zod.ZodEnum<["Draft", "Published"]>;
version: zod.ZodNumber;
}, "strip", zod.ZodTypeAny, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}>, zod.ZodObject<{
id: zod.ZodString;
updatedAt: zod.ZodDate;
publishedAt: zod.ZodNullable<zod.ZodDate>;
}, "strip", zod.ZodTypeAny, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}>>;
export declare const ListAdminArticlesResponse: zod.ZodArray<zod.ZodIntersection<zod.ZodObject<{
title: zod.ZodString;
slug: zod.ZodString;
excerpt: zod.ZodString;
content: zod.ZodString;
category: zod.ZodEnum<["Courier Guides", "Product Hunting", "Dropshipping", "Online Selling", "eCommerce Platforms", "Comparisons"]>;
author: zod.ZodString;
tags: zod.ZodString;
image: zod.ZodString;
imageAlt: zod.ZodString;
status: zod.ZodEnum<["Draft", "Published"]>;
version: zod.ZodNumber;
}, "strip", zod.ZodTypeAny, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}>, zod.ZodObject<{
id: zod.ZodString;
updatedAt: zod.ZodDate;
publishedAt: zod.ZodNullable<zod.ZodDate>;
}, "strip", zod.ZodTypeAny, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}>>, "many">;
/**
* @summary Save or publish an article (admin only, version checked)
*/
export declare const SaveArticleParams: zod.ZodObject<{
id: zod.ZodString;
}, "strip", zod.ZodTypeAny, {
id: string;
}, {
id: string;
}>;
export declare const saveArticleBodyTitleMax = 240;
export declare const saveArticleBodySlugMax = 200;
export declare const saveArticleBodySlugRegExp: RegExp;
export declare const saveArticleBodyExcerptMax = 2000;
export declare const saveArticleBodyContentMax = 200000;
export declare const saveArticleBodyAuthorMax = 160;
export declare const saveArticleBodyTagsMax = 1000;
export declare const saveArticleBodyImageMax = 1000;
export declare const saveArticleBodyImageAltMax = 500;
export declare const saveArticleBodyVersionMin = 0;
export declare const SaveArticleBody: zod.ZodObject<{
title: zod.ZodString;
slug: zod.ZodString;
excerpt: zod.ZodString;
content: zod.ZodString;
category: zod.ZodEnum<["Courier Guides", "Product Hunting", "Dropshipping", "Online Selling", "eCommerce Platforms", "Comparisons"]>;
author: zod.ZodString;
tags: zod.ZodString;
image: zod.ZodString;
imageAlt: zod.ZodString;
status: zod.ZodEnum<["Draft", "Published"]>;
version: zod.ZodNumber;
}, "strip", zod.ZodTypeAny, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}>;
export declare const saveArticleResponseOneTitleMax = 240;
export declare const saveArticleResponseOneSlugMax = 200;
export declare const saveArticleResponseOneSlugRegExp: RegExp;
export declare const saveArticleResponseOneExcerptMax = 2000;
export declare const saveArticleResponseOneContentMax = 200000;
export declare const saveArticleResponseOneAuthorMax = 160;
export declare const saveArticleResponseOneTagsMax = 1000;
export declare const saveArticleResponseOneImageMax = 1000;
export declare const saveArticleResponseOneImageAltMax = 500;
export declare const saveArticleResponseOneVersionMin = 0;
export declare const SaveArticleResponse: zod.ZodIntersection<zod.ZodObject<{
title: zod.ZodString;
slug: zod.ZodString;
excerpt: zod.ZodString;
content: zod.ZodString;
category: zod.ZodEnum<["Courier Guides", "Product Hunting", "Dropshipping", "Online Selling", "eCommerce Platforms", "Comparisons"]>;
author: zod.ZodString;
tags: zod.ZodString;
image: zod.ZodString;
imageAlt: zod.ZodString;
status: zod.ZodEnum<["Draft", "Published"]>;
version: zod.ZodNumber;
}, "strip", zod.ZodTypeAny, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}, {
status: "Draft" | "Published";
title: string;
slug: string;
excerpt: string;
content: string;
category: "Courier Guides" | "Product Hunting" | "Dropshipping" | "Online Selling" | "eCommerce Platforms" | "Comparisons";
author: string;
tags: string;
image: string;
imageAlt: string;
version: number;
}>, zod.ZodObject<{
id: zod.ZodString;
updatedAt: zod.ZodDate;
publishedAt: zod.ZodNullable<zod.ZodDate>;
}, "strip", zod.ZodTypeAny, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}, {
id: string;
updatedAt: Date;
publishedAt: Date | null;
}>>;
/**
* @summary Upload a featured image to durable App Storage (admin only)
*/
export declare const UploadArticleImageResponse: zod.ZodObject<{
image: zod.ZodString;
}, "strip", zod.ZodTypeAny, {
image: string;
}, {
image: string;
}>;
/**
* @summary Serve a public featured image
*/
export declare const GetArticleImageParams: zod.ZodObject<{
id: zod.ZodString;
}, "strip", zod.ZodTypeAny, {
id: string;
}, {
id: string;
}>;
export declare const GetArticleImageResponse: zod.ZodUnknown;
/**
* Returns server health status
* @summary Health check
*/
export declare const HealthCheckResponse: zod.ZodObject<{
status: zod.ZodString;
}, "strip", zod.ZodTypeAny, {
status: string;
}, {
status: string;
}>;
//# sourceMappingURL=api.d.ts.map