@juzi/wechaty-grpc 1.0.11 → 1.0.14

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.11",
+    "version": "1.0.14",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -303,88 +303,6 @@
         ]
       }
     },
-    "/contacts/{contactId}/tag/tags/{tagId}": {
-      "delete": {
-        "operationId": "Puppet_TagContactTagRemove",
-        "responses": {
-          "200": {
-            "description": "A successful response.",
-            "schema": {
-              "$ref": "#/definitions/puppetTagContactTagRemoveResponse"
-            }
-          },
-          "default": {
-            "description": "An unexpected error response.",
-            "schema": {
-              "$ref": "#/definitions/rpcStatus"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "contactId",
-            "in": "path",
-            "required": true,
-            "type": "string"
-          },
-          {
-            "name": "tagId",
-            "in": "path",
-            "required": true,
-            "type": "string"
-          },
-          {
-            "name": "tagGroupId",
-            "in": "query",
-            "required": false,
-            "type": "string"
-          }
-        ],
-        "tags": [
-          "Puppet"
-        ]
-      },
-      "put": {
-        "operationId": "Puppet_TagContactTagAdd",
-        "responses": {
-          "200": {
-            "description": "A successful response.",
-            "schema": {
-              "$ref": "#/definitions/puppetTagContactTagAddResponse"
-            }
-          },
-          "default": {
-            "description": "An unexpected error response.",
-            "schema": {
-              "$ref": "#/definitions/rpcStatus"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "contactId",
-            "in": "path",
-            "required": true,
-            "type": "string"
-          },
-          {
-            "name": "tagId",
-            "in": "path",
-            "required": true,
-            "type": "string"
-          },
-          {
-            "name": "tagGroupId",
-            "in": "query",
-            "required": false,
-            "type": "string"
-          }
-        ],
-        "tags": [
-          "Puppet"
-        ]
-      }
-    },
     "/contacts/{id}": {
       "get": {
         "summary": "Get a contact payload",
@@ -2029,6 +1947,16 @@
             "in": "path",
             "required": true,
             "type": "string"
+          },
+          {
+            "name": "contactIds",
+            "in": "query",
+            "required": false,
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "collectionFormat": "multi"
           }
         ],
         "tags": [
@@ -2222,14 +2150,46 @@
         ]
       }
     },
-    "/tag/groups": {
-      "get": {
-        "operationId": "Puppet_TagGroupList",
+    "/tag/add": {
+      "post": {
+        "operationId": "Puppet_TagTagAdd",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/puppetTagGroupListResponse"
+              "$ref": "#/definitions/puppetTagTagAddResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/puppetTagTagAddRequest"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/tag/addContactTag": {
+      "post": {
+        "operationId": "Puppet_TagContactTagAdd",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetTagContactTagAddResponse"
             }
           },
           "default": {
@@ -2239,6 +2199,48 @@
             }
           }
         },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/puppetTagContactTagAddRequest"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/tag/delete": {
+      "post": {
+        "operationId": "Puppet_TagTagDelete",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetTagTagDeleteResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/puppetTagTagDeleteRequest"
+            }
+          }
+        ],
         "tags": [
           "Puppet"
         ]
@@ -2274,7 +2276,7 @@
         ]
       }
     },
-    "/tag/tags": {
+    "/tag/list": {
       "get": {
         "operationId": "Puppet_TagTagList",
         "responses": {
@@ -2296,14 +2298,14 @@
         ]
       }
     },
-    "/tag/{tagGroupId}/{tagId}/contacts": {
-      "get": {
-        "operationId": "Puppet_TagTagContactList",
+    "/tag/payload": {
+      "post": {
+        "operationId": "Puppet_TagPayload",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/puppetTagTagContactListResponse"
+              "$ref": "#/definitions/puppetTagPayloadResponse"
             }
           },
           "default": {
@@ -2315,16 +2317,12 @@
         },
         "parameters": [
           {
-            "name": "tagGroupId",
-            "in": "path",
-            "required": true,
-            "type": "string"
-          },
-          {
-            "name": "tagId",
-            "in": "path",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "string"
+            "schema": {
+              "$ref": "#/definitions/puppetTagPayloadRequest"
+            }
           }
         ],
         "tags": [
@@ -2332,14 +2330,14 @@
         ]
       }
     },
-    "/tags/groups/{tagGroupId}": {
-      "delete": {
-        "operationId": "Puppet_TagGroupDelete",
+    "/tag/removeContactTag": {
+      "post": {
+        "operationId": "Puppet_TagContactTagRemove",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/puppetTagGroupDeleteResponse"
+              "$ref": "#/definitions/puppetTagContactTagRemoveResponse"
             }
           },
           "default": {
@@ -2351,10 +2349,12 @@
         },
         "parameters": [
           {
-            "name": "tagGroupId",
-            "in": "path",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "string"
+            "schema": {
+              "$ref": "#/definitions/puppetTagContactTagRemoveRequest"
+            }
           }
         ],
         "tags": [
@@ -2362,14 +2362,14 @@
         ]
       }
     },
-    "/tags/groups/{tagGroupId}/tags/{tagId}": {
-      "delete": {
-        "operationId": "Puppet_TagTagDelete",
+    "/tag/{tag.groupId}/{tag.id}/contacts": {
+      "get": {
+        "operationId": "Puppet_TagTagContactList",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/puppetTagTagDeleteResponse"
+              "$ref": "#/definitions/puppetTagTagContactListResponse"
             }
           },
           "default": {
@@ -2381,13 +2381,13 @@
         },
         "parameters": [
           {
-            "name": "tagGroupId",
+            "name": "tag.groupId",
             "in": "path",
             "required": true,
             "type": "string"
           },
           {
-            "name": "tagId",
+            "name": "tag.id",
             "in": "path",
             "required": true,
             "type": "string"
@@ -2398,14 +2398,14 @@
         ]
       }
     },
-    "/tags/groups/{tagGroupId}/tags/{tagName}": {
-      "put": {
-        "operationId": "Puppet_TagTagAdd",
+    "/tagGroup/add": {
+      "post": {
+        "operationId": "Puppet_TagGroupAdd",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/puppetTagTagAddResponse"
+              "$ref": "#/definitions/puppetTagGroupAddResponse"
             }
           },
           "default": {
@@ -2417,16 +2417,44 @@
         },
         "parameters": [
           {
-            "name": "tagGroupId",
-            "in": "path",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "string"
+            "schema": {
+              "$ref": "#/definitions/puppetTagGroupAddRequest"
+            }
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/tagGroup/delete": {
+      "post": {
+        "operationId": "Puppet_TagGroupDelete",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetTagGroupDeleteResponse"
+            }
           },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
           {
-            "name": "tagName",
-            "in": "path",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "string"
+            "schema": {
+              "$ref": "#/definitions/puppetTagGroupDeleteRequest"
+            }
           }
         ],
         "tags": [
@@ -2434,14 +2462,36 @@
         ]
       }
     },
-    "/tags/groups/{tagGroupName}": {
-      "put": {
-        "operationId": "Puppet_TagGroupAdd",
+    "/tagGroup/list": {
+      "get": {
+        "operationId": "Puppet_TagGroupList",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/puppetTagGroupAddResponse"
+              "$ref": "#/definitions/puppetTagGroupListResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/tagGroup/payload": {
+      "post": {
+        "operationId": "Puppet_TagGroupPayload",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetTagGroupPayloadResponse"
             }
           },
           "default": {
@@ -2453,10 +2503,12 @@
         },
         "parameters": [
           {
-            "name": "tagGroupName",
-            "in": "path",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "string"
+            "schema": {
+              "$ref": "#/definitions/puppetTagGroupPayloadRequest"
+            }
           }
         ],
         "tags": [
@@ -3025,7 +3077,8 @@
         "EVENT_TYPE_RESET",
         "EVENT_TYPE_LOGIN",
         "EVENT_TYPE_LOGOUT",
-        "EVENT_TYPE_DIRTY"
+        "EVENT_TYPE_DIRTY",
+        "EVENT_TYPE_TAG"
       ],
       "default": "EVENT_TYPE_UNSPECIFIED"
     },
@@ -3757,16 +3810,50 @@
     "puppetStopResponse": {
       "type": "object"
     },
+    "puppetTagContactTagAddRequest": {
+      "type": "object",
+      "properties": {
+        "tags": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/puppetTagIdentifier"
+          }
+        },
+        "contactIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
     "puppetTagContactTagAddResponse": {
       "type": "object"
     },
     "puppetTagContactTagListResponse": {
       "type": "object",
       "properties": {
-        "payloads": {
+        "tags": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/puppetTagPayload"
+            "$ref": "#/definitions/puppetTagIdentifier"
+          }
+        }
+      }
+    },
+    "puppetTagContactTagRemoveRequest": {
+      "type": "object",
+      "properties": {
+        "tags": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/puppetTagIdentifier"
+          }
+        },
+        "contactIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
           }
         }
       }
@@ -3774,11 +3861,27 @@
     "puppetTagContactTagRemoveResponse": {
       "type": "object"
     },
+    "puppetTagGroupAddRequest": {
+      "type": "object",
+      "properties": {
+        "tagGroupName": {
+          "type": "string"
+        }
+      }
+    },
     "puppetTagGroupAddResponse": {
       "type": "object",
       "properties": {
-        "payload": {
-          "$ref": "#/definitions/puppetTagGroupPayload"
+        "tagGroupId": {
+          "type": "string"
+        }
+      }
+    },
+    "puppetTagGroupDeleteRequest": {
+      "type": "object",
+      "properties": {
+        "tagGroupId": {
+          "type": "string"
         }
       }
     },
@@ -3788,10 +3891,10 @@
     "puppetTagGroupListResponse": {
       "type": "object",
       "properties": {
-        "payloads": {
+        "tagGroupIds": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/puppetTagGroupPayload"
+            "type": "string"
           }
         }
       }
@@ -3804,20 +3907,50 @@
         },
         "name": {
           "type": "string"
+        },
+        "type": {
+          "$ref": "#/definitions/puppetTagType"
+        }
+      }
+    },
+    "puppetTagGroupPayloadRequest": {
+      "type": "object",
+      "properties": {
+        "groupId": {
+          "type": "string"
+        }
+      }
+    },
+    "puppetTagGroupPayloadResponse": {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "#/definitions/puppetTagGroupPayload"
         }
       }
     },
     "puppetTagGroupTagListResponse": {
       "type": "object",
       "properties": {
-        "payloads": {
+        "tags": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/puppetTagPayload"
+            "$ref": "#/definitions/puppetTagIdentifier"
           }
         }
       }
     },
+    "puppetTagIdentifier": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "groupId": {
+          "type": "string"
+        }
+      }
+    },
     "puppetTagPayload": {
       "type": "object",
       "properties": {
@@ -3835,7 +3968,15 @@
         }
       }
     },
-    "puppetTagTagAddResponse": {
+    "puppetTagPayloadRequest": {
+      "type": "object",
+      "properties": {
+        "tag": {
+          "$ref": "#/definitions/puppetTagIdentifier"
+        }
+      }
+    },
+    "puppetTagPayloadResponse": {
       "type": "object",
       "properties": {
         "payload": {
@@ -3843,10 +3984,29 @@
         }
       }
     },
+    "puppetTagTagAddRequest": {
+      "type": "object",
+      "properties": {
+        "tagName": {
+          "type": "string"
+        },
+        "tagGroupId": {
+          "type": "string"
+        }
+      }
+    },
+    "puppetTagTagAddResponse": {
+      "type": "object",
+      "properties": {
+        "tag": {
+          "$ref": "#/definitions/puppetTagIdentifier"
+        }
+      }
+    },
     "puppetTagTagContactListResponse": {
       "type": "object",
       "properties": {
-        "payloads": {
+        "contactIds": {
           "type": "array",
           "items": {
             "type": "string"
@@ -3854,16 +4014,24 @@
         }
       }
     },
+    "puppetTagTagDeleteRequest": {
+      "type": "object",
+      "properties": {
+        "tag": {
+          "$ref": "#/definitions/puppetTagIdentifier"
+        }
+      }
+    },
     "puppetTagTagDeleteResponse": {
       "type": "object"
     },
     "puppetTagTagListResponse": {
       "type": "object",
       "properties": {
-        "payloads": {
+        "tags": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/puppetTagPayload"
+            "$ref": "#/definitions/puppetTagIdentifier"
           }
         }
       }