tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
1,377 lines (1,278 loc) • 43.9 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 品牌响应数据 */
declare interface BrandData {
/** 品牌Id */
CompanyId?: number;
/** 企业名称 */
CompanyName?: string;
/** 品牌名称 */
BrandName?: string;
/** 联系电话 */
Phone?: string;
/** 营业执照 */
License?: string;
/** 营业执照审核状态 */
LicenseStatus?: number;
/** 营业执照审核状态说明 */
LicenseNote?: string;
/** 授权书 */
Authorization?: string;
/** 授权书审核状态 */
AuthorizationStatus?: number;
/** 授权书审核状态说明 */
AuthorizationNote?: string;
/** 商标信息 */
Trademarks?: TrademarkData[];
/** 新增时间 */
InsertTime?: string;
/** 服务信息 */
Services?: ServiceData;
/** 账号id */
Uin?: string;
}
/** 仿冒应用数据 */
declare interface FakeAPPData {
/** 仿冒应用id */
FakeAPPId?: number | null;
/** 品牌名称 */
BrandName?: string | null;
/** 仿冒来源:0-系统检测 1-人工举报 */
Origin?: number | null;
/** 仿冒应用名称 */
FakeAPPName?: string | null;
/** 仿冒应用包名 */
FakeAPPPackageName?: string | null;
/** 仿冒应用证书 */
FakeAPPCert?: string | null;
/** 仿冒应用大小 */
FakeAPPSize?: string | null;
/** 热度 */
Heat?: number | null;
/** 协助处置状态:0-未处置 1-处置中 2-处置成功 3-处置失败 */
BlockStatus?: number | null;
/** 协助处置状态说明 */
BlockNote?: string | null;
/** 关停状态:0-未关停 1-关停中 2-关停成功 3-关停失败 4-重复上架 */
OfflineStatus?: number | null;
/** 关停状态说明 */
OfflineNote?: string | null;
/** app来源 */
DownloadWay?: string | null;
/** 新增时间 */
InsertTime?: string | null;
/** App下载链接 */
DownloadCosURL?: string | null;
/** 资质证明状态:0-不可用 1-可用 */
CertificationStatus?: number | null;
}
/** 仿冒网址数据 */
declare interface FakeURLData {
/** 仿冒网址id */
FakeURLId?: number | null;
/** 品牌名称 */
BrandName?: string | null;
/** 仿冒来源:0-系统检测 1-人工举报 */
Origin?: number | null;
/** 仿冒网址 */
FakeURL?: string | null;
/** 仿冒域名 */
FakeDomain?: string | null;
/** 热度 */
Heat?: number | null;
/** 拦截处置状态:0-未处置 1-处置中 2-处置成功 3-处置失败 */
BlockStatus?: number | null;
/** 拦截处置状态说明 */
BlockNote?: string | null;
/** 关停状态:0-未关停 1-关停中 2-关停成功 3-关停失败 4-重复上架 */
OfflineStatus?: number | null;
/** 关停状态说明 */
OfflineNote?: string | null;
/** ip地址 */
IP?: string | null;
/** ip地理位置 */
IPLocation?: string | null;
/** 网站所属单位 */
WebCompany?: string | null;
/** 网站性质 */
WebAttribute?: string | null;
/** 网站名称 */
WebName?: string | null;
/** 备案号 */
WebICP?: string | null;
/** 网站创建时间 */
WebCreateTime?: string | null;
/** 网站过期时间 */
WebExpireTime?: string | null;
/** 新增时间 */
InsertTime?: string | null;
/** 资质证明状态:0-不可用 1-可用 */
CertificationStatus?: number | null;
/** 网址截图 */
Snapshot?: string | null;
/** 账户资源状态:0-不可用 1-可用 */
AccountStatus?: number | null;
/** 审核状态:0-未审核 1-审核中 2-审核成功 3-审核失败 */
AuditStatus?: number | null;
/** 下线时间 */
OfflineTime?: string | null;
}
/** 过滤参数 */
declare interface Filter {
/** 过滤参数键 */
Name: string;
/** 过滤参数值 */
Value: string;
}
/** 服务响应数据 */
declare interface ServiceData {
/** 网站保护关联资产数 */
ProtectURLCount?: number;
/** 网站保护服务到期时间 */
ProtectURLExpireTime?: string;
/** 应用保护关联资产数 */
ProtectAPPCount?: number;
/** 应用保护服务到期时间 */
ProtectAPPExpireTime?: string;
/** 公众号保护关联资产数 */
ProtectOfficialAccountCount?: number;
/** 公众号保护服务到期时间 */
ProtectOfficialAccountExpireTime?: string;
/** 小程序保护关联资产数 */
ProtectMiniProgramCount?: number;
/** 小程序保护服务到期时间 */
ProtectMiniProgramExpireTime?: string;
/** 关停下架使用次数 */
OfflineCount?: number;
}
/** 商标响应数据 */
declare interface TrademarkData {
/** 商标证明 */
Trademark?: string;
/** 商标审核状态 */
TrademarkStatus?: number;
/** 商标审核状态说明 */
TrademarkNote?: string;
/** 商标id */
TrademarkId?: number;
/** 商标转让书 */
Transfer?: string;
/** 商标转让书审核状态 */
TransferStatus?: number;
/** 商标转让书审核状态说明 */
TransferNote?: string;
/** 商标名称 */
TrademarkName?: string;
}
/** 白名单数据 */
declare interface WhiteListData {
/** 白名单id */
WhiteListId?: number | null;
/** 企业id */
CompanyId?: number | null;
/** 品牌名称 */
BrandName?: string | null;
/** 资产类型:0-网站 1-app 2-公众号 3-小程序 */
AssetsType?: number | null;
/** 白名单 */
WhiteList?: string | null;
/** 白名单备注 */
Remark?: string | null;
/** 新增时间 */
InsertTime?: string | null;
}
declare interface CreateBPBrandRequest {
/** 品牌名称 */
BrandName: string;
/** 企业名称 */
CompanyName?: string;
/** 品牌logo */
BrandLogo?: string;
/** 联系电话 */
Phone?: string;
/** 营业执照 */
License?: string;
/** 授权书 */
Authorization?: string;
/** 商标名称 */
TrademarkNames?: string[];
/** 商标证明 */
Trademarks?: string[];
/** 是否涉及转让: 0-不转让 1-转让 */
IsTransfers?: string[];
/** 转让证明 */
Transfers?: string[];
/** 保护网址 */
ProtectURLs?: string[];
/** 保护应用 */
ProtectAPPs?: string[];
/** 保护公众号 */
ProtectOfficialAccounts?: string[];
/** 保护小程序 */
ProtectMiniPrograms?: string[];
/** 请求来源:0-反钓鱼 2-反假冒 */
APISource?: number;
}
declare interface CreateBPBrandResponse {
/** 企业id */
CompanyId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateBPFakeAPPListRequest {
/** 批量模板 */
FakeAPPs: string;
}
declare interface CreateBPFakeAPPListResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateBPFakeAPPRequest {
/** 企业id */
CompanyId: number;
/** 仿冒应用名称 */
FakeAPPName: string;
/** 仿冒来源 */
APPChan?: string;
/** 仿冒应用包名 */
FakeAPPPackageName?: string;
/** 仿冒应用证书 */
FakeAPPCert?: string;
/** 仿冒应用大小 */
FakeAPPSize?: string;
/** 仿冒截图 */
FakeAPPSnapshots?: string[];
/** 备注 */
Note?: string;
}
declare interface CreateBPFakeAPPResponse {
/** FakeAPPId */
FakeAPPId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateBPFakeURLRequest {
/** 企业id */
CompanyId: number;
/** 仿冒网址 */
FakeURL: string;
/** 仿冒网址截图 */
FakeURLSnapshots?: string[];
/** 备注 */
Note?: string;
}
declare interface CreateBPFakeURLResponse {
/** FakeURLId */
FakeURLId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateBPFakeURLsRequest {
/** 批量模板 */
FakeURLs: string;
}
declare interface CreateBPFakeURLsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateBPWhiteListRequest {
/** 企业Id */
CompanyId: number;
/** 白名单类型:0-网站 1-应用 2-公众号 3-小程 */
WhiteListType: number;
/** 白名单名称 */
WhiteLists: string[];
/** 白名单备注 */
Remark?: string;
}
declare interface CreateBPWhiteListResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteBPWhiteListRequest {
/** 白名单id */
WhiteListId: number;
}
declare interface DeleteBPWhiteListResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBPBrandsRequest {
}
declare interface DescribeBPBrandsResponse {
/** 品牌信息 */
Brands?: BrandData[];
/** 品牌审核通知栏状态:0 不显示 1 显示 */
NoticeStatus?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBPFakeAPPListRequest {
/** 过滤参数 */
Filters?: Filter[];
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
}
declare interface DescribeBPFakeAPPListResponse {
/** 仿冒应用列表 */
FakeAPPList?: FakeAPPData[];
/** 仿冒应用总数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBPFakeURLsRequest {
/** 过滤参数 */
Filters?: Filter[];
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
}
declare interface DescribeBPFakeURLsResponse {
/** 仿冒网址列表 */
FakeURLs?: FakeURLData[];
/** 仿冒网址总数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeBPWhiteListsRequest {
/** 过滤参数 */
Filters?: Filter[];
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
}
declare interface DescribeBPWhiteListsResponse {
/** 白名单列表 */
WhiteLists?: WhiteListData[];
/** 白名单总数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare namespace V20210624 {
type VersionHeader = { headers: { 'X-TC-Version': '2021-06-24' } }
/** 商标信息 */
interface BrandData {
/** 商标名称 */
BrandName: string;
/** 商标证明 */
BrandCertificateName: string;
/** 商标审核状态 1-审核中 2-审核未通过 3-审核通过 */
BrandStatus: number;
/** 审核说明 */
BrandNote: string;
/** 商标转让证明 */
TransferName: string;
/** 商标转让证明审核状态 */
TransferStatus: number;
/** 审核说明 1-审核中 2-审核未通过 3-审核通过 */
TransferNote: string;
}
/** 仿冒网站信息 */
interface FakeURLInfo {
/** 仿冒网址ID */
FakeURLId: number;
/** 保护网站 */
ProtectWeb: string;
/** 检测时间 */
DetectTime: string;
/** 仿冒网址 */
FakeURL: string;
/** 截图 */
Snapshot: string;
/** IP地址 */
IP: string;
/** IP地理位置 */
IPLoc: string;
/** 热度 */
Heat: number;
/** 网址状态 */
Status: number;
/** 备注 */
Note: string;
/** 仿冒网站所属单位 */
FakeURLCompany: string;
/** 仿冒网站性质 */
FakeURLAttr: string;
/** 仿冒网站名称 */
FakeURLName: string;
/** 仿冒网站备案号 */
FakeURLICP: string;
/** 仿冒网站创建时间 */
FakeURLCreateTime: string;
/** 仿冒网站过期时间 */
FakeURLExpireTime: string;
}
/** 权属文件列表 */
interface File {
/** 文件下载地址 */
FileUrl: string;
/** 文件类型 1-委托书 2-授权书 5-存证证书 11-营业执照 */
FileType: number;
/** 文件有效开始日期 */
ValidStartDate: string;
/** 文件有效截止日期 */
ValidEndDate: string;
}
/** 过滤参数 */
interface Filter {
}
/** 版权保护-监测结果 */
interface Monitor {
/** 作品ID */
WorkId: number;
/** 作品名称 */
WorkName: string;
/** 作品内容类型 01-视频 02-音频 03-文本 04-图片 */
WorkType: string;
/** 侵权平台数量 */
TortPlatNum: number;
/** 侵权链接数量 */
TortURLNum: number;
/** 监测时间 */
MonitorTime: string;
/** 0-待监测 1-监测中 2-不监测 3-暂停监测 */
MonitorStatus: number;
/** 作品类型 */
WorkCategory: string;
/** 新增时间 */
InsertTime: string;
/** 监测状态说明 */
MonitorNote: string;
/** 作品类型全部展示 */
WorkCategoryAll: string;
/** 存证状态 */
EvidenceStatus: number;
/** 存证状态说明 */
EvidenceNote: string;
/** 侵权站点数量 */
TortSiteNum: number;
/** 监测截止时间 */
MonitorEndTime?: string;
/** 是否自动续费 */
AutoRenew?: number;
}
/** 监测侵权信息详情 */
interface MonitorTort {
/** 侵权信息ID */
TortId: number;
/** 侵权标题 */
TortTitle: string;
/** 侵权平台 */
TortPlat: string;
/** 侵权链接 */
TortURL: string;
/** 侵权链接发布时间 */
PubTime: string;
/** 作者 */
Author: string;
/** 发现时间 */
DetectTime: string;
/** 取证状态 */
ObtainStatus: number;
/** 维权状态 */
RightStatus: number;
/** 拦截状态 */
BlockStatus: number;
/** 侵权编号 */
TortNum: string;
/** 取证状态说明 */
ObtainNote: string;
/** 作品标题 */
WorkTitle: string;
/** 侵权站点 */
TortSite: string;
/** ICP备案信息 */
ICP: string;
/** 维权状态说明 */
RightNote: string;
/** 取证类型 */
ObtainType: number;
/** 拦截状态说明 */
BlockNote: string;
/** 作品ID */
WorkId: number;
/** 作品名称 */
WorkName: string;
/** 授权书状态 */
AuthStatus: number;
/** 委托书状态 */
CommStatus: number;
/** 存证证书状态 */
EvidenceStatus: number;
/** 是否著作权人 */
IsProducer: number;
/** 是否境外网址 */
IsOverseas: number;
/** ip地理位置 */
IPLoc: string;
}
/** 保护网站信息 */
interface ProtectURLInfo {
/** 保护网站ID */
ProtectURLId: number;
/** 保护网站 */
ProtectURL: string;
/** 保护网站名称 */
ProtectWeb: string;
/** 保护网站审核状态 1-审核中 2-审核不通过 3-审核通过 */
ProtectURLStatus: number;
/** 网站审核不通过原因 */
ProtectURLNote: string;
/** 创建时间 */
CreateTime: string;
}
/** 举报网址信息 */
interface ReportFakeURLInfo {
/** 仿冒网址ID */
FakeURLId: number;
/** 检测时间 */
DetectTime: string;
/** 保护网站 */
ProtectURL: string;
/** 保护网站名称 */
ProtectWeb: string;
/** 仿冒网址 */
FakeURL: string;
/** 截图 */
Snapshot: string;
/** IP地址 */
IP: string;
/** IP地理位置 */
IPLoc: string;
/** 热度 */
Heat: number;
/** 网站状态 */
Status: number;
/** 网站不处理原因 */
Note: string;
/** 仿冒网站的企业名称 */
FakeURLCompany: string;
/** 仿冒网站的网站性质 */
FakeURLAttr: string;
/** 仿冒网站的网站名称 */
FakeURLName: string;
/** 仿冒网站的备案 */
FakeURLICP: string;
/** 仿冒网站创建时间 */
FakeURLCreateTime: string;
/** 仿冒网站过期时间 */
FakeURLExpireTime: string;
/** 协查处置时间 */
BlockTime: string;
}
interface CreateBPFakeURLRequest {
/** 保护网址ID */
ProtectURLId?: number;
/** 仿冒网址 */
FakeURL?: string;
/** 截图 */
SnapshotNames?: string[];
/** 举报说明 */
Note?: string;
}
interface CreateBPFakeURLResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateBPFalseTicketRequest {
/** 仿冒网址 */
FakeURL?: string;
}
interface CreateBPFalseTicketResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateBPOfflineAttachmentRequest {
/** 品牌名字 */
BrandName?: string;
/** 商标证明 */
BrandCertificateName?: string;
/** 商标转让证明 */
TransferName?: string;
/** 授权书 */
AuthorizationName?: string;
}
interface CreateBPOfflineAttachmentResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateBPOfflineTicketRequest {
/** 仿冒网址ID */
FakeURLId?: number;
}
interface CreateBPOfflineTicketResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateBPProtectURLsRequest {
/** 企业名称 */
CompanyName?: string;
/** 电话号码 */
Phone?: string;
/** 营业执照 */
LicenseName?: string;
/** 保护网站 */
ProtectURLs?: string[];
/** 网站名称 */
ProtectWebs?: string[];
}
interface CreateBPProtectURLsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRBlockRequest {
/** 作品ID */
WorkId: number;
/** 侵权链接 */
TortUrl: string;
/** 侵权标题 */
TortTitle?: string;
/** 侵权平台 */
TortPlat?: string;
/** 拦截结果回调地址 */
BlockUrl?: string;
/** 授权书下载地址 */
FileUrl?: string;
/** 授权书生效日期 */
ValidStartDate?: string;
/** 授权书截止日期 */
ValidEndDate?: string;
/** 侵权截图 */
TortPic?: string;
/** 委托书下载地址 */
CommFileUrl?: string;
/** 委托书生效日期 */
CommValidStartDate?: string;
/** 委托书截止日期 */
CommValidEndDate?: string;
/** 是否著作权人:0-否 1-是 */
IsProducer?: string;
/** 存证证书下载地址 */
EvidenceFileUrl?: string;
/** 存证证书生效日期 */
EvidenceValidStartDate?: string;
/** 存证证书截止日期 */
EvidenceValidEndDate?: string;
}
interface CreateCRBlockResponse {
/** 侵权ID */
TortId: number;
/** 该字段已废弃 */
TortNum: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRCompanyVerifyRequest {
/** 企业名称 */
CompanyName: string;
/** 企业证件号码 */
CompanyID?: string;
/** 企业法人姓名 */
CompanyLegalName?: string;
/** 联系人姓名 */
ManagerName?: string;
/** 联系人手机号 */
ManagerPhone?: string;
/** 手机验证码,接口接入可以置空 */
VerificationCode?: string;
/** 字段已废弃,企业认证号码类型 1:社会信用代码 2:组织机构代码 3:企业工商注册码 4:其他 默认为1 */
CompanyIDType?: string;
/** 字段已废弃,认证类型 */
Type?: string;
}
interface CreateCRCompanyVerifyResponse {
/** 认证状态:0-认证成功 1-认证失败 */
Status: number;
/** 认证状态说明,包括认证失败的原因 */
Note: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRDesktopCodeRequest {
/** xxx */
TortId: number;
/** xxx */
DesktopCode: string;
}
interface CreateCRDesktopCodeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRRightFileRequest {
/** 作品ID */
WorkId: number;
/** 权属文件列表 */
FileList: File[];
}
interface CreateCRRightFileResponse {
/** 权属文件Id,按提交顺序排序 */
FileIds: number[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRRightRequest {
/** 作品ID */
WorkId: number;
/** 侵权链接 */
TortUrl: string;
/** 侵权标题 */
TortTitle?: string;
/** 侵权平台 */
TortPlat?: string;
/** 发函结果回调地址 */
RightUrl?: string;
/** 授权书下载地址 */
FileUrl?: string;
/** 授权书生效日期 */
ValidStartDate?: string;
/** 授权书截止日期 */
ValidEndDate?: string;
/** 委托书下载地址 */
CommFileUrl?: string;
/** 委托书生效日期 */
CommValidStartDate?: string;
/** 委托书截止日期 */
CommValidEndDate?: string;
/** 主页下载地址 */
HomeFileUrl?: string;
/** 主页生效日期 */
HomeValidStartDate?: string;
/** 主页截止日期 */
HomeValidEndDate?: string;
/** 是否著作权人:0-否 1-是 */
IsProducer?: string;
/** 存证证书下载地址 */
EvidenceFileUrl?: string;
/** 存证证书生效日期 */
EvidenceValidStartDate?: string;
/** 存证证书截止日期 */
EvidenceValidEndDate?: string;
}
interface CreateCRRightResponse {
/** 侵权ID */
TortId: number;
/** 该字段已废弃 */
TortNum: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRTortRequest {
/** 作品ID */
WorkId: number;
/** 侵权网址 */
TortURL: string;
/** 侵权平台 */
TortPlat?: string;
/** 侵权标题 */
TortTitle?: string;
}
interface CreateCRTortResponse {
/** 作品ID */
WorkId: number;
/** 侵权ID */
TortId: number;
/** 侵权标题 */
TortTitle: string;
/** 侵权平台 */
TortPlat: string;
/** 侵权网址 */
TortURL: string;
/** 侵权域名 */
TortDomain: string;
/** 侵权主体 */
TortBodyName: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRUserVerifyRequest {
/** 用户真实姓名 */
UserName: string;
/** 用户身份证号 */
UserID: string;
/** 用户手机号码 */
UserPhone: string;
/** 短信验证码,接口接入可以置空 */
VerificationCode?: string;
/** 字段已废弃,认证类型 */
Type?: string;
}
interface CreateCRUserVerifyResponse {
/** 认证状态:0-认证成功 1-认证失败 */
Status: number;
/** 认证状态说明,包括认证失败原因等 */
Note: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface CreateCRWorkRequest {
/** 作品名称 */
WorkName: string;
/** 作品分类 */
WorkCategory: string;
/** 作品内容类型 */
WorkType: string;
/** 作品标签 */
WorkSign?: string;
/** 字段已废弃,作品图片 */
WorkPic?: string;
/** 作品描述 */
WorkDesc?: string;
/** 是否原创:0-否 1-是 */
IsOriginal?: string;
/** 是否发布:0-未发布 1-已发布 */
IsRelease?: string;
/** 字段已废弃,著作权人ID */
ProducerID?: number;
/** 创作时间 */
ProduceTime?: string;
/** 字段已废弃 */
SampleContentURL?: string;
/** 作品下载地址 */
SampleDownloadURL?: string;
/** 作品在线地址 */
SamplePublicURL?: string;
/** 字段已废弃,授予类型 */
GrantType?: string;
/** 是否监测:0-不监测 1-监测 */
IsMonitor?: string;
/** 是否存证:0-不存证 2-存证 注意是2 */
IsCert?: string;
/** 存证回调地址 */
CertUrl?: string;
/** 监测回调地址 */
MonitorUrl?: string;
/** 字段已废弃,创作性质 */
ProduceType?: string;
/** 白名单列表 */
WhiteLists?: string[];
/** 作品ID,忽略该字段 */
WorkId?: number;
/** 著作权人姓名 */
ProducerName?: string;
/** 作者,小说类型必填 */
Nickname?: string;
/** 授权书下载地址 */
Authorization?: string;
/** 授权书开始时间 */
AuthorizationStartTime?: string;
/** 授权书结束时间 */
AuthorizationEndTime?: string;
/** 内容格式,支持txt、doc等,表示Content的具体格式 */
ContentType?: string;
/** 文件内容base64编码,该字段仅在无法提供下载链接时使用 */
Content?: string;
/** 监测结束时间 */
MonitorEndTime?: string;
/** 申请人ID,用于存证和取证 */
ApplierId?: string;
/** 申请人姓名,用于存证和取证 */
ApplierName?: string;
/** 是否自动续期 */
IsAutoRenew?: string;
}
interface CreateCRWorkResponse {
/** 作品ID,一个作品对应唯一的workid */
WorkId?: number;
/** 存证ID,忽略该字段 */
EvidenceId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeBPCompanyInfoRequest {
}
interface DescribeBPCompanyInfoResponse {
/** 企业名称 */
CompanyName: string;
/** 电话号码 */
Phone: string;
/** 营业执照 */
LicenseName: string;
/** 营业执照审核状态 1-审核中 2-审核未通过,3、审核通过 */
LicenseStatus: number;
/** 营业执照备注 */
LicenseNote: string;
/** 授权书 */
AuthorizationName: string;
/** 授权书审核状态 */
AuthorizationStatus: number;
/** 授权书备注 */
AuthorizationNote: string;
/** 品牌信息 */
BrandDatas: BrandData[];
/** 企业ID */
CompanyId: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeBPFakeURLsRequest {
/** 过滤条件 */
Filters?: Filter[];
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
}
interface DescribeBPFakeURLsResponse {
/** 仿冒网址列表 */
FakeURLInfos: FakeURLInfo[];
/** 总量 */
TotalCount: number;
/** 导出量 */
ExportURL: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeBPProtectURLsRequest {
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
}
interface DescribeBPProtectURLsResponse {
/** 保护网址列表 */
ProtectURLInfos: ProtectURLInfo[];
/** 总量 */
TotalCount: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeBPReportFakeURLsRequest {
/** 过滤条件 */
Filters?: Filter[];
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
}
interface DescribeBPReportFakeURLsResponse {
/** 举报网站列表 */
ReportFakeURLInfos: ReportFakeURLInfo[];
/** 总量 */
TotalCount: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeCRMonitorDetailRequest {
/** 作品ID */
WorkId: number;
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
/** 过滤参数 */
Filters?: Filter[];
}
interface DescribeCRMonitorDetailResponse {
/** 侵权数组 */
Torts: MonitorTort[];
/** 总记录数 */
TotalCount: number;
/** 监测状态 */
MonitorStatus: number;
/** 导出地址 */
ExportURL: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeCRMonitorsRequest {
/** 过滤条件 */
Filters?: Filter[];
/** 页数 */
PageSize?: number;
/** 页码 */
PageNumber?: number;
}
interface DescribeCRMonitorsResponse {
/** 监测结果 */
Monitors?: Monitor[];
/** 记录总条数 */
TotalCount?: number;
/** 导出地址 */
ExportURL?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeCRObtainDetailRequest {
/** 侵权ID */
TortId: number;
}
interface DescribeCRObtainDetailResponse {
/** 作品名称 */
WorkName: string;
/** 侵权链接 */
TortURL: string;
/** 取证时间 */
ObtainTime: string;
/** 取证类型 */
ObtainType: string;
/** 取证号 */
ObtainNum: string;
/** 证据地址 */
DepositFile: string;
/** 公证信息地址 */
DepositCert: string;
/** 内容类型 */
WorkType: string;
/** 作品类型 */
WorkCategory: string;
/** 侵权ID */
TortId: number;
/** 侵权编号 */
TortNum: string;
/** 取证状态 */
ObtainStatus: number;
/** 取证状态说明 */
ObtainNote: string;
/** 取证时长 */
ObtainDuration: string;
/** 取证名称 */
ObtainName: string;
/** 取证公证信息 */
DepositPdfCert: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface DescribeCRWorkInfoRequest {
/** 作品ID */
WorkId: number;
}
interface DescribeCRWorkInfoResponse {
/** 作品名称 */
WorkName: string;
/** 监测状态 */
MonitorStatus: number;
/** 授权文件状态 */
AuthStatus: number;
/** 委托书状态 */
CommStatus: number;
/** 是否著作权人 */
IsProducer: number;
/** 存证证书状态 */
EvidenceStatus: number;
/** 作品类型 */
WorkCategory: string;
/** 是否原创 */
IsOriginal: string;
/** 是否已发表 */
IsRelease: string;
/** 著作权人姓名 */
ProducerName: string;
/** 发表时间 */
ProduceTime: string;
/** 白名单 */
WhiteLists: string[];
/** 作品描述 */
WorkDesc: string;
/** 授权书 */
Authorization: string;
/** 授权书生效日期 */
AuthorizationStartTime: string;
/** 授权书截止日期 */
AuthorizationEndTime: string;
/** 委托书 */
Commission: string;
/** 委托书生效日期 */
CommissionStartTime: string;
/** 委托书截止日期 */
CommissionEndTime: string;
/** 存证证书 */
EvidenceUrl: string;
/** 存证证书生效日期 */
EvidenceStartTime: string;
/** 存证证书截止日期 */
EvidenceEndTime: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface ModifyBPOfflineAttachmentRequest {
/** 营业执照 */
LicenseName?: string;
/** 授权书 */
AuthorizationName?: string;
/** 商标名称 */
BrandName?: string;
/** 商标证明 */
BrandCertificateName?: string;
/** 商标转让证明 */
TransferName?: string;
}
interface ModifyBPOfflineAttachmentResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface ModifyCRBlockStatusRequest {
/** 侵权ID */
TortId: number;
/** 拦截结果回调地址 */
BlockUrl?: string;
}
interface ModifyCRBlockStatusResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface ModifyCRMonitorRequest {
/** 作品ID */
WorkId: number;
/** 监测状态:1-开启监测 2-关闭监测 */
MonitorStatus: string;
/** 监测截止时间 */
MonitorEnd?: string;
}
interface ModifyCRMonitorResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface ModifyCRObtainStatusRequest {
/** 侵权ID */
TortId: number;
/** 取证类型:1-网页取证 2-过程取证(暂不提供) */
ObtainType: number;
/** 过程取证的取证时长,单位分钟,范围0-120 */
ObtainDuration: number;
/** 取证结果回调地址 */
ObtainUrl?: string;
}
interface ModifyCRObtainStatusResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface ModifyCRRightStatusRequest {
/** 侵权ID */
TortId: number;
/** 发函结果回调地址 */
RightUrl?: string;
}
interface ModifyCRRightStatusResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface ModifyCRWhiteListRequest {
/** 该字段已废弃,白名单ID */
WhiteListId?: number;
/** 该字段已废弃,平台名称 */
PlatForm?: string;
/** 该字段已废弃,平台站点链接 */
PlatUrl?: string;
/** 该字段已废弃,作者ID */
AuthorId?: string;
/** 该字段已废弃,作品ID */
WorksId?: number;
/** 作品ID */
WorkId?: number;
/** 白名单列表,以\n分割 */
WhiteSites?: string;
}
interface ModifyCRWhiteListResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
interface UpdateCRWorkRequest {
/** 作品ID */
WorkId: number;
/** 文件的扩展名,例如txt,docx */
ContentType?: string;
/** 内容的base64编码 */
Content?: string;
/** 本次存证类型:0-不存证 1-存当前文件 2-存历史全量文件 */
CertType?: string;
}
interface UpdateCRWorkResponse {
/** 作品ID */
WorkId: number;
/** 存证ID */
EvidenceId: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
}
/** {@link Bma 品牌经营管家} */
declare interface Bma {
(): Versions;
/** 添加品牌 {@link CreateBPBrandRequest} {@link CreateBPBrandResponse} */
CreateBPBrand(data: CreateBPBrandRequest, config?: AxiosRequestConfig): AxiosPromise<CreateBPBrandResponse>;
/** 仿冒应用举报 {@link CreateBPFakeAPPRequest} {@link CreateBPFakeAPPResponse} */
CreateBPFakeAPP(data: CreateBPFakeAPPRequest, config?: AxiosRequestConfig): AxiosPromise<CreateBPFakeAPPResponse>;
/** 批量仿冒应用举报 {@link CreateBPFakeAPPListRequest} {@link CreateBPFakeAPPListResponse} */
CreateBPFakeAPPList(data: CreateBPFakeAPPListRequest, config?: AxiosRequestConfig): AxiosPromise<CreateBPFakeAPPListResponse>;
/** 仿冒网址举报 {@link CreateBPFakeURLRequest} {@link CreateBPFakeURLResponse} */
CreateBPFakeURL(data: CreateBPFakeURLRequest, config?: AxiosRequestConfig): AxiosPromise<CreateBPFakeURLResponse>;
/** 批量仿冒网址举报 {@link CreateBPFakeURLsRequest} {@link CreateBPFakeURLsResponse} */
CreateBPFakeURLs(data: CreateBPFakeURLsRequest, config?: AxiosRequestConfig): AxiosPromise<CreateBPFakeURLsResponse>;
/** 添加白名单 {@link CreateBPWhiteListRequest} {@link CreateBPWhiteListResponse} */
CreateBPWhiteList(data: CreateBPWhiteListRequest, config?: AxiosRequestConfig): AxiosPromise<CreateBPWhiteListResponse>;
/** 删除白名单 {@link DeleteBPWhiteListRequest} {@link DeleteBPWhiteListResponse} */
DeleteBPWhiteList(data: DeleteBPWhiteListRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteBPWhiteListResponse>;
/** 查询品牌列表 {@link DescribeBPBrandsRequest} {@link DescribeBPBrandsResponse} */
DescribeBPBrands(data?: DescribeBPBrandsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBPBrandsResponse>;
/** 查询仿冒应用列表 {@link DescribeBPFakeAPPListRequest} {@link DescribeBPFakeAPPListResponse} */
DescribeBPFakeAPPList(data?: DescribeBPFakeAPPListRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBPFakeAPPListResponse>;
/** 查询仿冒网址列表 {@link DescribeBPFakeURLsRequest} {@link DescribeBPFakeURLsResponse} */
DescribeBPFakeURLs(data?: DescribeBPFakeURLsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBPFakeURLsResponse>;
/** 查询白名单列表 {@link DescribeBPWhiteListsRequest} {@link DescribeBPWhiteListsResponse} */
DescribeBPWhiteLists(data?: DescribeBPWhiteListsRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeBPWhiteListsResponse>;
/** 添加仿冒链接(举报) {@link V20210624.CreateBPFakeURLRequest} {@link V20210624.CreateBPFakeURLResponse} */
CreateBPFakeURL(data: V20210624.CreateBPFakeURLRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateBPFakeURLResponse>;
/** 添加误报工单 {@link V20210624.CreateBPFalseTicketRequest} {@link V20210624.CreateBPFalseTicketResponse} */
CreateBPFalseTicket(data: V20210624.CreateBPFalseTicketRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateBPFalseTicketResponse>;
/** 添加下线材料 {@link V20210624.CreateBPOfflineAttachmentRequest} {@link V20210624.CreateBPOfflineAttachmentResponse} */
CreateBPOfflineAttachment(data: V20210624.CreateBPOfflineAttachmentRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateBPOfflineAttachmentResponse>;
/** 添加下线工单 {@link V20210624.CreateBPOfflineTicketRequest} {@link V20210624.CreateBPOfflineTicketResponse} */
CreateBPOfflineTicket(data: V20210624.CreateBPOfflineTicketRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateBPOfflineTicketResponse>;
/** 添加保护网站 {@link V20210624.CreateBPProtectURLsRequest} {@link V20210624.CreateBPProtectURLsResponse} */
CreateBPProtectURLs(data: V20210624.CreateBPProtectURLsRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateBPProtectURLsResponse>;
/** 新建协查处置 {@link V20210624.CreateCRBlockRequest} {@link V20210624.CreateCRBlockResponse} */
CreateCRBlock(data: V20210624.CreateCRBlockRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRBlockResponse>;
/** 企业认证 {@link V20210624.CreateCRCompanyVerifyRequest} {@link V20210624.CreateCRCompanyVerifyResponse} */
CreateCRCompanyVerify(data: V20210624.CreateCRCompanyVerifyRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRCompanyVerifyResponse>;
/** 新建过程取证码 {@link V20210624.CreateCRDesktopCodeRequest} {@link V20210624.CreateCRDesktopCodeResponse} */
CreateCRDesktopCode(data: V20210624.CreateCRDesktopCodeRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRDesktopCodeResponse>;
/** 新建发函 {@link V20210624.CreateCRRightRequest} {@link V20210624.CreateCRRightResponse} */
CreateCRRight(data: V20210624.CreateCRRightRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRRightResponse>;
/** 权属文件添加 {@link V20210624.CreateCRRightFileRequest} {@link V20210624.CreateCRRightFileResponse} */
CreateCRRightFile(data: V20210624.CreateCRRightFileRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRRightFileResponse>;
/** 举报侵权链接 {@link V20210624.CreateCRTortRequest} {@link V20210624.CreateCRTortResponse} */
CreateCRTort(data: V20210624.CreateCRTortRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRTortResponse>;
/** 个人认证 {@link V20210624.CreateCRUserVerifyRequest} {@link V20210624.CreateCRUserVerifyResponse} */
CreateCRUserVerify(data: V20210624.CreateCRUserVerifyRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRUserVerifyResponse>;
/** 新建作品 {@link V20210624.CreateCRWorkRequest} {@link V20210624.CreateCRWorkResponse} */
CreateCRWork(data: V20210624.CreateCRWorkRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.CreateCRWorkResponse>;
/** 查询企业信息 {@link V20210624.DescribeBPCompanyInfoRequest} {@link V20210624.DescribeBPCompanyInfoResponse} */
DescribeBPCompanyInfo(data: V20210624.DescribeBPCompanyInfoRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeBPCompanyInfoResponse>;
/** 查询仿冒链接 {@link V20210624.DescribeBPFakeURLsRequest} {@link V20210624.DescribeBPFakeURLsResponse} */
DescribeBPFakeURLs(data: V20210624.DescribeBPFakeURLsRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeBPFakeURLsResponse>;
/** 查询保护网站 {@link V20210624.DescribeBPProtectURLsRequest} {@link V20210624.DescribeBPProtectURLsResponse} */
DescribeBPProtectURLs(data: V20210624.DescribeBPProtectURLsRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeBPProtectURLsResponse>;
/** 查询举报列表 {@link V20210624.DescribeBPReportFakeURLsRequest} {@link V20210624.DescribeBPReportFakeURLsResponse} */
DescribeBPReportFakeURLs(data: V20210624.DescribeBPReportFakeURLsRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeBPReportFakeURLsResponse>;
/** 查询作品监测详情 {@link V20210624.DescribeCRMonitorDetailRequest} {@link V20210624.DescribeCRMonitorDetailResponse} */
DescribeCRMonitorDetail(data: V20210624.DescribeCRMonitorDetailRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeCRMonitorDetailResponse>;
/** 查询监测列表 {@link V20210624.DescribeCRMonitorsRequest} {@link V20210624.DescribeCRMonitorsResponse} */
DescribeCRMonitors(data: V20210624.DescribeCRMonitorsRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeCRMonitorsResponse>;
/** 查询取证详情 {@link V20210624.DescribeCRObtainDetailRequest} {@link V20210624.DescribeCRObtainDetailResponse} */
DescribeCRObtainDetail(data: V20210624.DescribeCRObtainDetailRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeCRObtainDetailResponse>;
/** 查询作品基本信息 {@link V20210624.DescribeCRWorkInfoRequest} {@link V20210624.DescribeCRWorkInfoResponse} */
DescribeCRWorkInfo(data: V20210624.DescribeCRWorkInfoRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.DescribeCRWorkInfoResponse>;
/** 修改下线材料 {@link V20210624.ModifyBPOfflineAttachmentRequest} {@link V20210624.ModifyBPOfflineAttachmentResponse} */
ModifyBPOfflineAttachment(data: V20210624.ModifyBPOfflineAttachmentRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.ModifyBPOfflineAttachmentResponse>;
/** 协查处置申请 {@link V20210624.ModifyCRBlockStatusRequest} {@link V20210624.ModifyCRBlockStatusResponse} */
ModifyCRBlockStatus(data: V20210624.ModifyCRBlockStatusRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.ModifyCRBlockStatusResponse>;
/** 开启或关闭监测 {@link V20210624.ModifyCRMonitorRequest} {@link V20210624.ModifyCRMonitorResponse} */
ModifyCRMonitor(data: V20210624.ModifyCRMonitorRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.ModifyCRMonitorResponse>;
/** 取证申请 {@link V20210624.ModifyCRObtainStatusRequest} {@link V20210624.ModifyCRObtainStatusResponse} */
ModifyCRObtainStatus(data: V20210624.ModifyCRObtainStatusRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.ModifyCRObtainStatusResponse>;
/** 发函申请 {@link V20210624.ModifyCRRightStatusRequest} {@link V20210624.ModifyCRRightStatusResponse} */
ModifyCRRightStatus(data: V20210624.ModifyCRRightStatusRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.ModifyCRRightStatusResponse>;
/** 修改白名单列表 {@link V20210624.ModifyCRWhiteListRequest} {@link V20210624.ModifyCRWhiteListResponse} */
ModifyCRWhiteList(data: V20210624.ModifyCRWhiteListRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.ModifyCRWhiteListResponse>;
/** 更新作品 {@link V20210624.UpdateCRWorkRequest} {@link V20210624.UpdateCRWorkResponse} */
UpdateCRWork(data: V20210624.UpdateCRWorkRequest, config: AxiosRequestConfig & V20210624.VersionHeader): AxiosPromise<V20210624.UpdateCRWorkResponse>;
}
export declare type Versions = ["2022-11-15", "2021-06-24"];
export default Bma;