tenyun/types/acp.d.ts

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

/// <reference types="node" />

import { AxiosPromise, AxiosRequestConfig } from "axios";

/** 应用合规隐私诊断任务应用数据信息 */
declare interface AppInfoItem {
  /** App包名 */
  AppPackage?: string;
  /** App名称 */
  AppName?: string;
  /** App版本 */
  AppVersion?: string;
  /** 应用平台, 0:android, 1:ios, 2:小程序 */
  Platform?: number;
  /** App隐私诊断报告下载链接 */
  ReportUrl?: string;
  /** App隐私诊断报告名称 */
  ReportTitle?: string;
  /** App诊断堆栈报告下载链接 */
  BehaviorUrl?: string;
  /** App诊断堆栈报告名称 */
  BehaviorTitle?: string;
  /** 诊断高风险项数量 */
  HighRiskCount?: number;
  /** 隐私申明文件名称 */
  PrivacyTextName?: string;
  /** 软件MD5 */
  SoftwareMD5?: string;
  /** 隐私文本MD5 */
  PrivacyTextMD5?: string;
}

/** 应用合规隐私诊断任务数据 */
declare interface AppTaskData {
  /** 任务ID */
  TaskID?: string;
  /** 任务类型, 0:基础版, 1:专家版, 2:本地化 */
  TaskType?: number;
  /** 0:默认值(待检测/待咨询), 1.检测中, 2:待评估, 3:评估中, 4:任务完成/咨询完成, 5:任务失败, 6:咨询中; */
  TaskStatus?: number;
  /** 错误信息 */
  TaskErrMsg?: string;
  /** 任务来源,0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android) */
  Source?: number;
  /** 应用信息 */
  AppInfo?: AppInfoItem;
  /** 任务启动时间 */
  StartTime?: string;
  /** 任务完成时间(更新时间) */
  EndTime?: string;
  /** 联系人信息 */
  ContactName?: string;
}

/** 资源使用情况信息 */
declare interface ResourceUsageInfoData {
  /** 资源计费项名称 */
  ResourceName: string;
  /** 资源总数 */
  Total: number;
  /** 未使用资源数 */
  UnusedCount: number;
}

/** 任务流步骤详情 */
declare interface TaskFlowStepsInfo {
  /** 流程编号 */
  FlowNo?: string;
  /** 流程名称 */
  FlowName?: string;
  /** 流程状态, 其他值:进行中, 2:成功, 3:失败 */
  FlowStatus?: number;
  /** 流程状态描述 */
  FlowStateDesc?: string;
  /** 流程启动时间 */
  StartTime?: string;
  /** 流程完成时间 */
  EndTime?: string;
}

declare interface CreateAppScanTaskRepeatRequest {
  /** 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source: number;
  /** 应用平台, 0:android, 1:ios, 2:小程序 */
  Platform: number;
  /** 任务类型, 0:基础版, 1:专家版, 2:本地化 */
  TaskType: number;
  /** 原诊断任务ID */
  OrgTaskID: string;
  /** App包名 */
  AppPackage?: string;
  /** 上传的文件ID(任务来源为1时必填) */
  FileID?: string;
  /** 软件下载链接地址(任务来源为2时必填) */
  AppDownloadUrl?: string;
  /** 隐私文本下载地址(任务来源为2时必填) */
  PrivacyTextUrl?: string;
  /** 应用名称 */
  AppName?: string;
  /** 隐私申明文件名称 */
  PrivacyTextName?: string;
  /** 软件Sha1值(PrivacyTextMD5不为空时必填) */
  AppSha1?: string;
  /** 隐私申明文本md5(AppSha1不为空时必填) */
  PrivacyTextMD5?: string;
}

declare interface CreateAppScanTaskRepeatResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义 */
  Result: number;
  /** 任务id */
  TaskID: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface CreateAppScanTaskRequest {
  /** 任务类型, 0:基础版, 1:专家版, 2:本地化 */
  TaskType: number;
  /** 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source: number;
  /** 应用平台, 0:android, 1:ios, 2:小程序 */
  Platform: number;
  /** App包名 */
  AppPackage?: string;
  /** App名称(任务来源为2时必填) */
  AppName?: string;
  /** App版本 */
  AppVersion?: string;
  /** 上传的软件文件ID(任务来源为1时必填) */
  FileID?: string;
  /** 软件下载链接地址(任务来源为2时必填) */
  AppDownloadUrl?: string;
  /** 隐私文本下载地址(任务来源为2时必填) */
  PrivacyTextUrl?: string;
  /** 联系人信息 */
  ContactName?: string;
  /** 联系电话 */
  TelNumber?: string;
  /** 公司邮箱 */
  Email?: string;
  /** 公司名称 */
  CorpName?: string;
  /** 商务对接人员 */
  SalesPerson?: string;
  /** 备注信息 */
  Remark?: string;
  /** 是否同意隐私条款，0:不同意(默认), 1:同意 */
  IsAgreePrivacy?: number;
  /** 隐私申明文件名称 */
  PrivacyTextName?: string;
  /** 软件Sha1值(PrivacyTextMD5不为空时必填) */
  AppSha1?: string;
  /** 隐私申明文本md5(AppSha1不为空时必填) */
  PrivacyTextMD5?: string;
}

declare interface CreateAppScanTaskResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义 */
  Result?: number;
  /** 任务ID */
  TaskID?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeChannelTaskReportUrlRequest {
  /** 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source: number;
  /** 应用平台, 0:android, 1: iOS，2:小程序 */
  Platform: number;
  /** 任务id */
  TaskID: string;
  /** 任务类型, 0:基础版, 1:专家版, 2:本地化 */
  TaskType: number;
  /** 报告类型, 0:诊断报告, 1:堆栈报告, 2:视频证据(预留), 3:报告json结果 */
  ReportType: number;
  /** 子渠道APP MD5值 */
  AppMD5: string;
}

declare interface DescribeChannelTaskReportUrlResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义 */
  Result?: number;
  /** 诊断报告/堆栈信息/报告json结果下载链接 */
  ReportUrl?: string;
  /** 诊断报告/堆栈/报告json结果的名称 */
  ReportTitle?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeFileTicketRequest {
  /** 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source: number;
  /** 应用平台, 0:android, 1:ios, 2:小程序 */
  Platform: number;
}

declare interface DescribeFileTicketResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义 */
  Result?: number;
  /** 上传url(任务来源为2时:Post方法（100:apk,101:txt）, 任务来源为1时:put方法) */
  UploadUrl?: string;
  /** 上传url鉴权信息(任务来源为1时上传需要, Authorization参数值) */
  UploadSign?: string;
  /** 上传文件ID(任务来源为1时提交诊断任务需要) */
  FildID?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeResourceUsageInfoRequest {
  /** 资源计费项名称(为空时，则根据Source，TaskType和Platform进行查询) */
  PriceName?: string;
  /** 任务类型, 0:基础版, 1:专家版 */
  TaskType?: number;
  /** 应用平台, 0:android */
  Platform?: number;
  /** 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source?: number;
}

declare interface DescribeResourceUsageInfoResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义，暂时未定 */
  Result?: number;
  /** 资源使用信息 */
  Data?: ResourceUsageInfoData;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeScanTaskListRequest {
  /** 任务来源, -1:所有, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source: number;
  /** 应用平台, 0:android, 1:ios, 2:小程序 */
  Platform: number;
  /** 任务状态,可多值查询,例如:"1,2,3" 0:默认值(待检测/待咨询), 1.检测中, 2:待评估, 3:评估中, 4:任务完成/咨询完成, 5:任务失败, 6:咨询中; */
  TaskStatuses: string;
  /** 任务类型,可多值查询,采用逗号分隔,例如:"0,1" 0:基础版, 1:专家版, 2:本地化 */
  TaskTypes: string;
  /** 页码 */
  PageNo: number;
  /** 页码大小 */
  PageSize: number;
  /** 应用名称或小程序名称(可选参数) */
  AppName?: string;
  /** 查询时间范围, 查询开始时间(2021-09-30 或 2021-09-30 10:57:34) */
  StartTime?: string;
  /** 查询时间范围, 查询结束时间(2021-09-30 或 2021-09-30 10:57:34) */
  EndTime?: string;
}

declare interface DescribeScanTaskListResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义 */
  Result?: number;
  /** 任务总数量 */
  Total?: number;
  /** 诊断任务数据列表 */
  Data?: AppTaskData[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeScanTaskReportUrlRequest {
  /** 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source: number;
  /** 应用平台, 0:android, 1:ios, 2:小程序 */
  Platform: number;
  /** 任务id */
  TaskID: string;
  /** 任务类型, 0:基础版, 1:专家版, 2:本地化 */
  TaskType: number;
  /** 报告类型, 0:诊断报告, 1:堆栈报告, 2:视频证据(预留), 3:报告json结果 */
  ReportType: number;
}

declare interface DescribeScanTaskReportUrlResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义 */
  Result?: number;
  /** 诊断报告/堆栈信息/报告json结果下载链接 */
  ReportUrl?: string;
  /** 诊断报告/堆栈/报告json结果的名称 */
  ReportTitle?: string;
  /** 诊断json结果内容 */
  ReportResult?: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeScanTaskStatusRequest {
  /** 任务来源, 0:小程序诊断, 1:预留字段(暂未使用), 2:app诊断(android), 3:app漏洞扫描; */
  Source: number;
  /** 应用平台, 0:android, 1:ios, 2:小程序 */
  Platform: number;
  /** 任务id */
  TaskID: string;
  /** 任务类型, 0:基础版, 1:专家版, 2:本地化 */
  TaskType: number;
}

declare interface DescribeScanTaskStatusResponse {
  /** 返回值, 0:成功, 其他值请查看“返回值”定义 */
  Result?: number;
  /** 0:默认值(待检测/待咨询), 1.检测中, 4:任务完成/咨询完成, 5:任务失败, 6:咨询中; */
  Status?: number;
  /** 诊断失败的错误信息 */
  ErrMsg?: string;
  /** 任务流详情 */
  FlowSteps?: TaskFlowStepsInfo[];
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

/** {@link Acp 应用合规平台} */
declare interface Acp {
  (): Versions;
  /** 创建应用合规隐私诊断任务 {@link CreateAppScanTaskRequest} {@link CreateAppScanTaskResponse} */
  CreateAppScanTask(data: CreateAppScanTaskRequest, config?: AxiosRequestConfig): AxiosPromise<CreateAppScanTaskResponse>;
  /** 应用合规隐私诊断重试任务 {@link CreateAppScanTaskRepeatRequest} {@link CreateAppScanTaskRepeatResponse} */
  CreateAppScanTaskRepeat(data: CreateAppScanTaskRepeatRequest, config?: AxiosRequestConfig): AxiosPromise<CreateAppScanTaskRepeatResponse>;
  /** 获取子渠道应用合规隐私诊断任务报告url {@link DescribeChannelTaskReportUrlRequest} {@link DescribeChannelTaskReportUrlResponse} */
  DescribeChannelTaskReportUrl(data: DescribeChannelTaskReportUrlRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeChannelTaskReportUrlResponse>;
  /** 获取应用合规文件上传凭证接口 {@link DescribeFileTicketRequest} {@link DescribeFileTicketResponse} */
  DescribeFileTicket(data: DescribeFileTicketRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeFileTicketResponse>;
  /** 查询应用合规资源使用情况 {@link DescribeResourceUsageInfoRequest} {@link DescribeResourceUsageInfoResponse} */
  DescribeResourceUsageInfo(data?: DescribeResourceUsageInfoRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeResourceUsageInfoResponse>;
  /** 获取应用合规隐私诊断任务列表 {@link DescribeScanTaskListRequest} {@link DescribeScanTaskListResponse} */
  DescribeScanTaskList(data: DescribeScanTaskListRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeScanTaskListResponse>;
  /** 获取应用合规隐私诊断任务报告url {@link DescribeScanTaskReportUrlRequest} {@link DescribeScanTaskReportUrlResponse} */
  DescribeScanTaskReportUrl(data: DescribeScanTaskReportUrlRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeScanTaskReportUrlResponse>;
  /** 查询应用合规隐私诊断任务状态 {@link DescribeScanTaskStatusRequest} {@link DescribeScanTaskStatusResponse} */
  DescribeScanTaskStatus(data: DescribeScanTaskStatusRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeScanTaskStatusResponse>;
}

export declare type Versions = ["2022-01-05"];

export default Acp;