@juzi/wechaty-grpc 1.0.74 → 1.0.75

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.74",
+    "version": "1.0.75",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -322,16 +322,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "corporationRemarkStringValueDeprecated": {
-                  "type": "string",
-                  "title": "DEPRECATED, will be removed after Dec 31, 2022"
-                },
-                "corporationRemark": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/PuppetContactCorporationRemarkBody"
             }
           }
         ],
@@ -369,7 +360,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object"
+              "$ref": "#/definitions/PuppetContactDeleteBody"
             }
           }
         ],
@@ -407,16 +398,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "descriptionStringValueDeprecated": {
-                  "type": "string",
-                  "title": "DEPRECATED, will be removed after Dec 31, 2022"
-                },
-                "description": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/PuppetContactDescriptionBody"
             }
           }
         ],
@@ -454,15 +436,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "phones": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                }
-              }
+              "$ref": "#/definitions/PuppetContactPhoneBody"
             }
           }
         ],
@@ -562,17 +536,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "aliasStringValueDeprecated": {
-                  "type": "string",
-                  "description": "DEPRECATED, will be removed after Dec 31, 2022",
-                  "title": "nullable"
-                },
-                "alias": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/PuppetContactAliasBody"
             }
           }
         ],
@@ -701,98 +665,7 @@
             "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等。"
-                },
-                "tagIds": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  },
-                  "title": "标签（的id）"
-                },
-                "clearPhones": {
-                  "type": "boolean",
-                  "description": "*\n The protobuf encoding doesn't distinguish between these two cases. (undefined vs [])\n Since protobuf is language-agnostic,\n it doesn't understand the conceptual nuance of \"undefined\" versus \"[]\" of Javascript."
-                },
-                "clearTagIds": {
-                  "type": "boolean"
-                }
-              }
+              "$ref": "#/definitions/PuppetContactPayloadModifyBody"
             }
           }
         ],
@@ -832,12 +705,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "hasRead": {
-                  "type": "boolean"
-                }
-              }
+              "$ref": "#/definitions/PuppetConversationReadBody"
             }
           }
         ],
@@ -875,12 +743,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "channel": {
-                  "$ref": "#/definitions/puppetChannelPayload"
-                }
-              }
+              "$ref": "#/definitions/PuppetMessageSendChannelBody"
             }
           }
         ],
@@ -918,12 +781,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "contactId": {
-                  "type": "string"
-                }
-              }
+              "$ref": "#/definitions/PuppetMessageSendContactBody"
             }
           }
         ],
@@ -1010,12 +868,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "location": {
-                  "$ref": "#/definitions/puppetLocationPayload"
-                }
-              }
+              "$ref": "#/definitions/PuppetMessageSendLocationBody"
             }
           }
         ],
@@ -1054,18 +907,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "miniProgramDeprecated": {
-                  "type": "string",
-                  "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
-                  "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
-                },
-                "miniProgram": {
-                  "$ref": "#/definitions/puppetMiniProgramPayload",
-                  "title": "小程序payload"
-                }
-              }
+              "$ref": "#/definitions/PuppetMessageSendMiniProgramBody"
             }
           }
         ],
@@ -1104,25 +946,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "text": {
-                  "type": "string",
-                  "title": "文本内容"
-                },
-                "mentionalIds": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  },
-                  "title": "@人id列表"
-                },
-                "quoteId": {
-                  "type": "string",
-                  "title": "引用消息的id"
-                }
-              },
-              "title": "发文本消息"
+              "$ref": "#/definitions/PuppetMessageSendTextBody"
             }
           }
         ],
@@ -1161,18 +985,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "urlLinkDeprecated": {
-                  "type": "string",
-                  "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
-                  "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
-                },
-                "urlLink": {
-                  "$ref": "#/definitions/puppetUrlLinkPayload",
-                  "title": "链接payload"
-                }
-              }
+              "$ref": "#/definitions/PuppetMessageSendUrlBody"
             }
           }
         ],
@@ -1420,23 +1233,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "hello": {
-                  "type": "string"
-                },
-                "sourceRoomIdStringValueDeprecated": {
-                  "type": "string",
-                  "title": "Deprecated: will be removed after Dec 31, 2022"
-                },
-                "sourceContactIdStringValueDeprecated": {
-                  "type": "string",
-                  "title": "Deprecated: will be removed after Dec 31, 2022"
-                },
-                "referrer": {
-                  "$ref": "#/definitions/puppetReferrer"
-                }
-              }
+              "$ref": "#/definitions/PuppetFriendshipAddBody"
             }
           }
         ],
@@ -2740,17 +2537,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "type": "object",
-              "properties": {
-                "textStringValueDeprecated": {
-                  "type": "string",
-                  "title": "DEPRECATED, will be removed after Dec 31, 2022"
-                },
-                "text": {
-                  "type": "string"
-                }
-              },
-              "title": "群公告"
+              "$ref": "#/definitions/PuppetRoomAnnounceBody"
             }
           }
         ],
@@ -3866,9 +3653,351 @@
           "Puppet"
         ]
       }
+    },
+    "/wecom/roomAntiSpamStrategy/apply": {
+      "post": {
+        "operationId": "Puppet_ApplyRoomAntiSpamStrategy",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetApplyRoomAntiSpamStrategyResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/puppetApplyRoomAntiSpamStrategyRequest"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/wecom/roomAntiSpamStrategy/{strategyId}/rooms": {
+      "get": {
+        "operationId": "Puppet_GetRoomAntiSpamStrategyEffectRoomList",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetGetRoomAntiSpamStrategyEffectRoomListResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "strategyId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/wecom/roomAntiSpamStrategyList": {
+      "get": {
+        "operationId": "Puppet_GetRoomAntiSpamStrategyList",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetGetRoomAntiSpamStrategyListResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "tags": [
+          "Puppet"
+        ]
+      }
     }
   },
   "definitions": {
+    "PuppetContactAliasBody": {
+      "type": "object",
+      "properties": {
+        "aliasStringValueDeprecated": {
+          "type": "string",
+          "description": "DEPRECATED, will be removed after Dec 31, 2022",
+          "title": "nullable"
+        },
+        "alias": {
+          "type": "string"
+        }
+      }
+    },
+    "PuppetContactCorporationRemarkBody": {
+      "type": "object",
+      "properties": {
+        "corporationRemarkStringValueDeprecated": {
+          "type": "string",
+          "title": "DEPRECATED, will be removed after Dec 31, 2022"
+        },
+        "corporationRemark": {
+          "type": "string"
+        }
+      }
+    },
+    "PuppetContactDeleteBody": {
+      "type": "object"
+    },
+    "PuppetContactDescriptionBody": {
+      "type": "object",
+      "properties": {
+        "descriptionStringValueDeprecated": {
+          "type": "string",
+          "title": "DEPRECATED, will be removed after Dec 31, 2022"
+        },
+        "description": {
+          "type": "string"
+        }
+      }
+    },
+    "PuppetContactPayloadModifyBody": {
+      "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等。"
+        },
+        "tagIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "标签（的id）"
+        },
+        "clearPhones": {
+          "type": "boolean",
+          "description": "*\n The protobuf encoding doesn't distinguish between these two cases. (undefined vs [])\n Since protobuf is language-agnostic,\n it doesn't understand the conceptual nuance of \"undefined\" versus \"[]\" of Javascript."
+        },
+        "clearTagIds": {
+          "type": "boolean"
+        }
+      }
+    },
+    "PuppetContactPhoneBody": {
+      "type": "object",
+      "properties": {
+        "phones": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "PuppetConversationReadBody": {
+      "type": "object",
+      "properties": {
+        "hasRead": {
+          "type": "boolean"
+        }
+      }
+    },
+    "PuppetFriendshipAddBody": {
+      "type": "object",
+      "properties": {
+        "hello": {
+          "type": "string"
+        },
+        "sourceRoomIdStringValueDeprecated": {
+          "type": "string",
+          "title": "Deprecated: will be removed after Dec 31, 2022"
+        },
+        "sourceContactIdStringValueDeprecated": {
+          "type": "string",
+          "title": "Deprecated: will be removed after Dec 31, 2022"
+        },
+        "referrer": {
+          "$ref": "#/definitions/puppetReferrer"
+        }
+      }
+    },
+    "PuppetMessageSendChannelBody": {
+      "type": "object",
+      "properties": {
+        "channel": {
+          "$ref": "#/definitions/puppetChannelPayload"
+        }
+      }
+    },
+    "PuppetMessageSendContactBody": {
+      "type": "object",
+      "properties": {
+        "contactId": {
+          "type": "string"
+        }
+      }
+    },
+    "PuppetMessageSendLocationBody": {
+      "type": "object",
+      "properties": {
+        "location": {
+          "$ref": "#/definitions/puppetLocationPayload"
+        }
+      }
+    },
+    "PuppetMessageSendMiniProgramBody": {
+      "type": "object",
+      "properties": {
+        "miniProgramDeprecated": {
+          "type": "string",
+          "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
+          "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
+        },
+        "miniProgram": {
+          "$ref": "#/definitions/puppetMiniProgramPayload",
+          "title": "小程序payload"
+        }
+      }
+    },
+    "PuppetMessageSendTextBody": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string",
+          "title": "文本内容"
+        },
+        "mentionalIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "@人id列表"
+        },
+        "quoteId": {
+          "type": "string",
+          "title": "引用消息的id"
+        }
+      },
+      "title": "发文本消息"
+    },
+    "PuppetMessageSendUrlBody": {
+      "type": "object",
+      "properties": {
+        "urlLinkDeprecated": {
+          "type": "string",
+          "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
+          "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
+        },
+        "urlLink": {
+          "$ref": "#/definitions/puppetUrlLinkPayload",
+          "title": "链接payload"
+        }
+      }
+    },
+    "PuppetRoomAnnounceBody": {
+      "type": "object",
+      "properties": {
+        "textStringValueDeprecated": {
+          "type": "string",
+          "title": "DEPRECATED, will be removed after Dec 31, 2022"
+        },
+        "text": {
+          "type": "string"
+        }
+      },
+      "title": "群公告"
+    },
     "protobufAny": {
       "type": "object",
       "properties": {
@@ -3878,6 +4007,26 @@
       },
       "additionalProperties": {}
     },
+    "puppetApplyRoomAntiSpamStrategyRequest": {
+      "type": "object",
+      "properties": {
+        "strategyId": {
+          "type": "string"
+        },
+        "roomIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "active": {
+          "type": "boolean"
+        }
+      }
+    },
+    "puppetApplyRoomAntiSpamStrategyResponse": {
+      "type": "object"
+    },
     "puppetBroadcastStatus": {
       "type": "string",
       "enum": [
@@ -4586,6 +4735,29 @@
         }
       }
     },
+    "puppetGetRoomAntiSpamStrategyEffectRoomListResponse": {
+      "type": "object",
+      "properties": {
+        "roomIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "puppetGetRoomAntiSpamStrategyListResponse": {
+      "type": "object",
+      "properties": {
+        "strategies": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/puppetRoomAntiSpamStrategy"
+          }
+        }
+      }
+    },
     "puppetImageType": {
       "type": "string",
       "enum": [
@@ -5291,6 +5463,17 @@
         }
       }
     },
+    "puppetRoomAntiSpamStrategy": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      }
+    },
     "puppetRoomAvatarResponse": {
       "type": "object",
       "properties": {
@@ -5652,20 +5835,6 @@
         }
       }
     },
-    "puppetTagGroupPayload": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        },
-        "type": {
-          "$ref": "#/definitions/puppetTagType"
-        }
-      }
-    },
     "puppetTagGroupPayloadRequest": {
       "type": "object",
       "properties": {
@@ -5678,7 +5847,7 @@
       "type": "object",
       "properties": {
         "payload": {
-          "$ref": "#/definitions/puppetTagGroupPayload"
+          "$ref": "#/definitions/wechatypuppetTagGroupPayload"
         }
       }
     },
@@ -5693,25 +5862,6 @@
         }
       }
     },
-    "puppetTagPayload": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string",
-          "title": "标签名"
-        },
-        "groupId": {
-          "type": "string",
-          "title": "所属标签组的id，可为空"
-        },
-        "type": {
-          "$ref": "#/definitions/puppetTagType"
-        }
-      }
-    },
     "puppetTagPayloadRequest": {
       "type": "object",
       "properties": {
@@ -5724,7 +5874,7 @@
       "type": "object",
       "properties": {
         "payload": {
-          "$ref": "#/definitions/puppetTagPayload"
+          "$ref": "#/definitions/wechatypuppetTagPayload"
         }
       }
     },
@@ -5862,6 +6012,39 @@
           }
         }
       }
+    },
+    "wechatypuppetTagGroupPayload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "#/definitions/puppetTagType"
+        }
+      }
+    },
+    "wechatypuppetTagPayload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string",
+          "title": "标签名"
+        },
+        "groupId": {
+          "type": "string",
+          "title": "所属标签组的id，可为空"
+        },
+        "type": {
+          "$ref": "#/definitions/puppetTagType"
+        }
+      }
     }
   }
 }