rozod 6.7.1 → 6.9.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 (87) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +75 -451
  3. package/lib/endpoints/accountinformationv1.d.ts +92 -95
  4. package/lib/endpoints/accountsettingsv1.d.ts +88 -110
  5. package/lib/endpoints/adconfigurationv2.d.ts +108 -215
  6. package/lib/endpoints/assetdeliveryv1.d.ts +267 -230
  7. package/lib/endpoints/assetdeliveryv1.js +38 -0
  8. package/lib/endpoints/assetdeliveryv2.d.ts +201 -176
  9. package/lib/endpoints/assetdeliveryv2.js +26 -0
  10. package/lib/endpoints/authv1.d.ts +480 -517
  11. package/lib/endpoints/authv1.js +3 -1
  12. package/lib/endpoints/authv2.d.ts +210 -222
  13. package/lib/endpoints/authv2.js +1 -1
  14. package/lib/endpoints/authv3.d.ts +32 -35
  15. package/lib/endpoints/avatarv1.d.ts +112 -117
  16. package/lib/endpoints/avatarv2.d.ts +71 -76
  17. package/lib/endpoints/avatarv3.d.ts +27 -33
  18. package/lib/endpoints/badgesv1.d.ts +96 -99
  19. package/lib/endpoints/badgesv1.js +4 -0
  20. package/lib/endpoints/catalogv1.d.ts +209 -234
  21. package/lib/endpoints/catalogv1.js +2 -1
  22. package/lib/endpoints/catalogv2.d.ts +106 -136
  23. package/lib/endpoints/catalogv2.js +21 -17
  24. package/lib/endpoints/chatv2.d.ts +778 -778
  25. package/lib/endpoints/clientsettingsv1.d.ts +33 -35
  26. package/lib/endpoints/clientsettingsv2.d.ts +62 -68
  27. package/lib/endpoints/contactsv1.d.ts +18 -20
  28. package/lib/endpoints/developv1.d.ts +233 -293
  29. package/lib/endpoints/developv1.js +3 -0
  30. package/lib/endpoints/developv2.d.ts +87 -138
  31. package/lib/endpoints/developv2.js +3 -1
  32. package/lib/endpoints/economycreatorstatsv1.d.ts +12 -12
  33. package/lib/endpoints/economyv1.d.ts +6 -6
  34. package/lib/endpoints/engagementpayoutsv1.d.ts +9 -9
  35. package/lib/endpoints/followingsv1.d.ts +33 -34
  36. package/lib/endpoints/followingsv2.d.ts +9 -9
  37. package/lib/endpoints/friendsv1.d.ts +416 -545
  38. package/lib/endpoints/friendsv1.js +213 -313
  39. package/lib/endpoints/gameinternationalizationv1.d.ts +1509 -1642
  40. package/lib/endpoints/gameinternationalizationv2.d.ts +62 -64
  41. package/lib/endpoints/gamejoinv1.d.ts +458 -458
  42. package/lib/endpoints/gamesv1.d.ts +183 -143
  43. package/lib/endpoints/gamesv1.js +2 -0
  44. package/lib/endpoints/gamesv2.d.ts +161 -158
  45. package/lib/endpoints/gamesv2.js +9 -0
  46. package/lib/endpoints/groupsv1.d.ts +967 -976
  47. package/lib/endpoints/groupsv1.js +48 -4
  48. package/lib/endpoints/groupsv2.d.ts +259 -277
  49. package/lib/endpoints/groupsv2.js +1 -0
  50. package/lib/endpoints/inventoryv1.d.ts +93 -122
  51. package/lib/endpoints/inventoryv1.js +3 -1
  52. package/lib/endpoints/inventoryv2.d.ts +163 -178
  53. package/lib/endpoints/inventoryv2.js +2 -0
  54. package/lib/endpoints/itemconfigurationv1.d.ts +33 -40
  55. package/lib/endpoints/localev1.d.ts +47 -48
  56. package/lib/endpoints/localizationtablesv1.d.ts +315 -353
  57. package/lib/endpoints/matchmakingv1.d.ts +184 -190
  58. package/lib/endpoints/metricsv1.d.ts +88 -88
  59. package/lib/endpoints/notificationsv2.d.ts +144 -158
  60. package/lib/endpoints/premiumfeaturesv1.d.ts +14 -14
  61. package/lib/endpoints/presencev1.d.ts +7 -12
  62. package/lib/endpoints/privatemessagesv1.d.ts +56 -64
  63. package/lib/endpoints/publishv1.d.ts +32 -32
  64. package/lib/endpoints/thumbnailsresizerv1.d.ts +52 -53
  65. package/lib/endpoints/thumbnailsv1.d.ts +317 -361
  66. package/lib/endpoints/thumbnailsv1.js +25 -0
  67. package/lib/endpoints/tradesv1.d.ts +92 -104
  68. package/lib/endpoints/tradesv2.d.ts +81 -84
  69. package/lib/endpoints/translationrolesv1.d.ts +46 -51
  70. package/lib/endpoints/twostepverificationv1.d.ts +233 -237
  71. package/lib/endpoints/usersv1.d.ts +110 -114
  72. package/lib/index.d.ts +152 -4
  73. package/lib/index.js +273 -4
  74. package/lib/opencloud/v1/asset-permissions.d.ts +1 -1
  75. package/lib/opencloud/v1/assets.d.ts +9 -9
  76. package/lib/opencloud/v1/datastores-ordered.d.ts +6 -6
  77. package/lib/opencloud/v1/datastores.d.ts +8 -8
  78. package/lib/opencloud/v1/developer-products.d.ts +4 -4
  79. package/lib/opencloud/v1/game-passes.d.ts +4 -4
  80. package/lib/opencloud/v1/messaging.d.ts +1 -1
  81. package/lib/opencloud/v1/open-eval.d.ts +2 -2
  82. package/lib/opencloud/v1/secrets-store.d.ts +5 -5
  83. package/lib/opencloud/v1/toolbox.d.ts +2 -2
  84. package/lib/opencloud/v1/universes.d.ts +1 -1
  85. package/lib/opencloud/v2/cloud.d.ts +172 -84
  86. package/lib/opencloud/v2/cloud.js +25 -9
  87. package/package.json +2 -2
@@ -1,5 +1,5 @@
1
- import { z } from "zod";
2
- import { endpoint } from "..";
1
+ import { z } from 'zod';
2
+ import { endpoint } from '..';
3
3
 
4
4
  const Roblox_Web_Responses_Badges_BadgeAwardStatisticsResponse = z.object({
5
5
  pastDayAwardedCount: z.number().int(),
@@ -36,26 +36,24 @@ const Roblox_Badges_Api_BadgeMetadataResponse = z.object({
36
36
  maxBadgeNameLength: z.number().int(),
37
37
  maxBadgeDescriptionLength: z.number().int(),
38
38
  });
39
- const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_ =
40
- z.object({
41
- previousPageCursor: z.string(),
42
- nextPageCursor: z.string(),
43
- data: z.array(Roblox_Badges_Api_BadgeResponse),
44
- });
39
+ const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_ = z.object({
40
+ previousPageCursor: z.string(),
41
+ nextPageCursor: z.string(),
42
+ data: z.array(Roblox_Badges_Api_BadgeResponse),
43
+ });
45
44
  const universeId_badges_body = z.object({
46
45
  name: z.string(),
47
46
  description: z.string(),
48
- paymentSourceType: z.enum(["User", "Group"]),
47
+ paymentSourceType: z.enum(['User', 'Group']),
49
48
  files: z.instanceof(File),
50
49
  expectedCost: z.number().int(),
51
50
  isActive: z.boolean(),
52
51
  });
53
- const Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Badges_BadgeAwarderType_ =
54
- z.object({
55
- id: z.number().int(),
56
- type: z.literal("Place"),
57
- name: z.string(),
58
- });
52
+ const Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Badges_BadgeAwarderType_ = z.object({
53
+ id: z.number().int(),
54
+ type: z.literal('Place'),
55
+ name: z.string(),
56
+ });
59
57
  const Roblox_Web_Responses_Badges_BadgeResponseV2 = z.object({
60
58
  id: z.number().int(),
61
59
  name: z.string(),
@@ -65,8 +63,7 @@ const Roblox_Web_Responses_Badges_BadgeResponseV2 = z.object({
65
63
  enabled: z.boolean(),
66
64
  iconImageId: z.number().int(),
67
65
  displayIconImageId: z.number().int(),
68
- awarder:
69
- Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Badges_BadgeAwarderType_,
66
+ awarder: Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Badges_BadgeAwarderType_,
70
67
  statistics: Roblox_Web_Responses_Badges_BadgeAwardStatisticsResponse,
71
68
  created: z.string().datetime({ offset: true }),
72
69
  updated: z.string().datetime({ offset: true }),
@@ -86,24 +83,23 @@ const Roblox_Badges_Api_GetBadgesByUserResponse = z.object({
86
83
  enabled: z.boolean(),
87
84
  iconImageId: z.number().int(),
88
85
  displayIconImageId: z.number().int(),
89
- awarder:
90
- Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Badges_BadgeAwarderType_,
86
+ awarder: Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Badges_BadgeAwarderType_,
91
87
  statistics: Roblox_Web_Responses_Badges_BadgeAwardStatisticsResponse,
92
88
  created: z.string().datetime({ offset: true }),
93
89
  updated: z.string().datetime({ offset: true }),
94
90
  });
95
- const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_GetBadgesByUserResponse_ =
96
- z.object({
97
- previousPageCursor: z.string(),
98
- nextPageCursor: z.string(),
99
- data: z.array(Roblox_Badges_Api_GetBadgesByUserResponse),
100
- });
91
+ const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_GetBadgesByUserResponse_ = z.object({
92
+ previousPageCursor: z.string(),
93
+ nextPageCursor: z.string(),
94
+ data: z.array(Roblox_Badges_Api_GetBadgesByUserResponse),
95
+ });
101
96
  const Roblox_Badges_Api_BadgeAwardResponse = z.object({
102
97
  badgeId: z.number().int(),
103
98
  awardedDate: z.string().datetime({ offset: true }),
104
99
  });
105
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Badges_Api_BadgeAwardResponse_ =
106
- z.object({ data: z.array(Roblox_Badges_Api_BadgeAwardResponse) });
100
+ const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Badges_Api_BadgeAwardResponse_ = z.object({
101
+ data: z.array(Roblox_Badges_Api_BadgeAwardResponse),
102
+ });
107
103
  const badgeId_icon_body = z.object({ Files: z.instanceof(File) });
108
104
  const Roblox_Badges_Api_IconUploadResponse = z.object({
109
105
  targetId: z.number().int(),
@@ -115,13 +111,13 @@ const Roblox_Badges_Api_IconUploadResponse = z.object({
115
111
  * @param badgeId The badge Id.
116
112
  */
117
113
  export const getBadgesBadgeid = endpoint({
118
- method: "GET",
119
- path: "/v1/badges/:badgeId",
120
- baseUrl: "https://badges.roblox.com",
121
- requestFormat: "json",
114
+ method: 'GET',
115
+ path: '/v1/badges/:badgeId',
116
+ baseUrl: 'https://badges.roblox.com',
117
+ requestFormat: 'json',
122
118
  serializationMethod: {
123
119
  badgeId: {
124
- style: "simple",
120
+ style: 'simple',
125
121
  },
126
122
  },
127
123
  parameters: {
@@ -143,14 +139,14 @@ export const getBadgesBadgeid = endpoint({
143
139
  * @param badgeId The badge Id.
144
140
  */
145
141
  export const patchBadgesBadgeid = endpoint({
146
- method: "PATCH",
147
- path: "/v1/badges/:badgeId",
148
- baseUrl: "https://badges.roblox.com",
149
- requestFormat: "json",
142
+ method: 'PATCH',
143
+ path: '/v1/badges/:badgeId',
144
+ baseUrl: 'https://badges.roblox.com',
145
+ requestFormat: 'json',
150
146
  serializationMethod: {
151
147
  body: {},
152
148
  badgeId: {
153
- style: "simple",
149
+ style: 'simple',
154
150
  },
155
151
  },
156
152
  parameters: {
@@ -188,14 +184,14 @@ export const patchBadgesBadgeid = endpoint({
188
184
  * @param badgeId The badge Id.
189
185
  */
190
186
  export const postBadgesBadgeidIcon = endpoint({
191
- method: "POST",
192
- path: "/v1/badges/:badgeId/icon",
193
- baseUrl: "https://badges.roblox.com",
194
- requestFormat: "form-data",
187
+ method: 'POST',
188
+ path: '/v1/badges/:badgeId/icon',
189
+ baseUrl: 'https://badges.roblox.com',
190
+ requestFormat: 'form-data',
195
191
  serializationMethod: {
196
192
  body: {},
197
193
  badgeId: {
198
- style: "simple",
194
+ style: 'simple',
199
195
  },
200
196
  },
201
197
  parameters: {
@@ -233,10 +229,10 @@ export const postBadgesBadgeidIcon = endpoint({
233
229
  * @summary Gets metadata about the badges system.
234
230
  */
235
231
  export const getBadgesMetadata = endpoint({
236
- method: "GET",
237
- path: "/v1/badges/metadata",
238
- baseUrl: "https://badges.roblox.com",
239
- requestFormat: "json",
232
+ method: 'GET',
233
+ path: '/v1/badges/metadata',
234
+ baseUrl: 'https://badges.roblox.com',
235
+ requestFormat: 'json',
240
236
  response: Roblox_Badges_Api_BadgeMetadataResponse,
241
237
  errors: [],
242
238
  });
@@ -250,44 +246,47 @@ export const getBadgesMetadata = endpoint({
250
246
  * @param sortOrder The order the results are sorted in.
251
247
  */
252
248
  export const getUniversesUniverseidBadges = endpoint({
253
- method: "GET",
254
- path: "/v1/universes/:universeId/badges",
255
- baseUrl: "https://badges.roblox.com",
256
- requestFormat: "json",
249
+ method: 'GET',
250
+ path: '/v1/universes/:universeId/badges',
251
+ baseUrl: 'https://badges.roblox.com',
252
+ requestFormat: 'json',
257
253
  serializationMethod: {
258
254
  universeId: {
259
- style: "simple",
255
+ style: 'simple',
260
256
  },
261
257
  sortBy: {
262
- style: "form",
258
+ style: 'form',
263
259
  explode: true,
264
260
  },
265
261
  limit: {
266
- style: "form",
262
+ style: 'form',
267
263
  explode: true,
268
264
  },
269
265
  cursor: {
270
- style: "form",
266
+ style: 'form',
271
267
  explode: true,
272
268
  },
273
269
  sortOrder: {
274
- style: "form",
270
+ style: 'form',
275
271
  explode: true,
276
272
  },
277
273
  },
278
274
  parameters: {
279
275
  universeId: z.number().int(),
280
- sortBy: z.enum(["Rank", "DateCreated"]).optional(),
276
+ sortBy: z.enum(['Rank', 'DateCreated']).optional(),
281
277
  limit: z
282
278
  .union([z.literal(10), z.literal(25), z.literal(50), z.literal(100)])
283
279
  .optional()
284
280
  .default(10),
285
281
  cursor: z.string().optional(),
286
- sortOrder: z.enum(["Asc", "Desc"]).optional().default("Asc"),
282
+ sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
287
283
  },
288
- response:
289
- Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_,
284
+ response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_,
290
285
  errors: [
286
+ {
287
+ status: 400,
288
+ description: `26: The pagination cursor is invalid or incompatible with the current request.`,
289
+ },
291
290
  {
292
291
  status: 404,
293
292
  description: `3: The game is invalid or does not exist.`,
@@ -301,14 +300,14 @@ export const getUniversesUniverseidBadges = endpoint({
301
300
  * @param universeId The ID of the universe to create the badge for.
302
301
  */
303
302
  export const postUniversesUniverseidBadges = endpoint({
304
- method: "POST",
305
- path: "/v1/universes/:universeId/badges",
306
- baseUrl: "https://badges.roblox.com",
307
- requestFormat: "form-data",
303
+ method: 'POST',
304
+ path: '/v1/universes/:universeId/badges',
305
+ baseUrl: 'https://badges.roblox.com',
306
+ requestFormat: 'form-data',
308
307
  serializationMethod: {
309
308
  body: {},
310
309
  universeId: {
311
- style: "simple",
310
+ style: 'simple',
312
311
  },
313
312
  },
314
313
  parameters: {
@@ -352,13 +351,13 @@ export const postUniversesUniverseidBadges = endpoint({
352
351
  * @param universeId The universe Id.
353
352
  */
354
353
  export const getUniversesUniverseidFreeBadgesQuota = endpoint({
355
- method: "GET",
356
- path: "/v1/universes/:universeId/free-badges-quota",
357
- baseUrl: "https://badges.roblox.com",
358
- requestFormat: "json",
354
+ method: 'GET',
355
+ path: '/v1/universes/:universeId/free-badges-quota',
356
+ baseUrl: 'https://badges.roblox.com',
357
+ requestFormat: 'json',
359
358
  serializationMethod: {
360
359
  universeId: {
361
- style: "simple",
360
+ style: 'simple',
362
361
  },
363
362
  },
364
363
  parameters: {
@@ -378,13 +377,13 @@ export const getUniversesUniverseidFreeBadgesQuota = endpoint({
378
377
  * @param badgeId The badge Id.
379
378
  */
380
379
  export const deleteUserBadgesBadgeid = endpoint({
381
- method: "DELETE",
382
- path: "/v1/user/badges/:badgeId",
383
- baseUrl: "https://badges.roblox.com",
384
- requestFormat: "json",
380
+ method: 'DELETE',
381
+ path: '/v1/user/badges/:badgeId',
382
+ baseUrl: 'https://badges.roblox.com',
383
+ requestFormat: 'json',
385
384
  serializationMethod: {
386
385
  badgeId: {
387
- style: "simple",
386
+ style: 'simple',
388
387
  },
389
388
  },
390
389
  parameters: {
@@ -415,24 +414,24 @@ export const deleteUserBadgesBadgeid = endpoint({
415
414
  * @param sortOrder The order the results are sorted in.
416
415
  */
417
416
  export const getUsersUseridBadges = endpoint({
418
- method: "GET",
419
- path: "/v1/users/:userId/badges",
420
- baseUrl: "https://badges.roblox.com",
421
- requestFormat: "json",
417
+ method: 'GET',
418
+ path: '/v1/users/:userId/badges',
419
+ baseUrl: 'https://badges.roblox.com',
420
+ requestFormat: 'json',
422
421
  serializationMethod: {
423
422
  userId: {
424
- style: "simple",
423
+ style: 'simple',
425
424
  },
426
425
  limit: {
427
- style: "form",
426
+ style: 'form',
428
427
  explode: true,
429
428
  },
430
429
  cursor: {
431
- style: "form",
430
+ style: 'form',
432
431
  explode: true,
433
432
  },
434
433
  sortOrder: {
435
- style: "form",
434
+ style: 'form',
436
435
  explode: true,
437
436
  },
438
437
  },
@@ -443,10 +442,9 @@ export const getUsersUseridBadges = endpoint({
443
442
  .optional()
444
443
  .default(10),
445
444
  cursor: z.string().optional(),
446
- sortOrder: z.enum(["Asc", "Desc"]).optional().default("Asc"),
445
+ sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
447
446
  },
448
- response:
449
- Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_GetBadgesByUserResponse_,
447
+ response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_GetBadgesByUserResponse_,
450
448
  errors: [
451
449
  {
452
450
  status: 404,
@@ -461,16 +459,16 @@ export const getUsersUseridBadges = endpoint({
461
459
  * @param badgeId Badge id.
462
460
  */
463
461
  export const getUsersUseridBadgesBadgeidAwardedDate = endpoint({
464
- method: "GET",
465
- path: "/v1/users/:userId/badges/:badgeId/awarded-date",
466
- baseUrl: "https://badges.roblox.com",
467
- requestFormat: "json",
462
+ method: 'GET',
463
+ path: '/v1/users/:userId/badges/:badgeId/awarded-date',
464
+ baseUrl: 'https://badges.roblox.com',
465
+ requestFormat: 'json',
468
466
  serializationMethod: {
469
467
  userId: {
470
- style: "simple",
468
+ style: 'simple',
471
469
  },
472
470
  badgeId: {
473
- style: "simple",
471
+ style: 'simple',
474
472
  },
475
473
  },
476
474
  parameters: {
@@ -492,24 +490,23 @@ export const getUsersUseridBadgesBadgeidAwardedDate = endpoint({
492
490
  * @param badgeIds The CSV of badge Ids.
493
491
  */
494
492
  export const getUsersUseridBadgesAwardedDates = endpoint({
495
- method: "GET",
496
- path: "/v1/users/:userId/badges/awarded-dates",
497
- baseUrl: "https://badges.roblox.com",
498
- requestFormat: "json",
493
+ method: 'GET',
494
+ path: '/v1/users/:userId/badges/awarded-dates',
495
+ baseUrl: 'https://badges.roblox.com',
496
+ requestFormat: 'json',
499
497
  serializationMethod: {
500
498
  userId: {
501
- style: "simple",
499
+ style: 'simple',
502
500
  },
503
501
  badgeIds: {
504
- style: "form",
502
+ style: 'form',
505
503
  },
506
504
  },
507
505
  parameters: {
508
506
  userId: z.number().int(),
509
507
  badgeIds: z.array(z.number()),
510
508
  },
511
- response:
512
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Badges_Api_BadgeAwardResponse_,
509
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Badges_Api_BadgeAwardResponse_,
513
510
  errors: [
514
511
  {
515
512
  status: 400,
@@ -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.`,