From f121a5f4562b0eb0fe57bf6a5e365a2c41ce3581 Mon Sep 17 00:00:00 2001 From: Cameron Campbell Date: Fri, 17 May 2024 02:32:00 +0100 Subject: [PATCH] updated action --- docs_site/pages/_app.js | 6 --- docs_site/pages/_meta.json | 10 ---- docs_site/pages/classic/_meta.json | 11 ---- docs_site/pages/classic/friends/_meta.json | 10 ---- .../authenticatedUserFriendRequests.md | 24 --------- .../authenticatedUserFriendRequestsCount.md | 16 ------ .../friends/authenticatedUserFriendsCount.md | 16 ------ .../pages/classic/friends/findFriends.md | 25 --------- .../pages/classic/friends/friendsCount.md | 22 -------- .../pages/classic/friends/friendsList.md | 23 -------- .../pages/classic/friends/friendsMetadata.md | 16 ------ .../classic/friends/userfollowersCount.md | 22 -------- docs_site/pages/classic/games/_meta.json | 4 -- docs_site/pages/classic/games/gamesInfo.md | 25 --------- docs_site/pages/classic/games/userGames.md | 25 --------- docs_site/pages/classic/groups/_meta.json | 54 ------------------- .../classic/groups/acceptGroupJoinRequest.md | 23 -------- .../groups/acceptGroupRelationshipRequest.md | 28 ---------- .../classic/groups/addGroupSocialLink.md | 30 ----------- .../classic/groups/allGroupRolesForUser_V1.md | 22 -------- .../authenticatedUserGroupMembershipInfo.md | 22 -------- .../groups/authenticatedUserPendingGroups.md | 16 ------ ...rSubscribeToGroupWallNotificationEvents.md | 22 -------- .../groups/batchAcceptGroupJoinRequests.md | 26 --------- .../batchAcceptGroupRelationshipRequests.md | 28 ---------- .../groups/batchDeclineGroupJoinRequests.md | 26 --------- .../batchDeclineGroupRelationshipRequests.md | 28 ---------- .../classic/groups/declineGroupJoinRequest.md | 23 -------- .../groups/declineGroupRelationshipRequest.md | 28 ---------- .../pages/classic/groups/groupAuditLog.md | 27 ---------- .../groups/groupGuestRolePermissions.md | 22 -------- docs_site/pages/classic/groups/groupInfo.md | 22 -------- .../classic/groups/groupJoinRequestInfo.md | 23 -------- .../pages/classic/groups/groupJoinRequests.md | 25 --------- .../pages/classic/groups/groupLookupSearch.md | 22 -------- .../pages/classic/groups/groupMembers.md | 25 --------- .../classic/groups/groupMembersWithRole.md | 29 ---------- .../pages/classic/groups/groupNameHistory.md | 25 --------- .../groups/groupPayoutRestrictionsInfo.md | 22 -------- .../pages/classic/groups/groupPayoutsInfo.md | 22 -------- .../groups/groupPermissionsForAllRoles.md | 22 -------- .../classic/groups/groupPermissionsForRole.md | 23 -------- .../groups/groupRelationshipRequests.md | 29 ---------- .../classic/groups/groupRelationships.md | 29 ---------- docs_site/pages/classic/groups/groupRoles.md | 22 -------- .../pages/classic/groups/groupRolesFromIds.md | 22 -------- docs_site/pages/classic/groups/groupSearch.md | 28 ---------- .../classic/groups/groupSearchMetadata.md | 16 ------ .../pages/classic/groups/groupSettings.md | 22 -------- .../pages/classic/groups/groupSocialLinks.md | 22 -------- .../pages/classic/groups/groupWallPosts_V1.md | 25 --------- .../classic/groups/groupsConfigMetadata.md | 16 ------ .../pages/classic/groups/groupsMetadata.md | 16 ------ .../pages/classic/groups/groupsPolicyInfo.md | 22 -------- .../groups/groupsThatUsersFriendsAreIn.md | 22 -------- .../removeAllGroupWallPostMadeByUser.md | 26 --------- .../pages/classic/groups/removeGroupMember.md | 23 -------- .../classic/groups/removeGroupRelationship.md | 28 ---------- .../classic/groups/removeGroupSocialLink.md | 23 -------- .../classic/groups/removeGroupWallPost.md | 23 -------- .../groups/requestGroupRelationship.md | 28 ---------- .../classic/groups/setGroupDescription.md | 26 --------- .../pages/classic/groups/setGroupIcon.md | 23 -------- .../classic/groups/setGroupRolePermissions.md | 28 ---------- .../pages/classic/groups/setGroupSettings.md | 33 ------------ .../pages/classic/groups/setGroupShout.md | 23 -------- .../classic/groups/updateGroupMemberRole.md | 28 ---------- .../classic/groups/updateGroupSocialLink.md | 31 ----------- .../pages/classic/premiumFeatures/_meta.json | 3 -- .../classic/premiumFeatures/userHasPremium.md | 22 -------- .../pages/classic/subscriptions/_meta.json | 8 --- ...UserSubscriptionsPermissionsForUniverse.md | 24 --------- .../subscriptions/createSubscription.md | 32 ----------- .../subscriptions/setSubscriptionIcon.md | 27 ---------- .../classic/subscriptions/subscriptionInfo.md | 26 --------- .../subscriptions/subscriptionsForUniverse.md | 24 --------- .../subscriptionsPriceTiersForUniverse.md | 22 -------- docs_site/pages/classic/talent/_meta.json | 6 --- .../classic/talent/creatorExperiences.md | 25 --------- .../classic/talent/creatorIsIdVerified.md | 22 -------- .../pages/classic/talent/creatorProfile.md | 22 -------- docs_site/pages/classic/talent/jobSearch.md | 25 --------- docs_site/pages/classic/thumbnails/_meta.json | 4 -- .../pages/classic/thumbnails/gamesIcons.md | 15 ------ .../classic/thumbnails/gamesThumbnails.md | 27 ---------- docs_site/pages/classic/universes/_meta.json | 3 -- .../universes/universeIdFromPlaceId.md | 22 -------- docs_site/pages/classic/users/_meta.json | 17 ------ .../users/authenticatedUserAgeBracket.md | 16 ------ .../users/authenticatedUserBirthdate.md | 16 ------ .../users/authenticatedUserCountryCode.md | 16 ------ .../users/authenticatedUserDescription.md | 16 ------ .../classic/users/authenticatedUserGender.md | 16 ------ .../classic/users/authenticatedUserInfo.md | 16 ------ .../classic/users/authenticatedUserRoles.md | 16 ------ .../users/authenticatedUserSetDisplayName.md | 26 --------- .../pages/classic/users/userIdsToUsersInfo.md | 23 -------- docs_site/pages/classic/users/userInfo.md | 22 -------- docs_site/pages/classic/users/userSearch.md | 24 --------- .../pages/classic/users/usernameHistory.md | 25 --------- .../classic/users/usernamesToUsersInfo.md | 23 -------- .../validateDisplayNameForExistingUser.md | 26 --------- .../users/validateDisplayNameForNewUser.md | 26 --------- docs_site/pages/cloud/_meta.json | 10 ---- docs_site/pages/cloud/creatorStore/_meta.json | 5 -- .../creatorStore/createCreatorStoreProduct.md | 24 --------- .../creatorStore/creatorStoreProductInfo.md | 27 ---------- .../creatorStore/updateCreatorStoreProduct.md | 15 ------ docs_site/pages/cloud/experiences/_meta.json | 7 --- .../pages/cloud/experiences/placeInfo.md | 23 -------- .../experiences/restartUniverseServers.md | 22 -------- .../pages/cloud/experiences/universeInfo.md | 22 -------- .../pages/cloud/experiences/updatePlace.md | 28 ---------- .../pages/cloud/experiences/updateUniverse.md | 26 --------- docs_site/pages/cloud/groups/_meta.json | 7 --- docs_site/pages/cloud/groups/groupInfo.md | 22 -------- .../pages/cloud/groups/groupJoinRequests.md | 25 --------- docs_site/pages/cloud/groups/groupMembers.md | 25 --------- docs_site/pages/cloud/groups/groupRoles.md | 24 --------- docs_site/pages/cloud/groups/groupShout.md | 24 --------- docs_site/pages/cloud/inventory/_meta.json | 3 -- .../cloud/inventory/inventoryItemsForUser.md | 28 ---------- docs_site/pages/cloud/memoryStore/_meta.json | 12 ----- .../cloud/memoryStore/createSortedMapItem.md | 29 ---------- .../cloud/memoryStore/deleteSortedMapItem.md | 25 --------- .../pages/cloud/memoryStore/dequeueItems.md | 28 ---------- .../pages/cloud/memoryStore/enqueueItem.md | 25 --------- .../pages/cloud/memoryStore/flushAllQueues.md | 22 -------- .../cloud/memoryStore/listSortedMapItems.md | 30 ----------- .../cloud/memoryStore/operationStatus.md | 25 --------- .../pages/cloud/memoryStore/readQueueItems.md | 30 ----------- .../pages/cloud/memoryStore/sortedMapItem.md | 29 ---------- .../cloud/memoryStore/updateSortedMapItem.md | 32 ----------- docs_site/pages/cloud/messaging/_meta.json | 3 -- .../pages/cloud/messaging/publishMessage.md | 36 ------------- .../pages/cloud/subscriptions/_meta.json | 3 -- .../cloud/subscriptions/subscriptionInfo.md | 23 -------- docs_site/pages/cloud/users/_meta.json | 5 -- .../cloud/users/sendNotificationToUser.md | 33 ------------ docs_site/pages/cloud/users/userInfo.md | 22 -------- docs_site/pages/cloud/users/userThumbnail.md | 25 --------- docs_site/pages/styles.css | 6 --- 142 files changed, 3067 deletions(-) delete mode 100644 docs_site/pages/_app.js delete mode 100644 docs_site/pages/_meta.json delete mode 100644 docs_site/pages/classic/_meta.json delete mode 100644 docs_site/pages/classic/friends/_meta.json delete mode 100644 docs_site/pages/classic/friends/authenticatedUserFriendRequests.md delete mode 100644 docs_site/pages/classic/friends/authenticatedUserFriendRequestsCount.md delete mode 100644 docs_site/pages/classic/friends/authenticatedUserFriendsCount.md delete mode 100644 docs_site/pages/classic/friends/findFriends.md delete mode 100644 docs_site/pages/classic/friends/friendsCount.md delete mode 100644 docs_site/pages/classic/friends/friendsList.md delete mode 100644 docs_site/pages/classic/friends/friendsMetadata.md delete mode 100644 docs_site/pages/classic/friends/userfollowersCount.md delete mode 100644 docs_site/pages/classic/games/_meta.json delete mode 100644 docs_site/pages/classic/games/gamesInfo.md delete mode 100644 docs_site/pages/classic/games/userGames.md delete mode 100644 docs_site/pages/classic/groups/_meta.json delete mode 100644 docs_site/pages/classic/groups/acceptGroupJoinRequest.md delete mode 100644 docs_site/pages/classic/groups/acceptGroupRelationshipRequest.md delete mode 100644 docs_site/pages/classic/groups/addGroupSocialLink.md delete mode 100644 docs_site/pages/classic/groups/allGroupRolesForUser_V1.md delete mode 100644 docs_site/pages/classic/groups/authenticatedUserGroupMembershipInfo.md delete mode 100644 docs_site/pages/classic/groups/authenticatedUserPendingGroups.md delete mode 100644 docs_site/pages/classic/groups/authenticatedUserSubscribeToGroupWallNotificationEvents.md delete mode 100644 docs_site/pages/classic/groups/batchAcceptGroupJoinRequests.md delete mode 100644 docs_site/pages/classic/groups/batchAcceptGroupRelationshipRequests.md delete mode 100644 docs_site/pages/classic/groups/batchDeclineGroupJoinRequests.md delete mode 100644 docs_site/pages/classic/groups/batchDeclineGroupRelationshipRequests.md delete mode 100644 docs_site/pages/classic/groups/declineGroupJoinRequest.md delete mode 100644 docs_site/pages/classic/groups/declineGroupRelationshipRequest.md delete mode 100644 docs_site/pages/classic/groups/groupAuditLog.md delete mode 100644 docs_site/pages/classic/groups/groupGuestRolePermissions.md delete mode 100644 docs_site/pages/classic/groups/groupInfo.md delete mode 100644 docs_site/pages/classic/groups/groupJoinRequestInfo.md delete mode 100644 docs_site/pages/classic/groups/groupJoinRequests.md delete mode 100644 docs_site/pages/classic/groups/groupLookupSearch.md delete mode 100644 docs_site/pages/classic/groups/groupMembers.md delete mode 100644 docs_site/pages/classic/groups/groupMembersWithRole.md delete mode 100644 docs_site/pages/classic/groups/groupNameHistory.md delete mode 100644 docs_site/pages/classic/groups/groupPayoutRestrictionsInfo.md delete mode 100644 docs_site/pages/classic/groups/groupPayoutsInfo.md delete mode 100644 docs_site/pages/classic/groups/groupPermissionsForAllRoles.md delete mode 100644 docs_site/pages/classic/groups/groupPermissionsForRole.md delete mode 100644 docs_site/pages/classic/groups/groupRelationshipRequests.md delete mode 100644 docs_site/pages/classic/groups/groupRelationships.md delete mode 100644 docs_site/pages/classic/groups/groupRoles.md delete mode 100644 docs_site/pages/classic/groups/groupRolesFromIds.md delete mode 100644 docs_site/pages/classic/groups/groupSearch.md delete mode 100644 docs_site/pages/classic/groups/groupSearchMetadata.md delete mode 100644 docs_site/pages/classic/groups/groupSettings.md delete mode 100644 docs_site/pages/classic/groups/groupSocialLinks.md delete mode 100644 docs_site/pages/classic/groups/groupWallPosts_V1.md delete mode 100644 docs_site/pages/classic/groups/groupsConfigMetadata.md delete mode 100644 docs_site/pages/classic/groups/groupsMetadata.md delete mode 100644 docs_site/pages/classic/groups/groupsPolicyInfo.md delete mode 100644 docs_site/pages/classic/groups/groupsThatUsersFriendsAreIn.md delete mode 100644 docs_site/pages/classic/groups/removeAllGroupWallPostMadeByUser.md delete mode 100644 docs_site/pages/classic/groups/removeGroupMember.md delete mode 100644 docs_site/pages/classic/groups/removeGroupRelationship.md delete mode 100644 docs_site/pages/classic/groups/removeGroupSocialLink.md delete mode 100644 docs_site/pages/classic/groups/removeGroupWallPost.md delete mode 100644 docs_site/pages/classic/groups/requestGroupRelationship.md delete mode 100644 docs_site/pages/classic/groups/setGroupDescription.md delete mode 100644 docs_site/pages/classic/groups/setGroupIcon.md delete mode 100644 docs_site/pages/classic/groups/setGroupRolePermissions.md delete mode 100644 docs_site/pages/classic/groups/setGroupSettings.md delete mode 100644 docs_site/pages/classic/groups/setGroupShout.md delete mode 100644 docs_site/pages/classic/groups/updateGroupMemberRole.md delete mode 100644 docs_site/pages/classic/groups/updateGroupSocialLink.md delete mode 100644 docs_site/pages/classic/premiumFeatures/_meta.json delete mode 100644 docs_site/pages/classic/premiumFeatures/userHasPremium.md delete mode 100644 docs_site/pages/classic/subscriptions/_meta.json delete mode 100644 docs_site/pages/classic/subscriptions/authenticatedUserSubscriptionsPermissionsForUniverse.md delete mode 100644 docs_site/pages/classic/subscriptions/createSubscription.md delete mode 100644 docs_site/pages/classic/subscriptions/setSubscriptionIcon.md delete mode 100644 docs_site/pages/classic/subscriptions/subscriptionInfo.md delete mode 100644 docs_site/pages/classic/subscriptions/subscriptionsForUniverse.md delete mode 100644 docs_site/pages/classic/subscriptions/subscriptionsPriceTiersForUniverse.md delete mode 100644 docs_site/pages/classic/talent/_meta.json delete mode 100644 docs_site/pages/classic/talent/creatorExperiences.md delete mode 100644 docs_site/pages/classic/talent/creatorIsIdVerified.md delete mode 100644 docs_site/pages/classic/talent/creatorProfile.md delete mode 100644 docs_site/pages/classic/talent/jobSearch.md delete mode 100644 docs_site/pages/classic/thumbnails/_meta.json delete mode 100644 docs_site/pages/classic/thumbnails/gamesIcons.md delete mode 100644 docs_site/pages/classic/thumbnails/gamesThumbnails.md delete mode 100644 docs_site/pages/classic/universes/_meta.json delete mode 100644 docs_site/pages/classic/universes/universeIdFromPlaceId.md delete mode 100644 docs_site/pages/classic/users/_meta.json delete mode 100644 docs_site/pages/classic/users/authenticatedUserAgeBracket.md delete mode 100644 docs_site/pages/classic/users/authenticatedUserBirthdate.md delete mode 100644 docs_site/pages/classic/users/authenticatedUserCountryCode.md delete mode 100644 docs_site/pages/classic/users/authenticatedUserDescription.md delete mode 100644 docs_site/pages/classic/users/authenticatedUserGender.md delete mode 100644 docs_site/pages/classic/users/authenticatedUserInfo.md delete mode 100644 docs_site/pages/classic/users/authenticatedUserRoles.md delete mode 100644 docs_site/pages/classic/users/authenticatedUserSetDisplayName.md delete mode 100644 docs_site/pages/classic/users/userIdsToUsersInfo.md delete mode 100644 docs_site/pages/classic/users/userInfo.md delete mode 100644 docs_site/pages/classic/users/userSearch.md delete mode 100644 docs_site/pages/classic/users/usernameHistory.md delete mode 100644 docs_site/pages/classic/users/usernamesToUsersInfo.md delete mode 100644 docs_site/pages/classic/users/validateDisplayNameForExistingUser.md delete mode 100644 docs_site/pages/classic/users/validateDisplayNameForNewUser.md delete mode 100644 docs_site/pages/cloud/_meta.json delete mode 100644 docs_site/pages/cloud/creatorStore/_meta.json delete mode 100644 docs_site/pages/cloud/creatorStore/createCreatorStoreProduct.md delete mode 100644 docs_site/pages/cloud/creatorStore/creatorStoreProductInfo.md delete mode 100644 docs_site/pages/cloud/creatorStore/updateCreatorStoreProduct.md delete mode 100644 docs_site/pages/cloud/experiences/_meta.json delete mode 100644 docs_site/pages/cloud/experiences/placeInfo.md delete mode 100644 docs_site/pages/cloud/experiences/restartUniverseServers.md delete mode 100644 docs_site/pages/cloud/experiences/universeInfo.md delete mode 100644 docs_site/pages/cloud/experiences/updatePlace.md delete mode 100644 docs_site/pages/cloud/experiences/updateUniverse.md delete mode 100644 docs_site/pages/cloud/groups/_meta.json delete mode 100644 docs_site/pages/cloud/groups/groupInfo.md delete mode 100644 docs_site/pages/cloud/groups/groupJoinRequests.md delete mode 100644 docs_site/pages/cloud/groups/groupMembers.md delete mode 100644 docs_site/pages/cloud/groups/groupRoles.md delete mode 100644 docs_site/pages/cloud/groups/groupShout.md delete mode 100644 docs_site/pages/cloud/inventory/_meta.json delete mode 100644 docs_site/pages/cloud/inventory/inventoryItemsForUser.md delete mode 100644 docs_site/pages/cloud/memoryStore/_meta.json delete mode 100644 docs_site/pages/cloud/memoryStore/createSortedMapItem.md delete mode 100644 docs_site/pages/cloud/memoryStore/deleteSortedMapItem.md delete mode 100644 docs_site/pages/cloud/memoryStore/dequeueItems.md delete mode 100644 docs_site/pages/cloud/memoryStore/enqueueItem.md delete mode 100644 docs_site/pages/cloud/memoryStore/flushAllQueues.md delete mode 100644 docs_site/pages/cloud/memoryStore/listSortedMapItems.md delete mode 100644 docs_site/pages/cloud/memoryStore/operationStatus.md delete mode 100644 docs_site/pages/cloud/memoryStore/readQueueItems.md delete mode 100644 docs_site/pages/cloud/memoryStore/sortedMapItem.md delete mode 100644 docs_site/pages/cloud/memoryStore/updateSortedMapItem.md delete mode 100644 docs_site/pages/cloud/messaging/_meta.json delete mode 100644 docs_site/pages/cloud/messaging/publishMessage.md delete mode 100644 docs_site/pages/cloud/subscriptions/_meta.json delete mode 100644 docs_site/pages/cloud/subscriptions/subscriptionInfo.md delete mode 100644 docs_site/pages/cloud/users/_meta.json delete mode 100644 docs_site/pages/cloud/users/sendNotificationToUser.md delete mode 100644 docs_site/pages/cloud/users/userInfo.md delete mode 100644 docs_site/pages/cloud/users/userThumbnail.md delete mode 100644 docs_site/pages/styles.css diff --git a/docs_site/pages/_app.js b/docs_site/pages/_app.js deleted file mode 100644 index 4cd2cac..0000000 --- a/docs_site/pages/_app.js +++ /dev/null @@ -1,6 +0,0 @@ - -import './styles.css' - -export default function MyApp({ Component, pageProps }) { - return -} diff --git a/docs_site/pages/_meta.json b/docs_site/pages/_meta.json deleted file mode 100644 index 140bac4..0000000 --- a/docs_site/pages/_meta.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "cloud": { - "type": "page", - "title": "Cloud APIs" - }, - "classic": { - "type": "page", - "title": "Classic APIs" - } -} \ No newline at end of file diff --git a/docs_site/pages/classic/_meta.json b/docs_site/pages/classic/_meta.json deleted file mode 100644 index 284c37d..0000000 --- a/docs_site/pages/classic/_meta.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "friends": "ClassicFriendsApi", - "games": "ClassicGamesApi", - "groups": "ClassicGroupsApi", - "premiumFeatures": "ClassicPremiumFeaturesApi", - "subscriptions": "ClassicSubscriptionsApi", - "talent": "ClassicTalentApi", - "thumbnails": "ClassicThumbnailsApi", - "universes": "ClassicUniversesApi", - "users": "ClassicUsersApi" -} \ No newline at end of file diff --git a/docs_site/pages/classic/friends/_meta.json b/docs_site/pages/classic/friends/_meta.json deleted file mode 100644 index b476687..0000000 --- a/docs_site/pages/classic/friends/_meta.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "friendsMetadata": "friendsMetadata", - "authenticatedUserFriendsCount": "authenticatedUserFriendsCount", - "authenticatedUserFriendRequests": "authenticatedUserFriendRequests", - "authenticatedUserFriendRequestsCount": "authenticatedUserFriendRequestsCount", - "friendsList": "friendsList", - "friendsCount": "friendsCount", - "findFriends": "findFriends", - "userfollowersCount": "userfollowersCount" -} \ No newline at end of file diff --git a/docs_site/pages/classic/friends/authenticatedUserFriendRequests.md b/docs_site/pages/classic/friends/authenticatedUserFriendRequests.md deleted file mode 100644 index 08b4e64..0000000 --- a/docs_site/pages/classic/friends/authenticatedUserFriendRequests.md +++ /dev/null @@ -1,24 +0,0 @@ - -# authenticatedUserFriendRequests -Gets friends requests sent to the authenticated user. - - -## Parameters -| Name | Type | Description | -| :-------- | :---- | :---------- | -| limit | ? | limit | -| sortOrder | ? | sortOrder | -| cursor | ? | cursor | - - - -## Example -```js copy showLineNumbers -const { data: requests } = await ClassicFriendsApi.authenticatedUserFriendRequests({ limit: 10 }); -``` - -## Endpoint -```ansi -GET /v1/my/friends/requests -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/friends/authenticatedUserFriendRequestsCount.md b/docs_site/pages/classic/friends/authenticatedUserFriendRequestsCount.md deleted file mode 100644 index 4a3b720..0000000 --- a/docs_site/pages/classic/friends/authenticatedUserFriendRequestsCount.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserFriendRequestsCount -Gets the amount of friend requests the authenticated user has. - - - -## Example -```js copy showLineNumbers -const { data: requestsCount } = await ClassicFriendsApi.authenticatedUserFriendRequestsCount(); -``` - -## Endpoint -```ansi -GET /v1/user/friend-requests/count -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/friends/authenticatedUserFriendsCount.md b/docs_site/pages/classic/friends/authenticatedUserFriendsCount.md deleted file mode 100644 index ccc780b..0000000 --- a/docs_site/pages/classic/friends/authenticatedUserFriendsCount.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserFriendsCount -Gets the amount of friends the authenticated user has. - - - -## Example -```js copy showLineNumbers -const { data: metadata } = await ClassicFriendsApi.friendsMetadata(); -``` - -## Endpoint -```ansi -GET /v1/my/friends/count -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/friends/findFriends.md b/docs_site/pages/classic/friends/findFriends.md deleted file mode 100644 index 678463f..0000000 --- a/docs_site/pages/classic/friends/findFriends.md +++ /dev/null @@ -1,25 +0,0 @@ - -# findFriends -Gets a paginated list of all friends for the specified user. - - -## Parameters -| Name | Type | Description | -| :------- | :--------- | :----------------------------------------------- | -| userId | Identifier | The id of the user to get friends for. | -| userSort | ? | Specifies how to sort the returned friends. | -| limit | ? | The number of results to be returned | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: friends } = await ClassicFriendsApi.userfollowersCount({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/friends/find -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/friends/friendsCount.md b/docs_site/pages/classic/friends/friendsCount.md deleted file mode 100644 index 2657c0b..0000000 --- a/docs_site/pages/classic/friends/friendsCount.md +++ /dev/null @@ -1,22 +0,0 @@ - -# friendsCount -Gets friends count for a specified user. - - -## Parameters -| Name | Type | Description | -| :----- | :--------- | :------------------------------------- | -| userId | Identifier | The id of the user to get friends for. | - - - -## Example -```js copy showLineNumbers -const { data: count } = await ClassicFriendsApi.friendsCount({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/friends/count -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/friends/friendsList.md b/docs_site/pages/classic/friends/friendsList.md deleted file mode 100644 index e23379e..0000000 --- a/docs_site/pages/classic/friends/friendsList.md +++ /dev/null @@ -1,23 +0,0 @@ - -# friendsList -Gets friends for a specified user. - - -## Parameters -| Name | Type | Description | -| :------- | :--------- | :------------------------------------------ | -| userId | Identifier | The id of the user to get friends for. | -| userSort | ? | Specifies how to sort the returned friends. | - - - -## Example -```js copy showLineNumbers -const { data: friends } = await ClassicFriendsApi.friendsList({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/friends -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/friends/friendsMetadata.md b/docs_site/pages/classic/friends/friendsMetadata.md deleted file mode 100644 index 92a0993..0000000 --- a/docs_site/pages/classic/friends/friendsMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ - -# friendsMetadata -Gets friends metadata. - - - -## Example -```js copy showLineNumbers -const { data: metadata } = await ClassicFriendsApi.friendsMetadata(); -``` - -## Endpoint -```ansi -GET /v1/metadata -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/friends/userfollowersCount.md b/docs_site/pages/classic/friends/userfollowersCount.md deleted file mode 100644 index f1486a6..0000000 --- a/docs_site/pages/classic/friends/userfollowersCount.md +++ /dev/null @@ -1,22 +0,0 @@ - -# userfollowersCount -Gets the followers count for a specific user. - - -## Parameters -| Name | Type | Description | -| :----- | :--------- | :------------------------------------------------ | -| userId | Identifier | The id of the user to get the follower count for. | - - - -## Example -```js copy showLineNumbers -const { data: followersCount } = await ClassicFriendsApi.userfollowersCount({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/followers/count -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/games/_meta.json b/docs_site/pages/classic/games/_meta.json deleted file mode 100644 index 630c8ed..0000000 --- a/docs_site/pages/classic/games/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "gamesInfo": "gamesInfo", - "userGames": "userGames" -} \ No newline at end of file diff --git a/docs_site/pages/classic/games/gamesInfo.md b/docs_site/pages/classic/games/gamesInfo.md deleted file mode 100644 index dc71100..0000000 --- a/docs_site/pages/classic/games/gamesInfo.md +++ /dev/null @@ -1,25 +0,0 @@ - -# gamesInfo -Gets a list of games info from universe ids. - - -## Parameters -| Name | Type | Description | -| :-------- | :---- | :----------------------------------------------- | -| userId | | The id of the user to get games for. | -| limit | | The maximum amount of games to return. | -| sortOrder | | The order the results are sorted it. | -| cursor | | the paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers - -``` - -## Endpoint -```ansi -GET /v1/games -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/games/userGames.md b/docs_site/pages/classic/games/userGames.md deleted file mode 100644 index 7a5f1bf..0000000 --- a/docs_site/pages/classic/games/userGames.md +++ /dev/null @@ -1,25 +0,0 @@ - -# userGames -Gets a list of games made by a specific user. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :----------------------------------------------- | -| userId | Identifier | The id of the user to get games for. | -| limit | ? | The maximum amount of games to return. | -| sortOrder | ? | The order the results are sorted it. | -| cursor | ? | the paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers - -``` - -## Endpoint -```ansi -GET /v2/users/{userId}/games -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/_meta.json b/docs_site/pages/classic/groups/_meta.json deleted file mode 100644 index 24e93ef..0000000 --- a/docs_site/pages/classic/groups/_meta.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "groupInfo": "groupInfo", - "groupAuditLog": "groupAuditLog", - "groupNameHistory": "groupNameHistory", - "groupSettings": "groupSettings", - "setGroupSettings": "setGroupSettings", - "groupsConfigMetadata": "groupsConfigMetadata", - "groupsMetadata": "groupsMetadata", - "groupsPolicyInfo": "groupsPolicyInfo", - "setGroupDescription": "setGroupDescription", - "setGroupShout": "setGroupShout", - "setGroupIcon": "setGroupIcon", - "batchDeclineGroupJoinRequests": "batchDeclineGroupJoinRequests", - "groupJoinRequests": "groupJoinRequests", - "batchAcceptGroupJoinRequests": "batchAcceptGroupJoinRequests", - "declineGroupJoinRequest": "declineGroupJoinRequest", - "groupJoinRequestInfo": "groupJoinRequestInfo", - "acceptGroupJoinRequest": "acceptGroupJoinRequest", - "authenticatedUserGroupMembershipInfo": "authenticatedUserGroupMembershipInfo", - "groupRoles": "groupRoles", - "groupMembersWithRole": "groupMembersWithRole", - "groupMembers": "groupMembers", - "authenticatedUserPendingGroups": "authenticatedUserPendingGroups", - "groupsThatUsersFriendsAreIn": "groupsThatUsersFriendsAreIn", - "allGroupRolesForUser_V1": "allGroupRolesForUser_V1", - "removeGroupMember": "removeGroupMember", - "updateGroupMemberRole": "updateGroupMemberRole", - "groupPayoutRestrictionsInfo": "groupPayoutRestrictionsInfo", - "groupPayoutsInfo": "groupPayoutsInfo", - "groupRelationships": "groupRelationships", - "batchDeclineGroupRelationshipRequests": "batchDeclineGroupRelationshipRequests", - "groupRelationshipRequests": "groupRelationshipRequests", - "batchAcceptGroupRelationshipRequests": "batchAcceptGroupRelationshipRequests", - "removeGroupRelationship": "removeGroupRelationship", - "requestGroupRelationship": "requestGroupRelationship", - "declineGroupRelationshipRequest": "declineGroupRelationshipRequest", - "acceptGroupRelationshipRequest": "acceptGroupRelationshipRequest", - "groupPermissionsForRole": "groupPermissionsForRole", - "setGroupRolePermissions": "setGroupRolePermissions", - "groupGuestRolePermissions": "groupGuestRolePermissions", - "groupPermissionsForAllRoles": "groupPermissionsForAllRoles", - "groupSocialLinks": "groupSocialLinks", - "addGroupSocialLink": "addGroupSocialLink", - "removeGroupSocialLink": "removeGroupSocialLink", - "updateGroupSocialLink": "updateGroupSocialLink", - "groupWallPosts_V1": "groupWallPosts_V1", - "authenticatedUserSubscribeToGroupWallNotificationEvents": "authenticatedUserSubscribeToGroupWallNotificationEvents", - "removeGroupWallPost": "removeGroupWallPost", - "removeAllGroupWallPostMadeByUser": "removeAllGroupWallPostMadeByUser", - "groupSearch": "groupSearch", - "groupLookupSearch": "groupLookupSearch", - "groupSearchMetadata": "groupSearchMetadata", - "groupRolesFromIds": "groupRolesFromIds" -} \ No newline at end of file diff --git a/docs_site/pages/classic/groups/acceptGroupJoinRequest.md b/docs_site/pages/classic/groups/acceptGroupJoinRequest.md deleted file mode 100644 index 582d8f0..0000000 --- a/docs_site/pages/classic/groups/acceptGroupJoinRequest.md +++ /dev/null @@ -1,23 +0,0 @@ - -# acceptGroupJoinRequest -Accepts a join request. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------------------------------------ | -| groupId | Identifier | The id of the group to accept a join request for. | -| userId | Identifier | The id of the user to accept. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.acceptGroupJoinRequest({ groupId: 5850082, userId: 2655994471 }); -``` - -## Endpoint -```ansi -POST /v1/groups/{groupId}/join-requests/users/${userId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/acceptGroupRelationshipRequest.md b/docs_site/pages/classic/groups/acceptGroupRelationshipRequest.md deleted file mode 100644 index 83acc84..0000000 --- a/docs_site/pages/classic/groups/acceptGroupRelationshipRequest.md +++ /dev/null @@ -1,28 +0,0 @@ - -# acceptGroupRelationshipRequest -Accepts a group relationship request. - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :------------------------------------------------- | -| groupId | Identifier | The id of the group to accept for. | -| groupRelationshipType | GroupRelationshipType | The type of group relationship to accept. | -| relatedGroupId | Identifier | The id of the group to accept a relationship with. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.acceptGroupRelationshipRequest({ - groupId: 5850082, - groupRelationshipType: "Allies", - relatedGroupId: 3843784, -}); -``` - -## Endpoint -```ansi -POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests/{relatedGroupId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/addGroupSocialLink.md b/docs_site/pages/classic/groups/addGroupSocialLink.md deleted file mode 100644 index 129ffdc..0000000 --- a/docs_site/pages/classic/groups/addGroupSocialLink.md +++ /dev/null @@ -1,30 +0,0 @@ - -# addGroupSocialLink -Adds a new social link to a group. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------------------------------- | -| groupId | Identifier | The id of the group to add a social link to. | -| request | | The social link request data. | - - - -## Example -```js copy showLineNumbers -const { data: addedSocial } = await ClassicGroupsApi.addGroupSocialLink({ - groupId: 5850082, - newSocial: { - type: "Twitch", - title: "Follow My Twitch", - url: "twitch.tv/fooBar", - }, -}); -``` - -## Endpoint -```ansi -POST /v1/groups/{groupId}/social-links -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/allGroupRolesForUser_V1.md b/docs_site/pages/classic/groups/allGroupRolesForUser_V1.md deleted file mode 100644 index a8ce70f..0000000 --- a/docs_site/pages/classic/groups/allGroupRolesForUser_V1.md +++ /dev/null @@ -1,22 +0,0 @@ - -# allGroupRolesForUser_V1 -Gets a list of all roles for every group that the specified user is in. - - -## Parameters -| Name | Type | Description | -| :----- | :--------- | :----------------------------------- | -| userId | Identifier | The id of the user to get roles for. | - - - -## Example -```js copy showLineNumbers -const { data: allRoles } = await ClassicGroupsApi.allGroupRolesForUser_V1({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/groups/roles -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/authenticatedUserGroupMembershipInfo.md b/docs_site/pages/classic/groups/authenticatedUserGroupMembershipInfo.md deleted file mode 100644 index 5513350..0000000 --- a/docs_site/pages/classic/groups/authenticatedUserGroupMembershipInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# authenticatedUserGroupMembershipInfo -Gets group membership info for the currently authenticated user. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :---------------------------------------------- | -| groupId | GroupId | The id of the group to get membership info for. | - - - -## Example -```js copy showLineNumbers -const { data: membershipInfo } = await ClassicGroupsApi.authenticatedUserGroupMembershipInfo({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/membership -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/authenticatedUserPendingGroups.md b/docs_site/pages/classic/groups/authenticatedUserPendingGroups.md deleted file mode 100644 index 67adbd8..0000000 --- a/docs_site/pages/classic/groups/authenticatedUserPendingGroups.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserPendingGroups -Gets groups that the authenticated user has requested to join. - - - -## Example -```js copy showLineNumbers -const { data: pendingGroups } = await ClassicGroupsApi.authenticatedUserPendingGroups(); -``` - -## Endpoint -```ansi -GET /v1/user/groups/pending -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/authenticatedUserSubscribeToGroupWallNotificationEvents.md b/docs_site/pages/classic/groups/authenticatedUserSubscribeToGroupWallNotificationEvents.md deleted file mode 100644 index 31300fe..0000000 --- a/docs_site/pages/classic/groups/authenticatedUserSubscribeToGroupWallNotificationEvents.md +++ /dev/null @@ -1,22 +0,0 @@ - -# authenticatedUserSubscribeToGroupWallNotificationEvents -(THIS ENDPOINT PROBABLY DOESN'T WORK). Subscribes the authenticated user to notifications of group wall events. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------- | -| groupId | Identifier | The id of the group. | - - - -## Example -```js copy showLineNumbers -const { data } = await ClassicGroupsApi.authenticatedUserSubscribeToGroupWallNotificationEvents({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/wall/posts/subscribe -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/batchAcceptGroupJoinRequests.md b/docs_site/pages/classic/groups/batchAcceptGroupJoinRequests.md deleted file mode 100644 index bd4d85c..0000000 --- a/docs_site/pages/classic/groups/batchAcceptGroupJoinRequests.md +++ /dev/null @@ -1,26 +0,0 @@ - -# batchAcceptGroupJoinRequests -Batch accepts join requests. - - -## Parameters -| Name | Type | Description | -| :------ | :------------------------ | :------------------------------------------------------ | -| groupId | Identifier | The id of the group to batch accepts join requests for. | -| userIds | ArrayNonEmpty | The ids of the user to accept. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.batchAcceptGroupJoinRequests({ - groupId: 5850082, - userIds: [2655994471], -}); -``` - -## Endpoint -```ansi -POST /v1/groups/{groupId}/join-requests -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/batchAcceptGroupRelationshipRequests.md b/docs_site/pages/classic/groups/batchAcceptGroupRelationshipRequests.md deleted file mode 100644 index 1b5c692..0000000 --- a/docs_site/pages/classic/groups/batchAcceptGroupRelationshipRequests.md +++ /dev/null @@ -1,28 +0,0 @@ - -# batchAcceptGroupRelationshipRequests -Batch accepts relationship requests. - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :------------------------------------------------------------- | -| groupId | Identifier | The id of the group to batch accept relationship requests for. | -| groupRelationshipType | GroupRelationshipType | The type of group relationship to batch accept for. | -| groupIds | Identifier[] | The ids of the groups to accept. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.batchAcceptGroupRelationshipRequests({ - groupId: 5850082, - groupRelationshipType: "Allies", - groupIds: [15842838], -}); -``` - -## Endpoint -```ansi -POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/batchDeclineGroupJoinRequests.md b/docs_site/pages/classic/groups/batchDeclineGroupJoinRequests.md deleted file mode 100644 index 0125f1f..0000000 --- a/docs_site/pages/classic/groups/batchDeclineGroupJoinRequests.md +++ /dev/null @@ -1,26 +0,0 @@ - -# batchDeclineGroupJoinRequests -Batch declines join requests. - - -## Parameters -| Name | Type | Description | -| :------ | :------------------------ | :------------------------------------------------------ | -| groupId | Identifier | The id of the group to batch decline join requests for. | -| userIds | ArrayNonEmpty | The ids of the user to decline. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.batchDeclineGroupJoinRequests({ - groupId: 5850082, - userIds: [2655994471], -}); -``` - -## Endpoint -```ansi -DELETE /v1/groups/{groupId}/join-requests -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/batchDeclineGroupRelationshipRequests.md b/docs_site/pages/classic/groups/batchDeclineGroupRelationshipRequests.md deleted file mode 100644 index 7ec6bb4..0000000 --- a/docs_site/pages/classic/groups/batchDeclineGroupRelationshipRequests.md +++ /dev/null @@ -1,28 +0,0 @@ - -# batchDeclineGroupRelationshipRequests -Batch declines relationship requests. - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :-------------------------------------------------------------- | -| groupId | Identifier | The id of the group to batch decline relationship requests for. | -| groupRelationshipType | GroupRelationshipType | The type of group relationship to batch decline for. | -| groupIds | Identifier[] | The ids of the groups to decline. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.batchDeclineGroupRelationshipRequests({ - groupId: 5850082, - groupRelationshipType: "Allies", - groupIds: [15842838], -}); -``` - -## Endpoint -```ansi -DELETE /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/declineGroupJoinRequest.md b/docs_site/pages/classic/groups/declineGroupJoinRequest.md deleted file mode 100644 index cd9dcc3..0000000 --- a/docs_site/pages/classic/groups/declineGroupJoinRequest.md +++ /dev/null @@ -1,23 +0,0 @@ - -# declineGroupJoinRequest -Declines a join request. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------------------------------------- | -| groupId | Identifier | The id of the group to decline a join request for. | -| userId | Identifier | The id of the user to decline. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.declineGroupJoinRequest({ groupId: 5850082, userId: 2655994471 }); -``` - -## Endpoint -```ansi -DELETE /v1/groups/{groupId}/join-requests/users/${userId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/declineGroupRelationshipRequest.md b/docs_site/pages/classic/groups/declineGroupRelationshipRequest.md deleted file mode 100644 index 8dc2432..0000000 --- a/docs_site/pages/classic/groups/declineGroupRelationshipRequest.md +++ /dev/null @@ -1,28 +0,0 @@ - -# declineGroupRelationshipRequest -Declines a group relationship request. - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :-------------------------------------------------- | -| groupId | Identifier | The id of the group to decline for. | -| groupRelationshipType | GroupRelationshipType | The type of group relationship to decline. | -| relatedGroupId | Identifier | The id of the group to decline a relationship with. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.declineGroupRelationshipRequest({ - groupId: 5850082, - groupRelationshipType: "Allies", - relatedGroupId: 3843784, -}); -``` - -## Endpoint -```ansi -DELETE /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests/{relatedGroupId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupAuditLog.md b/docs_site/pages/classic/groups/groupAuditLog.md deleted file mode 100644 index c33b253..0000000 --- a/docs_site/pages/classic/groups/groupAuditLog.md +++ /dev/null @@ -1,27 +0,0 @@ - -# groupAuditLog -Gets audit log entries for a group. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :---------------------------------------------------------------------------------------------- | -| groupId | Identifier | The id of the group. | -| actionType | ? | The action to filter the audit logs by. (no filter will be applied if actionType is undefined). | -| userId | ? | Filter for specific user by their id. | -| limit | ? | The number of results to be returned. | -| sortOrder | ? | The order that the results are sorted in. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: auditLog } = await ClassicGroupsApi.groupAuditLog({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/audit-log -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupGuestRolePermissions.md b/docs_site/pages/classic/groups/groupGuestRolePermissions.md deleted file mode 100644 index 6d34537..0000000 --- a/docs_site/pages/classic/groups/groupGuestRolePermissions.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupGuestRolePermissions -Gets permissions for the guest role of a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :------------------- | -| groupId | GroupId | The id of the group. | - - - -## Example -```js copy showLineNumbers -const { data: rolePerms } = await ClassicGroupsApi.groupGuestRolePermissions({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/roles/guest/permissions -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupInfo.md b/docs_site/pages/classic/groups/groupInfo.md deleted file mode 100644 index cf7e937..0000000 --- a/docs_site/pages/classic/groups/groupInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupInfo -Gets information about a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :------------------- | -| groupId | GroupId | The id of the group. | - - - -## Example -```js copy showLineNumbers -const { data: groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupJoinRequestInfo.md b/docs_site/pages/classic/groups/groupJoinRequestInfo.md deleted file mode 100644 index 66f731e..0000000 --- a/docs_site/pages/classic/groups/groupJoinRequestInfo.md +++ /dev/null @@ -1,23 +0,0 @@ - -# groupJoinRequestInfo -Gets a join request for a user. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------- | -| groupId | Identifier | The id of the group. | -| userId | UserId | The id of the user. | - - - -## Example -```js copy showLineNumbers -const { data: joinRequest } = await ClassicGroupsApi.groupJoinRequestInfo({ groupId: 5850082, userId: 2655994471 }); -``` - -## Endpoint -```ansi -DELETE /v1/groups/{groupId}/join-requests/users/${userId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupJoinRequests.md b/docs_site/pages/classic/groups/groupJoinRequests.md deleted file mode 100644 index 68de3af..0000000 --- a/docs_site/pages/classic/groups/groupJoinRequests.md +++ /dev/null @@ -1,25 +0,0 @@ - -# groupJoinRequests -gets join requests. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :----------------------------------------------- | -| groupId | Identifier | The id of the group to get join requests for. | -| limit | ? | The number of results to be returned. | -| sortOrder | ? | The order that the results are sorted in. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: joinRequests } = await ClassicGroupsApi.groupJoinRequests({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/join-requests -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupLookupSearch.md b/docs_site/pages/classic/groups/groupLookupSearch.md deleted file mode 100644 index 3819329..0000000 --- a/docs_site/pages/classic/groups/groupLookupSearch.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupLookupSearch -Search for groups by keyword. - - -## Parameters -| Name | Type | Description | -| :-------- | :----- | :------------------------------- | -| groupName | string | The name of the group to lookup. | - - - -## Example -```js copy showLineNumbers -const { data: results } = await ClassicGroupsApi.groupLookupSearch({ groupName: "MightyPart Games" }); -``` - -## Endpoint -```ansi -GET /v1/groups/search/lookup -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupMembers.md b/docs_site/pages/classic/groups/groupMembers.md deleted file mode 100644 index 5f84a5c..0000000 --- a/docs_site/pages/classic/groups/groupMembers.md +++ /dev/null @@ -1,25 +0,0 @@ - -# groupMembers -Gets a page of members of a group. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :----------------------------------------------- | -| groupId | Identifier | The id of the group. | -| limit | ? | The number of results to be returned. | -| sortOrder | ? | The order that the results are sorted in. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: members } = await ClassicGroupsApi.groupMembers({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/users -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupMembersWithRole.md b/docs_site/pages/classic/groups/groupMembersWithRole.md deleted file mode 100644 index d5b2f36..0000000 --- a/docs_site/pages/classic/groups/groupMembersWithRole.md +++ /dev/null @@ -1,29 +0,0 @@ - -# groupMembersWithRole -Gets group members that have a specified role. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :----------------------------------------------- | -| groupId | Identifier | The id of the group. | -| roleSetId | Identifier | The id of the role. | -| limit | ? | The number of results to be returned. | -| sortOrder | ? | The order that the results are sorted in. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: membersWithRole } = await ClassicGroupsApi.groupMembersWithRole({ - groupId: 5850082, - roleSetId: 38353811, -}); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/roles/{roleSetId}/users -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupNameHistory.md b/docs_site/pages/classic/groups/groupNameHistory.md deleted file mode 100644 index 023e1e5..0000000 --- a/docs_site/pages/classic/groups/groupNameHistory.md +++ /dev/null @@ -1,25 +0,0 @@ - -# groupNameHistory -Gets name history of a group. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :----------------------------------------------- | -| groupId | Identifier | The id of the group. | -| limit | ? | The number of results to be returned. | -| sortOrder | ? | The order that the results are sorted in. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: nameHistory } = await ClassicGroupsApi.groupNameHistory({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/name-history -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupPayoutRestrictionsInfo.md b/docs_site/pages/classic/groups/groupPayoutRestrictionsInfo.md deleted file mode 100644 index ceac327..0000000 --- a/docs_site/pages/classic/groups/groupPayoutRestrictionsInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupPayoutRestrictionsInfo -Gets values indicating if the specified group can use payout features. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------- | -| groupId | Identifier | The id of the group. | - - - -## Example -```js copy showLineNumbers -const { data: payoutRestrictions } = await ClassicGroupsApi.groupPayoutRestrictionsInfo({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/payout-restriction -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupPayoutsInfo.md b/docs_site/pages/classic/groups/groupPayoutsInfo.md deleted file mode 100644 index e6ff20c..0000000 --- a/docs_site/pages/classic/groups/groupPayoutsInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupPayoutsInfo -Gets a list of the group payout percentages. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------- | -| groupId | Identifier | The id of the group. | - - - -## Example -```js copy showLineNumbers -const { data: payouts } = await ClassicGroupsApi.groupPayoutsInfo({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/payouts -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupPermissionsForAllRoles.md b/docs_site/pages/classic/groups/groupPermissionsForAllRoles.md deleted file mode 100644 index e20b25d..0000000 --- a/docs_site/pages/classic/groups/groupPermissionsForAllRoles.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupPermissionsForAllRoles -Gets permissions for all roles in a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :------------------- | -| groupId | GroupId | The id of the group. | - - - -## Example -```js copy showLineNumbers -const { data: allPerms } = await ClassicGroupsApi.groupPermissionsForAllRoles({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/roles/permissions -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupPermissionsForRole.md b/docs_site/pages/classic/groups/groupPermissionsForRole.md deleted file mode 100644 index 9a8cc21..0000000 --- a/docs_site/pages/classic/groups/groupPermissionsForRole.md +++ /dev/null @@ -1,23 +0,0 @@ - -# groupPermissionsForRole -Gets permissions for a role in a group. - - -## Parameters -| Name | Type | Description | -| :-------- | :-------- | :----------------------------------------- | -| groupId | GroupId | The id of the group. | -| roleSetId | RoleSetId | The id of the role to get permissions for. | - - - -## Example -```js copy showLineNumbers -const { data: rolePerms } = await ClassicGroupsApi.groupPermissionsForRole({ groupId: 5850082, roleSetId: 38353814 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/roles/{roleSetId}/permissions -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupRelationshipRequests.md b/docs_site/pages/classic/groups/groupRelationshipRequests.md deleted file mode 100644 index a0a7097..0000000 --- a/docs_site/pages/classic/groups/groupRelationshipRequests.md +++ /dev/null @@ -1,29 +0,0 @@ - -# groupRelationshipRequests -Gets relationship requests. - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :--------------------------------------------------------------------- | -| groupId | Identifier | The id of the group. | -| groupRelationshipType | GroupRelationshipType | The group relationship type, "Enemies" or "Allies". | -| maxRows | ? | The maximum number of rows for the page request, should be at least 1. | -| startRowIndex | ? | The start index of the page request. | - - - -## Example -```js copy showLineNumbers -const { data: relationshipRequests, cursors } = await ClassicGroupsApi.groupRelationshipRequests({ - groupId: 5850082, - groupRelationshipType: "Allies", - maxRows: 1, -}); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupRelationships.md b/docs_site/pages/classic/groups/groupRelationships.md deleted file mode 100644 index 397eaab..0000000 --- a/docs_site/pages/classic/groups/groupRelationships.md +++ /dev/null @@ -1,29 +0,0 @@ - -# groupRelationships -Gets a group's relationships. - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :--------------------------------------------------------------------- | -| groupId | Identifier | The id of the group. | -| groupRelationshipType | GroupRelationshipType | The group relationship type, "Enemies" or "Allies". | -| maxRows | ? | The maximum number of rows for the page request, should be at least 1. | -| startRowIndex | ? | The start index of the page request. | - - - -## Example -```js copy showLineNumbers -const { data: relationships } = await ClassicGroupsApi.groupRelationships({ - groupId: 5850082, - groupRelationshipType: "Allies", - maxRows: 1, -}); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/relationships/{groupRelationshipType} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupRoles.md b/docs_site/pages/classic/groups/groupRoles.md deleted file mode 100644 index 222b312..0000000 --- a/docs_site/pages/classic/groups/groupRoles.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupRoles -Gets all roles in a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :------------------------------------ | -| groupId | GroupId | The id of the group to get roles for. | - - - -## Example -```js copy showLineNumbers -const { data: roles } = await ClassicGroupsApi.groupRoles({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/roles -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupRolesFromIds.md b/docs_site/pages/classic/groups/groupRolesFromIds.md deleted file mode 100644 index e6b6ede..0000000 --- a/docs_site/pages/classic/groups/groupRolesFromIds.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupRolesFromIds -Gets a list of roles from role ids. - - -## Parameters -| Name | Type | Description | -| :------ | :---- | :----------------------- | -| roleIds | | The ids of roles to get. | - - - -## Example -```js copy showLineNumbers -const { data: roles } = await ClassicGroupsApi.groupRolesFromIds([38353811]); -``` - -## Endpoint -```ansi -GET /v1/roles -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupSearch.md b/docs_site/pages/classic/groups/groupSearch.md deleted file mode 100644 index e7aed64..0000000 --- a/docs_site/pages/classic/groups/groupSearch.md +++ /dev/null @@ -1,28 +0,0 @@ - -# groupSearch -Search for groups by keyword. - - -## Parameters -| Name | Type | Description | -| :------------------- | :----- | :------------------------------------------------------------ | -| keyword | string | The keyword or phrase to use as the search parameter. | -| prioritizeExactMatch | ? | Whether or not to prioritize the exact match for the keyword. | -| limit | ? | The number of results to be returned. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: results } = await ClassicGroupsApi.groupSearch({ - keyword: "MightyPart Games", - prioritizeExactMatch: true, -}); -``` - -## Endpoint -```ansi -GET /v1/groups/search -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupSearchMetadata.md b/docs_site/pages/classic/groups/groupSearchMetadata.md deleted file mode 100644 index 2fad12a..0000000 --- a/docs_site/pages/classic/groups/groupSearchMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ - -# groupSearchMetadata -Gets suggested groups and other miscellaneous information needed for the group/join page like flags. - - - -## Example -```js copy showLineNumbers -const { data: searchMetadata } = await ClassicGroupsApi.groupSearchMetadata(); -``` - -## Endpoint -```ansi -GET /v1/groups/search/metadata -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupSettings.md b/docs_site/pages/classic/groups/groupSettings.md deleted file mode 100644 index 9d7cf46..0000000 --- a/docs_site/pages/classic/groups/groupSettings.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupSettings -Gets settings for a group. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :--------------------------------------- | -| groupId | Identifier | The id of the group to get settings for. | - - - -## Example -```js copy showLineNumbers -const { data: settings } = await ClassicGroupsApi.groupSettings({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/settings -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupSocialLinks.md b/docs_site/pages/classic/groups/groupSocialLinks.md deleted file mode 100644 index 661b967..0000000 --- a/docs_site/pages/classic/groups/groupSocialLinks.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupSocialLinks -Gets socials links for a group. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------------------------------- | -| groupId | Identifier | The id of the group to get social links for. | - - - -## Example -```js copy showLineNumbers -const { rawBody: socials } = await ClassicGroupsApi.groupSocialLinks(5850082); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/social-links -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupWallPosts_V1.md b/docs_site/pages/classic/groups/groupWallPosts_V1.md deleted file mode 100644 index c1ad50b..0000000 --- a/docs_site/pages/classic/groups/groupWallPosts_V1.md +++ /dev/null @@ -1,25 +0,0 @@ - -# groupWallPosts_V1 -Gets a list of group wall posts. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :----------------------------------------------- | -| groupId | Identifier | The id of the group to get wall posts for. | -| limit | ? | The number of results to be returned. | -| sortOrder | ? | The order that the results are sorted in. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: wallPosts } = await ClassicGroupsApi.groupWallPosts_V1({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/wall/posts -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupsConfigMetadata.md b/docs_site/pages/classic/groups/groupsConfigMetadata.md deleted file mode 100644 index d6a8436..0000000 --- a/docs_site/pages/classic/groups/groupsConfigMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ - -# groupsConfigMetadata -Gets groups configuration metadata. - - - -## Example -```js copy showLineNumbers -const { data: configMetadata } = await ClassicGroupsApi.groupsConfigMetadata(); -``` - -## Endpoint -```ansi -GET /v1/groups/configuration/metadata -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupsMetadata.md b/docs_site/pages/classic/groups/groupsMetadata.md deleted file mode 100644 index bc70e48..0000000 --- a/docs_site/pages/classic/groups/groupsMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ - -# groupsMetadata -Gets groups metadata. - - - -## Example -```js copy showLineNumbers -const { data: metadata } = await ClassicGroupsApi.groupsMetadata(); -``` - -## Endpoint -```ansi -GET /v1/groups/metadata -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupsPolicyInfo.md b/docs_site/pages/classic/groups/groupsPolicyInfo.md deleted file mode 100644 index d0a6244..0000000 --- a/docs_site/pages/classic/groups/groupsPolicyInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupsPolicyInfo -Gets group policy info used for compliance. - - -## Parameters -| Name | Type | Description | -| :------- | :--------------------- | :---------------------------------------- | -| groupIds | ArrayNonEmpty | the ids of groups to get policy info for. | - - - -## Example -```js copy showLineNumbers -const { data: policyInfo } = await ClassicGroupsApi.groupsPolicyInfo({ groupIds: [5850082] }); -``` - -## Endpoint -```ansi -GET /v1/groups/policies -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/groupsThatUsersFriendsAreIn.md b/docs_site/pages/classic/groups/groupsThatUsersFriendsAreIn.md deleted file mode 100644 index 27dcf3d..0000000 --- a/docs_site/pages/classic/groups/groupsThatUsersFriendsAreIn.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupsThatUsersFriendsAreIn -Gets a list of all groups the specified users' friends are in. - - -## Parameters -| Name | Type | Description | -| :----- | :--------- | :-------------------------------------------- | -| userId | Identifier | The id of the user to get friends groups for. | - - - -## Example -```js copy showLineNumbers -const { data: groupsThatUsersFriendsAreIn } = await ClassicGroupsApi.groupsThatUsersFriendsAreIn({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/friends/groups/roles -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/removeAllGroupWallPostMadeByUser.md b/docs_site/pages/classic/groups/removeAllGroupWallPostMadeByUser.md deleted file mode 100644 index 69ddff1..0000000 --- a/docs_site/pages/classic/groups/removeAllGroupWallPostMadeByUser.md +++ /dev/null @@ -1,26 +0,0 @@ - -# removeAllGroupWallPostMadeByUser -Removes all group wall posts made by a specific user. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------- | -| groupId | Identifier | The id of the group. | -| userId | Identifier | The id of the user. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.removeAllGroupWallPostMadeByUser({ - groupId: 5850082, - userId: 45348281, -}); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/wall/users/{userId}/posts -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/removeGroupMember.md b/docs_site/pages/classic/groups/removeGroupMember.md deleted file mode 100644 index c7eaad0..0000000 --- a/docs_site/pages/classic/groups/removeGroupMember.md +++ /dev/null @@ -1,23 +0,0 @@ - -# removeGroupMember -Removes a user from a group. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------------------------------- | -| groupId | Identifier | The id of the group to remove the user from. | -| userId | Identifier | The id of the user to be removed. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.removeGroupMember({ groupId: 5850082, userId: 2655994471 }); -``` - -## Endpoint -```ansi -DELETE /v1/groups/{groupId}/users/{userId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/removeGroupRelationship.md b/docs_site/pages/classic/groups/removeGroupRelationship.md deleted file mode 100644 index 34838d3..0000000 --- a/docs_site/pages/classic/groups/removeGroupRelationship.md +++ /dev/null @@ -1,28 +0,0 @@ - -# removeGroupRelationship -Removes an already existing group relationship - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :--------------------------------------------------- | -| groupId | Identifier | The id of the group to remove the relationship from. | -| groupRelationshipType | GroupRelationshipType | The type of group relationship to remove. | -| relatedGroupId | Identifier | The id of the group to remove. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.removeGroupRelationship({ - groupId: 5850082, - groupRelationshipType: "Allies", - relatedGroupId: 3843784, -}); -``` - -## Endpoint -```ansi -POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/{relatedGroupId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/removeGroupSocialLink.md b/docs_site/pages/classic/groups/removeGroupSocialLink.md deleted file mode 100644 index 77f4948..0000000 --- a/docs_site/pages/classic/groups/removeGroupSocialLink.md +++ /dev/null @@ -1,23 +0,0 @@ - -# removeGroupSocialLink -Removes an existing social link from a group. - - -## Parameters -| Name | Type | Description | -| :----------- | :--------- | :------------------------------------------- | -| groupId | Identifier | The id of the group to add a social link to. | -| socialLinkId | Identifier | The id of the social link to remove. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.removeGroupSocialLink({ groupId: 5850082, socialLinkId: 10792025 }); -``` - -## Endpoint -```ansi -DELETE /v1/groups/{groupId}/social-links/{socialLinkId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/removeGroupWallPost.md b/docs_site/pages/classic/groups/removeGroupWallPost.md deleted file mode 100644 index e0c1e47..0000000 --- a/docs_site/pages/classic/groups/removeGroupWallPost.md +++ /dev/null @@ -1,23 +0,0 @@ - -# removeGroupWallPost -Removes a group wall post. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :------------------------------------- | -| groupId | Identifier | The id of the group. | -| wallPostId | Identifier | The id of the wall post to be removed. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.removeGroupWallPost({ groupId: 5850082, wallPostId: 2727146317 }); -``` - -## Endpoint -```ansi -GET /v1/groups/{groupId}/wall/posts/{wallPostId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/requestGroupRelationship.md b/docs_site/pages/classic/groups/requestGroupRelationship.md deleted file mode 100644 index c398d9e..0000000 --- a/docs_site/pages/classic/groups/requestGroupRelationship.md +++ /dev/null @@ -1,28 +0,0 @@ - -# requestGroupRelationship -Sends a group relationship request to a group. - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :-------------------------------------------------- | -| groupId | Identifier | The id of the group to send a request for. | -| groupRelationshipType | GroupRelationshipType | The type of group relationship to request. | -| relatedGroupId | Identifier | The id of the group to request a relationship with. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.requestGroupRelationship({ - groupId: 5850082, - groupRelationshipType: "Allies", - relatedGroupId: 3843784, -}); -``` - -## Endpoint -```ansi -POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/{relatedGroupId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/setGroupDescription.md b/docs_site/pages/classic/groups/setGroupDescription.md deleted file mode 100644 index 72bc64e..0000000 --- a/docs_site/pages/classic/groups/setGroupDescription.md +++ /dev/null @@ -1,26 +0,0 @@ - -# setGroupDescription -Sets group description. - - -## Parameters -| Name | Type | Description | -| :------------- | :------------- | :---------------------------------------------- | -| groupId | Identifier | The id of the group to set the description for. | -| newDescription | NewDescription | The content of the new description. | - - - -## Example -```js copy showLineNumbers -const { data: newDescription } = await ClassicGroupsApi.setGroupDescription({ - groupId: 5850082, - newDescription: "Hello World!", -}); -``` - -## Endpoint -```ansi -PATCH /v1/groups/{groupId}/description -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/setGroupIcon.md b/docs_site/pages/classic/groups/setGroupIcon.md deleted file mode 100644 index de6e5c9..0000000 --- a/docs_site/pages/classic/groups/setGroupIcon.md +++ /dev/null @@ -1,23 +0,0 @@ - -# setGroupIcon -Sets group icon. - - -## Parameters -| Name | Type | Description | -| :------ | :------------- | :--------------------------------------- | -| groupId | Identifier | The id of the group to set the icon for. | -| newIcon | string \| File | The new icon for the group. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.setGroupIcon({ groupId: 5850082, newIcon: "./newGroupIcon.png" }); -``` - -## Endpoint -```ansi -PATCH /v1/groups/{groupId}/status -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/setGroupRolePermissions.md b/docs_site/pages/classic/groups/setGroupRolePermissions.md deleted file mode 100644 index b73bba8..0000000 --- a/docs_site/pages/classic/groups/setGroupRolePermissions.md +++ /dev/null @@ -1,28 +0,0 @@ - -# setGroupRolePermissions -Sets permissions for a role in a group. - - -## Parameters -| Name | Type | Description | -| :---------- | :------------------- | :----------------------------------------- | -| groupId | GroupId | The id of the group. | -| roleSetId | RoleSetId | The id of the role to set permissions for. | -| permissions | GroupRolePermissions | An object of permissions to set. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.setGroupRolePermissions({ - groupId: 5850082, - roleSetId: 38353813, - permissions: { viewStatus: true }, -}); -``` - -## Endpoint -```ansi -PATCH /v1/groups/{groupId}/roles/{roleSetId}/permissions -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/setGroupSettings.md b/docs_site/pages/classic/groups/setGroupSettings.md deleted file mode 100644 index be98ae9..0000000 --- a/docs_site/pages/classic/groups/setGroupSettings.md +++ /dev/null @@ -1,33 +0,0 @@ - -# setGroupSettings -Sets settings for a group. - - -## Parameters -| Name | Type | Description | -| :---------- | :---------------- | :------------------------------ | -| groupId | Identifier | The id of the group. | -| newSettings | GroupSettingsData | The new settings for the group. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.setGroupSettings({ - groupId: 5850082, - newSettings: { - isApprovalRequired: true, - isBuildersClubRequired: false, - areEnemiesAllowed: true, - areGroupFundsVisible: false, - areGroupGamesVisible: true, - isGroupNameChangeEnabled: true, - }, -}); -``` - -## Endpoint -```ansi -PATCH /v1/groups/{groupId}/settings -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/setGroupShout.md b/docs_site/pages/classic/groups/setGroupShout.md deleted file mode 100644 index 07fab7f..0000000 --- a/docs_site/pages/classic/groups/setGroupShout.md +++ /dev/null @@ -1,23 +0,0 @@ - -# setGroupShout -Sets group shout (status). - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :---------------------------------------- | -| groupId | Identifier | The id of the group to set the shout for. | -| message | | The content of the new shout. | - - - -## Example -```js copy showLineNumbers -const { data: newShout } = await ClassicGroupsApi.setGroupShout({ groupId: 5850082, newShout: "Hello World!" }); -``` - -## Endpoint -```ansi -PATCH /v1/groups/{groupId}/status -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/updateGroupMemberRole.md b/docs_site/pages/classic/groups/updateGroupMemberRole.md deleted file mode 100644 index d10a58f..0000000 --- a/docs_site/pages/classic/groups/updateGroupMemberRole.md +++ /dev/null @@ -1,28 +0,0 @@ - -# updateGroupMemberRole -Changes a members' role in a group. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :------------------------------------- | -| groupId | Identifier | The id of the group | -| userId | Identifier | The id of the user to change role for. | -| roleId | Identifier | The id of the role. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicGroupsApi.updateGroupMemberRole({ - groupId: 5850082, - userId: 2655994471, - roleId: 38354760, -}); -``` - -## Endpoint -```ansi -PATCH /v1/groups/{groupId}/users/{userId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/groups/updateGroupSocialLink.md b/docs_site/pages/classic/groups/updateGroupSocialLink.md deleted file mode 100644 index 4a21ced..0000000 --- a/docs_site/pages/classic/groups/updateGroupSocialLink.md +++ /dev/null @@ -1,31 +0,0 @@ - -# updateGroupSocialLink -Updates an existing social link. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :------------------------------------------- | -| groupId | Identifier | The id of the group to add a social link to. | -| newSocial | NewSocial | The social link request data. | - - - -## Example -```js copy showLineNumbers -const { data: updatedSocial } = await ClassicGroupsApi.updateGroupSocialLink({ - groupId: 5850082, - socialLinkId: addedSocial.id, - newSocial: { - type: "Twitch", - title: "Follow My Twitch lol", - url: "https://twitch.tv/fooBar", - }, -}); -``` - -## Endpoint -```ansi -PATCH /v1/groups/{groupId}/social-links/{socialLinkId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/premiumFeatures/_meta.json b/docs_site/pages/classic/premiumFeatures/_meta.json deleted file mode 100644 index a064378..0000000 --- a/docs_site/pages/classic/premiumFeatures/_meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "userHasPremium": "userHasPremium" -} \ No newline at end of file diff --git a/docs_site/pages/classic/premiumFeatures/userHasPremium.md b/docs_site/pages/classic/premiumFeatures/userHasPremium.md deleted file mode 100644 index 0df55b4..0000000 --- a/docs_site/pages/classic/premiumFeatures/userHasPremium.md +++ /dev/null @@ -1,22 +0,0 @@ - -# userHasPremium -Gets the followers count for a specific user. - - -## Parameters -| Name | Type | Description | -| :----- | :--------- | :------------------------------------------------ | -| userId | Identifier | The id of the user to get the follower count for. | - - - -## Example -```js copy showLineNumbers -const { data: hasPremium } = await ClassicPremiumFeaturesApi.userHasPremium({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/validate-membership -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/subscriptions/_meta.json b/docs_site/pages/classic/subscriptions/_meta.json deleted file mode 100644 index 10b6e99..0000000 --- a/docs_site/pages/classic/subscriptions/_meta.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "createSubscription": "createSubscription", - "setSubscriptionIcon": "setSubscriptionIcon", - "subscriptionsForUniverse": "subscriptionsForUniverse", - "subscriptionInfo": "subscriptionInfo", - "subscriptionsPriceTiersForUniverse": "subscriptionsPriceTiersForUniverse", - "authenticatedUserSubscriptionsPermissionsForUniverse": "authenticatedUserSubscriptionsPermissionsForUniverse" -} \ No newline at end of file diff --git a/docs_site/pages/classic/subscriptions/authenticatedUserSubscriptionsPermissionsForUniverse.md b/docs_site/pages/classic/subscriptions/authenticatedUserSubscriptionsPermissionsForUniverse.md deleted file mode 100644 index 2bcd606..0000000 --- a/docs_site/pages/classic/subscriptions/authenticatedUserSubscriptionsPermissionsForUniverse.md +++ /dev/null @@ -1,24 +0,0 @@ - -# authenticatedUserSubscriptionsPermissionsForUniverse -Gets permissions the authenticated user can perform of a specified universes subscriptions. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :---------------------------------------------------------- | -| universeId | Identifier | The id of the universe to get subscription permissions for. | - - - -## Example -```js copy showLineNumbers -const { data: perms } = await ClassicSubscriptionsApi.authenticatedUserSubscriptionsPermissionsForUniverse({ - universeId: 5795192361, -}); -``` - -## Endpoint -```ansi -GET /v1/experiences/{universeId}/experience-subscriptions/permission -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/subscriptions/createSubscription.md b/docs_site/pages/classic/subscriptions/createSubscription.md deleted file mode 100644 index 105e969..0000000 --- a/docs_site/pages/classic/subscriptions/createSubscription.md +++ /dev/null @@ -1,32 +0,0 @@ - -# createSubscription -Creates a subscription for a specified universe. - - -## Parameters -| Name | Type | Description | -| :---------- | :--------------- | :--------------------------------------------------- | -| universeId | UniverseId | The id of the universe to create a subscription for. | -| name | Name | The subscription name. | -| description | Description | The subscription description. | -| type | Type | The subscription type. | -| price | SubsriptionPrice | The subscription price. | - - - -## Example -```js copy showLineNumbers -const { data } = await ClassicSubscriptionsApi.createSubscription({ - universeId: 5795192361, - name: "Cool Subscription", - description: "Lorem ipsum dolor sit amet.", - type: "Durable", - price: "$7.99", -}); -``` - -## Endpoint -```ansi -POST /v1/experiences/{universeId}/experience-subscriptions -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/subscriptions/setSubscriptionIcon.md b/docs_site/pages/classic/subscriptions/setSubscriptionIcon.md deleted file mode 100644 index 28d182a..0000000 --- a/docs_site/pages/classic/subscriptions/setSubscriptionIcon.md +++ /dev/null @@ -1,27 +0,0 @@ - -# setSubscriptionIcon -Sets the icon of a subscription. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :--------------------------------------------------- | -| universeId | Identifier | The id of the universe to create a subscription for. | - - - -## Example -```js copy showLineNumbers -const { data: success } = await ClassicSubscriptionsApi.setSubscriptionIcon({ - universeId: 5795192361, - subscriptionId: "3656348821302804581", - actingUserId: 45348281, - icon: "./src/image.png", -}); -``` - -## Endpoint -```ansi -POST /v1/experiences/{universeId}/experience-subscriptions/{subscriptionId}/upload-image -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/subscriptions/subscriptionInfo.md b/docs_site/pages/classic/subscriptions/subscriptionInfo.md deleted file mode 100644 index fbc52ce..0000000 --- a/docs_site/pages/classic/subscriptions/subscriptionInfo.md +++ /dev/null @@ -1,26 +0,0 @@ - -# subscriptionInfo -Gets information about a subscription for a specified universe. - - -## Parameters -| Name | Type | Description | -| :------------- | :------------- | :--------------------------------- | -| universeId | UniverseId | The id of the universe. | -| subscriptionId | SubscriptionId | The id of the subscription to get. | - - - -## Example -```js copy showLineNumbers -const { data: subscription } = await ClassicSubscriptionsApi.subscriptionInfo({ - universeId: 5795192361, - subscriptionId: "3656348821302804581", -}); -``` - -## Endpoint -```ansi -GET /v1/experiences/{universeId}/experience-subscriptions/{subscriptionId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/subscriptions/subscriptionsForUniverse.md b/docs_site/pages/classic/subscriptions/subscriptionsForUniverse.md deleted file mode 100644 index 716d7bb..0000000 --- a/docs_site/pages/classic/subscriptions/subscriptionsForUniverse.md +++ /dev/null @@ -1,24 +0,0 @@ - -# subscriptionsForUniverse -Lists subscriptions for a specified universe. - - -## Parameters -| Name | Type | Description | -| :------------- | :--------- | :--------------------------------------------------- | -| universeId | UniverseId | The id of the universe to create a subscription for. | -| resultsPerPage | ? | The number of results to show per page. | -| cursor | ? | A pagination cursor for the next or previous page. | - - - -## Example -```js copy showLineNumbers -undefined -``` - -## Endpoint -```ansi -GET /v1/experiences/{universeId}/experience-subscriptions -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/subscriptions/subscriptionsPriceTiersForUniverse.md b/docs_site/pages/classic/subscriptions/subscriptionsPriceTiersForUniverse.md deleted file mode 100644 index ab27ecb..0000000 --- a/docs_site/pages/classic/subscriptions/subscriptionsPriceTiersForUniverse.md +++ /dev/null @@ -1,22 +0,0 @@ - -# subscriptionsPriceTiersForUniverse -Gets all of the availible price tiers that a universe's subscriptions can have. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :---------------------- | -| universeId | Identifier | The id of the universe. | - - - -## Example -```js copy showLineNumbers -const { data: tiers } = await ClassicSubscriptionsApi.subscriptionsPriceTiersForUniverse({ universeId: 5795192361 }); -``` - -## Endpoint -```ansi -GET /v1/experiences/{universeId}/experience-subscriptions/prices -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/talent/_meta.json b/docs_site/pages/classic/talent/_meta.json deleted file mode 100644 index c4a6faf..0000000 --- a/docs_site/pages/classic/talent/_meta.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "creatorProfile": "creatorProfile", - "creatorExperiences": "creatorExperiences", - "creatorIsIdVerified": "creatorIsIdVerified", - "jobSearch": "jobSearch" -} \ No newline at end of file diff --git a/docs_site/pages/classic/talent/creatorExperiences.md b/docs_site/pages/classic/talent/creatorExperiences.md deleted file mode 100644 index 3327ac5..0000000 --- a/docs_site/pages/classic/talent/creatorExperiences.md +++ /dev/null @@ -1,25 +0,0 @@ - -# creatorExperiences -Gets someones work history (experiences / games) from their talent hub profile. - - -## Parameters -| Name | Type | Description | -| :-------- | :----- | :------------------------------------------------- | -| userId | UserId | The id of the user to get verification info about. | -| sortOrder | ? | The order the results are sorted it. | -| limit | ? | The number of results to be returned | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: experiences } = await ClassicTalentApi.creatorExperiences({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/experiences -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/talent/creatorIsIdVerified.md b/docs_site/pages/classic/talent/creatorIsIdVerified.md deleted file mode 100644 index ae9548b..0000000 --- a/docs_site/pages/classic/talent/creatorIsIdVerified.md +++ /dev/null @@ -1,22 +0,0 @@ - -# creatorIsIdVerified -Gets ID verification status for a user that has a public talent hub profile. - - -## Parameters -| Name | Type | Description | -| :----- | :----- | :------------------------------------------------- | -| userId | UserId | The id of the user to get verification info about. | - - - -## Example -```js copy showLineNumbers -const { data: isIdVerified } = await ClassicTalentApi.creatorIsIdVerified({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/verification -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/talent/creatorProfile.md b/docs_site/pages/classic/talent/creatorProfile.md deleted file mode 100644 index 058f1eb..0000000 --- a/docs_site/pages/classic/talent/creatorProfile.md +++ /dev/null @@ -1,22 +0,0 @@ - -# creatorProfile -Gets profile information about someones talent hub profile. - - -## Parameters -| Name | Type | Description | -| :----- | :----- | :------------------------------------------------- | -| userId | UserId | The id of the user to get verification info about. | - - - -## Example -```js copy showLineNumbers -const { data: profile } = await ClassicTalentApi.creatorProfile({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/profile -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/talent/jobSearch.md b/docs_site/pages/classic/talent/jobSearch.md deleted file mode 100644 index d37b9ba..0000000 --- a/docs_site/pages/classic/talent/jobSearch.md +++ /dev/null @@ -1,25 +0,0 @@ - -# jobSearch -Searches talent hub job posts. - - -## Parameters -| Name | Type | Description | -| :----- | :---- | :------------------------------------------------------------ | -| query | ? | The query to search for. | -| limit | ? | The maxium amount of items to return. | -| filter | ? | Filter the returned job posts to match specific requirements. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: jobSearchData } = await ClassicTalentApi.jobSearch({ query: "simulator", limit: 1, cursor: 1 }); -``` - -## Endpoint -```ansi -GET /v1/search/jobs -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/thumbnails/_meta.json b/docs_site/pages/classic/thumbnails/_meta.json deleted file mode 100644 index 4a4335c..0000000 --- a/docs_site/pages/classic/thumbnails/_meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "gamesThumbnails": "gamesThumbnails", - "gamesIcons": "gamesIcons" -} \ No newline at end of file diff --git a/docs_site/pages/classic/thumbnails/gamesIcons.md b/docs_site/pages/classic/thumbnails/gamesIcons.md deleted file mode 100644 index ae231b0..0000000 --- a/docs_site/pages/classic/thumbnails/gamesIcons.md +++ /dev/null @@ -1,15 +0,0 @@ - -# gamesIcons - - - -## Example -```js copy showLineNumbers -undefined -``` - -## Endpoint -```ansi - -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/thumbnails/gamesThumbnails.md b/docs_site/pages/classic/thumbnails/gamesThumbnails.md deleted file mode 100644 index 49f5674..0000000 --- a/docs_site/pages/classic/thumbnails/gamesThumbnails.md +++ /dev/null @@ -1,27 +0,0 @@ - -# gamesThumbnails -Gets thumbnail(s) for multiple games. - - -## Parameters -| Name | Type | Description | -| :--------------- | :------------------------ | :--------------------------------------------------------------- | -| universeIds | ArrayNonEmpty | The ids of the universe to get thumbnails for. | -| countPerUniverse | ? | The amount of thumbnails to return for each universe | -| defaults | ? | True if defaults (if any) should be returned if no media exists. | -| size | ? | The thumbnails size (formatted as {width}x{height}). | -| format | ? | Specifies the format of the thumbnails. | -| isCircular | ? | Dictates if the thumbnails should be masked by a circle. | - - - -## Example -```js copy showLineNumbers -const { data: gamesThumbnails } = await ClassicThumbnailsApi.gamesThumbnails({ universeIds: [1685831367] }); -``` - -## Endpoint -```ansi -GET /v1/games/multiget/thumbnails -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/universes/_meta.json b/docs_site/pages/classic/universes/_meta.json deleted file mode 100644 index 2327068..0000000 --- a/docs_site/pages/classic/universes/_meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "universeIdFromPlaceId": "universeIdFromPlaceId" -} \ No newline at end of file diff --git a/docs_site/pages/classic/universes/universeIdFromPlaceId.md b/docs_site/pages/classic/universes/universeIdFromPlaceId.md deleted file mode 100644 index fec1421..0000000 --- a/docs_site/pages/classic/universes/universeIdFromPlaceId.md +++ /dev/null @@ -1,22 +0,0 @@ - -# universeIdFromPlaceId -Gets the parent universe Id from a place Id. - - -## Parameters -| Name | Type | Description | -| :------ | :--------- | :---------------------------------------------- | -| placeId | Identifier | The id of the place to get the universe id for. | - - - -## Example -```js copy showLineNumbers -const { data: universeId } = await ClassicUniversesApi.universeIdFromPlaceId({ placeId: 16349154726 }); -``` - -## Endpoint -```ansi -GET /v1/places/{placeId}/universe -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/_meta.json b/docs_site/pages/classic/users/_meta.json deleted file mode 100644 index cf63d78..0000000 --- a/docs_site/pages/classic/users/_meta.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "authenticatedUserBirthdate": "authenticatedUserBirthdate", - "authenticatedUserDescription": "authenticatedUserDescription", - "authenticatedUserGender": "authenticatedUserGender", - "validateDisplayNameForNewUser": "validateDisplayNameForNewUser", - "validateDisplayNameForExistingUser": "validateDisplayNameForExistingUser", - "authenticatedUserSetDisplayName": "authenticatedUserSetDisplayName", - "userInfo": "userInfo", - "authenticatedUserInfo": "authenticatedUserInfo", - "authenticatedUserAgeBracket": "authenticatedUserAgeBracket", - "authenticatedUserCountryCode": "authenticatedUserCountryCode", - "authenticatedUserRoles": "authenticatedUserRoles", - "usernamesToUsersInfo": "usernamesToUsersInfo", - "userIdsToUsersInfo": "userIdsToUsersInfo", - "usernameHistory": "usernameHistory", - "userSearch": "userSearch" -} \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserAgeBracket.md b/docs_site/pages/classic/users/authenticatedUserAgeBracket.md deleted file mode 100644 index 157309d..0000000 --- a/docs_site/pages/classic/users/authenticatedUserAgeBracket.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserAgeBracket -Gets the currently authenticated user's age bracket. - - - -## Example -```js copy showLineNumbers -const { data: ageBracket } = await ClassicUsersApi.authenticatedUserAgeBracket(); -``` - -## Endpoint -```ansi -GET /v1/users/authenticated/age-bracket -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserBirthdate.md b/docs_site/pages/classic/users/authenticatedUserBirthdate.md deleted file mode 100644 index 13c8f27..0000000 --- a/docs_site/pages/classic/users/authenticatedUserBirthdate.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserBirthdate -Gets the birthdate for the currently authenticated user. - - - -## Example -```js copy showLineNumbers -const { data: birthdate } = await ClassicUsersApi.authenticatedUserBirthdate(); -``` - -## Endpoint -```ansi -GET /v1/birthdate -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserCountryCode.md b/docs_site/pages/classic/users/authenticatedUserCountryCode.md deleted file mode 100644 index 3ec2fd7..0000000 --- a/docs_site/pages/classic/users/authenticatedUserCountryCode.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserCountryCode -Gets the currently authenticated user's country code. - - - -## Example -```js copy showLineNumbers -const { data: countryCode } = await ClassicUsersApi.authenticatedUserCountryCode(); -``` - -## Endpoint -```ansi -GET /v1/users/authenticated/country-code -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserDescription.md b/docs_site/pages/classic/users/authenticatedUserDescription.md deleted file mode 100644 index 4b96583..0000000 --- a/docs_site/pages/classic/users/authenticatedUserDescription.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserDescription -Gets the description for the currently authenticated user. - - - -## Example -```js copy showLineNumbers -const { data: description } = await ClassicUsersApi.authenticatedUserDescription(); -``` - -## Endpoint -```ansi -GET /v1/description -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserGender.md b/docs_site/pages/classic/users/authenticatedUserGender.md deleted file mode 100644 index b7b95f0..0000000 --- a/docs_site/pages/classic/users/authenticatedUserGender.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserGender -Gets the gender for the currently authenticated user. - - - -## Example -```js copy showLineNumbers -const { data: description } = await ClassicUsersApi.authenticatedUserGender(); -``` - -## Endpoint -```ansi -GET /v1/gender -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserInfo.md b/docs_site/pages/classic/users/authenticatedUserInfo.md deleted file mode 100644 index 9a3c436..0000000 --- a/docs_site/pages/classic/users/authenticatedUserInfo.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserInfo -Gets information about the currently authenticated user. - - - -## Example -```js copy showLineNumbers -const { data: userInfo } = await ClassicUsersApi.authenticatedUserInfo(); -``` - -## Endpoint -```ansi -GET /v1/users/authenticated -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserRoles.md b/docs_site/pages/classic/users/authenticatedUserRoles.md deleted file mode 100644 index 9656ea0..0000000 --- a/docs_site/pages/classic/users/authenticatedUserRoles.md +++ /dev/null @@ -1,16 +0,0 @@ - -# authenticatedUserRoles -Gets the currently authenticated user's roles. - - - -## Example -```js copy showLineNumbers -const { data: roles } = await ClassicUsersApi.authenticatedUserRoles(); -``` - -## Endpoint -```ansi -GET /v1/users/authenticated/roles -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/authenticatedUserSetDisplayName.md b/docs_site/pages/classic/users/authenticatedUserSetDisplayName.md deleted file mode 100644 index bb1e78f..0000000 --- a/docs_site/pages/classic/users/authenticatedUserSetDisplayName.md +++ /dev/null @@ -1,26 +0,0 @@ - -# authenticatedUserSetDisplayName -Sets the display name for the currently authenticated user. - - -## Parameters -| Name | Type | Description | -| :------------- | :--------- | :--------------------------------------------------------------------------------------- | -| newDisplayName | string | The new display name for the authenticated user. | -| userId | Identifier | The id of the currently authenticated user (the endpoint requires this for some reason). | - - - -## Example -```js copy showLineNumbers -const { data: displayNameUpdated } = await ClassicUsersApi.authenticatedUserSetDisplayName({ - userId: 45348281, - newDisplayName: "LoremIpsum", -}); -``` - -## Endpoint -```ansi -PATCH /v1/users/{userId}/display-names -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/userIdsToUsersInfo.md b/docs_site/pages/classic/users/userIdsToUsersInfo.md deleted file mode 100644 index d0968a6..0000000 --- a/docs_site/pages/classic/users/userIdsToUsersInfo.md +++ /dev/null @@ -1,23 +0,0 @@ - -# userIdsToUsersInfo -Gets information about multiple users from their ids. - - -## Parameters -| Name | Type | Description | -| :----------------- | :-------------------- | :-------------------------------------------------------------------------------------------------- | -| userIds | ArrayNonEmpty | The ids of the users to get info about. | -| excludeBannedUsers | ? | Dictates if info about banned users should be excluded from the returned data. (defaults to false). | - - - -## Example -```js copy showLineNumbers -const { data: usersInfo } = await ClassicUsersApi.userIdsToUsersInfo({ userIds: [45348281] }); -``` - -## Endpoint -```ansi -POST /v1/users -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/userInfo.md b/docs_site/pages/classic/users/userInfo.md deleted file mode 100644 index 1f5b016..0000000 --- a/docs_site/pages/classic/users/userInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# userInfo -Gets information about a user from their id. - - -## Parameters -| Name | Type | Description | -| :----- | :----- | :--------------------------------------------- | -| userId | UserId | The id of the user to get detailed info about. | - - - -## Example -```js copy showLineNumbers -const { data: userInfo } = await ClassicUsersApi.userInfo({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId} -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/userSearch.md b/docs_site/pages/classic/users/userSearch.md deleted file mode 100644 index 9f38f3a..0000000 --- a/docs_site/pages/classic/users/userSearch.md +++ /dev/null @@ -1,24 +0,0 @@ - -# userSearch -Searched for users. - - -## Parameters -| Name | Type | Description | -| :------ | :----- | :----------------------------------------------- | -| keyword | string | The keyword to search users by. | -| limit | ? | The number of results to be returned | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: searchResults } = await ClassicUsersApi.userSearch({ keyword: "MightyPart", limit: 10 }); -``` - -## Endpoint -```ansi -GET /v1/users/search -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/usernameHistory.md b/docs_site/pages/classic/users/usernameHistory.md deleted file mode 100644 index ef529cc..0000000 --- a/docs_site/pages/classic/users/usernameHistory.md +++ /dev/null @@ -1,25 +0,0 @@ - -# usernameHistory -Gets a users previous usernames. - - -## Parameters -| Name | Type | Description | -| :-------- | :--------- | :-------------------------------------------------- | -| userId | Identifier | The id of the user to get the username history for. | -| limit | ? | The number of results to be returned. | -| sortOrder | ? | The order that the results are sorted in. | -| cursor | ? | The paging cursor for the previous or next page. | - - - -## Example -```js copy showLineNumbers -const { data: previousUsernames } = await ClassicUsersApi.usernameHistory({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/username-history -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/usernamesToUsersInfo.md b/docs_site/pages/classic/users/usernamesToUsersInfo.md deleted file mode 100644 index 239fc54..0000000 --- a/docs_site/pages/classic/users/usernamesToUsersInfo.md +++ /dev/null @@ -1,23 +0,0 @@ - -# usernamesToUsersInfo -Gets information about multiple users from their usernames. - - -## Parameters -| Name | Type | Description | -| :----------------- | :---------------------- | :-------------------------------------------------------------------------------------------------- | -| usernames | ArrayNonEmpty | The usernames of the users to get info about. | -| excludeBannedUsers | ? | Dictates if info about banned users should be excluded from the returned data. (defaults to false). | - - - -## Example -```js copy showLineNumbers -const { data: usersInfo } = await ClassicUsersApi.usernamesToUsersInfo({ usernames: ["MightyPart"] }); -``` - -## Endpoint -```ansi -POST /v1/usernames/users -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/validateDisplayNameForExistingUser.md b/docs_site/pages/classic/users/validateDisplayNameForExistingUser.md deleted file mode 100644 index 7f182e2..0000000 --- a/docs_site/pages/classic/users/validateDisplayNameForExistingUser.md +++ /dev/null @@ -1,26 +0,0 @@ - -# validateDisplayNameForExistingUser -Validates a display name for an existing user (NOTE: This does not change the display name). - - -## Parameters -| Name | Type | Description | -| :---------- | :--------- | :-------------------------------- | -| displayName | string | The display name to be validated. | -| userId | Identifier | The id of the existing user. | - - - -## Example -```js copy showLineNumbers -const { data: displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForExistingUser({ - userId: 45348281, - displayName: "Hello", -}); -``` - -## Endpoint -```ansi -GET /v1/users/{userId}/display-names/validate -``` - \ No newline at end of file diff --git a/docs_site/pages/classic/users/validateDisplayNameForNewUser.md b/docs_site/pages/classic/users/validateDisplayNameForNewUser.md deleted file mode 100644 index 8f0e936..0000000 --- a/docs_site/pages/classic/users/validateDisplayNameForNewUser.md +++ /dev/null @@ -1,26 +0,0 @@ - -# validateDisplayNameForNewUser -Validates a display name for a new user (NOTE: This does not change the display name). - - -## Parameters -| Name | Type | Description | -| :---------- | :------------------ | :-------------------------------- | -| displayName | string | The display name to be validated. | -| birthdate | ISODateTime \| Date | The birthdate of the new user. | - - - -## Example -```js copy showLineNumbers -const { data: displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ - displayName: "Hello", - birthdate: "2023-07-27T04:14:57+0000", -}); -``` - -## Endpoint -```ansi -GET /v1/display-names/validate -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/_meta.json b/docs_site/pages/cloud/_meta.json deleted file mode 100644 index 39736a3..0000000 --- a/docs_site/pages/cloud/_meta.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "creatorStore": "CreatorStoreApi", - "experiences": "ExperiencesApi", - "groups": "GroupsApi", - "inventory": "InventoryApi", - "memoryStore": "MemoryStoreApi", - "messaging": "MessagingApi", - "subscriptions": "SubscriptionsApi", - "users": "UsersApi" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/creatorStore/_meta.json b/docs_site/pages/cloud/creatorStore/_meta.json deleted file mode 100644 index a9af616..0000000 --- a/docs_site/pages/cloud/creatorStore/_meta.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "creatorStoreProductInfo": "creatorStoreProductInfo", - "createCreatorStoreProduct": "createCreatorStoreProduct", - "updateCreatorStoreProduct": "updateCreatorStoreProduct" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/creatorStore/createCreatorStoreProduct.md b/docs_site/pages/cloud/creatorStore/createCreatorStoreProduct.md deleted file mode 100644 index 4844cec..0000000 --- a/docs_site/pages/cloud/creatorStore/createCreatorStoreProduct.md +++ /dev/null @@ -1,24 +0,0 @@ - -# createCreatorStoreProduct -Creates a creator store product (doesnt work atm for some reason). - - -## Parameters -| Name | Type | Description | -| :---------- | :---- | :-------------------------------- | -| displayName | | The display name for the product. | -| description | | The description for the product. | -| basePrice | | basePrice | - - - -## Example -```js copy showLineNumbers - -``` - -## Endpoint -```ansi -POST /v2/creator-store-products -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/creatorStore/creatorStoreProductInfo.md b/docs_site/pages/cloud/creatorStore/creatorStoreProductInfo.md deleted file mode 100644 index 4e82a92..0000000 --- a/docs_site/pages/cloud/creatorStore/creatorStoreProductInfo.md +++ /dev/null @@ -1,27 +0,0 @@ - -# creatorStoreProductInfo - - -## Parameters -| Name | Type | Description | -| :---------------- | :---- | :---------------------------------------------------------------- | -| modelAssetId | | Use this if the creator product you are getting is a model. | -| pluginAssetId | | Use this if the creator product you are getting is a plugin. | -| audioAssetId | | Use this if the creator product you are getting is an audio. | -| decalAssetId | | Use this if the creator product you are getting is a decal. | -| meshPartAssetId | | Use this if the creator product you are getting is a mesh part. | -| videoAssetId | | Use this if the creator product you are getting is a video. | -| fontFamilyAssetId | | Use this if the creator product you are getting is a font family. | - - - -## Example -```js copy showLineNumbers -const { data: productInfo } = await CreatorStoreApi.creatorStoreProductInfo({ modelAssetId: 16989381169 }); -``` - -## Endpoint -```ansi -GET /v2/creator-store-products/{productId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/creatorStore/updateCreatorStoreProduct.md b/docs_site/pages/cloud/creatorStore/updateCreatorStoreProduct.md deleted file mode 100644 index 47c3b56..0000000 --- a/docs_site/pages/cloud/creatorStore/updateCreatorStoreProduct.md +++ /dev/null @@ -1,15 +0,0 @@ - -# updateCreatorStoreProduct - - - -## Example -```js copy showLineNumbers -undefined -``` - -## Endpoint -```ansi - -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/experiences/_meta.json b/docs_site/pages/cloud/experiences/_meta.json deleted file mode 100644 index 4d6d080..0000000 --- a/docs_site/pages/cloud/experiences/_meta.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "universeInfo": "universeInfo", - "updateUniverse": "updateUniverse", - "restartUniverseServers": "restartUniverseServers", - "placeInfo": "placeInfo", - "updatePlace": "updatePlace" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/experiences/placeInfo.md b/docs_site/pages/cloud/experiences/placeInfo.md deleted file mode 100644 index e665099..0000000 --- a/docs_site/pages/cloud/experiences/placeInfo.md +++ /dev/null @@ -1,23 +0,0 @@ - -# placeInfo -Gets information about a universes place. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :----------------------------------------------------- | -| universeId | UniverseId | The id of the universe to get place information about. | -| placeId | PlaceId | The id of the place to get information about. | - - - -## Example -```js copy showLineNumbers -const { data: placeInfo } = await ExperiencesApi.placeInfo({ universeId: 5795192361, placeId: 16866553538 }); -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId}/{placeId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/experiences/restartUniverseServers.md b/docs_site/pages/cloud/experiences/restartUniverseServers.md deleted file mode 100644 index ece7940..0000000 --- a/docs_site/pages/cloud/experiences/restartUniverseServers.md +++ /dev/null @@ -1,22 +0,0 @@ - -# restartUniverseServers -Restarts all currently running servers for a given universe. Used for releasing experience updates. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :--------------------------------------------- | -| universeId | UniverseId | The id of the universe to restart servers for. | - - - -## Example -```js copy showLineNumbers -await ExperiencesApi.restartUniverseServers({ universeId: 5795192361 }); -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/experiences/universeInfo.md b/docs_site/pages/cloud/experiences/universeInfo.md deleted file mode 100644 index 5e26534..0000000 --- a/docs_site/pages/cloud/experiences/universeInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# universeInfo -Gets information about a universe. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :----------------------------------------------- | -| universeId | UniverseId | The id of the universe to get information about. | - - - -## Example -```js copy showLineNumbers -const { data: universeInfo } = await ExperiencesApi.universeInfo({ universeId: 5795192361 }); -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/experiences/updatePlace.md b/docs_site/pages/cloud/experiences/updatePlace.md deleted file mode 100644 index d51cb53..0000000 --- a/docs_site/pages/cloud/experiences/updatePlace.md +++ /dev/null @@ -1,28 +0,0 @@ - -# updatePlace -Updates a places information. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :------------------------------------------------------ | -| universeId | UniverseId | The id of the universe to update place information for. | -| placeId | PlaceId | The id of the place to update. | -| newData | NewData | the updated place information. | - - - -## Example -```js copy showLineNumbers -const { data: updatedInfo } = await ExperiencesApi.updatePlace({ - universeId: 5795192361, - placeId: 16866553538, - newData: { displayName: "Hello World" }, -}); -``` - -## Endpoint -```ansi -PATCH /v2/universes/{universeId}/places/{PlaceId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/experiences/updateUniverse.md b/docs_site/pages/cloud/experiences/updateUniverse.md deleted file mode 100644 index 4bd4d56..0000000 --- a/docs_site/pages/cloud/experiences/updateUniverse.md +++ /dev/null @@ -1,26 +0,0 @@ - -# updateUniverse -Updates a universes information. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :-------------------------------- | -| universeId | UniverseId | The id of the universe to update. | -| newData | NewData | the updated universe information. | - - - -## Example -```js copy showLineNumbers -const { data: updatedData } = await ExperiencesApi.updateUniverse({ - universeId: 5795192361, - newData: { displayName: "Lorem Ipsum", visibility: "PRIVATE" }, -}); -``` - -## Endpoint -```ansi -PATCH /v2/universes/{universeId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/groups/_meta.json b/docs_site/pages/cloud/groups/_meta.json deleted file mode 100644 index 8708efa..0000000 --- a/docs_site/pages/cloud/groups/_meta.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "groupInfo": "groupInfo", - "groupJoinRequests": "groupJoinRequests", - "groupMembers": "groupMembers", - "groupRoles": "groupRoles", - "groupShout": "groupShout" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/groups/groupInfo.md b/docs_site/pages/cloud/groups/groupInfo.md deleted file mode 100644 index 65c3531..0000000 --- a/docs_site/pages/cloud/groups/groupInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# groupInfo -Gets information about a user from their id. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :------------------------------------- | -| groupId | GroupId | The id of the group to get info about. | - - - -## Example -```js copy showLineNumbers -const { data: groupInfo } = await GroupsApi.groupInfo({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v2/groups/{groupId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/groups/groupJoinRequests.md b/docs_site/pages/cloud/groups/groupJoinRequests.md deleted file mode 100644 index e4547c7..0000000 --- a/docs_site/pages/cloud/groups/groupJoinRequests.md +++ /dev/null @@ -1,25 +0,0 @@ - -# groupJoinRequests -Gets join requests for a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| groupId | GroupId | The id of the group to get join requests for. | -| limit | ? | The maximum number of group join requests to return. The service might return fewer than this value. If unspecified, at most 10 group join requests are returned. The maximum value is 20 and higher values are set to 20. | -| filter | ? | This field may be set in order to filter the resources returned. | -| cursor | ? | A page token, received from a previous call, to retrieve a subsequent page. | - - - -## Example -```js copy showLineNumbers -const { data: joinRequests } = await GroupsApi.groupJoinRequests({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v2/groups/{groupId}/join-requests -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/groups/groupMembers.md b/docs_site/pages/cloud/groups/groupMembers.md deleted file mode 100644 index 41a8d26..0000000 --- a/docs_site/pages/cloud/groups/groupMembers.md +++ /dev/null @@ -1,25 +0,0 @@ - -# groupMembers -Gets join requests for a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| groupId | GroupId | The id of the group to get join requests for. | -| limit | ? | The maximum number of group memberships to return. The service might return fewer than this value. If unspecified, at most 10 group memberships are returned. The maximum value is 100 and higher values are set to 100. | -| filter | ? | This field may be set in order to filter the resources returned. | -| cursor | ? | A page token, received from a previous call, to retrieve a subsequent page. | - - - -## Example -```js copy showLineNumbers -const { data: members } = await GroupsApi.groupMembers({ groupId: 5850082, filter: { userId: 45348281 } }); -``` - -## Endpoint -```ansi -GET /v2/groups/{groupId}/memberships -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/groups/groupRoles.md b/docs_site/pages/cloud/groups/groupRoles.md deleted file mode 100644 index 55cf60b..0000000 --- a/docs_site/pages/cloud/groups/groupRoles.md +++ /dev/null @@ -1,24 +0,0 @@ - -# groupRoles -Gets roles for a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| groupId | GroupId | The id of the group to get roles for. | -| limit | ? | The maximum number of group roles to return. The service might return fewer than this value. If unspecified, at most 10 group roles are returned. The maximum value is 20 and higher values are set to 20. | -| cursor | ? | A page token, received from a previous call, to retrieve a subsequent page. | - - - -## Example -```js copy showLineNumbers -const { data: roles } = await GroupsApi.groupRoles({ groupId: 5850082, limit: 1 }); -``` - -## Endpoint -```ansi -GET /v2/groups/{groupId}/roles -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/groups/groupShout.md b/docs_site/pages/cloud/groups/groupShout.md deleted file mode 100644 index b8498dd..0000000 --- a/docs_site/pages/cloud/groups/groupShout.md +++ /dev/null @@ -1,24 +0,0 @@ - -# groupShout -Gets roles for a group. - - -## Parameters -| Name | Type | Description | -| :------ | :------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| groupId | GroupId | The id of the group to get roles for. | -| limit | | The maximum number of group roles to return. The service might return fewer than this value. If unspecified, at most 10 group roles are returned. The maximum value is 20 and higher values are set to 20. | -| cursor | | A page token, received from a previous call, to retrieve a subsequent page. | - - - -## Example -```js copy showLineNumbers -const { data: shout } = await GroupsApi.groupShout({ groupId: 5850082 }); -``` - -## Endpoint -```ansi -GET /v2/groups/{groupId}/roles -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/inventory/_meta.json b/docs_site/pages/cloud/inventory/_meta.json deleted file mode 100644 index aa21c8a..0000000 --- a/docs_site/pages/cloud/inventory/_meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "inventoryItemsForUser": "inventoryItemsForUser" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/inventory/inventoryItemsForUser.md b/docs_site/pages/cloud/inventory/inventoryItemsForUser.md deleted file mode 100644 index 1ca0ac0..0000000 --- a/docs_site/pages/cloud/inventory/inventoryItemsForUser.md +++ /dev/null @@ -1,28 +0,0 @@ - -# inventoryItemsForUser - - -## Parameters -| Name | Type | Description | -| :----- | :--------- | :----------------------------------------------------------- | -| userId | Identifier | The id of the user to get the inventory items for. | -| limit | ? | The maximum amount of items to return. | -| filter | ? | Filters the returned inventory items by specified criterias. | -| cursor | ? | A paging cursor for a specified page. | - - - -## Example -```js copy showLineNumbers -const { data: inventoryItems } = await InventoryApi.inventoryItemsForUser({ - userId: 45348281, - limit: 3, - filter: { privateServers: true }, -}); -``` - -## Endpoint -```ansi -GET /v2/users/{userId}/inventory-items -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/_meta.json b/docs_site/pages/cloud/memoryStore/_meta.json deleted file mode 100644 index eace7c6..0000000 --- a/docs_site/pages/cloud/memoryStore/_meta.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "sortedMapItem": "sortedMapItem", - "listSortedMapItems": "listSortedMapItems", - "createSortedMapItem": "createSortedMapItem", - "updateSortedMapItem": "updateSortedMapItem", - "deleteSortedMapItem": "deleteSortedMapItem", - "enqueueItem": "enqueueItem", - "readQueueItems": "readQueueItems", - "dequeueItems": "dequeueItems", - "flushAllQueues": "flushAllQueues", - "operationStatus": "operationStatus" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/createSortedMapItem.md b/docs_site/pages/cloud/memoryStore/createSortedMapItem.md deleted file mode 100644 index b8e3266..0000000 --- a/docs_site/pages/cloud/memoryStore/createSortedMapItem.md +++ /dev/null @@ -1,29 +0,0 @@ - -# createSortedMapItem -Creates a sorted map item. - - -## Parameters -| Name | Type | Description | -| :--------- | :------------------------------------------------- | :------------------------------------------------------- | -| universeId | Identifier | The id of the universe to create the sorted map item in. | -| sortedMap | string | The sorted map to create the item in. | -| item | CreateSortedMapItem_ConstructItemConfig | The sorted map item data. | - - - -## Example -```js copy showLineNumbers -type Item = { isReal: boolean }; -const { data } = await MemoryStoresApi.createSortedMapItem({ - universeId: 5243626809, - sortedMap: "MySortedMap", - item: { id: "Testing123", value: { isReal: true }, ttl: "300s", numericSortKey: 1 }, -}); -``` - -## Endpoint -```ansi -POST /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/deleteSortedMapItem.md b/docs_site/pages/cloud/memoryStore/deleteSortedMapItem.md deleted file mode 100644 index 2db5436..0000000 --- a/docs_site/pages/cloud/memoryStore/deleteSortedMapItem.md +++ /dev/null @@ -1,25 +0,0 @@ - -# deleteSortedMapItem -Deletes a sorted map item. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :------------------------------------------------------ | -| universeId | Identifier | The id of the universe to get the sorted map item from. | -| sortedMap | string | The sorted map to get the item from. | -| itemId | string | The id of the item to update. | -| etag | ? | Server generated id for conditional delete. | - - - -## Example -```js copy showLineNumbers -await MemoryStoresApi.deleteSortedMapItem({ universeId: 5243626809, sortedMap: "MySortedMap", itemId: "Testing1234" }); -``` - -## Endpoint -```ansi -DELETE /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items/{itemId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/dequeueItems.md b/docs_site/pages/cloud/memoryStore/dequeueItems.md deleted file mode 100644 index 1021336..0000000 --- a/docs_site/pages/cloud/memoryStore/dequeueItems.md +++ /dev/null @@ -1,28 +0,0 @@ - -# dequeueItems -Dequeues queue items. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :------------------------------------------------------------------------------------------------------------ | -| universeId | Identifier | The id of the universe to remove queue items from. | -| queue | string | Name of the Queue. | -| readId | string | ID returned from a previous Read Queue call. It will discard all items that were read from the previous call. | - - - -## Example -```js copy showLineNumbers -await MemoryStoresApi.dequeueItems({ - universeId: 5243626809, - queue: "MyQueue", - readId: "5cfc27af46da4cf08b41aa9a3d78a75e", -}); -``` - -## Endpoint -```ansi -POST /v2/universes/{universeId}/memory-store/queues/{queue}/items:discard -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/enqueueItem.md b/docs_site/pages/cloud/memoryStore/enqueueItem.md deleted file mode 100644 index 463897f..0000000 --- a/docs_site/pages/cloud/memoryStore/enqueueItem.md +++ /dev/null @@ -1,25 +0,0 @@ - -# enqueueItem -Deletes a sorted map item. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :------------------------------------------------------ | -| universeId | Identifier | The id of the universe to get the sorted map item from. | -| sortedMap | | The sorted map to get the item from. | -| itemId | | The id of the item to update. | -| etag | | Server generated id for conditional delete. | - - - -## Example -```js copy showLineNumbers -await MemoryStoresApi.deleteSortedMapItem({ universeId: 5243626809, sortedMap: "MySortedMap", itemId: "Testing1234" }); -``` - -## Endpoint -```ansi -DELETE /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items/{itemId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/flushAllQueues.md b/docs_site/pages/cloud/memoryStore/flushAllQueues.md deleted file mode 100644 index 64358df..0000000 --- a/docs_site/pages/cloud/memoryStore/flushAllQueues.md +++ /dev/null @@ -1,22 +0,0 @@ - -# flushAllQueues -Removes all items from every queue in a given universe. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :---------------------------------------------------- | -| universeId | UniverseId | The id of the universe to flush all queue items from. | - - - -## Example -```js copy showLineNumbers -const { data: createdOperation } = await MemoryStoresApi.flushAllQueues({ universeId: 5243626809 }); -``` - -## Endpoint -```ansi -POST /v2/universes/${universeId}/memory-store:flush -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/listSortedMapItems.md b/docs_site/pages/cloud/memoryStore/listSortedMapItems.md deleted file mode 100644 index 963f59e..0000000 --- a/docs_site/pages/cloud/memoryStore/listSortedMapItems.md +++ /dev/null @@ -1,30 +0,0 @@ - -# listSortedMapItems -Lists items of a sorted map. - - -## Parameters -| Name | Type | Description | -| :---------- | :--------- | :------------------------------------------------------ | -| universeId | Identifier | The id of the universe to get the sorted map item from. | -| sortedMap | string | The sorted map to get the item from. | -| maxPageSize | ? | The id of the item to get. | -| orderBy | ? | The order of the returned sorted map items. | -| filter | ? | filter returned sorted map items. | - - - -## Example -```js copy showLineNumbers -const { data: items } = await MemoryStoresApi.listSortedMapItems({ - universeId: 5243626809, - sortedMap: "MySortedMap", - maxPageSize: 1, -}); -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/operationStatus.md b/docs_site/pages/cloud/memoryStore/operationStatus.md deleted file mode 100644 index cff6095..0000000 --- a/docs_site/pages/cloud/memoryStore/operationStatus.md +++ /dev/null @@ -1,25 +0,0 @@ - -# operationStatus -Removes all items from every queue in a given universe. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :---------------------------------------------------- | -| universeId | UniverseId | The id of the universe to flush all queue items from. | - - - -## Example -```js copy showLineNumbers -const { data: operation } = await MemoryStoresApi.operationStatus({ - universeId: 5243626809, - operation: "AAUAAAAAAADRMx55T0AKRxSgFCrSusMzqOKQNyVaQz8eMi9t-dwQwQ", -}); -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId}/memory-store/operations/{operation} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/readQueueItems.md b/docs_site/pages/cloud/memoryStore/readQueueItems.md deleted file mode 100644 index b7b56b5..0000000 --- a/docs_site/pages/cloud/memoryStore/readQueueItems.md +++ /dev/null @@ -1,30 +0,0 @@ - -# readQueueItems -Reads queue items. - - -## Parameters -| Name | Type | Description | -| :------------------------- | :--------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- | -| universeId | Identifier | The id of the universe to read queue items from. | -| queue | string | Name of the Queue. | -| limit | ? | Maximum entries to read, Max 200, Default 1. | -| allOrNothing | ? | Whether to read any items if >= count can’t be read. Default false. | -| invisibilityTimeoutSeconds | ? | Invisibility timeout for items read, default 30s. This will make previously read items invisible for the provided duration in the next Read request. | - - - -## Example -```js copy showLineNumbers -type Item = { isReal: boolean }; -const { - data: queueItems, - response: { body }, -} = await MemoryStoresApi.readQueueItems({ universeId: 5243626809, queue: "MyQueue", limit: 2 }); -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId}/memory-store/queues/{queue}/items:read -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/sortedMapItem.md b/docs_site/pages/cloud/memoryStore/sortedMapItem.md deleted file mode 100644 index 120f90e..0000000 --- a/docs_site/pages/cloud/memoryStore/sortedMapItem.md +++ /dev/null @@ -1,29 +0,0 @@ - -# sortedMapItem -Gets a sorted map item. - - -## Parameters -| Name | Type | Description | -| :--------- | :--------- | :------------------------------------------------------ | -| universeId | Identifier | The id of the universe to get the sorted map item from. | -| sortedMap | string | The sorted map to get the item from. | -| itemId | string | The id of the item to get. | - - - -## Example -```js copy showLineNumbers -type Item = { isReal: boolean }; -const { data } = await MemoryStoresApi.sortedMapItem({ - universeId: 5243626809, - sortedMap: "MySortedMap", - itemId: "Testing123", -}); -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items/{itemId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/memoryStore/updateSortedMapItem.md b/docs_site/pages/cloud/memoryStore/updateSortedMapItem.md deleted file mode 100644 index 3e168af..0000000 --- a/docs_site/pages/cloud/memoryStore/updateSortedMapItem.md +++ /dev/null @@ -1,32 +0,0 @@ - -# updateSortedMapItem -Updates a sorted map item. - - -## Parameters -| Name | Type | Description | -| :-------------- | :------------------------------------------------- | :------------------------------------------------------------------------------------ | -| universeId | Identifier | The id of the universe to get the sorted map item from. | -| sortedMap | string | The sorted map to get the item from. | -| itemId | string | The id of the item to update. | -| updatedItemData | UpdateSortedMapItem_ConstructItemConfig | The data to update the sorted map item with. | -| allowMissing | ? | If set to true, and the item is not found, a new item will be created. Default false. | - - - -## Example -```js copy showLineNumbers -type Item = { isReal: boolean }; -const { data: updatedItem } = await MemoryStoresApi.updateSortedMapItem({ - universeId: 5243626809, - sortedMap: "MySortedMap", - itemId: "Testing123", - updatedItemData: { value: { isReal: true }, ttl: "300s", numericSortKey: 1 }, -}); -``` - -## Endpoint -```ansi -PATCH /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items/{itemId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/messaging/_meta.json b/docs_site/pages/cloud/messaging/_meta.json deleted file mode 100644 index 7e9adee..0000000 --- a/docs_site/pages/cloud/messaging/_meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "publishMessage": "publishMessage" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/messaging/publishMessage.md b/docs_site/pages/cloud/messaging/publishMessage.md deleted file mode 100644 index 7b43fee..0000000 --- a/docs_site/pages/cloud/messaging/publishMessage.md +++ /dev/null @@ -1,36 +0,0 @@ - -# publishMessage -Publishes a message to all servers of a universe. - - - -## Example -```js copy showLineNumbers -// Openblox (Typescript Code) - Sending Message -type Message = { targetId: number; reason: string }; -await MessagingApi.publishMessage({ - universeId: 5097539509, - topic: "kickPlr", - message: { targetId: 45348281, reason: "You smell kinda funny." }, -}); - -/* Roblox Luau Code - Recieving The Message Above -local MessagingService = game:GetService("MessagingService") -local HttpService = game:GetService("HttpService") -local Players = game:GetService("Players") - -MessagingService:SubscribeAsync("kickPlr", function(msg) - local data = HttpService:JSONDecode(msg.Data) - - local plr = Players:GetPlayerByUserId(data.targetId) - if not plr then return end - - plr:Kick(`You have been kicked for: "{data.reason}"`) -end) */ -``` - -## Endpoint -```ansi -POST /v1/universes/{universeId}/topics/{topic} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/subscriptions/_meta.json b/docs_site/pages/cloud/subscriptions/_meta.json deleted file mode 100644 index 40b6ccd..0000000 --- a/docs_site/pages/cloud/subscriptions/_meta.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "subscriptionInfo": "subscriptionInfo" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/subscriptions/subscriptionInfo.md b/docs_site/pages/cloud/subscriptions/subscriptionInfo.md deleted file mode 100644 index f38d8bf..0000000 --- a/docs_site/pages/cloud/subscriptions/subscriptionInfo.md +++ /dev/null @@ -1,23 +0,0 @@ - -# subscriptionInfo - - -## Parameters -| Name | Type | Description | -| :-------------------- | :-------------------- | :--------------------------------- | -| universeId | UniverseId | The id of the universe. | -| subscriptionProductId | SubscriptionProductId | The id of the subscription. | -| subscriptionId | SubscriptionId | The Id of the user who subscribed. | - - - -## Example -```js copy showLineNumbers - -``` - -## Endpoint -```ansi -GET /v2/universes/{universeId}/subscription-products/{subscriptionProductId}/subscriptions/{subscriptionId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/users/_meta.json b/docs_site/pages/cloud/users/_meta.json deleted file mode 100644 index 019bc85..0000000 --- a/docs_site/pages/cloud/users/_meta.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "userInfo": "userInfo", - "userThumbnail": "userThumbnail", - "sendNotificationToUser": "sendNotificationToUser" -} \ No newline at end of file diff --git a/docs_site/pages/cloud/users/sendNotificationToUser.md b/docs_site/pages/cloud/users/sendNotificationToUser.md deleted file mode 100644 index 6f8901f..0000000 --- a/docs_site/pages/cloud/users/sendNotificationToUser.md +++ /dev/null @@ -1,33 +0,0 @@ - -# sendNotificationToUser -Sends a notification to a user. - - -## Parameters -| Name | Type | Description | -| :--------------- | :-------------------------------------------------- | :---------------------------------------------------- | -| userId | Identifier | The id of the user send the notification to. | -| universeId | Identifier | The id of the universe to send the notification from. | -| notificationData | SendNotificationToUser_NotificationData | The data of the notification. | - - - -## Example -```js copy showLineNumbers -const { data: notification } = await UsersApi.sendNotificationToUser({ - universeId: 1685831367, - userId: 45348281, - notificationData: { - messageId: "f70b6a49-a5e5-a048-b1a4-10f9e930614f", - parameters: { questsLeft: "15", custom: "lorem ipsum dolor sit amet" }, - launchData: "joined from foobar", - analyticsCategory: "foobar", - }, -}); -``` - -## Endpoint -```ansi -POST /v2/users/{userId}/notifications -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/users/userInfo.md b/docs_site/pages/cloud/users/userInfo.md deleted file mode 100644 index 06cfc70..0000000 --- a/docs_site/pages/cloud/users/userInfo.md +++ /dev/null @@ -1,22 +0,0 @@ - -# userInfo -Gets information about a user from their id. - - -## Parameters -| Name | Type | Description | -| :----- | :----- | :--------------------------------------------- | -| userId | UserId | The id of the user to get detailed info about. | - - - -## Example -```js copy showLineNumbers -const { data: userInfo } = await UsersApi.userInfo({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v2/users/{userId} -``` - \ No newline at end of file diff --git a/docs_site/pages/cloud/users/userThumbnail.md b/docs_site/pages/cloud/users/userThumbnail.md deleted file mode 100644 index 8edda7b..0000000 --- a/docs_site/pages/cloud/users/userThumbnail.md +++ /dev/null @@ -1,25 +0,0 @@ - -# userThumbnail -Gets a users avatar. - - -## Parameters -| Name | Type | Description | -| :----- | :----- | :------------------------------------------- | -| userId | UserId | The id of the user to get the thumbnail for. | -| size | ? | The size of the thumbnail to be returned. | -| format | ? | The format of the thumbnail to be returned. | -| shape | ? | The shape of the thumbnail to be returned. | - - - -## Example -```js copy showLineNumbers -const { data: userInfo } = await UsersApi.userInfo({ userId: 45348281 }); -``` - -## Endpoint -```ansi -GET /v2/users/{userId}:generateThumbnail -``` - \ No newline at end of file diff --git a/docs_site/pages/styles.css b/docs_site/pages/styles.css deleted file mode 100644 index 9edf5e4..0000000 --- a/docs_site/pages/styles.css +++ /dev/null @@ -1,6 +0,0 @@ - -@media (min-width:768px) { - .nextra-sidebar-container { - width: 22rem !important; - } -}