Inventory sharing and various Economy endpoints

openapi/components/parameters.yaml

@@ -558,11 +558,62 @@ inventorySpawnItemId:
   schema:
     $ref: ./schemas/InventoryItemID.yaml
   description: Id for inventory item spawning.
+inventoryPedestalItemId:
+  name: itemId
+  in: query
+  required: true
+  schema:
+    $ref: ./schemas/InventoryItemID.yaml
+  description: Id for inventory item sharing.
+inventoryPedestalDuration:
+  name: duration
+  in: query
+  required: true
+  schema:
+    type: integer
+    minimum: 30
+    maximum: 86400
+    default: 90
+  description: The duration before the sharing pedestal despawns.
 calendarSearchTerm:
   name: searchTerm
   in: query
   required: true
   schema:
     type: string
     example: game night
-  description: Search term for calendar events.
+  description: Search term for calendar events.
+steamId:
+  name: steamId
+  in: query
+  required: false
+  schema:
+    type: string
+    example: game night
+  description: The Steam ID of the user.
+hydrateListings:
+  name: hydrateListings
+  in: query
+  required: false
+  schema:
+    type: boolean
+  description: Listings fields will be populated.
+hydrateProducts:
+  name: hydrateProducts
+  in: query
+  required: false
+  schema:
+    type: boolean
+  description: Products fields will be populated.
+storeId:
+  name: storeId
+  in: query
+  required: true
+  schema:
+    $ref: ./schemas/StoreID.yaml
+storeView:
+  name: fetch
+  in: query
+  required: false
+  schema:
+    $ref: ./schemas/StoreView.yaml

openapi/components/paths.yaml

@@ -97,6 +97,8 @@
   $ref: "./paths/economy.yaml#/paths/~1Admin~1transactions~1{transactionId}"
 '/auth/user/subscription':
   $ref: "./paths/economy.yaml#/paths/~1auth~1user~1subscription"
+'/users/{userId}/subscription/eligible':
+  $ref: "./paths/economy.yaml#/paths/~1users~1{userId}~1subscription~1eligible"
 '/subscriptions':
   $ref: "./paths/economy.yaml#/paths/~1subscriptions"
 '/licenseGroups/{licenseGroupId}':
@@ -113,6 +115,16 @@
   $ref: "./paths/economy.yaml#/paths/~1user~1{userId}~1tilia~1tos"
 '/user/{userId}/balance':
   $ref: "./paths/economy.yaml#/paths/~1user~1{userId}~1balance"
+'/user/{userId}/balance/earnings':
+  $ref: "./paths/economy.yaml#/paths/~1user~1{userId}~1balance~1earnings"
+'/user/{userId}/economy/account':
+  $ref: "./paths/economy.yaml#/paths/~1user~1{userId}~1economy~1account"
+'/economy/licenses/active':
+  $ref: "./paths/economy.yaml#/paths/~1economy~1licenses~1active"
+'/economy/store':
+  $ref: "./paths/economy.yaml#/paths/~1economy~1store"
+'/economy/store/shelves':
+  $ref: "./paths/economy.yaml#/paths/~1economy~1store~1shelves"
 
 # favorites
 
@@ -238,6 +250,11 @@
   $ref: "./paths/inventory.yaml#/paths/~1inventory~1template~1{inventoryTemplateId}"
 "/inventory/spawn":
   $ref: "./paths/inventory.yaml#/paths/~1inventory~1spawn"
+"/inventory/cloning/pedestal":
+  $ref: "./paths/inventory.yaml#/paths/~1inventory~1cloning~1pedestal"
+"/inventory/cloning/direct":
+  $ref: "./paths/inventory.yaml#/paths/~1inventory~1cloning~1direct"
+
 
 # invite
 

openapi/components/paths/economy.yaml

@@ -82,6 +82,23 @@ paths:
       tags:
         - economy
       description: Get a list of all current user subscriptions.
+  '/users/{userId}/subscription/eligible':
+    parameters:
+      - $ref: ../parameters.yaml#/userId
+      - $ref: ../parameters.yaml#/steamId
+    get:
+      summary: Get User Subscription Eligiblity
+      operationId: getUserSubscriptionEligible
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/UserSubscriptionEligibleResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: Get the user's eligibility status for subscriptions.
   /subscriptions:
     get:
       summary: List Subscriptions
@@ -210,6 +227,88 @@ paths:
       tags:
         - economy
       description: 'Gets the balance of a user'
+  '/user/{userId}/balance/earnings':
+    parameters:
+      - $ref: ../parameters.yaml#/userId
+    get:
+      summary: Get Balance Earnings
+      operationId: getBalanceEarnings
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/BalanceResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: 'Gets the balance of a user from earnings'
+  '/user/{userId}/economy/account':
+    parameters:
+      - $ref: ../parameters.yaml#/userId
+    get:
+      summary: Get Economy Account
+      operationId: getEconomyAccount
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/EconomyAccountResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: 'Gets the economy account of a user'
+  '/economy/licenses/active':
+    get:
+      summary: Get Active Licenses
+      operationId: getActiveLicenses
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/LicenseListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: 'Gets active licenses'
+  '/economy/store':
+    parameters:
+      - $ref: ../parameters.yaml#/storeId
+      - $ref: ../parameters.yaml#/hydrateListings
+      - $ref: ../parameters.yaml#/hydrateProducts
+    get:
+      summary: Get Store
+      operationId: getStore
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/StoreResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: Gets a store
+  '/economy/store/shelves':
+    parameters:
+      - $ref: ../parameters.yaml#/storeId
+      - $ref: ../parameters.yaml#/hydrateListings
+      - $ref: ../parameters.yaml#/storeView
+    get:
+      summary: Get Store Shelves
+      operationId: getStoreShelves
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/economy/StoreShelfListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - economy
+      description: Gets the shelves for a store
 tags:
   $ref: ../tags.yaml
 components:

openapi/components/paths/inventory.yaml

@@ -104,6 +104,46 @@ paths:
       tags:
         - inventory
       description: Returns an InventorySpawn object.
+  '/inventory/cloning/pedestal':
+    parameters:
+      - $ref: ../parameters.yaml#/inventoryPedestalItemId
+      - $ref: ../parameters.yaml#/inventoryPedestalDuration
+    get:
+      summary: Share Inventory Item by Pedestal
+      operationId: shareInventoryItemPedestal
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/inventory/InventorySpawnResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - inventory
+      description: Returns an InventorySpawn object.
+  '/inventory/cloning/direct':
+    parameters:
+      - $ref: ../parameters.yaml#/inventoryPedestalItemId
+      - $ref: ../parameters.yaml#/inventoryPedestalDuration
+    post:
+      summary: Share Inventory Item Direct
+      operationId: shareInventoryItemDirect
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: ../requests/ShareInventoryItemDirectRequest.yaml
+      security:
+        - authCookie: []
+      responses:
+        '200':
+          $ref: ../responses/inventory/InventoryShareResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+      tags:
+        - inventory
+      description: Share content directly with other users.
 tags:
   $ref: ../tags.yaml
 components:

openapi/components/requests/ShareInventoryItemDirectRequest.yaml

@@ -0,0 +1,12 @@
+title: ShareInventoryItemDirectRequest
+type: object
+properties:
+  itemId:
+    $ref: ../schemas/InventoryItemID.yaml
+  users:
+    type: array
+    items:
+      $ref: ../schemas/UserID.yaml
+required:
+  - itemId
+  - users

openapi/components/responses/economy/EconomyAccountResponse.yaml

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

openapi/components/responses/economy/LicenseListResponse.yaml

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

openapi/components/responses/economy/StoreResponse.yaml

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

openapi/components/responses/economy/StoreShelfListResponse.yaml

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

openapi/components/responses/economy/UserSubscriptionEligibleResponse.yaml

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

openapi/components/responses/inventory/InventoryShareResponse.yaml

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

openapi/components/schemas/EconomyAccount.yaml

@@ -0,0 +1,25 @@
+title: EconomyAccount
+type: object
+properties:
+  accountActivatedOn:
+    type: string
+    format: date-time
+    nullable: true
+  accountId:
+    type: string
+    nullable: true
+  blocked:
+    type: boolean
+  canSpend:
+    type: boolean
+  source:
+    type: string
+  userId:
+    $ref: ./UserID.yaml
+required:
+  - accountActivatedOn
+  - accountId
+  - blocked
+  - canSpend
+  - source
+  - userId

openapi/components/schemas/OkStatus.yaml

@@ -0,0 +1,10 @@
+title: OkStatus
+type: object
+description: A status response consisting of solely a string description of whether the result of an operation was ok.
+properties:
+  ok:
+    type: string
+    default: "maybe?"
+    description: The actual status itself
+required:
+  - ok