### TypeScript Example: Get Universe Configuration Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/universeConfiguration.md Demonstrates how to fetch universe configuration using the ClassicDevelopApi in TypeScript, providing a practical code example. ```ts const { data: config } = await ClassicDevelopApi.universeConfiguration({ universeId: 6069031486 }); ``` -------------------------------- ### TypeScript Example: Getting an Instance Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/engine/instanceInfo.md Demonstrates how to use the EngineApi.instanceInfo method to retrieve an instance using TypeScript, providing example universe, place, and instance IDs. ```ts const { data: instance } = await EngineApi.instanceInfo({ universeId: 5795192361, placeId: 16866553538, instanceId: "root" }); ``` -------------------------------- ### TypeScript Example: Get Team Create Settings Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/teamCreateSettingsForUniverse.md Demonstrates how to use the ClassicDevelopApi to fetch team create settings for a specific universe ID using TypeScript. ```typescript const { data: settings } = await ClassicDevelopApi.teamCreateSettingsForUniverse({ universeId: 6069031486 }); ``` -------------------------------- ### TypeScript Example: Get Game Pass Info Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/gamePasses/gamePassInfo.md Example demonstrating how to use the ClassicGamePassesApi to fetch game pass information using TypeScript. ```ts const { data: gamePassInfo } = await ClassicGamePassesApi.gamePassInfo({ gamePassId: 9260480 }); ``` -------------------------------- ### TypeScript Example for Getting Place Information Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/experiences/placeInfo.md Demonstrates how to use the ExperiencesApi in TypeScript to asynchronously retrieve place information for a specified universe and place ID. ```ts const { data: placeInfo } = await ExperiencesApi.placeInfo({ universeId: 5795192361, placeId: 16866553538 }); ``` -------------------------------- ### TypeScript Example: Get Resellable Copies Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/economy/authedUserAssetResellableCopies.md Demonstrates how to use the ClassicEconomyApi to fetch resellable copies of an asset for a specific user. ```ts const { data: resellableCopies } = await ClassicEconomyApi.authedUserAssetResellableCopies({ userId: 45348281, assetId: 3798248888, }); ``` -------------------------------- ### Example Data Returned by creatorStoreProductInfo API Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/creatorStore/creatorStoreProductInfo.md Illustrates the structure and typical values of the data returned by the `creatorStoreProductInfo` API. This example shows the response for a model asset, including its path, display name, pricing, and publication status. ```typescript { path: "creator-store-products/CreatorMarketplaceAsset-Model-16989381169", displayName: "monkey", description: "", basePrice: { currencyCode: "USD", quantity: { significand: 0, exponent: 0 } }, purchasePrice: { currencyCode: "USD", quantity: { significand: 0, exponent: 0 } }, published: false, restrictions: [], purchasable: false, userSeller: "45348281", modelAssetId: "16989381169" } ``` -------------------------------- ### TypeScript Example: Subscription Data Structure Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/subscriptions/subscriptionInfo.md Illustrates the structure and typical values of the data returned for a subscription, providing a clear example of the expected response format. ```ts { id: "3656348821302804581", universeId: 5795192361, name: "Testing", description: "Lorem ipsum dolor sit amet.", imageAssetId: 17175811135, periodType: "Monthly", productType: "Consumable", productStatusType: 1, basePriceId: "919c5912-7de8-413c-9756-d4265b3cbd3a", initialActivationTimestampMs: 0, createdTimestampMs: 1712783803427, updatedTimestampMs: 1713318949692, basePrice: "$2.99" } ``` -------------------------------- ### TypeScript Example: Calling createSubscription API Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/subscriptions/createSubscription.md Demonstrates how to call the createSubscription API using TypeScript, providing an example of the required parameters. ```ts const { data } = await ClassicSubscriptionsApi.createSubscription({ universeId: 5795192361, name: "Cool Subscription", description: "Lorem ipsum dolor sit amet.", type: "Durable", price: "$7.99" }); ``` -------------------------------- ### TypeScript Example: Create Developer Product Call Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/developerProducts/createDeveloperProduct.md Demonstrates how to programmatically create a developer product using the `ClassicDeveloperProductsApi` in TypeScript, providing a concrete example with typical input values. ```typescript const { data: product } = await ClassicDeveloperProductsApi.createDeveloperProduct({ universeId: 1685831367, name: "50 Coins", description: "Lorem Ipsum", priceInRobux: 50, }); ``` -------------------------------- ### TypeScript Example for Getting Asset Thumbnails Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/thumbnails/assetsThumbnails.md Demonstrates how to use the ClassicThumbnailsApi to fetch thumbnails for a list of asset IDs with a specified size using an asynchronous call. ```ts const { data: assetsThumbnails } = await ClassicThumbnailsApi.assetsThumbnails({ assetIds: [7229442422], size: "420x420" }); ``` -------------------------------- ### Example Response Data for Creator Experiences Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/talent/creatorExperiences.md Illustrates the structure and content of the data returned by the `creatorExperiences` API endpoint, showing a single experience object. ```APIDOC [ { experienceId: 21126, creatorUserId: 45348281, createdUtc: 2022-01-16T16:09:30.161Z, updatedUtc: 2022-07-29T12:23:28.866Z, projectName: "RoCamping", experienceDescription: "RoCamping was my first game, it was a survival game where you built a shelter and tried to survive. My role was the manage the project as well as script and create the UI .", jobRole: "Programmer & UI Designer", teamName: "", experienceMedia: [], experienceLinks: [ "[The Game](https://www.roblox.com/games/4922741943/RoCamping)" ], teamId: null, robloxExperienceIds: [], robloxAssetIds: [], startedUtc: 2020-03-31T23:00:00.000Z, endedUtc: 2020-09-30T23:00:00.000Z, isCurrent: false } ] ``` -------------------------------- ### TypeScript Example: Fetching Creator Experiences Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/talent/creatorExperiences.md Demonstrates how to call the `creatorExperiences` API using TypeScript to retrieve a user's work history from the ClassicTalentApi. ```TypeScript const { data: experiences } = await ClassicTalentApi.creatorExperiences({ userId: 45348281 }); ``` -------------------------------- ### Get Group Settings (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/groups/groupSettings.md An example demonstrating how to call the groupSettings API using TypeScript, showing the use of 'ClassicGroupsApi' and the 'groupId' parameter. ```typescript const { data: settings } = await ClassicGroupsApi.groupSettings({ groupId: 5850082 }); ``` -------------------------------- ### TypeScript Example: VIP Server Configuration Response Data Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/vipServerConfigurationForUniverse.md Provides an example of the data structure returned by the `vipServerConfigurationForUniverse` API call, including properties like `isEnabled`, `price`, and server/subscription counts. ```ts { isEnabled: false, price: null, activeServersCount: 0, activeSubscriptionsCount: 0, } ``` -------------------------------- ### TypeScript Example Data: Empty Request Body Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/experiences/restartUniverseServers.md Provides an example of the expected request body structure, which is an empty object for this operation, indicating no specific payload is required. ```typescript {} ``` -------------------------------- ### Example Response Data for Catalog Batch Info Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/catalog/catalogBatchInfo.md Illustrates the structure and content of the data returned by the `catalogBatchInfo` endpoint, showing details for both a bundle and an asset. ```ts [ { id: 429, itemType: "Bundle", bundleType: 1, name: "Magma Fiend", description: "He's got hot blood, with a temperature of nine hundred and three.", productId: 7219806593957530, itemStatus: [], itemRestrictions: [], creatorHasVerifiedBadge: true, creatorType: "User", creatorTargetId: 1, creatorName: "Roblox", price: 300, lowestPrice: 300, lowestResalePrice: 0, unitsAvailableForConsumption: 0, purchaseCount: 0, favoriteCount: 520324, offSaleDeadline: null, collectibleItemId: "e036077b-ed8d-4bf1-9193-4e64bbc86978", totalQuantity: 0, saleLocationType: "ShopAndAllExperiences", hasResellers: false }, { id: 2608538559, itemType: "Asset", assetType: 31, name: "Magma Fiend - Right Leg", description: "He's got hot blood, with a temperature of nine hundred and three.", productId: 427839098, itemStatus: [], itemRestrictions: [], creatorHasVerifiedBadge: true, creatorType: "User", creatorTargetId: 1, creatorName: "Roblox", priceStatus: "Off Sale", purchaseCount: 0, favoriteCount: 9887, offSaleDeadline: null, saleLocationType: "NotApplicable", isOffSale: true } ] ``` -------------------------------- ### Example Response Data for placeInfo Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/experiences/placeInfo.md Illustrates the structure and content of the data returned by the placeInfo API endpoint, including path, timestamps, display name, description, and server size. ```ts { path: "universes/5795192361/places/16866553538", createTime: 2024-03-25T10:42:46.297Z, updateTime: 2024-03-26T16:50:19.023Z, displayName: "MightyPart's Place Number: 201", description: "", serverSize: 50, } ``` -------------------------------- ### TypeScript: Call recommendationsForBundle API Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/catalog/recommendationsForBundle.md Example TypeScript code demonstrating how to use `ClassicCatalogApi.recommendationsForBundle` to fetch recommendations for a given bundle ID and amount. ```typescript const { data: bundles } = await ClassicCatalogApi.recommendationsForBundle({ bundleId: 429, amount: 1 }); ``` -------------------------------- ### TypeScript Example: Get Universe Information Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/universeInfo.md Demonstrates how to use the ClassicDevelopApi to retrieve information for a specific universe ID in TypeScript. ```ts const { data: universeInfo } = await ClassicDevelopApi.universeInfo({ universeId: 6069031486 }); ``` -------------------------------- ### TypeScript Example: Fetching Place Configuration Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/placeConfiguration.md Demonstrates how to use the ClassicDevelopApi to fetch place configuration using a given place ID in TypeScript. ```typescript const { data: config } = await ClassicDevelopApi.placeConfiguration({ placeId: 16349154726 }); ``` -------------------------------- ### TypeScript Example: Calling listLuauExecutionLogs API Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/luauExecution/listLuauExecutionLogs.md An example demonstrating how to call the `listLuauExecutionLogs` API using TypeScript, showing the required and optional parameters for retrieving Luau execution logs. ```typescript const { data: logs } = await LuauExecutionApi.listLuauExecutionLogs({ universeId: 5795192361, placeId: 16866553538, version: 26, sessionId: "67823af7-1f99-4fc5-b3bb-da7ab3456b5d", taskId: "67823af7-1f99-4fc5-b3bb-da7ab3456b5d" }); ``` -------------------------------- ### TypeScript Example: Fetching Game Thumbnails Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/thumbnails/gameThumbnailsFromIds.md Demonstrates how to use the `ClassicThumbnailsApi` to fetch game thumbnails for a specific universe and thumbnail ID using async/await. This snippet shows a practical application of the API call with example input values. ```TypeScript const { data: gameThumbnails } = await ClassicThumbnailsApi.gameThumbnailsFromIds({ universeId: 1685831367, thumbnailIds: [5030792576] }); ``` -------------------------------- ### Bundles Thumbnails Example Data (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/thumbnails/bundlesThumbnails.md Provides an example of the JSON data structure returned by the bundlesThumbnails API, showing the state and image URL for a bundle. ```ts { "181": { state: "Completed", imageUrl: "https://tr.rbxcdn.com/12ff41b547ee75865bb60d0f3ae5508b/420/420/Avatar/Png", }, } ``` -------------------------------- ### TypeScript Example: Get Standard DataStore Entry Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/standardDataStores_V2/standardDataStoreEntry.md Demonstrates how to fetch an entry from a standard datastore using the `StandardDataStoresApi_V2`, including a type definition for the expected data schema. ```ts type InventorySchema = { Iron?: number; Gold?: number; Copper?: number; Stone?: number; Wood?: number }; const { data, response: { body }, } = await StandardDataStoresApi_V2.standardDataStoreEntry({ universeId: 5097539509, dataStore: "InventoryStore", entryId: "users/45348281", }); ``` -------------------------------- ### TypeScript Example: VIP Server Response Data Structure Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/updateVipServer.md Illustrates the structure and content of the data returned after successfully updating a VIP server. This example includes details such as the server's ID, name, associated game, join code, active status, subscription information, permissions, voice settings, and a direct link. ```typescript { id: 1630945839, name: "New Name", game: { id: 6430220996, name: "Get Id", rootPlace: { id: 18980972074, name: "Get Id" }, }, joinCode: "70420354791950165689950670608627", active: true, subscription: { active: false, expired: false, expirationDate: "2024-09-17T15:49:02.8879762Z", price: null, canRenew: false, hasInsufficientFunds: false, hasRecurringProfile: true, hasPriceChanged: true, }, permissions: { clanAllowed: false, enemyClanId: null, friendsAllowed: false, users: [], }, voiceSettings: { enabled: false }, link: "https://www.roblox.com/games/18980972074?privateServerLinkCode=70420354791950165689950670608627", } ``` -------------------------------- ### TypeScript Example: Calling restartUniverseServers Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/experiences/restartUniverseServers.md Illustrates how to invoke the restartUniverseServers API method using TypeScript, providing a sample universe ID. ```typescript await ExperiencesApi.restartUniverseServers({ universeId: 5795192361 }); ``` -------------------------------- ### TypeScript Example: Get Public Servers for a Place Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/placeServerList.md Demonstrates how to use the `ClassicGamesApi` to retrieve a list of public servers for a specific place ID using the `placeServerList` method. ```typescript const { data: servers } = await ClassicGamesApi.placeServerList({ placeId: 26838733, serverType: "Public" }); ``` -------------------------------- ### TypeScript Example: Get Group Permissions Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/groups/groupPermissionsForAllRoles.md Demonstrates how to use the ClassicGroupsApi to fetch all role permissions for a given group ID using TypeScript. ```ts const { data: allPerms } = await ClassicGroupsApi.groupPermissionsForAllRoles({ groupId: 5850082 }); ``` -------------------------------- ### TypeScript Example: Create a Game Pass Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/gamePasses/createGamePass.md Demonstrates how to use the ClassicGamePassesApi to create a new game pass, specifying the universe ID, name, and description. The example shows asynchronous API call and data destructuring. ```ts const { data: gamePassId } = await ClassicGamePassesApi.createGamePass({ universeId: 1685831367, name: "My Pass", description: "Lorem Ipsum..." }); ``` -------------------------------- ### TypeScript Example Data: Game Product Info Response Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/universesProductInfo.md Illustrates the structure and content of the data returned by the `universesProductInfo` API call, showing product details for a specific game ID. ```ts { "1685831367": { isForSale: false, productId: 0, price: null, sellerId: 1536374574, } } ``` -------------------------------- ### Get User Followings Count Example in TypeScript Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/friends/userFollowingsCount.md This TypeScript code snippet demonstrates how to asynchronously fetch the number of followings for a specific user using the ClassicFriendsApi. It destructures the 'data' property to get 'followingsCount'. ```typescript const { data: followingsCount } = await ClassicFriendsApi.userFollowingsCount({ userId: 45348281 }); ``` -------------------------------- ### TypeScript Example: Fetch VIP Server Configuration Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/vipServerConfigurationForUniverse.md Demonstrates a TypeScript code snippet using `ClassicDevelopApi` to asynchronously fetch the VIP server configuration for a specified `universeId`. ```ts const { data: config } = await ClassicDevelopApi.vipServerConfigurationForUniverse({ universeId: 5638577595 }); ``` -------------------------------- ### TypeScript Example: Fetching Game Product Info Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/universesProductInfo.md Demonstrates how to call the `universesProductInfo` API using TypeScript to retrieve product details for specified game IDs. ```ts const { data: products } = await ClassicGamesApi.universesProductInfo({ universeIds: [1685831367] }); ``` -------------------------------- ### TypeScript Example: Sample Response Data for placesInfo Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/placesInfo.md Provides an example of the data structure returned by the placesInfo API endpoint, showing detailed information for a specific place ID. ```ts { "4922741943": { name: "RoCamping", description: "RoCamping is a fun adventure game where the end-goal is to create the best camp ever. Gather resources, chop down trees, go down caves and much more! Start your journey today!\r\n\r\nNOTE: RoCamping is still in BETA so expect there to be glitches, if you find a glitch then don't hesitate to join our group and report it there.\r\n\r\nCurrent Version: BETA v3,0\r\n\r\nalvinblox", sourceName: "RoCamping", sourceDescription: "RoCamping is a fun adventure game where the end-goal is to create the best camp ever. Gather resources, chop down trees, go down caves and much more! Start your journey today!\r\n\r\nNOTE: RoCamping is still in BETA so expect there to be glitches, if you find a glitch then don't hesitate to join our group and report it there.\r\n\r\nCurrent Version: BETA v3,0", url: "https://www.roblox.com/games/4922741943/RoCamping", builder: "MightyPart Games", builderId: 5850082, hasVerifiedBadge: false, isPlayable: true, reasonProhibited: "None", universeId: 1685831367, universeRootPlaceId: 4922741943, price: 0, imageToken: "T_4922741943_678b" } } ``` -------------------------------- ### TypeScript Example Data: Developer Product Creator Details Response Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/developerProducts/developerProductCreatorDetails.md Provides an example of the data structure returned by the developerProductCreatorDetails API call, showing various properties of a developer product such as display name, price, creator, and timestamps. ```ts { displayName: "Starterpackk", displayDescription: null, displayIconImageAssetId: 5106354357, priceInformation: { defaultPriceInRobux: 95, isInActivePriceOptimizationExperiment: false }, targetId: 3848620, productType: "Developer Product", assetId: 0, productId: 995087849, name: "Starterpackk", description: null, assetTypeId: 0, creator: { id: 0, name: null, creatorType: null, creatorTargetId: 0 }, iconImageAssetId: 5106354357, created: "2020-05-29T11:49:09.08Z", updated: "2024-07-22T05:33:16.827Z", priceInRobux: null, premiumPriceInRobux: null, priceInTickets: null, isNew: false, isForSale: true, isPublicDomain: false, isLimited: false, isLimitedUnique: false, remaining: null, sales: null, minimumMembershipLevel: 0 } ``` -------------------------------- ### Get Asset Favorites Count in TypeScript Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/catalog/assetFavoritesCount.md Example of how to retrieve the favorites count for an asset using the ClassicCatalogApi in TypeScript. ```ts const { data: favoritesCount } = await ClassicCatalogApi.assetFavoritesCount({ assetId: 2608539495 }); ``` -------------------------------- ### TypeScript Example Data: Universes Info Response Structure Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/universesInfo.md Provides an example of the data structure returned by the `universesInfo` endpoint, illustrating the format and content for a specific universe ID. ```typescript { "6069031486": { created: 2024-06-03T09:42:56.270Z, updated: 2024-06-03T09:42:56.270Z, name: "MightyPart's Place: 06032024_1", description: null, isArchived: false, rootPlaceId: 17718644108, isActive: false, privacyType: "Private", creatorType: "User", creatorTargetId: 45348281, creatorName: "MightyPart" } } ``` -------------------------------- ### Example Developer Product Data Structure (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/developerProducts/developerProductsForUniverse.md Illustrates the expected data structure of developer products returned by the API, including ID, name, description, shopId, and iconImageAssetId. ```ts [ { "id": 3616380, "name": "Buy $100 CamperCoins", "description": null, "shopId": 1685930453, "iconImageAssetId": 4922956503 }, { "id": 3616418, "name": "Buy $1000 CamperCoins", "description": null, "shopId": 1685930453, "iconImageAssetId": 4922970743 }, { "id": 3616413, "name": "Buy $500 CamperCoins", "description": null, "shopId": 1685930453, "iconImageAssetId": 4922969199 }, { "id": 3616425, "name": "CamperCoins", "description": null, "shopId": 1685930453, "iconImageAssetId": 18760547825 }, { "id": 3848620, "name": "Starterpackk", "description": null, "shopId": 1685930453, "iconImageAssetId": 5106354357 } ] ``` -------------------------------- ### Get 3D Outfit Thumbnail (TypeScript Example) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/thumbnails/outfit3dThumbnail.md Demonstrates how to fetch a 3D outfit thumbnail using the `ClassicThumbnailsApi` in TypeScript, requiring an `outfitId` as input. ```ts const { data: outfit3dData } = await ClassicThumbnailsApi.outfit3dThumbnail({ outfitId: 110540093 }); ``` -------------------------------- ### Get Authenticated User Friend Requests Count (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/friends/authenticatedUserFriendRequestsCount.md This TypeScript example demonstrates how to retrieve the number of pending friend requests for the currently authenticated user using the ClassicFriendsApi. It awaits the `authenticatedUserFriendRequestsCount` method and destructures the `data` property to get the `requestsCount`. ```typescript const { data: requestsCount } = await ClassicFriendsApi.authenticatedUserFriendRequestsCount(); ``` -------------------------------- ### TypeScript Example: Place Configuration Response Data Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/placeConfiguration.md Illustrates the structure and typical values of the data returned when fetching a place's configuration via the API. ```typescript { maxPlayerCount: 50, socialSlotType: "Automatic", customSocialSlotsCount: 15, allowCopying: false, currentSavedVersion: 1537, isAllGenresAllowed: true, allowedGearTypes: [], maxPlayersAllowed: 700, id: 16349154726, universeId: 5638577595, name: "New name!", description: "", isRootPlace: true, } ``` -------------------------------- ### Developer Product Information Example Data (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/developerProducts/developerProductInfo.md Provides a sample JSON object demonstrating the structure and typical values returned when querying developer product information via the API. ```ts { productId: 995087849, productTypeId: 4, isPublicDomain: false, isForSale: true, priceInRobux: 95, premiumPriceInRobux: null, robloxProductId: null, targetId: 3848620, assetTypeId: null, creatorId: 1536374574, assetGenres: 0, assetCategories: 0, affiliateFeePercentage: null, isNew: false, created: "2020-05-29T11:49:09.08Z", updated: 2024-07-22T05:33:16.827Z, } ``` -------------------------------- ### TypeScript Example: Get User Followers Count Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/friends/findFriends.md Demonstrates how to use the ClassicFriendsApi to retrieve the count of user followers for a given userId. ```typescript const { data: friends } = await ClassicFriendsApi.userfollowersCount({ userId: 45348281 }); ``` -------------------------------- ### Example Data: Created Ordered Datastore Entry Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/orderedDataStores_V1/createOrderedDatastoreEntry.md Illustrates the structure of the data returned after successfully creating an ordered datastore entry, including its path, value, and ID. ```ts { path: "universes/5097539509/orderedDataStores/PointsStore/scopes/global/entries/45348281", value: 54, id: "45348281", } ``` -------------------------------- ### TypeScript Example: Get Bundles Owned by User Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/catalog/bundlesOwnedByUser.md Demonstrates how to call the `bundlesOwnedByUser` API using TypeScript to retrieve user-owned bundles. ```typescript const { data: bundles } = await ClassicCatalogApi.bundlesOwnedByUser({ userId: 45348281 }); ``` -------------------------------- ### API Parameters for creatorExperiences Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/talent/creatorExperiences.md Defines the parameters available for the `creatorExperiences` endpoint, including their types and descriptions. Optional parameters are marked with a question mark. ```APIDOC Parameters: userId: UserId Description: The id of the user to get verification info about. sortOrder?: SortOrder Description: The order the results are sorted it. limit?: number Description: The number of results to be returned cursor?: string Description: The paging cursor for the previous or next page. ``` -------------------------------- ### TypeScript Example: Standard Datastore Keys Return Data Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/standardDataStores_V1/standardDatastoreKeys.md Illustrates the format of the data returned by the standardDatastoreKeys API. This snippet provides an example of a typical response, showing a list of user keys. ```ts ["user/45348281"] ``` -------------------------------- ### TypeScript Example: Standard Data Stores Response Format Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/standardDataStores_V2/listStandardDataStores.md Provides an example of the data structure returned by the `listStandardDataStores` API, showing the `path` and `id` for a data store entry. ```ts [{ path: "universes/5097539509/data-stores/Bans", id: "Bans" }] ``` -------------------------------- ### TypeScript Example: Get Authenticated User Bundle Favorite Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/catalog/authedUserGetBundleFavorite.md Demonstrates how to call the authedUserGetBundleFavorite API using TypeScript to retrieve a user's favorite bundle. ```ts const { data: favorite } = await ClassicCatalogApi.authedUserGetBundleFavorite({ userId: 45348281, bundleId: 429 }); ``` -------------------------------- ### TypeScript Example: Get Game Pass Thumbnails Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/thumbnails/gamePassesThumbnails.md Demonstrates how to use the ClassicThumbnailsApi to fetch thumbnails for a given game pass ID in TypeScript. ```ts const { data: gamePassesThumbnails } = await ClassicThumbnailsApi.gamePassesThumbnails({ gamePassIds: [9063647] }); ``` -------------------------------- ### TypeScript Example: Fetching Catalog Batch Info Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/catalog/catalogBatchInfo.md Demonstrates how to call the `catalogBatchInfo` API using TypeScript to retrieve information for specific asset and bundle IDs. ```ts const { data: items } = await ClassicCatalogApi.catalogBatchInfo({ assetIds: [2608538559], bundleIds: [429] }); ``` -------------------------------- ### TypeScript Example: Get Developer Product Creator Details Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/developerProducts/developerProductCreatorDetails.md Demonstrates how to use the ClassicDeveloperProductsApi to retrieve creator details for a specific developer product using its ID. ```ts const { data: productCreatorDetails } = await ClassicDeveloperProductsApi.developerProductCreatorDetails({ developerProductProductId: 995087849, }); ``` -------------------------------- ### TypeScript Example: Fetching Game Info Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/universesInfo.md Demonstrates how to use the ClassicGamesApi to fetch game information for a given universe ID using TypeScript. ```typescript const { data: games } = await ClassicGamesApi.universesInfo({ universeIds: [1685831367] }); ``` -------------------------------- ### Example Response Data for createSortedMapItem Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/memoryStores/createSortedMapItem.md Provides an example of the data structure returned after successfully creating a sorted map item, including path, value, etag, expire time, id, and numeric sort key. ```ts { path: "cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items", value: { isReal: true }, etag: "10", expireTime: 2024-04-18T00:30:14.000Z, id: "Testing123", numericSortKey: 1 } ``` -------------------------------- ### TypeScript Example: Fetch Universe Information Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/experiences/universeInfo.md Demonstrates how to programmatically retrieve information about a specific universe using the `ExperiencesApi.universeInfo` method in TypeScript. ```ts const { data: universeInfo } = await ExperiencesApi.universeInfo({ universeId: 5795192361 }); ``` -------------------------------- ### TypeScript Example: Universe Configuration Data Structure Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/develop/updateUniverseConfiguration_V1.md Provides an example of the data structure for a universe's configuration, illustrating various properties such as `allowPrivateServers`, `name`, `genre`, and `playableDevices`. This can be used to understand the expected format for API responses or request bodies. ```ts { allowPrivateServers: false, privateServerPrice: null, isMeshTextureApiAccessAllowed: true, id: 5638577595, name: "Terrain Gen Tech Demo", universeAvatarType: "PlayerChoice", universeScaleType: "AllScales", universeAnimationType: "PlayerChoice", universeCollisionType: "OuterBox", universeBodyType: "Standard", universeJointPositioningType: "ArtistIntent", isArchived: false, isFriendsOnly: false, genre: "All", playableDevices: ["Computer"], isForSale: false, price: 0, isStudioAccessToApisAllowed: false, privacyType: "Public" } ``` -------------------------------- ### TypeScript Example: Sample Response Data for User Group Roles Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/groups/allGroupRolesForUser_v2.md Provides an example of the data structure returned by the allGroupRolesForUser_v2 endpoint, showing group and role details for a user. ```ts [ { group: { id: 5850082, name: "MightyPart Games", memberCount: 108, hasVerifiedBadge: false }, role: { id: 5850082, name: "Mighty Member", rank: 100 } } ] ``` -------------------------------- ### TypeScript Example Data: VIP Server Info Response Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/vipServerInfo.md Illustrates the structure and content of the data returned by the vipServerInfo API endpoint. This example shows various properties of a VIP server, including its ID, name, associated game, join code, subscription status, permissions, and a direct link. ```ts { id: 1630945839, name: "Testing", game: { id: 6430220996, name: "Get Id", rootPlace: { id: 18980972074, name: "Get Id" } }, joinCode: "70420354791950165689950670608627", active: true, subscription: { active: false, expired: false, expirationDate: "2024-09-17T15:49:02.8879762Z", price: null, canRenew: false, hasInsufficientFunds: false, hasRecurringProfile: true, hasPriceChanged: true }, permissions: { clanAllowed: false, enemyClanId: null, friendsAllowed: false, users: [] }, voiceSettings: { enabled: false }, link: "https://www.roblox.com/games/18980972074?privateServerLinkCode=70420354791950165689950670608627" } ``` -------------------------------- ### Get Free Badges Left for Universe (TypeScript Example) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/badges/freeBadgesLeftForUniverse.md Demonstrates how to fetch the number of free badges remaining for a specific universe using the ClassicBadgesApi in TypeScript. ```typescript const { data: freeBadgesLeft } = await ClassicBadgesApi.freeBadgesLeftForUniverse({ universeId: 1685831367 }); ``` -------------------------------- ### Group Settings Example Data (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/groups/groupSettings.md An example of the data structure and values returned by the groupSettings API call, illustrating various boolean settings for a group. ```typescript { isApprovalRequired: true, isBuildersClubRequired: false, areEnemiesAllowed: true, areGroupFundsVisible: false, areGroupGamesVisible: true, isGroupNameChangeEnabled: true, } ``` -------------------------------- ### TypeScript Example: BundlesOwnedByUser Response Data Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/catalog/bundlesOwnedByUser.md Provides an example of the data structure returned by the `bundlesOwnedByUser` API call, showing a list of user-owned bundles. ```typescript [ { id: 290, name: "Football Player", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 71, name: "Wild Starr", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 238, name: "Man ", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 81, name: "Superhero Animation Pack", bundleType: "AvatarAnimations", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 109, name: "ROBLOX Boy", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 338, name: "Knights of Redcliff: Paladin", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 321, name: "City Life Man", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 337, name: "City Life Woman", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 339, name: "The High Seas: Beatrix The Pirate Queen", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } }, { id: 350, name: "Dark Age Apprentice", bundleType: "BodyParts", creator: { id: 1, name: "Roblox", type: "User", hasVerifiedBadge: true } } ] ``` -------------------------------- ### TypeScript Example: Get Universe Vote Status Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/universesVoteStatus.md Demonstrates how to programmatically retrieve vote statuses for a specific universe using the ClassicGamesApi in TypeScript. ```ts const { data: voteStatuses } = await ClassicGamesApi.universesVoteStatus({ universeIds: [1685831367] }); ``` -------------------------------- ### TypeScript: Example Usage for Updating VIP Server Voice Settings Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/updateVipServerVoiceSettings.md Illustrates how to call the `updateVipServerVoiceSettings` API using the `ClassicGamesApi` in TypeScript, showing a typical API request and the structure of the data returned or expected. ```typescript const { data: serverInfo } = await ClassicGamesApi.updateVipServerVoiceSettings({ vipServerId: 1630945839, enabled: true, }); ``` ```typescript { enabled: true } ``` -------------------------------- ### TypeScript Example Data for Universe Update Response Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/experiences/updateUniverse.md Provides an example of the data structure returned after successfully updating a universe, including path, timestamps, display name, and various enabled flags. ```TypeScript { path: "universes/5795192361", createTime: 2024-03-25T10:42:46.360Z, updateTime: 2024-03-25T10:42:46.360Z, displayName: "MightyPart's Place Number: 201", description: "", user: "users/45348281", visibility: "PRIVATE", voiceChatEnabled: false, ageRating: "AGE_RATING_UNSPECIFIED", desktopEnabled: true, mobileEnabled: true, tabletEnabled: true, consoleEnabled: false, vrEnabled: true } ``` -------------------------------- ### Get User Followers Count (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/friends/userFollowersCount.md Example demonstrating how to retrieve the follower count for a given user ID using the ClassicFriendsApi in TypeScript. ```typescript const { data: followersCount } = await ClassicFriendsApi.userfollowersCount({ userId: 45348281 }); ``` -------------------------------- ### TypeScript Example: subscriptionsForUniverse Placeholder Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/subscriptions/subscriptionsForUniverse.md An empty TypeScript code block, likely a placeholder for a usage example of the subscriptionsForUniverse API. ```ts undefined ``` -------------------------------- ### TypeScript Example: Get VIP Server Info Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/vipServerInfo.md Demonstrates how to call the vipServerInfo API using TypeScript. This snippet utilizes the 'ClassicGamesApi' to fetch server information based on a provided 'vipServerId', destructuring the response to access the 'data' property. ```ts const { data: serverInfo } = await ClassicGamesApi.vipServerInfo({ vipServerId: 1630945839 }); ``` -------------------------------- ### TypeScript Example: Get Authenticated User Game Playability Statuses Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/games/authedUserGamesPlayabilityStatuses.md Demonstrates how to call the authedUserGamesPlayabilityStatuses API using ClassicGamesApi in TypeScript to retrieve playability statuses for specified universe IDs. ```ts const { data: playabilityStatuses } = await ClassicGamesApi.authedUserGamesPlayabilityStatuses({ universeIds: [1685831367], }); ``` -------------------------------- ### TypeScript Example: Get Ordered Data Store Entry Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/orderedDataStores_V2/orderedDataStoreEntry.md Demonstrates how to retrieve an entry from an ordered data store using the `OrderedDataStoresApi_V2` client in TypeScript, providing the necessary universe, data store, scope, and entry IDs. ```typescript const { data: entry } = await OrderedDataStoresApi_V2.orderedDataStoreEntry({ universeId: 5097539509, dataStoreId: "PointsStore", scope: "global", entryId: "45348281" }); ``` -------------------------------- ### TypeScript Example: Asset Resale Data Structure Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/economy/assetResaleData.md Illustrates the typical structure and example values of the `assetResaleData` object returned by the API. ```typescript { assetStock: null, sales: 11412, numberRemaining: null, recentAveragePrice: 261565, originalPrice: null, priceDataPoints: [{ value: 271997, date: "2024-07-30T00:00:00Z" }], volumeDataPoints: [{ value: 2, date: "2024-07-30T00:00:00Z" }], } ``` -------------------------------- ### TypeScript Example: Get Instance Children Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/engine/instanceChildren.md Demonstrates how to call the instanceChildren API using EngineApi in TypeScript, providing required universeId, placeId, and instanceId to retrieve instance children. ```ts const { data: children } = await EngineApi.instanceChildren({ universeId: 5795192361, placeId: 16866553538, instanceId: "root" }); ``` -------------------------------- ### TypeScript Example: Fetching a Standard Datastore Entry Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/standardDataStores_V1/standardDatastoreEntry.md Provides a TypeScript code example demonstrating how to retrieve a data store entry using `StandardDataStoresApi_V1.standardDatastoreEntry`. It includes a type definition for the expected data schema and logic to check if the returned data's checksums match, indicating data integrity. ```typescript type InventorySchema = { Iron?: number; Gold?: number; Copper?: number; Stone?: number; Wood?: number }; const { data: entryInfo } = await StandardDataStoresApi_V1.standardDatastoreEntry({ universeId: 5097539509, datastoreName: "InventoryStore", entryKey: "user/45348281", }); if (!entryInfo.checksumsMatch) console.log("checksums do not match, data may be invalid!"); else console.log("checksums match! ->", entryInfo.entry); ``` -------------------------------- ### Example Usage: Get Badges Thumbnails (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/thumbnails/badgesThumbnails.md Demonstrates how to call the badgesThumbnails API using TypeScript to retrieve thumbnails for a given badge ID. ```ts const { data: badgesThumbnails } = await ClassicThumbnailsApi.badgesThumbnails({ badgeIds: [2124533401] }); ``` -------------------------------- ### Initializing Openblox Configuration and Fetching User Data (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/index.md This example demonstrates how to set up Openblox configuration using environment variables for `ROBLOX_COOKIE` and `CLOUD_KEY`. It then shows how to fetch user information from the Roblox API using both the `ClassicUsersApi` and `UsersApi` (cloud) modules, highlighting the use of `setDefaultOpenbloxConfig` and `createOpenbloxConfig`. The snippet also notes the automatic import of cookie and cloud key from environment variables. ```typescript import "dotenv/config"; import { createOpenbloxConfig, setDefaultOpenbloxConfig } from "openblox/config"; import { UsersApi } from "openblox/cloud"; import { ClassicUsersApi } from "openblox/classic"; // Classic (BEDEV & BEDEV2) APIs will always be prefixed with `Classic`. /* Naming your Roblox Cookie environment variable `ROBLOX_COOKIE` will automatically import it into your Openblox config, therefore voiding the need to set it in the config manually. Similarly, naming your OpenCloud API Key environment variable `ROBLOX_CLOUD_KEY` will also automatically import it into your Openblox config. */ setDefaultOpenbloxConfig( createOpenbloxConfig({ cookie: process.env.ROBLOX_COOKIE as any, cloudKey: process.env.CLOUD_KEY as any }) ) (async () => { const { data:userInfo_classic } = await ClassicUsersApi.userInfo({ userId: 45348281 }) const { data:userInfo_cloud } = await UsersApi.userInfo({ userId: 45348281 }) }) ``` -------------------------------- ### TypeScript: Example Response Data for Snapshot API Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/standardDataStores_V2/createStandardDataStoreSnapshot.md Illustrative example of the data structure returned by the `createStandardDataStoreSnapshot` API, showing typical values for `newSnapshotTaken` and `latestSnapshotTime`. ```ts { newSnapshotTaken: false, latestSnapshotTime: 2024-07-29T22:08:49.588Z } ``` -------------------------------- ### TypeScript Example: Calling listOrderedDatastoreEntries Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/cloud/orderedDataStores_V1/listOrderedDatastoreEntries.md Demonstrates how to call the `listOrderedDatastoreEntries` API using TypeScript, showing the required parameters and an asynchronous execution pattern. ```typescript const { data: entries } = await OrderedDataStoresApi_V1.listOrderedDatastoreEntries({ universeId: 5097539509, orderedDataStore: "PointsStore", scope: "global" }); ``` -------------------------------- ### TypeScript Example: Fetching Subscription Information Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/subscriptions/subscriptionInfo.md Demonstrates how to use the ClassicSubscriptionsApi to retrieve subscription details for a given universe and subscription ID. ```ts const { data: subscription } = await ClassicSubscriptionsApi.subscriptionInfo({ universeId: 5795192361, subscriptionId: "3656348821302804581" }); ``` -------------------------------- ### TypeScript Example: Get Featured Event Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/groups/featuredEvent.md Demonstrates how to call the 'featuredEvent' API using the ClassicGroupsApi in TypeScript to retrieve the event ID for a specified group. ```typescript const { data: eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }); ``` -------------------------------- ### TypeScript Example Data: subscriptionsForUniverse Response Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/subscriptions/subscriptionsForUniverse.md An example JSON response structure for the subscriptionsForUniverse endpoint, showing typical data fields and values for a subscription object. ```ts [ { id: "3656348821302804581", universeId: 5795192361, name: "Testing", description: "Lorem ipsum dolor sit amet.", imageAssetId: 17095512680, periodType: "Monthly", productType: "Consumable", productStatusType: 1, basePriceId: "919c5912-7de8-413c-9756-d4265b3cbd3a", initialActivationTimestampMs: 0, createdTimestampMs: 1712783803427, updatedTimestampMs: 1712783804047, basePrice: "$2.99" } ] ``` -------------------------------- ### Get Friends Count for User (TypeScript) Source: https://github.com/sqikerz/openblox-docs/blob/main/docs_site/pages/classic/friends/friendsCount.md Example of how to call the 'friendsCount' API using TypeScript to retrieve the number of friends for a given user ID. ```typescript const { data: count } = await ClassicFriendsApi.friendsCount({ userId: 45348281 }); ```