rozod 6.7.0 → 6.8.0

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 (70) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +75 -451
  3. package/lib/endpoints/accountinformationv1.d.ts +50 -87
  4. package/lib/endpoints/accountinformationv1.js +46 -90
  5. package/lib/endpoints/assetdeliveryv1.d.ts +39 -0
  6. package/lib/endpoints/assetdeliveryv1.js +39 -0
  7. package/lib/endpoints/assetdeliveryv2.d.ts +27 -0
  8. package/lib/endpoints/assetdeliveryv2.js +27 -0
  9. package/lib/endpoints/authv1.d.ts +71 -3
  10. package/lib/endpoints/authv1.js +70 -4
  11. package/lib/endpoints/authv2.d.ts +22 -1
  12. package/lib/endpoints/authv2.js +23 -2
  13. package/lib/endpoints/avatarv1.d.ts +9 -6
  14. package/lib/endpoints/avatarv1.js +9 -6
  15. package/lib/endpoints/avatarv2.d.ts +11 -5
  16. package/lib/endpoints/avatarv2.js +11 -5
  17. package/lib/endpoints/avatarv3.d.ts +16 -7
  18. package/lib/endpoints/avatarv3.js +16 -7
  19. package/lib/endpoints/badgesv1.d.ts +4 -0
  20. package/lib/endpoints/badgesv1.js +4 -0
  21. package/lib/endpoints/catalogv1.d.ts +25 -3
  22. package/lib/endpoints/catalogv1.js +21 -3
  23. package/lib/endpoints/catalogv2.d.ts +294 -50
  24. package/lib/endpoints/catalogv2.js +256 -24
  25. package/lib/endpoints/clientsettingsv2.d.ts +6 -0
  26. package/lib/endpoints/clientsettingsv2.js +6 -0
  27. package/lib/endpoints/contactsv1.d.ts +18 -22
  28. package/lib/endpoints/contactsv1.js +14 -22
  29. package/lib/endpoints/developv1.d.ts +36 -1
  30. package/lib/endpoints/developv1.js +12 -3
  31. package/lib/endpoints/developv2.d.ts +32 -3
  32. package/lib/endpoints/developv2.js +16 -5
  33. package/lib/endpoints/friendsv1.d.ts +222 -314
  34. package/lib/endpoints/friendsv1.js +213 -313
  35. package/lib/endpoints/gameinternationalizationv1.d.ts +59 -0
  36. package/lib/endpoints/gameinternationalizationv1.js +57 -1
  37. package/lib/endpoints/gamesv1.d.ts +79 -0
  38. package/lib/endpoints/gamesv1.js +70 -97
  39. package/lib/endpoints/gamesv2.d.ts +12 -0
  40. package/lib/endpoints/gamesv2.js +10 -0
  41. package/lib/endpoints/groupsv1.d.ts +49 -4
  42. package/lib/endpoints/groupsv1.js +55 -7
  43. package/lib/endpoints/groupsv2.d.ts +2 -0
  44. package/lib/endpoints/groupsv2.js +2 -0
  45. package/lib/endpoints/inventoryv1.d.ts +3 -1
  46. package/lib/endpoints/inventoryv1.js +3 -1
  47. package/lib/endpoints/inventoryv2.d.ts +70 -0
  48. package/lib/endpoints/inventoryv2.js +68 -1
  49. package/lib/endpoints/localev1.d.ts +27 -0
  50. package/lib/endpoints/localev1.js +28 -1
  51. package/lib/endpoints/publishv1.d.ts +3 -6
  52. package/lib/endpoints/publishv1.js +3 -6
  53. package/lib/endpoints/thumbnailsv1.d.ts +44 -87
  54. package/lib/endpoints/thumbnailsv1.js +25 -0
  55. package/lib/index.d.ts +96 -3
  56. package/lib/index.js +114 -1
  57. package/lib/opencloud/v1/asset-permissions.d.ts +1 -1
  58. package/lib/opencloud/v1/assets.d.ts +9 -9
  59. package/lib/opencloud/v1/datastores-ordered.d.ts +6 -6
  60. package/lib/opencloud/v1/datastores.d.ts +8 -8
  61. package/lib/opencloud/v1/developer-products.d.ts +4 -4
  62. package/lib/opencloud/v1/game-passes.d.ts +4 -4
  63. package/lib/opencloud/v1/messaging.d.ts +1 -1
  64. package/lib/opencloud/v1/open-eval.d.ts +2 -2
  65. package/lib/opencloud/v1/secrets-store.d.ts +5 -5
  66. package/lib/opencloud/v1/toolbox.d.ts +2 -2
  67. package/lib/opencloud/v1/universes.d.ts +1 -1
  68. package/lib/opencloud/v2/cloud.d.ts +197 -87
  69. package/lib/opencloud/v2/cloud.js +68 -15
  70. package/package.json +108 -108
@@ -158,14 +158,14 @@ export const patchOutfitsUseroutfitid = endpoint({
158
158
  errors: [
159
159
  {
160
160
  status: 400,
161
- description: `1: The specified userOutfit does not exist!
162
- 1: Must provide both assetIds and bodyColors in to update outfit contents.
163
- 3: Body colors must be valid BrickColor IDs
161
+ description: `3: Body colors must be valid BrickColor IDs
164
162
  4: Invalid outfit name
165
163
  5: Asset is not wearable by you
166
164
  8: Invalid Player Avatar Type. Valid types are R6 and R15
167
165
  11: Meta does not apply to specified asset type
168
- 12: Meta is required for this specific asset type`,
166
+ 12: Meta is required for this specific asset type
167
+ 13: Invalid Outfit Type
168
+ 14: Invalid scale`,
169
169
  },
170
170
  {
171
171
  status: 401,
@@ -176,6 +176,10 @@ export const patchOutfitsUseroutfitid = endpoint({
176
176
  description: `0: Token Validation Failed
177
177
  2: You don't have permission to update this outfit.`,
178
178
  },
179
+ {
180
+ status: 404,
181
+ description: `1: The specified userOutfit does not exist!`,
182
+ },
179
183
  {
180
184
  status: 500,
181
185
  description: `6: An error occurred while trying to update the outfit`,
@@ -215,13 +219,16 @@ export const getOutfitsUseroutfitidDetails = endpoint({
215
219
  errors: [
216
220
  {
217
221
  status: 400,
218
- description: `1: The specified userOutfitId is invalid.
219
- 2: The outfit for the specified userOutfit is invalid.`,
222
+ description: `2: The outfit for the specified userOutfit is invalid.`,
220
223
  },
221
224
  {
222
225
  status: 403,
223
226
  description: `3: The requester does not have access to the details for the given user outfit.`,
224
227
  },
228
+ {
229
+ status: 404,
230
+ description: `1: The specified userOutfitId is invalid.`,
231
+ },
225
232
  ],
226
233
  });
227
234
  /**
@@ -257,7 +264,9 @@ export const postOutfitsCreate = endpoint({
257
264
  7: Invalid Player Avatar Type. Valid types are R6 and R15
258
265
  8: Invalid assetIds
259
266
  9: Meta does not apply to specified asset type
260
- 10: Required meta is not provided for the specific asset type`,
267
+ 10: Required meta is not provided for the specific asset type
268
+ 12: Outfit type invalid or not permitted
269
+ 13: Invalid Scale`,
261
270
  },
262
271
  {
263
272
  status: 401,
@@ -153,14 +153,14 @@ exports.patchOutfitsUseroutfitid = (0, __1.endpoint)({
153
153
  errors: [
154
154
  {
155
155
  status: 400,
156
- description: `1: The specified userOutfit does not exist!
157
- 1: Must provide both assetIds and bodyColors in to update outfit contents.
158
- 3: Body colors must be valid BrickColor IDs
156
+ description: `3: Body colors must be valid BrickColor IDs
159
157
  4: Invalid outfit name
160
158
  5: Asset is not wearable by you
161
159
  8: Invalid Player Avatar Type. Valid types are R6 and R15
162
160
  11: Meta does not apply to specified asset type
163
- 12: Meta is required for this specific asset type`,
161
+ 12: Meta is required for this specific asset type
162
+ 13: Invalid Outfit Type
163
+ 14: Invalid scale`,
164
164
  },
165
165
  {
166
166
  status: 401,
@@ -171,6 +171,10 @@ exports.patchOutfitsUseroutfitid = (0, __1.endpoint)({
171
171
  description: `0: Token Validation Failed
172
172
  2: You don't have permission to update this outfit.`,
173
173
  },
174
+ {
175
+ status: 404,
176
+ description: `1: The specified userOutfit does not exist!`,
177
+ },
174
178
  {
175
179
  status: 500,
176
180
  description: `6: An error occurred while trying to update the outfit`,
@@ -210,13 +214,16 @@ exports.getOutfitsUseroutfitidDetails = (0, __1.endpoint)({
210
214
  errors: [
211
215
  {
212
216
  status: 400,
213
- description: `1: The specified userOutfitId is invalid.
214
- 2: The outfit for the specified userOutfit is invalid.`,
217
+ description: `2: The outfit for the specified userOutfit is invalid.`,
215
218
  },
216
219
  {
217
220
  status: 403,
218
221
  description: `3: The requester does not have access to the details for the given user outfit.`,
219
222
  },
223
+ {
224
+ status: 404,
225
+ description: `1: The specified userOutfitId is invalid.`,
226
+ },
220
227
  ],
221
228
  });
222
229
  /**
@@ -252,7 +259,9 @@ exports.postOutfitsCreate = (0, __1.endpoint)({
252
259
  7: Invalid Player Avatar Type. Valid types are R6 and R15
253
260
  8: Invalid assetIds
254
261
  9: Meta does not apply to specified asset type
255
- 10: Required meta is not provided for the specific asset type`,
262
+ 10: Required meta is not provided for the specific asset type
263
+ 12: Outfit type invalid or not permitted
264
+ 13: Invalid Scale`,
256
265
  },
257
266
  {
258
267
  status: 401,
@@ -288,6 +288,10 @@ export const getUniversesUniverseidBadges = endpoint({
288
288
  response:
289
289
  Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_,
290
290
  errors: [
291
+ {
292
+ status: 400,
293
+ description: `26: The pagination cursor is invalid or incompatible with the current request.`,
294
+ },
291
295
  {
292
296
  status: 404,
293
297
  description: `3: The game is invalid or does not exist.`,
@@ -284,6 +284,10 @@ exports.getUniversesUniverseidBadges = (0, __1.endpoint)({
284
284
  },
285
285
  response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_,
286
286
  errors: [
287
+ {
288
+ status: 400,
289
+ description: `26: The pagination cursor is invalid or incompatible with the current request.`,
290
+ },
287
291
  {
288
292
  status: 404,
289
293
  description: `3: The game is invalid or does not exist.`,
@@ -62,6 +62,18 @@ const Roblox_Catalog_Api_CollectibleItemDetail = z.object({
62
62
  lowestAvailableResaleItemInstanceId: z.string(),
63
63
  resaleRestriction: z.enum(["Invalid", "None", "Disabled"]),
64
64
  });
65
+ const Roblox_Catalog_Api_Discount = z.object({
66
+ robuxDiscountAmount: z.number().int(),
67
+ robuxDiscountPercentage: z.number(),
68
+ discountCampaign: z.string(),
69
+ localizedDiscountAttribution: z.string(),
70
+ });
71
+ const Roblox_Catalog_Api_DiscountInformation = z.object({
72
+ originalPrice: z.number().int(),
73
+ totalDiscountPercentage: z.number(),
74
+ totalDiscountAmount: z.number().int(),
75
+ discounts: z.array(Roblox_Catalog_Api_Discount),
76
+ });
65
77
  const Roblox_Catalog_Api_BundleDetailsModel = z.object({
66
78
  id: z.number().int(),
67
79
  name: z.string(),
@@ -85,6 +97,7 @@ const Roblox_Catalog_Api_BundleDetailsModel = z.object({
85
97
  ])
86
98
  ),
87
99
  collectibleItemDetail: Roblox_Catalog_Api_CollectibleItemDetail,
100
+ discountInformation: Roblox_Catalog_Api_DiscountInformation,
88
101
  });
89
102
  const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Catalog_Api_BundleDetailsModel_ =
90
103
  z.object({
@@ -128,6 +141,7 @@ const Roblox_Catalog_Api_BundleFavoriteModel = z.object({
128
141
  const Roblox_Catalog_Api_TimedOption = z.object({
129
142
  days: z.number().int(),
130
143
  price: z.number().int(),
144
+ discountInformation: Roblox_Catalog_Api_DiscountInformation,
131
145
  selected: z.boolean(),
132
146
  });
133
147
  const Roblox_Catalog_Api_CatalogSearchDetailedResponseItem = z.object({
@@ -218,6 +232,7 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItem = z.object({
218
232
  z.literal(89),
219
233
  z.literal(90),
220
234
  z.literal(91),
235
+ z.literal(92),
221
236
  ]),
222
237
  bundleType: z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4)]),
223
238
  isRecolorable: z.boolean(),
@@ -225,7 +240,9 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItem = z.object({
225
240
  description: z.string(),
226
241
  productId: z.number().int(),
227
242
  bundledItems: z.array(Roblox_Catalog_Api_BundleItemDetailModel),
228
- itemStatus: z.array(z.union([z.literal(1), z.literal(2), z.literal(7)])),
243
+ itemStatus: z.array(
244
+ z.union([z.literal(1), z.literal(2), z.literal(7), z.literal(8)])
245
+ ),
229
246
  itemRestrictions: z.array(
230
247
  z.union([
231
248
  z.literal(1),
@@ -315,6 +332,7 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItemV2 = z.object({
315
332
  bundledItems: z.array(Roblox_Catalog_Api_BundleItemDetailModelV2),
316
333
  taxonomy: z.array(Roblox_Catalog_Api_TaxonomyModel),
317
334
  itemCreatedUtc: z.string().datetime({ offset: true }),
335
+ discountInformation: Roblox_Catalog_Api_DiscountInformation,
318
336
  id: z.number().int(),
319
337
  itemType: z.enum(["Asset", "Bundle"]),
320
338
  assetType: z.union([
@@ -402,13 +420,16 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItemV2 = z.object({
402
420
  z.literal(89),
403
421
  z.literal(90),
404
422
  z.literal(91),
423
+ z.literal(92),
405
424
  ]),
406
425
  bundleType: z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4)]),
407
426
  isRecolorable: z.boolean(),
408
427
  name: z.string(),
409
428
  description: z.string(),
410
429
  productId: z.number().int(),
411
- itemStatus: z.array(z.union([z.literal(1), z.literal(2), z.literal(7)])),
430
+ itemStatus: z.array(
431
+ z.union([z.literal(1), z.literal(2), z.literal(7), z.literal(8)])
432
+ ),
412
433
  itemRestrictions: z.array(
413
434
  z.union([
414
435
  z.literal(1),
@@ -644,8 +665,9 @@ export const getBundlesDetails = endpoint({
644
665
  });
645
666
  /**
646
667
  * @api POST https://catalog.roblox.com/v1/catalog/items/details
647
- * @summary Returns list of item details.
668
+ * @summary Returns details for one or more catalog items.
648
669
  * @param body Roblox.Catalog.Api.MultigetItemDetailsRequestModel.
670
+ * @description There is an item count limit per request. Exceeding this returns 400 Bad Request.
649
671
  */
650
672
  export const postCatalogItemsDetails = endpoint({
651
673
  method: "POST",
@@ -64,6 +64,18 @@ const Roblox_Catalog_Api_CollectibleItemDetail = zod_1.z.object({
64
64
  lowestAvailableResaleItemInstanceId: zod_1.z.string(),
65
65
  resaleRestriction: zod_1.z.enum(['Invalid', 'None', 'Disabled']),
66
66
  });
67
+ const Roblox_Catalog_Api_Discount = zod_1.z.object({
68
+ robuxDiscountAmount: zod_1.z.number().int(),
69
+ robuxDiscountPercentage: zod_1.z.number(),
70
+ discountCampaign: zod_1.z.string(),
71
+ localizedDiscountAttribution: zod_1.z.string(),
72
+ });
73
+ const Roblox_Catalog_Api_DiscountInformation = zod_1.z.object({
74
+ originalPrice: zod_1.z.number().int(),
75
+ totalDiscountPercentage: zod_1.z.number(),
76
+ totalDiscountAmount: zod_1.z.number().int(),
77
+ discounts: zod_1.z.array(Roblox_Catalog_Api_Discount),
78
+ });
67
79
  const Roblox_Catalog_Api_BundleDetailsModel = zod_1.z.object({
68
80
  id: zod_1.z.number().int(),
69
81
  name: zod_1.z.string(),
@@ -85,6 +97,7 @@ const Roblox_Catalog_Api_BundleDetailsModel = zod_1.z.object({
85
97
  zod_1.z.literal(9),
86
98
  ])),
87
99
  collectibleItemDetail: Roblox_Catalog_Api_CollectibleItemDetail,
100
+ discountInformation: Roblox_Catalog_Api_DiscountInformation,
88
101
  });
89
102
  const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Catalog_Api_BundleDetailsModel_ = zod_1.z.object({
90
103
  previousPageCursor: zod_1.z.string(),
@@ -128,6 +141,7 @@ const Roblox_Catalog_Api_BundleFavoriteModel = zod_1.z.object({
128
141
  const Roblox_Catalog_Api_TimedOption = zod_1.z.object({
129
142
  days: zod_1.z.number().int(),
130
143
  price: zod_1.z.number().int(),
144
+ discountInformation: Roblox_Catalog_Api_DiscountInformation,
131
145
  selected: zod_1.z.boolean(),
132
146
  });
133
147
  const Roblox_Catalog_Api_CatalogSearchDetailedResponseItem = zod_1.z.object({
@@ -218,6 +232,7 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItem = zod_1.z.object({
218
232
  zod_1.z.literal(89),
219
233
  zod_1.z.literal(90),
220
234
  zod_1.z.literal(91),
235
+ zod_1.z.literal(92),
221
236
  ]),
222
237
  bundleType: zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(3), zod_1.z.literal(4)]),
223
238
  isRecolorable: zod_1.z.boolean(),
@@ -225,7 +240,7 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItem = zod_1.z.object({
225
240
  description: zod_1.z.string(),
226
241
  productId: zod_1.z.number().int(),
227
242
  bundledItems: zod_1.z.array(Roblox_Catalog_Api_BundleItemDetailModel),
228
- itemStatus: zod_1.z.array(zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(7)])),
243
+ itemStatus: zod_1.z.array(zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(7), zod_1.z.literal(8)])),
229
244
  itemRestrictions: zod_1.z.array(zod_1.z.union([
230
245
  zod_1.z.literal(1),
231
246
  zod_1.z.literal(2),
@@ -311,6 +326,7 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItemV2 = zod_1.z.object({
311
326
  bundledItems: zod_1.z.array(Roblox_Catalog_Api_BundleItemDetailModelV2),
312
327
  taxonomy: zod_1.z.array(Roblox_Catalog_Api_TaxonomyModel),
313
328
  itemCreatedUtc: zod_1.z.string().datetime({ offset: true }),
329
+ discountInformation: Roblox_Catalog_Api_DiscountInformation,
314
330
  id: zod_1.z.number().int(),
315
331
  itemType: zod_1.z.enum(['Asset', 'Bundle']),
316
332
  assetType: zod_1.z.union([
@@ -398,13 +414,14 @@ const Roblox_Catalog_Api_CatalogSearchDetailedResponseItemV2 = zod_1.z.object({
398
414
  zod_1.z.literal(89),
399
415
  zod_1.z.literal(90),
400
416
  zod_1.z.literal(91),
417
+ zod_1.z.literal(92),
401
418
  ]),
402
419
  bundleType: zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(3), zod_1.z.literal(4)]),
403
420
  isRecolorable: zod_1.z.boolean(),
404
421
  name: zod_1.z.string(),
405
422
  description: zod_1.z.string(),
406
423
  productId: zod_1.z.number().int(),
407
- itemStatus: zod_1.z.array(zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(7)])),
424
+ itemStatus: zod_1.z.array(zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(7), zod_1.z.literal(8)])),
408
425
  itemRestrictions: zod_1.z.array(zod_1.z.union([
409
426
  zod_1.z.literal(1),
410
427
  zod_1.z.literal(2),
@@ -633,8 +650,9 @@ exports.getBundlesDetails = (0, __1.endpoint)({
633
650
  });
634
651
  /**
635
652
  * @api POST https://catalog.roblox.com/v1/catalog/items/details
636
- * @summary Returns list of item details.
653
+ * @summary Returns details for one or more catalog items.
637
654
  * @param body Roblox.Catalog.Api.MultigetItemDetailsRequestModel.
655
+ * @description There is an item count limit per request. Exceeding this returns 400 Bad Request.
638
656
  */
639
657
  exports.postCatalogItemsDetails = (0, __1.endpoint)({
640
658
  method: 'POST',