@juzi/wechaty-grpc 1.0.5 → 1.0.8

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.5",
+    "version": "1.0.8",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -166,6 +166,118 @@
         ]
       }
     },
+    "/contacts/{contactId}/corp-tag/tags": {
+      "get": {
+        "operationId": "Puppet_CorpTagContactTagList",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagContactTagListResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "contactId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/contacts/{contactId}/corp-tag/tags/{corpTagId}": {
+      "delete": {
+        "operationId": "Puppet_CorpTagContactTagRemove",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagContactTagRemoveResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "contactId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "corpTagId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "corpTagGroupId",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      },
+      "put": {
+        "operationId": "Puppet_CorpTagContactTagAdd",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagContactTagAddResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "contactId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "corpTagId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "corpTagGroupId",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
     "/contacts/{contactId}/corporation-remark": {
       "put": {
         "operationId": "Puppet_ContactCorporationRemark",
@@ -890,6 +1002,212 @@
         ]
       }
     },
+    "/corp-tag/groups": {
+      "get": {
+        "operationId": "Puppet_CorpTagGroupList",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagGroupListResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/corp-tag/groups/{corpTagGroupId}": {
+      "get": {
+        "operationId": "Puppet_CorpTagTagList",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagTagListResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "corpTagGroupId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/corp-tags/groups/{corpTagGroupId}": {
+      "delete": {
+        "operationId": "Puppet_CorpTagGroupDelete",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagGroupDeleteResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "corpTagGroupId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/corp-tags/groups/{corpTagGroupId}/tags/{corpTagId}": {
+      "delete": {
+        "operationId": "Puppet_CorpTagTagDelete",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagTagDeleteResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "corpTagGroupId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "corpTagId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/corp-tags/groups/{corpTagGroupId}/tags/{corpTagName}": {
+      "put": {
+        "operationId": "Puppet_CorpTagTagAdd",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagTagAddResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "corpTagGroupId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "corpTagName",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/corp-tags/groups/{corpTagGroupName}": {
+      "put": {
+        "operationId": "Puppet_CorpTagGroupAdd",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCorpTagGroupAddResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "corpTagGroupName",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
+    "/currentUser": {
+      "get": {
+        "operationId": "Puppet_CurrentUser",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/puppetCurrentUserResponse"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "tags": [
+          "Puppet"
+        ]
+      }
+    },
     "/ding": {
       "post": {
         "operationId": "Puppet_Ding",
@@ -2304,6 +2622,7 @@
         "parameters": [
           {
             "name": "body",
+            "description": "*\nHuan(202003): we just rename the payload message because gRPC only care about the message structure\n (and as long as we keep consistent with the old structure).\n\n @link https://github.com/wechaty/grpc/pull/173\n\nRename:\n 1. `FriendshipSearchWeixinRequest`    -> `FriendshipSearchHandleRequest`\n 2. `FriendshipSearchWeixinReqsponse`  -> `FriendshipSearchHandleResponse`",
             "in": "body",
             "required": true,
             "schema": {
@@ -2677,6 +2996,9 @@
           "items": {
             "type": "string"
           }
+        },
+        "additionalInfo": {
+          "type": "string"
         }
       }
     },
@@ -2723,6 +3045,100 @@
       ],
       "default": "CONTACT_TYPE_UNSPECIFIED"
     },
+    "puppetCorpTagContactTagAddResponse": {
+      "type": "object"
+    },
+    "puppetCorpTagContactTagListResponse": {
+      "type": "object",
+      "properties": {
+        "payloads": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/puppetCorpTagPayload"
+          }
+        }
+      }
+    },
+    "puppetCorpTagContactTagRemoveResponse": {
+      "type": "object"
+    },
+    "puppetCorpTagGroupAddResponse": {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "#/definitions/puppetCorpTagGroupPayload"
+        }
+      }
+    },
+    "puppetCorpTagGroupDeleteResponse": {
+      "type": "object"
+    },
+    "puppetCorpTagGroupListResponse": {
+      "type": "object",
+      "properties": {
+        "payloads": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/puppetCorpTagGroupPayload"
+          }
+        }
+      }
+    },
+    "puppetCorpTagGroupPayload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      }
+    },
+    "puppetCorpTagPayload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "groupId": {
+          "type": "string"
+        }
+      }
+    },
+    "puppetCorpTagTagAddResponse": {
+      "type": "object",
+      "properties": {
+        "payload": {
+          "$ref": "#/definitions/puppetCorpTagPayload"
+        }
+      }
+    },
+    "puppetCorpTagTagDeleteResponse": {
+      "type": "object"
+    },
+    "puppetCorpTagTagListResponse": {
+      "type": "object",
+      "properties": {
+        "payloads": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/puppetCorpTagPayload"
+          }
+        }
+      }
+    },
+    "puppetCurrentUserResponse": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string"
+        }
+      }
+    },
     "puppetDingRequest": {
       "type": "object",
       "properties": {
@@ -3438,6 +3854,9 @@
         },
         "name": {
           "type": "string"
+        },
+        "additionalInfo": {
+          "type": "string"
         }
       }
     },
@@ -3470,6 +3889,9 @@
         },
         "handle": {
           "type": "string"
+        },
+        "additionalInfo": {
+          "type": "string"
         }
       }
     },