@juzi/wechaty-grpc 1.0.48 → 1.0.49

package/out/wechaty/puppet.swagger.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Wechaty Puppet Service OpenAPI Specification",
     "description": "Wechaty is a Conversational RPA SDK for chatbot makers. With only 6 lines of code, you can create a bot on the most popular IMs like WeChat, Whatsapp, WeCom, Gitter, etc.\n\nWechaty Puppet Service is the RESTful API for Wechaty API, which is build on top of the Wechaty Puppet Abstraction and the gRPC proto definition.",
-    "version": "1.0.48",
+    "version": "1.0.49",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -1446,6 +1446,36 @@
         ]
       }
     },
+    "/message/broadcast/{id}": {
+      "get": {
+        "operationId": "Puppet_GetMessageBroadcastStatus",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetGetMessageBroadcastStatusResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
     "/message/{id}": {
       "get": {
         "operationId": "Puppet_MessagePayload",
@@ -3258,6 +3288,39 @@
       },
       "additionalProperties": {}
     },
+    "puppetBroadcastStatus": {
+      "type": "string",
+      "enum": [
+        "BROADCAST_STATUS_UNKNWON",
+        "BROADCAST_STATUS_SENDING",
+        "BROADCAST_STATUS_SENT"
+      ],
+      "default": "BROADCAST_STATUS_UNKNWON"
+    },
+    "puppetBroadcastTarget": {
+      "type": "object",
+      "properties": {
+        "contactId": {
+          "type": "string"
+        },
+        "roomId": {
+          "type": "string"
+        },
+        "status": {
+          "$ref": "#/definitions/puppetBroadcastTargetStatus"
+        }
+      }
+    },
+    "puppetBroadcastTargetStatus": {
+      "type": "string",
+      "enum": [
+        "BROADCAST_TARGET_STATUS_UNSENT",
+        "BROADCAST_TARGET_STATUS_SENT",
+        "BROADCAST_TARGET_STATUS_NOT_FROEND",
+        "BROADCAST_TARGET_STATUS_OCCUPIED"
+      ],
+      "default": "BROADCAST_TARGET_STATUS_UNSENT"
+    },
     "puppetChannelPayload": {
       "type": "object",
       "properties": {
@@ -3707,6 +3770,20 @@
       "description": "- FRIENDSHIP_TYPE_UNSPECIFIED: 不明确\n - FRIENDSHIP_TYPE_CONFIRM: 确认——双方互加后触发\n - FRIENDSHIP_TYPE_RECEIVE: 收到——收到好友请求后触发\n - FRIENDSHIP_TYPE_VERIFY: 验证——主动加他人为好友时触发，wxwork里暂无此事件\n - FRIENDSHIP_TYPE_DELETE: 删除——主动删除好友时触发\n - FRIENDSHIP_TYPE_REMOVED: 被删除——被他人删除好友时触发",
       "title": "事件类型"
     },
+    "puppetGetMessageBroadcastStatusResponse": {
+      "type": "object",
+      "properties": {
+        "status": {
+          "$ref": "#/definitions/puppetBroadcastStatus"
+        },
+        "detail": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/puppetBroadcastTarget"
+          }
+        }
+      }
+    },
     "puppetGetMessageBroadcastTargetResponse": {
       "type": "object",
       "properties": {

package/out/wechaty/puppet_grpc_pb.d.ts

@@ -70,6 +70,7 @@ interface IPuppetService extends grpc.ServiceDefinition<grpc.UntypedServiceImple
     messagePreview: IPuppetService_IMessagePreview;
     getMessageBroadcastTarget: IPuppetService_IGetMessageBroadcastTarget;
     createMessageBroadcast: IPuppetService_ICreateMessageBroadcast;
+    getMessageBroadcastStatus: IPuppetService_IGetMessageBroadcastStatus;
     roomPayload: IPuppetService_IRoomPayload;
     roomList: IPuppetService_IRoomList;
     roomAdd: IPuppetService_IRoomAdd;
@@ -532,6 +533,15 @@ interface IPuppetService_ICreateMessageBroadcast extends grpc.MethodDefinition<w
     responseSerialize: grpc.serialize<wechaty_puppet_message_pb.CreateMessageBroadcastResponse>;
     responseDeserialize: grpc.deserialize<wechaty_puppet_message_pb.CreateMessageBroadcastResponse>;
 }
+interface IPuppetService_IGetMessageBroadcastStatus extends grpc.MethodDefinition<wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse> {
+    path: "/wechaty.Puppet/GetMessageBroadcastStatus";
+    requestStream: false;
+    responseStream: false;
+    requestSerialize: grpc.serialize<wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest>;
+    requestDeserialize: grpc.deserialize<wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest>;
+    responseSerialize: grpc.serialize<wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse>;
+    responseDeserialize: grpc.deserialize<wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse>;
+}
 interface IPuppetService_IRoomPayload extends grpc.MethodDefinition<wechaty_puppet_room_pb.RoomPayloadRequest, wechaty_puppet_room_pb.RoomPayloadResponse> {
     path: "/wechaty.Puppet/RoomPayload";
     requestStream: false;
@@ -916,6 +926,7 @@ export interface IPuppetServer extends grpc.UntypedServiceImplementation {
     messagePreview: grpc.handleUnaryCall<wechaty_puppet_message_pb.MessagePreviewRequest, wechaty_puppet_message_pb.MessagePreviewResponse>;
     getMessageBroadcastTarget: grpc.handleUnaryCall<wechaty_puppet_message_pb.GetMessageBroadcastTargetRequest, wechaty_puppet_message_pb.GetMessageBroadcastTargetResponse>;
     createMessageBroadcast: grpc.handleUnaryCall<wechaty_puppet_message_pb.CreateMessageBroadcastRequest, wechaty_puppet_message_pb.CreateMessageBroadcastResponse>;
+    getMessageBroadcastStatus: grpc.handleUnaryCall<wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse>;
     roomPayload: grpc.handleUnaryCall<wechaty_puppet_room_pb.RoomPayloadRequest, wechaty_puppet_room_pb.RoomPayloadResponse>;
     roomList: grpc.handleUnaryCall<wechaty_puppet_room_pb.RoomListRequest, wechaty_puppet_room_pb.RoomListResponse>;
     roomAdd: grpc.handleUnaryCall<wechaty_puppet_room_pb.RoomAddRequest, wechaty_puppet_room_pb.RoomAddResponse>;
@@ -1096,6 +1107,9 @@ export interface IPuppetClient {
     createMessageBroadcast(request: wechaty_puppet_message_pb.CreateMessageBroadcastRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.CreateMessageBroadcastResponse) => void): grpc.ClientUnaryCall;
     createMessageBroadcast(request: wechaty_puppet_message_pb.CreateMessageBroadcastRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.CreateMessageBroadcastResponse) => void): grpc.ClientUnaryCall;
     createMessageBroadcast(request: wechaty_puppet_message_pb.CreateMessageBroadcastRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.CreateMessageBroadcastResponse) => void): grpc.ClientUnaryCall;
+    getMessageBroadcastStatus(request: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse) => void): grpc.ClientUnaryCall;
+    getMessageBroadcastStatus(request: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse) => void): grpc.ClientUnaryCall;
+    getMessageBroadcastStatus(request: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse) => void): grpc.ClientUnaryCall;
     roomPayload(request: wechaty_puppet_room_pb.RoomPayloadRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_room_pb.RoomPayloadResponse) => void): grpc.ClientUnaryCall;
     roomPayload(request: wechaty_puppet_room_pb.RoomPayloadRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_room_pb.RoomPayloadResponse) => void): grpc.ClientUnaryCall;
     roomPayload(request: wechaty_puppet_room_pb.RoomPayloadRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_room_pb.RoomPayloadResponse) => void): grpc.ClientUnaryCall;
@@ -1351,6 +1365,9 @@ export class PuppetClient extends grpc.Client implements IPuppetClient {
     public createMessageBroadcast(request: wechaty_puppet_message_pb.CreateMessageBroadcastRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.CreateMessageBroadcastResponse) => void): grpc.ClientUnaryCall;
     public createMessageBroadcast(request: wechaty_puppet_message_pb.CreateMessageBroadcastRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.CreateMessageBroadcastResponse) => void): grpc.ClientUnaryCall;
     public createMessageBroadcast(request: wechaty_puppet_message_pb.CreateMessageBroadcastRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.CreateMessageBroadcastResponse) => void): grpc.ClientUnaryCall;
+    public getMessageBroadcastStatus(request: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse) => void): grpc.ClientUnaryCall;
+    public getMessageBroadcastStatus(request: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse) => void): grpc.ClientUnaryCall;
+    public getMessageBroadcastStatus(request: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse) => void): grpc.ClientUnaryCall;
     public roomPayload(request: wechaty_puppet_room_pb.RoomPayloadRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_room_pb.RoomPayloadResponse) => void): grpc.ClientUnaryCall;
     public roomPayload(request: wechaty_puppet_room_pb.RoomPayloadRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_room_pb.RoomPayloadResponse) => void): grpc.ClientUnaryCall;
     public roomPayload(request: wechaty_puppet_room_pb.RoomPayloadRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_room_pb.RoomPayloadResponse) => void): grpc.ClientUnaryCall;

package/out/wechaty/puppet_grpc_pb.js

@@ -559,6 +559,28 @@ function deserialize_wechaty_puppet_FriendshipSearchPhoneResponse(buffer_arg) {
   return wechaty_puppet_friendship_pb.FriendshipSearchPhoneResponse.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_wechaty_puppet_GetMessageBroadcastStatusRequest(arg) {
+  if (!(arg instanceof wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest)) {
+    throw new Error('Expected argument of type wechaty.puppet.GetMessageBroadcastStatusRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_wechaty_puppet_GetMessageBroadcastStatusRequest(buffer_arg) {
+  return wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_wechaty_puppet_GetMessageBroadcastStatusResponse(arg) {
+  if (!(arg instanceof wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse)) {
+    throw new Error('Expected argument of type wechaty.puppet.GetMessageBroadcastStatusResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_wechaty_puppet_GetMessageBroadcastStatusResponse(buffer_arg) {
+  return wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_wechaty_puppet_GetMessageBroadcastTargetRequest(arg) {
   if (!(arg instanceof wechaty_puppet_message_pb.GetMessageBroadcastTargetRequest)) {
     throw new Error('Expected argument of type wechaty.puppet.GetMessageBroadcastTargetRequest');
@@ -2410,6 +2432,17 @@ messageFile: {
     responseSerialize: serialize_wechaty_puppet_CreateMessageBroadcastResponse,
     responseDeserialize: deserialize_wechaty_puppet_CreateMessageBroadcastResponse,
   },
+  getMessageBroadcastStatus: {
+    path: '/wechaty.Puppet/GetMessageBroadcastStatus',
+    requestStream: false,
+    responseStream: false,
+    requestType: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest,
+    responseType: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse,
+    requestSerialize: serialize_wechaty_puppet_GetMessageBroadcastStatusRequest,
+    requestDeserialize: deserialize_wechaty_puppet_GetMessageBroadcastStatusRequest,
+    responseSerialize: serialize_wechaty_puppet_GetMessageBroadcastStatusResponse,
+    responseDeserialize: deserialize_wechaty_puppet_GetMessageBroadcastStatusResponse,
+  },
   // *
 //
 // Room

package/out/wechaty/puppet_pb_service.d.ts

@@ -440,6 +440,15 @@ type PuppetCreateMessageBroadcast = {
   readonly responseType: typeof wechaty_puppet_message_pb.CreateMessageBroadcastResponse;
 };
 
+type PuppetGetMessageBroadcastStatus = {
+  readonly methodName: string;
+  readonly service: typeof Puppet;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest;
+  readonly responseType: typeof wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse;
+};
+
 type PuppetRoomPayload = {
   readonly methodName: string;
   readonly service: typeof Puppet;
@@ -822,6 +831,7 @@ export class Puppet {
   static readonly MessagePreview: PuppetMessagePreview;
   static readonly GetMessageBroadcastTarget: PuppetGetMessageBroadcastTarget;
   static readonly CreateMessageBroadcast: PuppetCreateMessageBroadcast;
+  static readonly GetMessageBroadcastStatus: PuppetGetMessageBroadcastStatus;
   static readonly RoomPayload: PuppetRoomPayload;
   static readonly RoomList: PuppetRoomList;
   static readonly RoomAdd: PuppetRoomAdd;
@@ -1308,6 +1318,15 @@ export class PuppetClient {
     requestMessage: wechaty_puppet_message_pb.CreateMessageBroadcastRequest,
     callback: (error: ServiceError|null, responseMessage: wechaty_puppet_message_pb.CreateMessageBroadcastResponse|null) => void
   ): UnaryResponse;
+  getMessageBroadcastStatus(
+    requestMessage: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse|null) => void
+  ): UnaryResponse;
+  getMessageBroadcastStatus(
+    requestMessage: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest,
+    callback: (error: ServiceError|null, responseMessage: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse|null) => void
+  ): UnaryResponse;
   roomPayload(
     requestMessage: wechaty_puppet_room_pb.RoomPayloadRequest,
     metadata: grpc.Metadata,

package/out/wechaty/puppet_pb_service.js

@@ -446,6 +446,15 @@ Puppet.CreateMessageBroadcast = {
   responseType: wechaty_puppet_message_pb.CreateMessageBroadcastResponse
 };
 
+Puppet.GetMessageBroadcastStatus = {
+  methodName: "GetMessageBroadcastStatus",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_message_pb.GetMessageBroadcastStatusRequest,
+  responseType: wechaty_puppet_message_pb.GetMessageBroadcastStatusResponse
+};
+
 Puppet.RoomPayload = {
   methodName: "RoomPayload",
   service: Puppet,
@@ -2251,6 +2260,37 @@ PuppetClient.prototype.createMessageBroadcast = function createMessageBroadcast(
   };
 };
 
+PuppetClient.prototype.getMessageBroadcastStatus = function getMessageBroadcastStatus(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.GetMessageBroadcastStatus, {
+    request: requestMessage,
+    host: this.serviceHost,
+    metadata: metadata,
+    transport: this.options.transport,
+    debug: this.options.debug,
+    onEnd: function (response) {
+      if (callback) {
+        if (response.status !== grpc.Code.OK) {
+          var err = new Error(response.statusMessage);
+          err.code = response.status;
+          err.metadata = response.trailers;
+          callback(err, null);
+        } else {
+          callback(null, response.message);
+        }
+      }
+    }
+  });
+  return {
+    cancel: function () {
+      callback = null;
+      client.close();
+    }
+  };
+};
+
 PuppetClient.prototype.roomPayload = function roomPayload(requestMessage, metadata, callback) {
   if (arguments.length === 2) {
     callback = arguments[1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-grpc",
-  "version": "1.0.48",
+  "version": "1.0.49",
   "description": "gRPC for Wechaty",
   "type": "module",
   "exports": {

package/src/package-json.ts

@@ -4,7 +4,7 @@
 import type { PackageJson } from 'type-fest'
 export const packageJson: PackageJson = {
   "name": "@juzi/wechaty-grpc",
-  "version": "1.0.48",
+  "version": "1.0.49",
   "description": "gRPC for Wechaty",
   "type": "module",
   "exports": {