@jacobhumston/roblox-openapi-ts 1.0.0 → 1.0.3

package/README.md

@@ -3,5 +3,3 @@
 An automatically updated [openapi-fetch](https://openapi-ts.dev/openapi-fetch/) client for Roblox's [OpenAPI](https://create.roblox.com/docs/cloud/reference/openapi) document.
 
 This package is intended for quickly testing the Roblox API.
-
-Docs: [https://jacobhumston.github.io/roblox-openapi-ts](https://jacobhumston.github.io/roblox-openapi-ts)

package/dist/index.d.ts

@@ -1,4 +1,11 @@
-import { $defs, components, operations, paths, webhooks } from './types.js';
-export { $defs, components, operations, paths, webhooks };
-/** Roblox API client. */
-export declare const client: import("openapi-fetch").Client<paths, `${string}/${string}`>;
+import { ClientOptions } from 'openapi-fetch';
+import { paths } from './types.js';
+export * from './types.js';
+/**
+ * Create a new Roblox API client.
+ * @param url The URL for this client. Default is https://apis.roblox.com
+ * @param options Options to pass to the API client.
+ */
+export declare function newRobloxAPIClient(url?: RobloxApiUrl, options?: ClientOptions): import("openapi-fetch").Client<paths, `${string}/${string}`>;
+/** Roblox API urls. */
+export type RobloxApiUrl = 'https://apis.roblox.com' | 'https://accountinformation.roblox.com' | 'https://accountsettings.roblox.com' | 'https://adconfiguration.roblox.com' | 'https://assetdelivery.roblox.com' | 'https://auth.roblox.com' | 'https://avatar.roblox.com' | 'https://badges.roblox.com' | 'https://catalog.roblox.com' | 'https://clientsettings.roblox.com' | 'https://contacts.roblox.com' | 'https://develop.roblox.com' | 'https://economy.roblox.com' | 'https://economycreatorstats.roblox.com' | 'https://engagementpayouts.roblox.com' | 'https://followings.roblox.com' | 'https://friends.roblox.com' | 'https://gameinternationalization.roblox.com' | 'https://games.roblox.com' | 'https://groups.roblox.com' | 'https://inventory.roblox.com' | 'https://itemconfiguration.roblox.com' | 'https://locale.roblox.com' | 'https://localizationtables.roblox.com' | 'https://notifications.roblox.com' | 'https://premiumfeatures.roblox.com' | 'https://presence.roblox.com' | 'https://privatemessages.roblox.com' | 'https://publish.roblox.com' | 'https://thumbnails.roblox.com' | 'https://thumbnailsresizer.roblox.com' | 'https://trades.roblox.com' | 'https://translationroles.roblox.com' | 'https://twostepverification.roblox.com' | 'https://users.roblox.com';

package/dist/index.js

@@ -1,4 +1,11 @@
 import createClient from 'openapi-fetch';
-/** Roblox API client. */
-export const client = createClient({ baseUrl: 'https://apis.roblox.com' });
+export * from './types.js';
+/**
+ * Create a new Roblox API client.
+ * @param url The URL for this client. Default is https://apis.roblox.com
+ * @param options Options to pass to the API client.
+ */
+export function newRobloxAPIClient(url, options) {
+    return createClient({ ...(options ?? {}), ...{ baseUrl: url ?? 'https://apis.roblox.com' } });
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAKzC,yBAAyB;AACzB,MAAM,CAAC,MAAM,MAAM,GAAG,YAAY,CAAQ,EAAE,OAAO,EAAE,yBAAyB,EAAE,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAA+B,MAAM,eAAe,CAAC;AAG5D,cAAc,YAAY,CAAC;AAE3B;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAkB,EAAE,OAAuB;IAC1E,OAAO,YAAY,CAAQ,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,yBAAyB,EAAE,EAAE,CAAC,CAAC;AACzG,CAAC"}

package/dist/types.d.ts

@@ -11445,6 +11445,7 @@ export interface paths {
                  * @description 3: The request did not contain a file to be uploaded.
                  *     4: The file in the request is too large.
                  *     5: The duration of the audio file is too long.
+                 *     7: Failed to parse the file.
                  *     8: The file type is not supported.
                  *     9: The file is corrupted
                  *     11: Missing permissions to spend group funds.
@@ -11481,10 +11482,7 @@ export interface paths {
                     };
                     content?: never;
                 };
-                /**
-                 * @description 7: Failed to parse the file.
-                 *     19: Asset creation was unavailable. Please try again.
-                 */
+                /** @description 19: Asset creation was unavailable. Please try again. */
                 500: {
                     headers: {
                         [name: string]: unknown;
@@ -11538,6 +11536,7 @@ export interface paths {
                  * @description 3: The request did not contain a file to be uploaded.
                  *     4: The file in the request is too large.
                  *     5: The duration of the audio file is too long.
+                 *     7: Failed to parse the file.
                  *     8: The file type is not supported.
                  *     9: The file is corrupted
                  *     18: Too many requests. Try again later.
@@ -11565,13 +11564,6 @@ export interface paths {
                     };
                     content?: never;
                 };
-                /** @description 7: Failed to parse the file. */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content?: never;
-                };
             };
         };
         delete?: never;
@@ -19318,6 +19310,8 @@ export interface paths {
                 query: {
                     /** @description A list of universe Ids. Cannot exceed a maximum of 50 IDs. */
                     universeIds: number[];
+                    /** @description Optional comma-separated list of field names to include in the response. When omitted, all fields are returned. */
+                    fields?: string;
                 };
                 header?: never;
                 path?: never;
@@ -50354,6 +50348,17 @@ export interface components {
              */
             bypassSlowMode?: boolean;
         };
+        "GroupsApi.Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Assets.AssetType_": {
+            /** Format: int64 */
+            id?: number;
+            /**
+             * Format: int32
+             * @description ['Image' = 1, 'TShirt' = 2, 'Audio' = 3, 'Mesh' = 4, 'Lua' = 5, 'HTML' = 6, 'Text' = 7, 'Hat' = 8, 'Place' = 9, 'Model' = 10, 'Shirt' = 11, 'Pants' = 12, 'Decal' = 13, 'Avatar' = 16, 'Head' = 17, 'Face' = 18, 'Gear' = 19, 'Badge' = 21, 'GroupEmblem' = 22, 'Animation' = 24, 'Arms' = 25, 'Legs' = 26, 'Torso' = 27, 'RightArm' = 28, 'LeftArm' = 29, 'LeftLeg' = 30, 'RightLeg' = 31, 'Package' = 32, 'YouTubeVideo' = 33, 'GamePass' = 34, 'App' = 35, 'Code' = 37, 'Plugin' = 38, 'SolidModel' = 39, 'MeshPart' = 40, 'HairAccessory' = 41, 'FaceAccessory' = 42, 'NeckAccessory' = 43, 'ShoulderAccessory' = 44, 'FrontAccessory' = 45, 'BackAccessory' = 46, 'WaistAccessory' = 47, 'ClimbAnimation' = 48, 'DeathAnimation' = 49, 'FallAnimation' = 50, 'IdleAnimation' = 51, 'JumpAnimation' = 52, 'RunAnimation' = 53, 'SwimAnimation' = 54, 'WalkAnimation' = 55, 'PoseAnimation' = 56, 'LocalizationTableManifest' = 59, 'LocalizationTableTranslation' = 60, 'EmoteAnimation' = 61, 'Video' = 62, 'TexturePack' = 63, 'TShirtAccessory' = 64, 'ShirtAccessory' = 65, 'PantsAccessory' = 66, 'JacketAccessory' = 67, 'SweaterAccessory' = 68, 'ShortsAccessory' = 69, 'LeftShoeAccessory' = 70, 'RightShoeAccessory' = 71, 'DressSkirtAccessory' = 72, 'FontFamily' = 73, 'FontFace' = 74, 'MeshHiddenSurfaceRemoval' = 75, 'EyebrowAccessory' = 76, 'EyelashAccessory' = 77, 'MoodAnimation' = 78, 'DynamicHead' = 79, 'CodeSnippet' = 80, 'AdsVideo' = 81, 'OtaUpdate' = 82, 'Screenshot' = 83, 'RuntimePropertySet' = 84, 'StorePreviewVideo' = 85, 'GamePreviewVideo' = 86, 'CreatorExperienceConfig' = 87, 'FaceMakeup' = 88, 'LipMakeup' = 89, 'EyeMakeup' = 90, 'VoxelFragment' = 91]
+             * @enum {integer}
+             */
+            type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 16 | 17 | 18 | 19 | 21 | 22 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91;
+            name?: string;
+        };
         HttpContent: {
             readonly headers?: components["schemas"]["StringStringIEnumerableKeyValuePair"][] | null;
         };
@@ -55617,6 +55622,7 @@ export interface components {
             product?: components["schemas"]["Roblox.Catalog.Api.BundleProductModel"];
             itemRestrictions?: (1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9)[];
             collectibleItemDetail?: components["schemas"]["Roblox.Catalog.Api.CollectibleItemDetail"];
+            discountInformation?: components["schemas"]["Roblox.Catalog.Api.DiscountInformation"];
         };
         /** @description A model to represent bundle favorites. */
         "Roblox.Catalog.Api.BundleFavoriteModel": {
@@ -56005,6 +56011,23 @@ export interface components {
              */
             resaleRestriction?: 0 | 1 | 2;
         };
+        "Roblox.Catalog.Api.Discount": {
+            /** Format: int64 */
+            robuxDiscountAmount?: number;
+            /** Format: float */
+            robuxDiscountPercentage?: number;
+            discountCampaign?: string;
+            localizedDiscountAttribution?: string;
+        };
+        "Roblox.Catalog.Api.DiscountInformation": {
+            /** Format: int64 */
+            originalPrice?: number;
+            /** Format: float */
+            totalDiscountPercentage?: number;
+            /** Format: int64 */
+            totalDiscountAmount?: number;
+            discounts?: components["schemas"]["Roblox.Catalog.Api.Discount"][];
+        };
         "Roblox.Catalog.Api.ElasticsearchDebugInfo": {
             /** @description Gets or sets the nest query that resulted from the operation. */
             elasticsearchQuery?: string;
@@ -56124,6 +56147,7 @@ export interface components {
              * @description The price for the timed option.
              */
             price?: number;
+            discountInformation?: components["schemas"]["Roblox.Catalog.Api.DiscountInformation"];
             /** @description To indicate if this option is selected by the client. */
             selected?: boolean;
         };
@@ -57368,6 +57392,11 @@ export interface components {
             refundLink?: string;
             localizedFiatPrice?: string;
             refundPolicy?: components["schemas"]["Roblox.Games.Api.Models.Response.RefundPolicy"];
+            /**
+             * @description Canonical URL path for the game page, e.g. /games/{placeId}/{canonical-slug}.
+             *     It must be the same as the canonical URL (rel-canonical meta tag) on the game's EDP.
+             */
+            canonicalUrlPath?: string;
         };
         /** @description Game favorite response model. */
         "Roblox.Games.Api.Models.Response.GameFavoriteResponse": {
@@ -58365,7 +58394,7 @@ export interface components {
             /** @description The game description. */
             description?: string;
             creator?: components["schemas"]["Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Core.CreatorType_"];
-            rootPlace?: components["schemas"]["Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Assets.AssetType_"];
+            rootPlace?: components["schemas"]["GroupsApi.Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Assets.AssetType_"];
             /**
              * Format: date-time
              * @description When the game was created.
@@ -60999,10 +61028,10 @@ export interface components {
             id?: number;
             /**
              * Format: int32
-             * @description ['Image' = 1, 'TShirt' = 2, 'Audio' = 3, 'Mesh' = 4, 'Lua' = 5, 'HTML' = 6, 'Text' = 7, 'Hat' = 8, 'Place' = 9, 'Model' = 10, 'Shirt' = 11, 'Pants' = 12, 'Decal' = 13, 'Avatar' = 16, 'Head' = 17, 'Face' = 18, 'Gear' = 19, 'Badge' = 21, 'GroupEmblem' = 22, 'Animation' = 24, 'Arms' = 25, 'Legs' = 26, 'Torso' = 27, 'RightArm' = 28, 'LeftArm' = 29, 'LeftLeg' = 30, 'RightLeg' = 31, 'Package' = 32, 'YouTubeVideo' = 33, 'GamePass' = 34, 'App' = 35, 'Code' = 37, 'Plugin' = 38, 'SolidModel' = 39, 'MeshPart' = 40, 'HairAccessory' = 41, 'FaceAccessory' = 42, 'NeckAccessory' = 43, 'ShoulderAccessory' = 44, 'FrontAccessory' = 45, 'BackAccessory' = 46, 'WaistAccessory' = 47, 'ClimbAnimation' = 48, 'DeathAnimation' = 49, 'FallAnimation' = 50, 'IdleAnimation' = 51, 'JumpAnimation' = 52, 'RunAnimation' = 53, 'SwimAnimation' = 54, 'WalkAnimation' = 55, 'PoseAnimation' = 56, 'LocalizationTableManifest' = 59, 'LocalizationTableTranslation' = 60, 'EmoteAnimation' = 61, 'Video' = 62, 'TexturePack' = 63, 'TShirtAccessory' = 64, 'ShirtAccessory' = 65, 'PantsAccessory' = 66, 'JacketAccessory' = 67, 'SweaterAccessory' = 68, 'ShortsAccessory' = 69, 'LeftShoeAccessory' = 70, 'RightShoeAccessory' = 71, 'DressSkirtAccessory' = 72, 'FontFamily' = 73, 'FontFace' = 74, 'MeshHiddenSurfaceRemoval' = 75, 'EyebrowAccessory' = 76, 'EyelashAccessory' = 77, 'MoodAnimation' = 78, 'DynamicHead' = 79, 'CodeSnippet' = 80, 'AdsVideo' = 81, 'OtaUpdate' = 82, 'Screenshot' = 83, 'RuntimePropertySet' = 84, 'StorePreviewVideo' = 85, 'GamePreviewVideo' = 86, 'CreatorExperienceConfig' = 87, 'FaceMakeup' = 88, 'LipMakeup' = 89, 'EyeMakeup' = 90, 'VoxelFragment' = 91]
+             * @description ['Image' = 1, 'TShirt' = 2, 'Audio' = 3, 'Mesh' = 4, 'Lua' = 5, 'HTML' = 6, 'Text' = 7, 'Hat' = 8, 'Place' = 9, 'Model' = 10, 'Shirt' = 11, 'Pants' = 12, 'Decal' = 13, 'Avatar' = 16, 'Head' = 17, 'Face' = 18, 'Gear' = 19, 'Badge' = 21, 'GroupEmblem' = 22, 'Animation' = 24, 'Arms' = 25, 'Legs' = 26, 'Torso' = 27, 'RightArm' = 28, 'LeftArm' = 29, 'LeftLeg' = 30, 'RightLeg' = 31, 'Package' = 32, 'YouTubeVideo' = 33, 'GamePass' = 34, 'App' = 35, 'Code' = 37, 'Plugin' = 38, 'SolidModel' = 39, 'MeshPart' = 40, 'HairAccessory' = 41, 'FaceAccessory' = 42, 'NeckAccessory' = 43, 'ShoulderAccessory' = 44, 'FrontAccessory' = 45, 'BackAccessory' = 46, 'WaistAccessory' = 47, 'ClimbAnimation' = 48, 'DeathAnimation' = 49, 'FallAnimation' = 50, 'IdleAnimation' = 51, 'JumpAnimation' = 52, 'RunAnimation' = 53, 'SwimAnimation' = 54, 'WalkAnimation' = 55, 'PoseAnimation' = 56, 'LocalizationTableManifest' = 59, 'LocalizationTableTranslation' = 60, 'EmoteAnimation' = 61, 'Video' = 62, 'TexturePack' = 63, 'TShirtAccessory' = 64, 'ShirtAccessory' = 65, 'PantsAccessory' = 66, 'JacketAccessory' = 67, 'SweaterAccessory' = 68, 'ShortsAccessory' = 69, 'LeftShoeAccessory' = 70, 'RightShoeAccessory' = 71, 'DressSkirtAccessory' = 72, 'FontFamily' = 73, 'FontFace' = 74, 'MeshHiddenSurfaceRemoval' = 75, 'EyebrowAccessory' = 76, 'EyelashAccessory' = 77, 'MoodAnimation' = 78, 'DynamicHead' = 79, 'CodeSnippet' = 80, 'AdsVideo' = 81, 'OtaUpdate' = 82, 'Screenshot' = 83, 'RuntimePropertySet' = 84, 'StorePreviewVideo' = 85, 'GamePreviewVideo' = 86, 'CreatorExperienceConfig' = 87, 'FaceMakeup' = 88, 'LipMakeup' = 89, 'EyeMakeup' = 90, 'VoxelFragment' = 91, 'AvatarBackground' = 92]
              * @enum {integer}
              */
-            type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 16 | 17 | 18 | 19 | 21 | 22 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91;
+            type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 16 | 17 | 18 | 19 | 21 | 22 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92;
             name?: string;
         };
         "Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Badges.BadgeAwarderType_": {
@@ -61398,8 +61427,8 @@ export interface components {
             /** @description The search terms used to filter the results. Only one of 'query' and 'image' can be present in a query. */
             query?: string | null;
             /**
-             * Format: binary
-             * @description The image file to search by. Only one of 'query' and 'image' can be present in a query.
+             * Format: byte
+             * @description The image file to search by. The image must be base64 encoded to be used in the search. Only one of 'query' and 'image' can be present in a query.
              */
             image?: string | null;
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jacobhumston/roblox-openapi-ts",
-    "version": "1.0.0",
+    "version": "1.0.3",
     "description": "An automatically updated Roblox API client based on their OpenAPI documentation.",
     "keywords": [
         "roblox",
@@ -11,14 +11,13 @@
     "module": "dist/index.js",
     "types": "dist/index.d.ts",
     "license": "MIT",
-    "homepage": "https://github.com/jacobhumston/flags.ts",
+    "homepage": "https://github.com/jacobhumston/roblox-openapi-ts",
     "repository": {
-        "url": "https://github.com/jacobhumston/flags.ts"
+        "url": "https://github.com/jacobhumston/roblox-openapi-ts"
     },
     "scripts": {
         "format": "bun x prettier --write --cache .",
-        "compile": "bun run tools/build.ts && del dist/ && bun x tsc && bun run tools/bundle.ts",
-        "docs": "del docs/ && bun x typedoc src/index.ts --options typedoc.json && bun x prettier --write --ignore-path null docs/"
+        "compile": "bun run tools/build.ts && del dist/ && bun x tsc"
     },
     "devDependencies": {
         "@ianvs/prettier-plugin-sort-imports": "^4.7.1",