@selldone/sdk-storefront
Version:
A TypeScript SDK to connect to your shop and build a fully functional storefront and website by simply developing a frontend web application. All backend operations are seamlessly managed by the serverless Selldone solution.
128 lines (127 loc) • 2.89 kB
TypeScript
export interface Article {
/**
* Unique identifier of the article.
*/
id: number;
/**
* ID representing the associated shop.
*/
shop_id: number;
/**
* ID of the parent entity.
*/
parent_id: number;
/**
* Type of the parent entity.
*/
parent_type: Article.TypeValue;
/**
* ID of the user associated with the article.
*/
user_id: number;
/**
* Community name or identifier associated with the article.
*/
community: string;
/**
* Title of the article.
*/
title: string;
/**
* Body or main content of the article.
*/
body: string;
/**
* Title to be used for the article's webpage.
*/
page_title: string;
/**
* Description of the article.
*/
description: string;
/**
* Image URL or path associated with the article.
*/
image: string;
/**
* Power rating or score of the article.
*/
power: number;
/**
* Count of likes the article has received.
*/
like: number;
/**
* Indicates if the article is published.
*/
published: boolean;
/**
* Indicates if the article is private.
*/
private: boolean;
/**
* Language of the article.
*/
lang: string;
/**
* Total count of comments on the article.
*/
comments_count: number;
/**
* Count of new comments since the last check.
*/
new_comments_count: number;
/**
* Number of views the article has received.
*/
views: number;
/**
* Date and time when the article is scheduled to be published.
*/
schedule_at: Date;
/**
* URL-friendly version of the article's title.
*/
slug: string;
/**
* FAQs associated with the article.
*/
faqs: any[];
/**
* Structures or sections of the article.
*/
structures: any[];
/**
* Last updated date of the article.
*/
updated_at: Date;
/**
* Creation date of the article.
*/
created_at: Date;
}
export declare namespace Article {
/**
* Interface representing the structure of each article type.
*/
interface IType {
code: string;
name: string;
color: string;
}
/**
* Enumerates the keys for different types of articles.
*/
export type TypeKey = "SelldoneBlog" | "SelldoneHelp" | "Product" | "Blog" | "Company";
/**
* Object containing different types of articles.
* Each property of the object represents a specific type of article
* with its unique code, name, and color.
*/
export const Types: Record<TypeKey, IType>;
/**
* Type representing the union of all possible `code` values in `Type`.
*/
export type TypeValue = typeof Types[TypeKey]['code'];
export {};
}