@juzi/wechaty-grpc 1.0.42 → 1.0.44

package/dist/cjs/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.42
+  version: 1.0.44
   contact:
     name: Wechaty
     url: 'https://github.com/wechaty/openapi'
@@ -956,6 +956,40 @@ paths:
             $ref: '#/definitions/rpcStatus'
       tags:
         - Puppet
+  /message/broadcast/create:
+    post:
+      operationId: Puppet_CreateMessageBroadcast
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetCreateMessageBroadcastResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetCreateMessageBroadcastRequest'
+      tags:
+        - Puppet
+  /message/broadcast/target:
+    get:
+      operationId: Puppet_GetMessageBroadcastTarget
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetGetMessageBroadcastTargetResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      tags:
+        - Puppet
   '/message/{id}':
     get:
       operationId: Puppet_MessagePayload
@@ -2098,35 +2132,6 @@ paths:
             $ref: '#/definitions/puppetMessageFileRequest'
       tags:
         - Puppet
-  /wechaty.Puppet/MessageFileStream:
-    post:
-      summary: |-
-        *
-        Deprecated: will be removed after Dec 31, 2022
-      operationId: Puppet_MessageFileStream
-      responses:
-        '200':
-          description: A successful response.(streaming responses)
-          schema:
-            type: object
-            properties:
-              result:
-                $ref: '#/definitions/puppetMessageFileStreamResponse'
-              error:
-                $ref: '#/definitions/rpcStatus'
-            title: Stream result of puppetMessageFileStreamResponse
-        default:
-          description: An unexpected error response.
-          schema:
-            $ref: '#/definitions/rpcStatus'
-      parameters:
-        - name: body
-          in: body
-          required: true
-          schema:
-            $ref: '#/definitions/puppetMessageFileStreamRequest'
-      tags:
-        - Puppet
   /wechaty.Puppet/MessageImage:
     post:
       operationId: Puppet_MessageImage
@@ -2147,32 +2152,6 @@ paths:
             $ref: '#/definitions/puppetMessageImageRequest'
       tags:
         - Puppet
-  /wechaty.Puppet/MessageImageStream:
-    post:
-      operationId: Puppet_MessageImageStream
-      responses:
-        '200':
-          description: A successful response.(streaming responses)
-          schema:
-            type: object
-            properties:
-              result:
-                $ref: '#/definitions/puppetMessageImageStreamResponse'
-              error:
-                $ref: '#/definitions/rpcStatus'
-            title: Stream result of puppetMessageImageStreamResponse
-        default:
-          description: An unexpected error response.
-          schema:
-            $ref: '#/definitions/rpcStatus'
-      parameters:
-        - name: body
-          in: body
-          required: true
-          schema:
-            $ref: '#/definitions/puppetMessageImageStreamRequest'
-      tags:
-        - Puppet
   /wechaty.Puppet/MessageSendFile:
     post:
       operationId: Puppet_MessageSendFile
@@ -2193,30 +2172,6 @@ paths:
             $ref: '#/definitions/puppetMessageSendFileRequest'
       tags:
         - Puppet
-  /wechaty.Puppet/MessageSendFileStream:
-    post:
-      operationId: Puppet_MessageSendFileStream
-      responses:
-        '200':
-          description: A successful response.
-          schema:
-            $ref: '#/definitions/puppetMessageSendFileStreamResponse'
-        default:
-          description: An unexpected error response.
-          schema:
-            $ref: '#/definitions/rpcStatus'
-      parameters:
-        - name: body
-          description: |-
-            *
-             Huan(202110): `oneof xxx {}` seems equal with `optional`?
-              to be confirmed. (streaming inputs)
-          in: body
-          required: true
-          schema:
-            $ref: '#/definitions/puppetMessageSendFileStreamRequest'
-      tags:
-        - Puppet
 definitions:
   protobufAny:
     type: object
@@ -2423,6 +2378,22 @@ definitions:
     properties:
       hasRead:
         type: boolean
+  puppetCreateMessageBroadcastRequest:
+    type: object
+    properties:
+      targetIds:
+        type: array
+        items:
+          type: string
+      type:
+        $ref: '#/definitions/puppetMessageBroadcastTargetType'
+      content:
+        $ref: '#/definitions/puppetPostPayloadClient'
+  puppetCreateMessageBroadcastResponse:
+    type: object
+    properties:
+      id:
+        type: string
   puppetCurrentUserResponse:
     type: object
     properties:
@@ -2482,20 +2453,6 @@ definitions:
       - EVENT_TYPE_POST_TAP
       - EVENT_TYPE_ROOM_ANNOUNCE
     default: EVENT_TYPE_UNSPECIFIED
-  puppetFileBoxChunk:
-    type: object
-    properties:
-      data:
-        type: string
-        format: byte
-        title: 'oneof payload {'
-      name:
-        type: string
-        title: '}'
-    description: |-
-      *
-       Huan(202110): `oneof xxx {}` seems equal with `optional`?
-        to be confirmed.
   puppetFriendshipAcceptResponse:
     type: object
   puppetFriendshipAddResponse:
@@ -2606,6 +2563,17 @@ definitions:
        - FRIENDSHIP_TYPE_DELETE: 删除——主动删除好友时触发
        - FRIENDSHIP_TYPE_REMOVED: 被删除——被他人删除好友时触发
     title: 事件类型
+  puppetGetMessageBroadcastTargetResponse:
+    type: object
+    properties:
+      contactIds:
+        type: array
+        items:
+          type: string
+      roomIds:
+        type: array
+        items:
+          type: string
   puppetImageType:
     type: string
     enum:
@@ -2637,6 +2605,13 @@ definitions:
         title: 地址名，例如xx大厦
   puppetLogoutResponse:
     type: object
+  puppetMessageBroadcastTargetType:
+    type: string
+    enum:
+      - MESSAGE_BROADCAST_TARGET_TYPE_UNKNOWN
+      - MESSAGE_BROADCAST_TARGET_TYPE_CONTACT
+      - MESSAGE_BROADCAST_TARGET_TYPE_ROOM
+    default: MESSAGE_BROADCAST_TARGET_TYPE_UNKNOWN
   puppetMessageChannelResponse:
     type: object
     properties:
@@ -2657,16 +2632,6 @@ definitions:
     properties:
       fileBox:
         type: string
-  puppetMessageFileStreamRequest:
-    type: object
-    properties:
-      id:
-        type: string
-  puppetMessageFileStreamResponse:
-    type: object
-    properties:
-      fileBoxChunk:
-        $ref: '#/definitions/puppetFileBoxChunk'
   puppetMessageForwardResponse:
     type: object
     properties:
@@ -2693,18 +2658,6 @@ definitions:
     properties:
       fileBox:
         type: string
-  puppetMessageImageStreamRequest:
-    type: object
-    properties:
-      id:
-        type: string
-      type:
-        $ref: '#/definitions/puppetImageType'
-  puppetMessageImageStreamResponse:
-    type: object
-    properties:
-      fileBoxChunk:
-        $ref: '#/definitions/puppetFileBoxChunk'
   puppetMessageLocationResponse:
     type: object
     properties:
@@ -2818,32 +2771,6 @@ definitions:
              https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
       id:
         type: string
-  puppetMessageSendFileStreamRequest:
-    type: object
-    properties:
-      conversationId:
-        type: string
-        title: 'oneof payload {'
-      fileBoxChunk:
-        $ref: '#/definitions/puppetFileBoxChunk'
-        title: '};'
-    description: |-
-      *
-       Huan(202110): `oneof xxx {}` seems equal with `optional`?
-        to be confirmed.
-  puppetMessageSendFileStreamResponse:
-    type: object
-    properties:
-      idStringValueDeprecated:
-        type: string
-        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
-        title: |-
-          *
-          @deprecated:
-           Huan(202109): Wrapper types must not be used going forward.
-             https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
-      id:
-        type: string
   puppetMessageSendLocationResponse:
     type: object
     properties:

package/dist/cjs/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.42",
+    "version": "1.0.44",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -1392,6 +1392,60 @@
         ]
       }
     },
+    "/message/broadcast/create": {
+      "post": {
+        "operationId": "Puppet_CreateMessageBroadcast",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCreateMessageBroadcastResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/puppetCreateMessageBroadcastRequest"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/message/broadcast/target": {
+      "get": {
+        "operationId": "Puppet_GetMessageBroadcastTarget",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetGetMessageBroadcastTargetResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
     "/message/{id}": {
       "get": {
         "operationId": "Puppet_MessagePayload",
@@ -3129,48 +3183,6 @@
         ]
       }
     },
-    "/wechaty.Puppet/MessageFileStream": {
-      "post": {
-        "summary": "*\nDeprecated: will be removed after Dec 31, 2022",
-        "operationId": "Puppet_MessageFileStream",
-        "responses": {
-          "200": {
-            "description": "A successful response.(streaming responses)",
-            "schema": {
-              "type": "object",
-              "properties": {
-                "result": {
-                  "$ref": "#/definitions/puppetMessageFileStreamResponse"
-                },
-                "error": {
-                  "$ref": "#/definitions/rpcStatus"
-                }
-              },
-              "title": "Stream result of puppetMessageFileStreamResponse"
-            }
-          },
-          "default": {
-            "description": "An unexpected error response.",
-            "schema": {
-              "$ref": "#/definitions/rpcStatus"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "body",
-            "in": "body",
-            "required": true,
-            "schema": {
-              "$ref": "#/definitions/puppetMessageFileStreamRequest"
-            }
-          }
-        ],
-        "tags": [
-          "Puppet"
-        ]
-      }
-    },
     "/wechaty.Puppet/MessageImage": {
       "post": {
         "operationId": "Puppet_MessageImage",
@@ -3203,47 +3215,6 @@
         ]
       }
     },
-    "/wechaty.Puppet/MessageImageStream": {
-      "post": {
-        "operationId": "Puppet_MessageImageStream",
-        "responses": {
-          "200": {
-            "description": "A successful response.(streaming responses)",
-            "schema": {
-              "type": "object",
-              "properties": {
-                "result": {
-                  "$ref": "#/definitions/puppetMessageImageStreamResponse"
-                },
-                "error": {
-                  "$ref": "#/definitions/rpcStatus"
-                }
-              },
-              "title": "Stream result of puppetMessageImageStreamResponse"
-            }
-          },
-          "default": {
-            "description": "An unexpected error response.",
-            "schema": {
-              "$ref": "#/definitions/rpcStatus"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "body",
-            "in": "body",
-            "required": true,
-            "schema": {
-              "$ref": "#/definitions/puppetMessageImageStreamRequest"
-            }
-          }
-        ],
-        "tags": [
-          "Puppet"
-        ]
-      }
-    },
     "/wechaty.Puppet/MessageSendFile": {
       "post": {
         "operationId": "Puppet_MessageSendFile",
@@ -3275,39 +3246,6 @@
           "Puppet"
         ]
       }
-    },
-    "/wechaty.Puppet/MessageSendFileStream": {
-      "post": {
-        "operationId": "Puppet_MessageSendFileStream",
-        "responses": {
-          "200": {
-            "description": "A successful response.",
-            "schema": {
-              "$ref": "#/definitions/puppetMessageSendFileStreamResponse"
-            }
-          },
-          "default": {
-            "description": "An unexpected error response.",
-            "schema": {
-              "$ref": "#/definitions/rpcStatus"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "body",
-            "description": "*\n Huan(202110): `oneof xxx {}` seems equal with `optional`?\n  to be confirmed. (streaming inputs)",
-            "in": "body",
-            "required": true,
-            "schema": {
-              "$ref": "#/definitions/puppetMessageSendFileStreamRequest"
-            }
-          }
-        ],
-        "tags": [
-          "Puppet"
-        ]
-      }
     }
   },
   "definitions": {
@@ -3567,6 +3505,31 @@
         }
       }
     },
+    "puppetCreateMessageBroadcastRequest": {
+      "type": "object",
+      "properties": {
+        "targetIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "type": {
+          "$ref": "#/definitions/puppetMessageBroadcastTargetType"
+        },
+        "content": {
+          "$ref": "#/definitions/puppetPostPayloadClient"
+        }
+      }
+    },
+    "puppetCreateMessageBroadcastResponse": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      }
+    },
     "puppetCurrentUserResponse": {
       "type": "object",
       "properties": {
@@ -3640,21 +3603,6 @@
       ],
       "default": "EVENT_TYPE_UNSPECIFIED"
     },
-    "puppetFileBoxChunk": {
-      "type": "object",
-      "properties": {
-        "data": {
-          "type": "string",
-          "format": "byte",
-          "title": "oneof payload {"
-        },
-        "name": {
-          "type": "string",
-          "title": "}"
-        }
-      },
-      "description": "*\n Huan(202110): `oneof xxx {}` seems equal with `optional`?\n  to be confirmed."
-    },
     "puppetFriendshipAcceptResponse": {
       "type": "object"
     },
@@ -3762,6 +3710,23 @@
       "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": "事件类型"
     },
+    "puppetGetMessageBroadcastTargetResponse": {
+      "type": "object",
+      "properties": {
+        "contactIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "roomIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
     "puppetImageType": {
       "type": "string",
       "enum": [
@@ -3803,6 +3768,15 @@
     "puppetLogoutResponse": {
       "type": "object"
     },
+    "puppetMessageBroadcastTargetType": {
+      "type": "string",
+      "enum": [
+        "MESSAGE_BROADCAST_TARGET_TYPE_UNKNOWN",
+        "MESSAGE_BROADCAST_TARGET_TYPE_CONTACT",
+        "MESSAGE_BROADCAST_TARGET_TYPE_ROOM"
+      ],
+      "default": "MESSAGE_BROADCAST_TARGET_TYPE_UNKNOWN"
+    },
     "puppetMessageChannelResponse": {
       "type": "object",
       "properties": {
@@ -3835,22 +3809,6 @@
         }
       }
     },
-    "puppetMessageFileStreamRequest": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string"
-        }
-      }
-    },
-    "puppetMessageFileStreamResponse": {
-      "type": "object",
-      "properties": {
-        "fileBoxChunk": {
-          "$ref": "#/definitions/puppetFileBoxChunk"
-        }
-      }
-    },
     "puppetMessageForwardResponse": {
       "type": "object",
       "properties": {
@@ -3884,25 +3842,6 @@
         }
       }
     },
-    "puppetMessageImageStreamRequest": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "type": {
-          "$ref": "#/definitions/puppetImageType"
-        }
-      }
-    },
-    "puppetMessageImageStreamResponse": {
-      "type": "object",
-      "properties": {
-        "fileBoxChunk": {
-          "$ref": "#/definitions/puppetFileBoxChunk"
-        }
-      }
-    },
     "puppetMessageLocationResponse": {
       "type": "object",
       "properties": {
@@ -4043,33 +3982,6 @@
         }
       }
     },
-    "puppetMessageSendFileStreamRequest": {
-      "type": "object",
-      "properties": {
-        "conversationId": {
-          "type": "string",
-          "title": "oneof payload {"
-        },
-        "fileBoxChunk": {
-          "$ref": "#/definitions/puppetFileBoxChunk",
-          "title": "};"
-        }
-      },
-      "description": "*\n Huan(202110): `oneof xxx {}` seems equal with `optional`?\n  to be confirmed."
-    },
-    "puppetMessageSendFileStreamResponse": {
-      "type": "object",
-      "properties": {
-        "idStringValueDeprecated": {
-          "type": "string",
-          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
-          "title": "*\n@deprecated:\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
-        },
-        "id": {
-          "type": "string"
-        }
-      }
-    },
     "puppetMessageSendLocationResponse": {
       "type": "object",
       "properties": {