@gt6/sdk
Version:
GT6 SDK for articles management - A comprehensive JavaScript/TypeScript library for managing articles, categories, and tags in GT6 platform
622 lines • 23.1 kB
TypeScript
import { GT6Client } from './core/client';
import { ArticlesAPI } from './modules/articles';
import { ProductsAPI } from './modules/products';
import { SettingsAPI } from './modules/settings';
import { FormsAPI } from './modules/forms';
import { UsersAPI } from './modules/users';
import { TransactionsAPI } from './modules/transactions';
import { GT6Config, ArticlesByCategoryOptions, ArticlesByTagOptions, ProductsByCategoryOptions, ProductsByTagOptions } from './core/types';
/**
* GT6 SDK 主类
* 提供文章、产品、设置、表单和用户管理相关的所有功能
*/
export declare class GT6SDK {
articles: ArticlesAPI;
products: ProductsAPI;
settings: SettingsAPI;
forms: FormsAPI;
users: UsersAPI;
transactions: TransactionsAPI;
constructor(config: GT6Config);
/**
* 获取客户端实例（用于高级用法）
*/
getClient(): GT6Client;
/**
* 清除所有缓存
*/
clearCache(): void;
/**
* 获取缓存统计信息
*/
getCacheStats(): {
size: number;
entries: Array<{
key: string;
age: number;
}>;
};
/**
* 1. 便捷方法：根据文章ID获取文章详情
*/
getArticle(articleId: number | string): Promise<import("./core/types").Article>;
/**
* 1.1. 便捷方法：根据文章ID获取文章详情（使用上级平台ID）
*/
getArticle_p(articleId: number | string): Promise<import("./core/types").Article>;
/**
* 2. 便捷方法：获取文章分类列表
*/
getCategories(rootCategoryId?: number | string): Promise<import("./core/types").Category[]>;
/**
* 2.1. 便捷方法：获取文章分类列表（使用下级平台ID）
*/
getCategories_p(rootCategoryId_p?: number | string): Promise<import("./core/types").Category[]>;
/**
* 2.2. 便捷方法：获取文章分类列表（使用下级平台ID）
*/
getCategories_a(rootCategoryId?: number | string): Promise<import("./core/types").Category[]>;
/**
* 3. 便捷方法：获取文章标签列表
*/
getTags(tagAlias?: string): Promise<import("./core/types").Tag[]>;
/**
* 3.1. 便捷方法：获取文章标签列表（使用下级平台ID）
*/
getTags_p(tagAlias_p?: string): Promise<import("./core/types").Tag[]>;
/**
* 3.2. 便捷方法：获取单个平台文章标签列表
*/
getTags_p_single(tagId_p?: number): Promise<import("./core/types").SingleTagResponse>;
/**
* 3.3. 便捷方法：获取单个平台文章标签的文章ID列表
*/
getTagArticleIds_p(tagId_p?: number): Promise<number[]>;
/**
* 4. 便捷方法：根据分类ID获取文章列表
*/
getArticlesByCategory(categoryId: number | number[], options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/*********************************************************************************************
* 4.1. 便捷方法：根据分类ID获取文章列表（使用上级平台ID）
*/
getArticlesByCategory_all(categoryId: number, options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
getArticlesByCategory_all_search(categoryId: number, options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
filteredTotal: number;
}>;
getArticlesByCategory_all_search01(categoryId: number, options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
filteredTotal: number;
}>;
getArticlesByplatform_all(platformId: number, options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/**
* 4.2. 便捷方法：获取文章分类列表
*/
getArticlesCategories_all(rootCategoryId?: number | string): Promise<import("./core/types").Category[]>;
/**
* 4.3. 便捷方法：根据单个标签ID获取平台文章列表
*/
getArticlesByTag_single_all(tagId: number, options?: ArticlesByTagOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
tag: Omit<import("./core/types").SingleTagResponse, "articleIds">;
}>;
/**
* 4.4. 便捷方法：根据文章ID获取文章详情（使用上级平台ID）
*/
getArticle_all(articleId: number | string): Promise<import("./core/types").Article>;
/*********************************************************************************************
* 4.5. 便捷方法：根据分类ID获取文章列表（使用下级平台ID）
*/
getArticlesByCategory_p(categoryId: number | number[], options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/**
* 4.2. 便捷方法：根据分类ID获取文章列表（使用当前分类数据）
*/
getArticlesByCategory_t(categoryId: number | number[], options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/**
* 4.3. 便捷方法：根据分类ID获取文章列表（从大型静态JSON文件获取）
*/
getArticlesByCategory_a(categoryId: number, options?: ArticlesByCategoryOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/**
* 5. 便捷方法：根据标签ID获取文章列表
*/
getArticlesByTag(tagId: number | number[], options?: ArticlesByTagOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/**
* 5.1. 便捷方法：根据标签ID获取文章列表（使用下级平台ID）
*/
getArticlesByTag_p(tagId: number | number[], options?: ArticlesByTagOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/**
* 5.2. 便捷方法：根据标签ID获取文章列表（使用当前标签数据）
*/
getArticlesByTag_t(tagId: number | number[], options?: ArticlesByTagOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
}>;
/**
* 5.3. 便捷方法：根据单个标签ID获取平台文章列表
*/
getArticlesByTag_single(tagId: number, options?: ArticlesByTagOptions): Promise<{
articles: import("./core/types").Article[];
total: number;
page: number;
limit: number;
tag: Omit<import("./core/types").SingleTagResponse, "articleIds">;
}>;
/**
* 6. 便捷方法：根据分类ID获取该分类的层级路径
*/
getCategoryPath(categoryId: number): Promise<{
path: import("./core/types").Category[];
currentCategory: import("./core/types").Category | null;
breadcrumbs: Array<{
categoryId: number;
categoryName: string;
level: number;
}>;
}>;
/**
* 7. 便捷方法：获取指定分类ID下的子分类
*/
getSubCategories(categoryId: number, options?: {
recursive?: boolean;
includeCurrent?: boolean;
maxDepth?: number;
}): Promise<{
subCategories: import("./core/types").Category[];
currentCategory: import("./core/types").Category | null;
total: number;
depth: number;
}>;
/**
* 8. 便捷方法：根据产品ID获取产品详情
*/
getProduct(productId: number | string): Promise<import("./core/types").Product>;
/**
* 8.1. 便捷方法：根据产品ID获取父平台产品详情
*/
getProduct_p(productId: number | string): Promise<import("./core/types").Product>;
/**
* 8.1.1. 便捷方法：根据产品ID获取全部产品详情（包括自定义和平台）
*/
getProduct_all(productId: number | string): Promise<import("./core/types").Product>;
getProduct01_all(productId: number | string): Promise<import("./core/types").Product>;
/**
* 8.2. 便捷方法：获取父平台产品分类列表
*/
getCategories_b(rootCategoryId?: number | string): Promise<import("./core/types").ProductCategory[]>;
/**
* 8.1.2. 便捷方法：获取父平台产品分类列表
*/
getProductsCategories_all(productRootCategoryId?: number | string): Promise<import("./core/types").ProductCategory[]>;
/**
* 8.1.3. 便捷方法：根据大分类ID获取平台产品列表
*/
getProductsByCategory_all(categoryId: number, options?: ProductsByCategoryOptions): Promise<{
products: any[];
total: number;
page: number;
limit: number;
}>;
/**
* 8.1.4. 便捷方法：根据单个标签ID获取平台产品列表
*/
getProductsByTag_single_all(tagId: number, options?: ProductsByTagOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
tag: Omit<import("./core/types").SingleProductTagResponse, "productIds">;
}>;
/**
* 9. 便捷方法：获取产品分类列表
*/
getProductCategories(productRootCategoryId?: number | string): Promise<import("./core/types").ProductCategory[]>;
/**
* 9.1. 便捷方法：获取父平台产品分类列表
*/
getProductCategories_p(productRootCategoryId_p?: number | string): Promise<import("./core/types").ProductCategory[]>;
/**
* 10. 便捷方法：获取产品标签列表
*/
getProductTags(productTagAlias?: string): Promise<import("./core/types").ProductTag[]>;
/**
* 10.1. 便捷方法：获取父平台产品标签列表
*/
getProductTags_p(productTagAlias_p?: string): Promise<import("./core/types").ProductTag[]>;
/**
* 10.2. 便捷方法：获取单个平台产品标签列表
*/
getProductTags_p_single(productTagId_p?: number): Promise<import("./core/types").SingleProductTagResponse>;
/**
* 10.3. 便捷方法：获取单个平台产品标签的产品ID列表
*/
getProductTagProductIds_p(productTagId_p?: number): Promise<number[]>;
/**
* 11. 便捷方法：根据分类ID获取产品列表
*/
getProductsByCategory(categoryId: number | number[], options?: ProductsByCategoryOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
}>;
/**
* 11.1. 便捷方法：根据分类ID获取父平台产品列表
*/
getProductsByCategory_p(categoryId: number | number[], options?: ProductsByCategoryOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
}>;
/**
* 11.2. 便捷方法：根据分类ID获取父平台产品列表（使用当前分类数据）
*/
getProductsByCategory_t(categoryId: number | number[], options?: ProductsByCategoryOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
}>;
/**
* 11.3. 便捷方法：根据大分类ID获取平台产品列表（从big-product-categories静态JSON获取）
*/
getProductsByCategory_b(categoryId: number, options?: ProductsByCategoryOptions): Promise<{
products: any[];
total: number;
page: number;
limit: number;
}>;
/**
* 12. 便捷方法：根据标签ID获取产品列表
*/
getProductsByTag(tagId: number | number[], options?: ProductsByTagOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
}>;
/**
* 12.1. 便捷方法：根据标签ID获取父平台产品列表
*/
getProductsByTag_p(tagId: number | number[], options?: ProductsByTagOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
}>;
/**
* 12.2. 便捷方法：根据标签ID获取父平台产品列表（使用当前标签数据）
*/
getProductsByTag_t(tagId: number | number[], options?: ProductsByTagOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
}>;
/**
* 12.3. 便捷方法：根据单个标签ID获取平台产品列表
*/
getProductsByTag_single(tagId: number, options?: ProductsByTagOptions): Promise<{
products: import("./core/types").Product[];
total: number;
page: number;
limit: number;
tag: Omit<import("./core/types").SingleProductTagResponse, "productIds">;
}>;
/**
* 13. 便捷方法：根据分类ID获取该分类的层级路径
*/
getProductCategoryPath(categoryId: number): Promise<{
path: import("./core/types").ProductCategory[];
currentCategory: import("./core/types").ProductCategory | null;
breadcrumbs: Array<{
categoryId: number;
categoryName: string;
level: number;
}>;
}>;
/**
* 14. 便捷方法：获取指定分类ID下的子分类
*/
getProductSubCategories(categoryId: number, options?: {
recursive?: boolean;
includeCurrent?: boolean;
maxDepth?: number;
}): Promise<{
subCategories: import("./core/types").ProductCategory[];
currentCategory: import("./core/types").ProductCategory | null;
total: number;
depth: number;
}>;
/**
* 15. 便捷方法：获取税费信息
*/
getTaxInfo(): Promise<import("./core/types").TaxResponse>;
/**
* 16. 便捷方法：获取运费信息
*/
getShippingInfo(): Promise<import("./core/types").ShippingResponse>;
/**
* 17. 便捷方法：获取区域信息
*/
getRegions(): Promise<import("./core/types").RegionResponse>;
/**
* 18. 便捷方法：获取全局设置列表
*/
getSettings(settingAlias?: string): Promise<import("./core/types").Setting[]>;
/**
* 18.1. 便捷方法：获取父平台全局设置列表
*/
getSettings_p(settingAlias_p?: string): Promise<import("./core/types").Setting[]>;
/**
* 19. 便捷方法：获取指定设置
*/
getSetting(key: string): Promise<import("./core/types").Setting | null>;
/**
* 19.1. 便捷方法：获取父平台指定设置
*/
getSetting_p(key: string): Promise<import("./core/types").Setting | null>;
/**
* 20. 便捷方法：获取支付方式列表
*/
getPaymentMethods(paymentAlias?: string): Promise<import("./core/types").PaymentMethodsResponse>;
/**
* 21. 便捷方法：根据类型获取支付方式
*/
getPaymentMethodsByType(type: 'Api' | 'Manual' | 'Gateway' | 'Crypto', paymentAlias?: string): Promise<import("./core/types").PaymentMethod[]>;
/**
* 22. 便捷方法：根据ID获取支付方式详情
*/
getPaymentMethodById(methodId: number, paymentAlias?: string): Promise<import("./core/types").PaymentMethod | null>;
/**
* 23. 便捷方法：获取支付方式属性值
*/
getPaymentMethodAttribute(methodId: number, attrName: string, paymentAlias?: string): Promise<string | null>;
/**
* 24. 便捷方法：通用表单提交
*/
submitForm(aliases: string, email: string, fieldValue: Record<string, any>, options?: any): Promise<import("./core/types").FormSubmitResponse>;
/**
* 25. 便捷方法：联系表单提交
*/
submitContactForm(formData: {
firstName: string;
lastName?: string;
email: string;
phone?: string;
subject: string;
message: string;
}): Promise<import("./core/types").FormSubmitResponse>;
/**
* 26. 便捷方法：反馈表单提交
*/
submitFeedbackForm(formData: {
name: string;
email: string;
type: string;
message: string;
rating?: number;
}): Promise<import("./core/types").FormSubmitResponse>;
/**
* 27. 便捷方法：自定义表单提交
*/
submitCustomForm(aliases: string, formData: Record<string, any>, emailField?: string): Promise<import("./core/types").FormSubmitResponse>;
/**
* 28. 便捷方法：用户登录
*/
login(username: string, password: string, platformId: number): Promise<import("./modules/users").LoginResponse>;
/**
* 29. 便捷方法：用户注册
*/
register(username: string, password: string, platformId: number, ibcode?: string): Promise<import("./modules/users").RegisterResponse>;
/**
* 30. 便捷方法：检查用户是否已登录
*/
isLoggedIn(): boolean;
/**
* 31. 便捷方法：获取当前登录用户信息
*/
getCurrentUser(): Omit<import("./modules/users").UserData, "token"> | null;
/**
* 32. 便捷方法：获取当前登录用户的token
*/
getToken(): string | null;
/**
* 33. 便捷方法：用户登出
*/
logout(): void;
/**
* 34. 便捷方法：保存用户数据
*/
saveUserData(userData: any): void;
/**
* 35. 便捷方法：获取用户数据
*/
getUserData(): import("./modules/users").UserData | null;
/**
* 36. 便捷方法：记住登录信息
*/
rememberLogin(username: string, password: string): void;
/**
* 37. 便捷方法：获取记住的登录信息
*/
getRememberedLogin(): {
username: string;
password: string;
} | null;
/**
* 38. 便捷方法：清除记住的登录信息
*/
clearRememberedLogin(): void;
/**
* 39. 便捷方法：获取用户资金信息
*/
getUserFunds(): Promise<import("./modules/users").UserFundsResponse>;
/**
* 40. 便捷方法：获取用户资金信息（简化版本）
*/
getFunds(): Promise<import("./modules/users").UserFunds | null>;
/**
* 41. 便捷方法：获取用户支付记录列表
*/
getPaymentRecords(options?: any): Promise<import("./modules/users").PaymentRecordsResponse>;
/**
* 42. 便捷方法：获取用户支付记录列表（简化版本）
*/
getPaymentRecordsSimple(page?: number, pageSize?: number): Promise<{
records: import("./modules/users").PaymentRecord[];
total: number;
page: number;
pageSize: number;
} | null>;
/**
* 便捷方法：获取用户资金日志列表
*/
getFundLogs(options?: any): Promise<import("./modules/users").FundLogsResponse>;
/**
* 便捷方法：获取用户资金日志列表（简化版本）
*/
getFundLogsSimple(page?: number, pageSize?: number): Promise<{
logs: import("./modules/users").FundLog[];
total: number;
} | null>;
/**
* 便捷方法：获取用户零售订单列表
*/
getRetailOrders(options?: any): Promise<import("./modules/users").RetailOrdersResponse>;
/**
* 便捷方法：获取用户零售订单列表（简化版本）
*/
getRetailOrdersSimple(page?: number, pageSize?: number): Promise<{
orders: import("./modules/users").RetailOrder[];
total: number;
page: number;
pageSize: number;
} | null>;
/**
* 便捷方法：获取用户地址列表
* @param userType 用户类型，默认为2（普通用户）
*/
getAddresses(userType?: number): Promise<import("./modules/users").AddressesResponse>;
/**
* 便捷方法：获取用户地址列表（简化版本）
* @param userType 用户类型，默认为2（普通用户）
*/
getAddressesSimple(userType?: number): Promise<import("./modules/users").AddressInfo[] | null>;
/**
* 便捷方法：根据地址ID获取地址信息
* @param addressId 地址ID
* @param userType 用户类型，默认为2（普通用户）
*/
getAddressById(addressId: number, userType?: number): Promise<import("./modules/users").AddressInfo | null>;
/**
* 便捷方法：获取用户资料
*/
getUserProfile(): Promise<import("./modules/users").UserProfileResponse>;
/**
* 便捷方法：获取用户资料（简化版本）
*/
getProfile(): Promise<import("./modules/users").UserProfile | null>;
/**
* 便捷方法：更新用户资料
*/
updateProfile(profileData: any): Promise<import("./modules/users").UpdateProfileResponse>;
/**
* 便捷方法：修改密码
*/
changePassword(passwordData: any): Promise<import("./modules/users").ChangePasswordResponse>;
/**
* 便捷方法：创建地址
* @param addressData 地址数据
*/
createAddress(addressData: any): Promise<import("./modules/users").AddressResponse>;
/**
* 便捷方法：更新地址
* @param addressId 地址ID
* @param addressData 地址数据
*/
updateAddress(addressId: number, addressData: any): Promise<import("./modules/users").AddressResponse>;
/**
* 便捷方法：删除地址
* @param addressId 地址ID
* @param userType 用户类型，默认为2（普通用户）
*/
deleteAddress(addressId: number, userType?: number): Promise<import("./modules/users").AddressResponse>;
/**
* 便捷方法：上传文件
*/
uploadFile(file: File): Promise<import("./modules/users").UploadResponse>;
/**
* 便捷方法：资金扣款
*/
deductFunds(deductData: any): Promise<import("./modules/transactions").DeductFundsResponse>;
/**
* 便捷方法：创建零售订单
*/
createRetailOrder(orderData: any): Promise<import("./modules/transactions").CreateRetailOrderResponse>;
/**
* 便捷方法：创建支付记录
*/
createPaymentRecord(paymentData: any): Promise<import("./modules/transactions").CreatePaymentRecordResponse>;
}
export * from './core/types';
export * from './core/client';
export * from './modules/articles';
export * from './modules/products';
export * from './modules/settings';
export * from './modules/forms';
export * from './modules/users';
export * from './modules/transactions';
export default GT6SDK;
//# sourceMappingURL=index.d.ts.map