@juzi/wechaty-grpc 1.0.38 → 1.0.40

package/out/wechaty/puppet.openapi.yaml

@@ -9,7 +9,7 @@ info:
 
     Wechaty 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.38
+  version: 1.0.40
   contact:
     name: Wechaty
     url: 'https://github.com/wechaty/openapi'
@@ -344,6 +344,87 @@ paths:
           pattern: PAYLOADTYPECONTACT
       tags:
         - Puppet
+  '/contacts/{id}/payload-modify':
+    put:
+      operationId: Puppet_ContactPayloadModify
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetContactPayloadModifyResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: id
+          in: path
+          required: true
+          type: string
+        - name: body
+          in: body
+          required: true
+          schema:
+            type: object
+            properties:
+              gender:
+                $ref: '#/definitions/puppetContactGender'
+                title: 性别
+              type:
+                $ref: '#/definitions/puppetContactType'
+                title: 类型
+              name:
+                type: string
+                title: 姓名
+              avatar:
+                type: string
+                title: 头像
+              address:
+                type: string
+                title: 地址
+              alias:
+                type: string
+                title: 别名，即备注
+              city:
+                type: string
+                title: 城市
+              friend:
+                type: boolean
+                title: 是否为好友
+              province:
+                type: string
+                title: 省份
+              signature:
+                type: string
+                title: 签名
+              star:
+                type: boolean
+                title: 是否为特别好友
+              weixin:
+                type: string
+                title: IM专属id，在企微环境中特指weixinId
+              corporation:
+                type: string
+                title: 企业
+              title:
+                type: string
+                title: 头衔
+              description:
+                type: string
+                title: 描述
+              coworker:
+                type: boolean
+                title: 是否为同事
+              phones:
+                type: array
+                items:
+                  type: string
+                title: 电话号码，企微中最多5个
+              additionalInfo:
+                type: string
+                title: 额外信息，是由JS对象stringify得到的字符串，目前支持的内容包含addContactTime、corpId等。
+      tags:
+        - Puppet
   '/conversation/{conversationId}/read':
     put:
       summary: '*'
@@ -2189,6 +2270,8 @@ definitions:
         type: array
         items:
           type: string
+  puppetContactPayloadModifyResponse:
+    type: object
   puppetContactPayloadResponse:
     type: object
     properties:
@@ -2298,12 +2381,14 @@ definitions:
       - CONTACT_TYPE_PERSONAL
       - CONTACT_TYPE_OFFICIAL
       - CONTACT_TYPE_CORPORATION
+      - CONTACT_TYPE_APPLICATION
     default: CONTACT_TYPE_UNSPECIFIED
     description: |-
       - CONTACT_TYPE_UNSPECIFIED: 不明确
        - CONTACT_TYPE_PERSONAL: 个微联系人
        - CONTACT_TYPE_OFFICIAL: 公众号
        - CONTACT_TYPE_CORPORATION: 企微联系人
+       - CONTACT_TYPE_APPLICATION: 应用联系人 例如小助手
     title: 类型枚举
   puppetConversationReadResponse:
     type: object

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.38",
+    "version": "1.0.40",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -514,6 +514,121 @@
         ]
       }
     },
+    "/contacts/{id}/payload-modify": {
+      "put": {
+        "operationId": "Puppet_ContactPayloadModify",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetContactPayloadModifyResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "type": "object",
+              "properties": {
+                "gender": {
+                  "$ref": "#/definitions/puppetContactGender",
+                  "title": "性别"
+                },
+                "type": {
+                  "$ref": "#/definitions/puppetContactType",
+                  "title": "类型"
+                },
+                "name": {
+                  "type": "string",
+                  "title": "姓名"
+                },
+                "avatar": {
+                  "type": "string",
+                  "title": "头像"
+                },
+                "address": {
+                  "type": "string",
+                  "title": "地址"
+                },
+                "alias": {
+                  "type": "string",
+                  "title": "别名，即备注"
+                },
+                "city": {
+                  "type": "string",
+                  "title": "城市"
+                },
+                "friend": {
+                  "type": "boolean",
+                  "title": "是否为好友"
+                },
+                "province": {
+                  "type": "string",
+                  "title": "省份"
+                },
+                "signature": {
+                  "type": "string",
+                  "title": "签名"
+                },
+                "star": {
+                  "type": "boolean",
+                  "title": "是否为特别好友"
+                },
+                "weixin": {
+                  "type": "string",
+                  "title": "IM专属id，在企微环境中特指weixinId"
+                },
+                "corporation": {
+                  "type": "string",
+                  "title": "企业"
+                },
+                "title": {
+                  "type": "string",
+                  "title": "头衔"
+                },
+                "description": {
+                  "type": "string",
+                  "title": "描述"
+                },
+                "coworker": {
+                  "type": "boolean",
+                  "title": "是否为同事"
+                },
+                "phones": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "title": "电话号码，企微中最多5个"
+                },
+                "additionalInfo": {
+                  "type": "string",
+                  "title": "额外信息，是由JS对象stringify得到的字符串，目前支持的内容包含addContactTime、corpId等。"
+                }
+              }
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
     "/conversation/{conversationId}/read": {
       "put": {
         "summary": "*",
@@ -3262,6 +3377,9 @@
         }
       }
     },
+    "puppetContactPayloadModifyResponse": {
+      "type": "object"
+    },
     "puppetContactPayloadResponse": {
       "type": "object",
       "properties": {
@@ -3391,10 +3509,11 @@
         "CONTACT_TYPE_UNSPECIFIED",
         "CONTACT_TYPE_PERSONAL",
         "CONTACT_TYPE_OFFICIAL",
-        "CONTACT_TYPE_CORPORATION"
+        "CONTACT_TYPE_CORPORATION",
+        "CONTACT_TYPE_APPLICATION"
       ],
       "default": "CONTACT_TYPE_UNSPECIFIED",
-      "description": "- CONTACT_TYPE_UNSPECIFIED: 不明确\n - CONTACT_TYPE_PERSONAL: 个微联系人\n - CONTACT_TYPE_OFFICIAL: 公众号\n - CONTACT_TYPE_CORPORATION: 企微联系人",
+      "description": "- CONTACT_TYPE_UNSPECIFIED: 不明确\n - CONTACT_TYPE_PERSONAL: 个微联系人\n - CONTACT_TYPE_OFFICIAL: 公众号\n - CONTACT_TYPE_CORPORATION: 企微联系人\n - CONTACT_TYPE_APPLICATION: 应用联系人 例如小助手",
       "title": "类型枚举"
     },
     "puppetConversationReadResponse": {

package/out/wechaty/puppet_grpc_pb.d.ts

@@ -46,6 +46,7 @@ interface IPuppetService extends grpc.ServiceDefinition<grpc.UntypedServiceImple
     contactDescription: IPuppetService_IContactDescription;
     contactDelete: IPuppetService_IContactDelete;
     contactList: IPuppetService_IContactList;
+    contactPayloadModify: IPuppetService_IContactPayloadModify;
     friendshipPayload: IPuppetService_IFriendshipPayload;
     friendshipSearchPhone: IPuppetService_IFriendshipSearchPhone;
     friendshipSearchWeixin: IPuppetService_IFriendshipSearchWeixin;
@@ -307,6 +308,15 @@ interface IPuppetService_IContactList extends grpc.MethodDefinition<wechaty_pupp
     responseSerialize: grpc.serialize<wechaty_puppet_contact_pb.ContactListResponse>;
     responseDeserialize: grpc.deserialize<wechaty_puppet_contact_pb.ContactListResponse>;
 }
+interface IPuppetService_IContactPayloadModify extends grpc.MethodDefinition<wechaty_puppet_contact_pb.ContactPayloadModifyRequest, wechaty_puppet_contact_pb.ContactPayloadModifyResponse> {
+    path: "/wechaty.Puppet/ContactPayloadModify";
+    requestStream: false;
+    responseStream: false;
+    requestSerialize: grpc.serialize<wechaty_puppet_contact_pb.ContactPayloadModifyRequest>;
+    requestDeserialize: grpc.deserialize<wechaty_puppet_contact_pb.ContactPayloadModifyRequest>;
+    responseSerialize: grpc.serialize<wechaty_puppet_contact_pb.ContactPayloadModifyResponse>;
+    responseDeserialize: grpc.deserialize<wechaty_puppet_contact_pb.ContactPayloadModifyResponse>;
+}
 interface IPuppetService_IFriendshipPayload extends grpc.MethodDefinition<wechaty_puppet_friendship_pb.FriendshipPayloadRequest, wechaty_puppet_friendship_pb.FriendshipPayloadResponse> {
     path: "/wechaty.Puppet/FriendshipPayload";
     requestStream: false;
@@ -882,6 +892,7 @@ export interface IPuppetServer extends grpc.UntypedServiceImplementation {
     contactDescription: grpc.handleUnaryCall<wechaty_puppet_contact_pb.ContactDescriptionRequest, wechaty_puppet_contact_pb.ContactDescriptionResponse>;
     contactDelete: grpc.handleUnaryCall<wechaty_puppet_contact_pb.ContactDeleteRequest, wechaty_puppet_contact_pb.ContactDeleteResponse>;
     contactList: grpc.handleUnaryCall<wechaty_puppet_contact_pb.ContactListRequest, wechaty_puppet_contact_pb.ContactListResponse>;
+    contactPayloadModify: grpc.handleUnaryCall<wechaty_puppet_contact_pb.ContactPayloadModifyRequest, wechaty_puppet_contact_pb.ContactPayloadModifyResponse>;
     friendshipPayload: grpc.handleUnaryCall<wechaty_puppet_friendship_pb.FriendshipPayloadRequest, wechaty_puppet_friendship_pb.FriendshipPayloadResponse>;
     friendshipSearchPhone: grpc.handleUnaryCall<wechaty_puppet_friendship_pb.FriendshipSearchPhoneRequest, wechaty_puppet_friendship_pb.FriendshipSearchPhoneResponse>;
     friendshipSearchWeixin: grpc.handleUnaryCall<wechaty_puppet_friendship_pb.FriendshipSearchHandleRequest, wechaty_puppet_friendship_pb.FriendshipSearchHandleResponse>;
@@ -1010,6 +1021,9 @@ export interface IPuppetClient {
     contactList(request: wechaty_puppet_contact_pb.ContactListRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactListResponse) => void): grpc.ClientUnaryCall;
     contactList(request: wechaty_puppet_contact_pb.ContactListRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactListResponse) => void): grpc.ClientUnaryCall;
     contactList(request: wechaty_puppet_contact_pb.ContactListRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactListResponse) => void): grpc.ClientUnaryCall;
+    contactPayloadModify(request: wechaty_puppet_contact_pb.ContactPayloadModifyRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactPayloadModifyResponse) => void): grpc.ClientUnaryCall;
+    contactPayloadModify(request: wechaty_puppet_contact_pb.ContactPayloadModifyRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactPayloadModifyResponse) => void): grpc.ClientUnaryCall;
+    contactPayloadModify(request: wechaty_puppet_contact_pb.ContactPayloadModifyRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactPayloadModifyResponse) => void): grpc.ClientUnaryCall;
     friendshipPayload(request: wechaty_puppet_friendship_pb.FriendshipPayloadRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_friendship_pb.FriendshipPayloadResponse) => void): grpc.ClientUnaryCall;
     friendshipPayload(request: wechaty_puppet_friendship_pb.FriendshipPayloadRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_friendship_pb.FriendshipPayloadResponse) => void): grpc.ClientUnaryCall;
     friendshipPayload(request: wechaty_puppet_friendship_pb.FriendshipPayloadRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_friendship_pb.FriendshipPayloadResponse) => void): grpc.ClientUnaryCall;
@@ -1261,6 +1275,9 @@ export class PuppetClient extends grpc.Client implements IPuppetClient {
     public contactList(request: wechaty_puppet_contact_pb.ContactListRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactListResponse) => void): grpc.ClientUnaryCall;
     public contactList(request: wechaty_puppet_contact_pb.ContactListRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactListResponse) => void): grpc.ClientUnaryCall;
     public contactList(request: wechaty_puppet_contact_pb.ContactListRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactListResponse) => void): grpc.ClientUnaryCall;
+    public contactPayloadModify(request: wechaty_puppet_contact_pb.ContactPayloadModifyRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactPayloadModifyResponse) => void): grpc.ClientUnaryCall;
+    public contactPayloadModify(request: wechaty_puppet_contact_pb.ContactPayloadModifyRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactPayloadModifyResponse) => void): grpc.ClientUnaryCall;
+    public contactPayloadModify(request: wechaty_puppet_contact_pb.ContactPayloadModifyRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_contact_pb.ContactPayloadModifyResponse) => void): grpc.ClientUnaryCall;
     public friendshipPayload(request: wechaty_puppet_friendship_pb.FriendshipPayloadRequest, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_friendship_pb.FriendshipPayloadResponse) => void): grpc.ClientUnaryCall;
     public friendshipPayload(request: wechaty_puppet_friendship_pb.FriendshipPayloadRequest, metadata: grpc.Metadata, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_friendship_pb.FriendshipPayloadResponse) => void): grpc.ClientUnaryCall;
     public friendshipPayload(request: wechaty_puppet_friendship_pb.FriendshipPayloadRequest, metadata: grpc.Metadata, options: Partial<grpc.CallOptions>, callback: (error: grpc.ServiceError | null, response: wechaty_puppet_friendship_pb.FriendshipPayloadResponse) => void): grpc.ClientUnaryCall;

package/out/wechaty/puppet_grpc_pb.js

@@ -164,6 +164,28 @@ function deserialize_wechaty_puppet_ContactListResponse(buffer_arg) {
   return wechaty_puppet_contact_pb.ContactListResponse.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_wechaty_puppet_ContactPayloadModifyRequest(arg) {
+  if (!(arg instanceof wechaty_puppet_contact_pb.ContactPayloadModifyRequest)) {
+    throw new Error('Expected argument of type wechaty.puppet.ContactPayloadModifyRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_wechaty_puppet_ContactPayloadModifyRequest(buffer_arg) {
+  return wechaty_puppet_contact_pb.ContactPayloadModifyRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_wechaty_puppet_ContactPayloadModifyResponse(arg) {
+  if (!(arg instanceof wechaty_puppet_contact_pb.ContactPayloadModifyResponse)) {
+    throw new Error('Expected argument of type wechaty.puppet.ContactPayloadModifyResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_wechaty_puppet_ContactPayloadModifyResponse(buffer_arg) {
+  return wechaty_puppet_contact_pb.ContactPayloadModifyResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_wechaty_puppet_ContactPayloadRequest(arg) {
   if (!(arg instanceof wechaty_puppet_contact_pb.ContactPayloadRequest)) {
     throw new Error('Expected argument of type wechaty.puppet.ContactPayloadRequest');
@@ -2100,6 +2122,17 @@ contactList: {
     responseSerialize: serialize_wechaty_puppet_ContactListResponse,
     responseDeserialize: deserialize_wechaty_puppet_ContactListResponse,
   },
+  contactPayloadModify: {
+    path: '/wechaty.Puppet/ContactPayloadModify',
+    requestStream: false,
+    responseStream: false,
+    requestType: wechaty_puppet_contact_pb.ContactPayloadModifyRequest,
+    responseType: wechaty_puppet_contact_pb.ContactPayloadModifyResponse,
+    requestSerialize: serialize_wechaty_puppet_ContactPayloadModifyRequest,
+    requestDeserialize: deserialize_wechaty_puppet_ContactPayloadModifyRequest,
+    responseSerialize: serialize_wechaty_puppet_ContactPayloadModifyResponse,
+    responseDeserialize: deserialize_wechaty_puppet_ContactPayloadModifyResponse,
+  },
   // *
 //
 // Friendship

package/out/wechaty/puppet_pb_service.d.ts

@@ -216,6 +216,15 @@ type PuppetContactList = {
   readonly responseType: typeof wechaty_puppet_contact_pb.ContactListResponse;
 };
 
+type PuppetContactPayloadModify = {
+  readonly methodName: string;
+  readonly service: typeof Puppet;
+  readonly requestStream: false;
+  readonly responseStream: false;
+  readonly requestType: typeof wechaty_puppet_contact_pb.ContactPayloadModifyRequest;
+  readonly responseType: typeof wechaty_puppet_contact_pb.ContactPayloadModifyResponse;
+};
+
 type PuppetFriendshipPayload = {
   readonly methodName: string;
   readonly service: typeof Puppet;
@@ -789,6 +798,7 @@ export class Puppet {
   static readonly ContactDescription: PuppetContactDescription;
   static readonly ContactDelete: PuppetContactDelete;
   static readonly ContactList: PuppetContactList;
+  static readonly ContactPayloadModify: PuppetContactPayloadModify;
   static readonly FriendshipPayload: PuppetFriendshipPayload;
   static readonly FriendshipSearchPhone: PuppetFriendshipSearchPhone;
   static readonly FriendshipSearchWeixin: PuppetFriendshipSearchWeixin;
@@ -1050,6 +1060,15 @@ export class PuppetClient {
     requestMessage: wechaty_puppet_contact_pb.ContactListRequest,
     callback: (error: ServiceError|null, responseMessage: wechaty_puppet_contact_pb.ContactListResponse|null) => void
   ): UnaryResponse;
+  contactPayloadModify(
+    requestMessage: wechaty_puppet_contact_pb.ContactPayloadModifyRequest,
+    metadata: grpc.Metadata,
+    callback: (error: ServiceError|null, responseMessage: wechaty_puppet_contact_pb.ContactPayloadModifyResponse|null) => void
+  ): UnaryResponse;
+  contactPayloadModify(
+    requestMessage: wechaty_puppet_contact_pb.ContactPayloadModifyRequest,
+    callback: (error: ServiceError|null, responseMessage: wechaty_puppet_contact_pb.ContactPayloadModifyResponse|null) => void
+  ): UnaryResponse;
   friendshipPayload(
     requestMessage: wechaty_puppet_friendship_pb.FriendshipPayloadRequest,
     metadata: grpc.Metadata,

package/out/wechaty/puppet_pb_service.js

@@ -222,6 +222,15 @@ Puppet.ContactList = {
   responseType: wechaty_puppet_contact_pb.ContactListResponse
 };
 
+Puppet.ContactPayloadModify = {
+  methodName: "ContactPayloadModify",
+  service: Puppet,
+  requestStream: false,
+  responseStream: false,
+  requestType: wechaty_puppet_contact_pb.ContactPayloadModifyRequest,
+  responseType: wechaty_puppet_contact_pb.ContactPayloadModifyResponse
+};
+
 Puppet.FriendshipPayload = {
   methodName: "FriendshipPayload",
   service: Puppet,
@@ -1494,6 +1503,37 @@ PuppetClient.prototype.contactList = function contactList(requestMessage, metada
   };
 };
 
+PuppetClient.prototype.contactPayloadModify = function contactPayloadModify(requestMessage, metadata, callback) {
+  if (arguments.length === 2) {
+    callback = arguments[1];
+  }
+  var client = grpc.unary(Puppet.ContactPayloadModify, {
+    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.friendshipPayload = function friendshipPayload(requestMessage, metadata, callback) {
   if (arguments.length === 2) {
     callback = arguments[1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-grpc",
-  "version": "1.0.38",
+  "version": "1.0.40",
   "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.38",
+  "version": "1.0.40",
   "description": "gRPC for Wechaty",
   "type": "module",
   "exports": {