client/typescript/notify/index.ts

163 lines
5.4 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Code generated by protoc-gen-typescript-http. DO NOT EDIT.
/* eslint-disable camelcase */
// @ts-nocheck
/** sms module */
export type SendMailRequest = {
/** 必传项 */
signName?: string;
};
export type SendMailResponse = {
requestId?: string;
};
/** Mail method */
export interface Mail {
}
type RequestType = {
path: string;
method: string;
body: string | null;
};
type RequestHandler = (request: RequestType, meta: { service: string, method: string }) => Promise<unknown>;
export function createMailClient(
handler: RequestHandler
): Mail {
return {
};
}
export type StatusReply = {
/** 状态码 */
status?: number;
/** 标识码 */
identity?: string;
/** 状态说明 */
message?: string;
/** 响应时间序列 */
timeseq?: number;
};
export type BaseItem = {
/** 消息的内容。(注意:需要对payload字符串做urlencode处理 */
payload?: string;
/** App的包名。备注:中间用逗号分割。 */
restrictedPackageName?: string;
/** 通知栏展示的通知的标题不允许全是空白字符长度小于50 一个中英文字符均计算为1通知栏消息必填。 */
title?: string;
/** 通知栏展示的通知的描述不允许全是空白字符长度小于128一个中英文字符均计算为1通知栏消息必填。 */
description?: string;
/** 可选项。如果用户离线,设置消息在服务器保存的时间,单位:ms。服务器默认最长保留两周。 */
timeToLive?: number;
/** 可选项。定时发送消息。用自1970年1月1日以来00:00:00.0 UTC时间表示以毫秒为单位的时间。注:仅支持七天内的定时消息。 */
timeToSend?: number;
/** 可选项自定义通知栏消息铃声url */
soundUri?: string;
/** 可选项 '1'弹出通知栏消息(默认);'0'不会弹出通知栏消息 */
notifyForeground?: string;
/** 可选项,预定义通知栏消息的点击行为;"1":打开app的Launcher Activity。"2":打开app的任一Activity需要extra.intent_uri。"3":打开网页需要传入extra.web_uri */
notifyEffect?: string;
/** 可选项打开当前app的任一组件。 */
intentUri?: string;
/** 可选项,打开某一个网页。 */
webUri?: string;
/** 可选项使用推送批次JobKey功能聚合消息。由数字[0-9]),大小写字母([a-zA-Z]下划线_和中划线-组成长度不大于20个字符 */
jobkey?: string;
/** 可以接收消息的app版本号用逗号分割。目前支持MiPush_SDK_Client_2_2_12_sdk.jar及以后的版本。 */
appVersion?: string;
/** 无法接收消息的app版本号用逗号分割。 */
appVersionNotIn?: string;
/** 可选项,指定在特定的网络环境下才能接收到消息。目前仅支持指定"wifi"。 */
connpt?: string;
/** 可选项extra.only_send_once的值设置为'1',表示该消息仅在设备在线时发送一次,不缓存离线消息进行多次下发 */
onlySendOnce?: string;
/** 可选项。默认情况下通知栏只显示一条推送消息。如果通知栏要显示多条推送消息需要针对不同的消息设置不同的notify_id相同notify_id的通知栏消息会覆盖之前的且要求notify_id为取值在0~2147483647的整数。 */
notifyId?: number;
};
export type ARequest = {
/** 推送类型:"alias";"registration_id"; 注:需要与push_id对应 */
pushType?: string;
/** 根据alias或registration_id或account发送消息到指定设备上用逗号分割。 */
pushId?: string[];
message?: BaseItem;
};
export type TopicRequest = {
/** 根据topic发送消息给订阅了该topic的所有设备 */
topic?: string;
message?: BaseItem;
};
export type MultiTopicRequest = {
/** topic列表使用;$;分割。注: topics参数需要和topic_op参数配合使用另外topic的数量不能超过5。 */
topics?: string;
/** topic之间的操作关系。支持以下三种:UNION并集INTERSECTION交集EXCEPT差集例如:topics的列表元素是[A, B, C, D]则并集结果是ABCD交集的结果是A ∩B ∩C ∩D差集的结果是A-B-C-D。 */
topicOp?: string;
message?: BaseItem;
};
export interface Xiaomi {
}
export function createXiaomiClient(
handler: RequestHandler
): Xiaomi {
return {
};
}
/** sms module */
export type SmsSendRequest = {
/** 必传项 */
signName?: string;
/** 必传项 */
templateCode?: string;
/** 必传项 */
phone?: string;
paramters?: { [key: string]: string };
/** 是否生成验证码 */
/** 验证码相关 */
generateCode?: boolean;
/** 验证码缓存时间,单位:分钟,仅generate_code为true时会缓存,默认5分钟 */
expireInterval?: number;
/** 验证码长度,默认 4 */
codeWidth?: number;
/** template_code 模板中验证码的标识,默认code */
codeKey?: string;
/** 是否黑单过滤,默认不过滤 */
hasBlackListFilter?: boolean;
/** 忽略每天短信条数上线限制,默认不忽略 */
wihoutLimit?: boolean;
};
export type SmsSendResponse = {
/** string request_id = 1; */
bizId?: string;
};
export type SmsVerifyRequest = {
/** string request_id = 1; */
phone?: string;
code?: string;
};
export type PassResponse = {
pass?: boolean;
};
/** sms method */
export interface Sms {
}
export function createSmsClient(
handler: RequestHandler
): Sms {
return {
};
}
// @@protoc_insertion_point(typescript-http-eof)