@perk-net/perk-pushplus-sdk 1.0.1 → 1.1.1

package/dist/index.d.cts

@@ -176,7 +176,13 @@ declare enum Template {
     /** 路由器插件定制模板。 */
     ROUTE = "route",
     /** 支付成功通知模板。 */
-    PAY = "pay"
+    PAY = "pay",
+    /** 表单格式模板；发送时需传 pushId（表单编码）。 */
+    FORM = "form",
+    /** 文档格式模板（push 文档）；发送时需传 pushId。 */
+    DOC = "doc",
+    /** 表格格式模板（push 表格）；发送时需传 pushId。 */
+    EXCEL = "excel"
 }
 /**
  * 消息投递状态。
@@ -308,6 +314,8 @@ interface SendRequest {
     to?: string;
     /** 预处理编码（仅会员）。 */
     pre?: string;
+    /** push 编码；template 为 form/doc/excel 时必传。 */
+    pushId?: string;
 }
 declare class SendRequestBuilder {
     private req;
@@ -322,6 +330,7 @@ declare class SendRequestBuilder {
     timestamp(v?: number): this;
     to(v?: string): this;
     pre(v?: string): this;
+    pushId(v?: string): this;
     build(): SendRequest;
 }
 /**
@@ -345,6 +354,8 @@ interface BatchSendRequest {
     timestamp?: number;
     to?: string;
     pre?: string;
+    /** push 编码；template 为 form/doc/excel 时必传。 */
+    pushId?: string;
 }
 /**
  * 链式 Builder：支持以 `channel(Channel)` / `option(string)` 形式累积调用，
@@ -366,6 +377,7 @@ declare class BatchSendRequestBuilder {
     timestamp(v?: number): this;
     to(v?: string): this;
     pre(v?: string): this;
+    pushId(v?: string): this;
     /** 追加一个 channel。 */
     channel(ch: Channel | string): this;
     /** 追加一个 option，与最近一次 channel() 配对；可传空串。 */
@@ -441,6 +453,13 @@ interface AccessKeyResult {
     /** 过期时间（单位秒）。 */
     expiresIn?: number;
 }
+/** 会员信息。 */
+interface VipInfo {
+    /** 是否会员；0-否，1-是。 */
+    isVip?: number;
+    /** 会员到期日。 */
+    lastDay?: string;
+}
 interface UserInfo {
     openId?: string;
     unionId?: string;
@@ -453,6 +472,10 @@ interface UserInfo {
     emailStatus?: number;
     birthday?: string;
     points?: number;
+    /** 会员信息。 */
+    vipInfo?: VipInfo;
+    /** 实名认证状态；0-未实名，1-已实名。 */
+    verifyStatus?: number;
 }
 interface SendCount {
     wechatSendCount?: number;
@@ -1353,4 +1376,4 @@ declare const CallbackParser: {
     parse: typeof parseCallback;
 };
 
-export { AbstractApi, AccessKeyApi, AccessKeyManager, type AccessKeyResult, type ApiResponse, type BatchSendRequest, BatchSendRequestBuilder, type BatchSendResult, CallbackEvent, CallbackParser, type CallbackPayload, Channel, ChannelApi, ClawBotApi, type ClawBotInfo, type ClawBotMessage, type ClawBotQrCode, type CpItem, DEFAULT_BASE_URL, ErrorCode, FetchHttpRequester, FriendApi, type FriendInfo, type FriendItem, type FriendQrCode, type HttpRawBody, type HttpRawRequestOptions, type HttpRequestOptions, type HttpRequester, type HttpResponse, ImageApi, type ImageFileInput, type ImageItem, type ImageUploadOptions, type ImageUploadResult, type ImageUploadToken, type MailDetail, type MailItem, MessageApi, type MessageCompleteInfo, type MessageItem, type MessageTokenAddRequest, MessageTokenApi, type MessageTokenEditRequest, type MessageTokenItem, type MessageTokenOption, type MpItem, OpenAbstractApi, OpenMessageApi, type PageQuery, type PageResult, PreApi, type PreDetail, type PreItem, type PreSaveRequest, type PreTestRequest, PushPlusClient, PushPlusClientBuilder, type PushPlusClientOptions, type PushPlusConfig, PushPlusError, PushPlusException, RateLimitGuard, type ResolvedPushPlusConfig, type SendCount, type SendMessageResult, type SendRequest, SendRequestBuilder, SendStatus, SendStatusDescription, SettingApi, Template, type TopicAddRequest, TopicApi, type TopicDetail, type TopicEditRequest, type TopicItem, type TopicListQuery, type TopicQrCode, TopicUserApi, type TopicUserInfo, type TopicUserItem, type TopicUserListQuery, UserApi, type UserDefaultDetail, type UserDefaultItem, type UserDefaultSaveRequest, type UserInfo, type UserLimitTime, WebhookApi, type WebhookItem, type WebhookSaveRequest, WebhookType, WebhookTypeDescription, batchSendRequest, callExecuteRaw, errorCodeFromValue, isRateLimitedCode, isSuccessfulHttpStatus, parseCallback, resolveConfig, sendRequest };
+export { AbstractApi, AccessKeyApi, AccessKeyManager, type AccessKeyResult, type ApiResponse, type BatchSendRequest, BatchSendRequestBuilder, type BatchSendResult, CallbackEvent, CallbackParser, type CallbackPayload, Channel, ChannelApi, ClawBotApi, type ClawBotInfo, type ClawBotMessage, type ClawBotQrCode, type CpItem, DEFAULT_BASE_URL, ErrorCode, FetchHttpRequester, FriendApi, type FriendInfo, type FriendItem, type FriendQrCode, type HttpRawBody, type HttpRawRequestOptions, type HttpRequestOptions, type HttpRequester, type HttpResponse, ImageApi, type ImageFileInput, type ImageItem, type ImageUploadOptions, type ImageUploadResult, type ImageUploadToken, type MailDetail, type MailItem, MessageApi, type MessageCompleteInfo, type MessageItem, type MessageTokenAddRequest, MessageTokenApi, type MessageTokenEditRequest, type MessageTokenItem, type MessageTokenOption, type MpItem, OpenAbstractApi, OpenMessageApi, type PageQuery, type PageResult, PreApi, type PreDetail, type PreItem, type PreSaveRequest, type PreTestRequest, PushPlusClient, PushPlusClientBuilder, type PushPlusClientOptions, type PushPlusConfig, PushPlusError, PushPlusException, RateLimitGuard, type ResolvedPushPlusConfig, type SendCount, type SendMessageResult, type SendRequest, SendRequestBuilder, SendStatus, SendStatusDescription, SettingApi, Template, type TopicAddRequest, TopicApi, type TopicDetail, type TopicEditRequest, type TopicItem, type TopicListQuery, type TopicQrCode, TopicUserApi, type TopicUserInfo, type TopicUserItem, type TopicUserListQuery, UserApi, type UserDefaultDetail, type UserDefaultItem, type UserDefaultSaveRequest, type UserInfo, type UserLimitTime, type VipInfo, WebhookApi, type WebhookItem, type WebhookSaveRequest, WebhookType, WebhookTypeDescription, batchSendRequest, callExecuteRaw, errorCodeFromValue, isRateLimitedCode, isSuccessfulHttpStatus, parseCallback, resolveConfig, sendRequest };

package/dist/index.d.ts

@@ -176,7 +176,13 @@ declare enum Template {
     /** 路由器插件定制模板。 */
     ROUTE = "route",
     /** 支付成功通知模板。 */
-    PAY = "pay"
+    PAY = "pay",
+    /** 表单格式模板；发送时需传 pushId（表单编码）。 */
+    FORM = "form",
+    /** 文档格式模板（push 文档）；发送时需传 pushId。 */
+    DOC = "doc",
+    /** 表格格式模板（push 表格）；发送时需传 pushId。 */
+    EXCEL = "excel"
 }
 /**
  * 消息投递状态。
@@ -308,6 +314,8 @@ interface SendRequest {
     to?: string;
     /** 预处理编码（仅会员）。 */
     pre?: string;
+    /** push 编码；template 为 form/doc/excel 时必传。 */
+    pushId?: string;
 }
 declare class SendRequestBuilder {
     private req;
@@ -322,6 +330,7 @@ declare class SendRequestBuilder {
     timestamp(v?: number): this;
     to(v?: string): this;
     pre(v?: string): this;
+    pushId(v?: string): this;
     build(): SendRequest;
 }
 /**
@@ -345,6 +354,8 @@ interface BatchSendRequest {
     timestamp?: number;
     to?: string;
     pre?: string;
+    /** push 编码；template 为 form/doc/excel 时必传。 */
+    pushId?: string;
 }
 /**
  * 链式 Builder：支持以 `channel(Channel)` / `option(string)` 形式累积调用，
@@ -366,6 +377,7 @@ declare class BatchSendRequestBuilder {
     timestamp(v?: number): this;
     to(v?: string): this;
     pre(v?: string): this;
+    pushId(v?: string): this;
     /** 追加一个 channel。 */
     channel(ch: Channel | string): this;
     /** 追加一个 option，与最近一次 channel() 配对；可传空串。 */
@@ -441,6 +453,13 @@ interface AccessKeyResult {
     /** 过期时间（单位秒）。 */
     expiresIn?: number;
 }
+/** 会员信息。 */
+interface VipInfo {
+    /** 是否会员；0-否，1-是。 */
+    isVip?: number;
+    /** 会员到期日。 */
+    lastDay?: string;
+}
 interface UserInfo {
     openId?: string;
     unionId?: string;
@@ -453,6 +472,10 @@ interface UserInfo {
     emailStatus?: number;
     birthday?: string;
     points?: number;
+    /** 会员信息。 */
+    vipInfo?: VipInfo;
+    /** 实名认证状态；0-未实名，1-已实名。 */
+    verifyStatus?: number;
 }
 interface SendCount {
     wechatSendCount?: number;
@@ -1353,4 +1376,4 @@ declare const CallbackParser: {
     parse: typeof parseCallback;
 };
 
-export { AbstractApi, AccessKeyApi, AccessKeyManager, type AccessKeyResult, type ApiResponse, type BatchSendRequest, BatchSendRequestBuilder, type BatchSendResult, CallbackEvent, CallbackParser, type CallbackPayload, Channel, ChannelApi, ClawBotApi, type ClawBotInfo, type ClawBotMessage, type ClawBotQrCode, type CpItem, DEFAULT_BASE_URL, ErrorCode, FetchHttpRequester, FriendApi, type FriendInfo, type FriendItem, type FriendQrCode, type HttpRawBody, type HttpRawRequestOptions, type HttpRequestOptions, type HttpRequester, type HttpResponse, ImageApi, type ImageFileInput, type ImageItem, type ImageUploadOptions, type ImageUploadResult, type ImageUploadToken, type MailDetail, type MailItem, MessageApi, type MessageCompleteInfo, type MessageItem, type MessageTokenAddRequest, MessageTokenApi, type MessageTokenEditRequest, type MessageTokenItem, type MessageTokenOption, type MpItem, OpenAbstractApi, OpenMessageApi, type PageQuery, type PageResult, PreApi, type PreDetail, type PreItem, type PreSaveRequest, type PreTestRequest, PushPlusClient, PushPlusClientBuilder, type PushPlusClientOptions, type PushPlusConfig, PushPlusError, PushPlusException, RateLimitGuard, type ResolvedPushPlusConfig, type SendCount, type SendMessageResult, type SendRequest, SendRequestBuilder, SendStatus, SendStatusDescription, SettingApi, Template, type TopicAddRequest, TopicApi, type TopicDetail, type TopicEditRequest, type TopicItem, type TopicListQuery, type TopicQrCode, TopicUserApi, type TopicUserInfo, type TopicUserItem, type TopicUserListQuery, UserApi, type UserDefaultDetail, type UserDefaultItem, type UserDefaultSaveRequest, type UserInfo, type UserLimitTime, WebhookApi, type WebhookItem, type WebhookSaveRequest, WebhookType, WebhookTypeDescription, batchSendRequest, callExecuteRaw, errorCodeFromValue, isRateLimitedCode, isSuccessfulHttpStatus, parseCallback, resolveConfig, sendRequest };
+export { AbstractApi, AccessKeyApi, AccessKeyManager, type AccessKeyResult, type ApiResponse, type BatchSendRequest, BatchSendRequestBuilder, type BatchSendResult, CallbackEvent, CallbackParser, type CallbackPayload, Channel, ChannelApi, ClawBotApi, type ClawBotInfo, type ClawBotMessage, type ClawBotQrCode, type CpItem, DEFAULT_BASE_URL, ErrorCode, FetchHttpRequester, FriendApi, type FriendInfo, type FriendItem, type FriendQrCode, type HttpRawBody, type HttpRawRequestOptions, type HttpRequestOptions, type HttpRequester, type HttpResponse, ImageApi, type ImageFileInput, type ImageItem, type ImageUploadOptions, type ImageUploadResult, type ImageUploadToken, type MailDetail, type MailItem, MessageApi, type MessageCompleteInfo, type MessageItem, type MessageTokenAddRequest, MessageTokenApi, type MessageTokenEditRequest, type MessageTokenItem, type MessageTokenOption, type MpItem, OpenAbstractApi, OpenMessageApi, type PageQuery, type PageResult, PreApi, type PreDetail, type PreItem, type PreSaveRequest, type PreTestRequest, PushPlusClient, PushPlusClientBuilder, type PushPlusClientOptions, type PushPlusConfig, PushPlusError, PushPlusException, RateLimitGuard, type ResolvedPushPlusConfig, type SendCount, type SendMessageResult, type SendRequest, SendRequestBuilder, SendStatus, SendStatusDescription, SettingApi, Template, type TopicAddRequest, TopicApi, type TopicDetail, type TopicEditRequest, type TopicItem, type TopicListQuery, type TopicQrCode, TopicUserApi, type TopicUserInfo, type TopicUserItem, type TopicUserListQuery, UserApi, type UserDefaultDetail, type UserDefaultItem, type UserDefaultSaveRequest, type UserInfo, type UserLimitTime, type VipInfo, WebhookApi, type WebhookItem, type WebhookSaveRequest, WebhookType, WebhookTypeDescription, batchSendRequest, callExecuteRaw, errorCodeFromValue, isRateLimitedCode, isSuccessfulHttpStatus, parseCallback, resolveConfig, sendRequest };

package/dist/index.global.js

@@ -23,6 +23,9 @@ var PerkPushPlus = (function (exports) {
     Template2["JENKINS"] = "jenkins";
     Template2["ROUTE"] = "route";
     Template2["PAY"] = "pay";
+    Template2["FORM"] = "form";
+    Template2["DOC"] = "doc";
+    Template2["EXCEL"] = "excel";
     return Template2;
   })(Template || {});
   var SendStatus = /* @__PURE__ */ ((SendStatus2) => {
@@ -1136,7 +1139,7 @@ var PerkPushPlus = (function (exports) {
       logRequest: (_g = cfg.logRequest) != null ? _g : false,
       rateLimitGuardEnabled: (_h = cfg.rateLimitGuardEnabled) != null ? _h : true,
       rateLimitCooldownMs: (_i = cfg.rateLimitCooldownMs) != null ? _i : 0,
-      userAgent: (_j = cfg.userAgent) != null ? _j : `@perk-net/perk-pushplus-sdk/1.0.1`
+      userAgent: (_j = cfg.userAgent) != null ? _j : `@perk-net/perk-pushplus-sdk/1.1.1`
     };
   }
 
@@ -1377,6 +1380,10 @@ var PerkPushPlus = (function (exports) {
       this.req.pre = v;
       return this;
     }
+    pushId(v) {
+      this.req.pushId = v;
+      return this;
+    }
     build() {
       return { ...this.req };
     }
@@ -1426,6 +1433,10 @@ var PerkPushPlus = (function (exports) {
       this.req.pre = v;
       return this;
     }
+    pushId(v) {
+      this.req.pushId = v;
+      return this;
+    }
     /** 追加一个 channel。 */
     channel(ch) {
       this.channelList.push(typeof ch === "string" ? ch : ch);