@juzi/wechaty-grpc 1.0.74 → 1.0.76

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.74
+  version: 1.0.76
   contact:
     name: Wechaty
     url: https://github.com/wechaty/openapi
@@ -219,13 +219,7 @@ paths:
           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'
       tags:
         - Puppet
   /contacts/{contactId}/delete:
@@ -249,7 +243,7 @@ paths:
           in: body
           required: true
           schema:
-            type: object
+            $ref: '#/definitions/PuppetContactDeleteBody'
       tags:
         - Puppet
   /contacts/{contactId}/description:
@@ -273,13 +267,7 @@ paths:
           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'
       tags:
         - Puppet
   /contacts/{contactId}/phone:
@@ -303,12 +291,7 @@ paths:
           in: body
           required: true
           schema:
-            type: object
-            properties:
-              phones:
-                type: array
-                items:
-                  type: string
+            $ref: '#/definitions/PuppetContactPhoneBody'
       tags:
         - Puppet
   /contacts/{contactId}/tag/tags:
@@ -372,14 +355,7 @@ paths:
           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'
       tags:
         - Puppet
   /contacts/{id}/avatar:
@@ -465,78 +441,7 @@ paths:
           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: |-
-                  *
-                   The protobuf encoding doesn't distinguish between these two cases. (undefined vs [])
-                   Since protobuf is language-agnostic,
-                   it doesn't understand the conceptual nuance of "undefined" versus "[]" of Javascript.
-              clearTagIds:
-                type: boolean
+            $ref: '#/definitions/PuppetContactPayloadModifyBody'
       tags:
         - Puppet
   /conversation/{conversationId}/read:
@@ -562,10 +467,7 @@ paths:
           in: body
           required: true
           schema:
-            type: object
-            properties:
-              hasRead:
-                type: boolean
+            $ref: '#/definitions/PuppetConversationReadBody'
       tags:
         - Puppet
   /conversations/{conversationId}/channel:
@@ -589,10 +491,7 @@ paths:
           in: body
           required: true
           schema:
-            type: object
-            properties:
-              channel:
-                $ref: '#/definitions/puppetChannelPayload'
+            $ref: '#/definitions/PuppetMessageSendChannelBody'
       tags:
         - Puppet
   /conversations/{conversationId}/contact:
@@ -616,10 +515,7 @@ paths:
           in: body
           required: true
           schema:
-            type: object
-            properties:
-              contactId:
-                type: string
+            $ref: '#/definitions/PuppetMessageSendContactBody'
       tags:
         - Puppet
   /conversations/{conversationId}/forward/{messageId}:
@@ -679,10 +575,7 @@ paths:
           in: body
           required: true
           schema:
-            type: object
-            properties:
-              location:
-                $ref: '#/definitions/puppetLocationPayload'
+            $ref: '#/definitions/PuppetMessageSendLocationBody'
       tags:
         - Puppet
   /conversations/{conversationId}/mini-program:
@@ -707,22 +600,7 @@ paths:
           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: >-
-                  *
-
-                  Huan(202110): We should use payload instead of JSON.stringify
-                  string
-                   The compatible code will be removed after Dec 31, 2022
-              miniProgram:
-                $ref: '#/definitions/puppetMiniProgramPayload'
-                title: 小程序payload
+            $ref: '#/definitions/PuppetMessageSendMiniProgramBody'
       tags:
         - Puppet
   /conversations/{conversationId}/text:
@@ -747,20 +625,7 @@ paths:
           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'
       tags:
         - Puppet
   /conversations/{conversationId}/url-link:
@@ -785,22 +650,7 @@ paths:
           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: >-
-                  *
-
-                  Huan(202110): We should use payload instead of JSON.stringify
-                  string
-                   The compatible code will be removed after Dec 31, 2022
-              urlLink:
-                $ref: '#/definitions/puppetUrlLinkPayload'
-                title: 链接payload
+            $ref: '#/definitions/PuppetMessageSendUrlBody'
       tags:
         - Puppet
   /currentUser:
@@ -962,18 +812,7 @@ paths:
           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'
       tags:
         - Puppet
   /friendship/search/handle/{weixin}:
@@ -1845,14 +1684,7 @@ paths:
           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'
       tags:
         - Puppet
   /rooms/{id}/avatar:
@@ -2588,13 +2420,273 @@ paths:
             $ref: '#/definitions/puppetMessageSendFileRequest'
       tags:
         - 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: |-
+          *
+           The protobuf encoding doesn't distinguish between these two cases. (undefined vs [])
+           Since protobuf is language-agnostic,
+           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: |-
+          *
+          Huan(202110): We should use payload instead of JSON.stringify string
+           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: |-
+          *
+          Huan(202110): We should use payload instead of JSON.stringify string
+           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:
       '@type':
         type: string
     additionalProperties: {}
+  puppetApplyRoomAntiSpamStrategyRequest:
+    type: object
+    properties:
+      strategyId:
+        type: string
+      roomIds:
+        type: array
+        items:
+          type: string
+      active:
+        type: boolean
+  puppetApplyRoomAntiSpamStrategyResponse:
+    type: object
   puppetBroadcastStatus:
     type: string
     enum:
@@ -3168,6 +3260,21 @@ definitions:
         type: array
         items:
           type: string
+  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:
@@ -3321,6 +3428,11 @@ definitions:
         title: 被引用的消息id
       additionalInfo:
         type: string
+      textContents:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/puppetTextContent'
   puppetMessagePreviewResponse:
     type: object
     properties:
@@ -3734,6 +3846,13 @@ definitions:
         title: DEPRECATED, will be removed after Dec 31, 2022
       text:
         type: string
+  puppetRoomAntiSpamStrategy:
+    type: object
+    properties:
+      id:
+        type: string
+      name:
+        type: string
   puppetRoomAvatarResponse:
     type: object
     properties:
@@ -3985,15 +4104,6 @@ definitions:
         type: array
         items:
           type: string
-  puppetTagGroupPayload:
-    type: object
-    properties:
-      id:
-        type: string
-      name:
-        type: string
-      type:
-        $ref: '#/definitions/puppetTagType'
   puppetTagGroupPayloadRequest:
     type: object
     properties:
@@ -4003,7 +4113,7 @@ definitions:
     type: object
     properties:
       payload:
-        $ref: '#/definitions/puppetTagGroupPayload'
+        $ref: '#/definitions/wechatypuppetTagGroupPayload'
   puppetTagGroupTagListResponse:
     type: object
     properties:
@@ -4011,19 +4121,6 @@ definitions:
         type: array
         items:
           type: string
-  puppetTagPayload:
-    type: object
-    properties:
-      id:
-        type: string
-      name:
-        type: string
-        title: 标签名
-      groupId:
-        type: string
-        title: 所属标签组的id，可为空
-      type:
-        $ref: '#/definitions/puppetTagType'
   puppetTagPayloadRequest:
     type: object
     properties:
@@ -4033,7 +4130,7 @@ definitions:
     type: object
     properties:
       payload:
-        $ref: '#/definitions/puppetTagPayload'
+        $ref: '#/definitions/wechatypuppetTagPayload'
   puppetTagTagAddRequest:
     type: object
     properties:
@@ -4083,6 +4180,26 @@ definitions:
       - TAP_TYPE_UNSPECIFIED
       - TAP_TYPE_LIKE
     default: TAP_TYPE_UNSPECIFIED
+  puppetTextContent:
+    type: object
+    properties:
+      type:
+        $ref: '#/definitions/puppetTextContentType'
+      text:
+        type: string
+      data:
+        $ref: '#/definitions/puppetTextContentData'
+  puppetTextContentData:
+    type: object
+    properties:
+      contactId:
+        type: string
+  puppetTextContentType:
+    type: string
+    enum:
+      - TEXT_CONTENT_TYPE_REGULAR
+      - TEXT_CONTENT_TYPE_AT
+    default: TEXT_CONTENT_TYPE_REGULAR
   puppetUploadRequest:
     type: object
     properties:
@@ -4127,4 +4244,26 @@ definitions:
         items:
           type: object
           $ref: '#/definitions/protobufAny'
+  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'