anchor-sdk 0.1.36

package/dist/api/types.d.ts

@@ -0,0 +1,764 @@
+/**
+ * Response code enum values
+ */
+export type ResponseCode = "SUCCESS" | "SYSTEM_VERIFY_CLOSE" | "SYSTEM_VERIFY_OPEN_AND_OK" | "SYSTEM_VERIFY_OPEN_NEED_PHONE" | "SIGNATURE_ERROR" | "CUSTOMER_LOGIN_REQUIRED" | "CUSTOMER_NEW_LOGIN" | "CUSTOMER_MAIL_CODE_REQUIRED" | "CUSTOMER_MAIL_DUPLICATE" | "CUSTOMER_MAIL_CODE_INCORRECT" | "CUSTOMER_REFERENCE_REQUIRED" | "CUSTOMER_API_INVALID_SIGNATURE" | "CUSTOMER_PHONE_BIND_SUCCESS" | "CUSTOMER_LOGIN_PARAMETER_INCORRECT" | "CUSTOMER_LOGIN_INCORRECT" | "USER_NOT_EXIST" | "SYSTEM_OPERATION_FREQUENT" | "SYSTEM_SECURITY_PARAM_REQUIRED" | "SYSTEM_SECURITY_CHECK_FAIL" | "SYSTEM_PARAMETER_INVALID" | "SYSTEM_PARAMETER_REQUIRED" | "SYSTEM_PARAMETER_FORMAT_INCORRECT" | "SYSTEM_PARAMETER_TYPE_MISMATCH" | "SYSTEM_PARAMETER_NEED_DIGITAL" | "SYSTEM_DATA_NOT_FOUND" | "SYSTEM_CACHE_REFRESH_FAIL" | "SYSTEM_ACCESS_INTERFACE_OFFLINE" | "SYSTEM_UPGRADE_VERSION" | "SYSTEM_ACCESS_RESTRICTED" | "SYSTEM_HEADER_SAAS_ID_REQUIRED" | "SYSTEM_HEADER_CHAIN_ID_REQUIRED" | "SYSTEM_HEADER_JWT_TOKEN_REQUIRED" | "SYSTEM_HEADER_DEVICE_ID_REQUIRED" | "SYSTEM_HEADER_DEVICE_TYPE_REQUIRED" | "SYSTEM_HEADER_VERSION_REQUIRED" | "API_RATE_LIMITING" | "SYSTEM_PROJECT_NOT_FOUND" | "SYSTEM_HEADER_PROJECT_ID_REQUIRED" | "PARAMS_JWT_DECRYPT_FAIL" | "PARAMS_JWT_CHECK_INVALID" | "SYSTEM_CONFIG_ERROR" | "SYSTEM_UNAVAILABLE" | "SYSTEM_ERROR" | "SYSTEM_UPGRADING";
+/**
+ * 进度 DTO
+ */
+export interface ProgressDTO {
+    /** 条件名称 */
+    name: string;
+    /** 进度值 */
+    value: string;
+}
+/**
+ * NFT 进度 VO
+ */
+export interface NftProgressVO {
+    /** 条件编号 */
+    condition: string;
+    /** 条件名称 */
+    name: string;
+    /** 条件类型 */
+    type: string;
+    /** 进度值 */
+    value: string;
+}
+/**
+ * NFT VO
+ */
+export interface NftVO {
+    /** 已铸造数量 */
+    mintedCount?: number;
+    /** NFT 系列 logo */
+    seriesLogo?: string;
+    /** 可领取 ID */
+    claimableId?: string;
+    /** NFT 类型 */
+    type?: string;
+    /** NFT 层级 */
+    tier?: number;
+    /** 价格 */
+    price?: string;
+    /** NFT 网关 logo */
+    logo?: string;
+    /** 奖励 */
+    reward?: number;
+    /** 显示新标签 */
+    newTag?: boolean;
+    /** NFT 完成进度 */
+    process?: number;
+    /** NFT 合约地址 */
+    address?: string;
+    /** NFT token ID */
+    tokenId?: string;
+    /** 等级 */
+    level?: string;
+    /** NFT 系列名称 */
+    seriesName?: string;
+    /** 总供应量 */
+    totalSupply?: number;
+    /** 代币排序 */
+    sort?: number;
+    /** NFT 条件最大值 */
+    maxCond?: number;
+    /** NFT 领取时间 */
+    claimTime?: number;
+    /** 代币 */
+    token?: string;
+    /** NFT 系列 */
+    series?: string;
+    /** NFT 条件最小值 */
+    minCond?: number;
+    /** NFT 名称 */
+    name?: string;
+    /** NFT 条件和进度 */
+    progress?: NftProgressVO[];
+    /** 类别 */
+    category?: string;
+    /** 业务类型 */
+    businessType?: string;
+    /** NFT 描述 */
+    desc?: string;
+    /** NFT 状态(pending、claimable、claimed) */
+    status?: string;
+    /** NFT 稀有度 */
+    rarity?: string;
+}
+/**
+ * NFT 系列详情 VO
+ */
+export interface NftSeriesDetailVO {
+    /** 系列扩展 */
+    ext?: string;
+    /** 总奖励 */
+    rewardTotal?: number;
+    /** 系列中的所有 NFT */
+    nfts?: NftVO[];
+    /** 系列类型 */
+    series?: string;
+    /** 系列名称 */
+    name?: string;
+    /** 系列网关 logo */
+    logo?: string;
+    /** 系列详情 */
+    detail?: string;
+    /** 系列排序 */
+    sort?: number;
+    /** 系列类型，唯一键 */
+    type?: string;
+    /** 系列组 */
+    group?: string;
+    /** 系列描述 */
+    desc?: string;
+}
+/**
+ * 赛季配置 VO
+ */
+export interface SeasonConfigVO {
+    /** 赛季名称 */
+    name?: string;
+    /** 等级配置 */
+    levelConfig?: SeasonLevelConfigVO[];
+    /** 赛季 ID */
+    id?: number;
+    /** 赛季开始时间 */
+    beginTime?: number;
+    /** 赛季结束时间 */
+    endTime?: number;
+}
+/**
+ * 赛季等级配置 VO
+ */
+export interface SeasonLevelConfigVO {
+    /** 赛季等级跳跃点 */
+    jumpPoint?: number;
+    /** 赛季等级名称 */
+    name?: string;
+    /** 赛季等级图标 */
+    icon?: string;
+    /** 赛季等级分享图片 */
+    shareImage?: string;
+    /** 赛季等级滑动排名 */
+    slideRank?: number;
+    /** 赛季等级 ID */
+    id?: number;
+    /** 赛季等级跳跃排名 */
+    jumpRank?: number;
+    /** 赛季等级描述 */
+    desc?: string;
+}
+/**
+ * 徽章检查请求
+ */
+export interface BadgeCheckRequest {
+    /** 徽章系列过滤器 */
+    series: string;
+    /** 最大检查徽章数量 */
+    limit?: number;
+    /** 徽章组过滤器 */
+    group?: string;
+}
+/**
+ * 徽章检查响应数据
+ */
+export interface WebResultBadgeCheckResponse_data {
+    /** 可领取徽章列表 */
+    badges?: NftVO[];
+    /** 最后检查时间戳 */
+    lastCheckTimestamp?: number;
+    /** 可领取徽章数量 */
+    claimableCount?: number;
+}
+/**
+ * 徽章可领取响应数据
+ */
+export interface WebResultBadgeClaimableResponse_data {
+    /** 不可领取的原因 */
+    reason?: string;
+    /** 要求列表 */
+    requirements?: WebResultBadgeClaimableResponseDataRequirementsInner[];
+    /** 是否可领取 */
+    claimable?: boolean;
+}
+/**
+ * 徽章可领取响应数据要求
+ */
+export interface WebResultBadgeClaimableResponseDataRequirementsInner {
+    /** 要求名称 */
+    name?: string;
+    /** 是否完成 */
+    completed?: boolean;
+    /** 要求值 */
+    value?: string;
+}
+/**
+ * 徽章领取签名响应数据
+ */
+export interface WebResultBadgeClaimSignatureResponse_data {
+    /** 领取签名列表 */
+    signatures?: WebResultBadgeClaimSignatureResponseDataSignaturesInner[];
+}
+/**
+ * 徽章领取签名响应数据签名
+ */
+export interface WebResultBadgeClaimSignatureResponseDataSignaturesInner {
+    /** 徽章标识符 */
+    badgeId?: string;
+    /** 领取签名 */
+    signature?: string;
+    /** 签名有效期结束时间 */
+    validityEndTimestamp?: number;
+    /** 签名有效期开始时间 */
+    validityStartTimestamp?: number;
+}
+/**
+ * 徽章领取签名请求
+ */
+export interface BadgeClaimSignatureRequest {
+    /** 客户钱包地址 */
+    customerAddress: string;
+    /** 要领取的徽章 ID 列表 */
+    badgeIds: string[];
+}
+/**
+ * 徽章检查请求
+ */
+export interface BadgesCheckRequest {
+    /** 数量，上限 500 */
+    amount?: number;
+    /** 代币 ID */
+    tokenId?: string;
+    /** 系列 */
+    series: string;
+    /** 客户 ID */
+    customerId: string;
+    /** 业务 ID */
+    bizId: string;
+    /** 条件的完成进度，非必填，默认为设置的目标值 */
+    progress?: ProgressDTO[];
+}
+/**
+ * 购买请求
+ */
+export interface PurchaseRequest {
+    /** 代币 ID */
+    tokenId: string;
+    /** 客户 ID */
+    customerId: string;
+    /** 购买折扣 */
+    discount?: number;
+    /** 铸造到地址 */
+    toAddress: string;
+}
+/**
+ * NFT 铸造请求 VO
+ */
+export interface NFTMintRequestVO {
+    /** 客户地址 */
+    customerAddress: string;
+    /** NFT 类型 */
+    nftType: "badge";
+    /** NFT 合约地址 */
+    contractAddress: string;
+    /** 可领取 ID 列表 */
+    claimableIds: string[];
+}
+/**
+ * 批量铸造请求 VO
+ */
+export interface BatchMintRequestVO {
+    /** 客户地址 */
+    customerAddress: string;
+    /** NFT 合约地址 */
+    contractAddress: string;
+    /** 代币 ID 列表 */
+    tokenIds: string[];
+}
+/**
+ * 查询资产请求
+ */
+export interface QueryAssetsRequest {
+    /** 限制(最大: 200) */
+    limit?: number;
+    /** 客户 ID 列表 */
+    customerIds: string[];
+    /** 查询策略(ALL: 返回所有记录, MAX: 返回最大记录, REWARD: 按奖励降序排序) */
+    strategy: "ALL" | "MAX" | "REWARD";
+    /** 状态(pending、claimable、claimed) */
+    status: string;
+}
+/**
+ * 资产徽章响应
+ */
+export interface AssetsBadgeResponse {
+    /** 系列中的所有 NFT */
+    nfts?: NftVO[];
+    /** 用户 ID */
+    customerId?: string;
+}
+/**
+ * 检查事件请求
+ */
+export interface CheckEventRequest {
+    /** 系列 */
+    series: string;
+    /** 客户 ID */
+    customerId: string;
+    /** 条件进度 */
+    progress: ProgressDTO[];
+}
+/**
+ * 授予徽章请求 VO
+ */
+export interface WebResultGrantBadgeRequestVO {
+    /** 签名 */
+    signature?: string;
+    /** 周 ID */
+    week_id?: number;
+    /** 等级 ID */
+    level_id?: number;
+    /** 赛季 ID */
+    season_id?: number;
+    /** 客户 ID */
+    customer_id?: string;
+    /** 业务 ID */
+    business_id?: string;
+}
+/**
+ * 铸造请求
+ */
+export interface MintRequest {
+    /** UID */
+    uid?: string;
+    /** 数量 */
+    quantity?: number;
+    /** 代币 ID */
+    tokenId?: string;
+    /** 签名 */
+    signature?: string;
+    /** 链 ID */
+    chainId?: string;
+    /** 价格 */
+    price?: string;
+    /** 合约地址 */
+    contractAddress?: string;
+    /** 货币 */
+    currency?: string;
+    /** 有效期结束时间戳 */
+    validityEndTimestamp?: number;
+    /** ID */
+    id?: string;
+    /** 有效期开始时间戳 */
+    validityStartTimestamp?: number;
+    /** 项目处理 */
+    projectHandle?: string;
+}
+/**
+ * 分页信息
+ */
+export interface WebResultBadgeSeriesResponse_pagination {
+    /** 总项目数 */
+    total?: number;
+    /** 下一页令牌 */
+    nextToken?: string;
+}
+/**
+ * 授予徽章响应 VO 对象
+ */
+export interface WebResultGrantBadgeResponseVOAllOfObj {
+    /** 结果 */
+    result?: boolean;
+}
+/**
+ * 检查结果响应对象
+ */
+export interface WebResultCheckResultResponseAllOfObj {
+    /** 最后一次检查时间戳 */
+    lastCheckTimestamp?: number;
+    /** 可领取徽章数量 */
+    claimableBadgeCount?: number;
+}
+/**
+ * 资产徽章响应对象
+ */
+export interface WebResultAssetsBadgeResponseAllOfObj {
+    /** 行 */
+    rows?: AssetsBadgeResponse[];
+}
+/**
+ * 铸造响应对象
+ */
+export interface MintResponseAllOfObj {
+    /** 行 */
+    rows?: MintRequest[];
+}
+/**
+ * 赛季配置列表响应对象
+ */
+export interface WebResultListSeasonConfigVOAllOfObj {
+    /** 行 */
+    rows?: SeasonConfigVO[];
+}
+/**
+ * 徽章响应对象
+ */
+export interface WebResultBadgeResponseAllOfObj {
+    /** 总数 */
+    total?: number;
+    /** 下一页令牌 */
+    nextToken?: string;
+    /** 行 */
+    rows?: NftVO[];
+}
+/**
+ * Web 结果响应基类
+ */
+export interface WebResult<T> {
+    /** 响应枚举 */
+    responseEnum?: ResponseCode;
+    /** 代码 */
+    code?: string;
+    /** 是否成功 */
+    success?: boolean;
+    /** 对象 */
+    obj?: T;
+    /** 消息键 */
+    msgKey?: string;
+}
+/**
+ * 徽章系列响应
+ */
+export interface WebResultBadgeSeriesResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 分页信息 */
+    pagination?: WebResultBadgeSeriesResponse_pagination;
+    /** 徽章系列列表 */
+    data?: NftSeriesDetailVO[];
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 徽章检查响应
+ */
+export interface WebResultBadgeCheckResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 数据 */
+    data?: WebResultBadgeCheckResponse_data;
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 徽章可领取响应
+ */
+export interface WebResultBadgeClaimableResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 数据 */
+    data?: WebResultBadgeClaimableResponse_data;
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 徽章可领取列表响应
+ */
+export interface WebResultBadgeClaimableListResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 分页信息 */
+    pagination?: WebResultBadgeSeriesResponse_pagination;
+    /** 可领取徽章列表 */
+    data?: NftVO[];
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 徽章资产响应
+ */
+export interface WebResultBadgeAssetsResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 分页信息 */
+    pagination?: WebResultBadgeSeriesResponse_pagination;
+    /** 用户徽章资产列表 */
+    data?: NftVO[];
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 徽章系列详情响应
+ */
+export interface WebResultBadgeSeriesDetailResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 数据 */
+    data?: NftSeriesDetailVO;
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 徽章详情响应
+ */
+export interface WebResultBadgeDetailResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 数据 */
+    data?: NftVO;
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 徽章领取签名响应
+ */
+export interface WebResultBadgeClaimSignatureResponse {
+    /** 响应代码 */
+    code?: string;
+    /** 数据 */
+    data?: WebResultBadgeClaimSignatureResponse_data;
+    /** 响应消息 */
+    message?: string;
+}
+/**
+ * 购买响应
+ */
+export type WebResultPurchaseResponse = WebResult<MintRequest>;
+/**
+ * 授予徽章响应 VO
+ */
+export type WebResultGrantBadgeResponseVO = WebResult<WebResultGrantBadgeResponseVOAllOfObj>;
+/**
+ * 检查事件响应
+ */
+export type WebResultCheckEventResponse = WebResult<void>;
+/**
+ * 检查响应
+ */
+export type WebResultCheckResponse = WebResult<void>;
+/**
+ * 检查结果响应
+ */
+export type WebResultCheckResultResponse = WebResult<WebResultCheckResultResponseAllOfObj>;
+/**
+ * 资产徽章响应
+ */
+export type WebResultAssetsBadgeResponse = WebResult<WebResultAssetsBadgeResponseAllOfObj>;
+/**
+ * NFT 系列响应
+ */
+export type WebResultNftSeriesResponse = WebResult<NftSeriesDetailVO[]>;
+/**
+ * NFT 系列详情响应
+ */
+export type WebResultNftSeriesDetailResponse = WebResult<NftSeriesDetailVO>;
+/**
+ * 铸造响应
+ */
+export type MintResponse = WebResult<MintResponseAllOfObj>;
+/**
+ * 徽章响应
+ */
+export type WebResultBadgeResponse = WebResult<WebResultBadgeResponseAllOfObj>;
+/**
+ * 徽章检查响应
+ */
+export type WebResultBadgesCheckResponse = WebResult<void>;
+/**
+ * 赛季配置列表响应
+ */
+export type WebResultListSeasonConfigVO = WebResult<WebResultListSeasonConfigVOAllOfObj>;
+/**
+ * 错误响应
+ */
+export interface GetBadgeSeries400Response {
+    /** 错误代码 */
+    code?: string;
+    /** 数据 */
+    data?: object;
+    /** 错误消息 */
+    message?: string;
+}
+/**
+ * 未授权响应
+ */
+export interface GetBadgeSeries401Response {
+    /** 错误代码 */
+    code?: string;
+    /** 数据 */
+    data?: object;
+    /** 错误消息 */
+    message?: string;
+}
+/**
+ * 服务器错误响应
+ */
+export interface GetBadgeSeries500Response {
+    /** 错误代码 */
+    code?: string;
+    /** 数据 */
+    data?: object;
+    /** 错误消息 */
+    message?: string;
+}
+/**
+ * API 服务器配置
+ */
+export interface ApiServer {
+    /** 服务器描述 */
+    description: string;
+    /** 服务器 URL */
+    url: string;
+}
+/**
+ * API 信息
+ */
+export interface ApiInfo {
+    /** 许可证 */
+    license: {
+        name: string;
+        url: string;
+    };
+    /** 标题 */
+    title: string;
+    /** 版本 */
+    version: string;
+}
+/**
+ * API 标签
+ */
+export interface ApiTag {
+    /** 标签名称 */
+    name: string;
+    /** 标签描述 */
+    description: string;
+}
+/**
+ * 请求参数
+ */
+export interface RequestParameter {
+    /** 参数名称 */
+    name: string;
+    /** 参数位置 */
+    in: "path" | "query" | "header" | "cookie";
+    /** 是否必需 */
+    required?: boolean;
+    /** 参数描述 */
+    description?: string;
+    /** 参数模式 */
+    schema?: {
+        type?: string;
+        format?: string;
+        enum?: string[];
+        items?: {
+            type?: string;
+        };
+        default?: any;
+        maximum?: number;
+        minimum?: number;
+    };
+}
+/**
+ * API 路径操作
+ */
+export interface ApiPathOperation {
+    /** 操作摘要 */
+    summary?: string;
+    /** 操作描述 */
+    description?: string;
+    /** 操作 ID */
+    operationId?: string;
+    /** 请求参数 */
+    parameters?: RequestParameter[];
+    /** 请求体 */
+    requestBody?: {
+        content: {
+            "application/json": {
+                schema: {
+                    $ref?: string;
+                };
+            };
+        };
+    };
+    /** 响应 */
+    responses: {
+        [statusCode: string]: {
+            description?: string;
+            content?: {
+                "application/json": {
+                    schema: {
+                        $ref?: string;
+                    };
+                };
+            };
+        };
+    };
+    /** 标签 */
+    tags?: string[];
+}
+/**
+ * API 路径
+ */
+export interface ApiPath {
+    [path: string]: {
+        [method: string]: ApiPathOperation;
+    };
+}
+/**
+ * 安全方案
+ */
+export interface SecurityScheme {
+    /** 类型 */
+    type: string;
+    /** 名称 */
+    name?: string;
+    /** 位置 */
+    in?: string;
+}
+/**
+ * API 组件
+ */
+export interface ApiComponents {
+    /** 模式 */
+    schemas: {
+        [name: string]: any;
+    };
+    /** 安全方案 */
+    securitySchemes: {
+        [name: string]: SecurityScheme;
+    };
+}
+/**
+ * 用户操作哈希处理请求
+ */
+export interface UserOpHashProcessRequest {
+    /** 合约调用成功后返回的：userOpsHash */
+    userOperationHash: string;
+    /** 处理类型 */
+    processType?: "ERC20_TRANSFER";
+}
+/**
+ * 用户操作哈希处理响应
+ */
+export type WebResultUserOpHashProcess = WebResult<string>;
+/**
+ * 交易哈希处理响应
+ */
+export type WebResultTransactionHashProcess = WebResult<boolean>;
+/**
+ * OpenAPI 规范
+ */
+export interface OpenApiSpec {
+    /** 组件 */
+    components: ApiComponents;
+    /** 服务器 */
+    servers: ApiServer[];
+    /** OpenAPI 版本 */
+    openapi: string;
+    /** 路径 */
+    paths: ApiPath;
+    /** 信息 */
+    info: ApiInfo;
+    /** 标签 */
+    tags: ApiTag[];
+}