feature: add Subscription/Transaction/License API

openapi/components/parameters.yaml

@@ -267,6 +267,18 @@ permissionId:
   required: true
   schema:
     type: string
+transactionId:
+  name: transactionId
+  in: path
+  required: true
+  schema:
+    type: string
+licenseGroupId:
+  name: licenseGroupId
+  in: path
+  required: true
+  schema:
+    type: string
 variant:
   name: variant
   in: query

openapi/components/paths.yaml

@@ -32,6 +32,25 @@
 "/avatars/favorites":
   $ref: "./paths/avatars.yaml#/paths/~1avatars~1favorites"
 
+# economy
+
+'/Steam/transactions':
+  $ref: "./paths/economy.yaml#/paths/~1Steam~1transactions"
+'/Steam/transactions/{transactionId}':
+  $ref: "./paths/economy.yaml#/paths/~1Steam~1transactions~1{transactionId}"
+'/Admin/transactions':
+  $ref: "./paths/economy.yaml#/paths/~1Admin~1transactions"
+'/Admin/transactions/{transactionId}':
+  $ref: "./paths/economy.yaml#/paths/~1Admin~1transactions~1{transactionId}"
+'/auth/user/subscription':
+  $ref: "./paths/economy.yaml#/paths/~1auth~1user~1subscription"
+'/subscriptions':
+  $ref: "./paths/economy.yaml#/paths/~1subscriptions"
+'/licenseGroups':
+  $ref: "./paths/economy.yaml#/paths/~1licenseGroups"
+'/licenseGroups/{licenseGroupId}':
+  $ref: "./paths/economy.yaml#/paths/~1licenseGroups~1{licenseGroupId}"
+
 # favorites
 
 "/favorites":

openapi/components/paths/economy.yaml

@@ -0,0 +1,145 @@
+openapi: 3.0.3
+info:
+  title: economy
+  version: '1.0'
+  description: Economy Docs Here
+paths:
+  /Steam/transactions:
+    get:
+      summary: List Steam Transactions
+      operationId: getSteamTransactions
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/TransactionListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: Get all own Steam transactions.
+  '/Steam/transactions/{transactionId}':
+    parameters:
+      - $ref: ../parameters.yaml#/transactionId
+    get:
+      summary: Get Steam Transaction
+      operationId: getSteamTransaction
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/TransactionResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: 'Get a single Steam transactions by ID owned by you. This returns the exact same information as `getSteamTransactions`, so no point in using this function.'
+      deprecated: true
+  /Admin/transactions:
+    get:
+      summary: Get Admin Transactions
+      operationId: getAdminTransactions
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/TransactionListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: Get all own Admin transactions.
+      x-internal: true
+  '/Admin/transactions/{transactionId}':
+    parameters:
+      - $ref: ../parameters.yaml#/transactionId
+    get:
+      summary: Get Admin Transactions
+      operationId: getAdminTransaction
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/TransactionResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: 'Get a single Admin transactions by ID owned by you. This returns the exact same information as `getAdminTransactions`, so no point in using this function.'
+      deprecated: true
+      x-internal: true
+  /auth/user/subscription:
+    get:
+      summary: Get Current Subscriptions
+      operationId: getCurrentSubscriptions
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/UserSubscriptionListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: Get a list of all current user subscriptions.
+  /subscriptions:
+    get:
+      summary: List Subscriptions
+      operationId: getSubscriptions
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/SubscriptionListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: 'List all existing Subscriptions. For example, "vrchatplus-monthly" and "vrchatplus-yearly".'
+  /licenseGroups:
+    get:
+      summary: List License Groups
+      operationId: getLicenseGroups
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/LicenseGroupListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: |-
+        List all existing license groups.
+
+        **IMPLEMENTATION WARNING:** This endpoint currently return a text/plain array of seven nulls.
+      x-internal: true
+  '/licenseGroups/{licenseGroupId}':
+    parameters:
+      - $ref: ../parameters.yaml#/licenseGroupId
+    get:
+      summary: Get License Group
+      operationId: getLicenseGroup
+      security:
+        - apiKeyCookie: []
+          authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/LicenseGroupResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: Get a single License Group by given ID.
+tags:
+  $ref: ../tags.yaml
+components:
+  securitySchemes:
+    $ref: ../securitySchemes.yaml

openapi/components/paths/invite.yaml

@@ -118,7 +118,7 @@ paths:
       tags:
         - invite
       description: |-
-        Resets a single Invite Message back to it's original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users!
+        Resets a single Invite Message back to its original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users!
 
         Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown.
         Resetting it does however not set the rate-limit to 60 like when editing it.

openapi/components/paths/system.yaml

@@ -40,15 +40,7 @@ paths:
         - system
       responses:
         '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                type: integer
-                description: Number of online users
-                example: 12345
-                minimum: 0
-                readOnly: true
+          $ref: ../responses/system/CurrentOnlineUsersResponse.yaml
       operationId: getCurrentOnlineUsers
       security: []
       description: |-
@@ -62,14 +54,7 @@ paths:
         - system
       responses:
         '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                type: string
-                format: date-time
-                example: '2021-08-20T12:38:42+00:00'
-                description: Does not return millisecond precision. Always returns time in UTC.
+          $ref: ../responses/system/SystemTimeResponse.yaml
       operationId: getSystemTime
       description: |-
         Returns the current time of the API server.

openapi/components/responses/economy/LicenseGroupListResponse.yaml

@@ -0,0 +1,7 @@
+description: Returns a list of LicenseGroup objects.
+content:
+  application/json:
+    schema:
+      type: array
+      items:
+        $ref: ../../schemas/LicenseGroup.yaml

openapi/components/responses/economy/LicenseGroupResponse.yaml

@@ -0,0 +1,5 @@
+description: Returns a single LicenseGroup object.
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/LicenseGroup.yaml

openapi/components/responses/economy/SubscriptionListResponse.yaml

@@ -0,0 +1,7 @@
+description: Returns a list of Subscription objects.
+content:
+  application/json:
+    schema:
+      type: array
+      items:
+        $ref: ../../schemas/Subscription.yaml

openapi/components/responses/economy/TransactionListResponse.yaml

@@ -0,0 +1,7 @@
+description: Returns a list of Transaction objects.
+content:
+  application/json:
+    schema:
+      type: array
+      items:
+        $ref: ../../schemas/Transaction.yaml

openapi/components/responses/economy/TransactionResponse.yaml

@@ -0,0 +1,5 @@
+description: Returns a single Transaction object.
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/Transaction.yaml

openapi/components/responses/economy/UserSubscriptionListResponse.yaml

@@ -0,0 +1,7 @@
+description: Returns a list of UserSubscription objects.
+content:
+  application/json:
+    schema:
+      type: array
+      items:
+        $ref: ../../schemas/UserSubscription.yaml

openapi/components/responses/invite/InviteMessageNoEntryForSlotError.yaml

@@ -2,12 +2,7 @@ description: Error response when trying to reset an Invite Message whos slot doe
 content:
   application/json:
     schema:
-      type: object
-      properties:
-        error:
-          $ref: ../../schemas/Error.yaml
-      required:
-        - error
+      $ref: ../../schemas/Error.yaml
     examples:
       404 No Custom Invite Message In Slot:
         value:

openapi/components/responses/system/CurrentOnlineUsersResponse.yaml

@@ -0,0 +1,8 @@
+description: OK
+content:
+  application/json:
+    schema:
+      type: integer
+      description: Number of online users
+      example: 12345
+      minimum: 0

openapi/components/responses/system/SystemTimeResponse.yaml

@@ -0,0 +1,8 @@
+description: OK
+content:
+  application/json:
+    schema:
+      type: string
+      format: date-time
+      example: '2021-08-20T12:38:42+00:00'
+      description: Does not return millisecond precision. Always returns time in UTC.

openapi/components/schemas/License.yaml

@@ -0,0 +1,20 @@
+title: License
+type: object
+properties:
+  forId:
+    type: string
+    description: 'Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field.'
+    minLength: 1
+    pattern: '(avtr|lgrp|prms|prod)_[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}'
+  forType:
+    $ref: ./LicenseType.yaml
+  forName:
+    type: string
+    minLength: 1
+  forAction:
+    $ref: ./LicenseAction.yaml
+required:
+  - forId
+  - forType
+  - forName
+  - forAction

openapi/components/schemas/LicenseAction.yaml

@@ -0,0 +1,7 @@
+type: string
+title: LicenseAction
+default: have
+enum:
+  - wear
+  - have
+example: have