Files, Groups, Props, Users, NotificationV2 (#539)

* Files, Groups, Props, Users, NotificationV2

Files:
- Add `GET /agreement`
- Add `POST /agreement`
- Add `PUT /assetReview/{assetReviewId}/notes`
- Add `PUT /files/order`
Groups:
- Update `DELETE /groups/{groupId}`
  - Add missing optional query parameter
- Update `POST /groups/{groupId}/join`
  - Add missing optional query parameter
  - Add missing optional request body
- Add `GET /groups/{groupId}/auditLogTypes`
- Add `POST /groups/{groupId}/block`
- Add `PUT /groups/{groupId}/invites`
- Add `GET /groups/{groupId}/members/search`
- Add `GET /groups/{groupId}/transfer`
- Add `POST /groups/{groupId}/transfer`
- Add `DELETE /groups/{groupId}/transfer`
Props:
- Add `GET /props`
- Add `POST /props`
- Add `PUT /props/{propId}`
- Add `DELETE /props/{propId}`
- Add `GET /props/{propId}/publish`
- Add `PUT /props/{propId}/publish`
- Add `DELETE /props/{propId}/publish`
Users:
- Add `GET /users/{userId}/groups/invited`
- Add `GET /users/{userId}/groups/permissions`
- Add `GET /users/{userId}/groups/userblocked`
- Add `DELETE /users/{userId}/persist`
NotificationV2:
- Update NotificationV2Type to add `group.transfer`
- Update NotificationV2 to add data types
- Add NotificationV2DataGroupInformative
- Add NotificationV2DataGroupTransfer

* lint 1

* Update groups.yaml

* Apply suggestions from code review

Co-authored-by: Aries <me@ariesclark.com>

* lint 2

* Common search parameter, Avatar property, Config properties

* Fix path

* Describe prop spawnType and worldPlacementMask based on known examples

* duh

* Add playerPersistenceEnabled property to CreateInstanceRequest

* Fix NotificationV2 data vs. details, data for badge.earned

* Update NotificationV2ResponseType.yaml

* Add groupIds parameter to getUserAllGroupPermissions

* Update users.yaml

* Add calendarEntryId property to CreateInstanceRequest

* NotificationV2 data x-if, SentNotification details x-if, uploadImage body properties

* fix NotificationV2 details property schema reference, enumize uploadFile and File properties

* ah yes, renaming a file deletes the old one and creates a new one, very logical

* Ctrl+X Crtl+V

* Update agreement

* Lint issue

* Fix group member search response

* Fix GroupTransferability

* Fix test

* move endpoints to appropriate categories, add Permission.data properties

* local lint literally didnt catch this lmao

---------

Co-authored-by: Aries <me@ariesclark.com>
Co-authored-by: jellejurre <jelle@jilles.com>

Author: 3 people

openapi/components/parameters.yaml

@@ -21,6 +21,20 @@ adminAssetBundleId:
   schema:
     type: string
     example: aab_e159e72c-ce54-4fbe-8c37-96af02f6d18d
+assetReviewId:
+  name: assetReviewId
+  description: Must be an valid asset review ID.
+  required: true
+  in: path
+  schema:
+    type: string
+authorId:
+  name: authorId
+  description: Must be a valid user ID.
+  required: true
+  in: query
+  schema:
+    $ref: ./schemas/UserID.yaml
 avatarId:
   name: avatarId
   description: Must be a valid avatar ID.
@@ -481,6 +495,14 @@ inventoryTemplateId:
   schema:
     type: string
     example: invt_00000000-0000-0000-0000-000000000000
+isInternalVariant:
+  name: isInternalVariant
+  description: Not quite sure what this actually does (exists on the website but doesn't seem to be used)
+  required: false
+  in: query
+  schema:
+    type: boolean
+    example: false
 jamId:
   name: jamId
   description: Must be a valid query ID.

openapi/components/paths.yaml

@@ -8,12 +8,16 @@
   $ref: "./paths/economy.yaml#/paths/~1Steam~1transactions~1{transactionId}"
 "/adminassetbundles/{adminAssetBundleId}":
   $ref: "./paths/files.yaml#/paths/~1adminassetbundles~1{adminAssetBundleId}"
+/agreement:
+  $ref: "./paths/files.yaml#/paths/~1agreement"
 "/analysis/{fileId}/{versionId}":
   $ref: "./paths/files.yaml#/paths/~1analysis~1{fileId}~1{versionId}"
 "/analysis/{fileId}/{versionId}/security":
   $ref: "./paths/files.yaml#/paths/~1analysis~1{fileId}~1{versionId}~1security"
 "/analysis/{fileId}/{versionId}/standard":
   $ref: "./paths/files.yaml#/paths/~1analysis~1{fileId}~1{versionId}~1standard"
+"/assetReview/{assetReviewId}/notes":
+  $ref: "./paths/economy.yaml#/paths/~1assetReview~1{assetReviewId}~1notes"
 /auth:
   $ref: "./paths/authentication.yaml#/paths/~1auth"
 /auth/confirmEmail:
@@ -152,6 +156,8 @@
   $ref: "./paths/files.yaml#/paths/~1file~1{fileId}~1{versionId}~1{fileType}~1status"
 /files:
   $ref: "./paths/files.yaml#/paths/~1files"
+/files/order:
+  $ref: "./paths/groups.yaml#/paths/~1files~1order"
 /gallery:
   $ref: "./paths/files.yaml#/paths/~1gallery"
 /groups:
@@ -162,12 +168,16 @@
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}"
 "/groups/{groupId}/announcement":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1announcement"
+"/groups/{groupId}/auditLogTypes":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1auditLogTypes"
 "/groups/{groupId}/auditLogs":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1auditLogs"
 "/groups/{groupId}/bans":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1bans"
 "/groups/{groupId}/bans/{userId}":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1bans~1{userId}"
+"/groups/{groupId}/block":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1block"
 "/groups/{groupId}/galleries":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1galleries"
 "/groups/{groupId}/galleries/{groupGalleryId}":
@@ -188,6 +198,8 @@
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1leave"
 "/groups/{groupId}/members":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1members"
+"/groups/{groupId}/members/search":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1members~1search"
 "/groups/{groupId}/members/{userId}":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1members~1{userId}"
 "/groups/{groupId}/members/{userId}/roles/{groupRoleId}":
@@ -208,6 +220,8 @@
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1roles"
 "/groups/{groupId}/roles/{groupRoleId}":
   $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1roles~1{groupRoleId}"
+"/groups/{groupId}/transfer":
+  $ref: "./paths/groups.yaml#/paths/~1groups~1{groupId}~1transfer"
 /health:
   $ref: "./paths/miscellaneous.yaml#/paths/~1health"
 /icon:
@@ -298,8 +312,12 @@
   $ref: "./paths/prints.yaml#/paths/~1prints~1{printId}"
 "/products/{productId}":
   $ref: "./paths/economy.yaml#/paths/~1products~1{productId}"
+/props:
+  $ref: "./paths/props.yaml#/paths/~1props"
 "/props/{propId}":
   $ref: "./paths/props.yaml#/paths/~1props~1{propId}"
+"/props/{propId}/publish":
+  $ref: "./paths/props.yaml#/paths/~1props~1{propId}~1publish"
 "/requestInvite/{userId}":
   $ref: "./paths/invite.yaml#/paths/~1requestInvite~1{userId}"
 "/requestInvite/{userId}/photo":
@@ -358,10 +376,16 @@
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1feedback"
 "/users/{userId}/groups":
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups"
+"/users/{userId}/groups/invited":
+  $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1invited"
+"/users/{userId}/groups/permissions":
+  $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1permissions"
 "/users/{userId}/groups/represented":
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1represented"
 "/users/{userId}/groups/requested":
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1requested"
+"/users/{userId}/groups/userblocked":
+  $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1userblocked"
 "/users/{userId}/instances/groups":
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1instances~1groups"
 "/users/{userId}/instances/groups/{groupId}":
@@ -372,6 +396,8 @@
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1mutuals~1friends"
 "/users/{userId}/mutuals/groups":
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1mutuals~1groups"
+"/users/{userId}/persist":
+  $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1persist"
 "/users/{userId}/removeTags":
   $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1removeTags"
 "/users/{userId}/subscription/eligible":

openapi/components/paths/avatars.yaml

@@ -42,6 +42,7 @@ paths:
         - $ref: ../parameters.yaml#/maxUnityVersion
         - $ref: ../parameters.yaml#/minUnityVersion
         - $ref: ../parameters.yaml#/platform
+        - $ref: ../parameters.yaml#/isInternalVariant
       security:
         - authCookie: []
       responses:

openapi/components/paths/calendar.yaml

@@ -100,6 +100,7 @@ paths:
         - $ref: ../parameters.yaml#/utcOffset
         - $ref: ../parameters.yaml#/number
         - $ref: ../parameters.yaml#/offset
+        - $ref: ../parameters.yaml#/isInternalVariant
       security:
         - authCookie: []
       responses:

openapi/components/paths/economy.yaml

@@ -68,6 +68,27 @@ paths:
           $ref: ../responses/economy/TransactionResponse.yaml
         "401":
           $ref: ../responses/MissingCredentialsError.yaml
+  "/assetReview/{assetReviewId}/notes":
+    parameters:
+      - $ref: ../parameters.yaml#/assetReviewId
+    put:
+      operationId: updateAssetReviewNotes
+      summary: Update Asset Review Notes
+      description: Update notes regarding an asset review.
+      tags:
+        - files
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: ../requests/UpdateAssetReviewNotesRequest.yaml
+      security:
+        - authCookie: []
+      responses:
+        "200":
+          description: The asset review notes are submitted.
+        "401":
+          $ref: ../responses/MissingCredentialsError.yaml
   /auth/user/subscription:
     get:
       operationId: getCurrentSubscriptions

openapi/components/paths/files.yaml

@@ -18,6 +18,59 @@ paths:
       responses:
         "200":
           $ref: ../responses/files/AdminAssetBundleResponse.yaml
+  /agreement:
+    get:
+      operationId: getContentAgreementStatus
+      summary: Get Content Agreement Status
+      description: Returns the agreement status of the currently authenticated user for the given agreementCode, contentId, and version.
+      tags:
+        - files
+      parameters:
+        - name: agreementCode
+          description: The type of agreement (currently content.copyright.owned)
+          required: true
+          in: query
+          schema:
+            $ref: ../schemas/AgreementCode.yaml
+        - name: contentId
+          description: The id of the content being uploaded, such as a WorldID, AvatarID, or PropID
+          required: true
+          in: query
+          schema:
+            type: string
+            example: avtr_c38a1615-5bf5-42b4-84eb-a8b6c37cbd11
+        - name: version
+          description: The version of the agreement (currently 1)
+          required: true
+          in: query
+          schema:
+            type: integer
+            example: 1
+      security:
+        - authCookie: []
+      responses:
+        "200":
+          $ref: ../responses/files/AgreementStatusResponse.yaml
+        "401":
+          $ref: ../responses/MissingCredentialsError.yaml
+    post:
+      operationId: submitContentAgreement
+      summary: Submit Content Agreement
+      description: Returns the agreement of the currently authenticated user for the given agreementCode, contentId, and version.
+      tags:
+        - files
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: ../requests/AgreementRequest.yaml
+      security:
+        - authCookie: []
+      responses:
+        "200":
+          $ref: ../responses/files/AgreementResponse.yaml
+        "401":
+          $ref: ../responses/MissingCredentialsError.yaml
   "/analysis/{fileId}/{versionId}":
     parameters:
       - $ref: ../parameters.yaml#/fileId
@@ -106,26 +159,27 @@ paths:
               type: object
               properties:
                 animationStyle:
-                  type: string
-                  description: Animation style for sticker, required for emoji.
-                  example: bats
+                  $ref: ../schemas/ImageAnimationStyle.yaml
                 file:
                   type: string
                   description: The binary blob of the png file.
                   format: binary
                 frames:
                   type: integer
-                  description: Required for emojianimated. Total number of frames to be animated (2-64)
+                  description: Required for animated images. Total number of frames of the spritesheet to be animated.
+                  maximum: 64
+                  minimum: 2
                 framesOverTime:
                   type: integer
-                  description: Required for emojianimated. Animation frames per second (1-64)
+                  description: Required for animated images. Animation frames per second.
+                  maximum: 64
+                  minimum: 1
+                loopStyle:
+                  $ref: ../schemas/ImageLoopStyle.yaml
                 maskTag:
-                  type: string
-                  description: Mask of the sticker, optional for emoji.
-                  example: square
+                  $ref: ../schemas/ImageMask.yaml
                 tag:
-                  type: string
-                  description: Needs to be either icon, gallery, sticker, emoji, or emojianimated
+                  $ref: ../schemas/ImagePurpose.yaml
               required:
                 - file
                 - tag