@juzi/wechaty-grpc 1.0.10 → 1.0.13

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.10
+  version: 1.0.13
   contact:
     name: Wechaty
     url: 'https://github.com/wechaty/openapi'
@@ -43,29 +43,6 @@ paths:
             $ref: '#/definitions/rpcStatus'
       tags:
         - Puppet
-  '/contacts/-/tags/{id}':
-    delete:
-      summary: |-
-        *
-        Operate Sub-Collections
-          https://cloud.google.com/apis/design/design_patterns#list_sub-collections
-      operationId: Puppet_TagContactDelete
-      responses:
-        '200':
-          description: A successful response.
-          schema:
-            $ref: '#/definitions/puppetTagContactDeleteResponse'
-        default:
-          description: An unexpected error response.
-          schema:
-            $ref: '#/definitions/rpcStatus'
-      parameters:
-        - name: id
-          in: path
-          required: true
-          type: string
-      tags:
-        - Puppet
   '/contacts/self/name/{name}':
     put:
       operationId: Puppet_ContactSelfName
@@ -121,78 +98,6 @@ paths:
             $ref: '#/definitions/puppetContactSelfSignatureRequest'
       tags:
         - Puppet
-  '/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
@@ -280,65 +185,14 @@ paths:
                   type: string
       tags:
         - Puppet
-  '/contacts/{contactId}/tags':
+  '/contacts/{contactId}/tag/tags':
     get:
-      operationId: Puppet_TagContactList
-      responses:
-        '200':
-          description: A successful response.
-          schema:
-            $ref: '#/definitions/puppetTagContactListResponse'
-        default:
-          description: An unexpected error response.
-          schema:
-            $ref: '#/definitions/rpcStatus'
-      parameters:
-        - name: contactId
-          in: path
-          required: true
-          type: string
-        - name: contactIdStringValueDeprecated
-          description: |-
-            @deprecated:
-             Huan(202109): Wrapper types must not be used going forward.
-               https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
-          in: query
-          required: false
-          type: string
-      tags:
-        - Puppet
-  '/contacts/{contactId}/tags/{id}':
-    delete:
-      operationId: Puppet_TagContactRemove
-      responses:
-        '200':
-          description: A successful response.
-          schema:
-            $ref: '#/definitions/puppetTagContactRemoveResponse'
-        default:
-          description: An unexpected error response.
-          schema:
-            $ref: '#/definitions/rpcStatus'
-      parameters:
-        - name: contactId
-          in: path
-          required: true
-          type: string
-        - name: id
-          in: path
-          required: true
-          type: string
-      tags:
-        - Puppet
-    put:
-      summary: '*'
-      description: Tag
-      operationId: Puppet_TagContactAdd
+      operationId: Puppet_TagContactTagList
       responses:
         '200':
           description: A successful response.
           schema:
-            $ref: '#/definitions/puppetTagContactAddResponse'
+            $ref: '#/definitions/puppetTagContactTagListResponse'
         default:
           description: An unexpected error response.
           schema:
@@ -348,10 +202,6 @@ paths:
           in: path
           required: true
           type: string
-        - name: id
-          in: path
-          required: true
-          type: string
       tags:
         - Puppet
   '/contacts/{id}':
@@ -670,123 +520,6 @@ paths:
                 $ref: '#/definitions/puppetUrlLinkPayload'
       tags:
         - Puppet
-  /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
@@ -1572,6 +1305,13 @@ paths:
           in: path
           required: true
           type: string
+        - name: contactIds
+          in: query
+          required: false
+          type: array
+          items:
+            type: string
+          collectionFormat: multi
       tags:
         - Puppet
   '/rooms/{id}/members':
@@ -1694,79 +1434,309 @@ paths:
             $ref: '#/definitions/rpcStatus'
       tags:
         - Puppet
-  /upload:
+  /tag/add:
     post:
-      operationId: Puppet_Upload
+      operationId: Puppet_TagTagAdd
       responses:
         '200':
           description: A successful response.
           schema:
-            $ref: '#/definitions/puppetUploadResponse'
+            $ref: '#/definitions/puppetTagTagAddResponse'
         default:
           description: An unexpected error response.
           schema:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: body
-          description: ' (streaming inputs)'
           in: body
           required: true
           schema:
-            $ref: '#/definitions/puppetUploadRequest'
+            $ref: '#/definitions/puppetTagTagAddRequest'
       tags:
         - Puppet
-  /version:
-    get:
-      operationId: Puppet_Version
+  /tag/addContactTag:
+    post:
+      operationId: Puppet_TagContactTagAdd
       responses:
         '200':
           description: A successful response.
           schema:
-            $ref: '#/definitions/puppetVersionResponse'
+            $ref: '#/definitions/puppetTagContactTagAddResponse'
         default:
           description: An unexpected error response.
           schema:
             $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetTagContactTagAddRequest'
       tags:
         - Puppet
-  /wechaty.Puppet/FriendshipSearchWeixin:
+  /tag/delete:
     post:
-      summary: |-
-        *
-        Huan(202203): https://github.com/wechaty/puppet/issues/181
-        @deprecated use FriendshipSearchHandle instead, will be removed in v3.0
-      operationId: Puppet_FriendshipSearchWeixin
+      operationId: Puppet_TagTagDelete
       responses:
         '200':
           description: A successful response.
           schema:
-            $ref: '#/definitions/puppetFriendshipSearchHandleResponse'
+            $ref: '#/definitions/puppetTagTagDeleteResponse'
         default:
           description: An unexpected error response.
           schema:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: body
-          description: >-
-            *
-
-            Huan(202003): we just rename the payload message because gRPC only
-            care about the message structure
-             (and as long as we keep consistent with the old structure).
-
-             @link https://github.com/wechaty/grpc/pull/173
-
-            Rename:
-             1. `FriendshipSearchWeixinRequest`    -> `FriendshipSearchHandleRequest`
-             2. `FriendshipSearchWeixinReqsponse`  -> `FriendshipSearchHandleResponse`
           in: body
           required: true
           schema:
-            $ref: '#/definitions/puppetFriendshipSearchHandleRequest'
+            $ref: '#/definitions/puppetTagTagDeleteRequest'
       tags:
         - Puppet
-  /wechaty.Puppet/MessageFile:
-    post:
+  '/tag/groups/{tagGroupId}/tags':
+    get:
+      operationId: Puppet_TagGroupTagList
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetTagGroupTagListResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: tagGroupId
+          in: path
+          required: true
+          type: string
+      tags:
+        - Puppet
+  /tag/list:
+    get:
+      operationId: Puppet_TagTagList
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetTagTagListResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      tags:
+        - Puppet
+  /tag/payload:
+    post:
+      operationId: Puppet_TagPayload
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetTagPayloadResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetTagPayloadRequest'
+      tags:
+        - Puppet
+  /tag/removeContactTag:
+    post:
+      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: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetTagContactTagRemoveRequest'
+      tags:
+        - Puppet
+  '/tag/{tag.groupId}/{tag.id}/contacts':
+    get:
+      operationId: Puppet_TagTagContactList
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetTagTagContactListResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: tag.groupId
+          in: path
+          required: true
+          type: string
+        - name: tag.id
+          in: path
+          required: true
+          type: string
+      tags:
+        - Puppet
+  /tagGroup/add:
+    post:
+      operationId: Puppet_TagGroupAdd
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetTagGroupAddResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          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: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetTagGroupDeleteRequest'
+      tags:
+        - Puppet
+  /tagGroup/list:
+    get:
+      operationId: Puppet_TagGroupList
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $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:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetTagGroupPayloadRequest'
+      tags:
+        - Puppet
+  /upload:
+    post:
+      operationId: Puppet_Upload
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetUploadResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          description: ' (streaming inputs)'
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetUploadRequest'
+      tags:
+        - Puppet
+  /version:
+    get:
+      operationId: Puppet_Version
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetVersionResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      tags:
+        - Puppet
+  /wechaty.Puppet/FriendshipSearchWeixin:
+    post:
+      summary: |-
+        *
+        Huan(202203): https://github.com/wechaty/puppet/issues/181
+        @deprecated use FriendshipSearchHandle instead, will be removed in v3.0
+      operationId: Puppet_FriendshipSearchWeixin
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetFriendshipSearchHandleResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          description: >-
+            *
+
+            Huan(202003): we just rename the payload message because gRPC only
+            care about the message structure
+             (and as long as we keep consistent with the old structure).
+
+             @link https://github.com/wechaty/grpc/pull/173
+
+            Rename:
+             1. `FriendshipSearchWeixinRequest`    -> `FriendshipSearchHandleRequest`
+             2. `FriendshipSearchWeixinReqsponse`  -> `FriendshipSearchHandleResponse`
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetFriendshipSearchHandleRequest'
+      tags:
+        - Puppet
+  /wechaty.Puppet/MessageFile:
+    post:
       operationId: Puppet_MessageFile
       responses:
         '200':
@@ -2045,61 +2015,6 @@ definitions:
       - CONTACT_TYPE_OFFICIAL
       - CONTACT_TYPE_CORPORATION
     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:
@@ -2148,6 +2063,7 @@ definitions:
       - EVENT_TYPE_LOGIN
       - EVENT_TYPE_LOGOUT
       - EVENT_TYPE_DIRTY
+      - EVENT_TYPE_TAG
     default: EVENT_TYPE_UNSPECIFIED
   puppetFileBoxChunk:
     type: object
@@ -2719,19 +2635,154 @@ definitions:
     type: object
   puppetStopResponse:
     type: object
-  puppetTagContactAddResponse:
+  puppetTagContactTagAddRequest:
     type: object
-  puppetTagContactDeleteResponse:
+    properties:
+      tags:
+        type: array
+        items:
+          $ref: '#/definitions/puppetTagIdentifier'
+      contactIds:
+        type: array
+        items:
+          type: string
+  puppetTagContactTagAddResponse:
     type: object
-  puppetTagContactListResponse:
+  puppetTagContactTagListResponse:
     type: object
     properties:
-      ids:
+      tags:
+        type: array
+        items:
+          $ref: '#/definitions/puppetTagIdentifier'
+  puppetTagContactTagRemoveRequest:
+    type: object
+    properties:
+      tags:
+        type: array
+        items:
+          $ref: '#/definitions/puppetTagIdentifier'
+      contactIds:
+        type: array
+        items:
+          type: string
+  puppetTagContactTagRemoveResponse:
+    type: object
+  puppetTagGroupAddRequest:
+    type: object
+    properties:
+      tagGroupName:
+        type: string
+  puppetTagGroupAddResponse:
+    type: object
+    properties:
+      tagGroupId:
+        type: string
+  puppetTagGroupDeleteRequest:
+    type: object
+    properties:
+      tagGroupId:
+        type: string
+  puppetTagGroupDeleteResponse:
+    type: object
+  puppetTagGroupListResponse:
+    type: object
+    properties:
+      tagGroupIds:
+        type: array
+        items:
+          type: string
+  puppetTagGroupPayload:
+    type: object
+    properties:
+      id:
+        type: string
+      name:
+        type: string
+  puppetTagGroupPayloadRequest:
+    type: object
+    properties:
+      groupId:
+        type: string
+  puppetTagGroupPayloadResponse:
+    type: object
+    properties:
+      payload:
+        $ref: '#/definitions/puppetTagGroupPayload'
+  puppetTagGroupTagListResponse:
+    type: object
+    properties:
+      tags:
+        type: array
+        items:
+          $ref: '#/definitions/puppetTagIdentifier'
+  puppetTagIdentifier:
+    type: object
+    properties:
+      id:
+        type: string
+      groupId:
+        type: string
+  puppetTagPayload:
+    type: object
+    properties:
+      id:
+        type: string
+      name:
+        type: string
+      groupId:
+        type: string
+      type:
+        $ref: '#/definitions/puppetTagType'
+  puppetTagPayloadRequest:
+    type: object
+    properties:
+      tag:
+        $ref: '#/definitions/puppetTagIdentifier'
+  puppetTagPayloadResponse:
+    type: object
+    properties:
+      payload:
+        $ref: '#/definitions/puppetTagPayload'
+  puppetTagTagAddRequest:
+    type: object
+    properties:
+      tagName:
+        type: string
+      tagGroupId:
+        type: string
+  puppetTagTagAddResponse:
+    type: object
+    properties:
+      tag:
+        $ref: '#/definitions/puppetTagIdentifier'
+  puppetTagTagContactListResponse:
+    type: object
+    properties:
+      contactIds:
         type: array
         items:
           type: string
-  puppetTagContactRemoveResponse:
+  puppetTagTagDeleteRequest:
+    type: object
+    properties:
+      tag:
+        $ref: '#/definitions/puppetTagIdentifier'
+  puppetTagTagDeleteResponse:
     type: object
+  puppetTagTagListResponse:
+    type: object
+    properties:
+      tags:
+        type: array
+        items:
+          $ref: '#/definitions/puppetTagIdentifier'
+  puppetTagType:
+    type: string
+    enum:
+      - PERSONAL
+      - CORPORATION
+    default: PERSONAL
   puppetUploadRequest:
     type: object
     properties: