@juzi/wechaty-grpc 1.0.108 → 1.0.110

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.108
+  version: 1.0.110
   contact:
     name: Wechaty
     url: https://github.com/wechaty/openapi
@@ -3179,6 +3179,67 @@ paths:
             $ref: '#/definitions/puppetMessageVoiceTextRequest'
       tags:
         - Puppet
+  /wechaty.Puppet/RoomMemberLoadState:
+    post:
+      operationId: Puppet_RoomMemberLoadState
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetRoomMemberLoadStateResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetRoomMemberLoadStateRequest'
+      tags:
+        - Puppet
+  /wechaty.Puppet/RoomMemberSnapshot:
+    post:
+      summary: Reads an existing revision only; must not start member loading.
+      operationId: Puppet_RoomMemberSnapshot
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetRoomMemberSnapshotResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetRoomMemberSnapshotRequest'
+      tags:
+        - Puppet
+  /wechaty.Puppet/RoomMemberSync:
+    post:
+      operationId: Puppet_RoomMemberSync
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetRoomMemberLoadStateResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/puppetRoomMemberSyncRequest'
+      tags:
+        - Puppet
   /wecom/corpMessageInterceptionStrategyList:
     get:
       operationId: Puppet_GetCorpMessageInterceptionStrategies
@@ -3193,6 +3254,49 @@ paths:
             $ref: '#/definitions/rpcStatus'
       tags:
         - Puppet
+  /wecom/orgBroadcast/{id}:
+    get:
+      operationId: Puppet_OrgBroadcastPayload
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetOrgBroadcastPayloadResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: id
+          in: path
+          required: true
+          type: string
+      tags:
+        - Puppet
+  /wecom/orgBroadcast/{id}/execute:
+    post:
+      operationId: Puppet_OrgBroadcastExecute
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetOrgBroadcastExecuteResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      parameters:
+        - name: id
+          in: path
+          required: true
+          type: string
+        - name: body
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/PuppetOrgBroadcastExecuteBody'
+      tags:
+        - Puppet
   /wecom/roomAntiSpamStrategy/apply:
     post:
       operationId: Puppet_ApplyRoomAntiSpamStrategy
@@ -3487,6 +3591,19 @@ definitions:
       urlLink:
         $ref: '#/definitions/puppetUrlLinkPayload'
         title: 链接payload
+  PuppetOrgBroadcastExecuteBody:
+    type: object
+    properties:
+      targetIds:
+        type: array
+        items:
+          type: string
+        title: >-
+          empty means all targets of the plan; otherwise a subset of the plan
+          targets.
+
+          clients must not send an explicit empty selection, it would be read as
+          all targets
   PuppetRoomAnnounceBody:
     type: object
     properties:
@@ -4195,10 +4312,15 @@ definitions:
       - EVENT_TYPE_VERIFY_SLIDE
       - EVENT_TYPE_CALL
       - EVENT_TYPE_SAME_NET_VERIFY
+      - EVENT_TYPE_ORG_BROADCAST_CREATED
+      - EVENT_TYPE_ORG_BROADCAST_SENT
+      - EVENT_TYPE_ROOM_MEMBER_LOAD
     default: EVENT_TYPE_UNSPECIFIED
     description: >-
       - EVENT_TYPE_SAME_NET_VERIFY: same network verify for personal wechat
       login on Mac protocol
+       - EVENT_TYPE_ORG_BROADCAST_CREATED: wecom org (admin) broadcast plan arrived: member received the broadcast assistant card
+       - EVENT_TYPE_ORG_BROADCAST_SENT: wecom org (admin) broadcast plan executed, from any client
   puppetFriendshipAcceptResponse:
     type: object
   puppetFriendshipAddResponse:
@@ -5064,6 +5186,77 @@ definitions:
       - BOOL_FALSE
       - BOOL_TRUE
     default: BOOL_UNSET
+  puppetOrgBroadcastExecuteResponse:
+    type: object
+  puppetOrgBroadcastPayloadResponse:
+    type: object
+    properties:
+      id:
+        type: string
+      sendType:
+        type: integer
+        format: int32
+        title: '0: official (org admin), 1: personal, 2: special'
+      conversationType:
+        type: integer
+        format: int32
+        title: '0: person, 1: group'
+      creatorId:
+        type: string
+      execTime:
+        type: string
+        format: int64
+        title: milliseconds timestamp of the scheduled sending, 0 means immediately
+      status:
+        type: integer
+        format: int32
+        title: >-
+          0: checking, 1: check succeeded, 2: check failed, 3: delayed send
+          succeeded, 4: delayed send canceled
+      canCancel:
+        type: boolean
+      allowSelect:
+        type: boolean
+        title: members may adjust targets before sending
+      sent:
+        type: boolean
+      totalCount:
+        type: integer
+        format: int32
+      sentCount:
+        type: integer
+        format: int32
+      contentListJson:
+        type: string
+      targets:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/puppetOrgBroadcastTarget'
+  puppetOrgBroadcastTarget:
+    type: object
+    properties:
+      contactId:
+        type: string
+        title: set when conversation_type is person
+      roomId:
+        type: string
+        title: set when conversation_type is group
+      status:
+        $ref: '#/definitions/puppetOrgBroadcastTargetStatus'
+  puppetOrgBroadcastTargetStatus:
+    type: string
+    enum:
+      - ORG_BROADCAST_TARGET_STATUS_UNSENT
+      - ORG_BROADCAST_TARGET_STATUS_SENT
+      - ORG_BROADCAST_TARGET_STATUS_NOT_FRIEND
+      - ORG_BROADCAST_TARGET_STATUS_OCCUPIED
+      - ORG_BROADCAST_TARGET_STATUS_UNCONFIRMED
+      - ORG_BROADCAST_TARGET_STATUS_CONFIRMED
+      - ORG_BROADCAST_TARGET_STATUS_EXPIRED
+      - ORG_BROADCAST_TARGET_STATUS_CANCELED
+      - ORG_BROADCAST_TARGET_STATUS_NEW_UNSENT
+    default: ORG_BROADCAST_TARGET_STATUS_UNSENT
   puppetPayloadType:
     type: string
     enum:
@@ -5382,6 +5575,44 @@ definitions:
         type: array
         items:
           type: string
+  puppetRoomMemberLoadMode:
+    type: string
+    enum:
+      - ROOM_MEMBER_LOAD_MODE_UNSPECIFIED
+      - ROOM_MEMBER_LOAD_MODE_NORMAL
+      - ROOM_MEMBER_LOAD_MODE_LAZY
+    default: ROOM_MEMBER_LOAD_MODE_UNSPECIFIED
+  puppetRoomMemberLoadStateRequest:
+    type: object
+    properties:
+      id:
+        type: string
+  puppetRoomMemberLoadStateResponse:
+    type: object
+    properties:
+      id:
+        type: string
+      taskId:
+        type: string
+      status:
+        $ref: '#/definitions/puppetRoomMemberLoadStatus'
+      revision:
+        type: string
+        description: Canonical non-negative decimal string; never convert to a JS number.
+      loadedAt:
+        type: string
+        format: date-time
+      error:
+        type: string
+  puppetRoomMemberLoadStatus:
+    type: string
+    enum:
+      - ROOM_MEMBER_LOAD_STATUS_UNSPECIFIED
+      - ROOM_MEMBER_LOAD_STATUS_PENDING
+      - ROOM_MEMBER_LOAD_STATUS_LOADING
+      - ROOM_MEMBER_LOAD_STATUS_LOADED
+      - ROOM_MEMBER_LOAD_STATUS_FAILED
+    default: ROOM_MEMBER_LOAD_STATUS_UNSPECIFIED
   puppetRoomMemberPayloadResponse:
     type: object
     properties:
@@ -5406,6 +5637,43 @@ definitions:
         format: double
       joinScene:
         $ref: '#/definitions/puppetRoomMemberJoinSceneType'
+  puppetRoomMemberSnapshotRequest:
+    type: object
+    properties:
+      id:
+        type: string
+      revision:
+        type: string
+      pageToken:
+        type: string
+      pageSize:
+        type: integer
+        format: int64
+        description: Zero selects the adapter default (100); maximum 500.
+  puppetRoomMemberSnapshotResponse:
+    type: object
+    properties:
+      id:
+        type: string
+      revision:
+        type: string
+      loadedAt:
+        type: string
+        format: date-time
+      members:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/puppetRoomMemberPayloadResponse'
+      nextPageToken:
+        type: string
+  puppetRoomMemberSyncRequest:
+    type: object
+    properties:
+      id:
+        type: string
+      force:
+        type: boolean
   puppetRoomOwnerTransferResponse:
     type: object
   puppetRoomParseDynamicQRCodeResponse:
@@ -5456,6 +5724,18 @@ definitions:
       createTime:
         type: string
         format: date-time
+      memberCount:
+        type: integer
+        format: int64
+      memberLoadMode:
+        $ref: '#/definitions/puppetRoomMemberLoadMode'
+      memberLoadStatus:
+        $ref: '#/definitions/puppetRoomMemberLoadStatus'
+      memberLoadRevision:
+        type: string
+      memberLoadedAt:
+        type: string
+        format: date-time
   puppetRoomPermissionResponse:
     type: object
     properties: