openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
3,153 lines • 124 kB
TypeScript
/**
* Gets audit log entries for a group.
* @category Groups
* @endpoint GET /v1/groups/{groupId}/audit-log
*
* @param groupId The id of the group.
* @param actionType The action to filter the audit logs by. (no filter will be applied if actionType is undefined).
* @param userId Filter for specific user by their id.
* @param limit The number of results to be returned.
* @param sortOrder The order that the results are sorted in.
* @param cursor The paging cursor for the previous or next page.
*
* @example const { data:auditLog } = await LegacyGroupsApi.groupAuditLogs({ groupId: 5850082 })
* @exampleData { previousPageCursor: null, nextPageCursor: null, data: [ { actor: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, actionType: "Accept Ally Request", description: { TargetGroupId: 6333562, TargetGroupName: "Mine Ways Talk Show" }, created: "2020-05-18T12:06:34Z" }, { actor: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, actionType: "Accept Ally Request", description: { TargetGroupId: 5257567, TargetGroupName: "The X1 Team" }, created: "2020-05-13T13:52:57Z" }, { actor: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, actionType: "Accept Ally Request", description: { TargetGroupId: 5894486, TargetGroupName: "Sky-Blox Studio" }, created: "2020-05-13T13:52:56Z" } ] }
* @exampleRawBody [ { actor: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, actionType: "AcceptAllyRequest", description: { targetGroupId: 6333562, targetGroupName: "Mine Ways Talk Show" }, created: "2020-05-18T12:06:34Z" }, { actor: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, actionType: "AcceptAllyRequest", description: { targetGroupId: 5257567, targetGroupName: "The X1 Team" }, created: "2020-05-13T13:52:57Z" }, { actor: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, actionType: "AcceptAllyRequest", description: { targetGroupId: 5894486, targetGroupName: "Sky-Blox Studio" }, created: "2020-05-13T13:52:56Z" } ]
*/
export declare const groupAuditLogs: import("../../apiGroup/apiGroup.types").CallApiMethod<{
groupId: import("typeforge").Identifier;
actionType?: import("../../classic/groups/groups.types").GroupAuditLogActionType | undefined;
userId?: import("typeforge").Identifier | undefined;
limit?: 10 | 25 | 50 | 100 | undefined;
sortOrder?: import("../../../utils/utils.types").SortOrder | undefined;
cursor?: string | undefined;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
previousPageCursor?: string | undefined;
nextPageCursor?: string | undefined;
data: ({
actionType: "Delete Post";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
PostDec: string;
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Remove Member" | "Accept Join Request" | "Decline Join Request";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Post Status";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Text: string;
};
created: string;
} | {
actionType: "Change Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
NewRoleSetId: number;
OldRoleSetId: number;
TargetName: string;
NewRoleSetName: string;
OldRoleSetName: string;
};
created: string;
} | {
actionType: "Buy Ad";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AdName: string;
Bid: number;
CurrencyTypeId: number;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Send Ally Request" | "Create Enemy" | "Accept Ally Request" | "Decline Ally Request" | "Delete Ally" | "Delete Enemy";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetGroupId: number;
TargetGroupName: string;
};
created: string;
} | {
actionType: "Create Items" | "Create Group Developer Product";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
};
created: string;
} | {
actionType: "Spend Group Funds";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Amount: number;
CurrencyTypeId: number;
ItemDescription: string;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Change Owner";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
IsRoblox: boolean;
NewOwnerId: number;
NewOwnerName: string;
OldOwnerId: number;
OldOwnerName: string;
};
created: string;
} | {
actionType: "Abandon";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Claim";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Rename";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewName: string;
};
created: string;
} | {
actionType: "Change Description";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
};
created: string;
} | {
actionType: "Add Group Place" | "Remove Group Place" | "Configure Items" | "Delete" | "Adjust Currency Amounts" | "Invite To Clan" | "Kick From Clan" | "Cancel Clan Invite" | "Buy Clan" | "Revert Group Asset" | "Create Group Developer Subscription Product" | "Lock" | "Unlock" | "Configure Badge" | "Publish Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Create Group Asset" | "Update Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
RevertVersionNumber: number | null;
};
created: string;
} | {
actionType: "Configure Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
Actions: number[] | null;
};
created: string;
} | {
actionType: "Configure Group Game";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Actions: number[];
Type: number;
TargetId: number;
TargetName: string;
UniverseId: number | null;
UniverseName: string;
};
created: string;
} | {
actionType: "Create Game Pass";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
GamePassId: number;
PlaceId: number;
GamePassName: string;
PlaceName: string;
};
created: string;
} | {
actionType: "Create Badge";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
BadgeId: number;
BadgeName: string;
Type: null;
};
created: string;
} | {
actionType: "Save Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
};
created: string;
} | {
actionType: "Update Roleset Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewRank: number;
OldRank: number;
RoleSetId: number;
RoleSetName: string;
};
created: string;
} | {
actionType: "Update Roleset Data";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
NewName: string;
OldDescription: string;
OldName: string;
RoleSetId: number;
RoleSetName: string;
};
created: string;
})[];
}) => string) | undefined;
getCursorsFn?: ((rawData: {
previousPageCursor?: string | undefined;
nextPageCursor?: string | undefined;
data: ({
actionType: "Delete Post";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
PostDec: string;
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Remove Member" | "Accept Join Request" | "Decline Join Request";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Post Status";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Text: string;
};
created: string;
} | {
actionType: "Change Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
NewRoleSetId: number;
OldRoleSetId: number;
TargetName: string;
NewRoleSetName: string;
OldRoleSetName: string;
};
created: string;
} | {
actionType: "Buy Ad";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AdName: string;
Bid: number;
CurrencyTypeId: number;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Send Ally Request" | "Create Enemy" | "Accept Ally Request" | "Decline Ally Request" | "Delete Ally" | "Delete Enemy";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetGroupId: number;
TargetGroupName: string;
};
created: string;
} | {
actionType: "Create Items" | "Create Group Developer Product";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
};
created: string;
} | {
actionType: "Spend Group Funds";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Amount: number;
CurrencyTypeId: number;
ItemDescription: string;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Change Owner";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
IsRoblox: boolean;
NewOwnerId: number;
NewOwnerName: string;
OldOwnerId: number;
OldOwnerName: string;
};
created: string;
} | {
actionType: "Abandon";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Claim";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Rename";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewName: string;
};
created: string;
} | {
actionType: "Change Description";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
};
created: string;
} | {
actionType: "Add Group Place" | "Remove Group Place" | "Configure Items" | "Delete" | "Adjust Currency Amounts" | "Invite To Clan" | "Kick From Clan" | "Cancel Clan Invite" | "Buy Clan" | "Revert Group Asset" | "Create Group Developer Subscription Product" | "Lock" | "Unlock" | "Configure Badge" | "Publish Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Create Group Asset" | "Update Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
RevertVersionNumber: number | null;
};
created: string;
} | {
actionType: "Configure Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
Actions: number[] | null;
};
created: string;
} | {
actionType: "Configure Group Game";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Actions: number[];
Type: number;
TargetId: number;
TargetName: string;
UniverseId: number | null;
UniverseName: string;
};
created: string;
} | {
actionType: "Create Game Pass";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
GamePassId: number;
PlaceId: number;
GamePassName: string;
PlaceName: string;
};
created: string;
} | {
actionType: "Create Badge";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
BadgeId: number;
BadgeName: string;
Type: null;
};
created: string;
} | {
actionType: "Save Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
};
created: string;
} | {
actionType: "Update Roleset Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewRank: number;
OldRank: number;
RoleSetId: number;
RoleSetName: string;
};
created: string;
} | {
actionType: "Update Roleset Data";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
NewName: string;
OldDescription: string;
OldName: string;
RoleSetId: number;
RoleSetName: string;
};
created: string;
})[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
previousPageCursor?: string | undefined;
nextPageCursor?: string | undefined;
data: ({
actionType: "Delete Post";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
PostDec: string;
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Remove Member" | "Accept Join Request" | "Decline Join Request";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Post Status";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Text: string;
};
created: string;
} | {
actionType: "Change Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
NewRoleSetId: number;
OldRoleSetId: number;
TargetName: string;
NewRoleSetName: string;
OldRoleSetName: string;
};
created: string;
} | {
actionType: "Buy Ad";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AdName: string;
Bid: number;
CurrencyTypeId: number;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Send Ally Request" | "Create Enemy" | "Accept Ally Request" | "Decline Ally Request" | "Delete Ally" | "Delete Enemy";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetGroupId: number;
TargetGroupName: string;
};
created: string;
} | {
actionType: "Create Items" | "Create Group Developer Product";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
};
created: string;
} | {
actionType: "Spend Group Funds";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Amount: number;
CurrencyTypeId: number;
ItemDescription: string;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Change Owner";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
IsRoblox: boolean;
NewOwnerId: number;
NewOwnerName: string;
OldOwnerId: number;
OldOwnerName: string;
};
created: string;
} | {
actionType: "Abandon";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Claim";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Rename";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewName: string;
};
created: string;
} | {
actionType: "Change Description";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
};
created: string;
} | {
actionType: "Add Group Place" | "Remove Group Place" | "Configure Items" | "Delete" | "Adjust Currency Amounts" | "Invite To Clan" | "Kick From Clan" | "Cancel Clan Invite" | "Buy Clan" | "Revert Group Asset" | "Create Group Developer Subscription Product" | "Lock" | "Unlock" | "Configure Badge" | "Publish Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Create Group Asset" | "Update Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
RevertVersionNumber: number | null;
};
created: string;
} | {
actionType: "Configure Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
Actions: number[] | null;
};
created: string;
} | {
actionType: "Configure Group Game";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Actions: number[];
Type: number;
TargetId: number;
TargetName: string;
UniverseId: number | null;
UniverseName: string;
};
created: string;
} | {
actionType: "Create Game Pass";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
GamePassId: number;
PlaceId: number;
GamePassName: string;
PlaceName: string;
};
created: string;
} | {
actionType: "Create Badge";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
BadgeId: number;
BadgeName: string;
Type: null;
};
created: string;
} | {
actionType: "Save Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
};
created: string;
} | {
actionType: "Update Roleset Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewRank: number;
OldRank: number;
RoleSetId: number;
RoleSetName: string;
};
created: string;
} | {
actionType: "Update Roleset Data";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
NewName: string;
OldDescription: string;
OldName: string;
RoleSetId: number;
RoleSetName: string;
};
created: string;
})[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: ({
actionType: "Delete Post";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
PostDec: string;
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Remove Member" | "Accept Join Request" | "Decline Join Request";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Post Status";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Text: string;
};
created: string;
} | {
actionType: "Change Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
NewRoleSetId: number;
OldRoleSetId: number;
TargetName: string;
NewRoleSetName: string;
OldRoleSetName: string;
};
created: string;
} | {
actionType: "Buy Ad";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AdName: string;
Bid: number;
CurrencyTypeId: number;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Send Ally Request" | "Create Enemy" | "Accept Ally Request" | "Decline Ally Request" | "Delete Ally" | "Delete Enemy";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetGroupId: number;
TargetGroupName: string;
};
created: string;
} | {
actionType: "Create Items" | "Create Group Developer Product";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
};
created: string;
} | {
actionType: "Spend Group Funds";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Amount: number;
CurrencyTypeId: number;
ItemDescription: string;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Change Owner";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
IsRoblox: boolean;
NewOwnerId: number;
NewOwnerName: string;
OldOwnerId: number;
OldOwnerName: string;
};
created: string;
} | {
actionType: "Abandon";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Claim";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Rename";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewName: string;
};
created: string;
} | {
actionType: "Change Description";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
};
created: string;
} | {
actionType: "Add Group Place" | "Remove Group Place" | "Configure Items" | "Delete" | "Adjust Currency Amounts" | "Invite To Clan" | "Kick From Clan" | "Cancel Clan Invite" | "Buy Clan" | "Revert Group Asset" | "Create Group Developer Subscription Product" | "Lock" | "Unlock" | "Configure Badge" | "Publish Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Create Group Asset" | "Update Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
RevertVersionNumber: number | null;
};
created: string;
} | {
actionType: "Configure Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
Actions: number[] | null;
};
created: string;
} | {
actionType: "Configure Group Game";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Actions: number[];
Type: number;
TargetId: number;
TargetName: string;
UniverseId: number | null;
UniverseName: string;
};
created: string;
} | {
actionType: "Create Game Pass";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
GamePassId: number;
PlaceId: number;
GamePassName: string;
PlaceName: string;
};
created: string;
} | {
actionType: "Create Badge";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
BadgeId: number;
BadgeName: string;
Type: null;
};
created: string;
} | {
actionType: "Save Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
};
created: string;
} | {
actionType: "Update Roleset Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewRank: number;
OldRank: number;
RoleSetId: number;
RoleSetName: string;
};
created: string;
} | {
actionType: "Update Roleset Data";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
NewName: string;
OldDescription: string;
OldName: string;
RoleSetId: number;
RoleSetName: string;
};
created: string;
})[] | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
previousPageCursor?: string | undefined;
nextPageCursor?: string | undefined;
data: ({
actionType: "Delete Post";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
PostDec: string;
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Remove Member" | "Accept Join Request" | "Decline Join Request";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
TargetName: string;
};
created: string;
} | {
actionType: "Post Status";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Text: string;
};
created: string;
} | {
actionType: "Change Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetId: number;
NewRoleSetId: number;
OldRoleSetId: number;
TargetName: string;
NewRoleSetName: string;
OldRoleSetName: string;
};
created: string;
} | {
actionType: "Buy Ad";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AdName: string;
Bid: number;
CurrencyTypeId: number;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Send Ally Request" | "Create Enemy" | "Accept Ally Request" | "Decline Ally Request" | "Delete Ally" | "Delete Enemy";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
TargetGroupId: number;
TargetGroupName: string;
};
created: string;
} | {
actionType: "Create Items" | "Create Group Developer Product";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
};
created: string;
} | {
actionType: "Spend Group Funds";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Amount: number;
CurrencyTypeId: number;
ItemDescription: string;
CurrencyTypeName: string;
};
created: string;
} | {
actionType: "Change Owner";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
IsRoblox: boolean;
NewOwnerId: number;
NewOwnerName: string;
OldOwnerId: number;
OldOwnerName: string;
};
created: string;
} | {
actionType: "Abandon";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Claim";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Rename";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewName: string;
};
created: string;
} | {
actionType: "Change Description";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
};
created: string;
} | {
actionType: "Add Group Place" | "Remove Group Place" | "Configure Items" | "Delete" | "Adjust Currency Amounts" | "Invite To Clan" | "Kick From Clan" | "Cancel Clan Invite" | "Buy Clan" | "Revert Group Asset" | "Create Group Developer Subscription Product" | "Lock" | "Unlock" | "Configure Badge" | "Publish Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {};
created: string;
} | {
actionType: "Create Group Asset" | "Update Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
RevertVersionNumber: number | null;
};
created: string;
} | {
actionType: "Configure Group Asset";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
Actions: number[] | null;
};
created: string;
} | {
actionType: "Configure Group Game";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
Actions: number[];
Type: number;
TargetId: number;
TargetName: string;
UniverseId: number | null;
UniverseName: string;
};
created: string;
} | {
actionType: "Create Game Pass";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
GamePassId: number;
PlaceId: number;
GamePassName: string;
PlaceName: string;
};
created: string;
} | {
actionType: "Create Badge";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
BadgeId: number;
BadgeName: string;
Type: null;
};
created: string;
} | {
actionType: "Save Place";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
AssetId: number;
AssetName: string;
VersionNumber: number;
};
created: string;
} | {
actionType: "Update Roleset Rank";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewRank: number;
OldRank: number;
RoleSetId: number;
RoleSetName: string;
};
created: string;
} | {
actionType: "Update Roleset Data";
actor: {
user: {
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
role: {
id: number;
name: string;
rank: number;
};
};
description: {
NewDescription: string;
NewName: string;
OldDescription: string;
OldName: string;
RoleSetId: number;
RoleSetName: string;
};
created: string;
})[];
}, import("../../classic/groups/groups.types").PrettifiedGroupAuditLogsData>, true>;
/**
* Gets group policy info used for compliance.
* @category Groups
* @endpoint GET /v1/groups/policies
* @tags [ "Cookie" ]
*
* @param groupIds the ids of groups to get policy info for.
*
* @example const { data:policyInfo } = await LegacyGroupsApi.groupsPolicyInfo({ groupIds: [ 5850082 ] })
* @exampleData { "5850082": { canViewGroup: true } }
* @exampleRawBody { groups: [ { canViewGroup: true, groupId: 5850082 } ] }
*/
export declare const groupsPolicyInfo: <GroupId extends import("typeforge").Identifier>(this: any, args: {
groupIds: import("typeforge").ArrayNonEmptyIfConst<GroupId>;
}) => Promise<{
data: Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T ? T extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T, T extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_1 ? T_1 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_1 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_2 ? T_2 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_2 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_2 : never : never> : never : never))["🔒__PRIVATE_FORMATTED_DATA"], undefined>;
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: import("typeforge").Prettify<Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_3 ? T_3 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_3 extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T_3, T_3 extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_4 ? T_4 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_4 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_5 ? T_5 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_5 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_5 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_6 ? T_6 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_6 extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T_6, T_6 extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_7 ? T_7 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_7 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_8 ? T_8 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_8 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_8 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined> extends infer T_9 ? T_9 extends Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_10 ? T_10 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_10 extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T_10, T_10 extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_11 ? T_11 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_11 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_12 ? T_12 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_12 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_12 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined> ? T_9 extends Date ? true : false : never : never>;
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
again: () => Promise<{
data: Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_13 ? T_13 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_13 extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T_13, T_13 extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_14 ? T_14 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_14 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_15 ? T_15 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_15 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_15 : never : never> : never : never))["🔒__PRIVATE_FORMATTED_DATA"], undefined>;
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: import("typeforge").Prettify<Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_16 ? T_16 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_16 extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T_16, T_16 extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_17 ? T_17 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_17 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_18 ? T_18 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_18 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_18 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_19 ? T_19 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_19 extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T_19, T_19 extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_20 ? T_20 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_20 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_21 ? T_21 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_21 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_21 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined> extends infer T_22 ? T_22 extends Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>) => string) | undefined;
getCursorsFn?: ((rawData: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_23 ? T_23 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_23 extends undefined ? {
groups: {
canViewGroup: boolean;
groupId: GroupId;
}[];
} : import("typeforge").Prettify<T_23, T_23 extends Date ? true : false> : never : never) | undefined;
} & (import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_24 ? T_24 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_24 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId>, import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> extends infer T_25 ? T_25 extends import("../../classic/groups/groups.types").PrettifiedGroupPolicyInfoData<GroupId> ? T_25 extends undefined ? import("../../classic/groups/groups.types").RawGroupPolicyInfoData<GroupId> : T_25 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined> ? T_22 extends Date ? true : false : never : never>;
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* Gets settings for a group.
* @category Groups
* @endpoint GET /v1/groups/{groupId}/settings
* @tags [ "Cookie" ]
*
* @param groupId The id of the group to get settings for.
*
* @example const { data:settings } = await LegacyGroupsApi.groupSettings({ groupId: 5850082 })
* @exampleData { isApprovalRequired: true, isBuildersClubRequired: false, areEnemiesAllowed: true, areGroupFundsVisible: false, areGroupGamesVisible: true, isGroupNameChangeEnabled: true }
* @exampleRawBody { isApprovalRequired: true, isBuildersClubRequired: false, areEnemiesAllowed: true, areGroupFundsVisible: false, areGroupGamesVisible: true, isGroupNameChangeEnabled: true }
*/
export declare const groupSettings: import("../../apiGroup/apiGroup.types").CallApiMethod<{
groupId: import("typeforge").Identifier;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
isApprovalRequired: boolean;
isBuildersClubRequired: boolean;
areEnemiesAllowed: boolean;
areGroupFundsVisible: boolean;
areGroupGamesVisible: boolean;
isGroupNameChangeEnabled: boolean;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
isApprovalRequired: boolean;
isBuildersClubRequired: boolean;
areEnemiesAllowed: boolean;
areGroupFundsVisible: boolean;
areGroupGamesVisible: boolean;
isGroupNameChangeEnabled: boolean;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
isApprovalRequired: boolean;
isBuildersClubRequired: boolean;
areEnemiesAllowed: boolean;
areGroupFundsVisible: boolean;
areGroupGamesVisible: boolean;
isGroupNameChangeEnabled: boolean;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
isApprovalRequired: boolean;
isBuildersClubRequired: boolean;
areEnemiesAllowed: boolean;
areGroupFundsVisible: boolean;
areGroupGamesVisible: boolean;
isGroupNameChangeEnabled: boolean;
} | undefined;
}, false>;
/**
* Sets settings for a group.
* @category Groups
* @endpoint PATCH /v1/groups/{groupId}/settings
* @tags [ "Cookie" ]
*
* @param groupId The id of the group.
* @param newSettings The new settings for the group.
*
* @example const { data:success } = await LegacyGroupsApi.setGroupSettings({ groupId: 5850082, newSettings: {
isApprovalRequired: true,
isBuildersClubRequired: false,
areEnemiesAllowed: true,
areGroupFundsVisible: false,
areGroupGamesVisible: true, isGroupNameChangeEnabled: true
}})
* @exampleData boolean
* @exampleRawBody {}
*/
export declare const setGroupSettings: import("../../apiGroup/apiGroup.types").CallApiMethod<{
groupId: import("typeforge").Identifier;
newSettings: {
isApprovalRequired: boolean;
isBuildersClubRequired: boolean;
areEnemiesAllowed: boolean;
areGroupFundsVisible: boolean;
areGroupGamesVisible: boolean;
isGroupNameChangeEnabled: boolean;
};
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: boolean) => string) | undefined;
getCursorsFn?: ((rawData: boolean) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: boolean | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {} | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<boolean, {}>, false>;
/**
* Sets group shout (status).
* @category Groups
* @endpoint PATCH /v1/groups/{groupId}/status
* @tags [ "Cookie" ]
*
* @param groupId The id of the group to set the shout for.
* @param message The content of the new shout.
*
* @example const { data:newShout } = await LegacyGroupsApi.setGroupShout({ groupId: 5850082, newShout: "Hello World!" })
* @exampleData { body: "Hello World!", poster: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, created: 2020-03-31T18:36:51.607Z, updated: 2023-09-15T16:21:00.272Z }
* @exampleRawBody { body: "Hello World!", poster: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, created: "2020-03-31T18:36:51.607Z", updated: "2023-09-15T16:21:00.272Z" }
*/
export declare const setGroupShout: <NewShout extends string>(this: any, args: {
groupId: import("typeforge").Identifier;
newShout: NewShout;
}) => Promise<{
data: {
body: NewShout;
poster: {
buildersClubMembershipType: number;
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
created: Date;
updated: Date;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
body: NewShout;
poster: {
buildersClubMembershipType: number;
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
created: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
updated: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
again: () => Promise<{
data: {
body: NewShout;
poster: {
buildersClubMembershipType: number;
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
created: Date;
updated: Date;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
body: NewShout;
poster: {
buildersClubMembershipType: number;
hasVerifiedBadge: boolean;
userId: number;
username: string;
displayName: string;
};
created: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
updated: `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}Z+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}+${number}${number}${number}${number}` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z` | `${number}${number}${number}${number}-${number}${number}-${number}${number}T${number}${number}:${number}${number}:${number}${number}${number}${number}${number}Z+${number}${number}${number}${number}`;
};
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;
/**
* Sets group description.
* @category Groups
* @endpoint PATCH /v1/groups/{groupId}/description
* @tags [ "Cookie" ]
*
* @param groupId The id of the group to set the description for.
* @param newDescription The content of the new description.
*
* @example const { data:newDescription } = await LegacyGroupsApi.setGroupDescription({ groupId: 5850082, newDescription: "Hello World!" })
* @exampleData "Hello World!"
* @exampleRawBody { newDescription: "Hello World!" }
*/
export declare const setGroupDescription: <NewDescription extends string>(this: any, args: {
groupId: import("typeforge").Identifier;
newDescription: NewDescription;
}) => Promise<{
data: Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_FORMATTED_DATA"], undefined>;
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: import("typeforge").Prettify<Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_RAW_DATA"], undefined> extends infer T ? T extends Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_RAW_DATA"], undefined> ? T extends Date ? true : false : never : never>;
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
} & {
again: () => Promise<{
data: Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_FORMATTED_DATA"], undefined>;
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: import("typeforge").Prettify<Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_RAW_DATA"], undefined> extends infer T_1 ? T_1 extends Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {
newDescription: NewDescription;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
newDescription: NewDescription;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newDescription: NewDescription;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (NewDescription extends undefined ? {
newDescription: NewDescription;
} : import("typeforge").Prettify<NewDescription, NewDescription extends Date ? true : false>) | undefined;
} & (NewDescription extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{
newDescription: NewDescription;
}, NewDescription extends undefined ? {
newDescription: NewDescription;
} : NewDescription>))["🔒__PRIVATE_RAW_DATA"], undefined> ? T_1 extends Date ? true : false : never : never>;
};
configUsed: {
cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
cloudKey?: string | undefined;
http?: {
adapter?: import("../../../http/httpAdapters").HttpAdapter | undefined;
csrfMaxAttempts?: number | undefined;
csrfToken?: string | undefined;
polling?: {
disabled?: boolean | undefined;
iterations?: number | undefined;
multiplyer?: number | undefined;
retryOffset?: number | undefined;
debugMessages?: boolean | undefined;
} | undefined;
} | undefined;
cache?: {
name: string;
get: (key: string) => any;
set: (settings: any, key: string, value: any) => void;
}[] | undefined;
};
}>;
}>;