rozod 6.4.2 → 6.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +35 -57
  2. package/lib/endpoints/authv1.d.ts +4 -1
  3. package/lib/endpoints/authv1.js +4 -1
  4. package/lib/endpoints/authv2.d.ts +3 -1
  5. package/lib/endpoints/authv2.js +3 -1
  6. package/lib/endpoints/catalogv1.d.ts +1 -0
  7. package/lib/endpoints/catalogv1.js +1 -0
  8. package/lib/endpoints/catalogv2.d.ts +1 -0
  9. package/lib/endpoints/catalogv2.js +1 -0
  10. package/lib/endpoints/friendsv1.d.ts +6 -1
  11. package/lib/endpoints/friendsv1.js +6 -1
  12. package/lib/endpoints/gameinternationalizationv1.d.ts +40 -0
  13. package/lib/endpoints/gameinternationalizationv1.js +42 -1
  14. package/lib/endpoints/gamesv1.d.ts +12 -0
  15. package/lib/endpoints/gamesv1.js +12 -0
  16. package/lib/endpoints/groupsv1.d.ts +8 -1
  17. package/lib/endpoints/groupsv1.js +8 -1
  18. package/lib/endpoints/groupsv2.d.ts +151 -0
  19. package/lib/endpoints/groupsv2.js +147 -1
  20. package/lib/endpoints/itemconfigurationv1.d.ts +6 -164
  21. package/lib/endpoints/itemconfigurationv1.js +7 -165
  22. package/lib/endpoints/twostepverificationv1.d.ts +2 -0
  23. package/lib/endpoints/twostepverificationv1.js +2 -0
  24. package/lib/index.js +1 -1
  25. package/lib/opencloud/v1/asset-permissions.d.ts +7 -7
  26. package/lib/opencloud/v1/asset-permissions.js +1 -1
  27. package/lib/opencloud/v1/assets.d.ts +3 -3
  28. package/lib/opencloud/v1/assets.js +1 -1
  29. package/lib/opencloud/v1/datastores-ordered.d.ts +1 -1
  30. package/lib/opencloud/v1/datastores-ordered.js +1 -1
  31. package/lib/opencloud/v1/developer-products.d.ts +7 -7
  32. package/lib/opencloud/v1/developer-products.js +1 -1
  33. package/lib/opencloud/v1/game-passes.d.ts +6 -6
  34. package/lib/opencloud/v1/game-passes.js +1 -1
  35. package/lib/opencloud/v1/messaging.d.ts +2 -0
  36. package/lib/opencloud/v1/messaging.js +2 -0
  37. package/lib/opencloud/v1/secrets-store.d.ts +6 -6
  38. package/lib/opencloud/v1/secrets-store.js +1 -1
  39. package/lib/opencloud/v2/cloud.d.ts +69 -74
  40. package/lib/opencloud/v2/cloud.js +11 -16
  41. package/package.json +4 -3
@@ -155,33 +155,33 @@ export declare const patchCloudV2CreatorStoreProductsCreatorStoreProductId: impo
155
155
  videoAssetId: string;
156
156
  fontFamilyAssetId: string;
157
157
  }, {
158
- path: string;
159
- basePrice: {
158
+ path?: string | undefined;
159
+ basePrice?: {
160
160
  currencyCode: string;
161
161
  quantity: {
162
162
  significand: number;
163
163
  exponent: number;
164
164
  };
165
- };
166
- purchasePrice: {
165
+ } | undefined;
166
+ purchasePrice?: {
167
167
  currencyCode: string;
168
168
  quantity: {
169
169
  significand: number;
170
170
  exponent: number;
171
171
  };
172
- };
173
- published: boolean;
174
- restrictions: ("RESTRICTION_UNSPECIFIED" | "SOLD_ITEM_RESTRICTED" | "SELLER_TEMPORARILY_RESTRICTED" | "SELLER_PERMANENTLY_RESTRICTED" | "SELLER_NO_LONGER_ACTIVE")[];
175
- purchasable: boolean;
176
- userSeller: string;
177
- groupSeller: string;
178
- modelAssetId: string;
179
- pluginAssetId: string;
180
- audioAssetId: string;
181
- decalAssetId: string;
182
- meshPartAssetId: string;
183
- videoAssetId: string;
184
- fontFamilyAssetId: string;
172
+ } | undefined;
173
+ published?: boolean | undefined;
174
+ restrictions?: ("RESTRICTION_UNSPECIFIED" | "SOLD_ITEM_RESTRICTED" | "SELLER_TEMPORARILY_RESTRICTED" | "SELLER_PERMANENTLY_RESTRICTED" | "SELLER_NO_LONGER_ACTIVE")[] | undefined;
175
+ purchasable?: boolean | undefined;
176
+ userSeller?: string | undefined;
177
+ groupSeller?: string | undefined;
178
+ modelAssetId?: string | undefined;
179
+ pluginAssetId?: string | undefined;
180
+ audioAssetId?: string | undefined;
181
+ decalAssetId?: string | undefined;
182
+ meshPartAssetId?: string | undefined;
183
+ videoAssetId?: string | undefined;
184
+ fontFamilyAssetId?: string | undefined;
185
185
  }>;
186
186
  /**
187
187
  * `BETA`
@@ -506,11 +506,11 @@ export declare const patchCloudV2GroupsGroupIdMembershipsMembershipId: import(".
506
506
  user: string;
507
507
  role: string;
508
508
  }, {
509
- path: string;
510
- createTime: string;
511
- updateTime: string;
512
- user: string;
513
- role: string;
509
+ path?: string | undefined;
510
+ createTime?: string | undefined;
511
+ updateTime?: string | undefined;
512
+ user?: string | undefined;
513
+ role?: string | undefined;
514
514
  }>;
515
515
  /**
516
516
  * `BETA`
@@ -795,7 +795,6 @@ export declare const patchCloudV2UniversesUniverseId: import("../..").EndpointGe
795
795
  vrEnabled?: boolean | undefined;
796
796
  rootPlace?: string | undefined;
797
797
  }, {
798
- templateRootPlace: string;
799
798
  path?: string | undefined;
800
799
  createTime?: string | undefined;
801
800
  updateTime?: string | undefined;
@@ -841,6 +840,7 @@ export declare const patchCloudV2UniversesUniverseId: import("../..").EndpointGe
841
840
  consoleEnabled?: boolean | undefined;
842
841
  vrEnabled?: boolean | undefined;
843
842
  rootPlace?: string | undefined;
843
+ templateRootPlace?: string | undefined;
844
844
  }>;
845
845
  /**
846
846
  * `BETA`
@@ -1328,16 +1328,16 @@ export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntries
1328
1328
  attributes: Record<string, never>;
1329
1329
  }, {
1330
1330
  [x: string]: unknown;
1331
- path: string;
1332
- createTime: string;
1333
- revisionId: string;
1334
- revisionCreateTime: string;
1335
- state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
1336
- etag: string;
1337
- value: unknown;
1338
- id: string;
1339
- users: string[];
1340
- attributes: Record<string, never>;
1331
+ path?: string | undefined;
1332
+ createTime?: string | undefined;
1333
+ revisionId?: string | undefined;
1334
+ revisionCreateTime?: string | undefined;
1335
+ state?: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED" | undefined;
1336
+ etag?: string | undefined;
1337
+ value?: unknown;
1338
+ id?: string | undefined;
1339
+ users?: string[] | undefined;
1340
+ attributes?: Record<string, never> | undefined;
1341
1341
  }>;
1342
1342
  /**
1343
1343
  * `STABLE`
@@ -1684,16 +1684,16 @@ export declare const patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesS
1684
1684
  attributes: Record<string, never>;
1685
1685
  }, {
1686
1686
  [x: string]: unknown;
1687
- path: string;
1688
- createTime: string;
1689
- revisionId: string;
1690
- revisionCreateTime: string;
1691
- state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
1692
- etag: string;
1693
- value: unknown;
1694
- id: string;
1695
- users: string[];
1696
- attributes: Record<string, never>;
1687
+ path?: string | undefined;
1688
+ createTime?: string | undefined;
1689
+ revisionId?: string | undefined;
1690
+ revisionCreateTime?: string | undefined;
1691
+ state?: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED" | undefined;
1692
+ etag?: string | undefined;
1693
+ value?: unknown;
1694
+ id?: string | undefined;
1695
+ users?: string[] | undefined;
1696
+ attributes?: Record<string, never> | undefined;
1697
1697
  }>;
1698
1698
  /**
1699
1699
  * `STABLE`
@@ -2136,14 +2136,14 @@ export declare const patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedM
2136
2136
  stringSortKey: string;
2137
2137
  numericSortKey: number;
2138
2138
  }, {
2139
- path: string;
2140
- value: unknown;
2141
- etag: string;
2142
- ttl: string;
2143
- expireTime: string;
2144
- id: string;
2145
- stringSortKey: string;
2146
- numericSortKey: number;
2139
+ path?: string | undefined;
2140
+ value?: unknown;
2141
+ etag?: string | undefined;
2142
+ ttl?: string | undefined;
2143
+ expireTime?: string | undefined;
2144
+ id?: string | undefined;
2145
+ stringSortKey?: string | undefined;
2146
+ numericSortKey?: number | undefined;
2147
2147
  }>;
2148
2148
  /**
2149
2149
  * `STABLE`
@@ -2306,9 +2306,9 @@ export declare const patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedData
2306
2306
  value: number;
2307
2307
  id: string;
2308
2308
  }, {
2309
- path: string;
2310
- value: number;
2311
- id: string;
2309
+ path?: string | undefined;
2310
+ value?: number | undefined;
2311
+ id?: string | undefined;
2312
2312
  }>;
2313
2313
  /**
2314
2314
  * `STABLE`
@@ -2397,7 +2397,6 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceId: import("../..
2397
2397
  root?: boolean | undefined;
2398
2398
  universeRuntimeCreation?: boolean | undefined;
2399
2399
  }, {
2400
- templatePlace: string;
2401
2400
  path?: string | undefined;
2402
2401
  createTime?: string | undefined;
2403
2402
  updateTime?: string | undefined;
@@ -2406,6 +2405,7 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceId: import("../..
2406
2405
  serverSize?: number | undefined;
2407
2406
  root?: boolean | undefined;
2408
2407
  universeRuntimeCreation?: boolean | undefined;
2408
+ templatePlace?: string | undefined;
2409
2409
  }>;
2410
2410
  /**
2411
2411
  * `BETA`
@@ -2484,9 +2484,9 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstan
2484
2484
  '@type': string;
2485
2485
  };
2486
2486
  }, {
2487
- path: string;
2488
- hasChildren: boolean;
2489
- engineInstance: {
2487
+ path?: string | undefined;
2488
+ hasChildren?: boolean | undefined;
2489
+ engineInstance?: {
2490
2490
  Id: string;
2491
2491
  Parent: string;
2492
2492
  Name: string;
@@ -2506,7 +2506,7 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstan
2506
2506
  Source: string;
2507
2507
  };
2508
2508
  };
2509
- };
2509
+ } | undefined;
2510
2510
  }>;
2511
2511
  /**
2512
2512
  * `BETA`
@@ -2735,10 +2735,10 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestriction
2735
2735
  inherited: boolean;
2736
2736
  };
2737
2737
  }, {
2738
- path: string;
2739
- updateTime: string;
2740
- user: string;
2741
- gameJoinRestriction: {
2738
+ path?: string | undefined;
2739
+ updateTime?: string | undefined;
2740
+ user?: string | undefined;
2741
+ gameJoinRestriction?: {
2742
2742
  active: boolean;
2743
2743
  startTime: string;
2744
2744
  duration: string;
@@ -2746,7 +2746,7 @@ export declare const patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestriction
2746
2746
  displayReason: string;
2747
2747
  excludeAltAccounts: boolean;
2748
2748
  inherited: boolean;
2749
- };
2749
+ } | undefined;
2750
2750
  }>;
2751
2751
  /**
2752
2752
  * `BETA`
@@ -3147,10 +3147,10 @@ export declare const patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrict
3147
3147
  inherited: boolean;
3148
3148
  };
3149
3149
  }, {
3150
- path: string;
3151
- updateTime: string;
3152
- user: string;
3153
- gameJoinRestriction: {
3150
+ path?: string | undefined;
3151
+ updateTime?: string | undefined;
3152
+ user?: string | undefined;
3153
+ gameJoinRestriction?: {
3154
3154
  active: boolean;
3155
3155
  startTime: string;
3156
3156
  duration: string;
@@ -3158,7 +3158,7 @@ export declare const patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrict
3158
3158
  displayReason: string;
3159
3159
  excludeAltAccounts: boolean;
3160
3160
  inherited: boolean;
3161
- };
3161
+ } | undefined;
3162
3162
  }>;
3163
3163
  /**
3164
3164
  * `BETA`
@@ -3313,11 +3313,6 @@ scopes it has or who created it.
3313
3313
  * Their inventory can still be viewed with an OAuth2 token if the target
3314
3314
  user authorizes an app requesting permissions for the
3315
3315
  `user.inventory-item:read` scope.
3316
-
3317
- Rate Limits:
3318
- * API Keys - 100 requests/minute per API key owner (can be user or group).
3319
- Rate limits are enforced across all of an owner's API keys.
3320
- * OAuth2 Tokens - 20 requests/minute per OAuth2 access token
3321
3316
  *
3322
3317
  * **Scopes:** `user.inventory-item:read`
3323
3318
  * **Engine:** Usable with HttpService
@@ -788,7 +788,7 @@ exports.patchCloudV2CreatorStoreProductsCreatorStoreProductId = (0, __1.endpoint
788
788
  updateMask: zod_1.z.string().optional(),
789
789
  allowMissing: zod_1.z.boolean().optional(),
790
790
  },
791
- body: CreatorStoreProduct,
791
+ body: CreatorStoreProduct.partial(),
792
792
  response: CreatorStoreProduct,
793
793
  errors: [],
794
794
  });
@@ -1154,7 +1154,7 @@ exports.patchCloudV2GroupsGroupIdMembershipsMembershipId = (0, __1.endpoint)({
1154
1154
  group_id: zod_1.z.string(),
1155
1155
  membership_id: zod_1.z.string(),
1156
1156
  },
1157
- body: GroupMembership,
1157
+ body: GroupMembership.partial(),
1158
1158
  response: GroupMembership,
1159
1159
  errors: [],
1160
1160
  });
@@ -1317,7 +1317,7 @@ exports.patchCloudV2UniversesUniverseId = (0, __1.endpoint)({
1317
1317
  universe_id: zod_1.z.string(),
1318
1318
  updateMask: zod_1.z.string().optional(),
1319
1319
  },
1320
- body: Universe,
1320
+ body: Universe.partial(),
1321
1321
  response: Universe,
1322
1322
  errors: [],
1323
1323
  });
@@ -1869,7 +1869,7 @@ exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdEntriesEntryId = (0,
1869
1869
  entry_id: zod_1.z.string(),
1870
1870
  allowMissing: zod_1.z.boolean().optional(),
1871
1871
  },
1872
- body: DataStoreEntry,
1872
+ body: DataStoreEntry.partial(),
1873
1873
  response: DataStoreEntry,
1874
1874
  errors: [],
1875
1875
  });
@@ -2234,7 +2234,7 @@ exports.patchCloudV2UniversesUniverseIdDataStoresDataStoreIdScopesScopeIdEntries
2234
2234
  entry_id: zod_1.z.string(),
2235
2235
  allowMissing: zod_1.z.boolean().optional(),
2236
2236
  },
2237
- body: DataStoreEntry,
2237
+ body: DataStoreEntry.partial(),
2238
2238
  response: DataStoreEntry,
2239
2239
  errors: [],
2240
2240
  });
@@ -2732,7 +2732,7 @@ exports.patchCloudV2UniversesUniverseIdMemoryStoreSortedMapsSortedMapIdItemsItem
2732
2732
  item_id: zod_1.z.string(),
2733
2733
  allowMissing: zod_1.z.boolean().optional(),
2734
2734
  },
2735
- body: MemoryStoreSortedMapItem,
2735
+ body: MemoryStoreSortedMapItem.partial(),
2736
2736
  response: MemoryStoreSortedMapItem,
2737
2737
  errors: [],
2738
2738
  });
@@ -2953,7 +2953,7 @@ exports.patchCloudV2UniversesUniverseIdOrderedDataStoresOrderedDataStoreIdScopes
2953
2953
  entry_id: zod_1.z.string(),
2954
2954
  allowMissing: zod_1.z.boolean().optional(),
2955
2955
  },
2956
- body: OrderedDataStoreEntry,
2956
+ body: OrderedDataStoreEntry.partial(),
2957
2957
  response: OrderedDataStoreEntry,
2958
2958
  errors: [],
2959
2959
  });
@@ -3059,7 +3059,7 @@ exports.patchCloudV2UniversesUniverseIdPlacesPlaceId = (0, __1.endpoint)({
3059
3059
  place_id: zod_1.z.string(),
3060
3060
  updateMask: zod_1.z.string().optional(),
3061
3061
  },
3062
- body: Place,
3062
+ body: Place.partial(),
3063
3063
  response: Place,
3064
3064
  errors: [],
3065
3065
  });
@@ -3135,7 +3135,7 @@ exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdInstancesInstanceId = (0, __
3135
3135
  instance_id: zod_1.z.string(),
3136
3136
  updateMask: zod_1.z.string().optional(),
3137
3137
  },
3138
- body: Instance,
3138
+ body: Instance.partial(),
3139
3139
  response: Operation,
3140
3140
  errors: [],
3141
3141
  });
@@ -3347,7 +3347,7 @@ exports.patchCloudV2UniversesUniverseIdPlacesPlaceIdUserRestrictionsUserRestrict
3347
3347
  'idempotencyKey.key': zod_1.z.string().optional(),
3348
3348
  'idempotencyKey.firstSent': zod_1.z.string().datetime({ offset: true }).optional(),
3349
3349
  },
3350
- body: UserRestriction,
3350
+ body: UserRestriction.partial(),
3351
3351
  response: UserRestriction,
3352
3352
  errors: [],
3353
3353
  });
@@ -3730,7 +3730,7 @@ exports.patchCloudV2UniversesUniverseIdUserRestrictionsUserRestrictionId = (0, _
3730
3730
  'idempotencyKey.key': zod_1.z.string().optional(),
3731
3731
  'idempotencyKey.firstSent': zod_1.z.string().datetime({ offset: true }).optional(),
3732
3732
  },
3733
- body: UserRestriction,
3733
+ body: UserRestriction.partial(),
3734
3734
  response: UserRestriction,
3735
3735
  errors: [],
3736
3736
  });
@@ -3883,11 +3883,6 @@ scopes it has or who created it.
3883
3883
  * Their inventory can still be viewed with an OAuth2 token if the target
3884
3884
  user authorizes an app requesting permissions for the
3885
3885
  `user.inventory-item:read` scope.
3886
-
3887
- Rate Limits:
3888
- * API Keys - 100 requests/minute per API key owner (can be user or group).
3889
- Rate limits are enforced across all of an owner's API keys.
3890
- * OAuth2 Tokens - 20 requests/minute per OAuth2 access token
3891
3886
  *
3892
3887
  * **Scopes:** `user.inventory-item:read`
3893
3888
  * **Engine:** Usable with HttpService
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rozod",
3
- "version": "6.4.2",
3
+ "version": "6.5.1",
4
4
  "description": "A TypeScript wrapper for the Roblox API",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -12,7 +12,9 @@
12
12
  "prepublishOnly": "npm test",
13
13
  "version": "npm run format && git add -A src",
14
14
  "generate": "node ./zodios_endpoints.js",
15
- "docs": "typedoc"
15
+ "docs": "cd docs && node scripts/generate-reference.mjs && bunx astro build",
16
+ "docs:dev": "cd docs && node scripts/generate-reference.mjs && bunx astro dev",
17
+ "docs:preview": "cd docs && bunx astro preview"
16
18
  },
17
19
  "author": "AlroviOfficial",
18
20
  "license": "ISC",
@@ -46,7 +48,6 @@
46
48
  "prettier": "^3.3.3",
47
49
  "swagger2openapi": "^7.0.8",
48
50
  "ts-jest": "^29.2.5",
49
- "typedoc": "^0.28.9",
50
51
  "typescript": "^5.6.2"
51
52
  },
52
53
  "keywords": [