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
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getTagsPrefixSearch = exports.getTags = exports.getItemTagsMetadata = exports.deleteItemTagsItemtagid = exports.postItemTags = exports.getItemTags = exports.getCreationsGetAssets = exports.postCreationsGetAssetDetails = void 0;
3
+ exports.getTagsPrefixSearch = exports.getTags = exports.getCreationsGetAssets = exports.postCreationsGetAssetDetails = void 0;
4
4
  const zod_1 = require("zod");
5
5
  const __1 = require("..");
6
6
  const Roblox_ItemConfiguration_Api_AssetCreationsResponse = zod_1.z.object({
@@ -12,32 +12,6 @@ const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_ItemConfiguration_Api_Asse
12
12
  nextPageCursor: zod_1.z.string(),
13
13
  data: zod_1.z.array(Roblox_ItemConfiguration_Api_AssetCreationsResponse),
14
14
  });
15
- const Roblox_ItemConfiguration_Api_TagDetails = zod_1.z.object({
16
- tagId: zod_1.z.string(),
17
- name: zod_1.z.string(),
18
- localizedDisplayName: zod_1.z.string(),
19
- status: zod_1.z.enum(['Success', 'MissingItem']),
20
- });
21
- const Roblox_ItemConfiguration_Api_ItemTagDetails = zod_1.z.object({
22
- id: zod_1.z.string(),
23
- tag: Roblox_ItemConfiguration_Api_TagDetails,
24
- });
25
- const Roblox_ItemConfiguration_Api_ItemWithTags = zod_1.z.object({
26
- id: zod_1.z.string(),
27
- itemTags: zod_1.z.array(Roblox_ItemConfiguration_Api_ItemTagDetails),
28
- });
29
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_ItemConfiguration_Api_ItemWithTags_ = zod_1.z.object({
30
- data: zod_1.z.array(Roblox_ItemConfiguration_Api_ItemWithTags),
31
- });
32
- const Roblox_ItemConfiguration_Api_CreateItemTagRequest = zod_1.z.object({
33
- itemId: zod_1.z.string(),
34
- tagId: zod_1.z.string(),
35
- });
36
- const Roblox_ItemConfiguration_Api_ItemTagsMetadataResponse = zod_1.z.object({
37
- isItemTagsFeatureEnabled: zod_1.z.boolean(),
38
- enabledAssetTypes: zod_1.z.array(zod_1.z.string()),
39
- maximumItemTagsPerItem: zod_1.z.number().int(),
40
- });
41
15
  const Roblox_ItemConfiguration_Api_AssetCreationsDetailsRequest = zod_1.z.object({
42
16
  AssetIds: zod_1.z.array(zod_1.z.number()),
43
17
  });
@@ -76,7 +50,6 @@ const Roblox_ItemConfiguration_Api_AssetCreationsDetailsResponse = zod_1.z.objec
76
50
  isDelisted: zod_1.z.boolean(),
77
51
  isCreatedForBundle: zod_1.z.boolean(),
78
52
  });
79
- const Roblox_Web_WebAPI_ApiEmptyResponseModel = zod_1.z.object({});
80
53
  /**
81
54
  * @api POST https://itemconfiguration.roblox.com/v1/creations/get-asset-details
82
55
  * @summary Gets the asset status and other configuration details for the given assetIds list.
@@ -193,144 +166,13 @@ exports.getCreationsGetAssets = (0, __1.endpoint)({
193
166
  },
194
167
  ],
195
168
  });
196
- /**
197
- * @api GET https://itemconfiguration.roblox.com/v1/item-tags
198
- * @summary Gets all related item tags for each item id listed.
199
- * @param itemIds
200
- */
201
- exports.getItemTags = (0, __1.endpoint)({
202
- method: 'GET',
203
- path: '/v1/item-tags',
204
- baseUrl: 'https://itemconfiguration.roblox.com',
205
- requestFormat: 'json',
206
- serializationMethod: {
207
- itemIds: {
208
- style: 'form',
209
- },
210
- },
211
- parameters: {
212
- itemIds: zod_1.z.array(zod_1.z.string()),
213
- },
214
- response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_ItemConfiguration_Api_ItemWithTags_,
215
- errors: [
216
- {
217
- status: 400,
218
- description: `1: No item tag Ids requested
219
- 2: Too many item tag Ids requested
220
- 3: Invalid item id
221
- 6: Invalid item namespace`,
222
- },
223
- {
224
- status: 404,
225
- description: `10: The endpoint was not found`,
226
- },
227
- {
228
- status: 429,
229
- description: `7: Too many requests`,
230
- },
231
- ],
232
- });
233
- /**
234
- * @api POST https://itemconfiguration.roblox.com/v1/item-tags
235
- * @summary Creates a new item tag.
236
- * @param body
237
- */
238
- exports.postItemTags = (0, __1.endpoint)({
239
- method: 'POST',
240
- path: '/v1/item-tags',
241
- baseUrl: 'https://itemconfiguration.roblox.com',
242
- requestFormat: 'json',
243
- serializationMethod: {
244
- body: {},
245
- },
246
- parameters: {},
247
- body: Roblox_ItemConfiguration_Api_CreateItemTagRequest,
248
- response: Roblox_ItemConfiguration_Api_ItemTagDetails,
249
- errors: [
250
- {
251
- status: 400,
252
- description: `3: Invalid item id
253
- 4: Invalid tag id
254
- 6: Invalid item namespace
255
- 8: The given item is ineligible for item tags
256
- 9: The given item has already reached its maximum item tag count`,
257
- },
258
- {
259
- status: 401,
260
- description: `0: Authorization has been denied for this request.`,
261
- },
262
- {
263
- status: 403,
264
- description: `0: Token Validation Failed
265
- 5: The current user is missing permissions for the endpoint`,
266
- },
267
- {
268
- status: 404,
269
- description: `10: The endpoint was not found`,
270
- },
271
- {
272
- status: 429,
273
- description: `7: Too many requests`,
274
- },
275
- ],
276
- });
277
- /**
278
- * @api DELETE https://itemconfiguration.roblox.com/v1/item-tags/:itemTagId
279
- * @summary Deletes an item tag from an item.
280
- * @param itemTagId
281
- */
282
- exports.deleteItemTagsItemtagid = (0, __1.endpoint)({
283
- method: 'DELETE',
284
- path: '/v1/item-tags/:itemTagId',
285
- baseUrl: 'https://itemconfiguration.roblox.com',
286
- requestFormat: 'json',
287
- serializationMethod: {
288
- itemTagId: {
289
- style: 'simple',
290
- },
291
- },
292
- parameters: {
293
- itemTagId: zod_1.z.string(),
294
- },
295
- response: zod_1.z.object({}),
296
- errors: [
297
- {
298
- status: 401,
299
- description: `0: Authorization has been denied for this request.`,
300
- },
301
- {
302
- status: 403,
303
- description: `0: Token Validation Failed
304
- 5: The current user is missing permissions for the endpoint`,
305
- },
306
- {
307
- status: 404,
308
- description: `10: The endpoint was not found`,
309
- },
310
- {
311
- status: 429,
312
- description: `7: Too many requests`,
313
- },
314
- ],
315
- });
316
- /**
317
- * @api GET https://itemconfiguration.roblox.com/v1/item-tags/metadata
318
- * @summary Gets the metadata related to item tags.
319
- */
320
- exports.getItemTagsMetadata = (0, __1.endpoint)({
321
- method: 'GET',
322
- path: '/v1/item-tags/metadata',
323
- baseUrl: 'https://itemconfiguration.roblox.com',
324
- requestFormat: 'json',
325
- response: Roblox_ItemConfiguration_Api_ItemTagsMetadataResponse,
326
- errors: [
327
- {
328
- status: 404,
329
- description: `10: The endpoint was not found`,
330
- },
331
- ],
332
- });
333
169
  // Patched endpoints removed from Roblox API docs (v6.1.0 compat)
170
+ const Roblox_ItemConfiguration_Api_TagDetails = zod_1.z.object({
171
+ tagId: zod_1.z.string(),
172
+ name: zod_1.z.string(),
173
+ localizedDisplayName: zod_1.z.string(),
174
+ status: zod_1.z.enum(['Success', 'MissingItem']),
175
+ });
334
176
  const Patch_ApiArrayResponse_TagDetails = zod_1.z.object({
335
177
  data: zod_1.z.array(Roblox_ItemConfiguration_Api_TagDetails),
336
178
  });
@@ -29,9 +29,11 @@ const Roblox_TwoStepVerification_Api_MetadataResponse = z.object({
29
29
  isSettingsTabRedesignEnabled: z.boolean(),
30
30
  twoStepCopyTextEnrollmentStatus: z.number().int(),
31
31
  isEppUIEnabled: z.boolean(),
32
+ isEppRecoveryCodesEnabled: z.boolean(),
32
33
  maskedUserEmail: z.string(),
33
34
  isUserU13: z.boolean(),
34
35
  isDelayedUiEnabled: z.boolean(),
36
+ is2svRecoveryEnabled: z.boolean(),
35
37
  });
36
38
  const Roblox_TwoStepVerification_Api_UserConfigurationMethod = z.object({
37
39
  mediaType: z.enum([
@@ -31,9 +31,11 @@ const Roblox_TwoStepVerification_Api_MetadataResponse = zod_1.z.object({
31
31
  isSettingsTabRedesignEnabled: zod_1.z.boolean(),
32
32
  twoStepCopyTextEnrollmentStatus: zod_1.z.number().int(),
33
33
  isEppUIEnabled: zod_1.z.boolean(),
34
+ isEppRecoveryCodesEnabled: zod_1.z.boolean(),
34
35
  maskedUserEmail: zod_1.z.string(),
35
36
  isUserU13: zod_1.z.boolean(),
36
37
  isDelayedUiEnabled: zod_1.z.boolean(),
38
+ is2svRecoveryEnabled: zod_1.z.boolean(),
37
39
  });
38
40
  const Roblox_TwoStepVerification_Api_UserConfigurationMethod = zod_1.z.object({
39
41
  mediaType: zod_1.z.enum([
package/lib/index.js CHANGED
@@ -67,7 +67,7 @@ function prepareRequestUrl(endpoint, extendedParams) {
67
67
  const pathParamPattern = new RegExp(`:${key}`);
68
68
  // Check if this is a path parameter
69
69
  if (pathParamPattern.test(processedPath)) {
70
- processedPath = processedPath.replace(pathParamPattern, String(value));
70
+ processedPath = processedPath.replace(pathParamPattern, encodeURIComponent(String(value)));
71
71
  usedPathParams.add(key);
72
72
  }
73
73
  }
@@ -17,14 +17,14 @@ export declare const patchAssetPermissionsApiV1AssetsPermissions: import("../.."
17
17
  code: "UnknownError" | "InvalidRequest" | "AssetNotFound" | "CannotManageAsset" | "PublicAssetCannotBeGrantedTo" | "CannotManageSubject" | "SubjectNotFound" | "AssetTypeNotEnabled" | "PermissionLimitReached" | "DependenciesLimitReached";
18
18
  }[] | null;
19
19
  }, {
20
- subjectType: "Invalid" | "User" | "Group" | "GroupRoleset" | "All" | "Universe";
21
- subjectId: string | null;
22
- action: "Invalid" | "Edit" | "Use" | "Download" | "CopyFromRcc" | "UpdateFromRcc";
23
- requests: {
20
+ subjectType?: "Invalid" | "User" | "Group" | "GroupRoleset" | "All" | "Universe" | undefined;
21
+ subjectId?: string | null | undefined;
22
+ action?: "Invalid" | "Edit" | "Use" | "Download" | "CopyFromRcc" | "UpdateFromRcc" | undefined;
23
+ requests?: {
24
24
  assetId: number;
25
25
  grantToDependencies: boolean;
26
26
  parentVersionNumber: number;
27
- }[] | null;
28
- assetIds: number[] | null;
29
- enableDeepAccessCheck: boolean;
27
+ }[] | null | undefined;
28
+ assetIds?: number[] | null | undefined;
29
+ enableDeepAccessCheck?: boolean | undefined;
30
30
  }>;
@@ -62,7 +62,7 @@ exports.patchAssetPermissionsApiV1AssetsPermissions = (0, __1.endpoint)({
62
62
  body: {},
63
63
  },
64
64
  parameters: {},
65
- body: BatchGrantPermissionsRequest,
65
+ body: BatchGrantPermissionsRequest.partial(),
66
66
  response: BatchGrantPermissionsResponse,
67
67
  errors: [
68
68
  {
@@ -178,7 +178,7 @@ export declare const patchAssetsAssetId: import("../..").EndpointGeneric<{
178
178
  };
179
179
  };
180
180
  }, {
181
- request: {
181
+ request?: {
182
182
  assetType: string;
183
183
  assetId: number;
184
184
  creationContext: {
@@ -207,8 +207,8 @@ export declare const patchAssetsAssetId: import("../..").EndpointGeneric<{
207
207
  title: string;
208
208
  uri: string;
209
209
  };
210
- };
211
- fileContent: File;
210
+ } | undefined;
211
+ fileContent?: File | undefined;
212
212
  }>;
213
213
  /**
214
214
  * **Archive Asset** · `BETA`
@@ -165,7 +165,7 @@ exports.patchAssetsAssetId = (0, __1.endpoint)({
165
165
  assetId: zod_1.z.string(),
166
166
  updateMask: zod_1.z.string().optional(),
167
167
  },
168
- body: Assets_CreateAsset_Body,
168
+ body: Assets_CreateAsset_Body.partial(),
169
169
  response: Operation,
170
170
  errors: [
171
171
  {
@@ -129,7 +129,7 @@ export declare const patchUniversesUniverseIdOrderedDataStoresOrderedDataStoreSc
129
129
  id: string;
130
130
  value: number;
131
131
  }, {
132
- value: number;
132
+ value?: number | undefined;
133
133
  }>;
134
134
  /**
135
135
  * **Increment** · `BETA`
@@ -268,7 +268,7 @@ exports.patchUniversesUniverseIdOrderedDataStoresOrderedDataStoreScopesScopeEntr
268
268
  entry: zod_1.z.string(),
269
269
  allow_missing: zod_1.z.boolean().optional(),
270
270
  },
271
- body: zod_1.z.object({ value: zod_1.z.number().int() }),
271
+ body: zod_1.z.object({ value: zod_1.z.number().int() }).partial(),
272
272
  response: Entry,
273
273
  errors: [
274
274
  {
@@ -51,13 +51,13 @@ export declare const patchDeveloperProductsV2UniversesUniverseIdDeveloperProduct
51
51
  universeId: number;
52
52
  productId: number;
53
53
  }, void, {
54
- name: string | null;
55
- description: string | null;
56
- isForSale: boolean | null;
57
- price: number | null;
58
- imageFile: File | null;
59
- isRegionalPricingEnabled: boolean | null;
60
- storePageEnabled: boolean | null;
54
+ name?: string | null | undefined;
55
+ description?: string | null | undefined;
56
+ isForSale?: boolean | null | undefined;
57
+ price?: number | null | undefined;
58
+ imageFile?: File | null | undefined;
59
+ isRegionalPricingEnabled?: boolean | null | undefined;
60
+ storePageEnabled?: boolean | null | undefined;
61
61
  }>;
62
62
  /**
63
63
  * `BETA`
@@ -155,7 +155,7 @@ exports.patchDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductId =
155
155
  universeId: zod_1.z.number().int(),
156
156
  productId: zod_1.z.number().int(),
157
157
  },
158
- body: DeveloperProducts_UpdateDeveloperProductV2_Body,
158
+ body: DeveloperProducts_UpdateDeveloperProductV2_Body.partial(),
159
159
  response: zod_1.z.void(),
160
160
  errors: [
161
161
  {
@@ -48,12 +48,12 @@ export declare const patchGamePassesV1UniversesUniverseIdGamePassesGamePassId: i
48
48
  universeId: number;
49
49
  gamePassId: number;
50
50
  }, void, {
51
- name: string | null;
52
- description: string | null;
53
- file: File | null;
54
- isForSale: boolean | null;
55
- price: number | null;
56
- isRegionalPricingEnabled: boolean | null;
51
+ name?: string | null | undefined;
52
+ description?: string | null | undefined;
53
+ file?: File | null | undefined;
54
+ isForSale?: boolean | null | undefined;
55
+ price?: number | null | undefined;
56
+ isRegionalPricingEnabled?: boolean | null | undefined;
57
57
  }>;
58
58
  /**
59
59
  * `BETA`
@@ -142,7 +142,7 @@ exports.patchGamePassesV1UniversesUniverseIdGamePassesGamePassId = (0, __1.endpo
142
142
  universeId: zod_1.z.number().int(),
143
143
  gamePassId: zod_1.z.number().int(),
144
144
  },
145
- body: GamePasses_UpdateGamePass_Body,
145
+ body: GamePasses_UpdateGamePass_Body.partial(),
146
146
  response: zod_1.z.void(),
147
147
  errors: [
148
148
  {
@@ -8,6 +8,8 @@
8
8
  * @param body
9
9
  * @param universeId The identifier of the experience in which you want to send your messages to. You can [copy your experience's Universe ID](/cloud/guides/usage-messaging.md#publishing-messages-to-live-servers) on **Creator Dashboard**.
10
10
  * @param topic The topic that you want to publish your message to, with up to 80 characters.
11
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}:publishMessage
12
+ * @deprecated Prefer the v2 alternative(s) listed above.
11
13
  */
12
14
  export declare const postUniversesUniverseIdTopicsTopic: import("../..").EndpointGeneric<{
13
15
  universeId: number;
@@ -14,6 +14,8 @@ const PublishRequest = zod_1.z.object({ message: zod_1.z.string().nullable() });
14
14
  * @param body
15
15
  * @param universeId The identifier of the experience in which you want to send your messages to. You can [copy your experience's Universe ID](/cloud/guides/usage-messaging.md#publishing-messages-to-live-servers) on **Creator Dashboard**.
16
16
  * @param topic The topic that you want to publish your message to, with up to 80 characters.
17
+ * @see POST https://apis.roblox.com/cloud/v2/universes/{universe_id}:publishMessage
18
+ * @deprecated Prefer the v2 alternative(s) listed above.
17
19
  */
18
20
  exports.postUniversesUniverseIdTopicsTopic = (0, __1.endpoint)({
19
21
  method: 'POST',
@@ -107,12 +107,12 @@ export declare const patchCloudV2UniversesUniverseIdSecretsSecretId: import("../
107
107
  create_time: string | null;
108
108
  update_time: string | null;
109
109
  }, {
110
- id: string | null;
111
- secret: string | null;
112
- key_id: string | null;
113
- domain: string | null;
114
- create_time: string | null;
115
- update_time: string | null;
110
+ id?: string | null | undefined;
111
+ secret?: string | null | undefined;
112
+ key_id?: string | null | undefined;
113
+ domain?: string | null | undefined;
114
+ create_time?: string | null | undefined;
115
+ update_time?: string | null | undefined;
116
116
  }>;
117
117
  /**
118
118
  * `BETA`
@@ -161,7 +161,7 @@ exports.patchCloudV2UniversesUniverseIdSecretsSecretId = (0, __1.endpoint)({
161
161
  universeId: zod_1.z.number().int(),
162
162
  secretId: zod_1.z.string(),
163
163
  },
164
- body: Secret,
164
+ body: Secret.partial(),
165
165
  response: Secret,
166
166
  errors: [
167
167
  {